IconTheme

gtk.icon_theme.IconTheme 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 gtk.image.Image rather than directly, but looking up icons directly is also simple. The gtk.icon_theme.IconTheme object acts as a database of all the icons in the current theme. You can create new gtk.icon_theme.IconTheme objects, but it’s much more efficient to use the standard icon theme of the gtk.widget.Widget 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);

class IconTheme : ObjectG {

this();

static gtk.icon_theme.IconTheme getForDisplay(gdk.display.Display display);

void addResourcePath(string path);

void addSearchPath(string path);

gdk.display.Display getDisplay();

string[] getIconNames();

int[] getIconSizes(string iconName);

string[] getResourcePath();

string[] getSearchPath();

string getThemeName();

bool hasGicon(gio.icon.Icon gicon);

bool hasIcon(string iconName);

gtk.icon_paintable.IconPaintable lookupByGicon(gio.icon.Icon icon, int size, int scale, gtk.types.TextDirection direction, gtk.types.IconLookupFlags flags);

gtk.icon_paintable.IconPaintable lookupIcon(string iconName, string[] fallbacks, int size, int scale, gtk.types.TextDirection direction, gtk.types.IconLookupFlags flags);

void setResourcePath(string[] path);

void setSearchPath(string[] path);

void setThemeName(string themeName);

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

}

Constructors

this this(): Creates a new icon theme object.

Members

Functions

addResourcePath void addResourcePath(string path): Adds a resource path that will be looked at when looking for icons, similar to search paths.
addSearchPath void addSearchPath(string path): Appends a directory to the search path.
connectChanged ulong connectChanged(T callback, Flag!"After" after): Connect to Changed signal.
getDisplay gdk.display.Display getDisplay(): Returns the display that the gtk.icon_theme.IconTheme object was created for.
getIconNames string[] getIconNames(): Lists the names of icons in the current icon theme.
getIconSizes int[] getIconSizes(string iconName): Returns an array of integers describing the sizes at which the icon is available without scaling.
getResourcePath string[] getResourcePath(): Gets the current resource path.
getSearchPath string[] getSearchPath(): Gets the current search path.
getThemeName string getThemeName(): Gets the current icon theme name.
hasGicon bool hasGicon(gio.icon.Icon gicon): Checks whether an icon theme includes an icon for a particular gio.icon.Icon.
hasIcon bool hasIcon(string iconName): Checks whether an icon theme includes an icon for a particular name.
lookupByGicon gtk.icon_paintable.IconPaintable lookupByGicon(gio.icon.Icon icon, int size, int scale, gtk.types.TextDirection direction, gtk.types.IconLookupFlags flags): Looks up a icon for a desired size and window scale.
lookupIcon gtk.icon_paintable.IconPaintable lookupIcon(string iconName, string[] fallbacks, int size, int scale, gtk.types.TextDirection direction, gtk.types.IconLookupFlags flags): Looks up a named icon for a desired size and window scale, returning a gtk.icon_paintable.IconPaintable.
setResourcePath void setResourcePath(string[] path): Sets the resource paths that will be looked at when looking for icons, similar to search paths.
setSearchPath void setSearchPath(string[] path): Sets the search path for the icon theme object.
setThemeName void setThemeName(string themeName): Sets the name of the icon theme that the gtk.icon_theme.IconTheme object uses overriding system configuration.

Static functions

getForDisplay gtk.icon_theme.IconTheme getForDisplay(gdk.display.Display display): Gets the icon theme object associated with display.

Inherited Members

From ObjectG

setGObject void setGObject(void* cObj, Flag!"Take" take): Set the GObject of a D ObjectG 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.
getType GType getType(): Get the GType of an object.
gType GType gType [@property getter]: GObject GType property.
self ObjectG 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 ulong 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.ObjectG 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.ObjectG 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.ObjectG.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.ObjectG.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.ObjectG.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.ObjectG 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.ObjectG.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.ObjectG.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.ObjectG.ref_ and gobject.object.ObjectG.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 ulong connectNotify(string detail, T callback, Flag!"After" after): Connect to Notify signal.

gtk icon_theme classes

IconTheme