IconTheme#

class IconTheme(**properties: Any)#

Superclasses: Object

GtkIconTheme provides a facility for loading themed icons.

The main reason for using a name rather than simply providing a filename is to allow different icons to be used depending on what “icon theme” is selected by the user. The operation of icon themes on Linux and Unix follows the Icon Theme Specification There is a fallback icon theme, named hicolor, where applications should install their icons, but additional icon themes can be installed as operating system vendors and users choose.

In many cases, named themes are used indirectly, via Image rather than directly, but looking up icons directly is also simple. The GtkIconTheme object acts as a database of all the icons in the current theme. You can create new GtkIconTheme objects, but it’s much more efficient to use the standard icon theme of the GtkWidget so that the icon information is shared with other people looking up icons.

GtkIconTheme *icon_theme;
GtkIconPaintable *icon;
GdkPaintable *paintable;

icon_theme = gtk_icon_theme_get_for_display (gtk_widget_get_display (my_widget));
icon = gtk_icon_theme_lookup_icon (icon_theme,
                                   "my-icon-name", // icon name
                                   48, // icon size
                                   1,  // scale
                                   0,  // flags);
paintable = GDK_PAINTABLE (icon);
// Use the paintable
g_object_unref (icon);

Constructors#

class IconTheme

classmethod new() → IconTheme#

Creates a new icon theme object.

Icon theme objects are used to lookup up an icon by name in a particular icon theme. Usually, you’ll want to use get_for_display rather than creating a new icon theme object for scratch.

Methods#

class IconTheme

add_resource_path(path: str) → None#

Adds a resource path that will be looked at when looking for icons, similar to search paths.

See set_resource_path.

This function should be used to make application-specific icons available as part of the icon theme.

Parameters:: path – a resource path

add_search_path(path: str) → None#

Appends a directory to the search path.

See set_search_path.

Parameters:: path – directory name to append to the icon path

get_display() → Display | None#: Returns the display that the GtkIconTheme object was created for.

get_for_display(display: Display) → IconTheme#

Gets the icon theme object associated with display.

If this function has not previously been called for the given display, a new icon theme object will be created and associated with the display. Icon theme objects are fairly expensive to create, so using this function is usually a better choice than calling new and setting the display yourself; by using this function a single icon theme object will be shared between users.

Parameters:: display – a GdkDisplay

get_icon_names() → list[str]#: Lists the names of icons in the current icon theme.

get_icon_sizes(icon_name: str) → list[int]#

Returns an array of integers describing the sizes at which the icon is available without scaling.

A size of -1 means that the icon is available in a scalable format. The array is zero-terminated.

Parameters:: icon_name – the name of an icon

get_resource_path() → list[str] | None#

Gets the current resource path.

See set_resource_path.

get_search_path() → list[str] | None#

Gets the current search path.

See set_search_path.

get_theme_name() → str#: Gets the current icon theme name.

has_gicon(gicon: Icon) → bool#

Checks whether an icon theme includes an icon for a particular GIcon.

Added in version 4.2.

Parameters:: gicon – a GIcon

has_icon(icon_name: str) → bool#

Checks whether an icon theme includes an icon for a particular name.

Parameters:: icon_name – the name of an icon

lookup_by_gicon(icon: Icon, size: int, scale: int, direction: TextDirection, flags: IconLookupFlags) → IconPaintable#

Looks up a icon for a desired size and window scale.

The icon can then be rendered by using it as a GdkPaintable, or you can get information such as the filename and size.

Parameters:

icon – the GIcon to look up
size – desired icon size, in application pixels
scale – the desired scale
direction – text direction the icon will be displayed in
flags – flags modifying the behavior of the icon lookup

lookup_icon(icon_name: str, fallbacks: Sequence[str] | None, size: int, scale: int, direction: TextDirection, flags: IconLookupFlags) → IconPaintable#

Looks up a named icon for a desired size and window scale, returning a GtkIconPaintable.

The icon can then be rendered by using it as a GdkPaintable, or you can get information such as the filename and size.

If the available icon_name is not available and fallbacks are provided, they will be tried in order.

If no matching icon is found, then a paintable that renders the “missing icon” icon is returned. If you need to do something else for missing icons you need to use has_icon.

Note that you probably want to listen for icon theme changes and update the icon. This is usually done by overriding the GtkWidgetClass.css-changed() function.

Parameters:

icon_name – the name of the icon to lookup
fallbacks – fallback names
size – desired icon size, in application pixels
scale – the window scale this will be displayed on
direction – text direction the icon will be displayed in
flags – flags modifying the behavior of the icon lookup

set_resource_path(path: Sequence[str] | None = None) → None#

Sets the resource paths that will be looked at when looking for icons, similar to search paths.

The resources are considered as part of the hicolor icon theme and must be located in subdirectories that are defined in the hicolor icon theme, such as `path/16x16/actions/run.png` or `path/scalable/actions/run.svg`.

Icons that are directly placed in the resource path instead of a subdirectory are also considered as ultimate fallback, but they are treated like unthemed icons.

Parameters:: path – NULL-terminated array of resource paths that are searched for icons

set_search_path(path: Sequence[str] | None = None) → None#

Sets the search path for the icon theme object.

When looking for an icon theme, GTK will search for a subdirectory of one or more of the directories in path with the same name as the icon theme containing an index.theme file. (Themes from multiple of the path elements are combined to allow themes to be extended by adding icons in the user’s home directory.)

In addition if an icon found isn’t found either in the current icon theme or the default icon theme, and an image file with the right name is found directly in one of the elements of path, then that image will be used for the icon name. (This is legacy feature, and new icons should be put into the fallback icon theme, which is called hicolor, rather than directly on the icon path.)

Parameters:: path – NULL-terminated array of directories that are searched for icon themes

set_theme_name(theme_name: str | None = None) → None#

Sets the name of the icon theme that the GtkIconTheme object uses overriding system configuration.

This function cannot be called on the icon theme objects returned from get_for_display.

Parameters:: theme_name – name of icon theme to use instead of configured theme, or None to unset a previously set custom theme

Properties#

class IconTheme

props.display: Display#: The type of the None singleton.

props.icon_names: Sequence[str]#: The type of the None singleton.

props.resource_path: Sequence[str]#: The type of the None singleton.

props.search_path: Sequence[str]#: The type of the None singleton.

props.theme_name: str#: The type of the None singleton.

Signals#

class IconTheme.signals

changed() → None#: The type of the None singleton.