libgtksourceviewmm-3.0-dev 3.2.0-1ubuntu1 / usr / include / gtksourceviewmm-3.0 / gtksourceviewmm / completionitem.h

// -*- c++ -*-
// Generated by gtkmmproc -- DO NOT MODIFY!
#ifndef _GTKSOURCEVIEWMM_COMPLETIONITEM_H
#define _GTKSOURCEVIEWMM_COMPLETIONITEM_H


#include <glibmm.h>

/* completionitem.h
 *
 * Copyright (C) 2009, 2010, 2011 Krzesimir Nowak
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the Free
 * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

#include <gtksourceviewmm/markup.h>
#include <gtksourceviewmm/completionproposal.h>

#include <gtkmm/stock.h>


#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GtkSourceCompletionItem GtkSourceCompletionItem;
typedef struct _GtkSourceCompletionItemClass GtkSourceCompletionItemClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */


namespace Gsv
{ class CompletionItem_Class; } // namespace Gsv
namespace Gsv
{

// TODO: need docs here. krnowak
/** CompletionItem
 *
 * @newin{2,10}
 */

class CompletionItem
:
  public Glib::Object,
  public CompletionProposal
{
  
#ifndef DOXYGEN_SHOULD_SKIP_THIS

public:
  typedef CompletionItem CppObjectType;
  typedef CompletionItem_Class CppClassType;
  typedef GtkSourceCompletionItem BaseObjectType;
  typedef GtkSourceCompletionItemClass BaseClassType;

private:  friend class CompletionItem_Class;
  static CppClassType completionitem_class_;

private:
  // noncopyable
  CompletionItem(const CompletionItem&);
  CompletionItem& operator=(const CompletionItem&);

protected:
  explicit CompletionItem(const Glib::ConstructParams& construct_params);
  explicit CompletionItem(GtkSourceCompletionItem* castitem);

#endif /* DOXYGEN_SHOULD_SKIP_THIS */

public:
  virtual ~CompletionItem();

#ifndef DOXYGEN_SHOULD_SKIP_THIS
  static GType get_type()      G_GNUC_CONST;


  static GType get_base_type() G_GNUC_CONST;
#endif

  ///Provides access to the underlying C GObject.
  GtkSourceCompletionItem*       gobj()       { return reinterpret_cast<GtkSourceCompletionItem*>(gobject_); }

  ///Provides access to the underlying C GObject.
  const GtkSourceCompletionItem* gobj() const { return reinterpret_cast<GtkSourceCompletionItem*>(gobject_); }

  ///Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
  GtkSourceCompletionItem* gobj_copy();

private:

  
protected:
  explicit CompletionItem(const Glib::ustring& label, const Glib::ustring& text, const Glib::RefPtr<const Gdk::Pixbuf>& icon, const Glib::ustring& info);
  explicit CompletionItem(const Markup& markup, const Glib::ustring& text, const Glib::RefPtr<const Gdk::Pixbuf>& icon, const Glib::ustring& info);
  explicit CompletionItem(const Glib::ustring& label, const Glib::ustring& text, const Gtk::StockID& stock, const Glib::ustring& info);
public:
  /** Create a new CompletionItem with label @a label, icon @a icon and
   *  extra information @a info.
   *;
   * If @a icon is empty, then there will be no icon shown. If @a info is empty,
   * then no extra information will be available.
   *
   * @param label The item label.
   * @param text The item text.
   * @param icon The item icon.
   * @param info The item extra information.
   *
   * @return New CompletionInfo.
   *
   * @newin{2,10}
   */
  
  static Glib::RefPtr<CompletionItem> create(const Glib::ustring& label, const Glib::ustring& text, const Glib::RefPtr<const Gdk::Pixbuf>& icon, const Glib::ustring& info);


  /** Create a new CompletionItem with markup label @a markup, icon
   *  @a icon and extra information @a info.
   *
   * If @a icon is empty, then there will be no icon shown. If @a info is empty,
   * then no extra information will be available.
   *
   * @param markup The item markup label.
   * @param text The item text.
   * @param icon The item icon.
   * @param info The item extra information.
   *
   * @return New CompletionInfo.
   *
   * @newin{2,10}
   */
  
  static Glib::RefPtr<CompletionItem> create(const Markup& markup, const Glib::ustring& text, const Glib::RefPtr<const Gdk::Pixbuf>& icon, const Glib::ustring& info);


  /** Creates a new CompletionItem from a stock item.
   *
   * If @a label is empty, then stock label will be used.
   *
   * @param label The item label.
   * @param text The item text.
   * @param stock The stock icon.
   * @param info The item extra information.
   *
   * @return New CompletionInfo.
   *
   * @newin{2,10}
   */
  
  static Glib::RefPtr<CompletionItem> create(const Glib::ustring& label, const Glib::ustring& text, const Gtk::StockID& stock, const Glib::ustring& info);


  #ifdef GLIBMM_PROPERTIES_ENABLED
/** Icon to be shown for this item.
   *
   * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
   * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
   * the value of the property changes.
   */
  Glib::PropertyProxy< Glib::RefPtr<Gdk::Pixbuf> > property_icon() ;
#endif //#GLIBMM_PROPERTIES_ENABLED

#ifdef GLIBMM_PROPERTIES_ENABLED
/** Icon to be shown for this item.
   *
   * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
   * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
   * the value of the property changes.
   */
  Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Gdk::Pixbuf> > property_icon() const;
#endif //#GLIBMM_PROPERTIES_ENABLED

  #ifdef GLIBMM_PROPERTIES_ENABLED
/** Info to be shown for this item.
   *
   * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
   * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
   * the value of the property changes.
   */
  Glib::PropertyProxy<Glib::ustring> property_info() ;
#endif //#GLIBMM_PROPERTIES_ENABLED

#ifdef GLIBMM_PROPERTIES_ENABLED
/** Info to be shown for this item.
   *
   * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
   * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
   * the value of the property changes.
   */
  Glib::PropertyProxy_ReadOnly<Glib::ustring> property_info() const;
#endif //#GLIBMM_PROPERTIES_ENABLED

  #ifdef GLIBMM_PROPERTIES_ENABLED
/** Label to be shown for this item.
   *
   * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
   * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
   * the value of the property changes.
   */
  Glib::PropertyProxy<Glib::ustring> property_label() ;
#endif //#GLIBMM_PROPERTIES_ENABLED

#ifdef GLIBMM_PROPERTIES_ENABLED
/** Label to be shown for this item.
   *
   * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
   * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
   * the value of the property changes.
   */
  Glib::PropertyProxy_ReadOnly<Glib::ustring> property_label() const;
#endif //#GLIBMM_PROPERTIES_ENABLED

  #ifdef GLIBMM_PROPERTIES_ENABLED
/** Markup to be shown for this item.
   *
   * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
   * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
   * the value of the property changes.
   */
  Glib::PropertyProxy<Glib::ustring> property_markup() ;
#endif //#GLIBMM_PROPERTIES_ENABLED

#ifdef GLIBMM_PROPERTIES_ENABLED
/** Markup to be shown for this item.
   *
   * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
   * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
   * the value of the property changes.
   */
  Glib::PropertyProxy_ReadOnly<Glib::ustring> property_markup() const;
#endif //#GLIBMM_PROPERTIES_ENABLED

  #ifdef GLIBMM_PROPERTIES_ENABLED
/** Item text.
   *
   * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
   * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
   * the value of the property changes.
   */
  Glib::PropertyProxy<Glib::ustring> property_text() ;
#endif //#GLIBMM_PROPERTIES_ENABLED

#ifdef GLIBMM_PROPERTIES_ENABLED
/** Item text.
   *
   * You rarely need to use properties because there are get_ and set_ methods for almost all of them.
   * @return A PropertyProxy that allows you to get or set the property of the value, or receive notification when
   * the value of the property changes.
   */
  Glib::PropertyProxy_ReadOnly<Glib::ustring> property_text() const;
#endif //#GLIBMM_PROPERTIES_ENABLED


public:

public:
  //C++ methods used to invoke GTK+ virtual functions:

protected:
  //GTK+ Virtual Functions (override these to change behaviour):

  //Default Signal Handlers::


};

} /* namespace Gsv */


namespace Glib
{
  /** A Glib::wrap() method for this object.
   * 
   * @param object The C instance.
   * @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
   * @result A C++ instance that wraps this C instance.
   *
   * @relates Gsv::CompletionItem
   */
  Glib::RefPtr<Gsv::CompletionItem> wrap(GtkSourceCompletionItem* object, bool take_copy = false);
}


#endif /* _GTKSOURCEVIEWMM_COMPLETIONITEM_H */