libclutter-gtk-1.0-doc 1.8.4-3 / usr / share / gtk-doc / html / clutter-gtk-1.0 / GtkClutterEmbed.html

This file is indexed.

/usr/share/gtk-doc/html/clutter-gtk-1.0/GtkClutterEmbed.html is in libclutter-gtk-1.0-doc 1.8.4-3.

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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GtkClutterEmbed: Clutter-Gtk 1.0 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Clutter-Gtk 1.0 Reference Manual">
<link rel="up" href="ch02.html" title="Clutter-Gtk Widgets">
<link rel="prev" href="ch02.html" title="Clutter-Gtk Widgets">
<link rel="next" href="GtkClutterActor.html" title="GtkClutterActor">
<meta name="generator" content="GTK-Doc V1.25 (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="#GtkClutterEmbed.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#GtkClutterEmbed.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
                  <a href="#GtkClutterEmbed.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#GtkClutterEmbed.properties" class="shortcut">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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ch02.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GtkClutterActor.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GtkClutterEmbed"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GtkClutterEmbed.top_of_page"></a>GtkClutterEmbed</span></h2>
<p>GtkClutterEmbed — Widget for embedding a Clutter scene</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GtkClutterEmbed.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">
<a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> *
</td>
<td class="function_name">
<a class="link" href="GtkClutterEmbed.html#gtk-clutter-embed-new" title="gtk_clutter_embed_new ()">gtk_clutter_embed_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/clutter/ClutterActor.html#ClutterActor-struct"><span class="returnvalue">ClutterActor</span></a> *
</td>
<td class="function_name">
<a class="link" href="GtkClutterEmbed.html#gtk-clutter-embed-get-stage" title="gtk_clutter_embed_get_stage ()">gtk_clutter_embed_get_stage</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="GtkClutterEmbed.html#gtk-clutter-embed-set-use-layout-size" title="gtk_clutter_embed_set_use_layout_size ()">gtk_clutter_embed_set_use_layout_size</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="GtkClutterEmbed.html#gtk-clutter-embed-get-use-layout-size" title="gtk_clutter_embed_get_use_layout_size ()">gtk_clutter_embed_get_use_layout_size</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkClutterEmbed.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"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
<td class="property_name"><a class="link" href="GtkClutterEmbed.html#GtkClutterEmbed--use-layout-size" title="The “use-layout-size” property">use-layout-size</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkClutterEmbed.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GtkClutterEmbed.html#GtkClutterEmbed-struct" title="struct GtkClutterEmbed">GtkClutterEmbed</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GtkClutterEmbed.html#GtkClutterEmbedClass" title="struct GtkClutterEmbedClass">GtkClutterEmbedClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkClutterEmbed.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
    <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
        <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct">GtkWidget</a>
            <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk3/GtkContainer.html#GtkContainer-struct">GtkContainer</a>
                <span class="lineart">╰──</span> GtkClutterEmbed
</pre>
</div>
<div class="refsect1">
<a name="GtkClutterEmbed.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GtkClutterEmbed implements
 AtkImplementorIface and  <a href="/usr/share/gtk-doc/html/gtk3/GtkBuildable.html#GtkBuildable-struct">GtkBuildable</a>.</p>
</div>
<div class="refsect1">
<a name="GtkClutterEmbed.description"></a><h2>Description</h2>
<p><a class="link" href="GtkClutterEmbed.html" title="GtkClutterEmbed"><span class="type">GtkClutterEmbed</span></a> is a GTK+ widget embedding a <a href="/usr/share/gtk-doc/html/clutter/ClutterStage.html#ClutterStage-struct"><span class="type">ClutterStage</span></a> inside
a GTK+ application.</p>
<p>By using a <a class="link" href="GtkClutterEmbed.html" title="GtkClutterEmbed"><span class="type">GtkClutterEmbed</span></a> widget is possible to build, show and
interact with a scene built using Clutter inside a GTK+ application.</p>
<div class="refsect3">
<a name="id-1.3.2.8.4"></a><h4>Event handling with GtkClutterEmbed</h4>
<p>Due to re-entrancy concerns, you should not use GTK event-related
API from within event handling signals emitted by Clutter actors
inside a <a class="link" href="GtkClutterEmbed.html" title="GtkClutterEmbed"><span class="type">GtkClutterEmbed</span></a>.</p>
<p>Event-related API, like the GTK drag and drop functions, or the
GTK grab ones, cause events to be processed inside the GDK event
loop; <a class="link" href="GtkClutterEmbed.html" title="GtkClutterEmbed"><span class="type">GtkClutterEmbed</span></a> and the Clutter event loop may use those
events to generate Clutter events, and thus emit signals on
<a href="/usr/share/gtk-doc/html/clutter/ClutterActor.html#ClutterActor-struct"><span class="type">ClutterActors</span></a>. If you use the event-related signals of a
<a href="/usr/share/gtk-doc/html/clutter/ClutterActor.html#ClutterActor-struct"><span class="type">ClutterActor</span></a> to call the GTK API, one of the two event loops
will try to re-enter into each other, and either cause a crash
or simply block your application.</p>
<p>To avoid this behavior, you can either:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p>only use GTK+ event handling signals to call event-related
GTK functions</p></li>
<li class="listitem"><p>let the main loop re-enter, by calling event-related GTK
functions from within an idle or a timeout callback</p></li>
</ul></div>
<p>You should also make sure you're not using GTK widgets that call
event-related GTK API, like the grab functions in a <a href="/usr/share/gtk-doc/html/gtk3/GtkMenu.html#GtkMenu-struct"><span class="type">GtkMenu</span></a>, in
response to Clutter actor events.</p>
</div>
<div class="refsect3">
<a name="id-1.3.2.8.5"></a><h4>Using GtkClutterEmbed as a container</h4>
<p>Though <a class="link" href="GtkClutterEmbed.html" title="GtkClutterEmbed"><span class="type">GtkClutterEmbed</span></a> is a <a href="/usr/share/gtk-doc/html/gtk3/GtkContainer.html#GtkContainer-struct"><span class="type">GtkContainer</span></a> subclass, it is not a
real GTK+ container; <a class="link" href="GtkClutterEmbed.html" title="GtkClutterEmbed"><span class="type">GtkClutterEmbed</span></a> is required to implement the
<a href="/usr/share/gtk-doc/html/gtk3/GtkContainer.html#GtkContainer-struct"><span class="type">GtkContainer</span></a> virtual functions in order to embed a <a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a>
through the <a class="link" href="GtkClutterActor.html" title="GtkClutterActor"><span class="type">GtkClutterActor</span></a> class. Calling <a href="/usr/share/gtk-doc/html/gtk3/GtkContainer.html#gtk-container-add"><code class="function">gtk_container_add()</code></a>
on a <a class="link" href="GtkClutterEmbed.html" title="GtkClutterEmbed"><span class="type">GtkClutterEmbed</span></a> will trigger an assertion. It is strongly
advised not to override the <a href="/usr/share/gtk-doc/html/gtk3/GtkContainer.html#GtkContainer-struct"><span class="type">GtkContainer</span></a> implementation when
subclassing <a class="link" href="GtkClutterEmbed.html" title="GtkClutterEmbed"><span class="type">GtkClutterEmbed</span></a>, to avoid breaking internal state.</p>
</div>
</div>
<div class="refsect1">
<a name="GtkClutterEmbed.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gtk-clutter-embed-new"></a><h3>gtk_clutter_embed_new ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> *
gtk_clutter_embed_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates a new <a class="link" href="GtkClutterEmbed.html" title="GtkClutterEmbed"><span class="type">GtkClutterEmbed</span></a> widget. This widget can be
used to build a scene using Clutter API into a GTK+ application.</p>
<div class="refsect3">
<a name="gtk-clutter-embed-new.returns"></a><h4>Returns</h4>
<p> the newly created <a class="link" href="GtkClutterEmbed.html" title="GtkClutterEmbed"><span class="type">GtkClutterEmbed</span></a></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-clutter-embed-get-stage"></a><h3>gtk_clutter_embed_get_stage ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/clutter/ClutterActor.html#ClutterActor-struct"><span class="returnvalue">ClutterActor</span></a> *
gtk_clutter_embed_get_stage (<em class="parameter"><code><a class="link" href="GtkClutterEmbed.html" title="GtkClutterEmbed"><span class="type">GtkClutterEmbed</span></a> *embed</code></em>);</pre>
<p>Retrieves the <a href="/usr/share/gtk-doc/html/clutter/ClutterStage.html#ClutterStage-struct"><span class="type">ClutterStage</span></a> from <em class="parameter"><code>embed</code></em>
. The returned stage can be
used to add actors to the Clutter scene.</p>
<div class="refsect3">
<a name="gtk-clutter-embed-get-stage.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>embed</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkClutterEmbed.html" title="GtkClutterEmbed"><span class="type">GtkClutterEmbed</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-clutter-embed-get-stage.returns"></a><h4>Returns</h4>
<p> the Clutter stage. You should never
destroy or unref the returned actor. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-clutter-embed-set-use-layout-size"></a><h3>gtk_clutter_embed_set_use_layout_size ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_clutter_embed_set_use_layout_size (<em class="parameter"><code><a class="link" href="GtkClutterEmbed.html" title="GtkClutterEmbed"><span class="type">GtkClutterEmbed</span></a> *embed</code></em>,
                                       <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> use_layout_size</code></em>);</pre>
<p>Changes the way <em class="parameter"><code>embed</code></em>
 requests size. If <em class="parameter"><code>use_layout_size</code></em>
 is
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, the <em class="parameter"><code>embed</code></em>
 widget will request the size that the
LayoutManager reports as the preferred size. This means that
a Gtk+ window will automatically get the natural and minimum
toplevel window sizes. This is useful when the contents of the
clutter stage is similar to a traditional UI.</p>
<p>If <em class="parameter"><code>use_layout_size</code></em>
 is <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> (which is the default) then <em class="parameter"><code>embed</code></em>

will not request any size and its up to the embedder to make sure
there is some size (by setting a custom size on the widget or a default
size on the toplevel. This makes more sense when using the <em class="parameter"><code>embed</code></em>

as a viewport into a potentially unlimited clutter space.</p>
<div class="refsect3">
<a name="gtk-clutter-embed-set-use-layout-size.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>embed</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkClutterEmbed.html" title="GtkClutterEmbed"><span class="type">GtkClutterEmbed</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>use_layout_size</p></td>
<td class="parameter_description"><p>a boolean</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix04.html#api-index-1.4">1.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-clutter-embed-get-use-layout-size"></a><h3>gtk_clutter_embed_get_use_layout_size ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gtk_clutter_embed_get_use_layout_size (<em class="parameter"><code><a class="link" href="GtkClutterEmbed.html" title="GtkClutterEmbed"><span class="type">GtkClutterEmbed</span></a> *embed</code></em>);</pre>
<p>Retrieves whether the embedding uses the layout size, see
<a class="link" href="GtkClutterEmbed.html#gtk-clutter-embed-set-use-layout-size" title="gtk_clutter_embed_set_use_layout_size ()"><code class="function">gtk_clutter_embed_set_use_layout_size()</code></a> for details.</p>
<div class="refsect3">
<a name="gtk-clutter-embed-get-use-layout-size.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>embed</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkClutterEmbed.html" title="GtkClutterEmbed"><span class="type">GtkClutterEmbed</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-clutter-embed-get-use-layout-size.returns"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if reporting stage size as widget size, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</p>
</div>
<p class="since">Since: <a class="link" href="ix04.html#api-index-1.4">1.4</a></p>
</div>
</div>
<div class="refsect1">
<a name="GtkClutterEmbed.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GtkClutterEmbed-struct"></a><h3>struct GtkClutterEmbed</h3>
<pre class="programlisting">struct GtkClutterEmbed;</pre>
<p>A <a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a> containing the default Clutter stage.</p>
<p>The <span class="structname">GtkClutterEmbed</span> structure contains only
private data and should be accessed using the provided API.</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkClutterEmbedClass"></a><h3>struct GtkClutterEmbedClass</h3>
<pre class="programlisting">struct GtkClutterEmbedClass {
};
</pre>
<p>Base class for <a class="link" href="GtkClutterEmbed.html" title="GtkClutterEmbed"><span class="type">GtkClutterEmbed</span></a>.</p>
<p>The <span class="structname">GtkClutterEmbedClass</span> contains only private
data.</p>
</div>
</div>
<div class="refsect1">
<a name="GtkClutterEmbed.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GtkClutterEmbed--use-layout-size"></a><h3>The <code class="literal">“use-layout-size”</code> property</h3>
<pre class="programlisting">  “use-layout-size”          <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
<p>The <a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct"><span class="type">GtkWidget</span></a> to be embedded into the <a class="link" href="GtkClutterActor.html" title="GtkClutterActor"><span class="type">GtkClutterActor</span></a></p>
<p>Flags: Read / Write / Construct</p>
<p>Default value: FALSE</p>
<p class="since">Since: <a class="link" href="ix04.html#api-index-1.4">1.4</a></p>
</div>
</div>
<div class="refsect1">
<a name="GtkClutterEmbed.see-also"></a><h2>See Also</h2>
<p><a href="/usr/share/gtk-doc/html/clutter/ClutterStage.html#ClutterStage-struct"><span class="type">ClutterStage</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.