<!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 Vsnapshot">
<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.1 (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">
<span class="returnvalue">GtkWidget</span> *
</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">
<span class="returnvalue">ClutterActor</span> *
</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">
<span class="returnvalue">gboolean</span>
</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"><span class="type">gboolean</span></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"> GObject
<span class="lineart">╰──</span> GInitiallyUnowned
<span class="lineart">╰──</span> GtkWidget
<span class="lineart">╰──</span> GtkContainer
<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 GtkBuildable.</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 <span class="type">ClutterStage</span> 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
<span class="type">ClutterActors</span>. If you use the event-related signals of a
<span class="type">ClutterActor</span> 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 <span class="type">GtkMenu</span>, 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 <span class="type">GtkContainer</span> 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
<span class="type">GtkContainer</span> virtual functions in order to embed a <span class="type">GtkWidget</span>
through the <a class="link" href="GtkClutterActor.html" title="GtkClutterActor"><span class="type">GtkClutterActor</span></a> class. Calling <code class="function">gtk_container_add()</code>
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 <span class="type">GtkContainer</span> 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"><span class="returnvalue">GtkWidget</span> *
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"><span class="returnvalue">ClutterActor</span> *
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 <span class="type">ClutterStage</span> 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><span class="type">gboolean</span> 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
<code class="literal">TRUE</code>, 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 <code class="literal">FALSE</code> (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"><span class="returnvalue">gboolean</span>
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> <code class="literal">TRUE</code> if reporting stage size as widget size, <code class="literal">FALSE</code> 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 <span class="type">GtkWidget</span> 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” <span class="type">gboolean</span></pre>
<p>The <span class="type">GtkWidget</span> 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><span class="type">ClutterStage</span></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25.1</div>
</body>
</html>