← Back to branch summary

~inkscape.dev/inkscape-devlibs/devlibs-gtk3 

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

<!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</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.77.1">
<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.18 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="GtkStatusIcon.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="DisplayWidgets.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GTK+ 2 Reference Manual</th>
<td><a accesskey="n" href="ButtonWidgets.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GtkSpinner.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#GtkSpinner.description" class="shortcut">Description</a>
                   | 
                  <a href="#GtkSpinner.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#GtkSpinner.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
                   | 
                  <a href="#GtkSpinner.properties" class="shortcut">Properties</a>
                   | 
                  <a href="#GtkSpinner.style-properties" class="shortcut">Style Properties</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 valign="top" align="right"><img src="spinner.png"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GtkSpinner.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;gtk/gtk.h&gt;

struct              <a class="link" href="GtkSpinner.html#GtkSpinner-struct" title="struct GtkSpinner">GtkSpinner</a>;
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *         <a class="link" href="GtkSpinner.html#gtk-spinner-new" title="gtk_spinner_new ()">gtk_spinner_new</a>                     (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span>                <a class="link" href="GtkSpinner.html#gtk-spinner-start" title="gtk_spinner_start ()">gtk_spinner_start</a>                   (<em class="parameter"><code><a class="link" href="GtkSpinner.html" title="GtkSpinner"><span class="type">GtkSpinner</span></a> *spinner</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="GtkSpinner.html#gtk-spinner-stop" title="gtk_spinner_stop ()">gtk_spinner_stop</a>                    (<em class="parameter"><code><a class="link" href="GtkSpinner.html" title="GtkSpinner"><span class="type">GtkSpinner</span></a> *spinner</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="GtkSpinner.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  GObject
   +----GInitiallyUnowned
         +----<a class="link" href="GtkObject.html" title="GtkObject">GtkObject</a>
               +----<a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a>
                     +----<a class="link" href="GtkDrawingArea.html" title="GtkDrawingArea">GtkDrawingArea</a>
                           +----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.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a class="link" href="GtkSpinner.html#GtkSpinner--active" title='The "active" property'>active</a>"                   <span class="type">gboolean</span>              : Read / Write
</pre>
</div>
<div class="refsect1">
<a name="GtkSpinner.style-properties"></a><h2>Style Properties</h2>
<pre class="synopsis">
  "<a class="link" href="GtkSpinner.html#GtkSpinner--s-cycle-duration" title='The "cycle-duration" style property'>cycle-duration</a>"           <span class="type">guint</span>                 : Read
  "<a class="link" href="GtkSpinner.html#GtkSpinner--s-num-steps" title='The "num-steps" style property'>num-steps</a>"                <span class="type">guint</span>                 : Read
</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.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GtkSpinner-struct"></a><h3>struct GtkSpinner</h3>
<pre class="programlisting">struct GtkSpinner;</pre>
<p>
</p>
</div>
<hr>
<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="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" href="GtkSpinner.html" title="GtkSpinner"><span class="type">GtkSpinner</span></a>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.20</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="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>spinner</code></em> :</span></p></td>
<td>a <a class="link" href="GtkSpinner.html" title="GtkSpinner"><span class="type">GtkSpinner</span></a>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.20</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="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>spinner</code></em> :</span></p></td>
<td>a <a class="link" href="GtkSpinner.html" title="GtkSpinner"><span class="type">GtkSpinner</span></a>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.20</p>
</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>              : Read / Write</pre>
<p>Whether the spinner is active.</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>                 : Read</pre>
<p>
The duration in milliseconds for the spinner to complete a full cycle.
</p>
<p>Allowed values: &gt;= 500</p>
<p>Default value: 1000</p>
<p class="since">Since 2.20</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>                 : Read</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>Allowed values: &gt;= 1</p>
<p>Default value: 12</p>
<p class="since">Since 2.20</p>
</div>
</div>
<div class="refsect1">
<a name="GtkSpinner.see-also"></a><h2>See Also</h2>
<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>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>