Gtk.IconTheme

g GObject.Object GObject.Object Gtk.IconTheme Gtk.IconTheme GObject.Object->Gtk.IconTheme

Subclasses:None

Methods

Inherited:GObject.Object (37)
Structs:GObject.ObjectClass (5)
class add_builtin_icon (icon_name, size, pixbuf)
class get_default ()
class get_for_screen (screen)
class new ()
  add_resource_path (path)
  append_search_path (path)
  choose_icon (icon_names, size, flags)
  choose_icon_for_scale (icon_names, size, scale, flags)
  get_example_icon_name ()
  get_icon_sizes (icon_name)
  get_search_path ()
  has_icon (icon_name)
  list_contexts ()
  list_icons (context)
  load_icon (icon_name, size, flags)
  load_icon_for_scale (icon_name, size, scale, flags)
  load_surface (icon_name, size, scale, for_window, flags)
  lookup_by_gicon (icon, size, flags)
  lookup_by_gicon_for_scale (icon, size, scale, flags)
  lookup_icon (icon_name, size, flags)
  lookup_icon_for_scale (icon_name, size, scale, flags)
  prepend_search_path (path)
  rescan_if_needed ()
  set_custom_theme (theme_name)
  set_screen (screen)
  set_search_path (path)

Virtual Methods

Inherited:GObject.Object (7)
  do_changed ()

Properties

None

Signals

Inherited:GObject.Object (1)
Name Short Description
changed Emitted when the current icon theme is switched or GTK+ detects that a change has occurred in the contents of the current icon theme.

Fields

Inherited:GObject.Object (1)
Name Type Access Description
parent_instance GObject.Object r  

Class Details

class Gtk.IconTheme(**kwargs)
Bases:GObject.Object
Abstract:No
Structure:Gtk.IconThemeClass

Gtk.IconTheme provides a facility for looking up icons by name and size. 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.

Named icons are similar to the deprecated ‘Stock Items [gtkstock]’, and the distinction between the two may be a bit confusing. A few things to keep in mind:

  • Stock images usually are used in conjunction with ‘Stock Items [gtkstock]’, such as Gtk.STOCK_OK or Gtk.STOCK_OPEN. Named icons are easier to set up and therefore are more useful for new icons that an application wants to add, such as application icons or window icons.
  • Stock images can only be loaded at the symbolic sizes defined by the Gtk.IconSize enumeration, or by custom sizes defined by Gtk.IconSize.register(), while named icons are more flexible and any pixel size can be specified.
  • Because stock images are closely tied to stock items, and thus to actions in the user interface, stock images may come in multiple variants for different widget states or writing directions.

A good rule of thumb is that if there is a stock image for what you want to use, use it, otherwise use a named icon. It turns out that internally stock images are generally defined in terms of one or more named icons. (An example of the more than one case is icons that depend on writing direction; Gtk.STOCK_GO_FORWARD uses the two themed icons “gtk-stock-go-forward-ltr” and “gtk-stock-go-forward-rtl”.)

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

GError *error = NULL;
GtkIconTheme *icon_theme;
GdkPixbuf *pixbuf;

icon_theme = gtk_icon_theme_get_default ();
pixbuf = gtk_icon_theme_load_icon (icon_theme,
                                   "my-icon-name", // icon name
                                   48, // icon size
                                   0,  // flags
                                   &error);
if (!pixbuf)
  {
    g_warning ("Couldn’t load icon: %s", error->message);
    g_error_free (error);
  }
else
  {
    // Use the pixbuf
    g_object_unref (pixbuf);
  }
classmethod add_builtin_icon(icon_name, size, pixbuf)[source]
Parameters:
  • icon_name (str) – the name of the icon to register
  • size (int) – the size in pixels at which to register the icon (different images can be registered for the same icon name at different sizes.)
  • pixbuf (GdkPixbuf.Pixbuf) – GdkPixbuf.Pixbuf that contains the image to use for icon_name

Registers a built-in icon for icon theme lookups. The idea of built-in icons is to allow an application or library that uses themed icons to function requiring files to be present in the file system. For instance, the default images for all of GTK+’s stock icons are registered as built-icons.

In general, if you use Gtk.IconTheme.add_builtin_icon() you should also install the icon in the icon theme, so that the icon is generally available.

This function will generally be used with pixbufs loaded via GdkPixbuf.Pixbuf.new_from_inline().

New in version 2.4.

Deprecated since version 3.14: Use Gtk.IconTheme.add_resource_path() to add application-specific icons to the icon theme.

classmethod get_default()[source]
Returns:A unique Gtk.IconTheme associated with the default screen. This icon theme is associated with the screen and can be used as long as the screen is open. Do not ref or unref it.
Return type:Gtk.IconTheme

Gets the icon theme for the default screen. See Gtk.IconTheme.get_for_screen().

New in version 2.4.

classmethod get_for_screen(screen)[source]
Parameters:screen (Gdk.Screen) – a Gdk.Screen
Returns:A unique Gtk.IconTheme associated with the given screen. This icon theme is associated with the screen and can be used as long as the screen is open. Do not ref or unref it.
Return type:Gtk.IconTheme

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

New in version 2.4.

classmethod new()[source]
Returns:the newly created Gtk.IconTheme object.
Return type:Gtk.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 Gtk.IconTheme.get_default() or Gtk.IconTheme.get_for_screen() rather than creating a new icon theme object for scratch.

New in version 2.4.

add_resource_path(path)[source]
Parameters:path (str) – a resource path

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

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

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. Icons that are directly placed in the resource path instead of a subdirectory are also considered as ultimate fallback.

New in version 3.14.

append_search_path(path)[source]
Parameters:path (str) – directory name to append to the icon path

Appends a directory to the search path. See Gtk.IconTheme.set_search_path().

New in version 2.4.

choose_icon(icon_names, size, flags)[source]
Parameters:
  • icon_names ([str]) – None-terminated array of icon names to lookup
  • size (int) – desired icon size
  • flags (Gtk.IconLookupFlags) – flags modifying the behavior of the icon lookup
Returns:

a Gtk.IconInfo object containing information about the icon, or None if the icon wasn’t found.

Return type:

Gtk.IconInfo or None

Looks up a named icon and returns a Gtk.IconInfo containing information such as the filename of the icon. The icon can then be rendered into a pixbuf using Gtk.IconInfo.load_icon(). (Gtk.IconTheme.load_icon() combines these two steps if all you need is the pixbuf.)

If icon_names contains more than one name, this function tries them all in the given order before falling back to inherited icon themes.

New in version 2.12.

choose_icon_for_scale(icon_names, size, scale, flags)[source]
Parameters:
  • icon_names ([str]) – None-terminated array of icon names to lookup
  • size (int) – desired icon size
  • scale (int) – desired scale
  • flags (Gtk.IconLookupFlags) – flags modifying the behavior of the icon lookup
Returns:

a Gtk.IconInfo object containing information about the icon, or None if the icon wasn’t found.

Return type:

Gtk.IconInfo or None

Looks up a named icon for a particular window scale and returns a Gtk.IconInfo containing information such as the filename of the icon. The icon can then be rendered into a pixbuf using Gtk.IconInfo.load_icon(). (Gtk.IconTheme.load_icon() combines these two steps if all you need is the pixbuf.)

If icon_names contains more than one name, this function tries them all in the given order before falling back to inherited icon themes.

New in version 3.10.

get_example_icon_name()[source]
Returns:the name of an example icon or None. Free with GLib.free().
Return type:str or None

Gets the name of an icon that is representative of the current theme (for instance, to use when presenting a list of themes to the user.)

New in version 2.4.

get_icon_sizes(icon_name)[source]
Parameters:icon_name (str) – the name of an icon
Returns:An newly allocated array describing the sizes at which the icon is available. The array should be freed with GLib.free() when it is no longer needed.
Return type:[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.

New in version 2.6.

get_search_path()[source]
Returns:location to store a list of icon theme path directories or None. The stored value should be freed with GLib.strfreev().
Return type:path: [str]

Gets the current search path. See Gtk.IconTheme.set_search_path().

New in version 2.4.

has_icon(icon_name)[source]
Parameters:icon_name (str) – the name of an icon
Returns:True if self includes an icon for icon_name.
Return type:bool

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

New in version 2.4.

list_contexts()[source]
Returns:a GLib.List list holding the names of all the contexts in the theme. You must first free each element in the list with GLib.free(), then free the list itself with g_list_free().
Return type:[str]

Gets the list of contexts available within the current hierarchy of icon themes. See Gtk.IconTheme.list_icons() for details about contexts.

New in version 2.12.

list_icons(context)[source]
Parameters:context (str or None) – a string identifying a particular type of icon, or None to list all icons.
Returns:a GLib.List list holding the names of all the icons in the theme. You must first free each element in the list with GLib.free(), then free the list itself with g_list_free().
Return type:[str]

Lists the icons in the current icon theme. Only a subset of the icons can be listed by providing a context string. The set of values for the context string is system dependent, but will typically include such values as “Applications” and “MimeTypes”. Contexts are explained in the Icon Theme Specification. The standard contexts are listed in the Icon Naming Specification. Also see Gtk.IconTheme.list_contexts().

New in version 2.4.

load_icon(icon_name, size, flags)[source]
Parameters:
  • icon_name (str) – the name of the icon to lookup
  • size (int) – the desired icon size. The resulting icon may not be exactly this size; see Gtk.IconInfo.load_icon().
  • flags (Gtk.IconLookupFlags) – flags modifying the behavior of the icon lookup
Raises:

GLib.Error

Returns:

the rendered icon; this may be a newly created icon or a new reference to an internal icon, so you must not modify the icon. Use GObject.Object.unref() to release your reference to the icon. None if the icon isn’t found.

Return type:

GdkPixbuf.Pixbuf or None

Looks up an icon in an icon theme, scales it to the given size and renders it into a pixbuf. This is a convenience function; if more details about the icon are needed, use Gtk.IconTheme.lookup_icon() followed by Gtk.IconInfo.load_icon().

Note that you probably want to listen for icon theme changes and update the icon. This is usually done by connecting to the Gtk.Widget ::style-set signal. If for some reason you do not want to update the icon when the icon theme changes, you should consider using GdkPixbuf.Pixbuf.copy() to make a private copy of the pixbuf returned by this function. Otherwise GTK+ may need to keep the old icon theme loaded, which would be a waste of memory.

New in version 2.4.

load_icon_for_scale(icon_name, size, scale, flags)[source]
Parameters:
  • icon_name (str) – the name of the icon to lookup
  • size (int) – the desired icon size. The resulting icon may not be exactly this size; see Gtk.IconInfo.load_icon().
  • scale (int) – desired scale
  • flags (Gtk.IconLookupFlags) – flags modifying the behavior of the icon lookup
Raises:

GLib.Error

Returns:

the rendered icon; this may be a newly created icon or a new reference to an internal icon, so you must not modify the icon. Use GObject.Object.unref() to release your reference to the icon. None if the icon isn’t found.

Return type:

GdkPixbuf.Pixbuf or None

Looks up an icon in an icon theme for a particular window scale, scales it to the given size and renders it into a pixbuf. This is a convenience function; if more details about the icon are needed, use Gtk.IconTheme.lookup_icon() followed by Gtk.IconInfo.load_icon().

Note that you probably want to listen for icon theme changes and update the icon. This is usually done by connecting to the Gtk.Widget ::style-set signal. If for some reason you do not want to update the icon when the icon theme changes, you should consider using GdkPixbuf.Pixbuf.copy() to make a private copy of the pixbuf returned by this function. Otherwise GTK+ may need to keep the old icon theme loaded, which would be a waste of memory.

New in version 3.10.

load_surface(icon_name, size, scale, for_window, flags)[source]
Parameters:
Raises:

GLib.Error

Returns:

the rendered icon; this may be a newly created icon or a new reference to an internal icon, so you must not modify the icon. Use cairo_surface_destroy() to release your reference to the icon. None if the icon isn’t found.

Return type:

cairo.Surface or None

Looks up an icon in an icon theme for a particular window scale, scales it to the given size and renders it into a cairo surface. This is a convenience function; if more details about the icon are needed, use Gtk.IconTheme.lookup_icon() followed by Gtk.IconInfo.load_surface().

Note that you probably want to listen for icon theme changes and update the icon. This is usually done by connecting to the Gtk.Widget ::style-set signal.

New in version 3.10.

lookup_by_gicon(icon, size, flags)[source]
Parameters:
Returns:

a Gtk.IconInfo containing information about the icon, or None if the icon wasn’t found. Unref with GObject.Object.unref()

Return type:

Gtk.IconInfo or None

Looks up an icon and returns a Gtk.IconInfo containing information such as the filename of the icon. The icon can then be rendered into a pixbuf using Gtk.IconInfo.load_icon().

When rendering on displays with high pixel densities you should not use a size multiplied by the scaling factor returned by functions like Gdk.Window.get_scale_factor(). Instead, you should use Gtk.IconTheme.lookup_by_gicon_for_scale(), as the assets loaded for a given scaling factor may be different.

New in version 2.14.

lookup_by_gicon_for_scale(icon, size, scale, flags)[source]
Parameters:
Returns:

a Gtk.IconInfo containing information about the icon, or None if the icon wasn’t found. Unref with GObject.Object.unref()

Return type:

Gtk.IconInfo or None

Looks up an icon and returns a Gtk.IconInfo containing information such as the filename of the icon. The icon can then be rendered into a pixbuf using Gtk.IconInfo.load_icon().

New in version 3.10.

lookup_icon(icon_name, size, flags)[source]
Parameters:
  • icon_name (str) – the name of the icon to lookup
  • size (int) – desired icon size
  • flags (Gtk.IconLookupFlags) – flags modifying the behavior of the icon lookup
Returns:

a Gtk.IconInfo object containing information about the icon, or None if the icon wasn’t found.

Return type:

Gtk.IconInfo or None

Looks up a named icon and returns a Gtk.IconInfo containing information such as the filename of the icon. The icon can then be rendered into a pixbuf using Gtk.IconInfo.load_icon(). (Gtk.IconTheme.load_icon() combines these two steps if all you need is the pixbuf.)

When rendering on displays with high pixel densities you should not use a size multiplied by the scaling factor returned by functions like Gdk.Window.get_scale_factor(). Instead, you should use Gtk.IconTheme.lookup_icon_for_scale(), as the assets loaded for a given scaling factor may be different.

New in version 2.4.

lookup_icon_for_scale(icon_name, size, scale, flags)[source]
Parameters:
  • icon_name (str) – the name of the icon to lookup
  • size (int) – desired icon size
  • scale (int) – the desired scale
  • flags (Gtk.IconLookupFlags) – flags modifying the behavior of the icon lookup
Returns:

a Gtk.IconInfo object containing information about the icon, or None if the icon wasn’t found.

Return type:

Gtk.IconInfo or None

Looks up a named icon for a particular window scale and returns a Gtk.IconInfo containing information such as the filename of the icon. The icon can then be rendered into a pixbuf using Gtk.IconInfo.load_icon(). (Gtk.IconTheme.load_icon() combines these two steps if all you need is the pixbuf.)

New in version 3.10.

prepend_search_path(path)[source]
Parameters:path (str) – directory name to prepend to the icon path

Prepends a directory to the search path. See Gtk.IconTheme.set_search_path().

New in version 2.4.

rescan_if_needed()[source]
Returns:True if the icon theme has changed and needed to be reloaded.
Return type:bool

Checks to see if the icon theme has changed; if it has, any currently cached information is discarded and will be reloaded next time self is accessed.

New in version 2.4.

set_custom_theme(theme_name)[source]
Parameters:theme_name (str or None) – name of icon theme to use instead of configured theme, or None to unset a previously set custom theme

Sets the name of the icon theme that the Gtk.IconTheme object uses overriding system configuration. This function cannot be called on the icon theme objects returned from Gtk.IconTheme.get_default() and Gtk.IconTheme.get_for_screen().

New in version 2.4.

set_screen(screen)[source]
Parameters:screen (Gdk.Screen) – a Gdk.Screen

Sets the screen for an icon theme; the screen is used to track the user’s currently configured icon theme, which might be different for different screens.

New in version 2.4.

set_search_path(path)[source]
Parameters:path ([str]) – array of directories that are searched for icon themes

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.)

New in version 2.4.

do_changed() virtual

Signal Details

Gtk.IconTheme.signals.changed(icon_theme)
Signal Name:changed
Flags:RUN_LAST
Parameters:icon_theme (Gtk.IconTheme) – The object which received the signal

Emitted when the current icon theme is switched or GTK+ detects that a change has occurred in the contents of the current icon theme.