Back to Seed Clases

Gtk

Classes

Interfaces

Structs

Unions

Enums

GObject.Object
parent-child marker Gio.EmblemedIcon
Gtk.NumerableIcon

Class Gtk.NumerableIcon

Import line:	Gtk = imports.gi.Gtk;
GIR File:	Gtk-3.0.gir
C documentation:	GtkNumerableIcon
Class :	NumerableIcon
Implements:	Gio.Icon
Extends:	Gio.EmblemedIcon

GtkNumerableIcon is a subclass of GEmblemedIcon 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 GtkStyleContext; see
gtk_numerable_icon_set_style_context().

Typical numerable icons

Properties
Properties		Defined By
	background_icon : Gio.Icon	Gtk.NumerableIcon
	background_icon_name : String	Gtk.NumerableIcon
	count : gint32	Gtk.NumerableIcon
	gicon : Gio.Icon	Gio.EmblemedIcon
	label : String	Gtk.NumerableIcon
	parent : Gio.EmblemedIcon read only	Gtk.NumerableIcon
	parent_instance : GObject.Object read only	Gio.EmblemedIcon
	priv : Gtk.NumerableIconPrivate read only	Gtk.NumerableIcon
	style_context : Gtk.StyleContext	Gtk.NumerableIcon

Methods / Constructors
Method / Constructor		Defined By
	new Gtk.NumerableIcon (Object *properties) Create a new Gtk.NumerableIcon Create a new Gtk.NumerableIcon Parameters: Object properties*
	Gtk.NumerableIcon.c_new (Icon *base_icon) : Gio.Icon Creates a new unthemed GtkNumerableIcon. Creates a new unthemed GtkNumerableIcon. Parameters: Gio.Icon base_icon* Required (not null) a GIcon to overlay on Returns: Gio.Icon a new GIcon	Gtk.NumerableIcon
	Gtk.NumerableIcon.new_with_style_context (Icon *base_icon, StyleContext context) : Gio.Icon Creates a new GtkNumerableIcon* which will themed according to the passed GtkStyleContext. Creates a new GtkNumerableIcon which will themed according to the passed GtkStyleContext. This is a convenience constructor that calls gtk_numerable_icon_set_style_context() internally. Parameters: Gio.Icon base_icon Required (not null) a GIcon to overlay on Gtk.StyleContext context Required (not null) a GtkStyleContext Returns: Gio.Icon a new GIcon	Gtk.NumerableIcon
	add_emblem (Emblem *emblem) : none Adds emblem* to the GList of GEmblem s. Adds emblem to the GList of GEmblem s. Parameters: Gio.Emblem emblem Required (not null) a GEmblem Returns: none	Gio.EmblemedIcon
	clear_emblems () : none Removes all the emblems from icon. Removes all the emblems from icon. Returns: none	Gio.EmblemedIcon
	equal (Icon *icon2) : gboolean Checks if two icons are equal. Checks if two icons are equal. Parameters: Gio.Icon icon2* Required (not null) pointer to the second GIcon. Returns: gboolean TRUE if icon1 is equal to icon2. FALSE otherwise.	Gio.Icon
	get_background_gicon () : Gio.Icon Returns the GIcon that was set as the base background image, or NULL if there's none. Returns the GIcon that was set as the base background image, or NULL if there's none. The caller of this function does not own a reference to the returned GIcon. Returns: Gio.Icon a GIcon, or NULL	Gtk.NumerableIcon
	get_background_icon_name () : String Returns the icon name used as the base background image, or NULL if there's none. Returns the icon name used as the base background image, or NULL if there's none. Returns: String an icon name, or NULL	Gtk.NumerableIcon
	get_count () : gint32 Returns the value currently displayed by self. Returns the value currently displayed by self. Returns: gint32 the currently displayed value	Gtk.NumerableIcon
	get_emblems () : Array Gets the list of emblems for the icon. Gets the list of emblems for the icon. GEmblem s that is owned by emblemed Returns: Array a GList of	Gio.EmblemedIcon
	get_icon () : Gio.Icon Gets the main icon for emblemed. Gets the main icon for emblemed. Returns: Gio.Icon a GIcon that is owned by emblemed	Gio.EmblemedIcon
	get_label () : String Returns the currently displayed label of the icon, or NULL. Returns the currently displayed label of the icon, or NULL. Returns: String the currently displayed label	Gtk.NumerableIcon
	get_style_context () : Gtk.StyleContext Returns the GtkStyleContext used by the icon for theming, or NULL if there's none. Returns the GtkStyleContext used by the icon for theming, or NULL if there's none. This object is internal to GTK+ and should not be unreffed. Use g_object_ref() if you want to keep it around Returns: Gtk.StyleContext a GtkStyleContext, or NULL.	Gtk.NumerableIcon
	set_background_gicon (Icon *icon) : none Updates the icon to use icon* as the base background image. Updates the icon to use icon as the base background image. If icon is NULL, 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 gtk_numerable_icon_set_background_gicon() and gtk_numerable_icon_set_background_icon_name() has always priority. Parameters: Gio.Icon icon a GIcon, or NULL Returns: none	Gtk.NumerableIcon
	set_background_icon_name (String *icon_name) : none Updates the icon to use the icon named icon_name* from the current icon theme as the base background image. Updates the icon to use the icon named icon_name from the current icon theme as the base background image. If icon_name is NULL, self will go back using style information or default theming for its background image. If this method is called and a GIcon was already set as background for the icon, icon_name will be used, i.e. the last method called between gtk_numerable_icon_set_background_icon_name() and gtk_numerable_icon_set_background_gicon() has always priority. Parameters: String icon_name an icon name, or NULL Returns: none	Gtk.NumerableIcon
	set_count (gint32 *count) : none Sets the currently displayed value of self* to 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 NULL before rendering the number, i.e. the last method called between gtk_numerable_icon_set_count() and gtk_numerable_icon_set_label() has always priority. Parameters: gint32 count Required (not null) a number between -99 and 99 Returns: none	Gtk.NumerableIcon
	set_label (String *label) : none Sets the currently displayed value of self* to the string in 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 gtk_numerable_icon_set_label() and gtk_numerable_icon_set_count() has always priority. Parameters: String label a short label, or NULL Returns: none	Gtk.NumerableIcon
	set_style_context (StyleContext *style) : none Updates the icon to fetch theme information from the given GtkStyleContext. Updates the icon to fetch theme information from the given GtkStyleContext. Parameters: Gtk.StyleContext style* Required (not null) a GtkStyleContext Returns: none	Gtk.NumerableIcon
	to_string () : String Generates a textual representation of icon that can be used for serialization such as when passing icon to a different process or saving it to persistent storage. Generates a textual representation of icon that can be used for serialization such as when passing icon to a different process or saving it to persistent storage. Use g_icon_new_for_string() to get icon back from the returned string. The encoding of the returned string is proprietary to GIcon except in the following two cases If icon is a GFileIcon, the returned string is a native path (such as /path/to/my icon.png) without escaping if the GFile for icon is a native file. If the file is not native, the returned string is the result of g_file_get_uri() (such as sftp://path/to/my%%20icon.png). If icon is a GThemedIcon with exactly one name, the encoding is simply the name (such as network-server). be serialized. Use g_free() to free. Returns: String An allocated NUL-terminated UTF8 string or NULL if icon can't	Gio.Icon

Events
None