IconFactory

An icon factory manages a collection of #GtkIconSet; a #GtkIconSet manages a set of variants of a particular icon (i.e. a #GtkIconSet contains variants for different sizes and widget states). Icons in an icon factory are named by a stock ID, which is a simple string identifying the icon. Each #GtkStyle has a list of #GtkIconFactory derived from the current theme; those icon factories are consulted first when searching for an icon. If the theme doesn’t set a particular icon, GTK+ looks for the icon in a list of default icon factories, maintained by gtk.icon_factory.IconFactory.addDefault and gtk.icon_factory.IconFactory.removeDefault. Applications with icons should add a default icon factory with their icons, which will allow themes to override the icons for the application.

To display an icon, always use gtk.style.Style.lookupIconSet on the widget that will display the icon, or the convenience function gtk.widget.Widget.renderIcon. These functions take the theme into account when looking up the icon to use for a given stock ID.

GtkIconFactory as GtkBuildable # {#GtkIconFactory-BUILDER-UI}

GtkIconFactory supports a custom <sources> element, which can contain multiple <source> elements. The following attributes are allowed:

stock-id
The stock id of the source, a string. This attribute is mandatory
filename
The filename of the source, a string. This attribute is optional
icon-name
The icon name for the source, a string. This attribute is optional.
size
Size of the icon, a #GtkIconSize enum value. This attribute is optional.
direction
Direction of the source, a #GtkTextDirection enum value. This attribute is optional.
state
State of the source, a #GtkStateType enum value. This attribute is optional.

More...

class IconFactory : ObjectWrap , Buildable {

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

static GType _getGType();

GType _gType [@property getter];

IconFactory self();

static IconFactoryGidBuilder builder();

this();

static gtk.icon_set.IconSet lookupDefault(string stockId);

void add(string stockId, gtk.icon_set.IconSet iconSet);

void addDefault();

gtk.icon_set.IconSet lookup(string stockId);

void removeDefault();

}

Constructors

this this(void* ptr, Flag!"Take" take)
this this(): Creates a new #GtkIconFactory. An icon factory manages a collection of #GtkIconSets; a #GtkIconSet manages a set of variants of a particular icon (i.e. a #GtkIconSet contains variants for different sizes and widget states). Icons in an icon factory are named by a stock ID, which is a simple string identifying the icon. Each #GtkStyle has a list of #GtkIconFactorys derived from the current theme; those icon factories are consulted first when searching for an icon. If the theme doesn’t set a particular icon, GTK+ looks for the icon in a list of default icon factories, maintained by gtk.icon_factory.IconFactory.addDefault and gtk.icon_factory.IconFactory.removeDefault. Applications with icons should add a default icon factory with their icons, which will allow themes to override the icons for the application.

Members

Functions

add void add(string stockId, gtk.icon_set.IconSet iconSet): Adds the given icon_set to the icon factory, under the name stock_id. stock_id should be namespaced for your application, e.g. “myapp-whatever-icon”. Normally applications create a #GtkIconFactory, then add it to the list of default factories with gtk.icon_factory.IconFactory.addDefault. Then they pass the stock_id to widgets such as #GtkImage to display the icon. Themes can provide an icon with the same name (such as "myapp-whatever-icon") to override your application’s default icons. If an icon already existed in factory for stock_id, it is unreferenced and replaced with the new icon_set.
addDefault void addDefault(): Adds an icon factory to the list of icon factories searched by gtk.style.Style.lookupIconSet. This means that, for example, gtk.image.Image.newFromStock will be able to find icons in factory. There will normally be an icon factory added for each library or application that comes with icons. The default icon factories can be overridden by themes.
lookup gtk.icon_set.IconSet lookup(string stockId): Looks up stock_id in the icon factory, returning an icon set if found, otherwise null. For display to the user, you should use gtk.style.Style.lookupIconSet on the #GtkStyle for the widget that will display the icon, instead of using this function directly, so that themes are taken into account.
removeDefault void removeDefault(): Removes an icon factory from the list of default icon factories. Not normally used; you might use it for a library that can be unloaded or shut down.
self IconFactory self(): Returns this, for use in with statements.

Properties

_gType GType _gType [@property getter]

Static functions

_getGType GType _getGType()
builder IconFactoryGidBuilder builder(): Get builder for gtk.icon_factory.IconFactory
lookupDefault gtk.icon_set.IconSet lookupDefault(string stockId): Looks for an icon in the list of default icon factories. For display to the user, you should use gtk.style.Style.lookupIconSet on the #GtkStyle for the widget that will display the icon, instead of using this function directly, so that themes are taken into account.

Mixed In Members

From `mixin BuildableT!()`

addChild void addChild(gtk.builder.Builder builder, gobject.object.ObjectWrap child, string type): Adds a child to buildable. type is an optional string describing how the child should be added.
constructChild gobject.object.ObjectWrap constructChild(gtk.builder.Builder builder, string name): Constructs a child of buildable with the name name.
customFinished void customFinished(gtk.builder.Builder builder, gobject.object.ObjectWrap child, string tagname, void* data): This is similar to gtk.buildable.Buildable.parserFinished but is called once for each custom tag handled by the buildable.
customTagStart bool customTagStart(gtk.builder.Builder builder, gobject.object.ObjectWrap child, string tagname, glib.types.MarkupParser parser, void* data): This is called for each unknown element under <child>.
getInternalChild gobject.object.ObjectWrap getInternalChild(gtk.builder.Builder builder, string childname): Get the internal child called childname of the buildable object.
getName string getName(): Gets the name of the buildable object.
parserFinished void parserFinished(gtk.builder.Builder builder): Called when the builder finishes the parsing of a [GtkBuilder UI definition][BUILDER-UI]. Note that this will be called once for each time gtk.builder.Builder.addFromFile or gtk.builder.Builder.addFromString is called on a builder.
setBuildableProperty void setBuildableProperty(gtk.builder.Builder builder, string name, gobject.value.Value value): Sets the property name name to value on the buildable object.
setName void setName(string name): Sets the name of the buildable object.

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.

From Buildable

_getGType GType _getGType()
addChild void addChild(gtk.builder.Builder builder, gobject.object.ObjectWrap child, string type): Adds a child to buildable. type is an optional string describing how the child should be added.
constructChild gobject.object.ObjectWrap constructChild(gtk.builder.Builder builder, string name): Constructs a child of buildable with the name name.
customFinished void customFinished(gtk.builder.Builder builder, gobject.object.ObjectWrap child, string tagname, void* data): This is similar to gtk.buildable.Buildable.parserFinished but is called once for each custom tag handled by the buildable.
customTagStart bool customTagStart(gtk.builder.Builder builder, gobject.object.ObjectWrap child, string tagname, glib.types.MarkupParser parser, void* data): This is called for each unknown element under <child>.
getInternalChild gobject.object.ObjectWrap getInternalChild(gtk.builder.Builder builder, string childname): Get the internal child called childname of the buildable object.
getName string getName(): Gets the name of the buildable object.
parserFinished void parserFinished(gtk.builder.Builder builder): Called when the builder finishes the parsing of a [GtkBuilder UI definition][BUILDER-UI]. Note that this will be called once for each time gtk.builder.Builder.addFromFile or gtk.builder.Builder.addFromString is called on a builder.
setBuildableProperty void setBuildableProperty(gtk.builder.Builder builder, string name, gobject.value.Value value): Sets the property name name to value on the buildable object.
setName void setName(string name): Sets the name of the buildable object.

Detailed Description

A #GtkIconFactory UI definition fragment. ##

<object class="GtkIconFactory" id="iconfactory1">
  <sources>
    <source stock-id="apple-red" filename="apple-red.png"/>
  </sources>
</object>
<object class="GtkWindow" id="window1">
  <child>
    <object class="GtkButton" id="apple_button">
      <property name="label">apple-red</property>
      <property name="use-stock">True</property>
    </object>
  </child>
</object>

gtk icon_factory classes

IconFactory

GtkIconFactory as GtkBuildable # {#GtkIconFactory-BUILDER-UI}

From mixin BuildableT!()

From `mixin BuildableT!()`