Commit 9e3f0c6f authored by Owen Taylor's avatar Owen Taylor Committed by Owen Taylor
Browse files

Document named icon system.

Wed Jul  2 18:15:21 2003  Owen Taylor  <otaylor@redhat.com>

        * gtk/Makefile.am gtk/gtk-docs.sgml gtk/gtksections.txt
        gtk/tmpl/gtkicontheme.sgml: Document named icon system.

        * gtk/tmpl/gtkrc.sgml: Mention specifying named icons
        as @"icon-name".

        * gtk/tmpl/gtkimage.sgml: Add a cross-reference to stock
        icons.
parent 9adac9b2
Wed Jul 2 18:15:21 2003 Owen Taylor <otaylor@redhat.com>
* gtk/Makefile.am gtk/gtk-docs.sgml gtk/gtksections.txt
gtk/tmpl/gtkicontheme.sgml: Document named icon system.
* gtk/tmpl/gtkrc.sgml: Mention specifying named icons
as @"icon-name".
* gtk/tmpl/gtkimage.sgml: Add a cross-reference to stock
icons.
2003-07-01 Matthias Clasen <maclas@gmx.de>
* gtk/tmpl/gtkcolorbutton.sgml:
......
......@@ -27,6 +27,7 @@ IGNORE_HFILES= \
gdk-pixbuf-loader.h \
gtkdebug.h \
gtkhsv.h \
gtkiconthemeparser.h \
gtkimmodule.h \
gtkintl.h \
gtkkeyhash.h \
......
......@@ -140,6 +140,7 @@
<!ENTITY gtk-Types SYSTEM "xml/gtktypeutils.xml">
<!ENTITY gtk-Bindings SYSTEM "xml/gtkbindings.xml">
<!ENTITY gtk-Standard-Enumerations SYSTEM "xml/gtkenums.xml">
<!ENTITY gtk-Named-Icons SYSTEM "xml/gtkicontheme.xml">
<!ENTITY gtk-Stock-Items SYSTEM "xml/gtkstock.xml">
<!ENTITY gtk-Themeable-Stock-Images SYSTEM "xml/gtkiconfactory.xml">
<!ENTITY gtk-Settings SYSTEM "xml/gtksettings.xml">
......@@ -275,6 +276,7 @@ that is, GUI components such as <link linkend="GtkButton">GtkButton</link> or
&gtk-accel-map;
&gtk-Clipboards;
&gtk-Drag-and-Drop;
&gtk-Named-Icons;
&gtk-Stock-Items;
&gtk-Themeable-Stock-Images;
&gtk-Resource-Files;
......
......@@ -4518,6 +4518,55 @@ GTK_STOCK_ZOOM_IN
GTK_STOCK_ZOOM_OUT
</SECTION>
<SECTION>
<FILE>gtkicontheme</FILE>
<TITLE>GtkIconTheme</TITLE>
GtkIconInfo
GtkIconTheme
GtkIconLookupFlags
GTK_ICON_THEME_ERROR
GtkIconThemeError
gtk_icon_theme_new
gtk_icon_theme_get_default
gtk_icon_theme_get_for_screen
gtk_icon_theme_set_screen
gtk_icon_theme_set_search_path
gtk_icon_theme_get_search_path
gtk_icon_theme_append_search_path
gtk_icon_theme_prepend_search_path
gtk_icon_theme_set_custom_theme
gtk_icon_theme_has_icon
gtk_icon_theme_lookup_icon
gtk_icon_theme_load_icon
gtk_icon_theme_list_icons
gtk_icon_theme_get_example_icon_name
gtk_icon_theme_rescan_if_needed
gtk_icon_theme_add_builtin_icon
gtk_icon_info_copy
gtk_icon_info_free
gtk_icon_info_get_base_size
gtk_icon_info_get_filename
gtk_icon_info_get_builtin_pixbuf
gtk_icon_info_load_icon
gtk_icon_info_set_raw_coordinates
gtk_icon_info_get_embedded_rect
gtk_icon_info_get_attach_points
gtk_icon_info_get_display_name
<SUBSECTION Standard>
GtkIconThemeClass
GTK_ICON_THEME
GTK_IS_ICON_THEME
GTK_TYPE_ICON_THEME
gtk_icon_theme_get_type
GTK_ICON_THEME_CLASS
GTK_IS_ICON_THEME_CLASS
GTK_ICON_THEME_GET_CLASS
gtk_icon_info_get_type
GTK_TYPE_ICON_INFO
<SUBSECTION Private>
GtkIconThemePrivate
gtk_icon_theme_error_quark
</SECTION>
<SECTION>
<FILE>gtkiconfactory</FILE>
......@@ -4552,6 +4601,7 @@ gtk_icon_source_get_direction
gtk_icon_source_get_direction_wildcarded
gtk_icon_source_get_filename
gtk_icon_source_get_pixbuf
gtk_icon_source_get_icon_name
gtk_icon_source_get_size
gtk_icon_source_get_size_wildcarded
gtk_icon_source_get_state
......@@ -4561,6 +4611,7 @@ gtk_icon_source_set_direction
gtk_icon_source_set_direction_wildcarded
gtk_icon_source_set_filename
gtk_icon_source_set_pixbuf
gtk_icon_source_set_icon_name
gtk_icon_source_set_size
gtk_icon_source_set_size_wildcarded
gtk_icon_source_set_state
......
......@@ -47,6 +47,7 @@ gtk_hscale_get_type
gtk_hscrollbar_get_type
gtk_hseparator_get_type
gtk_icon_factory_get_type
gtk_icon_theme_get_type
gtk_im_context_get_type
gtk_im_context_simple_get_type
gtk_im_multicontext_get_type
......
......@@ -72,6 +72,50 @@ space allocated for the #GtkAlignment.
unused space, from 0 to 1. The values are similar to @xscale.
<!-- ##### FUNCTION gtk_alignment_get_padding ##### -->
<para>
</para>
@alignment:
@padding_top:
@padding_bottom:
@padding_left:
@padding_right:
<!-- ##### FUNCTION gtk_alignment_set_padding ##### -->
<para>
</para>
@alignment:
@padding_top:
@padding_bottom:
@padding_left:
@padding_right:
<!-- ##### ARG GtkAlignment:bottom-padding ##### -->
<para>
</para>
<!-- ##### ARG GtkAlignment:left-padding ##### -->
<para>
</para>
<!-- ##### ARG GtkAlignment:right-padding ##### -->
<para>
</para>
<!-- ##### ARG GtkAlignment:top-padding ##### -->
<para>
</para>
<!-- ##### ARG GtkAlignment:xalign ##### -->
<para>
......
......@@ -184,6 +184,24 @@ Returns the current relief style of the given #GtkButton.
@value:
<!-- ##### FUNCTION gtk_button_set_focus_on_click ##### -->
<para>
</para>
@button:
@focus_on_click:
<!-- ##### FUNCTION gtk_button_get_focus_on_click ##### -->
<para>
</para>
@button:
@Returns:
<!-- ##### SIGNAL GtkButton::activate ##### -->
<para>
......@@ -229,6 +247,11 @@ mouse cursor is.
@button: the object which received the signal.
<!-- ##### ARG GtkButton:focus-on-click ##### -->
<para>
</para>
<!-- ##### ARG GtkButton:label ##### -->
<para>
......
......@@ -159,6 +159,24 @@ Remove all visual markers.
@calendar: a #GtkCalendar.
<!-- ##### FUNCTION gtk_calendar_get_display_options ##### -->
<para>
</para>
@calendar:
@Returns:
<!-- ##### FUNCTION gtk_calendar_set_display_options ##### -->
<para>
</para>
@calendar:
@flags:
<!-- ##### FUNCTION gtk_calendar_display_options ##### -->
<para>
Sets display options (whether to display the heading and the month headings).
......@@ -247,3 +265,43 @@ calendar.
@calendar: the object which received the signal.
<!-- ##### ARG GtkCalendar:day ##### -->
<para>
</para>
<!-- ##### ARG GtkCalendar:month ##### -->
<para>
</para>
<!-- ##### ARG GtkCalendar:no-month-change ##### -->
<para>
</para>
<!-- ##### ARG GtkCalendar:show-day-names ##### -->
<para>
</para>
<!-- ##### ARG GtkCalendar:show-heading ##### -->
<para>
</para>
<!-- ##### ARG GtkCalendar:show-week-numbers ##### -->
<para>
</para>
<!-- ##### ARG GtkCalendar:week-start-monday ##### -->
<para>
</para>
<!-- ##### ARG GtkCalendar:year ##### -->
<para>
</para>
......@@ -2,7 +2,7 @@
GtkCellEditable
<!-- ##### SECTION Short_Description ##### -->
Interface for widgets which can are used for editing cells
Interface for widgets which can are used for editing cells
<!-- ##### SECTION Long_Description ##### -->
<para>
......
......@@ -4,7 +4,6 @@ GtkColorButton
<!-- ##### SECTION Short_Description ##### -->
A button to launch a color selection dialog
<!-- ##### SECTION Long_Description ##### -->
<para>
The #GtkColorButton is a button which displays the currently selected color an allows to open a color
......
......@@ -63,7 +63,7 @@ constraints on an entry in a #GtkTargetTable.
@GTK_TARGET_SAME_APP:
If this is set, the target will only be selected
for drags within a single application.
@GTK_TARGET_SAME_WIDGET:
@GTK_TARGET_SAME_WIDGET:
If this is set, the target will only be selected
for drags within a single widget.
......
......@@ -149,6 +149,7 @@ Used to specify the style of the expanders drawn by a #GtkTreeView.
@GTK_IM_PREEDIT_NOTHING:
@GTK_IM_PREEDIT_CALLBACK:
@GTK_IM_PREEDIT_NONE:
<!-- ##### ENUM GtkIMStatusStyle ##### -->
<para>
......@@ -157,6 +158,7 @@ Used to specify the style of the expanders drawn by a #GtkTreeView.
@GTK_IM_STATUS_NOTHING:
@GTK_IM_STATUS_CALLBACK:
@GTK_IM_STATUS_NONE:
<!-- ##### ENUM GtkJustification ##### -->
<para>
......
......@@ -319,6 +319,15 @@ looking up the icon to use for a given stock ID.
@Returns:
<!-- ##### FUNCTION gtk_icon_source_get_icon_name ##### -->
<para>
</para>
@source:
@Returns:
<!-- ##### FUNCTION gtk_icon_source_get_size ##### -->
<para>
......@@ -399,6 +408,15 @@ looking up the icon to use for a given stock ID.
@pixbuf:
<!-- ##### FUNCTION gtk_icon_source_set_icon_name ##### -->
<para>
</para>
@source:
@icon_name:
<!-- ##### FUNCTION gtk_icon_source_set_size ##### -->
<para>
......
<!-- ##### SECTION Title ##### -->
GtkIconTheme
<!-- ##### SECTION Short_Description ##### -->
Looking up icons by name
<!-- ##### SECTION Long_Description ##### -->
<para>
#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 <firstterm>icon theme</firstterm> is selecetd
by the user. The operation of icon themes on Linux and Unix
follows the <ulink
url="http://www.freedesktop.org/standards/icon-theme-spec.html">Icon
Theme Specification</ulink>. There is a default icon theme,
named <literal>hicolor</literal> where applications should install
their icons, but more additional application themes can be
installed as operating system vendors and users choose.
</para>
<para>
Named icons are similar to the <xref linkend="gtk-Themeable-Stock-Images"/>
facility, and the distinction between the two may be a bit confusing.
A few things to keep in mind:
</para>
<itemizedlist>
<listitem>
<para>
Stock images usually are used in conjunction with
<xref linkend="gtk-Stock-Items"/>., such as %GTK_STOCK_OK or
%GTK_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.
</para>
</listitem>
<listitem>
<para>
Stock images can only be loaded at the symbolic sizes defined
by the #GtkIconSize enumeration, or by custom sizes defined
by gtk_icon_size_register(), while named icons are more flexible
and any pixel size can be specified.
</para>
</listitem>
<listitem>
<para>
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.
</para>
</listitem>
</itemizedlist>
<para>
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_STOCK_GO_FORWARD uses the two themed icons
"gtk-stock-go-forward-ltr" and "gtk-stock-go-forward-rtl".)
</para>
<para>
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 its 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. In the case where the default screen is
being used, looking up an icon can be as simple as:
</para>
<informalexample>
<programlisting>
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, /* size */
0, /* flags */);
if (!pixbuf)
{
g_warning ("Couldn't load icon: &percnt;s", error->message);
g_error_free (message);
}
else
{
/* Use the pixbuf */
g_object_unref (pixbuf);
}
</programlisting>
</informalexample>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GtkIconInfo ##### -->
<para>
Contains information found when looking up an icon in
an icon theme.
</para>
<!-- ##### STRUCT GtkIconTheme ##### -->
<para>
Acts as a database of information about an icon theme.
Normally, you retrieve the icon theme for a particular
screen using gtk_icon_theme_get_for_screen() and it
will contain information about current icon theme for
that screen, but you can also create a new #GtkIconTheme
object and set the icon theme name explicitely using
gtk_icon_theme_set_custom_theme().
</para>
<!-- ##### ENUM GtkIconLookupFlags ##### -->
<para>
</para>
@GTK_ICON_LOOKUP_NO_SVG:
@GTK_ICON_LOOKUP_FORCE_SVG:
@GTK_ICON_LOOKUP_USE_BUILTIN:
<!-- ##### MACRO GTK_ICON_THEME_ERROR ##### -->
<para>
</para>
<!-- ##### ENUM GtkIconThemeError ##### -->
<para>
</para>
@GTK_ICON_THEME_NOT_FOUND:
@GTK_ICON_THEME_FAILED:
<!-- ##### FUNCTION gtk_icon_theme_new ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gtk_icon_theme_get_default ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gtk_icon_theme_get_for_screen ##### -->
<para>
</para>
@screen:
@Returns:
<!-- ##### FUNCTION gtk_icon_theme_set_screen ##### -->
<para>
</para>
@icon_theme:
@screen:
<!-- ##### FUNCTION gtk_icon_theme_set_search_path ##### -->
<para>
</para>
@icon_theme:
@path:
@n_elements:
<!-- ##### FUNCTION gtk_icon_theme_get_search_path ##### -->
<para>
</para>
@icon_theme:
@path:
@n_elements:
<!-- ##### FUNCTION gtk_icon_theme_append_search_path ##### -->
<para>
</para>
@icon_theme:
@path:
<!-- ##### FUNCTION gtk_icon_theme_prepend_search_path ##### -->
<para>
</para>
@icon_theme:
@path:
<!-- ##### FUNCTION gtk_icon_theme_set_custom_theme ##### -->
<para>
</para>
@icon_theme:
@theme_name:
<!-- ##### FUNCTION gtk_icon_theme_has_icon ##### -->
<para>
</para>
@icon_theme:
@icon_name:
@Returns:
<!-- ##### FUNCTION gtk_icon_theme_lookup_icon ##### -->
<para>
</para>
@icon_theme:
@icon_name:
@size:
@flags:
@Returns:
<!-- ##### FUNCTION gtk_icon_theme_load_icon ##### -->
<para>
</para>
@icon_theme:
@icon_name:
@size:
@flags:
@error:
@Returns:
<!-- ##### FUNCTION gtk_icon_theme_list_icons ##### -->
<para>
</para>
@icon_theme:
@context:
@Returns:
<!-- ##### FUNCTION gtk_icon_theme_get_example_icon_name ##### -->
<para>
</para>
@icon_theme:
@Returns:
<!-- ##### FUNCTION gtk_icon_theme_rescan_if_needed ##### -->
&l