← Back to branch summary

~ubuntu-branches/ubuntu/trusty/gnome-shell/trusty-proposed

« 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: 2012-03-14 13:47:20 UTC
  • mfrom: (1.1.36) (18.1.8 sid)
  • Revision ID: package-import@ubuntu.com-20120314134720-202sbjbu4a3z1fru
Tags: 3.3.90-0ubuntu1
https://launchpad.net/bugs/941755
https://launchpad.net/bugs/937709
* Sync with Debian experimental svn packaging (LP: #941755, #937709).
  Remaining changes:
  - debian/gnome-shell.gsettings-override: Update for Ubuntu defaults
  - debian/control.in: Recommend cups-pk-helper
  - debian/patches/10-make-NetworkManager-optional.patch: Disabled
  - Don't run dh-autoreconf

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/st/html/StIcon.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html>
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 
5
<title>StIcon</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
 
7
<link rel="home" href="index.html" title="St Reference Manual">
 
8
<link rel="up" href="widgets.html" title="Widgets">
 
9
<link rel="prev" href="StEntry.html" title="StEntry">
 
10
<link rel="next" href="StLabel.html" title="StLabel">
 
11
<meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
 
12
<link rel="stylesheet" href="style.css" type="text/css">
 
13
</head>
 
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
 
16
<tr valign="middle">
 
17
<td><a accesskey="p" href="StEntry.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
18
<td><a accesskey="u" href="widgets.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
20
<th width="100%" align="center">St Reference Manual</th>
 
21
<td><a accesskey="n" href="StLabel.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
22
</tr>
 
23
<tr><td colspan="5" class="shortcuts">
 
24
<a href="#StIcon.synopsis" class="shortcut">Top</a>
 
25
                   | 
 
26
                  <a href="#StIcon.description" class="shortcut">Description</a>
 
27
                   | 
 
28
                  <a href="#StIcon.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
29
                   | 
 
30
                  <a href="#StIcon.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
 
31
                   | 
 
32
                  <a href="#StIcon.properties" class="shortcut">Properties</a>
 
33
</td></tr>
 
34
</table>
 
35
<div class="refentry">
 
36
<a name="StIcon"></a><div class="titlepage"></div>
 
37
<div class="refnamediv"><table width="100%"><tr>
 
38
<td valign="top">
 
39
<h2><span class="refentrytitle"><a name="StIcon.top_of_page"></a>StIcon</span></h2>
 
40
<p>StIcon — a simple styled icon actor</p>
 
41
</td>
 
42
<td valign="top" align="right"></td>
 
43
</tr></table></div>
 
44
<div class="refsynopsisdiv">
 
45
<a name="StIcon.synopsis"></a><h2>Synopsis</h2>
 
46
<pre class="synopsis">                    <a class="link" href="StIcon.html#StIcon-struct" title="StIcon">StIcon</a>;
 
47
                    <a class="link" href="StIcon.html#StIconClass" title="StIconClass">StIconClass</a>;
 
48
<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>);
 
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>);
 
50
<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>);
 
51
<span class="returnvalue">StIconType</span>          <a class="link" href="StIcon.html#st-icon-get-icon-type" title="st_icon_get_icon_type ()">st_icon_get_icon_type</a>               (<em class="parameter"><code><a class="link" href="StIcon.html" title="StIcon"><span class="type">StIcon</span></a> *icon</code></em>);
 
52
<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>);
 
53
<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>,
 
54
                                                         <em class="parameter"><code><span class="type">GIcon</span> *gicon</code></em>);
 
55
<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>,
 
56
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *icon_name</code></em>);
 
57
<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>,
 
58
                                                         <em class="parameter"><code><span class="type">gint</span> size</code></em>);
 
59
<span class="returnvalue">void</span>                <a class="link" href="StIcon.html#st-icon-set-icon-type" title="st_icon_set_icon_type ()">st_icon_set_icon_type</a>               (<em class="parameter"><code><a class="link" href="StIcon.html" title="StIcon"><span class="type">StIcon</span></a> *icon</code></em>,
 
60
                                                         <em class="parameter"><code><span class="type">StIconType</span> icon_type</code></em>);
 
61
</pre>
 
62
</div>
 
63
<div class="refsect1">
 
64
<a name="StIcon.object-hierarchy"></a><h2>Object Hierarchy</h2>
 
65
<pre class="synopsis">
 
66
  GObject
 
67
   +----GInitiallyUnowned
 
68
         +----ClutterActor
 
69
               +----<a class="link" href="StWidget.html" title="StWidget">StWidget</a>
 
70
                     +----StIcon
 
71
</pre>
 
72
</div>
 
73
<div class="refsect1">
 
74
<a name="StIcon.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
 
75
<p>
 
76
StIcon implements
 
77
 ClutterContainer,  ClutterScriptable,  ClutterAnimatable and  AtkImplementorIface.</p>
 
78
</div>
 
79
<div class="refsect1">
 
80
<a name="StIcon.properties"></a><h2>Properties</h2>
 
81
<pre class="synopsis">
 
82
  "<a class="link" href="StIcon.html#StIcon--gicon" title='The "gicon" property'>gicon</a>"                    <span class="type">GIcon</span>*                : Read / Write
 
83
  "<a class="link" href="StIcon.html#StIcon--icon-name" title='The "icon-name" property'>icon-name</a>"                <span class="type">gchar</span>*                : Read / Write
 
84
  "<a class="link" href="StIcon.html#StIcon--icon-size" title='The "icon-size" property'>icon-size</a>"                <span class="type">gint</span>                  : Read / Write
 
85
  "<a class="link" href="StIcon.html#StIcon--icon-type" title='The "icon-type" property'>icon-type</a>"                <span class="type">StIconType</span>            : Read / Write
 
86
</pre>
 
87
</div>
 
88
<div class="refsect1">
 
89
<a name="StIcon.description"></a><h2>Description</h2>
 
90
<p>
 
91
<a class="link" href="StIcon.html" title="StIcon"><span class="type">StIcon</span></a> is a simple styled texture actor that displays an image from
 
92
a stylesheet.
 
93
</p>
 
94
</div>
 
95
<div class="refsect1">
 
96
<a name="StIcon.details"></a><h2>Details</h2>
 
97
<div class="refsect2">
 
98
<a name="StIcon-struct"></a><h3>StIcon</h3>
 
99
<pre class="programlisting">typedef struct _StIcon StIcon;</pre>
 
100
<p>
 
101
The contents of this structure are private and should only be accessed
 
102
through the public API.
 
103
</p>
 
104
</div>
 
105
<hr>
 
106
<div class="refsect2">
 
107
<a name="StIconClass"></a><h3>StIconClass</h3>
 
108
<pre class="programlisting">typedef struct {
 
109
  StWidgetClass parent_class;
 
110
 
 
111
  /* padding for future expansion */
 
112
  void (*_padding_0) (void);
 
113
  void (*_padding_1) (void);
 
114
  void (*_padding_2) (void);
 
115
  void (*_padding_3) (void);
 
116
  void (*_padding_4) (void);
 
117
} StIconClass;
 
118
</pre>
 
119
</div>
 
120
<hr>
 
121
<div class="refsect2">
 
122
<a name="st-icon-get-gicon"></a><h3>st_icon_get_gicon ()</h3>
 
123
<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>
 
124
<div class="variablelist"><table border="0">
 
125
<col align="left" valign="top">
 
126
<tbody>
 
127
<tr>
 
128
<td><p><span class="term"><em class="parameter"><code>icon</code></em> :</span></p></td>
 
129
<td>an icon</td>
 
130
</tr>
 
131
<tr>
 
132
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
133
<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>
 
134
</td>
 
135
</tr>
 
136
</tbody>
 
137
</table></div>
 
138
</div>
 
139
<hr>
 
140
<div class="refsect2">
 
141
<a name="st-icon-get-icon-name"></a><h3>st_icon_get_icon_name ()</h3>
 
142
<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>
 
143
</div>
 
144
<hr>
 
145
<div class="refsect2">
 
146
<a name="st-icon-get-icon-size"></a><h3>st_icon_get_icon_size ()</h3>
 
147
<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>
 
148
<p>
 
149
Gets the size explicit size on the icon. This is not necesariily
 
150
 the size that the icon will actually be displayed at.
 
151
</p>
 
152
<div class="variablelist"><table border="0">
 
153
<col align="left" valign="top">
 
154
<tbody>
 
155
<tr>
 
156
<td><p><span class="term"><em class="parameter"><code>icon</code></em> :</span></p></td>
 
157
<td>an icon</td>
 
158
</tr>
 
159
<tr>
 
160
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
161
<td>the size explicitly set, or -1 if no size has been set</td>
 
162
</tr>
 
163
</tbody>
 
164
</table></div>
 
165
</div>
 
166
<hr>
 
167
<div class="refsect2">
 
168
<a name="st-icon-get-icon-type"></a><h3>st_icon_get_icon_type ()</h3>
 
169
<pre class="programlisting"><span class="returnvalue">StIconType</span>          st_icon_get_icon_type               (<em class="parameter"><code><a class="link" href="StIcon.html" title="StIcon"><span class="type">StIcon</span></a> *icon</code></em>);</pre>
 
170
<p>
 
171
Gets the type of icon we'll look up to display in the actor.
 
172
See <a class="link" href="StIcon.html#st-icon-set-icon-type" title="st_icon_set_icon_type ()"><code class="function">st_icon_set_icon_type()</code></a>.
 
173
</p>
 
174
<div class="variablelist"><table border="0">
 
175
<col align="left" valign="top">
 
176
<tbody>
 
177
<tr>
 
178
<td><p><span class="term"><em class="parameter"><code>icon</code></em> :</span></p></td>
 
179
<td>a <a class="link" href="StIcon.html" title="StIcon"><span class="type">StIcon</span></a>
 
180
</td>
 
181
</tr>
 
182
<tr>
 
183
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
184
<td>the icon type.</td>
 
185
</tr>
 
186
</tbody>
 
187
</table></div>
 
188
</div>
 
189
<hr>
 
190
<div class="refsect2">
 
191
<a name="st-icon-new"></a><h3>st_icon_new ()</h3>
 
192
<pre class="programlisting"><span class="returnvalue">ClutterActor</span> *      st_icon_new                         (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 
193
<p>
 
194
Create a newly allocated <a class="link" href="StIcon.html" title="StIcon"><span class="type">StIcon</span></a>
 
195
</p>
 
196
<div class="variablelist"><table border="0">
 
197
<col align="left" valign="top">
 
198
<tbody><tr>
 
199
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
200
<td>A newly allocated <a class="link" href="StIcon.html" title="StIcon"><span class="type">StIcon</span></a>
 
201
</td>
 
202
</tr></tbody>
 
203
</table></div>
 
204
</div>
 
205
<hr>
 
206
<div class="refsect2">
 
207
<a name="st-icon-set-gicon"></a><h3>st_icon_set_gicon ()</h3>
 
208
<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>,
 
209
                                                         <em class="parameter"><code><span class="type">GIcon</span> *gicon</code></em>);</pre>
 
210
<div class="variablelist"><table border="0">
 
211
<col align="left" valign="top">
 
212
<tbody>
 
213
<tr>
 
214
<td><p><span class="term"><em class="parameter"><code>icon</code></em> :</span></p></td>
 
215
<td>an icon</td>
 
216
</tr>
 
217
<tr>
 
218
<td><p><span class="term"><em class="parameter"><code>gicon</code></em> :</span></p></td>
 
219
<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>
 
220
</td>
 
221
</tr>
 
222
</tbody>
 
223
</table></div>
 
224
</div>
 
225
<hr>
 
226
<div class="refsect2">
 
227
<a name="st-icon-set-icon-name"></a><h3>st_icon_set_icon_name ()</h3>
 
228
<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>,
 
229
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *icon_name</code></em>);</pre>
 
230
</div>
 
231
<hr>
 
232
<div class="refsect2">
 
233
<a name="st-icon-set-icon-size"></a><h3>st_icon_set_icon_size ()</h3>
 
234
<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>,
 
235
                                                         <em class="parameter"><code><span class="type">gint</span> size</code></em>);</pre>
 
236
<p>
 
237
Sets an explicit size for the icon.
 
238
</p>
 
239
<div class="variablelist"><table border="0">
 
240
<col align="left" valign="top">
 
241
<tbody>
 
242
<tr>
 
243
<td><p><span class="term"><em class="parameter"><code>icon</code></em> :</span></p></td>
 
244
<td>an icon</td>
 
245
</tr>
 
246
<tr>
 
247
<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
 
248
<td>if positive, the new size, otherwise the size will be
 
249
derived from the current style</td>
 
250
</tr>
 
251
</tbody>
 
252
</table></div>
 
253
</div>
 
254
<hr>
 
255
<div class="refsect2">
 
256
<a name="st-icon-set-icon-type"></a><h3>st_icon_set_icon_type ()</h3>
 
257
<pre class="programlisting"><span class="returnvalue">void</span>                st_icon_set_icon_type               (<em class="parameter"><code><a class="link" href="StIcon.html" title="StIcon"><span class="type">StIcon</span></a> *icon</code></em>,
 
258
                                                         <em class="parameter"><code><span class="type">StIconType</span> icon_type</code></em>);</pre>
 
259
<p>
 
260
Sets the type of icon we'll look up to display in the actor.
 
261
The icon type determines whether we use a symbolic icon or
 
262
a full color icon and also is used for specific handling for
 
263
application and document icons.
 
264
</p>
 
265
<div class="variablelist"><table border="0">
 
266
<col align="left" valign="top">
 
267
<tbody>
 
268
<tr>
 
269
<td><p><span class="term"><em class="parameter"><code>icon</code></em> :</span></p></td>
 
270
<td>a <a class="link" href="StIcon.html" title="StIcon"><span class="type">StIcon</span></a>
 
271
</td>
 
272
</tr>
 
273
<tr>
 
274
<td><p><span class="term"><em class="parameter"><code>icon_type</code></em> :</span></p></td>
 
275
<td>the type of icon to use</td>
 
276
</tr>
 
277
</tbody>
 
278
</table></div>
 
279
</div>
 
280
</div>
 
281
<div class="refsect1">
 
282
<a name="StIcon.property-details"></a><h2>Property Details</h2>
 
283
<div class="refsect2">
 
284
<a name="StIcon--gicon"></a><h3>The <code class="literal">"gicon"</code> property</h3>
 
285
<pre class="programlisting">  "gicon"                    <span class="type">GIcon</span>*                : Read / Write</pre>
 
286
<p>A GIcon to override :icon-name.</p>
 
287
</div>
 
288
<hr>
 
289
<div class="refsect2">
 
290
<a name="StIcon--icon-name"></a><h3>The <code class="literal">"icon-name"</code> property</h3>
 
291
<pre class="programlisting">  "icon-name"                <span class="type">gchar</span>*                : Read / Write</pre>
 
292
<p>An icon name.</p>
 
293
<p>Default value: NULL</p>
 
294
</div>
 
295
<hr>
 
296
<div class="refsect2">
 
297
<a name="StIcon--icon-size"></a><h3>The <code class="literal">"icon-size"</code> property</h3>
 
298
<pre class="programlisting">  "icon-size"                <span class="type">gint</span>                  : Read / Write</pre>
 
299
<p>The size if the icon, if positive. Otherwise the size will be derived from the current style.</p>
 
300
<p>Allowed values: &gt;= G_MAXULONG</p>
 
301
<p>Default value: -1</p>
 
302
</div>
 
303
<hr>
 
304
<div class="refsect2">
 
305
<a name="StIcon--icon-type"></a><h3>The <code class="literal">"icon-type"</code> property</h3>
 
306
<pre class="programlisting">  "icon-type"                <span class="type">StIconType</span>            : Read / Write</pre>
 
307
<p>The type of icon that should be used.</p>
 
308
<p>Default value: ST_ICON_SYMBOLIC</p>
 
309
</div>
 
310
</div>
 
311
</div>
 
312
<div class="footer">
 
313
<hr>
 
314
          Generated by GTK-Doc V1.18.1</div>
 
315
</body>
 
316
</html>
 
 
b'\\ No newline at end of file'