Class

GtkNumerableIcon

Description [src]

class Gtk.NumerableIcon : Gio.EmblemedIcon {
  parent: GEmblemedIcon
}

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:

Hierarchy

hierarchy this GtkNumerableIcon implements_0 GIcon this--implements_0 ancestor_0 GEmblemedIcon ancestor_0--this ancestor_1 GObject ancestor_1--ancestor_0

Implements

Functions

gtk_numerable_icon_new

Creates a new unthemed GtkNumerableIcon.

Available since: 3.0

Deprecated since: 3.14

gtk_numerable_icon_new_with_style_context

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.

Available since: 3.0

Deprecated since: 3.14

Instance methods

gtk_numerable_icon_get_background_gicon

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.

Available since: 3.0

Deprecated since: 3.14

gtk_numerable_icon_get_background_icon_name

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

Available since: 3.0

Deprecated since: 3.14

gtk_numerable_icon_get_count

Returns the value currently displayed by self.

Available since: 3.0

Deprecated since: 3.14

gtk_numerable_icon_get_label

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

Available since: 3.0

Deprecated since: 3.14

gtk_numerable_icon_get_style_context

Returns the GtkStyleContext used by the icon for theming, or NULL if there’s none.

Available since: 3.0

Deprecated since: 3.14

gtk_numerable_icon_set_background_gicon

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.

Available since: 3.0

Deprecated since: 3.14

gtk_numerable_icon_set_background_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 NULL, self will go back using style information or default theming for its background image.

Available since: 3.0

Deprecated since: 3.14

gtk_numerable_icon_set_count

Sets the currently displayed value of self to count.

Available since: 3.0

Deprecated since: 3.14

gtk_numerable_icon_set_label

Sets the currently displayed value of self to the string in label. Setting an empty label removes the emblem.

Available since: 3.0

Deprecated since: 3.14

gtk_numerable_icon_set_style_context

Updates the icon to fetch theme information from the given GtkStyleContext.

Available since: 3.0

Deprecated since: 3.14

Methods inherited from GEmblemedIcon (4)
g_emblemed_icon_add_emblem

Adds emblem to the GList of GEmblems.

Available since: 2.18

g_emblemed_icon_clear_emblems

Removes all the emblems from icon.

Available since: 2.28

g_emblemed_icon_get_emblems

Gets the list of emblems for the icon.

Available since: 2.18

g_emblemed_icon_get_icon

Gets the main icon for emblemed.

Available since: 2.18

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Methods inherited from GIcon (3)
g_icon_equal

Checks if two icons are equal.

g_icon_serialize

Serializes a GIcon into a GVariant. An equivalent GIcon can be retrieved back by calling g_icon_deserialize() on the returned value. As serialization will avoid using raw icon data when possible, it only makes sense to transfer the GVariant between processes on the same machine, (as opposed to over the network), and within the same file system namespace.

Available since: 2.38

g_icon_to_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. Use g_icon_new_for_string() to get icon back from the returned string.

Available since: 2.20

Properties

Gtk.NumerableIcon:background-icon
No description available.
Gtk.NumerableIcon:background-icon-name
No description available.
Gtk.NumerableIcon:count
No description available.
Gtk.NumerableIcon:label
No description available.
Gtk.NumerableIcon:style-context
No description available.
Properties inherited from GEmblemedIcon (1)
Gio.EmblemedIcon:gicon
No description available.

Signals

Signals inherited from GObject (1)
GObject.Object::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Class structure

struct GtkNumerableIconClass {
  GEmblemedIconClass parent_class;
  None padding;
  
}
No description available.
Class members
parent_class
GEmblemedIconClass
  No description available.
padding
None
  No description available.