A Gio::Icon that allows numbered emblems. More...

#include <gtkmm/numerableicon.h>

Inherits Gio::EmblemedIcon.

Public Member Functions
	NumerableIcon (NumerableIcon && src) noexcept

NumerableIcon &	operator= (NumerableIcon && src) noexcept

	~NumerableIcon () noexcept override

GtkNumerableIcon *	gobj ()
	Provides access to the underlying C GObject. More...

const GtkNumerableIcon *	gobj () const
	Provides access to the underlying C GObject. More...

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

Glib::RefPtr< StyleContext >	get_style_context ()
	Returns the Gtk::StyleContext used by the icon for theming, or `nullptr` if there’s none. More...

Glib::RefPtr< const StyleContext >	get_style_context () const
	Returns the Gtk::StyleContext used by the icon for theming, or `nullptr` if there’s none. More...

void	set_style_context (const Glib::RefPtr< StyleContext > & style)
	Updates the icon to fetch theme information from the given Gtk::StyleContext. More...

int	get_count () const
	Returns the value currently displayed by self. More...

void	set_count (int count)
	Sets the currently displayed value of self to count. More...

Glib::ustring	get_label () const
	Returns the currently displayed label of the icon, or `nullptr`. More...

void	set_label (const Glib::ustring & label)
	Sets the currently displayed value of self to the string in label. More...

void	set_background_gicon (const Glib::RefPtr< Gio::Icon > & icon)
	Updates the icon to use icon as the base background image. More...

Glib::RefPtr< Gio::Icon >	get_background_gicon ()
	Returns the Gio::Icon that was set as the base background image, or `nullptr` if there’s none. More...

Glib::RefPtr< const Gio::Icon >	get_background_gicon () const
	Returns the Gio::Icon that was set as the base background image, or `nullptr` if there’s none. More...

void	set_background_icon_name (const Glib::ustring & icon_name)
	Updates the icon to use the icon named icon_name from the current icon theme as the base background image. More...

Glib::ustring	get_background_icon_name () const
	Returns the icon name used as the base background image, or `nullptr` if there’s none. More...

Glib::PropertyProxy< int >	property_count ()
	The count of the emblem currently displayed. More...

Glib::PropertyProxy_ReadOnly< int >	property_count () const
	The count of the emblem currently displayed. More...

Glib::PropertyProxy< Glib::ustring >	property_label ()
	The label to be displayed over the icon. More...

Glib::PropertyProxy_ReadOnly< Glib::ustring >	property_label () const
	The label to be displayed over the icon. More...

Glib::PropertyProxy< Glib::RefPtr< StyleContext > >	property_style_context ()
	The style context to theme the icon appearance. More...

Glib::PropertyProxy_ReadOnly< Glib::RefPtr< StyleContext > >	property_style_context () const
	The style context to theme the icon appearance. More...

Glib::PropertyProxy< Glib::RefPtr< Gio::Icon > >	property_background_icon ()
	The icon for the number emblem background. More...

Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gio::Icon > >	property_background_icon () const
	The icon for the number emblem background. More...

Glib::PropertyProxy< Glib::ustring >	property_background_icon_name ()
	The icon name for the number emblem background. More...

Glib::PropertyProxy_ReadOnly< Glib::ustring >	property_background_icon_name () const
	The icon name for the number emblem background. More...

Static Public Member Functions
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system. More...

static Glib::RefPtr< NumerableIcon >	create (const Glib::RefPtr< Gio::Icon > & icon)

static Glib::RefPtr< NumerableIcon >	create (const Glib::RefPtr< Gio::Icon > & icon, const Glib::RefPtr< StyleContext > & context)

Protected Member Functions
	NumerableIcon (const Glib::RefPtr< Gio::Icon > & icon)

	NumerableIcon (const Glib::RefPtr< Gio::Icon > & icon, const Glib::RefPtr< StyleContext > & style_context)

Related Functions
(Note that these are not member functions.)
Glib::RefPtr< Gtk::NumerableIcon >	wrap (GtkNumerableIcon * object, bool take_copy=false)
	A Glib::wrap() method for this object. More...

Detailed Description

A Gio::Icon that allows numbered emblems.

Gtk::NumerableIcon is a subclass of Gio::EmblemedIcon that can show a number or short string as an emblem. The number can be overlayed on top of another emblem, if desired.

It supports theming by taking font and color information from a provided StyleContext. See set_style_context().

Since gtkmm 3.0:

Deprecated:: No replacement available.

Constructor & Destructor Documentation

◆ NumerableIcon() [1/3]

Gtk::NumerableIcon::NumerableIcon ( NumerableIcon && src )

noexcept

◆ ~NumerableIcon()

Gtk::NumerableIcon::~NumerableIcon ( )

overridenoexcept

◆ NumerableIcon() [2/3]

Gtk::NumerableIcon::NumerableIcon ( const Glib::RefPtr< Gio::Icon > & icon )

explicitprotected

◆ NumerableIcon() [3/3]

Gtk::NumerableIcon::NumerableIcon	(	const Glib::RefPtr< Gio::Icon > &	icon,
		const Glib::RefPtr< StyleContext > &	style_context
	)

explicitprotected

Member Function Documentation

◆ create() [1/2]

static Glib::RefPtr< NumerableIcon > Gtk::NumerableIcon::create ( const Glib::RefPtr< Gio::Icon > & icon )

static

◆ create() [2/2]

static Glib::RefPtr< NumerableIcon > Gtk::NumerableIcon::create	(	const Glib::RefPtr< Gio::Icon > &	icon,
		const Glib::RefPtr< StyleContext > &	context
	)

static

◆ get_background_gicon() [1/2]

Glib::RefPtr< Gio::Icon > Gtk::NumerableIcon::get_background_gicon ( )

Returns the Gio::Icon that was set as the base background image, or nullptr if there’s none.

The caller of this function does not own a reference to the returned Gio::Icon.

Since gtkmm 3.0:

Deprecated: 3.14

Returns: A Gio::Icon, or nullptr.

◆ get_background_gicon() [2/2]

Glib::RefPtr< const Gio::Icon > Gtk::NumerableIcon::get_background_gicon ( ) const

Returns the Gio::Icon that was set as the base background image, or nullptr if there’s none.

The caller of this function does not own a reference to the returned Gio::Icon.

Since gtkmm 3.0:

Deprecated: 3.14

Returns: A Gio::Icon, or nullptr.

◆ get_background_icon_name()

Glib::ustring Gtk::NumerableIcon::get_background_icon_name ( ) const

Returns the icon name used as the base background image, or nullptr if there’s none.

Since gtkmm 3.0:

Deprecated: 3.14

Returns: An icon name, or nullptr.

◆ get_count()

int Gtk::NumerableIcon::get_count ( ) const

Returns the value currently displayed by self.

Since gtkmm 3.0:

Deprecated: 3.14

Returns: The currently displayed value.

◆ get_label()

Glib::ustring Gtk::NumerableIcon::get_label ( ) const

Returns the currently displayed label of the icon, or nullptr.

Since gtkmm 3.0:

Deprecated: 3.14

Returns: The currently displayed label.

◆ get_style_context() [1/2]

Glib::RefPtr< StyleContext > Gtk::NumerableIcon::get_style_context ( )

Returns the Gtk::StyleContext used by the icon for theming, or nullptr if there’s none.

Since gtkmm 3.0:

Deprecated: 3.14

Returns: A Gtk::StyleContext, or nullptr. This object is internal to GTK+ and should not be unreffed. Use Glib::object_ref() if you want to keep it around.

◆ get_style_context() [2/2]

Glib::RefPtr< const StyleContext > Gtk::NumerableIcon::get_style_context ( ) const

Returns the Gtk::StyleContext used by the icon for theming, or nullptr if there’s none.

Since gtkmm 3.0:

Deprecated: 3.14

Returns: A Gtk::StyleContext, or nullptr. This object is internal to GTK+ and should not be unreffed. Use Glib::object_ref() if you want to keep it around.

◆ get_type()

static GType Gtk::NumerableIcon::get_type ( )

static

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

◆ gobj() [1/2]

GtkNumerableIcon * Gtk::NumerableIcon::gobj ( )

inline

Provides access to the underlying C GObject.

◆ gobj() [2/2]

const GtkNumerableIcon * Gtk::NumerableIcon::gobj ( ) const

inline

Provides access to the underlying C GObject.

◆ gobj_copy()

GtkNumerableIcon * Gtk::NumerableIcon::gobj_copy ( )

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

◆ operator=()

NumerableIcon & Gtk::NumerableIcon::operator= ( NumerableIcon && src )

noexcept

◆ property_background_icon() [1/2]

Glib::PropertyProxy< Glib::RefPtr< Gio::Icon > > Gtk::NumerableIcon::property_background_icon ( )

The icon for the number emblem background.

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_background_icon() [2/2]

Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gio::Icon > > Gtk::NumerableIcon::property_background_icon ( ) const

The icon for the number emblem background.

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_background_icon_name() [1/2]

Glib::PropertyProxy< Glib::ustring > Gtk::NumerableIcon::property_background_icon_name ( )

The icon name for the number emblem background.

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_background_icon_name() [2/2]

Glib::PropertyProxy_ReadOnly< Glib::ustring > Gtk::NumerableIcon::property_background_icon_name ( ) const

The icon name for the number emblem background.

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_count() [1/2]

Glib::PropertyProxy< int > Gtk::NumerableIcon::property_count ( )

The count of the emblem currently displayed.

Default value: 0

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_count() [2/2]

Glib::PropertyProxy_ReadOnly< int > Gtk::NumerableIcon::property_count ( ) const

The count of the emblem currently displayed.

Default value: 0

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 > Gtk::NumerableIcon::property_label ( )

The label to be displayed over the icon.

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 > Gtk::NumerableIcon::property_label ( ) const

The label to be displayed over the icon.

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_style_context() [1/2]

Glib::PropertyProxy< Glib::RefPtr< StyleContext > > Gtk::NumerableIcon::property_style_context ( )

The style context to theme the icon appearance.

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_style_context() [2/2]

Glib::PropertyProxy_ReadOnly< Glib::RefPtr< StyleContext > > Gtk::NumerableIcon::property_style_context ( ) const

The style context to theme the icon appearance.

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

◆ set_background_gicon()

void Gtk::NumerableIcon::set_background_gicon ( const Glib::RefPtr< Gio::Icon > & icon )

Updates the icon to use icon as the base background image.

If icon is nullptr, self will go back using style information or default theming for its background image.

If this method is called and an icon name was already set as background for the icon, icon will be used, i.e. the last method called between set_background_gicon() and set_background_icon_name() has always priority.

Since gtkmm 3.0:

Deprecated: 3.14

Parameters

icon	A Gio::Icon, or `nullptr`.

◆ set_background_icon_name()

void Gtk::NumerableIcon::set_background_icon_name ( const Glib::ustring & icon_name )

Updates the icon to use the icon named icon_name from the current icon theme as the base background image.

If icon_name is nullptr, self will go back using style information or default theming for its background image.

If this method is called and a Gio::Icon was already set as background for the icon, icon_name will be used, i.e. the last method called between set_background_icon_name() and set_background_gicon() has always priority.

Since gtkmm 3.0:

Deprecated: 3.14

Parameters

icon_name An icon name, or nullptr.

◆ set_count()

void Gtk::NumerableIcon::set_count ( int count )

Sets the currently displayed value of self to count.

The numeric value is always clamped to make it two digits, i.e. between -99 and 99. Setting a count of zero removes the emblem. If this method is called, and a label was already set on the icon, it will automatically be reset to nullptr before rendering the number, i.e. the last method called between set_count() and set_label() has always priority.

Since gtkmm 3.0:

Deprecated: 3.14

Parameters

count A number between -99 and 99.

◆ set_label()

void Gtk::NumerableIcon::set_label ( const Glib::ustring & label )

Sets the currently displayed value of self to the string in label.

Setting an empty label removes the emblem.

Note that this is meant for displaying short labels, such as roman numbers, or single letters. For roman numbers, consider using the Unicode characters U+2160 - U+217F. Strings longer than two characters will likely not be rendered very well.

If this method is called, and a number was already set on the icon, it will automatically be reset to zero before rendering the label, i.e. the last method called between set_label() and set_count() has always priority.

Since gtkmm 3.0:

Deprecated: 3.14

Parameters

label A short label, or nullptr.

◆ set_style_context()

void Gtk::NumerableIcon::set_style_context ( const Glib::RefPtr< StyleContext > & style )

Updates the icon to fetch theme information from the given Gtk::StyleContext.

Since gtkmm 3.0:

Deprecated: 3.14

Parameters

style A Gtk::StyleContext.

Friends And Related Function Documentation

◆ wrap()

Glib::RefPtr< Gtk::NumerableIcon > wrap	(	GtkNumerableIcon *	object,
		bool	take_copy = `false`
	)

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.

Public Member Functions

Static Public Member Functions

Protected Member Functions

Related Functions

Detailed Description

Constructor & Destructor Documentation

◆ NumerableIcon() [1/3]

◆ ~NumerableIcon()

◆ NumerableIcon() [2/3]

◆ NumerableIcon() [3/3]

Member Function Documentation

◆ create() [1/2]

◆ create() [2/2]

◆ get_background_gicon() [1/2]

◆ get_background_gicon() [2/2]

◆ get_background_icon_name()

◆ get_count()

◆ get_label()

◆ get_style_context() [1/2]

◆ get_style_context() [2/2]

◆ get_type()

◆ gobj() [1/2]

◆ gobj() [2/2]

◆ gobj_copy()

◆ operator=()

◆ property_background_icon() [1/2]

◆ property_background_icon() [2/2]

◆ property_background_icon_name() [1/2]

◆ property_background_icon_name() [2/2]

◆ property_count() [1/2]

◆ property_count() [2/2]

◆ property_label() [1/2]

◆ property_label() [2/2]

◆ property_style_context() [1/2]

◆ property_style_context() [2/2]

◆ set_background_gicon()

◆ set_background_icon_name()

◆ set_count()

◆ set_label()

◆ set_style_context()

Friends And Related Function Documentation

◆ wrap()