/usr/share/gtk-doc/html/pygtk/class-gtkstatusicon.html is in python-gtk2-doc 2.24.0-5.1ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 | <html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.StatusIcon</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"><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-gtkstatusbar.html" title="gtk.Statusbar"><link rel="next" href="class-gtkstyle.html" title="gtk.Style"></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.StatusIcon</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtkstatusbar.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtkstyle.html">Next</a></td></tr></table><hr></div><div class="refentry" title="gtk.StatusIcon"><a name="class-gtkstatusicon"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.StatusIcon</h2><p>gtk.StatusIcon — display an icon in the system tray (new in PyGTK
2.10)</p></div><div class="refsect1" title="Synopsis"><a name="id3909367"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.StatusIcon</span></span>(<span class="ooclass"><span class="classname"><PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK></span></span>):
<code class="constructorsynopsis"> <span class="methodname"><a class="link" href="class-gtkstatusicon.html#constructor-gtkstatusicon" title="gtk.StatusIcon">gtk.StatusIcon</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkstatusicon.html#method-gtkstatusicon--get-storage-type" title="gtk.StatusIcon.get_storage_type">get_storage_type</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkstatusicon.html#method-gtkstatusicon--get-gicon" title="gtk.StatusIcon.get_gicon">get_gicon</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkstatusicon.html#method-gtkstatusicon--get-pixbuf" title="gtk.StatusIcon.get_pixbuf">get_pixbuf</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkstatusicon.html#method-gtkstatusicon--get-stock" title="gtk.StatusIcon.get_stock">get_stock</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkstatusicon.html#method-gtkstatusicon--get-icon-name" title="gtk.StatusIcon.get_icon_name">get_icon_name</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkstatusicon.html#method-gtkstatusicon--get-size" title="gtk.StatusIcon.get_size">get_size</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkstatusicon.html#method-gtkstatusicon--get-x11-window-id" title="gtk.StatusIcon.get_x11_window_id">get_x11_window_id</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkstatusicon.html#method-gtkstatusicon--set-tooltip" title="gtk.StatusIcon.set_tooltip">set_tooltip</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>tooltip_text</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkstatusicon.html#method-gtkstatusicon--set-visible" title="gtk.StatusIcon.set_visible">set_visible</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>visible</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkstatusicon.html#method-gtkstatusicon--get-visible" title="gtk.StatusIcon.get_visible">get_visible</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkstatusicon.html#method-gtkstatusicon--set-blinking" title="gtk.StatusIcon.set_blinking">set_blinking</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>blinking</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkstatusicon.html#method-gtkstatusicon--get-blinking" title="gtk.StatusIcon.get_blinking">get_blinking</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkstatusicon.html#method-gtkstatusicon--is-embedded" title="gtk.StatusIcon.is_embedded">is_embedded</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkstatusicon.html#method-gtkstatusicon--get-geometry" title="gtk.StatusIcon.get_geometry">get_geometry</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>screen</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>area</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>orientation</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkstatusicon.html#method-gtkstatusicon--get-screen" title="gtk.StatusIcon.get_screen">get_screen</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkstatusicon.html#method-gtkstatusicon--set-screen" title="gtk.StatusIcon.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-gtkstatusicon.html#method-gtkstatusicon--set-from-pixbuf" title="gtk.StatusIcon.set_from_pixbuf">set_from_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-gtkstatusicon.html#method-gtkstatusicon--set-from-file" title="gtk.StatusIcon.set_from_file">set_from_file</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-gtkstatusicon.html#method-gtkstatusicon--set-from-stock" title="gtk.StatusIcon.set_from_stock">set_from_stock</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>stock_id</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkstatusicon.html#method-gtkstatusicon--set-from-icon-name" title="gtk.StatusIcon.set_from_icon_name">set_from_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-gtkstatusicon.html#method-gtkstatusicon--set-from-gicon" title="gtk.StatusIcon.set_from_gicon">set_from_gicon</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>gicon</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkstatusicon.html#method-gtkstatusicon--set-name" title="gtk.StatusIcon.set_name">set_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-gtkstatusicon.html#method-gtkstatusicon--set-title" title="gtk.StatusIcon.set_title">set_title</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>title</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkstatusicon.html#method-gtkstatusicon--get-title" title="gtk.StatusIcon.get_title">get_title</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkstatusicon.html#method-gtkstatusicon--set-has-tooltip" title="gtk.StatusIcon.set_has_tooltip">set_has_tooltip</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>has_tooltip</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkstatusicon.html#method-gtkstatusicon--get-has-tooltip" title="gtk.StatusIcon.get_has_tooltip">get_has_tooltip</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkstatusicon.html#method-gtkstatusicon--set-tooltip-text" title="gtk.StatusIcon.set_tooltip_text">set_tooltip_text</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>text</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkstatusicon.html#method-gtkstatusicon--get-tooltip-text" title="gtk.StatusIcon.get_tooltip_text">get_tooltip_text</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkstatusicon.html#method-gtkstatusicon--set-tooltip-markup" title="gtk.StatusIcon.set_tooltip_markup">set_tooltip_markup</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>markup</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkstatusicon.html#method-gtkstatusicon--get-tooltip-markup" title="gtk.StatusIcon.get_tooltip_markup">get_tooltip_markup</a></span>(<span class="methodparam"></span>)</code><br></pre></td></tr></table><pre class="programlisting">
<span class="bold"><strong>Functions</strong></span>
<code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkstatusicon.html#function-gtk--status-icon-new-from-pixbuf" title="gtk.status_icon_new_from_pixbuf">gtk.status_icon_new_from_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-gtkstatusicon.html#function-gtk--status-icon-new-from-file" title="gtk.status_icon_new_from_file">gtk.status_icon_new_from_file</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-gtkstatusicon.html#function-gtk--status-icon-new-from-gicon" title="gtk.status_icon_new_from_gicon">gtk.status_icon_new_from_gicon</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-gtkstatusicon.html#function-gtk--status-icon-new-from-stock" title="gtk.status_icon_new_from_stock">gtk.status_icon_new_from_stock</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>stock_id</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkstatusicon.html#function-gtk--status-icon-new-from-icon-name" title="gtk.status_icon_new_from_icon_name">gtk.status_icon_new_from_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-gtkstatusicon.html#function-gtk--status-icon-position-menu" title="gtk.status_icon_position_menu">gtk.status_icon_position_menu</a></span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>menu</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>statusicon</code></em></span></span>)</code></pre></div><div class="refsect1" title="Ancestry"><a name="id3910345"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
+-- <a class="link" href="class-gtkstatusicon.html" title="gtk.StatusIcon">gtk.StatusIcon</a>
</pre></div><div class="refsect1" title="gtk.StatusIcon Properties"><a name="properties-gtkstatusicon"></a><h2>gtk.StatusIcon Properties</h2><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table width="100%" border="0"><colgroup><col width="1in"><col width="1in"><col width="3.5in"></colgroup><tbody><tr valign="top"><td valign="top">"blinking"</td><td valign="top">Read-Write</td><td valign="top">if <code class="literal">True</code> the status icon is
blinking. Default value: <code class="literal">False</code>.</td></tr><tr valign="top"><td valign="top">"embedded"</td><td valign="top">Read-Write</td><td valign="top"><code class="literal">True</code> if the status icon is
embedded in a notification area.
Default value: <code class="literal">False</code>.
This property is available in GTK+ 2.12 and above.</td></tr><tr valign="top"><td valign="top">"file"</td><td valign="top">Write</td><td valign="top">Filename to load and display. Default value:
<code class="literal">None</code>.</td></tr><tr valign="top"><td valign="top">"gicon"</td><td valign="top">Read-Write</td><td valign="top">The GIcon displayed in the GtkStatusIcon. For themed icons,
the image will be updated automatically if the theme changes.</td></tr><tr valign="top"><td valign="top">"icon-name"</td><td valign="top">Read-Write</td><td valign="top">The name of the icon from the icon theme. Default value:
<code class="literal">None</code>.</td></tr><tr valign="top"><td valign="top">"orientation"</td><td valign="top">Read-Write</td><td valign="top">The orientation of the tray in which the statusicon is embedded.
Default value: gtk.ORIENTATION_HORIZONTAL.
This property is available in GTK+ 2.12 and above.</td></tr><tr valign="top"><td valign="top">"pixbuf"</td><td valign="top">Read-Write</td><td valign="top">A <a class="link" href="class-gdkpixbuf.html" title="gtk.gdk.Pixbuf"><code class="classname">gtk.gdk.Pixbuf</code></a>
to display.</td></tr><tr valign="top"><td valign="top">"size"</td><td valign="top">Read</td><td valign="top">The size of the icon. Default value: 0.</td></tr><tr valign="top"><td valign="top">"stock"</td><td valign="top">Read-Write</td><td valign="top">Stock ID for a stock image to display. Default value:
<code class="literal">None</code>.</td></tr><tr valign="top"><td valign="top">"storage-type"</td><td valign="top">Read</td><td valign="top">The representation being used for image data. Default
value: <code class="literal">gtk.IMAGE_EMPTY</code>.</td></tr><tr valign="top"><td valign="top">"title"</td><td valign="top">Read-Write</td><td valign="top">The title of this tray icon. This should be a short, human-readable,
localized string describing the tray icon. It may be used by tools like
screen readers to render the tray icon.
Default value: <code class="literal">None</code>.
This property is available in GTK+ 2.18 and above.</td></tr><tr valign="top"><td valign="top">"tooltip-markup"</td><td valign="top">Read-Write</td><td valign="top">Sets the text of the tooltip to be the given string, which is marked up
with the Pango text markup language.
Default value: <code class="literal">None</code>.
This property is available in GTK+ 2.16 and above.</td></tr><tr valign="top"><td valign="top">"tooltip-text"</td><td valign="top">Read-Write</td><td valign="top">Sets the text of tooltip to be the given string.
Default value: <code class="literal">None</code>.
This property is available in GTK+ 2.16 and above.</td></tr><tr valign="top"><td valign="top">"visible"</td><td valign="top">Read-Write</td><td valign="top">If <code class="literal">True</code> the status icon is
visible. Default value: <code class="literal">True</code>.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" title="gtk.StatusIcon Signal Prototypes"><a name="signal-prototypes-gtkstatusicon"></a><h2>gtk.StatusIcon 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-gtkstatusicon.html#signal-gtkstatusicon--activate" title='The "activate" gtk.StatusIcon Signal'>activate</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>status_icon</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><tr><td><p><span class="term">"<a class="link" href="class-gtkstatusicon.html#signal-gtkstatusicon--popup-menu" title='The "popup-menu" gtk.StatusIcon Signal'>popup-menu</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>status_icon</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>button</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>activate_time</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><tr><td><p><span class="term">"<a class="link" href="class-gtkstatusicon.html#signal-gtkstatusicon--size-changed" title='The "size-changed" gtk.StatusIcon Signal'>size-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>status_icon</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>size</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="id3911020"></a><h2>Description</h2><p>The "system tray" or notification area is normally used for
transient icons that indicate some special state. For example, a system
tray icon might appear to tell the user that they have new mail, or have
an incoming instant message, or something along those lines. The basic
idea is that creating an icon in the notification area is less annoying
than popping up a dialog.</p><p>A <a class="link" href="class-gtkstatusicon.html" title="gtk.StatusIcon"><code class="classname">gtk.StatusIcon</code></a>
object can be used to display an icon in a "system tray". The icon can
have a tooltip, and the user can interact with it by activating it or
popping up a context menu. Critical information should not solely be
displayed in a <a class="link" href="class-gtkstatusicon.html" title="gtk.StatusIcon"><code class="classname">gtk.StatusIcon</code></a>,
since it may not be visible (e.g. when the user doesn't have a
notification area on his panel). This can be checked with the <a class="link" href="class-gtkstatusicon.html#method-gtkstatusicon--is-embedded" title="gtk.StatusIcon.is_embedded"><code class="methodname">gtk.StatusIcon.is_embedded()</code></a>
method.</p><p>On X11, the implementation follows the freedesktop.org "System
Tray" <a class="ulink" href="http://www.freedesktop.org/wiki/Standards/systemtray-spec" target="_top">specification</a>.
Implementations of the "tray" side of this specification can be found
e.g. in the GNOME and KDE panel applications.</p><p>Note that a <a class="link" href="class-gtkstatusicon.html" title="gtk.StatusIcon"><code class="classname">gtk.StatusIcon</code></a>
is <span class="emphasis"><em>not</em></span> a widget, but just a <PYGTKDOCLINK HREF="class-gobject"><code class="classname">gobject.GObject</code></PYGTKDOCLINK>.
Making it a widget would be impractical, since the system tray on Win32
doesn't allow to embed arbitrary widgets.</p></div><div class="refsect1" title="Constructor"><a name="id3911108"></a><h2>Constructor</h2><div class="refsect2" title="gtk.StatusIcon"><a name="constructor-gtkstatusicon"></a><h3>gtk.StatusIcon</h3><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gtk.StatusIcon</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-gtkstatusicon.html" title="gtk.StatusIcon"><code class="classname">gtk.StatusIcon</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 constructor is available in PyGTK 2.10 and above.</p></div><p>Creates an empty status icon object.</p></div></div><div class="refsect1" title="Methods"><a name="id3911184"></a><h2>Methods</h2><div class="refsect2" title="gtk.StatusIcon.set_from_pixbuf"><a name="method-gtkstatusicon--set-from-pixbuf"></a><h3>gtk.StatusIcon.set_from_pixbuf</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_from_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>a <a class="link" href="class-gdkpixbuf.html" title="gtk.gdk.Pixbuf"><code class="classname">gtk.gdk.Pixbuf</code></a>
or <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.10 and above.</p></div><p>Makes <em class="parameter"><code>status_icon</code></em> display
<em class="parameter"><code>pixbuf</code></em>. See the <a class="link" href="class-gtkstatusicon.html#function-gtk--status-icon-new-from-pixbuf" title="gtk.status_icon_new_from_pixbuf"><code class="function">gtk.status_icon_new_from_pixbuf</code>()</a>
function for details.</p></div><div class="refsect2" title="gtk.StatusIcon.set_from_file"><a name="method-gtkstatusicon--set-from-file"></a><h3>gtk.StatusIcon.set_from_file</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_from_file</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>a filename</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.10 and above.</p></div><p>Makes <em class="parameter"><code>status_icon</code></em> display the file
<em class="parameter"><code>filename</code></em>. See the <a class="link" href="class-gtkstatusicon.html#function-gtk--status-icon-new-from-file" title="gtk.status_icon_new_from_file"><code class="function">gtk.status_icon_new_from_file</code>()</a>
function for details.</p></div><div class="refsect2" title="gtk.StatusIcon.set_from_stock"><a name="method-gtkstatusicon--set-from-stock"></a><h3>gtk.StatusIcon.set_from_stock</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_from_stock</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>stock_id</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>stock_id</code></strong> :</span></p></td><td>a stock icon id</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.10 and above.</p></div><p>Makes <em class="parameter"><code>status_icon</code></em> display the stock icon
with the id <em class="parameter"><code>stock_id</code></em>. See the <a class="link" href="class-gtkstatusicon.html#function-gtk--status-icon-new-from-stock" title="gtk.status_icon_new_from_stock"><code class="function">gtk.status_icon_new_from_stock</code>()</a>
function for details.</p></div><div class="refsect2" title="gtk.StatusIcon.set_from_icon_name"><a name="method-gtkstatusicon--set-from-icon-name"></a><h3>gtk.StatusIcon.set_from_icon_name</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_from_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</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.10 and above.</p></div><p>Makes <em class="parameter"><code>status_icon</code></em> display the icon named
<em class="parameter"><code>icon_name</code></em> from the current icon theme. See the
<a class="link" href="class-gtkstatusicon.html#function-gtk--status-icon-new-from-icon-name" title="gtk.status_icon_new_from_icon_name"><code class="function">gtk.status_icon_new_from_icon_name</code>()</a>
function for details.</p></div><div class="refsect2" title="gtk.StatusIcon.set_from_gicon"><a name="method-gtkstatusicon--set-from-gicon"></a><h3>gtk.StatusIcon.set_from_gicon</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_from_gicon</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>gicon</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>gicon</code></strong> :</span></p></td><td>a gio.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.14 and above.</p></div><p>Makes <em class="parameter"><code>status_icon</code></em> display the <em class="parameter"><code>gio.Icon()</code></em>
See <code class="methodname"><a class="link" href="class-gtkstatusicon.html#function-gtk--status-icon-new-from-gicon" title="gtk.status_icon_new_from_gicon">gtk.status_icon_new_from_gicon</a></code>()
for details</p></div><div class="refsect2" title="gtk.StatusIcon.get_storage_type"><a name="method-gtkstatusicon--get-storage-type"></a><h3>gtk.StatusIcon.get_storage_type</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_storage_type</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 representation being used - one of
the <a class="xref" href="gtk-constants.html#gtk-image-type-constants" title="GTK Image Type Constants">GTK Image Type Constants</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.10 and above.</p></div><p>Gets the type of representation being used by the <a class="link" href="class-gtkstatusicon.html" title="gtk.StatusIcon"><code class="classname">gtk.StatusIcon</code></a>
to store image data. If the <a class="link" href="class-gtkstatusicon.html" title="gtk.StatusIcon"><code class="classname">gtk.StatusIcon</code></a>
has no image data, the return value will be
<code class="literal">gtk.IMAGE_EMPTY</code>.</p></div><div class="refsect2" title="gtk.StatusIcon.get_gicon"><a name="method-gtkstatusicon--get-gicon"></a><h3>gtk.StatusIcon.get_gicon</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_gicon</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 displayed icon, or <code class="literal">None</code>
if the image is empty.</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>
Retrieves the gio.Icon() being displayed by the
<a class="link" href="class-gtkstatusicon.html" title="gtk.StatusIcon"><code class="classname">gtk.StatusIcon</code></a>.
The storage type of the status icon must be gtk.IMAGE_EMPTY or gtk.IMAGE_GICON.
If this method fails, icon is left unchanged;
</p></div><div class="refsect2" title="gtk.StatusIcon.get_x11_window_id"><a name="method-gtkstatusicon--get-x11-window-id"></a><h3>gtk.StatusIcon.get_x11_window_id</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_x11_window_id</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>An 32 bit unsigned integer identifier for the
underlying X11 Window.</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>
This function is only useful on the X11/freedesktop.org platform. It
returns a window ID for the widget in the underlying status icon
implementation. This is useful for the Galago notification service,
which can send a window ID in the protocol in order for the server
to position notification windows pointing to a status icon reliably.
</p><p>
This function is not intended for other use cases which are more likely
to be met by one of the non-X11 specific methods,
such as
<code class="methodname"><a class="link" href="class-gtkstatusicon.html#function-gtk--status-icon-position-menu" title="gtk.status_icon_position_menu">gtk.status_icon_position_menu</a></code>().
</p></div><div class="refsect2" title="gtk.StatusIcon.get_pixbuf"><a name="method-gtkstatusicon--get-pixbuf"></a><h3>gtk.StatusIcon.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 displayed pixbuf, or
<code class="literal">None</code> if the image is
empty.</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.10 and above.</p></div><p>Gets the <a class="link" href="class-gdkpixbuf.html" title="gtk.gdk.Pixbuf"><code class="classname">gtk.gdk.Pixbuf</code></a>
being displayed by the <a class="link" href="class-gtkstatusicon.html" title="gtk.StatusIcon"><code class="classname">gtk.StatusIcon</code></a>.
The storage type of the status icon must be
<code class="literal">gtk.IMAGE_EMPTY</code> or
<code class="literal">gtk.IMAGE_PIXBUF</code> (see the <a class="link" href="class-gtkstatusicon.html#method-gtkstatusicon--get-storage-type" title="gtk.StatusIcon.get_storage_type"><code class="methodname">gtk.StatusIcon.get_storage_type()</code></a>
method).</p></div><div class="refsect2" title="gtk.StatusIcon.get_stock"><a name="method-gtkstatusicon--get-stock"></a><h3>gtk.StatusIcon.get_stock</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_stock</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>stock id of the displayed stock icon, or
<code class="literal">None</code> if the image is
empty.</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.10 and above.</p></div><p>Gets the id of the stock icon being displayed by the <a class="link" href="class-gtkstatusicon.html" title="gtk.StatusIcon"><code class="classname">gtk.StatusIcon</code></a>.
The storage type of the status icon must be
<code class="literal">gtk.IMAGE_EMPTY</code> or
<code class="literal">gtk.IMAGE_STOCK</code> (see the <a class="link" href="class-gtkstatusicon.html#method-gtkstatusicon--get-storage-type" title="gtk.StatusIcon.get_storage_type"><code class="methodname">gtk.StatusIcon.get_storage_type()</code></a>
method).</p></div><div class="refsect2" title="gtk.StatusIcon.get_icon_name"><a name="method-gtkstatusicon--get-icon-name"></a><h3>gtk.StatusIcon.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>name of the displayed icon, or
<code class="literal">None</code> if the image is
empty.</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.10 and above.</p></div><p>Gets the name of the icon being displayed by the <a class="link" href="class-gtkstatusicon.html" title="gtk.StatusIcon"><code class="classname">gtk.StatusIcon</code></a>.
The storage type of the status icon must be
<code class="literal">gtk.IMAGE_EMPTY</code> or
<code class="literal">gtk.IMAGE_ICON_NAME</code> (see the <a class="link" href="class-gtkstatusicon.html#method-gtkstatusicon--get-storage-type" title="gtk.StatusIcon.get_storage_type"><code class="methodname">gtk.StatusIcon.get_storage_type()</code></a>
method).</p></div><div class="refsect2" title="gtk.StatusIcon.get_size"><a name="method-gtkstatusicon--get-size"></a><h3>gtk.StatusIcon.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 size that is available for the
image</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.10 and above.</p></div><p>Gets the size in pixels that is available for the image. Stock
icons and named icons adapt their size automatically if the size of
the notification area changes. For other storage types, the
"size-changed" signal can be used to react to size changes.</p></div><div class="refsect2" title="gtk.StatusIcon.set_tooltip"><a name="method-gtkstatusicon--set-tooltip"></a><h3>gtk.StatusIcon.set_tooltip</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_tooltip</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>tooltip_text</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>tooltip_text</code></strong> :</span></p></td><td>the tooltip text, or
<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.10 and above.</p></div><p>Sets the tooltip of the status icon.</p></div><div class="refsect2" title="gtk.StatusIcon.set_visible"><a name="method-gtkstatusicon--set-visible"></a><h3>gtk.StatusIcon.set_visible</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_visible</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>visible</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>visible</code></strong> :</span></p></td><td>if <code class="literal">True</code> show the status
icon, if <code class="literal">False</code> hide it</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.10 and above.</p></div><p>Shows or hides a status icon.</p></div><div class="refsect2" title="gtk.StatusIcon.get_visible"><a name="method-gtkstatusicon--get-visible"></a><h3>gtk.StatusIcon.get_visible</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_visible</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 status icon is
visible</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.10 and above.</p></div><p>Returns <code class="literal">True</code> if the status icon is visible.
Note that being visible does not guarantee that the user can actually
see the icon, see also the <a class="link" href="class-gtkstatusicon.html#method-gtkstatusicon--is-embedded" title="gtk.StatusIcon.is_embedded"><code class="methodname">gtk.StatusIcon.is_embedded()</code></a>
method.</p></div><div class="refsect2" title="gtk.StatusIcon.set_blinking"><a name="method-gtkstatusicon--set-blinking"></a><h3>gtk.StatusIcon.set_blinking</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_blinking</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>blinking</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>blinking</code></strong> :</span></p></td><td>if <code class="literal">True</code> turn blinking on, if
<code class="literal">False</code> turn it off</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.10 and above.</p></div><p>Makes the status icon start or stop blinking. Note that
blinking user interface elements may be problematic for some users,
and thus may be turned off, in which case this setting has no
effect.</p></div><div class="refsect2" title="gtk.StatusIcon.get_blinking"><a name="method-gtkstatusicon--get-blinking"></a><h3>gtk.StatusIcon.get_blinking</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_blinking</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 is
blinking</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.10 and above.</p></div><p>Returns <code class="literal">True</code> if the icon is blinking, see the
<a class="link" href="class-gtkstatusicon.html#method-gtkstatusicon--set-blinking" title="gtk.StatusIcon.set_blinking"><code class="methodname">gtk.StatusIcon.set_blinking()</code></a>
method.</p></div><div class="refsect2" title="gtk.StatusIcon.is_embedded"><a name="method-gtkstatusicon--is-embedded"></a><h3>gtk.StatusIcon.is_embedded</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">is_embedded</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 status icon is
embedded in a notification area.</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.10 and above.</p></div><p>Returns <code class="literal">True</code> if the status icon is embedded
in a notification area.</p></div><div class="refsect2" title="gtk.StatusIcon.get_geometry"><a name="method-gtkstatusicon--get-geometry"></a><h3>gtk.StatusIcon.get_geometry</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_geometry</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 3-tuple (containing the screen, area occupied
by the status icon and the panel orientation) or
None.</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.10 and above.</p></div><p>Returns information in a 3-tuple about the location of the
status icon on screen. The 3-tuple contains the <a class="link" href="class-gdkscreen.html" title="gtk.gdk.Screen"><code class="classname">gtk.gdk.Screen</code></a>,
the area occupied by the status icon as a <a class="link" href="class-gdkrectangle.html" title="gtk.gdk.Rectangle"><code class="classname">gtk.gdk.Rectangle</code></a>
and the orientation of the panel containing the statis icon - one of
the <a class="xref" href="gtk-constants.html#gtk-orientation-constants" title="GTK Orientation Constants">GTK Orientation Constants</a>. This information
can be used to e.g. position popups like notification bubbles. See
the <a class="link" href="class-gtkstatusicon.html#function-gtk--status-icon-position-menu" title="gtk.status_icon_position_menu"><code class="function">gtk.status_icon_position_menu</code>()</a>
function for a more convenient alternative for positioning
menus.</p><p>Note that some platforms do not provide this information.</p></div><div class="refsect2" title="gtk.StatusIcon.get_screen"><a name="method-gtkstatusicon--get-screen"></a><h3>gtk.StatusIcon.get_screen</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_screen</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 <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.12 and above.</p></div><p>Returns the <a class="link" href="class-gdkscreen.html" title="gtk.gdk.Screen"><code class="classname">gtk.gdk.Screen</code></a>
associated with status_icon.</p></div><div class="refsect2" title="gtk.StatusIcon.set_screen"><a name="method-gtkstatusicon--set-screen"></a><h3>gtk.StatusIcon.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.12 and above.</p></div><p>Sets the <a class="link" href="class-gdkscreen.html" title="gtk.gdk.Screen"><code class="classname">gtk.gdk.Screen</code></a>
where status_icon is displayed; if the icon is already mapped, it will be unmapped,
and then remapped on the new screen.</p></div></div><div class="refsect1" title="Functions"><a name="id3913087"></a><h2>Functions</h2><div class="refsect2" title="gtk.status_icon_new_from_pixbuf"><a name="function-gtk--status-icon-new-from-pixbuf"></a><h3>gtk.status_icon_new_from_pixbuf</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.status_icon_new_from_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></td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a new <a class="link" href="class-gtkstatusicon.html" title="gtk.StatusIcon"><code class="classname">gtk.StatusIcon</code></a></td></tr></tbody></table><p>Creates a status icon displaying <em class="parameter"><code>pixbuf</code></em>.
The image will be scaled down to fit in the available space in the
notification area, if necessary.</p></div><div class="refsect2" title="gtk.status_icon_new_from_file"><a name="function-gtk--status-icon-new-from-file"></a><h3>gtk.status_icon_new_from_file</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.status_icon_new_from_file</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></td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a new <a class="link" href="class-gtkstatusicon.html" title="gtk.StatusIcon"><code class="classname">gtk.StatusIcon</code></a></td></tr></tbody></table><p>Creates a status icon displaying the image in the file specified
by <em class="parameter"><code>filename</code></em>. The image will be scaled down to
fit in the available space in the notification area, if
necessary.</p></div><div class="refsect2" title="gtk.status_icon_new_from_gicon"><a name="function-gtk--status-icon-new-from-gicon"></a><h3>gtk.status_icon_new_from_gicon</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.status_icon_new_from_gicon</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>gicon</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>gicon</code></strong> :</span></p></td><td></td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a new <a class="link" href="class-gtkstatusicon.html" title="gtk.StatusIcon"><code class="classname">gtk.StatusIcon</code></a></td></tr></tbody></table><p>
Creates a status icon displaying a gio.Icon(). If the icon is a
themed icon, it will be updated when the theme changes.
</p></div><div class="refsect2" title="gtk.status_icon_new_from_stock"><a name="function-gtk--status-icon-new-from-stock"></a><h3>gtk.status_icon_new_from_stock</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.status_icon_new_from_stock</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>stock_id</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>stock_id</code></strong> :</span></p></td><td>a stock icon id</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a new <a class="link" href="class-gtkstatusicon.html" title="gtk.StatusIcon"><code class="classname">gtk.StatusIcon</code></a></td></tr></tbody></table><p>Creates a status icon displaying a stock icon. Sample stock icon
names are <code class="literal">gtk.STOCK_OPEN</code>,
<code class="literal">gtk.STOCK_QUIT</code>. You can register your own stock
icon names, see the <a class="link" href="class-gtkiconfactory.html#method-gtkiconfactory--add-default" title="gtk.IconFactory.add_default"><code class="methodname">gtk.IconFactory.add_default</code>()</a>
and <a class="link" href="class-gtkiconfactory.html#method-gtkiconfactory--add" title="gtk.IconFactory.add"><code class="methodname">gtk.IconFactory.add</code>()</a>
methods.</p></div><div class="refsect2" title="gtk.status_icon_new_from_icon_name"><a name="function-gtk--status-icon-new-from-icon-name"></a><h3>gtk.status_icon_new_from_icon_name</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.status_icon_new_from_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</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a new <a class="link" href="class-gtkstatusicon.html" title="gtk.StatusIcon"><code class="classname">gtk.StatusIcon</code></a></td></tr></tbody></table><p>Creates a status icon displaying an icon from the current icon
theme. If the current icon theme is changed, the icon will be updated
appropriately.</p></div><div class="refsect2" title="gtk.status_icon_position_menu"><a name="function-gtk--status-icon-position-menu"></a><h3>gtk.status_icon_position_menu</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.status_icon_position_menu</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>menu</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>statusicon</code></em></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"><em class="parameter"><code>menu</code></em> :</span></p></td><td>the <a class="link" href="class-gtkmenu.html" title="gtk.Menu"><code class="classname">gtk.Menu</code></a></td></tr><tr><td><p><span class="term"><em class="parameter"><code>statusicon</code></em> :</span></p></td><td>the <a class="link" href="class-gtkstatusicon.html" title="gtk.StatusIcon"><code class="classname">gtk.StatusIcon</code></a></td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a 3-tuple containing the x and y coordinates
for the menu and a boolean indicating whether the menu should be
pushed in to be completely inside the screen instead of just
clamped to the size to the screen.</td></tr></tbody></table><p>Menu positioning function to use with the <a class="link" href="class-gtkmenu.html#method-gtkmenu--popup" title="gtk.Menu.popup"><code class="methodname">popup</code>()</a>
method to position <em class="parameter"><code>menu</code></em> aligned to
<em class="parameter"><code>statusicon</code></em> .</p><p>Eample use of this function is:</p><pre class="programlisting">
menu.popup(None, None, gtk.status_icon_position_menu,
event.button, event.time, statusicon)
</pre></div><div class="refsect2" title="gtk.StatusIcon.set_name"><a name="method-gtkstatusicon--set-name"></a><h3>gtk.StatusIcon.set_name</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_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>the name.</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.22 and above.</p></div><p>The <code class="methodname">set_name</code>() method sets the name of this tray icon.
This should be a string identifying this icon. It is may be used for sorting the icons
in the tray and will not be shown to the user.</p></div><div class="refsect2" title="gtk.StatusIcon.set_title"><a name="method-gtkstatusicon--set-title"></a><h3>gtk.StatusIcon.set_title</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_title</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>title</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>title</code></strong> :</span></p></td><td>the title.</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.22 and above.</p></div><p>The <code class="methodname">set_title</code>() method sets the title of this tray icon.
This should be a short, human-readable, localized string describing the tray icon. It
may be used by tools like screen readers to render the tray icon.</p></div><div class="refsect2" title="gtk.StatusIcon.get_title"><a name="method-gtkstatusicon--get-title"></a><h3>gtk.StatusIcon.get_title</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_title</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 title of the status 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.22 and above.</p></div><p>The <code class="methodname">get_title</code>() method gets the title of this tray icon.</p></div><div class="refsect2" title="gtk.StatusIcon.set_has_tooltip"><a name="method-gtkstatusicon--set-has-tooltip"></a><h3>gtk.StatusIcon.set_has_tooltip</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_has_tooltip</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>has_tooltip</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>has_tooltip</code></strong> :</span></p></td><td><code class="literal">True</code> if the status icon has a tooltip, <code class="literal">False</code> otherwise.</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.16 and above.</p></div><p>The <code class="methodname">set_has_tooltip</code>() method sets the "has-tooltip" property.</p></div><div class="refsect2" title="gtk.StatusIcon.get_has_tooltip"><a name="method-gtkstatusicon--get-has-tooltip"></a><h3>gtk.StatusIcon.get_has_tooltip</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_has_tooltip</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 status icon has a tooltip, <code class="literal">False</code> otherwise..</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.16 and above.</p></div><p>The <code class="methodname">get_has_tooltip</code>() method returns the current value of the "has-tooltip" property.</p></div><div class="refsect2" title="gtk.StatusIcon.set_tooltip_text"><a name="method-gtkstatusicon--set-tooltip-text"></a><h3>gtk.StatusIcon.set_tooltip_text</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_tooltip_text</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>text</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>text</code></strong> :</span></p></td><td>the contents of the tooltip for the status icon, or <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.16 and above.</p></div><p>The <code class="methodname">set_tooltip_text</code>() method sets <em class="parameter"><code>text</code></em>
as the contents of the tooltip. This function will take care of setting
the "has-tooltip" property to <code class="literal">True</code> and of the default handler
for the "query-tooltip" signal.</p></div><div class="refsect2" title="gtk.StatusIcon.get_tooltip_text"><a name="method-gtkstatusicon--get-tooltip-text"></a><h3>gtk.StatusIcon.get_tooltip_text</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_tooltip_text</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 tooltip text, or <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.16 and above.</p></div><p>The <code class="methodname">get_tooltip_text</code>() method gets the
contents of the tooltip for the status icon.</p></div><div class="refsect2" title="gtk.StatusIcon.set_tooltip_markup"><a name="method-gtkstatusicon--set-tooltip-markup"></a><h3>gtk.StatusIcon.set_tooltip_markup</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_tooltip_markup</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>markup</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>markup</code></strong> :</span></p></td><td>the contents of the tooltip for widget, or <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.16 and above.</p></div><p>The <code class="methodname">set_tooltip_markup</code>() method sets markup as the
contents of the tooltip, which is marked up with the Pango text markup language.
This function will take care of setting the "has-tooltip" property to
<code class="literal">True</code> and of the default handler for the "query-tooltip" signal.</p></div><div class="refsect2" title="gtk.StatusIcon.get_tooltip_markup"><a name="method-gtkstatusicon--get-tooltip-markup"></a><h3>gtk.StatusIcon.get_tooltip_markup</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_tooltip_markup</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 tooltip text, or <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.16 and above.</p></div><p>The <code class="methodname">get_tooltip_markup</code>() method gets the
contents of the tooltip for the status icon.</p></div></div><div class="refsect1" title="Signals"><a name="id3914475"></a><h2>Signals</h2><div class="refsect2" title='The "activate" gtk.StatusIcon Signal'><a name="signal-gtkstatusicon--activate"></a><h3>The "activate" gtk.StatusIcon Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>status_icon</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></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>status_icon</code></em> :</span></p></td><td>the object which received the signal</td></tr><tr><td><p><span class="term"><em class="parameter"><code>user_param1</code></em> :</span></p></td><td>the first user parameter (if any) specified
with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
method</td></tr><tr><td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td><td>additional user parameters (if any)</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 signal is available in GTK+ 2.10 and above.</p></div><p>Gets emitted when the user activates the status icon. If and
how status icons can be activated is platform-dependent.</p></div><div class="refsect2" title='The "popup-menu" gtk.StatusIcon Signal'><a name="signal-gtkstatusicon--popup-menu"></a><h3>The "popup-menu" gtk.StatusIcon Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>status_icon</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>button</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>activate_time</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></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>status_icon</code></em> :</span></p></td><td>the object which received the signal</td></tr><tr><td><p><span class="term"><em class="parameter"><code>button</code></em> :</span></p></td><td>the button that was pressed, or 0 if the
signal is not emitted in response to a button press event</td></tr><tr><td><p><span class="term"><em class="parameter"><code>activate_time</code></em> :</span></p></td><td>the timestamp of the event that
triggered the signal emission</td></tr><tr><td><p><span class="term"><em class="parameter"><code>user_param1</code></em> :</span></p></td><td>the first user parameter (if any) specified
with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
method</td></tr><tr><td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td><td>additional user parameters (if any)</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 signal is available in GTK+ 2.10 and above.</p></div><p>Gets emitted when the user brings up the context menu of the
status icon. Whether status icons can have context menus and how these
are activated is platform-dependent.</p><p>The <em class="parameter"><code>button</code></em> and
<em class="parameter"><code>activate_time</code></em> parameters should be passed as
the last two arguments to the <a class="link" href="class-gtkmenu.html#method-gtkmenu--popup" title="gtk.Menu.popup"><code class="methodname">gtk.Menu.popup()</code></a>
method.</p></div><div class="refsect2" title='The "size-changed" gtk.StatusIcon Signal'><a name="signal-gtkstatusicon--size-changed"></a><h3>The "size-changed" gtk.StatusIcon Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>status_icon</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>size</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>statusicon</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>arg1</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></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>status_icon</code></em> :</span></p></td><td>the object which received the signal</td></tr><tr><td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td><td>the new size</td></tr><tr><td><p><span class="term"><em class="parameter"><code>user_param1</code></em> :</span></p></td><td>the first user parameter (if any) specified
with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
method</td></tr><tr><td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td><td>additional user parameters (if any)</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 was updated
for the new size. Otherwise, GTK+ will scale the icon as
necessary.</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 signal is available in GTK+ 2.10 and above.</p></div><p>Gets emitted when the size available for the image changes,
e.g. because the notification area got resized.</p></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="class-gtkstatusbar.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="gtk-class-reference.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="class-gtkstyle.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">gtk.Statusbar </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> gtk.Style</td></tr></table></div></body></html>
|