forked from AuroraMiddleware/gtk
10a173fedf
2001-03-12 Havoc Pennington <hp@redhat.com> * gtk/gtkiconfactory.h, gtk/gtkiconfactory.c: Switch to using an enum with registration for icon sizes, instead of strings. * gtkimage.h, gtkimage.c, gtkstyle.h, gtkstyle.c, gtkwidget.h, gtkwidget.c: Fix to reflect GtkIconSize
226 lines
3.3 KiB
Plaintext
226 lines
3.3 KiB
Plaintext
<!-- ##### SECTION Title ##### -->
|
|
Themeable Stock Images
|
|
|
|
<!-- ##### SECTION Short_Description ##### -->
|
|
|
|
Manipulating stock icons
|
|
|
|
<!-- ##### SECTION Long_Description ##### -->
|
|
<para>
|
|
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_add_default() and
|
|
gtk_icon_factory_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.
|
|
</para>
|
|
|
|
<para>
|
|
To display an icon, always use gtk_style_lookup_icon_set() on the widget that
|
|
will display the icon, or the convenience function
|
|
gtk_widget_render_icon(). These functions take the theme into account when
|
|
looking up the icon to use for a given stock ID.
|
|
</para>
|
|
|
|
<!-- ##### SECTION See_Also ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### STRUCT GtkIconSource ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@filename:
|
|
@pixbuf:
|
|
@direction:
|
|
@state:
|
|
@size:
|
|
@any_direction:
|
|
@any_state:
|
|
@any_size:
|
|
|
|
<!-- ##### STRUCT GtkIconFactory ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@parent_instance:
|
|
@icons:
|
|
|
|
<!-- ##### STRUCT GtkIconSet ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_icon_source_copy ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@source:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_icon_source_free ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@source:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_icon_factory_add ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@factory:
|
|
@stock_id:
|
|
@icon_set:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_icon_factory_add_default ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@factory:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_icon_factory_lookup ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@factory:
|
|
@stock_id:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_icon_factory_lookup_default ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@stock_id:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_icon_factory_new ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_icon_factory_remove_default ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@factory:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_icon_set_add_source ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@icon_set:
|
|
@source:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_icon_set_copy ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@icon_set:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_icon_set_new ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_icon_set_ref ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@icon_set:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_icon_set_render_icon ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@icon_set:
|
|
@style:
|
|
@direction:
|
|
@state:
|
|
@size:
|
|
@widget:
|
|
@detail:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_icon_set_unref ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@icon_set:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_icon_size_lookup ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@size:
|
|
@width:
|
|
@height:
|
|
@Returns:
|
|
<!-- # Unused Parameters # -->
|
|
@alias:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_icon_size_register ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@name:
|
|
@width:
|
|
@height:
|
|
@Returns:
|
|
<!-- # Unused Parameters # -->
|
|
@alias:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_icon_size_register_alias ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@alias:
|
|
@target:
|
|
|
|
|