<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GtkClutterActor: 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="GtkClutterEmbed.html" title="GtkClutterEmbed">
<link rel="next" href="GtkClutterWindow.html" title="GtkClutterWindow">
<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="#GtkClutterActor.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#GtkClutterActor.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#GtkClutterActor.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#GtkClutterActor.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="GtkClutterEmbed.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GtkClutterWindow.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GtkClutterActor"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GtkClutterActor.top_of_page"></a>GtkClutterActor</span></h2>
<p>GtkClutterActor — actor for embedding a Widget in a Clutter stage</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GtkClutterActor.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">ClutterActor</span> *
</td>
<td class="function_name">
<a class="link" href="GtkClutterActor.html#gtk-clutter-actor-new" title="gtk_clutter_actor_new ()">gtk_clutter_actor_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="GtkClutterActor.html#gtk-clutter-actor-new-with-contents" title="gtk_clutter_actor_new_with_contents ()">gtk_clutter_actor_new_with_contents</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GtkWidget</span> *
</td>
<td class="function_name">
<a class="link" href="GtkClutterActor.html#gtk-clutter-actor-get-contents" title="gtk_clutter_actor_get_contents ()">gtk_clutter_actor_get_contents</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GtkWidget</span> *
</td>
<td class="function_name">
<a class="link" href="GtkClutterActor.html#gtk-clutter-actor-get-widget" title="gtk_clutter_actor_get_widget ()">gtk_clutter_actor_get_widget</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkClutterActor.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">GtkWidget</span> *</td>
<td class="property_name"><a class="link" href="GtkClutterActor.html#GtkClutterActor--contents" title="The “contents” property">contents</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkClutterActor.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="GtkClutterActor.html#GtkClutterActor-struct" title="struct GtkClutterActor">GtkClutterActor</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GtkClutterActor.html#GtkClutterActorClass" title="struct GtkClutterActorClass">GtkClutterActorClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkClutterActor.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> GInitiallyUnowned
<span class="lineart">╰──</span> ClutterActor
<span class="lineart">╰──</span> GtkClutterActor
</pre>
</div>
<div class="refsect1">
<a name="GtkClutterActor.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GtkClutterActor implements
ClutterContainer, ClutterScriptable, ClutterAnimatable and AtkImplementorIface.</p>
</div>
<div class="refsect1">
<a name="GtkClutterActor.description"></a><h2>Description</h2>
<p><a class="link" href="GtkClutterActor.html" title="GtkClutterActor"><span class="type">GtkClutterActor</span></a> is a <span class="type">ClutterContainer</span> that also allows embedding
any <span class="type">GtkWidget</span> in a Clutter scenegraph.</p>
<p><a class="link" href="GtkClutterActor.html" title="GtkClutterActor"><span class="type">GtkClutterActor</span></a> only allows embedding <span class="type">GtkWidget</span>s when inside
the <span class="type">ClutterStage</span> provided by a <a class="link" href="GtkClutterEmbed.html" title="GtkClutterEmbed"><span class="type">GtkClutterEmbed</span></a>: it is not possible to
use <a class="link" href="GtkClutterActor.html" title="GtkClutterActor"><span class="type">GtkClutterActor</span></a> in a <span class="type">ClutterStage</span> handled by Clutter alone.</p>
</div>
<div class="refsect1">
<a name="GtkClutterActor.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gtk-clutter-actor-new"></a><h3>gtk_clutter_actor_new ()</h3>
<pre class="programlisting"><span class="returnvalue">ClutterActor</span> *
gtk_clutter_actor_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates a new <a class="link" href="GtkClutterActor.html" title="GtkClutterActor"><span class="type">GtkClutterActor</span></a>.</p>
<p>This widget can be used to embed a <span class="type">GtkWidget</span> into a Clutter scene,
by retrieving the internal <span class="type">GtkBin</span> container using
<a class="link" href="GtkClutterActor.html#gtk-clutter-actor-get-widget" title="gtk_clutter_actor_get_widget ()"><code class="function">gtk_clutter_actor_get_widget()</code></a> and adding the <span class="type">GtkWidget</span> to it.</p>
<div class="refsect3">
<a name="gtk-clutter-actor-new.returns"></a><h4>Returns</h4>
<p> the newly created <a class="link" href="GtkClutterActor.html" title="GtkClutterActor"><span class="type">GtkClutterActor</span></a></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-clutter-actor-new-with-contents"></a><h3>gtk_clutter_actor_new_with_contents ()</h3>
<pre class="programlisting"><span class="returnvalue">ClutterActor</span> *
gtk_clutter_actor_new_with_contents (<em class="parameter"><code><span class="type">GtkWidget</span> *contents</code></em>);</pre>
<p>Creates a new <a class="link" href="GtkClutterActor.html" title="GtkClutterActor"><span class="type">GtkClutterActor</span></a> widget. This widget can be
used to embed a Gtk widget into a clutter scene.</p>
<p>This function is the logical equivalent of:</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3
4</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="usertype">ClutterActor</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">actor </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GtkClutterActor.html#gtk-clutter-actor-new">gtk_clutter_actor_new</a></span><span class="normal"> </span><span class="symbol">();</span>
<span class="usertype">GtkWidget</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">bin </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GtkClutterActor.html#gtk-clutter-actor-get-widget">gtk_clutter_actor_get_widget</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function">GTK_CLUTTER_ACTOR</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">actor</span><span class="symbol">));</span>
<span class="function">gtk_container_add</span><span class="normal"> </span><span class="symbol">(</span><span class="function">GTK_CONTAINER</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">bin</span><span class="symbol">),</span><span class="normal"> contents</span><span class="symbol">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p></p>
<div class="refsect3">
<a name="gtk-clutter-actor-new-with-contents.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>contents</p></td>
<td class="parameter_description"><p>a <span class="type">GtkWidget</span> to pack into this <span class="type">ClutterActor</span></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-clutter-actor-new-with-contents.returns"></a><h4>Returns</h4>
<p> the newly created <a class="link" href="GtkClutterActor.html" title="GtkClutterActor"><span class="type">GtkClutterActor</span></a></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-clutter-actor-get-contents"></a><h3>gtk_clutter_actor_get_contents ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> *
gtk_clutter_actor_get_contents (<em class="parameter"><code><a class="link" href="GtkClutterActor.html" title="GtkClutterActor"><span class="type">GtkClutterActor</span></a> *actor</code></em>);</pre>
<p>Retrieves the child of the <span class="type">GtkBin</span> used to hold the contents of <em class="parameter"><code>actor</code></em>
.</p>
<p>This convenience function is the logical equivalent of:</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3
4</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="usertype">GtkWidget</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">bin</span><span class="symbol">;</span>
<span class="normal">bin </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GtkClutterActor.html#gtk-clutter-actor-get-widget">gtk_clutter_actor_get_widget</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function">GTK_CLUTTER_ACTOR</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">actor</span><span class="symbol">));</span>
<span class="keyword">return</span><span class="normal"> </span><span class="function">gtk_bin_get_child</span><span class="normal"> </span><span class="symbol">(</span><span class="function">GTK_BIN</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">bin</span><span class="symbol">));</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p></p>
<div class="refsect3">
<a name="gtk-clutter-actor-get-contents.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>actor</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkClutterActor.html" title="GtkClutterActor"><span class="type">GtkClutterActor</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-clutter-actor-get-contents.returns"></a><h4>Returns</h4>
<p>a <span class="type">GtkWidget</span>, or <code class="literal">NULL</code> if not content
has been set. </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-actor-get-widget"></a><h3>gtk_clutter_actor_get_widget ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> *
gtk_clutter_actor_get_widget (<em class="parameter"><code><a class="link" href="GtkClutterActor.html" title="GtkClutterActor"><span class="type">GtkClutterActor</span></a> *actor</code></em>);</pre>
<p>Retrieves the <span class="type">GtkBin</span> used to hold the <a class="link" href="GtkClutterActor.html#GtkClutterActor--contents" title="The “contents” property"><span class="type">“contents”</span></a> widget</p>
<div class="refsect3">
<a name="gtk-clutter-actor-get-widget.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>actor</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkClutterActor.html" title="GtkClutterActor"><span class="type">GtkClutterActor</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-clutter-actor-get-widget.returns"></a><h4>Returns</h4>
<p>a <span class="type">GtkBin</span>. </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>
</div>
<div class="refsect1">
<a name="GtkClutterActor.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GtkClutterActor-struct"></a><h3>struct GtkClutterActor</h3>
<pre class="programlisting">struct GtkClutterActor;</pre>
<p>A ClutterActor containing a <span class="type">GtkWidget</span>.</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkClutterActorClass"></a><h3>struct GtkClutterActorClass</h3>
<pre class="programlisting">struct GtkClutterActorClass {
};
</pre>
<p>Base class for <a class="link" href="GtkClutterActor.html" title="GtkClutterActor"><span class="type">GtkClutterActor</span></a>.</p>
</div>
</div>
<div class="refsect1">
<a name="GtkClutterActor.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GtkClutterActor--contents"></a><h3>The <code class="literal">“contents”</code> property</h3>
<pre class="programlisting"> “contents” <span class="type">GtkWidget</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>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25.1</div>
</body>
</html>