1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.IconSource</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-gtkiconset.html" title="gtk.IconSet"><link rel="next" href="class-gtkicontheme.html" title="gtk.IconTheme"></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.IconSource</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtkiconset.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtkicontheme.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-gtkiconsource"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.IconSource</h2><p>gtk.IconSource — a source for icon variants</p></div><div class="refsect1" lang="en"><a name="id3528711"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.IconSource</span></span>(<span class="ooclass"><span class="classname">gobject.GBoxed</span></span>):
1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.IconSource</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-gtkiconset.html" title="gtk.IconSet"><link rel="next" href="class-gtkicontheme.html" title="gtk.IconTheme"></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.IconSource</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtkiconset.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtkicontheme.html">Next</a></td></tr></table><hr></div><div class="refentry" title="gtk.IconSource"><a name="class-gtkiconsource"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.IconSource</h2><p>gtk.IconSource — a source for icon variants</p></div><div class="refsect1" title="Synopsis"><a name="id3838549"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.IconSource</span></span>(<span class="ooclass"><span class="classname">gobject.GBoxed</span></span>):
2
2
<code class="constructorsynopsis"> <span class="methodname"><a class="link" href="class-gtkiconsource.html#constructor-gtkiconsource" title="Constructor">gtk.IconSource</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkiconsource.html#method-gtkiconsource--copy" title="gtk.IconSource.copy">copy</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkiconsource.html#method-gtkiconsource--free" title="gtk.IconSource.free">free</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkiconsource.html#method-gtkiconsource--set-filename" title="gtk.IconSource.set_filename">set_filename</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>filename</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkiconsource.html#method-gtkiconsource--set-pixbuf" title="gtk.IconSource.set_pixbuf">set_pixbuf</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>pixbuf</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkiconsource.html#method-gtkiconsource--get-filename" title="gtk.IconSource.get_filename">get_filename</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkiconsource.html#method-gtkiconsource--get-pixbuf" title="gtk.IconSource.get_pixbuf">get_pixbuf</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkiconsource.html#method-gtkiconsource--set-direction-wildcarded" title="gtk.IconSource.set_direction_wildcarded">set_direction_wildcarded</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>setting</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkiconsource.html#method-gtkiconsource--set-state-wildcarded" title="gtk.IconSource.set_state_wildcarded">set_state_wildcarded</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>setting</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkiconsource.html#method-gtkiconsource--set-size-wildcarded" title="gtk.IconSource.set_size_wildcarded">set_size_wildcarded</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>setting</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkiconsource.html#method-gtkiconsource--get-size-wildcarded" title="gtk.IconSource.get_size_wildcarded">get_size_wildcarded</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkiconsource.html#method-gtkiconsource--get-state-wildcarded" title="gtk.IconSource.get_state_wildcarded">get_state_wildcarded</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkiconsource.html#method-gtkiconsource--get-direction-wildcarded" title="gtk.IconSource.get_direction_wildcarded">get_direction_wildcarded</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkiconsource.html#method-gtkiconsource--set-direction" title="gtk.IconSource.set_direction">set_direction</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>direction</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkiconsource.html#method-gtkiconsource--set-state" title="gtk.IconSource.set_state">set_state</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>state</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkiconsource.html#method-gtkiconsource--set-size" title="gtk.IconSource.set_size">set_size</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>size</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkiconsource.html#method-gtkiconsource--get-direction" title="gtk.IconSource.get_direction">get_direction</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkiconsource.html#method-gtkiconsource--get-state" title="gtk.IconSource.get_state">get_state</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkiconsource.html#method-gtkiconsource--get-size" title="gtk.IconSource.get_size">get_size</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkiconsource.html#method-gtkiconsource--set-state" title="gtk.IconSource.set_state">set_icon_name</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-gtkiconsource.html#method-gtkiconsource--get-size" title="gtk.IconSource.get_size">get_icon_name</a></span>(<span class="methodparam"></span>)</code><br></pre></td></tr></table><pre class="programlisting">
3
3
<span class="bold"><strong>Functions</strong></span>
5
<code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkiconsource.html#function-gtk--icon-size-lookup" title="gtk.icon_size_lookup">gtk.icon_size_lookup</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>icon_size</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkiconsource.html#function-gtk--icon-size-lookup-for-settings" title="gtk.icon_size_lookup_for_settings">gtk.icon_size_lookup_for_settings</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>settings</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>icon_size</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkiconsource.html#function-gtk--icon-size-register" title="gtk.icon_size_register">gtk.icon_size_register</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>name</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>width</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>height</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkiconsource.html#function-gtk--icon-size-register-alias" title="gtk.icon_size_register_alias">gtk.icon_size_register_alias</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>alias</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>target</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkiconsource.html#function-gtk--icon-size-from-name" title="gtk.icon_size_from_name">gtk.icon_size_from_name</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>name</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkiconsource.html#function-gtk--icon-size-get-name" title="gtk.icon_size_get_name">gtk.icon_size_get_name</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>size</code></strong></span></span>)</code></pre></div><div class="refsect1" lang="en"><a name="id3529455"></a><h2>Description</h2><p>A <a class="link" href="class-gtkiconsource.html" title="gtk.IconSource"><code class="classname">gtk.IconSource</code></a>
5
<code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkiconsource.html#function-gtk--icon-size-lookup" title="gtk.icon_size_lookup">gtk.icon_size_lookup</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>icon_size</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkiconsource.html#function-gtk--icon-size-lookup-for-settings" title="gtk.icon_size_lookup_for_settings">gtk.icon_size_lookup_for_settings</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>settings</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>icon_size</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkiconsource.html#function-gtk--icon-size-register" title="gtk.icon_size_register">gtk.icon_size_register</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>name</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>width</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>height</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkiconsource.html#function-gtk--icon-size-register-alias" title="gtk.icon_size_register_alias">gtk.icon_size_register_alias</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>alias</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>target</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkiconsource.html#function-gtk--icon-size-from-name" title="gtk.icon_size_from_name">gtk.icon_size_from_name</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>name</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkiconsource.html#function-gtk--icon-size-get-name" title="gtk.icon_size_get_name">gtk.icon_size_get_name</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>size</code></strong></span></span>)</code></pre></div><div class="refsect1" title="Description"><a name="id3839294"></a><h2>Description</h2><p>A <a class="link" href="class-gtkiconsource.html" title="gtk.IconSource"><code class="classname">gtk.IconSource</code></a>
6
6
contains a <a class="link" href="class-gdkpixbuf.html" title="gtk.gdk.Pixbuf"><code class="classname">gtk.gdk.Pixbuf</code></a> (or
7
7
an image filename) that serves as the base image for one or more of the
8
8
icons in a <a class="link" href="class-gtkiconset.html" title="gtk.IconSet"><code class="classname">gtk.IconSet</code></a>, along
9
9
with a specification for which icons in the icon set will be based on that
10
10
pixbuf or image file. By default, the icon source has all parameters
11
11
wildcarded. That is, the icon source can be used as the base icon for any
12
desired text direction, widget state, or icon size.</p></div><div class="refsect1" lang="en"><a name="constructor-gtkiconsource"></a><h2>Constructor</h2><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gtk.IconSource</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 new <a class="link" href="class-gtkiconsource.html" title="gtk.IconSource"><code class="classname">gtk.IconSource</code></a></td></tr></tbody></table><p>Creates a new <a class="link" href="class-gtkiconsource.html" title="gtk.IconSource"><code class="classname">gtk.IconSource</code></a>.
12
desired text direction, widget state, or icon size.</p></div><div class="refsect1" title="Constructor"><a name="constructor-gtkiconsource"></a><h2>Constructor</h2><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gtk.IconSource</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 new <a class="link" href="class-gtkiconsource.html" title="gtk.IconSource"><code class="classname">gtk.IconSource</code></a></td></tr></tbody></table><p>Creates a new <a class="link" href="class-gtkiconsource.html" title="gtk.IconSource"><code class="classname">gtk.IconSource</code></a>.
13
13
A <a class="link" href="class-gtkiconsource.html" title="gtk.IconSource"><code class="classname">gtk.IconSource</code></a>
14
14
contains a <a class="link" href="class-gdkpixbuf.html" title="gtk.gdk.Pixbuf"><code class="classname">gtk.gdk.Pixbuf</code></a> (or
15
15
image filename) that serves as the base image for one or more of the icons
17
17
with a specification for which icons in the icon set will be based on that
18
18
pixbuf or image file. By default, the icon source has all parameters
19
19
wildcarded. That is, the icon source will be used as the base icon for any
20
desired text direction, widget state, or icon size.</p></div><div class="refsect1" lang="en"><a name="id3529590"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-gtkiconsource--copy"></a><h3>gtk.IconSource.copy</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">copy</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 new <a class="link" href="class-gtkiconsource.html" title="gtk.IconSource"><code class="classname">gtk.IconSource</code></a></td></tr></tbody></table><p>The <code class="methodname">copy</code>() method creates a copy of the
21
icon source.</p></div><div class="refsect2" lang="en"><a name="method-gtkiconsource--free"></a><h3>gtk.IconSource.free</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">free</span>(<span class="methodparam"></span>)</code></pre><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p>This method is deprecated and should not be used. Use of this
20
desired text direction, widget state, or icon size.</p></div><div class="refsect1" title="Methods"><a name="id3839429"></a><h2>Methods</h2><div class="refsect2" title="gtk.IconSource.copy"><a name="method-gtkiconsource--copy"></a><h3>gtk.IconSource.copy</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">copy</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 new <a class="link" href="class-gtkiconsource.html" title="gtk.IconSource"><code class="classname">gtk.IconSource</code></a></td></tr></tbody></table><p>The <code class="methodname">copy</code>() method creates a copy of the
21
icon source.</p></div><div class="refsect2" title="gtk.IconSource.free"><a name="method-gtkiconsource--free"></a><h3>gtk.IconSource.free</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">free</span>(<span class="methodparam"></span>)</code></pre><div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p>This method is deprecated and should not be used. Use of this
22
22
method may cause your application to crash.</p></div><p>The <code class="methodname">free</code>() method frees a
23
23
dynamically-allocated icon source, along with its filename, size, and pixbuf
24
fields if those are not <code class="literal">None</code>.</p></div><div class="refsect2" lang="en"><a name="method-gtkiconsource--set-filename"></a><h3>gtk.IconSource.set_filename</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_filename</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>filename</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>filename</code></strong> :</span></p></td><td>the image file to use</td></tr></tbody></table><p>The <code class="methodname">set_filename</code>() method sets the name
24
fields if those are not <code class="literal">None</code>.</p></div><div class="refsect2" title="gtk.IconSource.set_filename"><a name="method-gtkiconsource--set-filename"></a><h3>gtk.IconSource.set_filename</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_filename</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>filename</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>filename</code></strong> :</span></p></td><td>the image file to use</td></tr></tbody></table><p>The <code class="methodname">set_filename</code>() method sets the name
25
25
of the image file (specified by <em class="parameter"><code>filename</code></em>) to use as
26
26
the base image when creating icon variants for a <a class="link" href="class-gtkiconset.html" title="gtk.IconSet"><code class="classname">gtk.IconSet</code></a>. The
27
filename must be absolute.</p></div><div class="refsect2" lang="en"><a name="method-gtkiconsource--set-pixbuf"></a><h3>gtk.IconSource.set_pixbuf</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_pixbuf</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>pixbuf</code></strong> :</span></p></td><td>the pixbuf to use as a
27
filename must be absolute.</p></div><div class="refsect2" title="gtk.IconSource.set_pixbuf"><a name="method-gtkiconsource--set-pixbuf"></a><h3>gtk.IconSource.set_pixbuf</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_pixbuf</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>pixbuf</code></strong> :</span></p></td><td>the pixbuf to use as a
28
28
source</td></tr></tbody></table><p>The <code class="methodname">set_pixbuf</code>() method sets a pixbuf
29
29
(specified by <em class="parameter"><code>pixbuf</code></em>) to use as a base image when
30
30
creating icon variants for a <a class="link" href="class-gtkiconset.html" title="gtk.IconSet"><code class="classname">gtk.IconSet</code></a>. If an
31
31
icon source has both a filename and a pixbuf set, the pixbuf will take
32
priority.</p></div><div class="refsect2" lang="en"><a name="method-gtkiconsource--get-filename"></a><h3>gtk.IconSource.get_filename</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_filename</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 image filename</td></tr></tbody></table><p>The <code class="methodname">get_filename</code>() method retrieves the
33
source filename, or <code class="literal">None</code> if none is set.</p></div><div class="refsect2" lang="en"><a name="method-gtkiconsource--get-pixbuf"></a><h3>gtk.IconSource.get_pixbuf</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_pixbuf</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 source pixbuf</td></tr></tbody></table><p>The <code class="methodname">get_pixbuf</code>() method retrieves the
34
source pixbuf, or <code class="literal">None</code> if none is set.</p></div><div class="refsect2" lang="en"><a name="method-gtkiconsource--set-direction-wildcarded"></a><h3>gtk.IconSource.set_direction_wildcarded</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_direction_wildcarded</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>setting</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>setting</code></strong> :</span></p></td><td>if <code class="literal">True</code> wildcard the text
32
priority.</p></div><div class="refsect2" title="gtk.IconSource.get_filename"><a name="method-gtkiconsource--get-filename"></a><h3>gtk.IconSource.get_filename</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_filename</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 image filename</td></tr></tbody></table><p>The <code class="methodname">get_filename</code>() method retrieves the
33
source filename, or <code class="literal">None</code> if none is set.</p></div><div class="refsect2" title="gtk.IconSource.get_pixbuf"><a name="method-gtkiconsource--get-pixbuf"></a><h3>gtk.IconSource.get_pixbuf</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_pixbuf</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 source pixbuf</td></tr></tbody></table><p>The <code class="methodname">get_pixbuf</code>() method retrieves the
34
source pixbuf, or <code class="literal">None</code> if none is set.</p></div><div class="refsect2" title="gtk.IconSource.set_direction_wildcarded"><a name="method-gtkiconsource--set-direction-wildcarded"></a><h3>gtk.IconSource.set_direction_wildcarded</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_direction_wildcarded</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>setting</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>setting</code></strong> :</span></p></td><td>if <code class="literal">True</code> wildcard the text
35
35
direction</td></tr></tbody></table><p>The <code class="methodname">set_direction_wildcarded</code>() method
36
36
determines whether the icon source direction is wildcarded according to the
37
37
value specified by <em class="parameter"><code>setting</code></em>. If
72
72
icon sources. An exact match will be used when possible.</p><p><a class="link" href="class-gtkiconset.html" title="gtk.IconSet"><code class="classname">gtk.IconSet</code></a> will
73
73
normally scale wildcarded source images to produce an appropriate icon at a
74
74
given size, but will not change the size of source images that match
75
exactly.</p></div><div class="refsect2" lang="en"><a name="method-gtkiconsource--get-size-wildcarded"></a><h3>gtk.IconSource.get_size_wildcarded</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_size_wildcarded</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 this icon source is
75
exactly.</p></div><div class="refsect2" title="gtk.IconSource.get_size_wildcarded"><a name="method-gtkiconsource--get-size-wildcarded"></a><h3>gtk.IconSource.get_size_wildcarded</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_size_wildcarded</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 this icon source is
76
76
a base for any icon size variant</td></tr></tbody></table><p>The <code class="methodname">get_size_wildcarded</code>() method gets
77
77
the value set by the <a class="link" href="class-gtkiconsource.html#method-gtkiconsource--set-size-wildcarded" title="gtk.IconSource.set_size_wildcarded"><code class="methodname">set_size_wildcarded</code>()</a>
78
method.</p></div><div class="refsect2" lang="en"><a name="method-gtkiconsource--get-state-wildcarded"></a><h3>gtk.IconSource.get_state_wildcarded</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_state_wildcarded</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 this icon source is
78
method.</p></div><div class="refsect2" title="gtk.IconSource.get_state_wildcarded"><a name="method-gtkiconsource--get-state-wildcarded"></a><h3>gtk.IconSource.get_state_wildcarded</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_state_wildcarded</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 this icon source is
79
79
a base for any widget state variant</td></tr></tbody></table><p>The <code class="methodname">get_state_wildcarded</code>() method gets
80
80
the value set by the <a class="link" href="class-gtkiconsource.html#method-gtkiconsource--set-state-wildcarded" title="gtk.IconSource.set_state_wildcarded"><code class="methodname">set_state_wildcarded</code>()</a>
81
method.</p></div><div class="refsect2" lang="en"><a name="method-gtkiconsource--get-direction-wildcarded"></a><h3>gtk.IconSource.get_direction_wildcarded</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_direction_wildcarded</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 this icon source is
81
method.</p></div><div class="refsect2" title="gtk.IconSource.get_direction_wildcarded"><a name="method-gtkiconsource--get-direction-wildcarded"></a><h3>gtk.IconSource.get_direction_wildcarded</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_direction_wildcarded</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 this icon source is
82
82
a base for any text direction variant</td></tr></tbody></table><p>The <code class="methodname">get_direction_wildcarded</code>() method
83
83
gets the value set by the <a class="link" href="class-gtkiconsource.html#method-gtkiconsource--set-direction-wildcarded" title="gtk.IconSource.set_direction_wildcarded"><code class="methodname">set_direction_wildcarded</code>()</a>
84
method.</p></div><div class="refsect2" lang="en"><a name="method-gtkiconsource--set-direction"></a><h3>gtk.IconSource.set_direction</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_direction</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>direction</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>direction</code></strong> :</span></p></td><td>the text direction this icon source applies
84
method.</p></div><div class="refsect2" title="gtk.IconSource.set_direction"><a name="method-gtkiconsource--set-direction"></a><h3>gtk.IconSource.set_direction</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_direction</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>direction</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>direction</code></strong> :</span></p></td><td>the text direction this icon source applies
85
85
to</td></tr></tbody></table><p>The <code class="methodname">set_direction</code>() method sets the
86
86
text direction according to the value of <em class="parameter"><code>direction</code></em>
87
87
that the icon source is intended to be used with. The value of direction
102
102
icon source makes no difference if the state is wildcarded. Therefore, you
103
103
should usually call the <a class="link" href="class-gtkiconsource.html#method-gtkiconsource--set-state-wildcarded" title="gtk.IconSource.set_state_wildcarded"><code class="methodname">set_state_wildcarded</code>()</a>
104
104
method with a setting of <code class="literal">False</code> to un-wildcard it in
105
addition to calling this function.</p></div><div class="refsect2" lang="en"><a name="method-gtkiconsource--set-size"></a><h3>gtk.IconSource.set_size</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_size</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>size</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>size</code></strong> :</span></p></td><td>the icon size this source applies
105
addition to calling this function.</p></div><div class="refsect2" title="gtk.IconSource.set_size"><a name="method-gtkiconsource--set-size"></a><h3>gtk.IconSource.set_size</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_size</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>size</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>size</code></strong> :</span></p></td><td>the icon size this source applies
106
106
to</td></tr></tbody></table><p>The <code class="methodname">set_size</code>() method sets the icon
107
107
size specified by <em class="parameter"><code>size</code></em> that the icon source is
108
108
intended to be used with. Setting the icon size for an icon source makes no
109
109
difference if the size is wildcarded. Therefore, you should usually call the
110
110
<a class="link" href="class-gtkiconsource.html#method-gtkiconsource--set-size-wildcarded" title="gtk.IconSource.set_size_wildcarded"><code class="function">gtk.IconSource.set_size_wildcarded()</code></a>
111
111
method with a setting of <code class="literal">False</code> to un-wildcard it in
112
addition to calling this function.</p></div><div class="refsect2" lang="en"><a name="method-gtkiconsource--get-direction"></a><h3>gtk.IconSource.get_direction</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_direction</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 text direction the icon source
112
addition to calling this function.</p></div><div class="refsect2" title="gtk.IconSource.get_direction"><a name="method-gtkiconsource--get-direction"></a><h3>gtk.IconSource.get_direction</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_direction</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 text direction the icon source
113
113
matches</td></tr></tbody></table><p>The <code class="methodname">get_direction</code>() method obtains the
114
114
text direction this icon source applies to. The return value is only useful
115
115
and meaningful if the text direction is <span class="emphasis"><em>not</em></span>
116
wildcarded.</p></div><div class="refsect2" lang="en"><a name="method-gtkiconsource--get-state"></a><h3>gtk.IconSource.get_state</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_state</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 widget state the icon source
116
wildcarded.</p></div><div class="refsect2" title="gtk.IconSource.get_state"><a name="method-gtkiconsource--get-state"></a><h3>gtk.IconSource.get_state</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_state</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 widget state the icon source
117
117
matches</td></tr></tbody></table><p>The <code class="methodname">get_state</code>() method obtains the
118
118
widget state this icon source applies to. The return value is only useful
119
119
and meaningful if the widget state is <span class="emphasis"><em>not</em></span>
120
wildcarded.</p></div><div class="refsect2" lang="en"><a name="method-gtkiconsource--get-size"></a><h3>gtk.IconSource.get_size</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_size</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 icon size this source
120
wildcarded.</p></div><div class="refsect2" title="gtk.IconSource.get_size"><a name="method-gtkiconsource--get-size"></a><h3>gtk.IconSource.get_size</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_size</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 icon size this source
121
121
matches.</td></tr></tbody></table><p>The <code class="methodname">get_size</code>() method obtains the icon
122
122
size this source applies to. The return value is only useful and meaningful
123
if the icon size is <span class="emphasis"><em>not</em></span> wildcarded.</p></div><div class="refsect2" lang="en"><a name="method-gtkiconsource--set-icon-name"></a><h3>gtk.IconSource.set_icon_name</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_icon_name</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>an icon name
124
to</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_icon_name</code>() method uses the
123
if the icon size is <span class="emphasis"><em>not</em></span> wildcarded.</p></div><div class="refsect2" title="gtk.IconSource.set_icon_name"><a name="method-gtkiconsource--set-icon-name"></a><h3>gtk.IconSource.set_icon_name</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_icon_name</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>an icon name
124
to</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_icon_name</code>() method uses the
125
125
name specified by <em class="parameter"><code>icon_name</code></em> to look up an icon in the
126
126
current icon theme to use as a base image when creating icon variants for
127
127
<a class="link" href="class-gtkiconset.html" title="gtk.IconSet"><code class="classname">gtk.IconSet</code></a>.</p><p>In PyGTK 2.10 and above, <em class="parameter"><code>icon_name</code></em> may be
128
<code class="literal">None</code> to unset the icon name.</p></div><div class="refsect2" lang="en"><a name="method-gtkiconsource--get-icon-name"></a><h3>gtk.IconSource.get_icon_name</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_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 icon name or <code class="literal">None</code> if no
129
name is set.</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_icon</code>() method returns the
130
source icon name, or <code class="literal">None</code> if no name is set.</p></div></div><div class="refsect1" lang="en"><a name="id3531382"></a><h2>Functions</h2><div class="refsect2" lang="en"><a name="function-gtk--icon-size-lookup"></a><h3>gtk.icon_size_lookup</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.icon_size_lookup</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>icon_size</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_size</code></strong> :</span></p></td><td> an icon size</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a 2-tuple containing the width and height of
128
<code class="literal">None</code> to unset the icon name.</p></div><div class="refsect2" title="gtk.IconSource.get_icon_name"><a name="method-gtkiconsource--get-icon-name"></a><h3>gtk.IconSource.get_icon_name</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_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 icon name or <code class="literal">None</code> if no
129
name is set.</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_icon</code>() method returns the
130
source icon name, or <code class="literal">None</code> if no name is set.</p></div></div><div class="refsect1" title="Functions"><a name="id3841221"></a><h2>Functions</h2><div class="refsect2" title="gtk.icon_size_lookup"><a name="function-gtk--icon-size-lookup"></a><h3>gtk.icon_size_lookup</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.icon_size_lookup</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>icon_size</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_size</code></strong> :</span></p></td><td> an icon size</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a 2-tuple containing the width and height of
131
131
the specified <em class="parameter"><code>icon_size</code></em></td></tr></tbody></table><p>The <code class="function">gtk.icon_size_lookup</code>() function returns
132
132
a 2-tuple containing the width and height of the icon size specified by
133
133
<em class="parameter"><code>icon_size</code></em>. The value of
134
<em class="parameter"><code>icon_size</code></em> must be one of:</p><div class="itemizedlist"><ul type="disc"><li><code class="literal">gtk.ICON_SIZE_MENU</code></li><li><code class="literal">gtk.ICON_SIZE_SMALL_TOOLBAR</code></li><li><code class="literal">gtk.ICON_SIZE_LARGE_TOOLBAR</code></li><li><code class="literal">gtk.ICON_SIZE_BUTTON</code></li><li><code class="literal">gtk.ICON_SIZE_DND</code></li><li><code class="literal">gtk.ICON_SIZE_DIALOG</code></li></ul></div><p>or an integer value returned from 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>
135
function.</p></div><div class="refsect2" lang="en"><a name="function-gtk--icon-size-lookup-for-settings"></a><h3>gtk.icon_size_lookup_for_settings</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.icon_size_lookup_for_settings</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>settings</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>icon_size</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>settings</code></strong> :</span></p></td><td>a <a class="link" href="class-gtksettings.html" title="gtk.Settings"><code class="classname">gtk.Settings</code></a>
134
<em class="parameter"><code>icon_size</code></em> must be one of:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><code class="literal">gtk.ICON_SIZE_MENU</code></li><li class="listitem"><code class="literal">gtk.ICON_SIZE_SMALL_TOOLBAR</code></li><li class="listitem"><code class="literal">gtk.ICON_SIZE_LARGE_TOOLBAR</code></li><li class="listitem"><code class="literal">gtk.ICON_SIZE_BUTTON</code></li><li class="listitem"><code class="literal">gtk.ICON_SIZE_DND</code></li><li class="listitem"><code class="literal">gtk.ICON_SIZE_DIALOG</code></li></ul></div><p>or an integer value returned from 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>
135
function.</p></div><div class="refsect2" title="gtk.icon_size_lookup_for_settings"><a name="function-gtk--icon-size-lookup-for-settings"></a><h3>gtk.icon_size_lookup_for_settings</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.icon_size_lookup_for_settings</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>settings</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>icon_size</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>settings</code></strong> :</span></p></td><td>a <a class="link" href="class-gtksettings.html" title="gtk.Settings"><code class="classname">gtk.Settings</code></a>
136
136
object used to determine which user preferences to use.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>icon_size</code></strong> :</span></p></td><td> an icon size</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a 2-tuple containing the width and height of
137
137
the specified <em class="parameter"><code>icon_size</code></em> or <code class="literal">None</code>
138
if <em class="parameter"><code>icon_size</code></em> was invalid.</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_size_lookup_for_settings</code>()
138
if <em class="parameter"><code>icon_size</code></em> was invalid.</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_size_lookup_for_settings</code>()
139
139
function returns a 2-tuple containing the width and height of the icon size
140
140
specified by <em class="parameter"><code>icon_size</code></em> of <code class="literal">None</code> if
141
141
<em class="parameter"><code>icon_size</code></em> was not valid. The value of
142
<em class="parameter"><code>icon_size</code></em> must be one of:</p><div class="itemizedlist"><ul type="disc"><li><code class="literal">gtk.ICON_SIZE_MENU</code></li><li><code class="literal">gtk.ICON_SIZE_SMALL_TOOLBAR</code></li><li><code class="literal">gtk.ICON_SIZE_LARGE_TOOLBAR</code></li><li><code class="literal">gtk.ICON_SIZE_BUTTON</code></li><li><code class="literal">gtk.ICON_SIZE_DND</code></li><li><code class="literal">gtk.ICON_SIZE_DIALOG</code></li></ul></div><p>or an integer value returned from 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>
143
function.</p></div><div class="refsect2" lang="en"><a name="function-gtk--icon-size-register"></a><h3>gtk.icon_size_register</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.icon_size_register</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>name</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>width</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>height</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>name</code></strong> :</span></p></td><td>the name of the icon size</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>width</code></strong> :</span></p></td><td>the width of the icon size</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>height</code></strong> :</span></p></td><td>the height of the icon
142
<em class="parameter"><code>icon_size</code></em> must be one of:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><code class="literal">gtk.ICON_SIZE_MENU</code></li><li class="listitem"><code class="literal">gtk.ICON_SIZE_SMALL_TOOLBAR</code></li><li class="listitem"><code class="literal">gtk.ICON_SIZE_LARGE_TOOLBAR</code></li><li class="listitem"><code class="literal">gtk.ICON_SIZE_BUTTON</code></li><li class="listitem"><code class="literal">gtk.ICON_SIZE_DND</code></li><li class="listitem"><code class="literal">gtk.ICON_SIZE_DIALOG</code></li></ul></div><p>or an integer value returned from 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>
143
function.</p></div><div class="refsect2" title="gtk.icon_size_register"><a name="function-gtk--icon-size-register"></a><h3>gtk.icon_size_register</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.icon_size_register</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>name</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>width</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>height</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>name</code></strong> :</span></p></td><td>the name of the icon size</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>width</code></strong> :</span></p></td><td>the width of the icon size</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>height</code></strong> :</span></p></td><td>the height of the icon
144
144
size</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>an integer representing the icon
145
145
size</td></tr></tbody></table><p>The <code class="function">gtk.icon_size_register</code>() function
146
146
registers a new icon size for the specified <em class="parameter"><code>width</code></em> and
147
147
<em class="parameter"><code>height</code></em> with the specified <em class="parameter"><code>name</code></em>
148
and returns the integer used to represent the icon size.</p></div><div class="refsect2" lang="en"><a name="function-gtk--icon-size-register-alias"></a><h3>gtk.icon_size_register_alias</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.icon_size_register_alias</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>alias</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>target</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>alias</code></strong> :</span></p></td><td>an alias for
148
and returns the integer used to represent the icon size.</p></div><div class="refsect2" title="gtk.icon_size_register_alias"><a name="function-gtk--icon-size-register-alias"></a><h3>gtk.icon_size_register_alias</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.icon_size_register_alias</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>alias</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>target</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>alias</code></strong> :</span></p></td><td>an alias for
149
149
<em class="parameter"><code>target</code></em></td></tr><tr><td><p><span class="term"><strong class="parameter"><code>target</code></strong> :</span></p></td><td>an integer representing an existing icon
150
150
size</td></tr></tbody></table><p>The <code class="function">gtk.icon_size_register_alias</code>() function
151
151
registers the specified <em class="parameter"><code>alias</code></em> as another name for the
152
icon size specified by <em class="parameter"><code>target</code></em>.</p></div><div class="refsect2" lang="en"><a name="function-gtk--icon-size-from-name"></a><h3>gtk.icon_size_from_name</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.icon_size_from_name</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>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>name</code></strong> :</span></p></td><td>a name of an existing icon
152
icon size specified by <em class="parameter"><code>target</code></em>.</p></div><div class="refsect2" title="gtk.icon_size_from_name"><a name="function-gtk--icon-size-from-name"></a><h3>gtk.icon_size_from_name</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.icon_size_from_name</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>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>name</code></strong> :</span></p></td><td>a name of an existing icon
153
153
size</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the icon size associated with
154
154
<em class="parameter"><code>name</code></em></td></tr></tbody></table><p>The <code class="function">gtk.icon_size_from_name</code>() function
155
155
returns the integer representing the icon size associated with the specified
156
<em class="parameter"><code>name</code></em>.</p></div><div class="refsect2" lang="en"><a name="function-gtk--icon-size-get-name"></a><h3>gtk.icon_size_get_name</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.icon_size_get_name</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>size</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>size</code></strong> :</span></p></td><td>an integer representing an existing icon
156
<em class="parameter"><code>name</code></em>.</p></div><div class="refsect2" title="gtk.icon_size_get_name"><a name="function-gtk--icon-size-get-name"></a><h3>gtk.icon_size_get_name</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.icon_size_get_name</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>size</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>size</code></strong> :</span></p></td><td>an integer representing an existing icon
157
157
size</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the name associated with the icon size
158
158
represented by <em class="parameter"><code>size</code></em></td></tr></tbody></table><p>The <code class="function">gtk.icon_size_get_name</code>() function
159
159
returns the name of the icon size represented by
added
removed
docs/html/class-gtkiconsource.html
