1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.IconTheme</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.73.2"><link rel="start" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="up" href="gtk-class-reference.html" title="The gtk Class Reference"><link rel="prev" href="class-gtkiconsource.html" title="gtk.IconSource"><link rel="next" href="class-gtkiconview.html" title="gtk.IconView"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">gtk.IconTheme</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtkiconsource.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtkiconview.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-gtkicontheme"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.IconTheme</h2><p>gtk.IconTheme — look up icons by name and size (new in PyGTK 2.4)</p></div><div class="refsect1" lang="en"><a name="id3532369"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.IconTheme</span></span>(<span class="ooclass"><span class="classname"><PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK></span></span>):
1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.IconTheme</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.75.1"><link rel="home" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="up" href="gtk-class-reference.html" title="The gtk Class Reference"><link rel="prev" href="class-gtkiconsource.html" title="gtk.IconSource"><link rel="next" href="class-gtkiconview.html" title="gtk.IconView"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">gtk.IconTheme</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtkiconsource.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtkiconview.html">Next</a></td></tr></table><hr></div><div class="refentry" title="gtk.IconTheme"><a name="class-gtkicontheme"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.IconTheme</h2><p>gtk.IconTheme — look up icons by name and size (new in PyGTK 2.4)</p></div><div class="refsect1" title="Synopsis"><a name="id3842211"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.IconTheme</span></span>(<span class="ooclass"><span class="classname"><PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK></span></span>):
2
2
<code class="constructorsynopsis"> <span class="methodname"><a class="link" href="class-gtkicontheme.html#constructor-gtkicontheme" title="Constructor">gtk.IconTheme</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkicontheme.html#method-gtkicontheme--set-screen" title="gtk.IconTheme.set_screen">set_screen</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>screen</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkicontheme.html#method-gtkicontheme--set-search-path" title="gtk.IconTheme.set_search_path">set_search_path</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>path</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkicontheme.html#method-gtkicontheme--get-search-path" title="gtk.IconTheme.get_search_path">get_search_path</a></span>()</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkicontheme.html#method-gtkicontheme--append-search-path" title="gtk.IconTheme.append_search_path">append_search_path</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>path</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkicontheme.html#method-gtkicontheme--prepend-search-path" title="gtk.IconTheme.prepend_search_path">prepend_search_path</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>path</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkicontheme.html#method-gtkicontheme--set-custom-theme" title="gtk.IconTheme.set_custom_theme">set_custom_theme</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>theme_name</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkicontheme.html#method-gtkicontheme--has-icon" title="gtk.IconTheme.has_icon">has_icon</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>icon_name</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkicontheme.html#method-gtkicontheme--lookup-icon" title="gtk.IconTheme.lookup_icon">lookup_icon</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>icon_name</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>size</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>flags</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkicontheme.html#method-gtkicontheme--load-icon" title="gtk.IconTheme.load_icon">load_icon</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>icon_name</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>size</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>flags</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkicontheme.html#method-gtkicontheme--choose-icon" title="gtk.IconTheme.choose_icon">choose_icon</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>icon_names</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>size</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>flags</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkicontheme.html#method-gtkicontheme--list-contexts" title="gtk.IconTheme.list_contexts">list_contexts</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkicontheme.html#method-gtkicontheme--list-icons" title="gtk.IconTheme.list_icons">list_icons</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>context</code></strong></span><span class="initializer">=None</span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkicontheme.html#method-gtkicontheme--get-example-icon-name" title="gtk.IconTheme.get_example_icon_name">get_example_icon_name</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkicontheme.html#method-gtkicontheme--rescan-if-needed" title="gtk.IconTheme.rescan_if_needed">rescan_if_needed</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkicontheme.html#method-gtkicontheme--get-icon-sizes" title="gtk.IconTheme.get_icon_sizes">get_icon_sizes</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>icon_name</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkicontheme.html#method-gtkicontheme--lookup-by-gicon" title="gtk.IconTheme.lookup_by_gicon">lookup_by_gicon</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>icon</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>size</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>flags</code></strong></span></span>)</code><br></pre></td></tr></table><pre class="programlisting">
3
3
<span class="bold"><strong>Functions</strong></span>
5
5
<code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkicontheme.html#function-gtk--icon-theme-get-default" title="gtk.icon_theme_get_default">gtk.icon_theme_get_default</a></span>()</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkicontheme.html#function-gtk--icon-theme-get-for-screen" title="gtk.icon_theme_get_for_screen">gtk.icon_theme_get_for_screen</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>screen</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkicontheme.html#function-gtk--icon-theme-add-builtin-icon" title="gtk.icon_theme_add_builtin_icon">gtk.icon_theme_add_builtin_icon</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>icon_name</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>size</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>pixbuf</code></strong></span></span>)</code>
6
</pre></div><div class="refsect1" lang="en"><a name="id3533044"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
6
</pre></div><div class="refsect1" title="Ancestry"><a name="id3842885"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
7
7
+-- <a class="link" href="class-gtkicontheme.html" title="gtk.IconTheme">gtk.IconTheme</a>
8
</pre></div><div class="refsect1" lang="en"><a name="signal-prototypes-gtkicontheme"></a><h2>gtk.IconTheme Signal Prototypes</h2><p><PYGTKDOCLINK HREF="signal-prototypes-gobject">gobject.GObject Signal Prototypes</PYGTKDOCLINK></p><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term">"<a class="link" href="class-gtkicontheme.html#signal-gtkicontheme--changed" title='The "changed" gtk.IconTheme Signal'>changed</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>icontheme</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr></tbody></table></div><div class="refsect1" lang="en"><a name="id3533155"></a><h2>Description</h2><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This object is available in PyGTK 2.4 and above.</p></div><p><a class="link" href="class-gtkicontheme.html" title="gtk.IconTheme"><code class="classname">gtk.IconTheme</code></a>
8
</pre></div><div class="refsect1" title="gtk.IconTheme Signal Prototypes"><a name="signal-prototypes-gtkicontheme"></a><h2>gtk.IconTheme Signal Prototypes</h2><p><PYGTKDOCLINK HREF="signal-prototypes-gobject">gobject.GObject Signal Prototypes</PYGTKDOCLINK></p><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term">"<a class="link" href="class-gtkicontheme.html#signal-gtkicontheme--changed" title='The "changed" gtk.IconTheme Signal'>changed</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>icontheme</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr></tbody></table></div><div class="refsect1" title="Description"><a name="id3842996"></a><h2>Description</h2><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This object is available in PyGTK 2.4 and above.</p></div><p><a class="link" href="class-gtkicontheme.html" title="gtk.IconTheme"><code class="classname">gtk.IconTheme</code></a>
9
9
provides a facility for looking up icons by name and size. The main reason
10
10
for using a name rather than simply providing a filename is to allow
11
11
different icons to be used depending on what icon theme is selected by the
17
17
<a class="link" href="class-gtkiconset.html" title="gtk.IconSet"><code class="classname">gtk.IconSet</code></a>
18
18
and <a class="link" href="class-gtkiconsource.html" title="gtk.IconSource"><code class="classname">gtk.IconSource</code></a>
19
19
for more detail), and the distinction between the two may be a bit
20
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 class="link" href="gtk-stock-items.html" title="Stock Items">Stock Items</a>, such as
20
confusing. A few things to keep in mind:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>Stock images usually are used in conjunction with <a class="link" href="gtk-stock-items.html" title="Stock Items">Stock Items</a>, such as
21
21
<code class="literal">gtk.STOCK_OK</code> or <code class="literal">gtk.STOCK_OPEN</code>. Named
22
22
icons are easier to set up and therefore are more useful for new icons that
23
23
an application wants to add, such as application icons or window
24
icons.</p></li><li><p>Stock images can only be loaded at the symbolic sizes defined
24
icons.</p></li><li class="listitem"><p>Stock images can only be loaded at the symbolic sizes defined
25
25
by the standard icon sizes (see the <a class="link" href="class-gtkiconsource.html#function-gtk--icon-size-lookup" title="gtk.icon_size_lookup"><code class="function">gtk.icon_size_lookup</code>()</a>
26
26
function), or by custom sizes defined by the <a class="link" href="class-gtkiconsource.html#function-gtk--icon-size-register" title="gtk.icon_size_register"><code class="function">gtk.icon_size_register</code>()</a>
27
27
function, while named icons are more flexible and any pixel size can be
28
specified.</p></li><li><p>Because stock images are closely tied to stock items, and thus
28
specified.</p></li><li class="listitem"><p>Because stock images are closely tied to stock items, and thus
29
29
to actions in the user interface, stock images may come in multiple variants
30
30
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
31
31
you want to use, use it, otherwise use a named icon. It turns out that
47
47
pixbuf = icon_theme.load_icon("my-icon-name", 48, 0)
48
48
except gobject.GError, exc:
49
49
print "can't load icon", exc
50
</pre><p></p></div><div class="refsect1" lang="en"><a name="constructor-gtkicontheme"></a><h2>Constructor</h2><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gtk.IconTheme</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the newly created <a class="link" href="class-gtkicontheme.html" title="gtk.IconTheme"><code class="classname">gtk.IconTheme</code></a>
51
object.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This constructor is available in PyGTK 2.4 and above.</p></div><p>Creates a new icon theme object. Icon theme objects are used to
50
</pre><p></p></div><div class="refsect1" title="Constructor"><a name="constructor-gtkicontheme"></a><h2>Constructor</h2><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gtk.IconTheme</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the newly created <a class="link" href="class-gtkicontheme.html" title="gtk.IconTheme"><code class="classname">gtk.IconTheme</code></a>
51
object.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This constructor is available in PyGTK 2.4 and above.</p></div><p>Creates a new icon theme object. Icon theme objects are used to
52
52
lookup up an icon by name in a particular icon theme. Usually, you'll want
53
53
to use the <a class="link" href="class-gtkicontheme.html#function-gtk--icon-theme-get-default" title="gtk.icon_theme_get_default"><code class="function">gtk.icon_theme_get_default</code>()</a>
54
54
or <a class="link" href="class-gtkicontheme.html#function-gtk--icon-theme-get-for-screen" title="gtk.icon_theme_get_for_screen"><code class="function">gtk.icon_theme_get_for_screen</code>()</a>
55
functions rather than creating a new icon theme object from scratch.</p></div><div class="refsect1" lang="en"><a name="id3533464"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-gtkicontheme--set-screen"></a><h3>gtk.IconTheme.set_screen</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_screen</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>screen</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>screen</code></strong> :</span></p></td><td>a <a class="link" href="class-gdkscreen.html" title="gtk.gdk.Screen"><code class="classname">gtk.gdk.Screen</code></a></td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">set_screen</code>() method sets the <a class="link" href="class-gdkscreen.html" title="gtk.gdk.Screen"><code class="classname">gtk.gdk.Screen</code></a> for
55
functions rather than creating a new icon theme object from scratch.</p></div><div class="refsect1" title="Methods"><a name="id3843305"></a><h2>Methods</h2><div class="refsect2" title="gtk.IconTheme.set_screen"><a name="method-gtkicontheme--set-screen"></a><h3>gtk.IconTheme.set_screen</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_screen</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>screen</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>screen</code></strong> :</span></p></td><td>a <a class="link" href="class-gdkscreen.html" title="gtk.gdk.Screen"><code class="classname">gtk.gdk.Screen</code></a></td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">set_screen</code>() method sets the <a class="link" href="class-gdkscreen.html" title="gtk.gdk.Screen"><code class="classname">gtk.gdk.Screen</code></a> for
56
56
an icon theme to <em class="parameter"><code>screen</code></em>. The screen is used to track
57
57
the user's currently configured icon theme, which might be different for
58
different screens.</p></div><div class="refsect2" lang="en"><a name="method-gtkicontheme--set-search-path"></a><h3>gtk.IconTheme.set_search_path</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_search_path</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>path</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>path</code></strong> :</span></p></td><td>a list or tuple of directories that are
59
searched for icon themes</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">set_search_path</code>() method sets the
58
different screens.</p></div><div class="refsect2" title="gtk.IconTheme.set_search_path"><a name="method-gtkicontheme--set-search-path"></a><h3>gtk.IconTheme.set_search_path</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_search_path</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>path</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>path</code></strong> :</span></p></td><td>a list or tuple of directories that are
59
searched for icon themes</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">set_search_path</code>() method sets the
60
60
search path for the icon theme object to the list of directory names
61
61
contained in <em class="parameter"><code>path</code></em>. When looking for an icon theme,
62
62
<code class="literal">GTK+</code> will search for a subdirectory of one or more of the
67
67
is found directly in one of the elements of <em class="parameter"><code>path</code></em>,
68
68
then that image will be used for the icon name. (This is a legacy feature,
69
69
and new icons should be put into the default icon theme, which is called
70
"hicolor", rather than directly on the icon path.)</p></div><div class="refsect2" lang="en"><a name="method-gtkicontheme--get-search-path"></a><h3>gtk.IconTheme.get_search_path</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_search_path</span>()</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a tuple containing the list of directory names
71
that are searched for icon themes</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">get_search_path</code>() method returns a
70
"hicolor", rather than directly on the icon path.)</p></div><div class="refsect2" title="gtk.IconTheme.get_search_path"><a name="method-gtkicontheme--get-search-path"></a><h3>gtk.IconTheme.get_search_path</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_search_path</span>()</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a tuple containing the list of directory names
71
that are searched for icon themes</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">get_search_path</code>() method returns a
72
72
tuple containing the current search path. See the <a class="link" href="class-gtkicontheme.html#method-gtkicontheme--set-search-path" title="gtk.IconTheme.set_search_path"><code class="methodname">set_search_path()</code></a>
73
method for more details.</p></div><div class="refsect2" lang="en"><a name="method-gtkicontheme--append-search-path"></a><h3>gtk.IconTheme.append_search_path</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">append_search_path</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>path</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>path</code></strong> :</span></p></td><td>a directory name to append to the icon
74
path</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">append_search_path</code>() method appends
73
method for more details.</p></div><div class="refsect2" title="gtk.IconTheme.append_search_path"><a name="method-gtkicontheme--append-search-path"></a><h3>gtk.IconTheme.append_search_path</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">append_search_path</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>path</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>path</code></strong> :</span></p></td><td>a directory name to append to the icon
74
path</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">append_search_path</code>() method appends
75
75
the directory name specified by <em class="parameter"><code>path</code></em> to the search
76
76
path. See the <a class="link" href="class-gtkicontheme.html#method-gtkicontheme--set-search-path" title="gtk.IconTheme.set_search_path"><code class="methodname">set_search_path()</code></a>
77
method for more information.</p></div><div class="refsect2" lang="en"><a name="method-gtkicontheme--prepend-search-path"></a><h3>gtk.IconTheme.prepend_search_path</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">prepend_search_path</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>path</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>path</code></strong> :</span></p></td><td>a directory name to prepend to the icon
78
path</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">prepend_search_path</code>() method
77
method for more information.</p></div><div class="refsect2" title="gtk.IconTheme.prepend_search_path"><a name="method-gtkicontheme--prepend-search-path"></a><h3>gtk.IconTheme.prepend_search_path</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">prepend_search_path</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>path</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>path</code></strong> :</span></p></td><td>a directory name to prepend to the icon
78
path</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">prepend_search_path</code>() method
79
79
prepends the directory name specified by <em class="parameter"><code>path</code></em> to the
80
80
search path. See the <a class="link" href="class-gtkicontheme.html#method-gtkicontheme--set-search-path" title="gtk.IconTheme.set_search_path"><code class="methodname">set_search_path()</code></a>
81
method for more information.</p></div><div class="refsect2" lang="en"><a name="method-gtkicontheme--set-custom-theme"></a><h3>gtk.IconTheme.set_custom_theme</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_custom_theme</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>theme_name</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>theme_name</code></strong> :</span></p></td><td>the name of icon theme to use instead of
82
the configured theme</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">set_custom_theme</code>() method sets the
81
method for more information.</p></div><div class="refsect2" title="gtk.IconTheme.set_custom_theme"><a name="method-gtkicontheme--set-custom-theme"></a><h3>gtk.IconTheme.set_custom_theme</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_custom_theme</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>theme_name</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>theme_name</code></strong> :</span></p></td><td>the name of icon theme to use instead of
82
the configured theme</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">set_custom_theme</code>() method sets the
83
83
theme used by the icon theme object to the theme named by
84
84
<em class="parameter"><code>theme_name</code></em> usually replacing system configured
85
85
theme. This method cannot be called on the icon theme objects returned from
86
86
the <a class="link" href="class-gtkicontheme.html#function-gtk--icon-theme-get-default" title="gtk.icon_theme_get_default"><code class="function">gtk.icon_theme_get_default</code>()</a>
87
87
and <a class="link" href="class-gtkicontheme.html#function-gtk--icon-theme-get-default" title="gtk.icon_theme_get_default"><code class="function">gtk.icon_theme_get_default</code>()</a>
88
functions.</p></div><div class="refsect2" lang="en"><a name="method-gtkicontheme--has-icon"></a><h3>gtk.IconTheme.has_icon</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">has_icon</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>icon_name</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>icon_name</code></strong> :</span></p></td><td>the name of an icon</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if the icon theme
88
functions.</p></div><div class="refsect2" title="gtk.IconTheme.has_icon"><a name="method-gtkicontheme--has-icon"></a><h3>gtk.IconTheme.has_icon</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">has_icon</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>icon_name</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>icon_name</code></strong> :</span></p></td><td>the name of an icon</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if the icon theme
89
89
includes an icon for
90
<em class="parameter"><code>icon_name</code></em>.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">has_icon</code>() method checks whether
90
<em class="parameter"><code>icon_name</code></em>.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">has_icon</code>() method checks whether
91
91
the icon theme includes an icon for the icon name specified by
92
<em class="parameter"><code>icon_name</code></em>.</p></div><div class="refsect2" lang="en"><a name="method-gtkicontheme--lookup-icon"></a><h3>gtk.IconTheme.lookup_icon</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">lookup_icon</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>icon_name</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>size</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>flags</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>icon_name</code></strong> :</span></p></td><td>the name of the icon to lookup</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>size</code></strong> :</span></p></td><td>the desired icon size</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>flags</code></strong> :</span></p></td><td>the flags modifying the behavior of the icon
92
<em class="parameter"><code>icon_name</code></em>.</p></div><div class="refsect2" title="gtk.IconTheme.lookup_icon"><a name="method-gtkicontheme--lookup-icon"></a><h3>gtk.IconTheme.lookup_icon</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">lookup_icon</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>icon_name</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>size</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>flags</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>icon_name</code></strong> :</span></p></td><td>the name of the icon to lookup</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>size</code></strong> :</span></p></td><td>the desired icon size</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>flags</code></strong> :</span></p></td><td>the flags modifying the behavior of the icon
93
93
lookup</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a <a class="link" href="class-gtkiconinfo.html" title="gtk.IconInfo"><code class="classname">gtk.IconInfo</code></a>
94
94
object containing information about the icon, or
95
95
<code class="literal">None</code> if the icon wasn't found. Free with the
96
96
<a class="link" href="class-gtkiconinfo.html#method-gtkiconinfo--free" title="gtk.IconInfo.free"><code class="methodname">gtk.IconInfo.free()</code></a>
97
method</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">lookup_icon</code>() method looks up the
97
method</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">lookup_icon</code>() method looks up the
98
98
icon specified by <em class="parameter"><code>icon_name</code></em>,
99
99
<em class="parameter"><code>size</code></em> and <em class="parameter"><code>flags</code></em> and returns a
100
100
<a class="link" href="class-gtkiconinfo.html" title="gtk.IconInfo"><code class="classname">gtk.IconInfo</code></a>
110
110
icon, the <a class="link" href="class-gtkiconinfo.html#method-gtkiconinfo--get-filename" title="gtk.IconInfo.get_filename"><code class="methodname">gtk.IconInfo.get_filename</code>()</a>
111
111
method returns <code class="literal">None</code> and you need to call the
112
112
<a class="link" href="class-gtkiconinfo.html#method-gtkiconinfo--get-builtin-pixbuf" title="gtk.IconInfo.get_builtin_pixbuf"><code class="methodname">get_builtin_pixbuf</code>()</a>
113
method.</td></tr></tbody></table><p></p></div><div class="refsect2" lang="en"><a name="method-gtkicontheme--load-icon"></a><h3>gtk.IconTheme.load_icon</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">load_icon</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>icon_name</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>size</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>flags</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>icon_name</code></strong> :</span></p></td><td>the name of the icon to lookup</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>size</code></strong> :</span></p></td><td>the desired icon size. The resulting icon may
113
method.</td></tr></tbody></table><p></p></div><div class="refsect2" title="gtk.IconTheme.load_icon"><a name="method-gtkicontheme--load-icon"></a><h3>gtk.IconTheme.load_icon</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">load_icon</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>icon_name</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>size</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>flags</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>icon_name</code></strong> :</span></p></td><td>the name of the icon to lookup</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>size</code></strong> :</span></p></td><td>the desired icon size. The resulting icon may
114
114
not be exactly this size; see the <a class="link" href="class-gtkiconinfo.html#method-gtkiconinfo--load-icon" title="gtk.IconInfo.load_icon"><code class="methodname">gtk.IconInfo.load_icon()</code></a>
115
115
method.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>flags</code></strong> :</span></p></td><td>the flags modifying the behavior of the icon
116
116
lookup</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a <a class="link" href="class-gdkpixbuf.html" title="gtk.gdk.Pixbuf"><code class="classname">gtk.gdk.Pixbuf</code></a>
117
117
containing the rendered icon; this may be a newly created icon or
118
118
a new reference to an internal icon, so you must not modify the
119
icon.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">load_icon</code>() method looks up the
119
icon.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">load_icon</code>() method looks up the
120
120
icon specified by <em class="parameter"><code>icon_name</code></em> in an icon theme, scales
121
121
it to the size specified by <em class="parameter"><code>size</code></em> and renders it into
122
122
a <a class="link" href="class-gdkpixbuf.html" title="gtk.gdk.Pixbuf"><code class="classname">gtk.gdk.Pixbuf</code></a>. flags
127
127
details about the icon are needed, use the <a class="link" href="class-gtkicontheme.html#method-gtkicontheme--lookup-icon" title="gtk.IconTheme.lookup_icon"><code class="methodname">lookup_icon()</code></a>
128
128
method followed by the <a class="link" href="class-gtkiconinfo.html#method-gtkiconinfo--load-icon" title="gtk.IconInfo.load_icon"><code class="methodname">GtkIconInfo.load_icon()</code></a>
129
129
method.</p><p>This method raise the GError exception if an error occurs during
130
rendering of the icon.</p></div><div class="refsect2" lang="en"><a name="method-gtkicontheme--choose-icon"></a><h3>gtk.IconTheme.choose_icon</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">choose_icon</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>icon_names</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>size</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>flags</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>icon_names</code></strong> :</span></p></td><td>A list or tuple of icon names to lookup.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>size</code></strong> :</span></p></td><td>The desired icon size.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>flags</code></strong> :</span></p></td><td>the flags modifying the behavior of the icon
130
rendering of the icon.</p></div><div class="refsect2" title="gtk.IconTheme.choose_icon"><a name="method-gtkicontheme--choose-icon"></a><h3>gtk.IconTheme.choose_icon</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">choose_icon</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>icon_names</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>size</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>flags</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>icon_names</code></strong> :</span></p></td><td>A list or tuple of icon names to lookup.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>size</code></strong> :</span></p></td><td>The desired icon size.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>flags</code></strong> :</span></p></td><td>the flags modifying the behavior of the icon
131
131
lookup</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>A <a class="link" href="class-gtkiconinfo.html" title="gtk.IconInfo"><code class="classname">gtk.IconInfo</code></a>.
132
132
structure containing information about the icon, or <code class="literal">None</code>
133
if the icon wasn't found.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.12 and above.</p></div><p>
133
if the icon wasn't found.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.12 and above.</p></div><p>
134
134
The <code class="methodname">choose_icon</code>() method looks up a named icon and
135
135
returns a structure containing information such as the filename of the icon.
136
136
The icon can then be rendered into a pixbuf using
137
137
<code class="methodname"><a class="link" href="class-gtkiconinfo.html#method-gtkiconinfo--load-icon" title="gtk.IconInfo.load_icon">gtk.IconInfo.load_icon</a></code>.
138
138
<code class="methodname"><a class="link" href="class-gtkicontheme.html#method-gtkicontheme--load-icon" title="gtk.IconTheme.load_icon">load_icon</a></code>
139
139
combines these two steps if all you need is the pixbuf.)
140
</p></div><div class="refsect2" lang="en"><a name="method-gtkicontheme--list-contexts"></a><h3>gtk.IconTheme.list_contexts</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">list_contexts</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>A list holding the names of all the
141
contexts in the theme. </td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.12 and above.</p></div><p>The <code class="methodname">list_contexts</code>() method gets the list of contexts
142
available within the current hierarchy of icon themes</p></div><div class="refsect2" lang="en"><a name="method-gtkicontheme--list-icons"></a><h3>gtk.IconTheme.list_icons</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">list_icons</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>context</code></strong></span><span class="initializer">=None</span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>context</code></strong> :</span></p></td><td>a string identifying a particular type of icon,
140
</p></div><div class="refsect2" title="gtk.IconTheme.list_contexts"><a name="method-gtkicontheme--list-contexts"></a><h3>gtk.IconTheme.list_contexts</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">list_contexts</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>A list holding the names of all the
141
contexts in the theme. </td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.12 and above.</p></div><p>The <code class="methodname">list_contexts</code>() method gets the list of contexts
142
available within the current hierarchy of icon themes</p></div><div class="refsect2" title="gtk.IconTheme.list_icons"><a name="method-gtkicontheme--list-icons"></a><h3>gtk.IconTheme.list_icons</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">list_icons</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>context</code></strong></span><span class="initializer">=None</span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>context</code></strong> :</span></p></td><td>a string identifying a particular type of icon,
143
143
or <code class="literal">None</code> to list all icons.</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a tuple containing the names of all the
144
icons in the theme.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">list_icons</code>() method lists the icons
144
icons in the theme.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">list_icons</code>() method lists the icons
145
145
in the current icon theme. Only a subset of the icons can be listed by
146
146
providing a string specified by <em class="parameter"><code>context</code></em>. The set of
147
147
values for the context string is system dependent, but will typically
148
include such values as 'apps' and 'mimetypes'.</p></div><div class="refsect2" lang="en"><a name="method-gtkicontheme--get-example-icon-name"></a><h3>gtk.IconTheme.get_example_icon_name</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_example_icon_name</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the name of an example icon or
149
<code class="literal">None</code>.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">get_example_icon_name</code>() method
148
include such values as 'apps' and 'mimetypes'.</p></div><div class="refsect2" title="gtk.IconTheme.get_example_icon_name"><a name="method-gtkicontheme--get-example-icon-name"></a><h3>gtk.IconTheme.get_example_icon_name</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_example_icon_name</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the name of an example icon or
149
<code class="literal">None</code>.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">get_example_icon_name</code>() method
150
150
returns the name of an icon that is representative of the current theme (for
151
instance, to use when presenting a list of themes to the user.)</p></div><div class="refsect2" lang="en"><a name="method-gtkicontheme--rescan-if-needed"></a><h3>gtk.IconTheme.rescan_if_needed</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">rescan_if_needed</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if the icon theme has
152
changed and needed to be reloaded.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">rescan_if_needed</code>() method checks to
151
instance, to use when presenting a list of themes to the user.)</p></div><div class="refsect2" title="gtk.IconTheme.rescan_if_needed"><a name="method-gtkicontheme--rescan-if-needed"></a><h3>gtk.IconTheme.rescan_if_needed</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">rescan_if_needed</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if the icon theme has
152
changed and needed to be reloaded.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">rescan_if_needed</code>() method checks to
153
153
see if the icon theme has changed; if it has, any currently cached
154
154
information is discarded and will be reloaded next time the icon theme is
155
accessed.</p></div><div class="refsect2" lang="en"><a name="method-gtkicontheme--get-icon-sizes"></a><h3>gtk.IconTheme.get_icon_sizes</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_icon_sizes</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>icon_name</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>icon_name</code></strong> :</span></p></td><td>the name of an icon</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a tuple containing the sizes that the icon is
156
available in.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.6 and above.</p></div><p>The <code class="methodname">get_icon_sizes</code>() method returns a
155
accessed.</p></div><div class="refsect2" title="gtk.IconTheme.get_icon_sizes"><a name="method-gtkicontheme--get-icon-sizes"></a><h3>gtk.IconTheme.get_icon_sizes</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_icon_sizes</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>icon_name</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>icon_name</code></strong> :</span></p></td><td>the name of an icon</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a tuple containing the sizes that the icon is
156
available in.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.6 and above.</p></div><p>The <code class="methodname">get_icon_sizes</code>() method returns a
157
157
tuple containing the sizes available for the icon named by
158
158
<em class="parameter"><code>icon_name</code></em>. A size of -1 means the icon is
159
scalable. If the icon is not found an empty tuple is returned.</p></div><div class="refsect2" lang="en"><a name="method-gtkicontheme--lookup-by-gicon"></a><h3>gtk.IconTheme.lookup_by_gicon</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">lookup_by_gicon</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>icon</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>size</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>flags</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>icon</code></strong> :</span></p></td><td>the <PYGTKDOCLINK HREF="class-gioicon"><code class="classname">gio.Icon</code></PYGTKDOCLINK>
159
scalable. If the icon is not found an empty tuple is returned.</p></div><div class="refsect2" title="gtk.IconTheme.lookup_by_gicon"><a name="method-gtkicontheme--lookup-by-gicon"></a><h3>gtk.IconTheme.lookup_by_gicon</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">lookup_by_gicon</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>icon</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>size</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>flags</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>icon</code></strong> :</span></p></td><td>the <PYGTKDOCLINK HREF="class-gioicon"><code class="classname">gio.Icon</code></PYGTKDOCLINK>
160
160
to lookup</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>size</code></strong> :</span></p></td><td>The desired icon size.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>flags</code></strong> :</span></p></td><td>the flags modifying the behavior of the icon
161
161
lookup</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>A <a class="link" href="class-gtkiconinfo.html" title="gtk.IconInfo"><code class="classname">gtk.IconInfo</code></a>.
162
162
structure containing information about the icon, or <code class="literal">None</code>
163
if the icon wasn't found.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.14 and above.</p></div><p>
163
if the icon wasn't found.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.14 and above.</p></div><p>
164
164
The <code class="methodname">lookup_by_gicon</code>() method Looks up an icon
165
165
and returns a structure containing information such as the filename of
166
166
the icon. The icon can then be rendered into a pixbuf using
167
167
<code class="methodname"><a class="link" href="class-gtkiconinfo.html#method-gtkiconinfo--load-icon" title="gtk.IconInfo.load_icon">gtk.IconInfo.load_icon</a></code>().
168
</p></div></div><div class="refsect1" lang="en"><a name="id3535583"></a><h2>Functions</h2><div class="refsect2" lang="en"><a name="function-gtk--icon-theme-get-default"></a><h3>gtk.icon_theme_get_default</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.icon_theme_get_default</span>()</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>A unique <a class="link" href="class-gtkicontheme.html" title="gtk.IconTheme"><code class="classname">gtk.IconTheme</code></a>
168
</p></div></div><div class="refsect1" title="Functions"><a name="id3845424"></a><h2>Functions</h2><div class="refsect2" title="gtk.icon_theme_get_default"><a name="function-gtk--icon-theme-get-default"></a><h3>gtk.icon_theme_get_default</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.icon_theme_get_default</span>()</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>A unique <a class="link" href="class-gtkicontheme.html" title="gtk.IconTheme"><code class="classname">gtk.IconTheme</code></a>
169
169
associated with the default <a class="link" href="class-gdkscreen.html" title="gtk.gdk.Screen"><code class="classname">gtk.gdk.Screen</code></a>. This
170
170
icon theme is associated with the screen and can be used as long
171
as the screen is open.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This function is available in PyGTK 2.4 and above.</p></div><p>The <code class="function">gtk.icon_them_get_default</code>() function
171
as the screen is open.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This function is available in PyGTK 2.4 and above.</p></div><p>The <code class="function">gtk.icon_them_get_default</code>() function
172
172
returns the icon theme for the default screen. See the <a class="link" href="class-gtkicontheme.html#function-gtk--icon-theme-get-for-screen" title="gtk.icon_theme_get_for_screen"><code class="function">gtk.icon_theme_get_for_screen</code>()</a>
173
function.</p></div><div class="refsect2" lang="en"><a name="function-gtk--icon-theme-get-for-screen"></a><h3>gtk.icon_theme_get_for_screen</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.icon_theme_get_for_screen</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>screen</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>screen</code></strong> :</span></p></td><td>a <a class="link" href="class-gdkscreen.html" title="gtk.gdk.Screen"><code class="classname">gtk.gdk.Screen</code></a>
173
function.</p></div><div class="refsect2" title="gtk.icon_theme_get_for_screen"><a name="function-gtk--icon-theme-get-for-screen"></a><h3>gtk.icon_theme_get_for_screen</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.icon_theme_get_for_screen</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>screen</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>screen</code></strong> :</span></p></td><td>a <a class="link" href="class-gdkscreen.html" title="gtk.gdk.Screen"><code class="classname">gtk.gdk.Screen</code></a>
174
174
object</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>A unique <a class="link" href="class-gtkicontheme.html" title="gtk.IconTheme"><code class="classname">gtk.IconTheme</code></a>
175
175
associated with the default <a class="link" href="class-gdkscreen.html" title="gtk.gdk.Screen"><code class="classname">gtk.gdk.Screen</code></a>. This
176
176
icon theme is associated with the screen and can be used as long
177
as the screen is open.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This function is available in PyGTK 2.4 and above.</p></div><p>The <code class="function">gtk.icon_theme_get_for_screen</code>()
177
as the screen is open.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This function is available in PyGTK 2.4 and above.</p></div><p>The <code class="function">gtk.icon_theme_get_for_screen</code>()
178
178
function returns the icon theme object associated with the <a class="link" href="class-gdkscreen.html" title="gtk.gdk.Screen"><code class="classname">gtk.gdk.Screen</code></a>
179
179
specified by <em class="parameter"><code>screen</code></em>. If this function has not
180
180
previously been called for the given screen, a new icon theme object will be
182
182
expensive to create, so using this function is usually a better choice than
183
183
calling the <a class="link" href="class-gtkicontheme.html#constructor-gtkicontheme" title="Constructor">gtk.IconTheme</a>()
184
184
constructor and setting the screen yourself; by using this function a single
185
icon theme object will be shared between users.</p></div><div class="refsect2" lang="en"><a name="function-gtk--icon-theme-add-builtin-icon"></a><h3>gtk.icon_theme_add_builtin_icon</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.icon_theme_add_builtin_icon</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>icon_name</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>size</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>pixbuf</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>icon_name</code></strong> :</span></p></td><td> the name of the icon to
185
icon theme object will be shared between users.</p></div><div class="refsect2" title="gtk.icon_theme_add_builtin_icon"><a name="function-gtk--icon-theme-add-builtin-icon"></a><h3>gtk.icon_theme_add_builtin_icon</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.icon_theme_add_builtin_icon</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>icon_name</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>size</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>pixbuf</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>icon_name</code></strong> :</span></p></td><td> the name of the icon to
186
186
register</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>size</code></strong> :</span></p></td><td> the size at which to register the icon
187
187
(different images can be registered for the same icon name at
188
188
different sizes.)</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>pixbuf</code></strong> :</span></p></td><td>a <a class="link" href="class-gdkpixbuf.html" title="gtk.gdk.Pixbuf"><code class="classname">gtk.gdk.Pixbuf</code></a>
189
189
that contains the image to use for
190
<em class="parameter"><code>icon_name</code></em>.</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td></td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This function is available in PyGTK 2.4 and above.</p></div><p>The <code class="function">gtk.icon_theme_add_builtin_icon</code>()
190
<em class="parameter"><code>icon_name</code></em>.</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td></td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This function is available in PyGTK 2.4 and above.</p></div><p>The <code class="function">gtk.icon_theme_add_builtin_icon</code>()
191
191
function registers a built-in icon for icon theme lookups using
192
192
<em class="parameter"><code>icon_name</code></em> as the icon name,
193
193
<em class="parameter"><code>size</code></em> as the icon size and
added
removed
docs/html/class-gtkicontheme.html
