cinnamon-doc 3.6.7-8ubuntu1 / usr / share / gtk-doc / html / cinnamon / CinnamonGenericContainer.html

This file is indexed.

/usr/share/gtk-doc/html/cinnamon/CinnamonGenericContainer.html is in cinnamon-doc 3.6.7-8ubuntu1.

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
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CinnamonGenericContainer: Cinnamon Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Cinnamon Reference Manual">
<link rel="up" href="ch01.html" title="Actors">
<link rel="prev" href="ch01.html" title="Actors">
<link rel="next" href="CinnamonSlicer.html" title="CinnamonSlicer">
<meta name="generator" content="GTK-Doc V1.27 (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="#CinnamonGenericContainer.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#CinnamonGenericContainer.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_signals">  <span class="dim">|</span> 
                  <a href="#CinnamonGenericContainer.signals" class="shortcut">Signals</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="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ch01.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="CinnamonSlicer.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="CinnamonGenericContainer"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="CinnamonGenericContainer.top_of_page"></a>CinnamonGenericContainer</span></h2>
<p>CinnamonGenericContainer — A container class with signals for allocation</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="CinnamonGenericContainer.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">guint</span>
</td>
<td class="function_name">
<a class="link" href="CinnamonGenericContainer.html#cinnamon-generic-container-get-n-skip-paint" title="cinnamon_generic_container_get_n_skip_paint ()">cinnamon_generic_container_get_n_skip_paint</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="CinnamonGenericContainer.html#cinnamon-generic-container-get-skip-paint" title="cinnamon_generic_container_get_skip_paint ()">cinnamon_generic_container_get_skip_paint</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="CinnamonGenericContainer.html#cinnamon-generic-container-set-skip-paint" title="cinnamon_generic_container_set_skip_paint ()">cinnamon_generic_container_set_skip_paint</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="CinnamonGenericContainer.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="signals_return">
<col width="300px" class="signals_name">
<col width="200px" class="signals_flags">
</colgroup>
<tbody>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="CinnamonGenericContainer.html#CinnamonGenericContainer-allocate" title="The “allocate” signal">allocate</a></td>
<td class="signal_flags">Run Last</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="CinnamonGenericContainer.html#CinnamonGenericContainer-get-preferred-height" title="The “get-preferred-height” signal">get-preferred-height</a></td>
<td class="signal_flags">Run Last</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="CinnamonGenericContainer.html#CinnamonGenericContainer-get-preferred-width" title="The “get-preferred-width” signal">get-preferred-width</a></td>
<td class="signal_flags">Run Last</td>
</tr>
</tbody>
</table></div>
</div>
<a name="CinnamonGenericContainerAllocation"></a><div class="refsect1">
<a name="CinnamonGenericContainer.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/gobject-Boxed-Types.html">GBoxed</a>
    <span class="lineart">╰──</span> CinnamonGenericContainerAllocation
    GObject
    <span class="lineart">╰──</span> GInitiallyUnowned
        <span class="lineart">╰──</span> ClutterActor
            <span class="lineart">╰──</span> StWidget
                <span class="lineart">╰──</span> CinnamonGenericContainer
</pre>
</div>
<div class="refsect1">
<a name="CinnamonGenericContainer.description"></a><h2>Description</h2>
<p><a class="link" href="CinnamonGenericContainer.html" title="CinnamonGenericContainer"><span class="type">CinnamonGenericContainer</span></a> is mainly a workaround for the current
lack of GObject subclassing + vfunc overrides in gjs.  We
implement the container interface, but proxy the virtual functions
into signals, which gjs can catch.</p>
<p><a class="link" href="CinnamonGenericContainer.html" title="CinnamonGenericContainer"><span class="type">CinnamonGenericContainer</span></a> is an <span class="type">StWidget</span>, and automatically takes its
borders and padding into account during size request and allocation.</p>
</div>
<div class="refsect1">
<a name="CinnamonGenericContainer.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="cinnamon-generic-container-get-n-skip-paint"></a><h3>cinnamon_generic_container_get_n_skip_paint ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
cinnamon_generic_container_get_n_skip_paint
                               (<em class="parameter"><code><a class="link" href="CinnamonGenericContainer.html" title="CinnamonGenericContainer"><span class="type">CinnamonGenericContainer</span></a> *self</code></em>);</pre>
<div class="refsect3">
<a name="cinnamon-generic-container-get-n-skip-paint.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>self</p></td>
<td class="parameter_description"><p>A <a class="link" href="CinnamonGenericContainer.html" title="CinnamonGenericContainer"><span class="type">CinnamonGenericContainer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="cinnamon-generic-container-get-n-skip-paint.returns"></a><h4>Returns</h4>
<p> Number of children which will not be painted.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="cinnamon-generic-container-get-skip-paint"></a><h3>cinnamon_generic_container_get_skip_paint ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
cinnamon_generic_container_get_skip_paint
                               (<em class="parameter"><code><a class="link" href="CinnamonGenericContainer.html" title="CinnamonGenericContainer"><span class="type">CinnamonGenericContainer</span></a> *self</code></em>,
                                <em class="parameter"><code><span class="type">ClutterActor</span> *child</code></em>);</pre>
<p>Gets whether or not <em class="parameter"><code>actor</code></em>
 is skipped when painting.</p>
<div class="refsect3">
<a name="cinnamon-generic-container-get-skip-paint.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>self</p></td>
<td class="parameter_description"><p>A <a class="link" href="CinnamonGenericContainer.html" title="CinnamonGenericContainer"><span class="type">CinnamonGenericContainer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>child</p></td>
<td class="parameter_description"><p>Child <span class="type">ClutterActor</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="cinnamon-generic-container-get-skip-paint.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> or <code class="literal">FALSE</code></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="cinnamon-generic-container-set-skip-paint"></a><h3>cinnamon_generic_container_set_skip_paint ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
cinnamon_generic_container_set_skip_paint
                               (<em class="parameter"><code><a class="link" href="CinnamonGenericContainer.html" title="CinnamonGenericContainer"><span class="type">CinnamonGenericContainer</span></a> *self</code></em>,
                                <em class="parameter"><code><span class="type">ClutterActor</span> *child</code></em>,
                                <em class="parameter"><code><span class="type">gboolean</span> skip</code></em>);</pre>
<p>Set whether or not we should skip painting <em class="parameter"><code>actor</code></em>
.  Workaround for
lack of gjs ability to override _paint vfunc.</p>
<div class="refsect3">
<a name="cinnamon-generic-container-set-skip-paint.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>self</p></td>
<td class="parameter_description"><p>A <a class="link" href="CinnamonGenericContainer.html" title="CinnamonGenericContainer"><span class="type">CinnamonGenericContainer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>child</p></td>
<td class="parameter_description"><p>Child <span class="type">ClutterActor</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>skip</p></td>
<td class="parameter_description"><p><code class="literal">TRUE</code> if we should skip painting</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="CinnamonGenericContainer.other_details"></a><h2>Types and Values</h2>
</div>
<div class="refsect1">
<a name="CinnamonGenericContainer.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="CinnamonGenericContainer-allocate"></a><h3>The <code class="literal">“allocate”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="CinnamonGenericContainer.html" title="CinnamonGenericContainer"><span class="type">CinnamonGenericContainer</span></a> *self,
               <span class="type">ClutterActorBox</span>          *box,
               <span class="type">ClutterAllocationFlags</span>    flags,
               <span class="type">gpointer</span>                  user_data)</pre>
<p>Emitted when <em class="parameter"><code>self</code></em>
 is allocated, after chaining up to the parent
allocate method.</p>
<p>Note that <em class="parameter"><code>box</code></em>
 is <em class="parameter"><code>self</code></em>
's content box (qv
<code class="function">st_theme_node_get_content_box()</code>), NOT its allocation.</p>
<div class="refsect3">
<a name="CinnamonGenericContainer-allocate.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>self</p></td>
<td class="parameter_description"><p>the <a class="link" href="CinnamonGenericContainer.html" title="CinnamonGenericContainer"><span class="type">CinnamonGenericContainer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>box</p></td>
<td class="parameter_description"><p><em class="parameter"><code>self</code></em>
's content box</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>flags</p></td>
<td class="parameter_description"><p>the allocation flags.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
</div>
<hr>
<div class="refsect2">
<a name="CinnamonGenericContainer-get-preferred-height"></a><h3>The <code class="literal">“get-preferred-height”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="CinnamonGenericContainer.html" title="CinnamonGenericContainer"><span class="type">CinnamonGenericContainer</span></a>           *self,
               <span class="type">gfloat</span>                              for_width,
               <a class="link" href="CinnamonGenericContainer.html#CinnamonGenericContainerAllocation"><span class="type">CinnamonGenericContainerAllocation</span></a> *alloc,
               <span class="type">gpointer</span>                            user_data)</pre>
<p>Emitted when <code class="function">clutter_actor_get_preferred_height()</code> is called
on <em class="parameter"><code>self</code></em>
. You should fill in the fields of <em class="parameter"><code>alloc</code></em>
 with the
your minimum and natural heights. <a class="link" href="CinnamonGenericContainer.html" title="CinnamonGenericContainer"><span class="type">CinnamonGenericContainer</span></a>
will deal with taking its borders and padding into account
for you.</p>
<p><em class="parameter"><code>alloc</code></em>
's fields are initialized to 0, so unless you have a fixed
height specified (via <span class="type">“height”</span> or CSS), you must
connect to this signal and fill in the values.</p>
<div class="refsect3">
<a name="CinnamonGenericContainer-get-preferred-height.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>self</p></td>
<td class="parameter_description"><p>the <a class="link" href="CinnamonGenericContainer.html" title="CinnamonGenericContainer"><span class="type">CinnamonGenericContainer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>for_width</p></td>
<td class="parameter_description"><p>as in <code class="function">clutter_actor_get_preferred_height()</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>alloc</p></td>
<td class="parameter_description"><p>a <a class="link" href="CinnamonGenericContainer.html#CinnamonGenericContainerAllocation"><span class="type">CinnamonGenericContainerAllocation</span></a> to be filled in</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
</div>
<hr>
<div class="refsect2">
<a name="CinnamonGenericContainer-get-preferred-width"></a><h3>The <code class="literal">“get-preferred-width”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="CinnamonGenericContainer.html" title="CinnamonGenericContainer"><span class="type">CinnamonGenericContainer</span></a>           *self,
               <span class="type">gfloat</span>                              for_height,
               <a class="link" href="CinnamonGenericContainer.html#CinnamonGenericContainerAllocation"><span class="type">CinnamonGenericContainerAllocation</span></a> *alloc,
               <span class="type">gpointer</span>                            user_data)</pre>
<p>Emitted when <code class="function">clutter_actor_get_preferred_width()</code> is called
on <em class="parameter"><code>self</code></em>
. You should fill in the fields of <em class="parameter"><code>alloc</code></em>
 with the
your minimum and natural widths. <a class="link" href="CinnamonGenericContainer.html" title="CinnamonGenericContainer"><span class="type">CinnamonGenericContainer</span></a>
will deal with taking its borders and padding into account
for you.</p>
<p><em class="parameter"><code>alloc</code></em>
's fields are initialized to 0, so unless you have a fixed
width specified (via <span class="type">“width”</span> or CSS), you must
connect to this signal and fill in the values.</p>
<div class="refsect3">
<a name="CinnamonGenericContainer-get-preferred-width.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>self</p></td>
<td class="parameter_description"><p>the <a class="link" href="CinnamonGenericContainer.html" title="CinnamonGenericContainer"><span class="type">CinnamonGenericContainer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>for_height</p></td>
<td class="parameter_description"><p>as in <code class="function">clutter_actor_get_preferred_width()</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>alloc</p></td>
<td class="parameter_description"><p>a <a class="link" href="CinnamonGenericContainer.html#CinnamonGenericContainerAllocation"><span class="type">CinnamonGenericContainerAllocation</span></a> to be filled in</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.