|
Server : Apache/2.2.17 (Unix) mod_ssl/2.2.17 OpenSSL/0.9.8e-fips-rhel5 DAV/2 PHP/5.2.17 System : Linux localhost 2.6.18-419.el5 #1 SMP Fri Feb 24 22:47:42 UTC 2017 x86_64 User : nobody ( 99) PHP Version : 5.2.17 Disable Function : NONE Directory : /usr/share/gtk-doc/html/gtk/ |
Upload File : |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>GtkIconTheme</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
<link rel="start" href="index.html" title="GTK+ Reference Manual">
<link rel="up" href="gtkbase.html" title="Part II. GTK+ Core Reference">
<link rel="prev" href="gtk-Drag-and-Drop.html" title="Drag and Drop">
<link rel="next" href="gtk-Stock-Items.html" title="Stock Items">
<meta name="generator" content="GTK-Doc V1.6 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="gtk.html" title="Part I. GTK+ Overview">
<link rel="part" href="gtkbase.html" title="Part II. GTK+ Core Reference">
<link rel="part" href="gtkobjects.html" title="Part III. GTK+ Widgets and Objects">
<link rel="chapter" href="ch01.html" title="Object Hierarchy">
<link rel="chapter" href="ch02.html" title="Widget Gallery">
<link rel="chapter" href="WindowWidgets.html" title="Windows">
<link rel="chapter" href="DisplayWidgets.html" title="Display Widgets">
<link rel="chapter" href="ButtonWidgets.html" title="Buttons and Toggles">
<link rel="chapter" href="NumericEntry.html" title="Numeric/Text Data Entry">
<link rel="chapter" href="TextWidgetObjects.html" title="Multiline Text Editor">
<link rel="chapter" href="TreeWidgetObjects.html" title="Tree, List and Icon Grid Widgets">
<link rel="chapter" href="MenusAndCombos.html" title="Menus, Combo Box, Toolbar">
<link rel="chapter" href="Actions.html" title="Action-based menus and toolbars">
<link rel="chapter" href="SelectorWidgets.html" title="Selectors (File/Font/Color/Input Devices)">
<link rel="chapter" href="LayoutContainers.html" title="Layout Containers">
<link rel="chapter" href="Ornaments.html" title="Ornaments">
<link rel="chapter" href="ScrollingWidgets.html" title="Scrolling">
<link rel="chapter" href="Printing.html" title="Printing">
<link rel="chapter" href="MiscObjects.html" title="Miscellaneous">
<link rel="chapter" href="AbstractObjects.html" title="Abstract Base Classes">
<link rel="chapter" href="PlugSocket.html" title="Cross-process Embedding">
<link rel="chapter" href="SpecialObjects.html" title="Special-purpose features">
<link rel="chapter" href="RecentDocuments.html" title="Recently Used Documents">
<link rel="chapter" href="DeprecatedObjects.html" title="Deprecated">
<link rel="part" href="migrating.html" title="Part IV. Migrating from Previous Versions of GTK+">
<link rel="chapter" href="gtk-migrating-checklist.html" title="Migration Checklist">
<link rel="chapter" href="gtk-migrating-GtkFileChooser.html" title="Migrating from GtkFileSelection to GtkFileChooser">
<link rel="chapter" href="gtk-migrating-GtkAction.html" title="Migrating from old menu and toolbar systems to GtkAction">
<link rel="chapter" href="gtk-migrating-GtkComboBox.html" title="Migrating from GtkOptionMenu and GtkCombo to GtkComboBox and
GtkComboBoxEntry">
<link rel="chapter" href="gtk-migrating-GtkIconView.html" title="Migrating from GnomeIconList to GtkIconView">
<link rel="chapter" href="gtk-migrating-GtkAboutDialog.html" title="Migrating from GnomeAbout to GtkAboutDialog">
<link rel="chapter" href="gtk-migrating-GtkColorButton.html" title="Migrating from GnomeColorPicker to GtkColorButton">
<link rel="chapter" href="gtk-migrating-GtkAssistant.html" title="Migrating from GnomeDruid to GtkAssistant">
<link rel="chapter" href="gtk-migrating-GtkRecentChooser.html" title="Migrating from EggRecent to GtkRecentChooser">
<link rel="chapter" href="gtk-migrating-GtkLinkButton.html" title="Migrating from GnomeHRef to GtkLinkButton">
<link rel="part" href="pt05.html" title="Part V. GTK+ Tools">
<link rel="glossary" href="glossary.html" title="Glossary">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of deprecated symbols">
<link rel="index" href="ix03.html" title="Index of new symbols in 2.2">
<link rel="index" href="ix04.html" title="Index of new symbols in 2.4">
<link rel="index" href="ix05.html" title="Index of new symbols in 2.6">
<link rel="index" href="ix06.html" title="Index of new symbols in 2.8">
<link rel="index" href="ix07.html" title="Index of new symbols in 2.10">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="gtk-Drag-and-Drop.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="gtkbase.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GTK+ Reference Manual</th>
<td><a accesskey="n" href="gtk-Stock-Items.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2620200" class="shortcut">Top</a>
 | 
<a href="#id2621147" class="shortcut">Description</a>
 | 
<a href="#id2621073" class="shortcut">Object Hierarchy</a>
 | 
<a href="#id2621097" class="shortcut">Signals</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="GtkIconTheme"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2620200"></a><span class="refentrytitle">GtkIconTheme</span>
</h2>
<p>GtkIconTheme — Looking up icons by name</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
#include <gtk/gtk.h>
<a href="GtkIconTheme.html#GtkIconInfo">GtkIconInfo</a>;
<a href="GtkIconTheme.html#GtkIconTheme-struct">GtkIconTheme</a>;
enum <a href="GtkIconTheme.html#GtkIconLookupFlags">GtkIconLookupFlags</a>;
#define <a href="GtkIconTheme.html#GTK-ICON-THEME-ERROR:CAPS">GTK_ICON_THEME_ERROR</a>
enum <a href="GtkIconTheme.html#GtkIconThemeError">GtkIconThemeError</a>;
<a href="GtkIconTheme.html" title="GtkIconTheme">GtkIconTheme</a>* <a href="GtkIconTheme.html#gtk-icon-theme-new">gtk_icon_theme_new</a> (void);
<a href="GtkIconTheme.html" title="GtkIconTheme">GtkIconTheme</a>* <a href="GtkIconTheme.html#gtk-icon-theme-get-default">gtk_icon_theme_get_default</a> (void);
<a href="GtkIconTheme.html" title="GtkIconTheme">GtkIconTheme</a>* <a href="GtkIconTheme.html#gtk-icon-theme-get-for-screen">gtk_icon_theme_get_for_screen</a> (<a
href="../gdk/GdkScreen.html"
>GdkScreen</a> *screen);
void <a href="GtkIconTheme.html#gtk-icon-theme-set-screen">gtk_icon_theme_set_screen</a> (<a href="GtkIconTheme.html" title="GtkIconTheme">GtkIconTheme</a> *icon_theme,
<a
href="../gdk/GdkScreen.html"
>GdkScreen</a> *screen);
void <a href="GtkIconTheme.html#gtk-icon-theme-set-search-path">gtk_icon_theme_set_search_path</a> (<a href="GtkIconTheme.html" title="GtkIconTheme">GtkIconTheme</a> *icon_theme,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *path[],
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> n_elements);
void <a href="GtkIconTheme.html#gtk-icon-theme-get-search-path">gtk_icon_theme_get_search_path</a> (<a href="GtkIconTheme.html" title="GtkIconTheme">GtkIconTheme</a> *icon_theme,
<a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> **path[],
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *n_elements);
void <a href="GtkIconTheme.html#gtk-icon-theme-append-search-path">gtk_icon_theme_append_search_path</a>
(<a href="GtkIconTheme.html" title="GtkIconTheme">GtkIconTheme</a> *icon_theme,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *path);
void <a href="GtkIconTheme.html#gtk-icon-theme-prepend-search-path">gtk_icon_theme_prepend_search_path</a>
(<a href="GtkIconTheme.html" title="GtkIconTheme">GtkIconTheme</a> *icon_theme,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *path);
void <a href="GtkIconTheme.html#gtk-icon-theme-set-custom-theme">gtk_icon_theme_set_custom_theme</a> (<a href="GtkIconTheme.html" title="GtkIconTheme">GtkIconTheme</a> *icon_theme,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *theme_name);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="GtkIconTheme.html#gtk-icon-theme-has-icon">gtk_icon_theme_has_icon</a> (<a href="GtkIconTheme.html" title="GtkIconTheme">GtkIconTheme</a> *icon_theme,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *icon_name);
<a href="GtkIconTheme.html#GtkIconInfo">GtkIconInfo</a>* <a href="GtkIconTheme.html#gtk-icon-theme-lookup-icon">gtk_icon_theme_lookup_icon</a> (<a href="GtkIconTheme.html" title="GtkIconTheme">GtkIconTheme</a> *icon_theme,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *icon_name,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> size,
<a href="GtkIconTheme.html#GtkIconLookupFlags">GtkIconLookupFlags</a> flags);
<a
href="../gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
>GdkPixbuf</a>* <a href="GtkIconTheme.html#gtk-icon-theme-load-icon">gtk_icon_theme_load_icon</a> (<a href="GtkIconTheme.html" title="GtkIconTheme">GtkIconTheme</a> *icon_theme,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *icon_name,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> size,
<a href="GtkIconTheme.html#GtkIconLookupFlags">GtkIconLookupFlags</a> flags,
<a
href="../glib/glib-Error-Reporting.html#GError"
>GError</a> **error);
<a
href="../glib/glib-Doubly-Linked-Lists.html#GList"
>GList</a>* <a href="GtkIconTheme.html#gtk-icon-theme-list-icons">gtk_icon_theme_list_icons</a> (<a href="GtkIconTheme.html" title="GtkIconTheme">GtkIconTheme</a> *icon_theme,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *context);
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a>* <a href="GtkIconTheme.html#gtk-icon-theme-get-icon-sizes">gtk_icon_theme_get_icon_sizes</a> (<a href="GtkIconTheme.html" title="GtkIconTheme">GtkIconTheme</a> *icon_theme,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *icon_name);
char* <a href="GtkIconTheme.html#gtk-icon-theme-get-example-icon-name">gtk_icon_theme_get_example_icon_name</a>
(<a href="GtkIconTheme.html" title="GtkIconTheme">GtkIconTheme</a> *icon_theme);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="GtkIconTheme.html#gtk-icon-theme-rescan-if-needed">gtk_icon_theme_rescan_if_needed</a> (<a href="GtkIconTheme.html" title="GtkIconTheme">GtkIconTheme</a> *icon_theme);
void <a href="GtkIconTheme.html#gtk-icon-theme-add-builtin-icon">gtk_icon_theme_add_builtin_icon</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *icon_name,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> size,
<a
href="../gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
>GdkPixbuf</a> *pixbuf);
<a href="GtkIconTheme.html#GtkIconInfo">GtkIconInfo</a>* <a href="GtkIconTheme.html#gtk-icon-info-copy">gtk_icon_info_copy</a> (<a href="GtkIconTheme.html#GtkIconInfo">GtkIconInfo</a> *icon_info);
void <a href="GtkIconTheme.html#gtk-icon-info-free">gtk_icon_info_free</a> (<a href="GtkIconTheme.html#GtkIconInfo">GtkIconInfo</a> *icon_info);
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> <a href="GtkIconTheme.html#gtk-icon-info-get-base-size">gtk_icon_info_get_base_size</a> (<a href="GtkIconTheme.html#GtkIconInfo">GtkIconInfo</a> *icon_info);
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a href="GtkIconTheme.html#gtk-icon-info-get-filename">gtk_icon_info_get_filename</a> (<a href="GtkIconTheme.html#GtkIconInfo">GtkIconInfo</a> *icon_info);
<a
href="../gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
>GdkPixbuf</a>* <a href="GtkIconTheme.html#gtk-icon-info-get-builtin-pixbuf">gtk_icon_info_get_builtin_pixbuf</a>
(<a href="GtkIconTheme.html#GtkIconInfo">GtkIconInfo</a> *icon_info);
<a
href="../gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
>GdkPixbuf</a>* <a href="GtkIconTheme.html#gtk-icon-info-load-icon">gtk_icon_info_load_icon</a> (<a href="GtkIconTheme.html#GtkIconInfo">GtkIconInfo</a> *icon_info,
<a
href="../glib/glib-Error-Reporting.html#GError"
>GError</a> **error);
void <a href="GtkIconTheme.html#gtk-icon-info-set-raw-coordinates">gtk_icon_info_set_raw_coordinates</a>
(<a href="GtkIconTheme.html#GtkIconInfo">GtkIconInfo</a> *icon_info,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> raw_coordinates);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="GtkIconTheme.html#gtk-icon-info-get-embedded-rect">gtk_icon_info_get_embedded_rect</a> (<a href="GtkIconTheme.html#GtkIconInfo">GtkIconInfo</a> *icon_info,
<a
href="../gdk/gdk-Points-Rectangles-and-Regions.html#GdkRectangle"
>GdkRectangle</a> *rectangle);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="GtkIconTheme.html#gtk-icon-info-get-attach-points">gtk_icon_info_get_attach_points</a> (<a href="GtkIconTheme.html#GtkIconInfo">GtkIconInfo</a> *icon_info,
<a
href="../gdk/gdk-Points-Rectangles-and-Regions.html#GdkPoint"
>GdkPoint</a> **points,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *n_points);
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a href="GtkIconTheme.html#gtk-icon-info-get-display-name">gtk_icon_info_get_display_name</a> (<a href="GtkIconTheme.html#GtkIconInfo">GtkIconInfo</a> *icon_info);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2621073"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
+----GtkIconTheme
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2621097"></a><h2>Signals</h2>
<pre class="synopsis">
"<a href="GtkIconTheme.html#GtkIconTheme-changed">changed</a>" void user_function (<a href="GtkIconTheme.html" title="GtkIconTheme">GtkIconTheme</a> *icon_theme,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2621147"></a><h2>Description</h2>
<p>
<a href="GtkIconTheme.html" title="GtkIconTheme"><span class="type">GtkIconTheme</span></a> 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 <em class="firstterm">icon theme</em> is selecetd
by the user. The operation of icon themes on Linux and Unix
follows the <a href="http://www.freedesktop.org/Standards/icon-theme-spec" target="_top">Icon
Theme Specification</a>. There is a default icon theme,
named <code class="literal">hicolor</code> where applications should install
their icons, but more additional application themes can be
installed as operating system vendors and users choose.
</p>
<p>
Named icons are similar to the <a href="gtk-Themeable-Stock-Images.html" title="Themeable Stock Images"><a name="id2642571"></a><span class="refentrytitle">Themeable Stock Images</span>(3)</a>
facility, and the distinction between the two may be a bit confusing.
A few things to keep in mind:
</p>
<div class="itemizedlist"><ul type="disc">
<li><p>
Stock images usually are used in conjunction with
<a href="gtk-Stock-Items.html" title="Stock Items"><a name="id2630871"></a><span class="refentrytitle">Stock Items</span>(3)</a>., such as <a href="gtk-Stock-Items.html#GTK-STOCK-OK:CAPS"><code class="literal">GTK_STOCK_OK</code></a> or
<a href="gtk-Stock-Items.html#GTK-STOCK-OPEN:CAPS"><code class="literal">GTK_STOCK_OPEN</code></a>. 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.
</p></li>
<li><p>
Stock images can only be loaded at the symbolic sizes defined
by the <a href="gtk-Themeable-Stock-Images.html#GtkIconSize"><span class="type">GtkIconSize</span></a> enumeration, or by custom sizes defined
by <a href="gtk-Themeable-Stock-Images.html#gtk-icon-size-register"><code class="function">gtk_icon_size_register()</code></a>, while named icons are more flexible
and any pixel size can be specified.
</p></li>
<li><p>
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.
</p></li>
</ul></div>
<p>
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".)
</p>
<p>
In many cases, named themes are used indirectly, via <a href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a>
or stock items, rather than directly, but looking up icons
directly is also simple. The <a href="GtkIconTheme.html" title="GtkIconTheme"><span class="type">GtkIconTheme</span></a> object acts
as a database of all the icons in the current theme. You
can create new <a href="GtkIconTheme.html" title="GtkIconTheme"><span class="type">GtkIconTheme</span></a> objects, but its much more
efficient to use the standard icon theme for the <a
href="../gdk/GdkScreen.html"
><span class="type">GdkScreen</span></a>
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:
</p>
<div class="informalexample"><pre class="programlisting">
GError *error = NULL;
GtkIconTheme *icon_theme;
GdkPixbuf *pixbuf;
icon_theme = <a href="GtkIconTheme.html#gtk-icon-theme-get-default"><code class="function">gtk_icon_theme_get_default()</code></a>;
pixbuf = gtk_icon_theme_load_icon (icon_theme,
"my-icon-name", /* icon name */
48, /* size */
0, /* flags */
&error);
if (!pixbuf)
{
g_warning ("Couldn't load icon: %s", error->message);
g_error_free (error);
}
else
{
/* Use the pixbuf */
g_object_unref (pixbuf);
}
</pre></div>
</div>
<div class="refsect1" lang="en">
<a name="id2621365"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2621387"></a><h3>
<a name="GtkIconInfo"></a>GtkIconInfo</h3>
<a class="indexterm" name="id2621399"></a><pre class="programlisting">typedef struct _GtkIconInfo GtkIconInfo;</pre>
<p>
Contains information found when looking up an icon in
an icon theme.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2621415"></a><h3>
<a name="GtkIconTheme-struct"></a>GtkIconTheme</h3>
<a class="indexterm" name="id2621428"></a><pre class="programlisting">typedef struct _GtkIconTheme GtkIconTheme;</pre>
<p>
Acts as a database of information about an icon theme.
Normally, you retrieve the icon theme for a particular
screen using <a href="GtkIconTheme.html#gtk-icon-theme-get-for-screen"><code class="function">gtk_icon_theme_get_for_screen()</code></a> and it
will contain information about current icon theme for
that screen, but you can also create a new <a href="GtkIconTheme.html" title="GtkIconTheme"><span class="type">GtkIconTheme</span></a>
object and set the icon theme name explicitely using
<a href="GtkIconTheme.html#gtk-icon-theme-set-custom-theme"><code class="function">gtk_icon_theme_set_custom_theme()</code></a>.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2621479"></a><h3>
<a name="GtkIconLookupFlags"></a>enum GtkIconLookupFlags</h3>
<a class="indexterm" name="id2621492"></a><pre class="programlisting">typedef enum
{
GTK_ICON_LOOKUP_NO_SVG = 1 << 0,
GTK_ICON_LOOKUP_FORCE_SVG = 1 << 1,
GTK_ICON_LOOKUP_USE_BUILTIN = 1 << 2
} GtkIconLookupFlags;
</pre>
<p>
Used to specify options for <a href="GtkIconTheme.html#gtk-icon-theme-lookup-icon"><code class="function">gtk_icon_theme_lookup_icon()</code></a></p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><a name="GTK-ICON-LOOKUP-NO-SVG:CAPS"></a><code class="literal">GTK_ICON_LOOKUP_NO_SVG</code></span></td>
<td> Never return SVG icons, even if gdk-pixbuf
supports them. Cannot be used together with <a href="GtkIconTheme.html#GTK-ICON-LOOKUP-FORCE-SVG:CAPS"><code class="literal">GTK_ICON_LOOKUP_FORCE_SVG</code></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><a name="GTK-ICON-LOOKUP-FORCE-SVG:CAPS"></a><code class="literal">GTK_ICON_LOOKUP_FORCE_SVG</code></span></td>
<td> Return SVG icons, even if gdk-pixbuf
doesn't support them.
Cannot be used together with <a href="GtkIconTheme.html#GTK-ICON-LOOKUP-NO-SVG:CAPS"><code class="literal">GTK_ICON_LOOKUP_NO_SVG</code></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><a name="GTK-ICON-LOOKUP-USE-BUILTIN:CAPS"></a><code class="literal">GTK_ICON_LOOKUP_USE_BUILTIN</code></span></td>
<td> When passed to
<a href="GtkIconTheme.html#gtk-icon-theme-lookup-icon"><code class="function">gtk_icon_theme_lookup_icon()</code></a> includes builtin icons
as well as files. For a builtin icon, <a href="GtkIconTheme.html#gtk-icon-info-get-filename"><code class="function">gtk_icon_info_get_filename()</code></a>
returns <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a> and you need to call <a href="GtkIconTheme.html#gtk-icon-info-get-builtin-pixbuf"><code class="function">gtk_icon_info_get_builtin_pixbuf()</code></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2621669"></a><h3>
<a name="GTK-ICON-THEME-ERROR:CAPS"></a>GTK_ICON_THEME_ERROR</h3>
<a class="indexterm" name="id2621683"></a><pre class="programlisting">#define GTK_ICON_THEME_ERROR gtk_icon_theme_error_quark ()
</pre>
<p>
The <a
href="../glib/glib-Quarks.html#GQuark"
><span class="type">GQuark</span></a> used for <a href="GtkIconTheme.html#GtkIconThemeError"><span class="type">GtkIconThemeError</span></a> errors.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2621715"></a><h3>
<a name="GtkIconThemeError"></a>enum GtkIconThemeError</h3>
<a class="indexterm" name="id2621728"></a><pre class="programlisting">typedef enum {
GTK_ICON_THEME_NOT_FOUND,
GTK_ICON_THEME_FAILED
} GtkIconThemeError;
</pre>
<p>
Error codes for GtkIconTheme operations.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><a name="GTK-ICON-THEME-NOT-FOUND:CAPS"></a><code class="literal">GTK_ICON_THEME_NOT_FOUND</code></span></td>
<td> The icon specified does not exist in the theme
</td>
</tr>
<tr>
<td>
<span class="term"><a name="GTK-ICON-THEME-FAILED:CAPS"></a><code class="literal">GTK_ICON_THEME_FAILED</code></span></td>
<td> An unspecified error occurred.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2621798"></a><h3>
<a name="gtk-icon-theme-new"></a>gtk_icon_theme_new ()</h3>
<a class="indexterm" name="id2621814"></a><pre class="programlisting"><a href="GtkIconTheme.html" title="GtkIconTheme">GtkIconTheme</a>* gtk_icon_theme_new (void);</pre>
<p>
Creates a new icon theme object. Icon theme objects are used
to lookup up an icon by name in a particular icon theme.
Usually, you'll want to use <a href="GtkIconTheme.html#gtk-icon-theme-get-default"><code class="function">gtk_icon_theme_get_default()</code></a>
or <a href="GtkIconTheme.html#gtk-icon-theme-get-for-screen"><code class="function">gtk_icon_theme_get_for_screen()</code></a> rather than creating
a new icon theme object for scratch.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the newly created <a href="GtkIconTheme.html" title="GtkIconTheme"><span class="type">GtkIconTheme</span></a> object.
</td>
</tr></tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2621892"></a><h3>
<a name="gtk-icon-theme-get-default"></a>gtk_icon_theme_get_default ()</h3>
<a class="indexterm" name="id2621908"></a><pre class="programlisting"><a href="GtkIconTheme.html" title="GtkIconTheme">GtkIconTheme</a>* gtk_icon_theme_get_default (void);</pre>
<p>
Gets the icon theme for the default screen. See
<a href="GtkIconTheme.html#gtk-icon-theme-get-for-screen"><code class="function">gtk_icon_theme_get_for_screen()</code></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> A unique <a href="GtkIconTheme.html" title="GtkIconTheme"><span class="type">GtkIconTheme</span></a> associated with
the default screen. This icon theme is associated with
the screen and can be used as long as the screen
is open. Do not ref or unref it.
</td>
</tr></tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2621975"></a><h3>
<a name="gtk-icon-theme-get-for-screen"></a>gtk_icon_theme_get_for_screen ()</h3>
<a class="indexterm" name="id2621991"></a><pre class="programlisting"><a href="GtkIconTheme.html" title="GtkIconTheme">GtkIconTheme</a>* gtk_icon_theme_get_for_screen (<a
href="../gdk/GdkScreen.html"
>GdkScreen</a> *screen);</pre>
<p>
Gets the icon theme object associated with <em class="parameter"><code>screen</code></em>; if this
function has not previously been called for the given
screen, a new icon theme object will be created and
associated with the screen. Icon theme objects are
fairly expensive to create, so using this function
is usually a better choice than calling than <a href="GtkIconTheme.html#gtk-icon-theme-new"><code class="function">gtk_icon_theme_new()</code></a>
and setting the screen yourself; by using this function
a single icon theme object will be shared between users.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>screen</code></em> :</span></td>
<td> a <a
href="../gdk/GdkScreen.html"
><span class="type">GdkScreen</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> A unique <a href="GtkIconTheme.html" title="GtkIconTheme"><span class="type">GtkIconTheme</span></a> associated with
the given screen. This icon theme is associated with
the screen and can be used as long as the screen
is open. Do not ref or unref it.
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2622097"></a><h3>
<a name="gtk-icon-theme-set-screen"></a>gtk_icon_theme_set_screen ()</h3>
<a class="indexterm" name="id2622113"></a><pre class="programlisting">void gtk_icon_theme_set_screen (<a href="GtkIconTheme.html" title="GtkIconTheme">GtkIconTheme</a> *icon_theme,
<a
href="../gdk/GdkScreen.html"
>GdkScreen</a> *screen);</pre>
<p>
Sets the screen for an icon theme; the screen is used
to track the user's currently configured icon theme,
which might be different for different screens.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>icon_theme</code></em> :</span></td>
<td> a <a href="GtkIconTheme.html" title="GtkIconTheme"><span class="type">GtkIconTheme</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>screen</code></em> :</span></td>
<td> a <a
href="../gdk/GdkScreen.html"
><span class="type">GdkScreen</span></a>
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2622206"></a><h3>
<a name="gtk-icon-theme-set-search-path"></a>gtk_icon_theme_set_search_path ()</h3>
<a class="indexterm" name="id2622222"></a><pre class="programlisting">void gtk_icon_theme_set_search_path (<a href="GtkIconTheme.html" title="GtkIconTheme">GtkIconTheme</a> *icon_theme,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *path[],
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> n_elements);</pre>
<p>
Sets the search path for the icon theme object. When looking
for an icon theme, GTK+ will search for a subdirectory of
one or more of the directories in <em class="parameter"><code>path</code></em> with the same name
as the icon theme. (Themes from multiple of the path elements
are combined to allow themes to be extended by adding icons
in the user's home directory.)
</p>
<p>
In addition if an icon found isn't found either in the current
icon theme or the default icon theme, and an image file with
the right name is found directly in one of the elements of
<em class="parameter"><code>path</code></em>, then that image will be used for the icon name.
(This is legacy feature, and new icons should be put
into the default icon theme, which is called DEFAULT_THEME_NAME,
rather than directly on the icon path.)</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>icon_theme</code></em> :</span></td>
<td> a <a href="GtkIconTheme.html" title="GtkIconTheme"><span class="type">GtkIconTheme</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>path</code></em> :</span></td>
<td> array of directories that are searched for icon themes
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>n_elements</code></em> :</span></td>
<td> number of elements in <em class="parameter"><code>path</code></em>.
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2622362"></a><h3>
<a name="gtk-icon-theme-get-search-path"></a>gtk_icon_theme_get_search_path ()</h3>
<a class="indexterm" name="id2622377"></a><pre class="programlisting">void gtk_icon_theme_get_search_path (<a href="GtkIconTheme.html" title="GtkIconTheme">GtkIconTheme</a> *icon_theme,
<a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> **path[],
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *n_elements);</pre>
<p>
Gets the current search path. See <a href="GtkIconTheme.html#gtk-icon-theme-set-search-path"><code class="function">gtk_icon_theme_set_search_path()</code></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>icon_theme</code></em> :</span></td>
<td> a <a href="GtkIconTheme.html" title="GtkIconTheme"><span class="type">GtkIconTheme</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>path</code></em> :</span></td>
<td> location to store a list of icon theme path directories or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>
The stored value should be freed with <a
href="../glib/glib-String-Utility-Functions.html#g-strfreev"
><code class="function">g_strfreev()</code></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>n_elements</code></em> :</span></td>
<td> location to store number of elements
in <em class="parameter"><code>path</code></em>, or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2622535"></a><h3>
<a name="gtk-icon-theme-append-search-path"></a>gtk_icon_theme_append_search_path ()</h3>
<a class="indexterm" name="id2622552"></a><pre class="programlisting">void gtk_icon_theme_append_search_path
(<a href="GtkIconTheme.html" title="GtkIconTheme">GtkIconTheme</a> *icon_theme,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *path);</pre>
<p>
Appends a directory to the search path.
See <a href="GtkIconTheme.html#gtk-icon-theme-set-search-path"><code class="function">gtk_icon_theme_set_search_path()</code></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>icon_theme</code></em> :</span></td>
<td> a <a href="GtkIconTheme.html" title="GtkIconTheme"><span class="type">GtkIconTheme</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>path</code></em> :</span></td>
<td> directory name to append to the icon path
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2622648"></a><h3>
<a name="gtk-icon-theme-prepend-search-path"></a>gtk_icon_theme_prepend_search_path ()</h3>
<a class="indexterm" name="id2622664"></a><pre class="programlisting">void gtk_icon_theme_prepend_search_path
(<a href="GtkIconTheme.html" title="GtkIconTheme">GtkIconTheme</a> *icon_theme,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *path);</pre>
<p>
Prepends a directory to the search path.
See <a href="GtkIconTheme.html#gtk-icon-theme-set-search-path"><code class="function">gtk_icon_theme_set_search_path()</code></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>icon_theme</code></em> :</span></td>
<td> a <a href="GtkIconTheme.html" title="GtkIconTheme"><span class="type">GtkIconTheme</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>path</code></em> :</span></td>
<td> directory name to prepend to the icon path
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2622761"></a><h3>
<a name="gtk-icon-theme-set-custom-theme"></a>gtk_icon_theme_set_custom_theme ()</h3>
<a class="indexterm" name="id2622777"></a><pre class="programlisting">void gtk_icon_theme_set_custom_theme (<a href="GtkIconTheme.html" title="GtkIconTheme">GtkIconTheme</a> *icon_theme,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *theme_name);</pre>
<p>
Sets the name of the icon theme that the <a href="GtkIconTheme.html" title="GtkIconTheme"><span class="type">GtkIconTheme</span></a> object uses
overriding system configuration. This function cannot be called
on the icon theme objects returned from <a href="GtkIconTheme.html#gtk-icon-theme-get-default"><code class="function">gtk_icon_theme_get_default()</code></a>
and <a href="GtkIconTheme.html#gtk-icon-theme-get-for-screen"><code class="function">gtk_icon_theme_get_for_screen()</code></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>icon_theme</code></em> :</span></td>
<td> a <a href="GtkIconTheme.html" title="GtkIconTheme"><span class="type">GtkIconTheme</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>theme_name</code></em> :</span></td>
<td> name of icon theme to use instead of configured theme,
or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a> to unset a previously set custom theme
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2622907"></a><h3>
<a name="gtk-icon-theme-has-icon"></a>gtk_icon_theme_has_icon ()</h3>
<a class="indexterm" name="id2622922"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gtk_icon_theme_has_icon (<a href="GtkIconTheme.html" title="GtkIconTheme">GtkIconTheme</a> *icon_theme,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *icon_name);</pre>
<p>
Checks whether an icon theme includes an icon
for a particular name.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>icon_theme</code></em> :</span></td>
<td> a <a href="GtkIconTheme.html" title="GtkIconTheme"><span class="type">GtkIconTheme</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>icon_name</code></em> :</span></td>
<td> the name of an icon
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> <a
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> if <em class="parameter"><code>icon_theme</code></em> includes an
icon for <em class="parameter"><code>icon_name</code></em>.
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2623039"></a><h3>
<a name="gtk-icon-theme-lookup-icon"></a>gtk_icon_theme_lookup_icon ()</h3>
<a class="indexterm" name="id2623056"></a><pre class="programlisting"><a href="GtkIconTheme.html#GtkIconInfo">GtkIconInfo</a>* gtk_icon_theme_lookup_icon (<a href="GtkIconTheme.html" title="GtkIconTheme">GtkIconTheme</a> *icon_theme,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *icon_name,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> size,
<a href="GtkIconTheme.html#GtkIconLookupFlags">GtkIconLookupFlags</a> flags);</pre>
<p>
Looks up a named icon and returns a structure containing
information such as the filename of the icon. The icon
can then be rendered into a pixbuf using
<a href="GtkIconTheme.html#gtk-icon-info-load-icon"><code class="function">gtk_icon_info_load_icon()</code></a>. (<a href="GtkIconTheme.html#gtk-icon-theme-load-icon"><code class="function">gtk_icon_theme_load_icon()</code></a>
combines these two steps if all you need is the pixbuf.)</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>icon_theme</code></em> :</span></td>
<td> a <a href="GtkIconTheme.html" title="GtkIconTheme"><span class="type">GtkIconTheme</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>icon_name</code></em> :</span></td>
<td> the name of the icon to lookup
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>size</code></em> :</span></td>
<td> desired icon size
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>flags</code></em> :</span></td>
<td> flags modifying the behavior of the icon lookup
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> a <a href="GtkIconTheme.html#GtkIconInfo"><span class="type">GtkIconInfo</span></a> structure containing information
about the icon, or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a> if the icon wasn't found. Free with
<a href="GtkIconTheme.html#gtk-icon-info-free"><code class="function">gtk_icon_info_free()</code></a>
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2623249"></a><h3>
<a name="gtk-icon-theme-load-icon"></a>gtk_icon_theme_load_icon ()</h3>
<a class="indexterm" name="id2623264"></a><pre class="programlisting"><a
href="../gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
>GdkPixbuf</a>* gtk_icon_theme_load_icon (<a href="GtkIconTheme.html" title="GtkIconTheme">GtkIconTheme</a> *icon_theme,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *icon_name,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> size,
<a href="GtkIconTheme.html#GtkIconLookupFlags">GtkIconLookupFlags</a> flags,
<a
href="../glib/glib-Error-Reporting.html#GError"
>GError</a> **error);</pre>
<p>
Looks up an icon in an icon theme, scales it to the given size
and renders it into a pixbuf. This is a convenience function;
if more details about the icon are needed, use
<a href="GtkIconTheme.html#gtk-icon-theme-lookup-icon"><code class="function">gtk_icon_theme_lookup_icon()</code></a> followed by <a href="GtkIconTheme.html#gtk-icon-info-load-icon"><code class="function">gtk_icon_info_load_icon()</code></a>.
</p>
<p>
Note that you probably want to listen for icon theme changes and
update the icon. This is usually done by connecting to the
GtkWidget::style-set signal. If for some reason you do not want to
update the icon when the icon theme changes, you should consider
using <a
href="../gdk-pixbuf/gdk-pixbuf-creating.html#gdk-pixbuf-copy"
><code class="function">gdk_pixbuf_copy()</code></a> to make a private copy of the pixbuf
returned by this function. Otherwise GTK+ may need to keep the old
icon theme loaded, which would be a waste of memory.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>icon_theme</code></em> :</span></td>
<td> a <a href="GtkIconTheme.html" title="GtkIconTheme"><span class="type">GtkIconTheme</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>icon_name</code></em> :</span></td>
<td> the name of the icon to lookup
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>size</code></em> :</span></td>
<td> the desired icon size. The resulting icon may not be
exactly this size; see <a href="GtkIconTheme.html#gtk-icon-info-load-icon"><code class="function">gtk_icon_info_load_icon()</code></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>flags</code></em> :</span></td>
<td> flags modifying the behavior of the icon lookup
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>error</code></em> :</span></td>
<td> Location to store error information on failure, or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the rendered icon; this may be a newly created icon
or a new reference to an internal icon, so you must not modify
the icon. Use <a
href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref"
><code class="function">g_object_unref()</code></a> to release your reference to the
icon. <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a> if the icon isn't found.
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2623518"></a><h3>
<a name="gtk-icon-theme-list-icons"></a>gtk_icon_theme_list_icons ()</h3>
<a class="indexterm" name="id2623535"></a><pre class="programlisting"><a
href="../glib/glib-Doubly-Linked-Lists.html#GList"
>GList</a>* gtk_icon_theme_list_icons (<a href="GtkIconTheme.html" title="GtkIconTheme">GtkIconTheme</a> *icon_theme,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *context);</pre>
<p>
Lists the icons in the current icon theme. Only a subset
of the icons can be listed by providing a context string.
The set of values for the context string is system dependent,
but will typically include such values as "Applications" and
"MimeTypes".</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>icon_theme</code></em> :</span></td>
<td> a <a href="GtkIconTheme.html" title="GtkIconTheme"><span class="type">GtkIconTheme</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>context</code></em> :</span></td>
<td> a string identifying a particular type of icon,
or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a> to list all icons.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> a <a
href="../glib/glib-Doubly-Linked-Lists.html#GList"
><span class="type">GList</span></a> list holding the names of all the
icons in the theme. You must first free each element
in the list with <a
href="../glib/glib-Memory-Allocation.html#g-free"
><code class="function">g_free()</code></a>, then free the list itself
with <a
href="../glib/glib-Doubly-Linked-Lists.html#g-list-free"
><code class="function">g_list_free()</code></a>.
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2623676"></a><h3>
<a name="gtk-icon-theme-get-icon-sizes"></a>gtk_icon_theme_get_icon_sizes ()</h3>
<a class="indexterm" name="id2623692"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gint"
>gint</a>* gtk_icon_theme_get_icon_sizes (<a href="GtkIconTheme.html" title="GtkIconTheme">GtkIconTheme</a> *icon_theme,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *icon_name);</pre>
<p>
Returns an array of integers describing the sizes at which
the icon is available without scaling. A size of -1 means
that the icon is available in a scalable format. The array
is zero-terminated.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>icon_theme</code></em> :</span></td>
<td> a <a href="GtkIconTheme.html" title="GtkIconTheme"><span class="type">GtkIconTheme</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>icon_name</code></em> :</span></td>
<td> the name of an icon
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> An newly allocated array describing the sizes at
which the icon is available. The array should be freed with <a
href="../glib/glib-Memory-Allocation.html#g-free"
><code class="function">g_free()</code></a>
when it is no longer needed.
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.6
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2623802"></a><h3>
<a name="gtk-icon-theme-get-example-icon-name"></a>gtk_icon_theme_get_example_icon_name ()</h3>
<a class="indexterm" name="id2623818"></a><pre class="programlisting">char* gtk_icon_theme_get_example_icon_name
(<a href="GtkIconTheme.html" title="GtkIconTheme">GtkIconTheme</a> *icon_theme);</pre>
<p>
Gets the name of an icon that is representative of the
current theme (for instance, to use when presenting
a list of themes to the user.)</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>icon_theme</code></em> :</span></td>
<td> a <a href="GtkIconTheme.html" title="GtkIconTheme"><span class="type">GtkIconTheme</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the name of an example icon or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>.
Free with <a
href="../glib/glib-Memory-Allocation.html#g-free"
><code class="function">g_free()</code></a>.
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2623915"></a><h3>
<a name="gtk-icon-theme-rescan-if-needed"></a>gtk_icon_theme_rescan_if_needed ()</h3>
<a class="indexterm" name="id2623931"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gtk_icon_theme_rescan_if_needed (<a href="GtkIconTheme.html" title="GtkIconTheme">GtkIconTheme</a> *icon_theme);</pre>
<p>
Checks to see if the icon theme has changed; if it has, any
currently cached information is discarded and will be reloaded
next time <em class="parameter"><code>icon_theme</code></em> is accessed.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>icon_theme</code></em> :</span></td>
<td> a <a href="GtkIconTheme.html" title="GtkIconTheme"><span class="type">GtkIconTheme</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> <a
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> if the icon theme has changed and needed
to be reloaded.
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2624024"></a><h3>
<a name="gtk-icon-theme-add-builtin-icon"></a>gtk_icon_theme_add_builtin_icon ()</h3>
<a class="indexterm" name="id2624040"></a><pre class="programlisting">void gtk_icon_theme_add_builtin_icon (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *icon_name,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> size,
<a
href="../gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
>GdkPixbuf</a> *pixbuf);</pre>
<p>
Registers a built-in icon for icon theme lookups. The idea
of built-in icons is to allow an application or library
that uses themed icons to function requiring files to
be present in the file system. For instance, the default
images for all of GTK+'s stock icons are registered
as built-icons.
</p>
<p>
In general, if you use <a href="GtkIconTheme.html#gtk-icon-theme-add-builtin-icon"><code class="function">gtk_icon_theme_add_builtin_icon()</code></a>
you should also install the icon in the icon theme, so
that the icon is generally available.
</p>
<p>
This function will generally be used with pixbufs loaded
via <a
href="../gdk-pixbuf/gdk-pixbuf-creating.html#gdk-pixbuf-new-from-inline"
><code class="function">gdk_pixbuf_new_from_inline()</code></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>icon_name</code></em> :</span></td>
<td> the name of the icon to register
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>size</code></em> :</span></td>
<td> the size at which to register the icon (different
images can be registered for the same icon name
at different sizes.)
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>pixbuf</code></em> :</span></td>
<td> <a
href="../gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
><span class="type">GdkPixbuf</span></a> that contains the image to use
for <em class="parameter"><code>icon_name</code></em>.
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2624192"></a><h3>
<a name="gtk-icon-info-copy"></a>gtk_icon_info_copy ()</h3>
<a class="indexterm" name="id2624207"></a><pre class="programlisting"><a href="GtkIconTheme.html#GtkIconInfo">GtkIconInfo</a>* gtk_icon_info_copy (<a href="GtkIconTheme.html#GtkIconInfo">GtkIconInfo</a> *icon_info);</pre>
<p>
Make a copy of a <a href="GtkIconTheme.html#GtkIconInfo"><span class="type">GtkIconInfo</span></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>icon_info</code></em> :</span></td>
<td> a <a href="GtkIconTheme.html#GtkIconInfo"><span class="type">GtkIconInfo</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the new GtkIconInfo
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2624287"></a><h3>
<a name="gtk-icon-info-free"></a>gtk_icon_info_free ()</h3>
<a class="indexterm" name="id2624302"></a><pre class="programlisting">void gtk_icon_info_free (<a href="GtkIconTheme.html#GtkIconInfo">GtkIconInfo</a> *icon_info);</pre>
<p>
Free a <a href="GtkIconTheme.html#GtkIconInfo"><span class="type">GtkIconInfo</span></a> and associated information</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><em class="parameter"><code>icon_info</code></em> :</span></td>
<td> a <a href="GtkIconTheme.html#GtkIconInfo"><span class="type">GtkIconInfo</span></a>
</td>
</tr></tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2624371"></a><h3>
<a name="gtk-icon-info-get-base-size"></a>gtk_icon_info_get_base_size ()</h3>
<a class="indexterm" name="id2624388"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> gtk_icon_info_get_base_size (<a href="GtkIconTheme.html#GtkIconInfo">GtkIconInfo</a> *icon_info);</pre>
<p>
Gets the base size for the icon. The base size
is a size for the icon that was specified by
the icon theme creator. This may be different
than the actual size of image; an example of
this is small emblem icons that can be attached
to a larger icon. These icons will be given
the same base size as the larger icons to which
they are attached.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>icon_info</code></em> :</span></td>
<td> a <a href="GtkIconTheme.html#GtkIconInfo"><span class="type">GtkIconInfo</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the base size, or 0, if no base
size is known for the icon.
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2624466"></a><h3>
<a name="gtk-icon-info-get-filename"></a>gtk_icon_info_get_filename ()</h3>
<a class="indexterm" name="id2624482"></a><pre class="programlisting">const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* gtk_icon_info_get_filename (<a href="GtkIconTheme.html#GtkIconInfo">GtkIconInfo</a> *icon_info);</pre>
<p>
Gets the filename for the icon. If the
<a href="GtkIconTheme.html#GTK-ICON-LOOKUP-USE-BUILTIN:CAPS"><code class="literal">GTK_ICON_LOOKUP_USE_BUILTIN</code></a> flag was passed
to <a href="GtkIconTheme.html#gtk-icon-theme-lookup-icon"><code class="function">gtk_icon_theme_lookup_icon()</code></a>, there may be
no filename if a builtin icon is returned; in this
case, you should use <a href="GtkIconTheme.html#gtk-icon-info-get-builtin-pixbuf"><code class="function">gtk_icon_info_get_builtin_pixbuf()</code></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>icon_info</code></em> :</span></td>
<td> a <a href="GtkIconTheme.html#GtkIconInfo"><span class="type">GtkIconInfo</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the filename for the icon, or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>
if <a href="GtkIconTheme.html#gtk-icon-info-get-builtin-pixbuf"><code class="function">gtk_icon_info_get_builtin_pixbuf()</code></a> should
be used instead. The return value is owned by
GTK+ and should not be modified or freed.
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2624615"></a><h3>
<a name="gtk-icon-info-get-builtin-pixbuf"></a>gtk_icon_info_get_builtin_pixbuf ()</h3>
<a class="indexterm" name="id2624630"></a><pre class="programlisting"><a
href="../gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
>GdkPixbuf</a>* gtk_icon_info_get_builtin_pixbuf
(<a href="GtkIconTheme.html#GtkIconInfo">GtkIconInfo</a> *icon_info);</pre>
<p>
Gets the built-in image for this icon, if any. To allow
GTK+ to use built in icon images, you must pass the
<a href="GtkIconTheme.html#GTK-ICON-LOOKUP-USE-BUILTIN:CAPS"><code class="literal">GTK_ICON_LOOKUP_USE_BUILTIN</code></a> to
<a href="GtkIconTheme.html#gtk-icon-theme-lookup-icon"><code class="function">gtk_icon_theme_lookup_icon()</code></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>icon_info</code></em> :</span></td>
<td> a <a href="GtkIconTheme.html#GtkIconInfo"><span class="type">GtkIconInfo</span></a> structure
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the built-in image pixbuf, or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>. No
extra reference is added to the returned pixbuf, so if
you want to keep it around, you must use <a
href="../gobject/gobject-The-Base-Object-Type.html#g-object-ref"
><code class="function">g_object_ref()</code></a>.
The returned image must not be modified.
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2624752"></a><h3>
<a name="gtk-icon-info-load-icon"></a>gtk_icon_info_load_icon ()</h3>
<a class="indexterm" name="id2624767"></a><pre class="programlisting"><a
href="../gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
>GdkPixbuf</a>* gtk_icon_info_load_icon (<a href="GtkIconTheme.html#GtkIconInfo">GtkIconInfo</a> *icon_info,
<a
href="../glib/glib-Error-Reporting.html#GError"
>GError</a> **error);</pre>
<p>
Renders an icon previously looked up in an icon theme using
<a href="GtkIconTheme.html#gtk-icon-theme-lookup-icon"><code class="function">gtk_icon_theme_lookup_icon()</code></a>; the size will be based on the size
passed to <a href="GtkIconTheme.html#gtk-icon-theme-lookup-icon"><code class="function">gtk_icon_theme_lookup_icon()</code></a>. Note that the resulting
pixbuf may not be exactly this size; an icon theme may have icons
that differ slightly from their nominal sizes, and in addition GTK+
will avoid scaling icons that it considers sufficiently close to the
requested size or for which the source image would have to be scaled
up too far. (This maintains sharpness.)</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>icon_info</code></em> :</span></td>
<td> a <a href="GtkIconTheme.html#GtkIconInfo"><span class="type">GtkIconInfo</span></a> structure from <a href="GtkIconTheme.html#gtk-icon-theme-lookup-icon"><code class="function">gtk_icon_theme_lookup_icon()</code></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>error</code></em> :</span></td>
<td> location to store error information on failure, or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the rendered icon; this may be a newly created icon
or a new reference to an internal icon, so you must not modify
the icon. Use <a
href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref"
><code class="function">g_object_unref()</code></a> to release your reference to the
icon.
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2624926"></a><h3>
<a name="gtk-icon-info-set-raw-coordinates"></a>gtk_icon_info_set_raw_coordinates ()</h3>
<a class="indexterm" name="id2624942"></a><pre class="programlisting">void gtk_icon_info_set_raw_coordinates
(<a href="GtkIconTheme.html#GtkIconInfo">GtkIconInfo</a> *icon_info,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> raw_coordinates);</pre>
<p>
Sets whether the coordinates returned by <a href="GtkIconTheme.html#gtk-icon-info-get-embedded-rect"><code class="function">gtk_icon_info_get_embedded_rect()</code></a>
and <a href="GtkIconTheme.html#gtk-icon-info-get-attach-points"><code class="function">gtk_icon_info_get_attach_points()</code></a> should be returned in their
original form as specified in the icon theme, instead of scaled
appropriately for the pixbuf returned by <a href="GtkIconTheme.html#gtk-icon-info-load-icon"><code class="function">gtk_icon_info_load_icon()</code></a>.
</p>
<p>
Raw coordinates are somewhat strange; they are specified to be with
respect to the unscaled pixmap for PNG and XPM icons, but for SVG
icons, they are in a 1000x1000 coordinate space that is scaled
to the final size of the icon. You can determine if the icon is an SVG
icon by using <a href="GtkIconTheme.html#gtk-icon-info-get-filename"><code class="function">gtk_icon_info_get_filename()</code></a>, and seeing if it is non-<a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>
and ends in '.svg'.
</p>
<p>
This function is provided primarily to allow compatibility wrappers
for older API's, and is not expected to be useful for applications.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>icon_info</code></em> :</span></td>
<td> a <a href="GtkIconTheme.html#GtkIconInfo"><span class="type">GtkIconInfo</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>raw_coordinates</code></em> :</span></td>
<td> whether the coordinates of embedded rectangles
and attached points should be returned in their original
(unscaled) form.
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2625100"></a><h3>
<a name="gtk-icon-info-get-embedded-rect"></a>gtk_icon_info_get_embedded_rect ()</h3>
<a class="indexterm" name="id2625115"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gtk_icon_info_get_embedded_rect (<a href="GtkIconTheme.html#GtkIconInfo">GtkIconInfo</a> *icon_info,
<a
href="../gdk/gdk-Points-Rectangles-and-Regions.html#GdkRectangle"
>GdkRectangle</a> *rectangle);</pre>
<p>
Gets the coordinates of a rectangle within the icon
that can be used for display of information such
as a preview of the contents of a text file.
See <a href="GtkIconTheme.html#gtk-icon-info-set-raw-coordinates"><code class="function">gtk_icon_info_set_raw_coordinates()</code></a> for further
information about the coordinate system.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>icon_info</code></em> :</span></td>
<td> a <a href="GtkIconTheme.html#GtkIconInfo"><span class="type">GtkIconInfo</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>rectangle</code></em> :</span></td>
<td> <a
href="../gdk/gdk-Points-Rectangles-and-Regions.html#GdkRectangle"
><span class="type">GdkRectangle</span></a> in which to store embedded
rectangle coordinates; coordinates are only stored
when this function returns <a
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> <a
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> if the icon has an embedded rectangle
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2625254"></a><h3>
<a name="gtk-icon-info-get-attach-points"></a>gtk_icon_info_get_attach_points ()</h3>
<a class="indexterm" name="id2625270"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gtk_icon_info_get_attach_points (<a href="GtkIconTheme.html#GtkIconInfo">GtkIconInfo</a> *icon_info,
<a
href="../gdk/gdk-Points-Rectangles-and-Regions.html#GdkPoint"
>GdkPoint</a> **points,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *n_points);</pre>
<p>
Fetches the set of attach points for an icon. An attach point
is a location in the icon that can be used as anchor points for attaching
emblems or overlays to the icon.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>icon_info</code></em> :</span></td>
<td> a <a href="GtkIconTheme.html#GtkIconInfo"><span class="type">GtkIconInfo</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>points</code></em> :</span></td>
<td> location to store pointer to an array of points, or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>
free the array of points with <a
href="../glib/glib-Memory-Allocation.html#g-free"
><code class="function">g_free()</code></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>n_points</code></em> :</span></td>
<td> location to store the number of points in <em class="parameter"><code>points</code></em>, or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> <a
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> if there are any attach points for the icon.
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2625437"></a><h3>
<a name="gtk-icon-info-get-display-name"></a>gtk_icon_info_get_display_name ()</h3>
<a class="indexterm" name="id2625452"></a><pre class="programlisting">const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* gtk_icon_info_get_display_name (<a href="GtkIconTheme.html#GtkIconInfo">GtkIconInfo</a> *icon_info);</pre>
<p>
Gets the display name for an icon. A display name is a
string to be used in place of the icon name in a user
visible context like a list of icons.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>icon_info</code></em> :</span></td>
<td> a <a href="GtkIconTheme.html#GtkIconInfo"><span class="type">GtkIconInfo</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the display name for the icon or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>, if
the icon doesn't have a specified display name. This value
is owned <em class="parameter"><code>icon_info</code></em> and must not be modified or free.
</td>
</tr>
</tbody>
</table></div>
<p>Since 2.4
</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2625548"></a><h2>Signal Details</h2>
<div class="refsect2" lang="en">
<a name="id2625558"></a><h3>
<a name="GtkIconTheme-changed"></a>The "changed" signal</h3>
<a class="indexterm" name="id2625568"></a><pre class="programlisting">void user_function (<a href="GtkIconTheme.html" title="GtkIconTheme">GtkIconTheme</a> *icon_theme,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run last</pre>
<p>
Emitted when the current icon theme is switched or GTK+ detects
that a change has occurred in the contents of the current
icon theme.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>icon_theme</code></em> :</span></td>
<td> the icon theme
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</body>
</html>