ThemedIcon

class ThemedIcon(**properties: Any)

Superclasses: Object

Implemented Interfaces: Icon

Constructors:

ThemedIcon(**properties)
new(iconname:str) -> Gio.ThemedIcon
new_from_names(iconnames:list) -> Gio.ThemedIcon
new_with_default_fallbacks(iconname:str) -> Gio.ThemedIcon

Constructors

class ThemedIcon

classmethod new(iconname: str) → ThemedIcon

Creates a new themed icon for iconname.

Parameters:

iconname – a string containing an icon name.

classmethod new_from_names(iconnames: Sequence[str]) → ThemedIcon

Creates a new themed icon for iconnames.

Parameters:

iconnames – an array of strings containing icon names.

classmethod new_with_default_fallbacks(iconname: str) → ThemedIcon

Creates a new themed icon for iconname, and all the names that can be created by shortening iconname at ‘-’ characters.

In the following example, icon1 and icon2 are equivalent:

const char *names[] = {
  "gnome-dev-cdrom-audio",
  "gnome-dev-cdrom",
  "gnome-dev",
  "gnome"
};

icon1 = g_themed_icon_new_from_names (names, 4);
icon2 = g_themed_icon_new_with_default_fallbacks ("gnome-dev-cdrom-audio");

Parameters:

iconname – a string containing an icon name

Methods

class ThemedIcon

append_name(iconname: str) → None

Append a name to the list of icons from within icon.

Note that doing so invalidates the hash computed by prior calls to hash().

Parameters:

iconname – name of icon to append to list of icons from within icon.

get_names() → list[str]

Gets the names of icons from within icon.

prepend_name(iconname: str) → None

Prepend a name to the list of icons from within icon.

Note that doing so invalidates the hash computed by prior calls to hash().

Added in version 2.18.

Parameters:

iconname – name of icon to prepend to list of icons from within icon.

Properties

class ThemedIcon

props.name: str

The icon name.

props.names: Sequence[str]

A None-terminated array of icon names.

props.use_default_fallbacks: bool

Whether to use the default fallbacks found by shortening the icon name at ‘-’ characters. If the “names” array has more than one element, ignores any past the first.

For example, if the icon name was “gnome-dev-cdrom-audio”, the array would become

{
  "gnome-dev-cdrom-audio",
  "gnome-dev-cdrom",
  "gnome-dev",
  "gnome",
  NULL
};