gtksourceview::SourceCompletionProposal Class Reference

Inherits Glib::Interface.

Collaboration diagram for gtksourceview::SourceCompletionProposal:
Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual ~SourceCompletionProposal ()
GtkSourceCompletionProposal* gobj ()
 Provides access to the underlying C GObject.
const GtkSourceCompletionProposal* gobj () const
 Provides access to the underlying C GObject.
Glib::ustring get_label () const
 Gets the label of proposal.
Glib::ustring get_markup () const
 Gets the label of proposal with markup.
Glib::ustring get_text () const
 Gets the text of proposal.
Glib::RefPtr< Gdk::Pixbufget_icon ()
 Gets the icon of proposal.
Glib::RefPtr< const Gdk::Pixbufget_icon () const
 Gets the icon of proposal.
Glib::ustring get_info () const
 Gets extra information associated to the proposal.
void changed ()
 Emits the "changed" signal on proposal.
guint hash () const
 Get the hash value of proposal.
bool equal (const Glib::RefPtr< const SourceCompletionProposal >& other) const
 Get whether two proposal objects are the same.
Glib::SignalProxy0< void > signal_changed ()

Static Public Member Functions

static void add_interface (GType gtype_implementer)

Protected Member Functions

virtual void on_changed ()

Related Functions

(Note that these are not member functions.)



Glib::RefPtr
< gtksourceview::SourceCompletionProposal
wrap (GtkSourceCompletionProposal* object, bool take_copy=false)
 A Glib::wrap() method for this object.

Constructor & Destructor Documentation

virtual gtksourceview::SourceCompletionProposal::~SourceCompletionProposal (  )  [virtual]

Member Function Documentation

static void gtksourceview::SourceCompletionProposal::add_interface ( GType  gtype_implementer  )  [static]
void gtksourceview::SourceCompletionProposal::changed (  ) 

Emits the "changed" signal on proposal.

This should be called by implementations whenever the name, icon or info of the proposal has changed.

bool gtksourceview::SourceCompletionProposal::equal ( const Glib::RefPtr< const SourceCompletionProposal >&  other  )  const

Get whether two proposal objects are the same.

This is used to (together with gtk_source_completion_proposal_hash) to match proposals in the completion model. By default, it uses direct equality (g_direct_equal).

Parameters:
other A Gtk::SourceCompletionProposal.
Returns:
true if proposal and object are the same proposal.
Glib::RefPtr<const Gdk::Pixbuf> gtksourceview::SourceCompletionProposal::get_icon (  )  const

Gets the icon of proposal.

Returns:
The icon of proposal.
Glib::RefPtr<Gdk::Pixbuf> gtksourceview::SourceCompletionProposal::get_icon (  ) 

Gets the icon of proposal.

Returns:
The icon of proposal.
Glib::ustring gtksourceview::SourceCompletionProposal::get_info (  )  const

Gets extra information associated to the proposal.

This information will be used to present the user with extra, detailed information about the selected proposal.

Returns:
The extra information of proposal or 0 if no extra information is associated to proposal.
Glib::ustring gtksourceview::SourceCompletionProposal::get_label (  )  const

Gets the label of proposal.

The label is shown in the list of proposals as plain text. If you need any markup (such as bold or italic text), you have to implement gtk_source_completion_proposal_get_markup.

Returns:
The label of proposal.
Glib::ustring gtksourceview::SourceCompletionProposal::get_markup (  )  const

Gets the label of proposal with markup.

The label is shown in the list of proposals and may contain markup. This will be used instead of gtk_source_completion_proposal_get_label if implemented.

Returns:
The label of proposal with markup.
Glib::ustring gtksourceview::SourceCompletionProposal::get_text (  )  const

Gets the text of proposal.

The text that is inserted into the text buffer when the proposal is activated by the default activation. You are free to implement a custom activation handler in the provider and not implement this function.

Returns:
The text of proposal.
const GtkSourceCompletionProposal* gtksourceview::SourceCompletionProposal::gobj (  )  const [inline]

Provides access to the underlying C GObject.

Reimplemented from Glib::Interface.

GtkSourceCompletionProposal* gtksourceview::SourceCompletionProposal::gobj (  )  [inline]

Provides access to the underlying C GObject.

Reimplemented from Glib::Interface.

guint gtksourceview::SourceCompletionProposal::hash (  )  const

Get the hash value of proposal.

This is used to (together with gtk_source_completion_proposal_equal) to match proposals in the completion model. By default, it uses a direct hash (g_direct_hash).

Returns:
The hash value of proposal.
virtual void gtksourceview::SourceCompletionProposal::on_changed (  )  [protected, virtual]
Glib::SignalProxy0< void > gtksourceview::SourceCompletionProposal::signal_changed (  ) 
Prototype:
void on_my_changed()

Friends And Related Function Documentation

Glib::RefPtr< gtksourceview::SourceCompletionProposal > wrap ( GtkSourceCompletionProposal *  object,
bool  take_copy = false 
) [related]

A Glib::wrap() method for this object.

Parameters:
object The C instance.
take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
Returns:
A C++ instance that wraps this C instance.

The documentation for this class was generated from the following file:

Generated on 13 Jan 2010 for gtksourceviewmm by  doxygen 1.6.1