File: GtkClutterEmbed.html

package info (click to toggle)
clutter-gtk 0.8.1-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 1,820 kB
  • ctags: 146
  • sloc: sh: 8,767; ansic: 1,023; xml: 434; makefile: 77
file content (201 lines) | stat: -rw-r--r-- 8,628 bytes parent folder | download
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
<!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</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<link rel="start" href="index.html" title="Clutter-Gtk 0.8.1 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="ch03.html" title="Miscellaneous">
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="ch01.html" title="Clutter-Gtk Overview">
<link rel="chapter" href="ch02.html" title="Clutter-Gtk Widgets">
<link rel="chapter" href="ch03.html" title="Miscellaneous">
<link rel="appendix" href="license.html" title="Appendix A. License">
</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="ch02.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">Clutter-Gtk 0.8.1
 Reference Manual</th>
<td><a accesskey="n" href="ch03.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#GtkClutterEmbed.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#GtkClutterEmbed.description" class="shortcut">Description</a>
                   | 
                  <a href="#GtkClutterEmbed.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#GtkClutterEmbed.implemented-interfaces" class="shortcut">Implemented Interfaces</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<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 valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GtkClutterEmbed.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
                    <a class="link" href="GtkClutterEmbed.html#GtkClutterEmbed-struct" title="GtkClutterEmbed">GtkClutterEmbed</a>;
                    <a class="link" href="GtkClutterEmbed.html#GtkClutterEmbedClass" title="GtkClutterEmbedClass">GtkClutterEmbedClass</a>;
<a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a>*          <a class="link" href="GtkClutterEmbed.html#gtk-clutter-embed-new" title="gtk_clutter_embed_new ()">gtk_clutter_embed_new</a>               (void);
<a
href="/usr/share/gtk-doc/html/clutter/ClutterActor.html"
>ClutterActor</a>*       <a class="link" href="GtkClutterEmbed.html#gtk-clutter-embed-get-stage" title="gtk_clutter_embed_get_stage ()">gtk_clutter_embed_get_stage</a>         (<a class="link" href="GtkClutterEmbed.html" title="GtkClutterEmbed">GtkClutterEmbed</a> *embed);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="GtkClutterEmbed.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  GObject
   +----GInitiallyUnowned
         +----<a
href="/usr/share/gtk-doc/html/gtk/GtkObject.html"
>GtkObject</a>
               +----<a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a>
                     +----GtkClutterEmbed
</pre>
</div>
<div class="refsect1" lang="en">
<a name="GtkClutterEmbed.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GtkClutterEmbed implements
 AtkImplementorIface and  <a
href="/usr/share/gtk-doc/html/gtk/gtk-gtkbuildable.html#GtkBuildable"
>GtkBuildable</a>.</p>
</div>
<div class="refsect1" lang="en">
<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"
><span class="type">ClutterStage</span></a>. 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>
<p>
</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>To avoid flickering on show, you should call <a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html#gtk-widget-show"
><code class="function">gtk_widget_show()</code></a>
or <a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html#gtk-widget-realize"
><code class="function">gtk_widget_realize()</code></a> before calling <a
href="/usr/share/gtk-doc/html/clutter/ClutterActor.html#clutter-actor-show"
><code class="function">clutter_actor_show()</code></a> on the
embedded <a
href="/usr/share/gtk-doc/html/clutter/ClutterStage.html"
><span class="type">ClutterStage</span></a> actor. This is needed for Clutter to be able
to paint on the <a class="link" href="GtkClutterEmbed.html" title="GtkClutterEmbed"><span class="type">GtkClutterEmbed</span></a> widget.</div>
<p>

</p>
</div>
<div class="refsect1" lang="en">
<a name="GtkClutterEmbed.details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="GtkClutterEmbed-struct"></a><h3>GtkClutterEmbed</h3>
<pre class="programlisting">typedef struct _GtkClutterEmbed GtkClutterEmbed;</pre>
<p>
A <a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
><span class="type">GtkWidget</span></a> containing the default Clutter stage.</p>
<p>

</p>
<p class="since">Since  0.6
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="GtkClutterEmbedClass"></a><h3>GtkClutterEmbedClass</h3>
<pre class="programlisting">typedef struct {
} GtkClutterEmbedClass;
</pre>
<p>
Base class for <a class="link" href="GtkClutterEmbed.html" title="GtkClutterEmbed"><span class="type">GtkClutterEmbed</span></a>.</p>
<p>

</p>
<p class="since">Since  0.6
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gtk-clutter-embed-new"></a><h3>gtk_clutter_embed_new ()</h3>
<pre class="programlisting"><a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a>*          gtk_clutter_embed_new               (void);</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>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the newly created <a class="link" href="GtkClutterEmbed.html" title="GtkClutterEmbed"><span class="type">GtkClutterEmbed</span></a>

</td>
</tr></tbody>
</table></div>
<p class="since">Since  0.6
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<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</a>*       gtk_clutter_embed_get_stage         (<a class="link" href="GtkClutterEmbed.html" title="GtkClutterEmbed">GtkClutterEmbed</a> *embed);</pre>
<p>
Retrieves the <a
href="/usr/share/gtk-doc/html/clutter/ClutterStage.html"
><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>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>embed</code></em> :</span></p></td>
<td> a <a class="link" href="GtkClutterEmbed.html" title="GtkClutterEmbed"><span class="type">GtkClutterEmbed</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the Clutter stage. You should never destroy or unref
  the returned actor.

</td>
</tr>
</tbody>
</table></div>
<p class="since">Since  0.6
</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.10</div>
</body>
</html>