IconFactory

Object Hierarchy:

Description:

[ CCode ( type_id = "gtk_icon_factory_get_type ()" ) ]
[ Version ( deprecated = true , deprecated_since = "3.10" , replacement = "IconTheme" ) ]
public class IconFactory : Object, Buildable

Warning: IconFactory is deprecated since 3.10. Use IconTheme.

An icon factory manages a collection of IconSet; a IconSet manages a set of variants of a particular icon (i.

e. a IconSet 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 Style has a list of IconFactory 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 add_default and remove_default. 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 lookup_icon_set on the widget that will display the icon, or the convenience function render_icon. These functions take the theme into account when looking up the icon to use for a given stock ID.

GtkIconFactory as GtkBuildable

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 IconSize enum value. This attribute is optional.
direction
Direction of the source, a TextDirection enum value. This attribute is optional.
state
State of the source, a StateType enum value. This attribute is optional.

A IconFactory 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>

Namespace: Gtk

Package: gtk+-3.0

Content:

Static methods:

public static unowned IconSet lookup_default (string stock_id)
Looks for an icon in the list of default icon factories.

Creation methods:

public IconFactory ()
Creates a new IconFactory.

Methods:

public void add (string stock_id, IconSet icon_set)
Adds the given icon_set to the icon factory, under the name stock_id.
public void add_default ()
Adds an icon factory to the list of icon factories searched by lookup_icon_set.
public unowned IconSet lookup (string stock_id)
Looks up stock_id in the icon factory, returning an icon set if found, otherwise null.
public void remove_default ()
Removes an icon factory from the list of default icon factories.

Inherited Members:

All known members inherited from class GLib.Object

All known members inherited from interface Gtk.Buildable