← Back to branch summary

~darkxst/ubuntu/saucy/gnome-shell/upstart_log

« back to all changes in this revision

Viewing changes to docs/reference/st/html/StIcon.html

  • Committer: Package Import Robot
  • Author(s): Jeremy Bicha
  • Date: 2013-05-31 12:01:12 UTC
  • mfrom: (1.1.49) (19.1.36 experimental)
  • Revision ID: package-import@ubuntu.com-20130531120112-ew91khxf051x9i2r
Tags: 3.8.2-1ubuntu1
https://launchpad.net/bugs/1185869
https://launchpad.net/bugs/1185721
https://launchpad.net/bugs/1064584
* Merge with Debian (LP: #1185869, #1185721). Remaining changes:
  - debian/control.in:
    + Build-depend on libsystemd-login-dev & libsystemd-daemon-dev
    + Depend on gdm instead of gdm3
    + Don't recommend gnome-session-fallback
  - debian/patches/40_change-pam-name-to-match-gdm.patch:
  - debian/patches/revert-suspend-break.patch:
    + Disabled, not needed on Ubuntu
  - debian/patches/ubuntu-lightdm-user-switching.patch:
    + Allow user switching when using LightDM. Thanks Gerhard Stein
      for rebasing against gnome-shell 3.8!
  - debian/patches/ubuntu_lock_on_suspend.patch
    + Respect Ubuntu's lock-on-suspend setting.
      Disabled until it can be rewritten.
  - debian/patches/git_relock_screen_after_crash.patch:
    + Add Upstream fix for unlocked session after crash (LP: #1064584)
* Note that the new GNOME Classic mode (which requires installing
  gnome-shell-extensions) won't work until gnome-session 3.8 is
  available in Ubuntu

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/st/html/StIcon.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>StIcon</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.77.1">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7
7
<link rel="home" href="index.html" title="St Reference Manual">
8
8
<link rel="up" href="widgets.html" title="Widgets">
9
9
<link rel="prev" href="StEntry.html" title="StEntry">
10
10
<link rel="next" href="StLabel.html" title="StLabel">
11
 
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
45
45
<a name="StIcon.synopsis"></a><h2>Synopsis</h2>
46
46
<pre class="synopsis">                    <a class="link" href="StIcon.html#StIcon-struct" title="StIcon">StIcon</a>;
47
47
                    <a class="link" href="StIcon.html#StIconClass" title="StIconClass">StIconClass</a>;
48
 
<a href="http://library.gnome.org/devel/gio/unstable/GIcon.html"><span class="returnvalue">GIcon</span></a> *             <a class="link" href="StIcon.html#st-icon-get-gicon" title="st_icon_get_gicon ()">st_icon_get_gicon</a>                   (<em class="parameter"><code><a class="link" href="StIcon.html" title="StIcon"><span class="type">StIcon</span></a> *icon</code></em>);
49
 
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="StIcon.html#st-icon-get-icon-name" title="st_icon_get_icon_name ()">st_icon_get_icon_name</a>               (<em class="parameter"><code><a class="link" href="StIcon.html" title="StIcon"><span class="type">StIcon</span></a> *icon</code></em>);
50
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                <a class="link" href="StIcon.html#st-icon-get-icon-size" title="st_icon_get_icon_size ()">st_icon_get_icon_size</a>               (<em class="parameter"><code><a class="link" href="StIcon.html" title="StIcon"><span class="type">StIcon</span></a> *icon</code></em>);
51
 
<a href="/usr/share/gtk-doc/html/clutter/ClutterActor.html"><span class="returnvalue">ClutterActor</span></a> *      <a class="link" href="StIcon.html#st-icon-new" title="st_icon_new ()">st_icon_new</a>                         (<em class="parameter"><code><span class="type">void</span></code></em>);
52
 
<span class="returnvalue">void</span>                <a class="link" href="StIcon.html#st-icon-set-gicon" title="st_icon_set_gicon ()">st_icon_set_gicon</a>                   (<em class="parameter"><code><a class="link" href="StIcon.html" title="StIcon"><span class="type">StIcon</span></a> *icon</code></em>,
53
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GIcon.html"><span class="type">GIcon</span></a> *gicon</code></em>);
 
48
<span class="returnvalue">ClutterActor</span> *      <a class="link" href="StIcon.html#st-icon-new" title="st_icon_new ()">st_icon_new</a>                         (<em class="parameter"><code><span class="type">void</span></code></em>);
 
49
const <span class="returnvalue">gchar</span> *       <a class="link" href="StIcon.html#st-icon-get-icon-name" title="st_icon_get_icon_name ()">st_icon_get_icon_name</a>               (<em class="parameter"><code><a class="link" href="StIcon.html" title="StIcon"><span class="type">StIcon</span></a> *icon</code></em>);
54
50
<span class="returnvalue">void</span>                <a class="link" href="StIcon.html#st-icon-set-icon-name" title="st_icon_set_icon_name ()">st_icon_set_icon_name</a>               (<em class="parameter"><code><a class="link" href="StIcon.html" title="StIcon"><span class="type">StIcon</span></a> *icon</code></em>,
55
 
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *icon_name</code></em>);
 
51
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *icon_name</code></em>);
 
52
<span class="returnvalue">gint</span>                <a class="link" href="StIcon.html#st-icon-get-icon-size" title="st_icon_get_icon_size ()">st_icon_get_icon_size</a>               (<em class="parameter"><code><a class="link" href="StIcon.html" title="StIcon"><span class="type">StIcon</span></a> *icon</code></em>);
56
53
<span class="returnvalue">void</span>                <a class="link" href="StIcon.html#st-icon-set-icon-size" title="st_icon_set_icon_size ()">st_icon_set_icon_size</a>               (<em class="parameter"><code><a class="link" href="StIcon.html" title="StIcon"><span class="type">StIcon</span></a> *icon</code></em>,
57
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> size</code></em>);
 
54
                                                         <em class="parameter"><code><span class="type">gint</span> size</code></em>);
 
55
<span class="returnvalue">void</span>                <a class="link" href="StIcon.html#st-icon-set-gicon" title="st_icon_set_gicon ()">st_icon_set_gicon</a>                   (<em class="parameter"><code><a class="link" href="StIcon.html" title="StIcon"><span class="type">StIcon</span></a> *icon</code></em>,
 
56
                                                         <em class="parameter"><code><span class="type">GIcon</span> *gicon</code></em>);
 
57
<span class="returnvalue">GIcon</span> *             <a class="link" href="StIcon.html#st-icon-get-gicon" title="st_icon_get_gicon ()">st_icon_get_gicon</a>                   (<em class="parameter"><code><a class="link" href="StIcon.html" title="StIcon"><span class="type">StIcon</span></a> *icon</code></em>);
58
58
</pre>
59
59
</div>
60
60
<div class="refsect1">
61
61
<a name="StIcon.object-hierarchy"></a><h2>Object Hierarchy</h2>
62
62
<pre class="synopsis">
63
 
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
64
 
   +----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
65
 
         +----<a href="/usr/share/gtk-doc/html/clutter/ClutterActor.html">ClutterActor</a>
 
63
  GObject
 
64
   +----GInitiallyUnowned
 
65
         +----ClutterActor
66
66
               +----<a class="link" href="StWidget.html" title="StWidget">StWidget</a>
67
67
                     +----StIcon
68
68
</pre>
71
71
<a name="StIcon.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
72
72
<p>
73
73
StIcon implements
74
 
 <a href="/usr/share/gtk-doc/html/clutter/ClutterContainer.html">ClutterContainer</a>,  <a href="/usr/share/gtk-doc/html/clutter/ClutterScriptable.html">ClutterScriptable</a>,  <a href="/usr/share/gtk-doc/html/clutter/ClutterAnimatable.html">ClutterAnimatable</a> and  AtkImplementorIface.</p>
 
74
 ClutterContainer,  ClutterScriptable,  ClutterAnimatable and  AtkImplementorIface.</p>
75
75
</div>
76
76
<div class="refsect1">
77
77
<a name="StIcon.properties"></a><h2>Properties</h2>
78
78
<pre class="synopsis">
79
 
  "<a class="link" href="StIcon.html#StIcon--gicon" title='The "gicon" property'>gicon</a>"                    <a href="http://library.gnome.org/devel/gio/unstable/GIcon.html"><span class="type">GIcon</span></a>*                : Read / Write
80
 
  "<a class="link" href="StIcon.html#StIcon--icon-name" title='The "icon-name" property'>icon-name</a>"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
81
 
  "<a class="link" href="StIcon.html#StIcon--icon-size" title='The "icon-size" property'>icon-size</a>"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
 
79
  "<a class="link" href="StIcon.html#StIcon--gicon" title='The "gicon" property'>gicon</a>"                    <span class="type">GIcon</span>*                : Read / Write
 
80
  "<a class="link" href="StIcon.html#StIcon--icon-name" title='The "icon-name" property'>icon-name</a>"                <span class="type">gchar</span>*                : Read / Write
 
81
  "<a class="link" href="StIcon.html#StIcon--icon-size" title='The "icon-size" property'>icon-size</a>"                <span class="type">gint</span>                  : Read / Write
82
82
</pre>
83
83
</div>
84
84
<div class="refsect1">
115
115
</div>
116
116
<hr>
117
117
<div class="refsect2">
118
 
<a name="st-icon-get-gicon"></a><h3>st_icon_get_gicon ()</h3>
119
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/gio/unstable/GIcon.html"><span class="returnvalue">GIcon</span></a> *             st_icon_get_gicon                   (<em class="parameter"><code><a class="link" href="StIcon.html" title="StIcon"><span class="type">StIcon</span></a> *icon</code></em>);</pre>
120
 
<div class="variablelist"><table border="0" class="variablelist">
121
 
<colgroup>
122
 
<col align="left" valign="top">
123
 
<col>
124
 
</colgroup>
125
 
<tbody>
126
 
<tr>
127
 
<td><p><span class="term"><em class="parameter"><code>icon</code></em> :</span></p></td>
128
 
<td>an icon</td>
129
 
</tr>
130
 
<tr>
131
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
132
 
<td>the override GIcon, if set, or NULL. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
133
 
</td>
134
 
</tr>
135
 
</tbody>
136
 
</table></div>
137
 
</div>
138
 
<hr>
139
 
<div class="refsect2">
140
 
<a name="st-icon-get-icon-name"></a><h3>st_icon_get_icon_name ()</h3>
141
 
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       st_icon_get_icon_name               (<em class="parameter"><code><a class="link" href="StIcon.html" title="StIcon"><span class="type">StIcon</span></a> *icon</code></em>);</pre>
142
 
</div>
143
 
<hr>
144
 
<div class="refsect2">
145
 
<a name="st-icon-get-icon-size"></a><h3>st_icon_get_icon_size ()</h3>
146
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                st_icon_get_icon_size               (<em class="parameter"><code><a class="link" href="StIcon.html" title="StIcon"><span class="type">StIcon</span></a> *icon</code></em>);</pre>
147
 
<p>
148
 
Gets the size explicit size on the icon. This is not necesariily
149
 
 the size that the icon will actually be displayed at.
150
 
</p>
151
 
<div class="variablelist"><table border="0" class="variablelist">
152
 
<colgroup>
153
 
<col align="left" valign="top">
154
 
<col>
155
 
</colgroup>
156
 
<tbody>
157
 
<tr>
158
 
<td><p><span class="term"><em class="parameter"><code>icon</code></em> :</span></p></td>
159
 
<td>an icon</td>
160
 
</tr>
161
 
<tr>
162
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
163
 
<td>the size explicitly set, or -1 if no size has been set</td>
164
 
</tr>
165
 
</tbody>
166
 
</table></div>
167
 
</div>
168
 
<hr>
169
 
<div class="refsect2">
170
118
<a name="st-icon-new"></a><h3>st_icon_new ()</h3>
171
 
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/clutter/ClutterActor.html"><span class="returnvalue">ClutterActor</span></a> *      st_icon_new                         (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 
119
<pre class="programlisting"><span class="returnvalue">ClutterActor</span> *      st_icon_new                         (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
172
120
<p>
173
121
Create a newly allocated <a class="link" href="StIcon.html" title="StIcon"><span class="type">StIcon</span></a>
174
122
</p>
186
134
</div>
187
135
<hr>
188
136
<div class="refsect2">
189
 
<a name="st-icon-set-gicon"></a><h3>st_icon_set_gicon ()</h3>
190
 
<pre class="programlisting"><span class="returnvalue">void</span>                st_icon_set_gicon                   (<em class="parameter"><code><a class="link" href="StIcon.html" title="StIcon"><span class="type">StIcon</span></a> *icon</code></em>,
191
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GIcon.html"><span class="type">GIcon</span></a> *gicon</code></em>);</pre>
192
 
<div class="variablelist"><table border="0" class="variablelist">
193
 
<colgroup>
194
 
<col align="left" valign="top">
195
 
<col>
196
 
</colgroup>
197
 
<tbody>
198
 
<tr>
199
 
<td><p><span class="term"><em class="parameter"><code>icon</code></em> :</span></p></td>
200
 
<td>an icon</td>
201
 
</tr>
202
 
<tr>
203
 
<td><p><span class="term"><em class="parameter"><code>gicon</code></em> :</span></p></td>
204
 
<td>a <a href="http://library.gnome.org/devel/gio/unstable/GIcon.html"><span class="type">GIcon</span></a> to override :icon-name. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
205
 
</td>
206
 
</tr>
207
 
</tbody>
208
 
</table></div>
 
137
<a name="st-icon-get-icon-name"></a><h3>st_icon_get_icon_name ()</h3>
 
138
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       st_icon_get_icon_name               (<em class="parameter"><code><a class="link" href="StIcon.html" title="StIcon"><span class="type">StIcon</span></a> *icon</code></em>);</pre>
209
139
</div>
210
140
<hr>
211
141
<div class="refsect2">
212
142
<a name="st-icon-set-icon-name"></a><h3>st_icon_set_icon_name ()</h3>
213
143
<pre class="programlisting"><span class="returnvalue">void</span>                st_icon_set_icon_name               (<em class="parameter"><code><a class="link" href="StIcon.html" title="StIcon"><span class="type">StIcon</span></a> *icon</code></em>,
214
 
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *icon_name</code></em>);</pre>
 
144
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *icon_name</code></em>);</pre>
 
145
</div>
 
146
<hr>
 
147
<div class="refsect2">
 
148
<a name="st-icon-get-icon-size"></a><h3>st_icon_get_icon_size ()</h3>
 
149
<pre class="programlisting"><span class="returnvalue">gint</span>                st_icon_get_icon_size               (<em class="parameter"><code><a class="link" href="StIcon.html" title="StIcon"><span class="type">StIcon</span></a> *icon</code></em>);</pre>
 
150
<p>
 
151
Gets the size explicit size on the icon. This is not necesariily
 
152
 the size that the icon will actually be displayed at.
 
153
</p>
 
154
<div class="variablelist"><table border="0" class="variablelist">
 
155
<colgroup>
 
156
<col align="left" valign="top">
 
157
<col>
 
158
</colgroup>
 
159
<tbody>
 
160
<tr>
 
161
<td><p><span class="term"><em class="parameter"><code>icon</code></em> :</span></p></td>
 
162
<td>an icon</td>
 
163
</tr>
 
164
<tr>
 
165
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
166
<td>the size explicitly set, or -1 if no size has been set</td>
 
167
</tr>
 
168
</tbody>
 
169
</table></div>
215
170
</div>
216
171
<hr>
217
172
<div class="refsect2">
218
173
<a name="st-icon-set-icon-size"></a><h3>st_icon_set_icon_size ()</h3>
219
174
<pre class="programlisting"><span class="returnvalue">void</span>                st_icon_set_icon_size               (<em class="parameter"><code><a class="link" href="StIcon.html" title="StIcon"><span class="type">StIcon</span></a> *icon</code></em>,
220
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> size</code></em>);</pre>
 
175
                                                         <em class="parameter"><code><span class="type">gint</span> size</code></em>);</pre>
221
176
<p>
222
177
Sets an explicit size for the icon.
223
178
</p>
239
194
</tbody>
240
195
</table></div>
241
196
</div>
 
197
<hr>
 
198
<div class="refsect2">
 
199
<a name="st-icon-set-gicon"></a><h3>st_icon_set_gicon ()</h3>
 
200
<pre class="programlisting"><span class="returnvalue">void</span>                st_icon_set_gicon                   (<em class="parameter"><code><a class="link" href="StIcon.html" title="StIcon"><span class="type">StIcon</span></a> *icon</code></em>,
 
201
                                                         <em class="parameter"><code><span class="type">GIcon</span> *gicon</code></em>);</pre>
 
202
<div class="variablelist"><table border="0" class="variablelist">
 
203
<colgroup>
 
204
<col align="left" valign="top">
 
205
<col>
 
206
</colgroup>
 
207
<tbody>
 
208
<tr>
 
209
<td><p><span class="term"><em class="parameter"><code>icon</code></em> :</span></p></td>
 
210
<td>an icon</td>
 
211
</tr>
 
212
<tr>
 
213
<td><p><span class="term"><em class="parameter"><code>gicon</code></em> :</span></p></td>
 
214
<td>a <span class="type">GIcon</span> to override :icon-name. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 
215
</td>
 
216
</tr>
 
217
</tbody>
 
218
</table></div>
 
219
</div>
 
220
<hr>
 
221
<div class="refsect2">
 
222
<a name="st-icon-get-gicon"></a><h3>st_icon_get_gicon ()</h3>
 
223
<pre class="programlisting"><span class="returnvalue">GIcon</span> *             st_icon_get_gicon                   (<em class="parameter"><code><a class="link" href="StIcon.html" title="StIcon"><span class="type">StIcon</span></a> *icon</code></em>);</pre>
 
224
<div class="variablelist"><table border="0" class="variablelist">
 
225
<colgroup>
 
226
<col align="left" valign="top">
 
227
<col>
 
228
</colgroup>
 
229
<tbody>
 
230
<tr>
 
231
<td><p><span class="term"><em class="parameter"><code>icon</code></em> :</span></p></td>
 
232
<td>an icon</td>
 
233
</tr>
 
234
<tr>
 
235
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
236
<td>the override GIcon, if set, or NULL. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 
237
</td>
 
238
</tr>
 
239
</tbody>
 
240
</table></div>
 
241
</div>
242
242
</div>
243
243
<div class="refsect1">
244
244
<a name="StIcon.property-details"></a><h2>Property Details</h2>
245
245
<div class="refsect2">
246
246
<a name="StIcon--gicon"></a><h3>The <code class="literal">"gicon"</code> property</h3>
247
 
<pre class="programlisting">  "gicon"                    <a href="http://library.gnome.org/devel/gio/unstable/GIcon.html"><span class="type">GIcon</span></a>*                : Read / Write</pre>
 
247
<pre class="programlisting">  "gicon"                    <span class="type">GIcon</span>*                : Read / Write</pre>
248
248
<p>The GIcon shown by this icon actor.</p>
249
249
</div>
250
250
<hr>
251
251
<div class="refsect2">
252
252
<a name="StIcon--icon-name"></a><h3>The <code class="literal">"icon-name"</code> property</h3>
253
 
<pre class="programlisting">  "icon-name"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
 
253
<pre class="programlisting">  "icon-name"                <span class="type">gchar</span>*                : Read / Write</pre>
254
254
<p>An icon name.</p>
255
255
<p>Default value: NULL</p>
256
256
</div>
257
257
<hr>
258
258
<div class="refsect2">
259
259
<a name="StIcon--icon-size"></a><h3>The <code class="literal">"icon-size"</code> property</h3>
260
 
<pre class="programlisting">  "icon-size"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 
260
<pre class="programlisting">  "icon-size"                <span class="type">gint</span>                  : Read / Write</pre>
261
261
<p>The size if the icon, if positive. Otherwise the size will be derived from the current style.</p>
262
262
<p>Allowed values: &gt;= G_MAXULONG</p>
263
263
<p>Default value: -1</p>
266
266
</div>
267
267
<div class="footer">
268
268
<hr>
269
 
          Generated by GTK-Doc V1.18</div>
 
269
          Generated by GTK-Doc V1.18.1</div>
270
270
</body>
271
271
</html>
 
 
b'\\ No newline at end of file'