libmx-doc 1.4.7-0ubuntu3 / usr / share / doc / libmx-doc / html / mx / MxSpinner.html

This file is indexed.

/usr/share/doc/libmx-doc/html/mx/MxSpinner.html is in libmx-doc 1.4.7-0ubuntu3.

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
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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>MxSpinner</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Mx Toolkit Reference Manual">
<link rel="up" href="ch01.html" title="Widgets">
<link rel="prev" href="MxTooltip.html" title="MxTooltip">
<link rel="next" href="MxImage.html" title="MxImage">
<meta name="generator" content="GTK-Doc V1.19 (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="MxTooltip.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.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">Mx Toolkit Reference Manual</th>
<td><a accesskey="n" href="MxImage.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#MxSpinner.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#MxSpinner.description" class="shortcut">Description</a>
                   | 
                  <a href="#MxSpinner.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#MxSpinner.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
                   | 
                  <a href="#MxSpinner.properties" class="shortcut">Properties</a>
                   | 
                  <a href="#MxSpinner.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="MxSpinner"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="MxSpinner.top_of_page"></a>MxSpinner</span></h2>
<p>MxSpinner — a processing indicator widget</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="MxSpinner.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct              <a class="link" href="MxSpinner.html#MxSpinner-struct" title="struct MxSpinner">MxSpinner</a>;
struct              <a class="link" href="MxSpinner.html#MxSpinnerClass" title="struct MxSpinnerClass">MxSpinnerClass</a>;
<span class="returnvalue">ClutterActor</span> *      <a class="link" href="MxSpinner.html#mx-spinner-new" title="mx_spinner_new ()">mx_spinner_new</a>                      (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span>                <a class="link" href="MxSpinner.html#mx-spinner-set-animating" title="mx_spinner_set_animating ()">mx_spinner_set_animating</a>            (<em class="parameter"><code><a class="link" href="MxSpinner.html" title="MxSpinner"><span class="type">MxSpinner</span></a> *spinner</code></em>,
                                                         <em class="parameter"><code><span class="type">gboolean</span> animating</code></em>);
<span class="returnvalue">gboolean</span>            <a class="link" href="MxSpinner.html#mx-spinner-get-animating" title="mx_spinner_get_animating ()">mx_spinner_get_animating</a>            (<em class="parameter"><code><a class="link" href="MxSpinner.html" title="MxSpinner"><span class="type">MxSpinner</span></a> *spinner</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="MxSpinner.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  GObject
   +----GInitiallyUnowned
         +----ClutterActor
               +----<a class="link" href="MxWidget.html" title="MxWidget">MxWidget</a>
                     +----MxSpinner
</pre>
</div>
<div class="refsect1">
<a name="MxSpinner.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
MxSpinner implements
 ClutterContainer,  ClutterScriptable,  ClutterAnimatable,  AtkImplementorIface and  <a class="link" href="MxStylable.html" title="MxStylable">MxStylable</a>.</p>
</div>
<div class="refsect1">
<a name="MxSpinner.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a class="link" href="MxSpinner.html#MxSpinner--animating" title='The "animating" property'>animating</a>"                <span class="type">gboolean</span>              : Read / Write
</pre>
</div>
<div class="refsect1">
<a name="MxSpinner.signals"></a><h2>Signals</h2>
<pre class="synopsis">
  "<a class="link" href="MxSpinner.html#MxSpinner-looped" title='The "looped" signal'>looped</a>"                                         : <code class="literal">Run Last</code>
</pre>
</div>
<div class="refsect1">
<a name="MxSpinner.description"></a><h2>Description</h2>
<p>
The <a class="link" href="MxSpinner.html" title="MxSpinner"><span class="type">MxSpinner</span></a> is a widget to use to indicate that something is being
processed, usually a task of indeterminate length.
</p>
</div>
<div class="refsect1">
<a name="MxSpinner.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="MxSpinner-struct"></a><h3>struct MxSpinner</h3>
<pre class="programlisting">struct MxSpinner;</pre>
<p>
The contents of this structure are private and should only be accessed
through the public API.
</p>
</div>
<hr>
<div class="refsect2">
<a name="MxSpinnerClass"></a><h3>struct MxSpinnerClass</h3>
<pre class="programlisting">struct MxSpinnerClass {
  MxWidgetClass parent_class;

  /* signals */
  void (* looped) (MxSpinner *spinner);

  /* padding for future expansion */
  void (*_padding_0) (void);
  void (*_padding_1) (void);
  void (*_padding_2) (void);
  void (*_padding_3) (void);
};
</pre>
</div>
<hr>
<div class="refsect2">
<a name="mx-spinner-new"></a><h3>mx_spinner_new ()</h3>
<pre class="programlisting"><span class="returnvalue">ClutterActor</span> *      mx_spinner_new                      (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Create a new <a class="link" href="MxSpinner.html" title="MxSpinner"><span class="type">MxSpinner</span></a> widget.
</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 newly allocated <a class="link" href="MxSpinner.html" title="MxSpinner"><span class="type">MxSpinner</span></a>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 1.2</p>
</div>
<hr>
<div class="refsect2">
<a name="mx-spinner-set-animating"></a><h3>mx_spinner_set_animating ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                mx_spinner_set_animating            (<em class="parameter"><code><a class="link" href="MxSpinner.html" title="MxSpinner"><span class="type">MxSpinner</span></a> *spinner</code></em>,
                                                         <em class="parameter"><code><span class="type">gboolean</span> animating</code></em>);</pre>
<p>
Sets whether the spinner is animating. A spinner can be stopped if
the task it represents has finished, or to save energy.
</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="MxSpinner.html" title="MxSpinner"><span class="type">MxSpinner</span></a> widget</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>animating</code></em> :</span></p></td>
<td>
<code class="literal">TRUE</code> to enable animation, <code class="literal">FALSE</code> to disable</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 1.2</p>
</div>
<hr>
<div class="refsect2">
<a name="mx-spinner-get-animating"></a><h3>mx_spinner_get_animating ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>            mx_spinner_get_animating            (<em class="parameter"><code><a class="link" href="MxSpinner.html" title="MxSpinner"><span class="type">MxSpinner</span></a> *spinner</code></em>);</pre>
<p>
Determines whether the spinner is animating.
</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="MxSpinner.html" title="MxSpinner"><span class="type">MxSpinner</span></a> widget</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 spinner is animating, <code class="literal">FALSE</code> otherwise</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 1.2</p>
</div>
</div>
<div class="refsect1">
<a name="MxSpinner.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="MxSpinner--animating"></a><h3>The <code class="literal">"animating"</code> property</h3>
<pre class="programlisting">  "animating"                <span class="type">gboolean</span>              : Read / Write</pre>
<p>Whether the spinner is animating.</p>
<p>Default value: TRUE</p>
</div>
</div>
<div class="refsect1">
<a name="MxSpinner.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="MxSpinner-looped"></a><h3>The <code class="literal">"looped"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="MxSpinner.html" title="MxSpinner"><span class="type">MxSpinner</span></a> *spinner,
                                                        <span class="type">gpointer</span>   user_data)      : <code class="literal">Run Last</code></pre>
<p>
Emitted after the animation has displayed the final frame.
</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>the <a class="link" href="MxSpinner.html" title="MxSpinner"><span class="type">MxSpinner</span></a> that received the signal</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 1.2</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.19</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.