gtksourceviewmm 3.91.1
Gsv::CompletionItem Class Reference

CompletionItem. More...

#include <gtksourceviewmm/completionitem.h>

Inheritance diagram for Gsv::CompletionItem:

Public Member Functions

 CompletionItem (CompletionItem&& src) noexcept
 
CompletionItemoperator= (CompletionItem&& src) noexcept
 
 ~CompletionItem () noexcept override
 
GtkSourceCompletionItem* gobj ()
 Provides access to the underlying C GObject.
 
const GtkSourceCompletionItem* gobj () const
 Provides access to the underlying C GObject.
 
GtkSourceCompletionItem* gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
 
Glib::PropertyProxy< Glib::RefPtr< Gdk::Pixbuf > > property_icon ()
 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gdk::Pixbuf > > property_icon () const
 
Glib::PropertyProxy< Glib::ustring > property_info ()
 Default value: "".
 
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_info () const
 Default value: "".
 
Glib::PropertyProxy< Glib::ustring > property_label ()
 Default value: "".
 
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_label () const
 Default value: "".
 
Glib::PropertyProxy< Glib::ustring > property_markup ()
 Default value: "".
 
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_markup () const
 Default value: "".
 
Glib::PropertyProxy< Glib::ustring > property_text ()
 Default value: "".
 
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_text () const
 Default value: "".
 
- Public Member Functions inherited from Gsv::CompletionProposal
 CompletionProposal (CompletionProposal&& src) noexcept
 
CompletionProposaloperator= (CompletionProposal&& src) noexcept
 
 ~CompletionProposal () noexcept override
 
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::Pixbufget_icon ()
 Gets the icon of a proposal.
 
Glib::RefPtr< const Gdk::Pixbufget_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::SignalProxy< void > signal_changed ()
 Emitted when the proposal has changed.
 

Static Public Member Functions

static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system.
 
static Glib::RefPtr< CompletionItemcreate (const Glib::ustring& label, const Glib::ustring& text, const Glib::RefPtr< const Gdk::Pixbuf >& icon, const Glib::ustring& info)
 Create a new CompletionItem with label label, icon icon and extra information info.
 
static Glib::RefPtr< CompletionItemcreate (const Markup& markup, const Glib::ustring& text, const Glib::RefPtr< const Gdk::Pixbuf >& icon, const Glib::ustring& info)
 Create a new CompletionItem with markup label markup, icon icon and extra information info.
 
- Static Public Member Functions inherited from Gsv::CompletionProposal
static void add_interface (GType gtype_implementer)
 
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system.
 

Protected Member Functions

 CompletionItem (const Glib::ustring& label, const Glib::ustring& text, const Glib::RefPtr< const Gdk::Pixbuf >& icon, const Glib::ustring& info)
 
 CompletionItem (const Markup& markup, const Glib::ustring& text, const Glib::RefPtr< const Gdk::Pixbuf >& icon, const Glib::ustring& info)
 
- Protected Member Functions inherited from Gsv::CompletionProposal
 CompletionProposal ()
 You should derive from this class to use it.
 
virtual void on_changed ()
 This is a default handler for the signal signal_changed().
 

Related Symbols

(Note that these are not member symbols.)

Glib::RefPtr< Gsv::CompletionItemwrap (GtkSourceCompletionItem* object, bool take_copy=false)
 A Glib::wrap() method for this object.
 

Detailed Description

Constructor & Destructor Documentation

◆ CompletionItem() [1/3]

Gsv::CompletionItem::CompletionItem ( CompletionItem&& src)
noexcept

◆ ~CompletionItem()

Gsv::CompletionItem::~CompletionItem ( )
overridenoexcept

◆ CompletionItem() [2/3]

Gsv::CompletionItem::CompletionItem ( const Glib::ustring & label,
const Glib::ustring & text,
const Glib::RefPtr< const Gdk::Pixbuf > & icon,
const Glib::ustring & info )
explicitprotected

◆ CompletionItem() [3/3]

Gsv::CompletionItem::CompletionItem ( const Markup& markup,
const Glib::ustring & text,
const Glib::RefPtr< const Gdk::Pixbuf > & icon,
const Glib::ustring & info )
explicitprotected

Member Function Documentation

◆ create() [1/2]

static Glib::RefPtr< CompletionItem > Gsv::CompletionItem::create ( const Glib::ustring & label,
const Glib::ustring & text,
const Glib::RefPtr< const Gdk::Pixbuf > & icon,
const Glib::ustring & info )
static

Create a new CompletionItem with label label, icon icon and extra information info.

; If icon is empty, then there will be no icon shown. If info is empty, then no extra information will be available.

Parameters
labelThe item label.
textThe item text.
iconThe item icon.
infoThe item extra information.
Returns
New CompletionInfo.
Since gtksourceviewmm 2.10

◆ create() [2/2]

static Glib::RefPtr< CompletionItem > Gsv::CompletionItem::create ( const Markup& markup,
const Glib::ustring & text,
const Glib::RefPtr< const Gdk::Pixbuf > & icon,
const Glib::ustring & info )
static

Create a new CompletionItem with markup label markup, icon icon and extra information info.

If icon is empty, then there will be no icon shown. If info is empty, then no extra information will be available.

Parameters
markupThe item markup label.
textThe item text.
iconThe item icon.
infoThe item extra information.
Returns
New CompletionInfo.
Since gtksourceviewmm 2.10

◆ get_type()

static GType Gsv::CompletionItem::get_type ( )
static

Get the GType for this class, for use with the underlying GObject type system.

◆ gobj() [1/2]

GtkSourceCompletionItem * Gsv::CompletionItem::gobj ( )
inline

Provides access to the underlying C GObject.

◆ gobj() [2/2]

const GtkSourceCompletionItem * Gsv::CompletionItem::gobj ( ) const
inline

Provides access to the underlying C GObject.

◆ gobj_copy()

GtkSourceCompletionItem * Gsv::CompletionItem::gobj_copy ( )

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

◆ operator=()

CompletionItem& Gsv::CompletionItem::operator= ( CompletionItem&& src)
noexcept

◆ property_icon() [1/2]

Glib::PropertyProxy< Glib::RefPtr< Gdk::Pixbuf > > Gsv::CompletionItem::property_icon ( )
Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

◆ property_icon() [2/2]

Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gdk::Pixbuf > > Gsv::CompletionItem::property_icon ( ) const
Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_info() [1/2]

Glib::PropertyProxy< Glib::ustring > Gsv::CompletionItem::property_info ( )

Default value: "".

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

◆ property_info() [2/2]

Glib::PropertyProxy_ReadOnly< Glib::ustring > Gsv::CompletionItem::property_info ( ) const

Default value: "".

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_label() [1/2]

Glib::PropertyProxy< Glib::ustring > Gsv::CompletionItem::property_label ( )

Default value: "".

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

◆ property_label() [2/2]

Glib::PropertyProxy_ReadOnly< Glib::ustring > Gsv::CompletionItem::property_label ( ) const

Default value: "".

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_markup() [1/2]

Glib::PropertyProxy< Glib::ustring > Gsv::CompletionItem::property_markup ( )

Default value: "".

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

◆ property_markup() [2/2]

Glib::PropertyProxy_ReadOnly< Glib::ustring > Gsv::CompletionItem::property_markup ( ) const

Default value: "".

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_text() [1/2]

Glib::PropertyProxy< Glib::ustring > Gsv::CompletionItem::property_text ( )

Default value: "".

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

◆ property_text() [2/2]

Glib::PropertyProxy_ReadOnly< Glib::ustring > Gsv::CompletionItem::property_text ( ) const

Default value: "".

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

Friends And Related Symbol Documentation

◆ wrap()

Glib::RefPtr< Gsv::CompletionItem > wrap ( GtkSourceCompletionItem * object,
bool take_copy = false )
related

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

Parameters
objectThe C instance.
take_copyFalse 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.