| gtksourceviewmm 3.2.0 | 
Completion proposal object. More...
#include <gtksourceviewmm/completionproposal.h>

| Public Member Functions | |
| 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 a proposal. | |
| Glib::ustring | get_markup () const | 
| Gets the label of a proposal with markup. | |
| Glib::ustring | get_text () const | 
| Gets the text of a proposal. | |
| Glib::RefPtr< Gdk::Pixbuf > | get_icon () | 
| Gets the icon of a proposal. | |
| Glib::RefPtr< const Gdk::Pixbuf > | get_icon () const | 
| Gets the icon of a proposal. | |
| Glib::ustring | get_info () const | 
| Gets extra information associated to the proposal. | |
| void | changed () | 
| Emits the "changed" signal on a proposal. | |
| guint | hash () const | 
| Get the hash value of a proposal. | |
| bool | equal (const Glib::RefPtr< const CompletionProposal >& other) const | 
| Get whether two proposal objects are the same. | |
| Glib::SignalProxy0< void > | signal_changed () | 
| Emitted when the proposal has changed. | |
| Related Functions | |
| (Note that these are not member functions.) | |
| Glib::RefPtr < Gsv::CompletionProposal > | wrap (GtkSourceCompletionProposal* object, bool take_copy=false) | 
| A Glib::wrap() method for this object. | |
Completion proposal object.
The proposal interface represents a completion item in the completion window. It provides information on how to display the completion item and what action should be taken when the completion item is activated.
| void Gsv::CompletionProposal::changed | ( | ) | 
Emits the "changed" signal on a proposal.
This should be called by implementations whenever the name, icon or info of the proposal has changed.
| bool Gsv::CompletionProposal::equal | ( | const Glib::RefPtr< const CompletionProposal >& | other | ) | const | 
Get whether two proposal objects are the same.
This is used to (together with hash()) to match proposals in the completion model. By default, it uses direct equality.
| other | A CompletionProposal. | 
true if a proposal and other are the same proposal.| Glib::RefPtr<const Gdk::Pixbuf> Gsv::CompletionProposal::get_icon | ( | ) | const | 
| Glib::RefPtr<Gdk::Pixbuf> Gsv::CompletionProposal::get_icon | ( | ) | 
| Glib::ustring Gsv::CompletionProposal::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.
| Glib::ustring Gsv::CompletionProposal::get_label | ( | ) | const | 
Gets the label of a 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 get_markup().
| Glib::ustring Gsv::CompletionProposal::get_markup | ( | ) | const | 
Gets the label of a proposal with markup.
The label is shown in the list of proposals and may contain markup. This will be used instead of get_label() if implemented.
| Glib::ustring Gsv::CompletionProposal::get_text | ( | ) | const | 
Gets the text of a 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.
| guint Gsv::CompletionProposal::hash | ( | ) | const | 
Get the hash value of a proposal.
This is used to (together with equal()) to match proposals in the completion model. By default, it uses a direct hash.
| Glib::SignalProxy0< void > Gsv::CompletionProposal::signal_changed | ( | ) | 
Emitted when the proposal has changed.
The completion popup will react to this by updating the shown information.
void on_my_changed() | Glib::RefPtr< Gsv::CompletionProposal > wrap | ( | GtkSourceCompletionProposal * | object, | 
| bool | take_copy = false | ||
| ) |  [related] | 
A Glib::wrap() method for this object.
| 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. | 
 1.7.4
 1.7.4