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

This file is indexed.

/usr/share/doc/libmx-doc/html/mx/MxExpander.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
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
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>MxExpander</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="ch02.html" title="Containers">
<link rel="prev" href="MxDeformWaves.html" title="MxDeformWaves">
<link rel="next" href="MxGrid.html" title="MxGrid">
<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="MxDeformWaves.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch02.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="MxGrid.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#MxExpander.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#MxExpander.description" class="shortcut">Description</a>
                   | 
                  <a href="#MxExpander.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#MxExpander.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
                   | 
                  <a href="#MxExpander.properties" class="shortcut">Properties</a>
                   | 
                  <a href="#MxExpander.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="MxExpander"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="MxExpander.top_of_page"></a>MxExpander</span></h2>
<p>MxExpander — a container which the user can show or hide its child</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="MxExpander.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">                    <a class="link" href="MxExpander.html#MxExpander-struct" title="MxExpander">MxExpander</a>;
                    <a class="link" href="MxExpander.html#MxExpanderClass" title="MxExpanderClass">MxExpanderClass</a>;
<span class="returnvalue">ClutterActor</span> *      <a class="link" href="MxExpander.html#mx-expander-new" title="mx_expander_new ()">mx_expander_new</a>                     (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span>                <a class="link" href="MxExpander.html#mx-expander-set-label" title="mx_expander_set_label ()">mx_expander_set_label</a>               (<em class="parameter"><code><a class="link" href="MxExpander.html" title="MxExpander"><span class="type">MxExpander</span></a> *expander</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *label</code></em>);
<span class="returnvalue">gboolean</span>            <a class="link" href="MxExpander.html#mx-expander-get-expanded" title="mx_expander_get_expanded ()">mx_expander_get_expanded</a>            (<em class="parameter"><code><a class="link" href="MxExpander.html" title="MxExpander"><span class="type">MxExpander</span></a> *expander</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="MxExpander.html#mx-expander-set-expanded" title="mx_expander_set_expanded ()">mx_expander_set_expanded</a>            (<em class="parameter"><code><a class="link" href="MxExpander.html" title="MxExpander"><span class="type">MxExpander</span></a> *expander</code></em>,
                                                         <em class="parameter"><code><span class="type">gboolean</span> expanded</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="MxExpander.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  GObject
   +----GInitiallyUnowned
         +----ClutterActor
               +----<a class="link" href="MxWidget.html" title="MxWidget">MxWidget</a>
                     +----<a class="link" href="MxBin.html" title="MxBin">MxBin</a>
                           +----MxExpander
</pre>
</div>
<div class="refsect1">
<a name="MxExpander.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
MxExpander implements
 ClutterContainer,  ClutterScriptable,  ClutterAnimatable,  AtkImplementorIface,  <a class="link" href="MxStylable.html" title="MxStylable">MxStylable</a> and  <a class="link" href="MxFocusable.html" title="MxFocusable">MxFocusable</a>.</p>
</div>
<div class="refsect1">
<a name="MxExpander.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a class="link" href="MxExpander.html#MxExpander--expanded" title='The "expanded" property'>expanded</a>"                 <span class="type">gboolean</span>              : Read / Write
  "<a class="link" href="MxExpander.html#MxExpander--label" title='The "label" property'>label</a>"                    <span class="type">gchar</span>*                : Read / Write
</pre>
</div>
<div class="refsect1">
<a name="MxExpander.signals"></a><h2>Signals</h2>
<pre class="synopsis">
  "<a class="link" href="MxExpander.html#MxExpander-expand-complete" title='The "expand-complete" signal'>expand-complete</a>"                                : <code class="literal">Run Last</code>
</pre>
</div>
<div class="refsect1">
<a name="MxExpander.description"></a><h2>Description</h2>
<p>
<a class="link" href="MxExpander.html" title="MxExpander"><span class="type">MxExpander</span></a> is a single child container that allows the user to show or
hide its child. It displays a clickable bar (with a text label), 
which (by default) when clicked toggles display of the child.
</p>
<p>
</p>
<div class="figure">
<a name="mx-expander-expanded"></a><p class="title"><b>Figure 3. MxExpander in its expanded state</b></p>
<div class="figure-contents">
<p>The image shows an <a class="link" href="MxExpander.html" title="MxExpander"><span class="type">MxExpander</span></a> with the
  <a class="link" href="MxExpander.html#MxExpander--expanded" title='The "expanded" property'><span class="type">"expanded"</span></a> property set to
  <span class="type">TRUE</span>.</p>
<div><img src="MxExpander-expanded.png" alt="MxExpander in its expanded state"></div>
</div>
</div>
<p><br class="figure-break">
</p>
<p>
</p>
<div class="figure">
<a name="mx-expander-contracted"></a><p class="title"><b>Figure 4. MxExpander in its contracted state</b></p>
<div class="figure-contents">
<p>The image shows an <a class="link" href="MxExpander.html" title="MxExpander"><span class="type">MxExpander</span></a> with the
  <a class="link" href="MxExpander.html#MxExpander--expanded" title='The "expanded" property'><span class="type">"expanded"</span></a> property set to
  <span class="type">FALSE</span>.</p>
<div><img src="MxExpander-contracted.png" alt="MxExpander in its contracted state"></div>
</div>
</div>
<p><br class="figure-break">
</p>
</div>
<div class="refsect1">
<a name="MxExpander.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="MxExpander-struct"></a><h3>MxExpander</h3>
<pre class="programlisting">typedef struct _MxExpander MxExpander;</pre>
<p>
The contents of the this structure are private and should only be accessed
through the public API.
</p>
</div>
<hr>
<div class="refsect2">
<a name="MxExpanderClass"></a><h3>MxExpanderClass</h3>
<pre class="programlisting">typedef struct {
  MxBinClass parent_class;

  /* signals */
  void (* expand_complete)   (MxExpander *expander);

  /* padding for future expansion */
  void (*_padding_0) (void);
  void (*_padding_1) (void);
  void (*_padding_2) (void);
  void (*_padding_3) (void);
  void (*_padding_4) (void);
} MxExpanderClass;
</pre>
</div>
<hr>
<div class="refsect2">
<a name="mx-expander-new"></a><h3>mx_expander_new ()</h3>
<pre class="programlisting"><span class="returnvalue">ClutterActor</span> *      mx_expander_new                     (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Creates a new <a class="link" href="MxExpander.html" title="MxExpander"><span class="type">MxExpander</span></a>
</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>the newly allocated <a class="link" href="MxExpander.html" title="MxExpander"><span class="type">MxExpander</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="mx-expander-set-label"></a><h3>mx_expander_set_label ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                mx_expander_set_label               (<em class="parameter"><code><a class="link" href="MxExpander.html" title="MxExpander"><span class="type">MxExpander</span></a> *expander</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *label</code></em>);</pre>
<p>
Sets the text displayed as the title of the expander
</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>expander</code></em> :</span></p></td>
<td>A <a class="link" href="MxExpander.html" title="MxExpander"><span class="type">MxExpander</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>label</code></em> :</span></p></td>
<td>string to set as the expander label</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="mx-expander-get-expanded"></a><h3>mx_expander_get_expanded ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>            mx_expander_get_expanded            (<em class="parameter"><code><a class="link" href="MxExpander.html" title="MxExpander"><span class="type">MxExpander</span></a> *expander</code></em>);</pre>
<p>
Get the current state of the expander (the value of <a class="link" href="MxExpander.html#MxExpander--expanded" title='The "expanded" property'><span class="type">"expanded"</span></a>)
</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>expander</code></em> :</span></p></td>
<td>a <a class="link" href="MxExpander.html" title="MxExpander"><span class="type">MxExpander</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<span class="type">TRUE</span> if the expander is open, <span class="type">FALSE</span> if it is closed</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="mx-expander-set-expanded"></a><h3>mx_expander_set_expanded ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                mx_expander_set_expanded            (<em class="parameter"><code><a class="link" href="MxExpander.html" title="MxExpander"><span class="type">MxExpander</span></a> *expander</code></em>,
                                                         <em class="parameter"><code><span class="type">gboolean</span> expanded</code></em>);</pre>
<p>
Set the state (the <a class="link" href="MxExpander.html#MxExpander--expanded" title='The "expanded" property'><span class="type">"expanded"</span></a> property) of the expander. 
This will cause the expander to open or close.
</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>expander</code></em> :</span></p></td>
<td>A <a class="link" href="MxExpander.html" title="MxExpander"><span class="type">MxExpander</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>expanded</code></em> :</span></p></td>
<td>the state of the expander to set</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="MxExpander.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="MxExpander--expanded"></a><h3>The <code class="literal">"expanded"</code> property</h3>
<pre class="programlisting">  "expanded"                 <span class="type">gboolean</span>              : Read / Write</pre>
<p>Indicates that the expander is open or closed.</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="MxExpander--label"></a><h3>The <code class="literal">"label"</code> property</h3>
<pre class="programlisting">  "label"                    <span class="type">gchar</span>*                : Read / Write</pre>
<p>Expander title label.</p>
<p>Default value: NULL</p>
</div>
</div>
<div class="refsect1">
<a name="MxExpander.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="MxExpander-expand-complete"></a><h3>The <code class="literal">"expand-complete"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="MxExpander.html" title="MxExpander"><span class="type">MxExpander</span></a> *expander,
                                                        <span class="type">gpointer</span>    user_data)      : <code class="literal">Run Last</code></pre>
<p>
Emitted after the expand animation finishes. Check the "expanded" property
of the <a class="link" href="MxExpander.html" title="MxExpander"><span class="type">MxExpander</span></a> to determine if the expander is expanded or not.
</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>expander</code></em> :</span></p></td>
<td>the object 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>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.19</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.