IconTheme

#GtkIconTheme 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.types.STOCK_OK or gtk.types.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 #GtkIconSize enumeration, or by custom sizes defined by gtk.global.iconSizeRegister, 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.types.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 #GtkImage or stock items, 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 for the #GdkScreen 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);
  }

class IconTheme : ObjectWrap {

this(void* ptr, Flag!"Take" take);

static GType _getGType();

GType _gType [@property getter];

IconTheme self();

static IconThemeGidBuilder builder();

this();

static void addBuiltinIcon(string iconName, int size, gdkpixbuf.pixbuf.Pixbuf pixbuf);

static gtk.icon_theme.IconTheme getDefault();

static gtk.icon_theme.IconTheme getForScreen(gdk.screen.Screen screen);

void addResourcePath(string path);

void appendSearchPath(string path);

gtk.icon_info.IconInfo chooseIcon(string[] iconNames, int size, gtk.types.IconLookupFlags flags);

gtk.icon_info.IconInfo chooseIconForScale(string[] iconNames, int size, int scale, gtk.types.IconLookupFlags flags);

string getExampleIconName();

int[] getIconSizes(string iconName);

void getSearchPath(string[] path);

bool hasIcon(string iconName);

string[] listContexts();

string[] listIcons(string context);

gdkpixbuf.pixbuf.Pixbuf loadIcon(string iconName, int size, gtk.types.IconLookupFlags flags);

gdkpixbuf.pixbuf.Pixbuf loadIconForScale(string iconName, int size, int scale, gtk.types.IconLookupFlags flags);

cairo.surface.Surface loadSurface(string iconName, int size, int scale, gdk.window.Window forWindow, gtk.types.IconLookupFlags flags);

gtk.icon_info.IconInfo lookupByGicon(gio.icon.Icon icon, int size, gtk.types.IconLookupFlags flags);

gtk.icon_info.IconInfo lookupByGiconForScale(gio.icon.Icon icon, int size, int scale, gtk.types.IconLookupFlags flags);

gtk.icon_info.IconInfo lookupIcon(string iconName, int size, gtk.types.IconLookupFlags flags);

gtk.icon_info.IconInfo lookupIconForScale(string iconName, int size, int scale, gtk.types.IconLookupFlags flags);

void prependSearchPath(string path);

bool rescanIfNeeded();

void setCustomTheme(string themeName);

void setScreen(gdk.screen.Screen screen);

void setSearchPath(string[] path);

gulong connectChanged(T callback, Flag!"After" after);

}

Constructors

this this(void* ptr, Flag!"Take" take)
this this(): 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.icon_theme.IconTheme.getDefault or gtk.icon_theme.IconTheme.getForScreen rather than creating a new icon theme object for scratch.

Members

Functions

addResourcePath void addResourcePath(string path): Adds a resource path that will be looked at when looking for icons, similar to search paths.
appendSearchPath void appendSearchPath(string path): Appends a directory to the search path. See gtk.icon_theme.IconTheme.setSearchPath.
chooseIcon gtk.icon_info.IconInfo chooseIcon(string[] iconNames, int size, gtk.types.IconLookupFlags flags): Looks up a named icon and returns a #GtkIconInfo containing information such as the filename of the icon. The icon can then be rendered into a pixbuf using gtk.icon_info.IconInfo.loadIcon. (gtk.icon_theme.IconTheme.loadIcon combines these two steps if all you need is the pixbuf.)
chooseIconForScale gtk.icon_info.IconInfo chooseIconForScale(string[] iconNames, int size, int scale, gtk.types.IconLookupFlags flags): Looks up a named icon for a particular window scale and returns a #GtkIconInfo containing information such as the filename of the icon. The icon can then be rendered into a pixbuf using gtk.icon_info.IconInfo.loadIcon. (gtk.icon_theme.IconTheme.loadIcon combines these two steps if all you need is the pixbuf.)
connectChanged gulong connectChanged(T callback, Flag!"After" after): Connect to Changed signal.
getExampleIconName string getExampleIconName(): 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.)
getIconSizes int[] getIconSizes(string iconName): 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.
getSearchPath void getSearchPath(string[] path): Gets the current search path. See gtk.icon_theme.IconTheme.setSearchPath.
hasIcon bool hasIcon(string iconName): Checks whether an icon theme includes an icon for a particular name.
listContexts string[] listContexts(): Gets the list of contexts available within the current hierarchy of icon themes. See gtk.icon_theme.IconTheme.listIcons for details about contexts.
listIcons string[] listIcons(string context): 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.icon_theme.IconTheme.listContexts.
loadIcon gdkpixbuf.pixbuf.Pixbuf loadIcon(string iconName, int size, gtk.types.IconLookupFlags flags): 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.icon_theme.IconTheme.lookupIcon followed by gtk.icon_info.IconInfo.loadIcon.
loadIconForScale gdkpixbuf.pixbuf.Pixbuf loadIconForScale(string iconName, int size, int scale, gtk.types.IconLookupFlags flags): 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.icon_theme.IconTheme.lookupIcon followed by gtk.icon_info.IconInfo.loadIcon.
loadSurface cairo.surface.Surface loadSurface(string iconName, int size, int scale, gdk.window.Window forWindow, gtk.types.IconLookupFlags flags): 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.icon_theme.IconTheme.lookupIcon followed by gtk.icon_info.IconInfo.loadSurface.
lookupByGicon gtk.icon_info.IconInfo lookupByGicon(gio.icon.Icon icon, int size, gtk.types.IconLookupFlags flags): Looks up an icon and returns a #GtkIconInfo containing information such as the filename of the icon. The icon can then be rendered into a pixbuf using gtk.icon_info.IconInfo.loadIcon.
lookupByGiconForScale gtk.icon_info.IconInfo lookupByGiconForScale(gio.icon.Icon icon, int size, int scale, gtk.types.IconLookupFlags flags): Looks up an icon and returns a #GtkIconInfo containing information such as the filename of the icon. The icon can then be rendered into a pixbuf using gtk.icon_info.IconInfo.loadIcon.
lookupIcon gtk.icon_info.IconInfo lookupIcon(string iconName, int size, gtk.types.IconLookupFlags flags): Looks up a named icon and returns a #GtkIconInfo containing information such as the filename of the icon. The icon can then be rendered into a pixbuf using gtk.icon_info.IconInfo.loadIcon. (gtk.icon_theme.IconTheme.loadIcon combines these two steps if all you need is the pixbuf.)
lookupIconForScale gtk.icon_info.IconInfo lookupIconForScale(string iconName, int size, int scale, gtk.types.IconLookupFlags flags): Looks up a named icon for a particular window scale and returns a #GtkIconInfo containing information such as the filename of the icon. The icon can then be rendered into a pixbuf using gtk.icon_info.IconInfo.loadIcon. (gtk.icon_theme.IconTheme.loadIcon combines these two steps if all you need is the pixbuf.)
prependSearchPath void prependSearchPath(string path): Prepends a directory to the search path. See gtk.icon_theme.IconTheme.setSearchPath.
rescanIfNeeded bool rescanIfNeeded(): Checks to see if the icon theme has changed; if it has, any currently cached information is discarded and will be reloaded next time icon_theme is accessed.
self IconTheme self(): Returns this, for use in with statements.
setCustomTheme void setCustomTheme(string themeName): 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 gtk.icon_theme.IconTheme.getDefault and gtk.icon_theme.IconTheme.getForScreen.
setScreen void setScreen(gdk.screen.Screen 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.
setSearchPath void setSearchPath(string[] path): 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.)

Properties

_gType GType _gType [@property getter]

Static functions

_getGType GType _getGType()
addBuiltinIcon void addBuiltinIcon(string iconName, int size, gdkpixbuf.pixbuf.Pixbuf pixbuf): 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.
builder IconThemeGidBuilder builder(): Get builder for gtk.icon_theme.IconTheme
getDefault gtk.icon_theme.IconTheme getDefault(): Gets the icon theme for the default screen. See gtk.icon_theme.IconTheme.getForScreen.
getForScreen gtk.icon_theme.IconTheme getForScreen(gdk.screen.Screen screen): 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.icon_theme.IconTheme.new_ and setting the screen yourself; by using this function a single icon theme object will be shared between users.

Inherited Members

From ObjectWrap

_setGObject void _setGObject(void* cObj, Flag!"Take" take): Set the GObject of a D ObjectWrap wrapper.
_cPtr void* _cPtr(Flag!"Dup" dup): Get a pointer to the underlying C object.
_ref void* _ref(void* gObj): Calls g_object_ref() on a GObject.
_unref _unref(void* gObj): Calls g_object_unref() on a GObject.
_getGType GType _getGType(): Get the GType of an object.
_gType GType _gType [@property getter]: GObject GType property.
self ObjectWrap self(): Convenience method to return this cast to a type. For use in D with statements.
_getDObject T _getDObject(void* cptr, Flag!"Take" take): Template to get the D object from a C GObject and cast it to the given D object type.
connectSignalClosure gulong connectSignalClosure(string signalDetail, DClosure closure, Flag!"After" after): Connect a D closure to an object signal.
setProperty void setProperty(string propertyName, T val): Template for setting a GObject property.
getProperty T getProperty(string propertyName): Template for getting a GObject property.
compatControl size_t compatControl(size_t what, void* data)
bindProperty gobject.binding.Binding bindProperty(string sourceProperty, gobject.object.ObjectWrap target, string targetProperty, gobject.types.BindingFlags flags): Creates a binding between source_property on source and target_property on target.
bindPropertyFull gobject.binding.Binding bindPropertyFull(string sourceProperty, gobject.object.ObjectWrap target, string targetProperty, gobject.types.BindingFlags flags, gobject.closure.Closure transformTo, gobject.closure.Closure transformFrom): Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.
forceFloating void forceFloating(): This function is intended for #GObject implementations to re-enforce a floating[floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling gobject.object.ObjectWrap.refSink.
freezeNotify void freezeNotify(): Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one #GObject::notify signal is emitted for each property modified while the object is frozen.
getData void* getData(string key): Gets a named field from the objects table of associations (see gobject.object.ObjectWrap.setData).
getProperty void getProperty(string propertyName, gobject.value.Value value): Gets a property of an object.
getQdata void* getQdata(glib.types.Quark quark): This function gets back user data pointers stored via gobject.object.ObjectWrap.setQdata.
getv void getv(string[] names, gobject.value.Value[] values): Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.
isFloating bool isFloating(): Checks whether object has a floating[floating-ref] reference.
notify void notify(string propertyName): Emits a "notify" signal for the property property_name on object.
notifyByPspec void notifyByPspec(gobject.param_spec.ParamSpec pspec): Emits a "notify" signal for the property specified by pspec on object.
refSink gobject.object.ObjectWrap refSink(): Increase the reference count of object, and possibly remove the floating[floating-ref] reference, if object has a floating reference.
runDispose void runDispose(): Releases all references to other objects. This can be used to break reference cycles.
setData void setData(string key, void* data): Each object carries around a table of associations from strings to pointers. This function lets you set an association.
setProperty void setProperty(string propertyName, gobject.value.Value value): Sets a property on an object.
stealData void* stealData(string key): Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
stealQdata void* stealQdata(glib.types.Quark quark): This function gets back user data pointers stored via gobject.object.ObjectWrap.setQdata and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:
thawNotify void thawNotify(): Reverts the effect of a previous call to gobject.object.ObjectWrap.freezeNotify. The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.
watchClosure void watchClosure(gobject.closure.Closure closure): This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling gobject.closure.Closure.invalidate on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, gobject.object.ObjectWrap.ref_ and gobject.object.ObjectWrap.unref are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.
connectNotify gulong connectNotify(string detail, T callback, Flag!"After" after): Connect to Notify signal.

gtk icon_theme classes