Gio.ThemedIcon¶

class — extends GObject.Object, Icon

GThemedIcon is an implementation of Icon that supports icon themes.

GThemedIcon contains a list of all of the icons present in an icon theme, so that icons can be looked up quickly. GThemedIcon does not provide actual pixmaps for icons, just the icon names. Ideally something like Gtk.IconTheme.choose_icon should be used to resolve the list of names so that fallback icons work nicely with themes that inherit other themes.

Constructors¶

new¶

@classmethod
def new(cls, iconname: str) -> ThemedIcon

Creates a new themed icon for iconname.

Parameters:

iconname — a string containing an icon name.

new_from_names¶

@classmethod
def new_from_names(cls, iconnames: list[str]) -> ThemedIcon

Creates a new themed icon for iconnames.

Parameters:

iconnames — an array of strings containing icon names.

new_with_default_fallbacks¶

@classmethod
def new_with_default_fallbacks(cls, 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¶

append_name¶

def append_name(self, 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 Icon.hash.

Parameters:

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

get_names¶

def get_names(self) -> list[str]

Gets the names of icons from within icon.

prepend_name¶

def prepend_name(self, 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 Icon.hash.

Parameters:

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

Properties¶

name¶

name: str  # read/write

The icon name.

names¶

names: list[str]  # read/write

A None-terminated array of icon names.

use_default_fallbacks¶

use_default_fallbacks: bool  # read/write

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
};