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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GtkSpinner: GTK+ 2 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GTK+ 2 Reference Manual">
<link rel="up" href="DisplayWidgets.html" title="Display Widgets">
<link rel="prev" href="GtkStatusIcon.html" title="GtkStatusIcon">
<link rel="next" href="ButtonWidgets.html" title="Buttons and Toggles">
<meta name="generator" content="GTK-Doc V1.33.0 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#GtkSpinner.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#GtkSpinner.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#GtkSpinner.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#GtkSpinner.properties" class="shortcut">Properties</a></span><span id="nav_style_properties"> <span class="dim">|</span>
<a href="#GtkSpinner.style-properties" class="shortcut">Style Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="DisplayWidgets.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GtkStatusIcon.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ButtonWidgets.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GtkSpinner"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GtkSpinner.top_of_page"></a>GtkSpinner</span></h2>
<p>GtkSpinner — Show a spinner animation</p>
</td>
<td class="gallery_image" valign="top" align="right"><img src="spinner.png"></td>
</tr></table></div>
<div class="refsect1">
<a name="GtkSpinner.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
</td>
<td class="function_name">
<a class="link" href="GtkSpinner.html#gtk-spinner-new" title="gtk_spinner_new ()">gtk_spinner_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkSpinner.html#gtk-spinner-start" title="gtk_spinner_start ()">gtk_spinner_start</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkSpinner.html#gtk-spinner-stop" title="gtk_spinner_stop ()">gtk_spinner_stop</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkSpinner.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody><tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="GtkSpinner.html#GtkSpinner--active" title="The “active” property">active</a></td>
<td class="property_flags">Read / Write</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkSpinner.style-properties"></a><h2>Style Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="style_properties_type">
<col width="300px" class="style_properties_name">
<col width="200px" class="style_properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type"><span class="type">guint</span></td>
<td class="property_name"><a class="link" href="GtkSpinner.html#GtkSpinner--s-cycle-duration" title="The “cycle-duration” style property">cycle-duration</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type"><span class="type">guint</span></td>
<td class="property_name"><a class="link" href="GtkSpinner.html#GtkSpinner--s-num-steps" title="The “num-steps” style property">num-steps</a></td>
<td class="property_flags">Read</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkSpinner.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GtkSpinner.html#GtkSpinner-struct" title="struct GtkSpinner">GtkSpinner</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkSpinner.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> GInitiallyUnowned
<span class="lineart">╰──</span> <a class="link" href="GtkObject.html" title="GtkObject">GtkObject</a>
<span class="lineart">╰──</span> <a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a>
<span class="lineart">╰──</span> <a class="link" href="GtkDrawingArea.html" title="GtkDrawingArea">GtkDrawingArea</a>
<span class="lineart">╰──</span> GtkSpinner
</pre>
</div>
<div class="refsect1">
<a name="GtkSpinner.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GtkSpinner implements
AtkImplementorIface and <a class="link" href="GtkBuildable.html" title="GtkBuildable">GtkBuildable</a>.</p>
</div>
<div class="refsect1">
<a name="GtkSpinner.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <gtk/gtk.h>
</pre>
</div>
<div class="refsect1">
<a name="GtkSpinner.description"></a><h2>Description</h2>
<p>A GtkSpinner widget displays an icon-size spinning animation.
It is often used as an alternative to a <a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a> for
displaying indefinite activity, instead of actual progress.</p>
<p>To start the animation, use <a class="link" href="GtkSpinner.html#gtk-spinner-start" title="gtk_spinner_start ()"><code class="function">gtk_spinner_start()</code></a>, to stop it
use <a class="link" href="GtkSpinner.html#gtk-spinner-stop" title="gtk_spinner_stop ()"><code class="function">gtk_spinner_stop()</code></a>.</p>
</div>
<div class="refsect1">
<a name="GtkSpinner.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gtk-spinner-new"></a><h3>gtk_spinner_new ()</h3>
<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
gtk_spinner_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Returns a new spinner widget. Not yet started.</p>
<div class="refsect3">
<a name="gtk-spinner-new.returns"></a><h4>Returns</h4>
<p> a new <a class="link" href="GtkSpinner.html" title="GtkSpinner"><span class="type">GtkSpinner</span></a></p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-20.html#api-index-2.20">2.20</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-spinner-start"></a><h3>gtk_spinner_start ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_spinner_start (<em class="parameter"><code><a class="link" href="GtkSpinner.html" title="GtkSpinner"><span class="type">GtkSpinner</span></a> *spinner</code></em>);</pre>
<p>Starts the animation of the spinner.</p>
<div class="refsect3">
<a name="gtk-spinner-start.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>spinner</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkSpinner.html" title="GtkSpinner"><span class="type">GtkSpinner</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-20.html#api-index-2.20">2.20</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-spinner-stop"></a><h3>gtk_spinner_stop ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_spinner_stop (<em class="parameter"><code><a class="link" href="GtkSpinner.html" title="GtkSpinner"><span class="type">GtkSpinner</span></a> *spinner</code></em>);</pre>
<p>Stops the animation of the spinner.</p>
<div class="refsect3">
<a name="gtk-spinner-stop.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>spinner</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkSpinner.html" title="GtkSpinner"><span class="type">GtkSpinner</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-20.html#api-index-2.20">2.20</a></p>
</div>
</div>
<div class="refsect1">
<a name="GtkSpinner.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GtkSpinner-struct"></a><h3>struct GtkSpinner</h3>
<pre class="programlisting">struct GtkSpinner;</pre>
</div>
</div>
<div class="refsect1">
<a name="GtkSpinner.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GtkSpinner--active"></a><h3>The <code class="literal">“active”</code> property</h3>
<pre class="programlisting"> “active” <span class="type">gboolean</span></pre>
<p>Whether the spinner is active.</p>
<p>Owner: GtkSpinner</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
</div>
</div>
<div class="refsect1">
<a name="GtkSpinner.style-property-details"></a><h2>Style Property Details</h2>
<div class="refsect2">
<a name="GtkSpinner--s-cycle-duration"></a><h3>The <code class="literal">“cycle-duration”</code> style property</h3>
<pre class="programlisting"> “cycle-duration” <span class="type">guint</span></pre>
<p>The duration in milliseconds for the spinner to complete a full cycle.</p>
<p>Owner: GtkSpinner</p>
<p>Flags: Read</p>
<p>Allowed values: >= 500</p>
<p>Default value: 1000</p>
<p class="since">Since: <a class="link" href="api-index-2-20.html#api-index-2.20">2.20</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GtkSpinner--s-num-steps"></a><h3>The <code class="literal">“num-steps”</code> style property</h3>
<pre class="programlisting"> “num-steps” <span class="type">guint</span></pre>
<p>The number of steps for the spinner to complete a full loop.
The animation will complete a full cycle in one second by default
(see the <span class="type">“cycle-duration”</span> style property).</p>
<p>Owner: GtkSpinner</p>
<p>Flags: Read</p>
<p>Allowed values: >= 1</p>
<p>Default value: 12</p>
<p class="since">Since: <a class="link" href="api-index-2-20.html#api-index-2.20">2.20</a></p>
</div>
</div>
<div class="refsect1">
<a name="GtkSpinner.see-also"></a><h2>See Also</h2>
<p><a class="link" href="GtkCellRendererSpinner.html" title="GtkCellRendererSpinner"><span class="type">GtkCellRendererSpinner</span></a>, <a class="link" href="GtkProgressBar.html" title="GtkProgressBar"><span class="type">GtkProgressBar</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.0</div>
</body>
</html>
|
