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
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY version SYSTEM "version.xml">
]>
<refentry id="clutter-gtk-Utility-Functions">
<refmeta>
<refentrytitle role="top_of_page" id="clutter-gtk-Utility-Functions.top_of_page">Utility Functions</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>CLUTTER-GTK Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>Utility Functions</refname>
<refpurpose>Utility functions for integrating Clutter in GTK+</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="clutter-gtk-Utility-Functions.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
enum <link linkend="ClutterGtkInitError">ClutterGtkInitError</link>;
<link linkend="ClutterInitError">ClutterInitError</link> <link linkend="gtk-clutter-init">gtk_clutter_init</link> (<link linkend="gint">gint</link> *argc,
<link linkend="gchar">gchar</link> ***argv);
<link linkend="void">void</link> <link linkend="gtk-clutter-get-fg-color">gtk_clutter_get_fg_color</link> (<link linkend="GtkWidget">GtkWidget</link> *widget,
<link linkend="GtkStateType">GtkStateType</link> state,
<link linkend="ClutterColor">ClutterColor</link> *color);
<link linkend="void">void</link> <link linkend="gtk-clutter-get-bg-color">gtk_clutter_get_bg_color</link> (<link linkend="GtkWidget">GtkWidget</link> *widget,
<link linkend="GtkStateType">GtkStateType</link> state,
<link linkend="ClutterColor">ClutterColor</link> *color);
<link linkend="void">void</link> <link linkend="gtk-clutter-get-text-color">gtk_clutter_get_text_color</link> (<link linkend="GtkWidget">GtkWidget</link> *widget,
<link linkend="GtkStateType">GtkStateType</link> state,
<link linkend="ClutterColor">ClutterColor</link> *color);
<link linkend="void">void</link> <link linkend="gtk-clutter-get-base-color">gtk_clutter_get_base_color</link> (<link linkend="GtkWidget">GtkWidget</link> *widget,
<link linkend="GtkStateType">GtkStateType</link> state,
<link linkend="ClutterColor">ClutterColor</link> *color);
<link linkend="ClutterActor">ClutterActor</link>* <link linkend="gtk-clutter-texture-new-from-pixbuf">gtk_clutter_texture_new_from_pixbuf</link> (<link linkend="GdkPixbuf">GdkPixbuf</link> *pixbuf);
<link linkend="ClutterActor">ClutterActor</link>* <link linkend="gtk-clutter-texture-new-from-stock">gtk_clutter_texture_new_from_stock</link> (<link linkend="GtkWidget">GtkWidget</link> *widget,
const <link linkend="gchar">gchar</link> *stock_id,
<link linkend="GtkIconSize">GtkIconSize</link> size);
<link linkend="ClutterActor">ClutterActor</link>* <link linkend="gtk-clutter-texture-new-from-icon-name">gtk_clutter_texture_new_from_icon_name</link>
(<link linkend="GtkWidget">GtkWidget</link> *widget,
const <link linkend="gchar">gchar</link> *icon_name,
<link linkend="GtkIconSize">GtkIconSize</link> size);
<link linkend="void">void</link> <link linkend="gtk-clutter-texture-set-from-pixbuf">gtk_clutter_texture_set_from_pixbuf</link> (<link linkend="ClutterTexture">ClutterTexture</link> *texture,
<link linkend="GdkPixbuf">GdkPixbuf</link> *pixbuf);
<link linkend="void">void</link> <link linkend="gtk-clutter-texture-set-from-stock">gtk_clutter_texture_set_from_stock</link> (<link linkend="ClutterTexture">ClutterTexture</link> *texture,
<link linkend="GtkWidget">GtkWidget</link> *widget,
const <link linkend="gchar">gchar</link> *stock_id,
<link linkend="GtkIconSize">GtkIconSize</link> size);
<link linkend="void">void</link> <link linkend="gtk-clutter-texture-set-from-icon-name">gtk_clutter_texture_set_from_icon_name</link>
(<link linkend="ClutterTexture">ClutterTexture</link> *texture,
<link linkend="GtkWidget">GtkWidget</link> *widget,
const <link linkend="gchar">gchar</link> *icon_name,
<link linkend="GtkIconSize">GtkIconSize</link> size);
</synopsis>
</refsynopsisdiv>
<refsect1 id="clutter-gtk-Utility-Functions.description" role="desc">
<title role="desc.title">Description</title>
<para>
In order to properly integrate a Clutter scene into a GTK+ applications
a certain degree of state must be retrieved from GTK+ itself.
</para>
<para>
Clutter-GTK provides API for easing the process of synchronizing colors
with the current GTK+ theme and for loading image sources from <link linkend="GdkPixbuf"><type>GdkPixbuf</type></link>,
GTK+ stock items and icon themes.</para>
<para>
</para>
</refsect1>
<refsect1 id="clutter-gtk-Utility-Functions.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="ClutterGtkInitError" role="enum" condition="since:0.8">
<title>enum ClutterGtkInitError</title>
<indexterm zone="ClutterGtkInitError" role="0.8"><primary>ClutterGtkInitError</primary></indexterm><programlisting>typedef enum {
CLUTTER_INIT_ERROR_LAST = CLUTTER_INIT_ERROR_INTERNAL,
CLUTTER_INIT_ERROR_GTK = (CLUTTER_INIT_ERROR_LAST - 1)
} ClutterGtkInitError;
</programlisting>
<para>
Extension of the <link linkend="ClutterInitError"><type>ClutterInitError</type></link> enumeration for the integration
with GTK+</para>
<para>
</para><variablelist role="enum">
<varlistentry id="CLUTTER-INIT-ERROR-LAST:CAPS" role="constant">
<term><literal>CLUTTER_INIT_ERROR_LAST</literal></term>
<listitem><simpara> Placeholder
</simpara></listitem>
</varlistentry>
<varlistentry id="CLUTTER-INIT-ERROR-GTK:CAPS" role="constant">
<term><literal>CLUTTER_INIT_ERROR_GTK</literal></term>
<listitem><simpara> Unable to initialize GTK+
</simpara></listitem>
</varlistentry>
</variablelist><para role="since">Since 0.8
</para></refsect2>
<refsect2 id="gtk-clutter-init" role="function" condition="since:0.8">
<title>gtk_clutter_init ()</title>
<indexterm zone="gtk-clutter-init" role="0.8"><primary>gtk_clutter_init</primary></indexterm><programlisting><link linkend="ClutterInitError">ClutterInitError</link> gtk_clutter_init (<link linkend="gint">gint</link> *argc,
<link linkend="gchar">gchar</link> ***argv);</programlisting>
<para>
This function should be called instead of <link linkend="clutter-init"><function>clutter_init()</function></link> and
<link linkend="gtk-init"><function>gtk_init()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>argc</parameter> :</term>
<listitem><simpara> pointer to the arguments count, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>argv</parameter> :</term>
<listitem><simpara> pointer to the arguments vector, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="CLUTTER-INIT-SUCCESS:CAPS"><literal>CLUTTER_INIT_SUCCESS</literal></link> on success, a negative integer
on failure.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.8
</para></refsect2>
<refsect2 id="gtk-clutter-get-fg-color" role="function" condition="since:0.8">
<title>gtk_clutter_get_fg_color ()</title>
<indexterm zone="gtk-clutter-get-fg-color" role="0.8"><primary>gtk_clutter_get_fg_color</primary></indexterm><programlisting><link linkend="void">void</link> gtk_clutter_get_fg_color (<link linkend="GtkWidget">GtkWidget</link> *widget,
<link linkend="GtkStateType">GtkStateType</link> state,
<link linkend="ClutterColor">ClutterColor</link> *color);</programlisting>
<para>
Retrieves the foreground color of <parameter>widget</parameter> for the given <parameter>state</parameter> and copies
it into <parameter>color</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>widget</parameter> :</term>
<listitem><simpara> a <link linkend="GtkWidget"><type>GtkWidget</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>state</parameter> :</term>
<listitem><simpara> a state
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>color</parameter> :</term>
<listitem><simpara> return location for a <link linkend="ClutterColor"><type>ClutterColor</type></link>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.8
</para></refsect2>
<refsect2 id="gtk-clutter-get-bg-color" role="function" condition="since:0.8">
<title>gtk_clutter_get_bg_color ()</title>
<indexterm zone="gtk-clutter-get-bg-color" role="0.8"><primary>gtk_clutter_get_bg_color</primary></indexterm><programlisting><link linkend="void">void</link> gtk_clutter_get_bg_color (<link linkend="GtkWidget">GtkWidget</link> *widget,
<link linkend="GtkStateType">GtkStateType</link> state,
<link linkend="ClutterColor">ClutterColor</link> *color);</programlisting>
<para>
Retrieves the background color of <parameter>widget</parameter> for the given <parameter>state</parameter> and copies
it into <parameter>color</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>widget</parameter> :</term>
<listitem><simpara> a <link linkend="GtkWidget"><type>GtkWidget</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>state</parameter> :</term>
<listitem><simpara> a state
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>color</parameter> :</term>
<listitem><simpara> return location for a <link linkend="ClutterColor"><type>ClutterColor</type></link>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.8
</para></refsect2>
<refsect2 id="gtk-clutter-get-text-color" role="function" condition="since:0.8">
<title>gtk_clutter_get_text_color ()</title>
<indexterm zone="gtk-clutter-get-text-color" role="0.8"><primary>gtk_clutter_get_text_color</primary></indexterm><programlisting><link linkend="void">void</link> gtk_clutter_get_text_color (<link linkend="GtkWidget">GtkWidget</link> *widget,
<link linkend="GtkStateType">GtkStateType</link> state,
<link linkend="ClutterColor">ClutterColor</link> *color);</programlisting>
<para>
Retrieves the text color of <parameter>widget</parameter> for the given <parameter>state</parameter> and copies it
into <parameter>color</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>widget</parameter> :</term>
<listitem><simpara> a <link linkend="GtkWidget"><type>GtkWidget</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>state</parameter> :</term>
<listitem><simpara> a state
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>color</parameter> :</term>
<listitem><simpara> return location for a <link linkend="ClutterColor"><type>ClutterColor</type></link>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.8
</para></refsect2>
<refsect2 id="gtk-clutter-get-base-color" role="function" condition="since:0.8">
<title>gtk_clutter_get_base_color ()</title>
<indexterm zone="gtk-clutter-get-base-color" role="0.8"><primary>gtk_clutter_get_base_color</primary></indexterm><programlisting><link linkend="void">void</link> gtk_clutter_get_base_color (<link linkend="GtkWidget">GtkWidget</link> *widget,
<link linkend="GtkStateType">GtkStateType</link> state,
<link linkend="ClutterColor">ClutterColor</link> *color);</programlisting>
<para>
Retrieves the base color of <parameter>widget</parameter> for the given <parameter>state</parameter> and copies it
into <parameter>color</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>widget</parameter> :</term>
<listitem><simpara> a <link linkend="GtkWidget"><type>GtkWidget</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>state</parameter> :</term>
<listitem><simpara> a state
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>color</parameter> :</term>
<listitem><simpara> return location for a <link linkend="ClutterColor"><type>ClutterColor</type></link>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.8
</para></refsect2>
<refsect2 id="gtk-clutter-texture-new-from-pixbuf" role="function" condition="since:0.8">
<title>gtk_clutter_texture_new_from_pixbuf ()</title>
<indexterm zone="gtk-clutter-texture-new-from-pixbuf" role="0.8"><primary>gtk_clutter_texture_new_from_pixbuf</primary></indexterm><programlisting><link linkend="ClutterActor">ClutterActor</link>* gtk_clutter_texture_new_from_pixbuf (<link linkend="GdkPixbuf">GdkPixbuf</link> *pixbuf);</programlisting>
<para>
Creates a new <link linkend="ClutterTexture"><type>ClutterTexture</type></link> and sets its contents with a copy
of <parameter>pixbuf</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>pixbuf</parameter> :</term>
<listitem><simpara> a <link linkend="GdkPixbuf"><type>GdkPixbuf</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the newly created <link linkend="ClutterTexture"><type>ClutterTexture</type></link>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.8
</para></refsect2>
<refsect2 id="gtk-clutter-texture-new-from-stock" role="function" condition="since:0.8">
<title>gtk_clutter_texture_new_from_stock ()</title>
<indexterm zone="gtk-clutter-texture-new-from-stock" role="0.8"><primary>gtk_clutter_texture_new_from_stock</primary></indexterm><programlisting><link linkend="ClutterActor">ClutterActor</link>* gtk_clutter_texture_new_from_stock (<link linkend="GtkWidget">GtkWidget</link> *widget,
const <link linkend="gchar">gchar</link> *stock_id,
<link linkend="GtkIconSize">GtkIconSize</link> size);</programlisting>
<para>
Creates a new <link linkend="ClutterTexture"><type>ClutterTexture</type></link> and sets its contents using the stock
icon <parameter>stock_id</parameter> as rendered by <parameter>widget</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>widget</parameter> :</term>
<listitem><simpara> a <link linkend="GtkWidget"><type>GtkWidget</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>stock_id</parameter> :</term>
<listitem><simpara> the stock id of the icon
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>size</parameter> :</term>
<listitem><simpara> the size of the icon, or -1
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the newly created <link linkend="ClutterTexture"><type>ClutterTexture</type></link>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.8
</para></refsect2>
<refsect2 id="gtk-clutter-texture-new-from-icon-name" role="function" condition="since:0.8">
<title>gtk_clutter_texture_new_from_icon_name ()</title>
<indexterm zone="gtk-clutter-texture-new-from-icon-name" role="0.8"><primary>gtk_clutter_texture_new_from_icon_name</primary></indexterm><programlisting><link linkend="ClutterActor">ClutterActor</link>* gtk_clutter_texture_new_from_icon_name
(<link linkend="GtkWidget">GtkWidget</link> *widget,
const <link linkend="gchar">gchar</link> *icon_name,
<link linkend="GtkIconSize">GtkIconSize</link> size);</programlisting>
<para>
Creates a new <link linkend="ClutterTexture"><type>ClutterTexture</type></link> and sets its contents to be
the <parameter>icon_name</parameter> from the current icon theme.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>widget</parameter> :</term>
<listitem><simpara> a <link linkend="GtkWidget"><type>GtkWidget</type></link> or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>icon_name</parameter> :</term>
<listitem><simpara> the name of the icon
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>size</parameter> :</term>
<listitem><simpara> the size of the icon, or -1
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the newly created texture, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if <parameter>widget</parameter>
was <link linkend="NULL:CAPS"><literal>NULL</literal></link> and <parameter>icon_name</parameter> was not found.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.8
</para></refsect2>
<refsect2 id="gtk-clutter-texture-set-from-pixbuf" role="function" condition="since:0.8">
<title>gtk_clutter_texture_set_from_pixbuf ()</title>
<indexterm zone="gtk-clutter-texture-set-from-pixbuf" role="0.8"><primary>gtk_clutter_texture_set_from_pixbuf</primary></indexterm><programlisting><link linkend="void">void</link> gtk_clutter_texture_set_from_pixbuf (<link linkend="ClutterTexture">ClutterTexture</link> *texture,
<link linkend="GdkPixbuf">GdkPixbuf</link> *pixbuf);</programlisting>
<para>
Sets the contents of <parameter>texture</parameter> with a copy of <parameter>pixbuf</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>texture</parameter> :</term>
<listitem><simpara> a <link linkend="ClutterTexture"><type>ClutterTexture</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>pixbuf</parameter> :</term>
<listitem><simpara> a <link linkend="GdkPixbuf"><type>GdkPixbuf</type></link>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.8
</para></refsect2>
<refsect2 id="gtk-clutter-texture-set-from-stock" role="function" condition="since:0.8">
<title>gtk_clutter_texture_set_from_stock ()</title>
<indexterm zone="gtk-clutter-texture-set-from-stock" role="0.8"><primary>gtk_clutter_texture_set_from_stock</primary></indexterm><programlisting><link linkend="void">void</link> gtk_clutter_texture_set_from_stock (<link linkend="ClutterTexture">ClutterTexture</link> *texture,
<link linkend="GtkWidget">GtkWidget</link> *widget,
const <link linkend="gchar">gchar</link> *stock_id,
<link linkend="GtkIconSize">GtkIconSize</link> size);</programlisting>
<para>
Sets the contents of <parameter>texture</parameter> using the stock icon <parameter>stock_id</parameter>, as
rendered by <parameter>widget</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>texture</parameter> :</term>
<listitem><simpara> a <link linkend="ClutterTexture"><type>ClutterTexture</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>widget</parameter> :</term>
<listitem><simpara> a <link linkend="GtkWidget"><type>GtkWidget</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>stock_id</parameter> :</term>
<listitem><simpara> the stock id of the icon
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>size</parameter> :</term>
<listitem><simpara> the size of the icon, or -1
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.8
</para></refsect2>
<refsect2 id="gtk-clutter-texture-set-from-icon-name" role="function" condition="since:0.8">
<title>gtk_clutter_texture_set_from_icon_name ()</title>
<indexterm zone="gtk-clutter-texture-set-from-icon-name" role="0.8"><primary>gtk_clutter_texture_set_from_icon_name</primary></indexterm><programlisting><link linkend="void">void</link> gtk_clutter_texture_set_from_icon_name
(<link linkend="ClutterTexture">ClutterTexture</link> *texture,
<link linkend="GtkWidget">GtkWidget</link> *widget,
const <link linkend="gchar">gchar</link> *icon_name,
<link linkend="GtkIconSize">GtkIconSize</link> size);</programlisting>
<para>
Sets the contents of <parameter>texture</parameter> using the <parameter>icon_name</parameter> from the
current icon theme.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>texture</parameter> :</term>
<listitem><simpara> a <link linkend="ClutterTexture"><type>ClutterTexture</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>widget</parameter> :</term>
<listitem><simpara> a <link linkend="GtkWidget"><type>GtkWidget</type></link> or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>icon_name</parameter> :</term>
<listitem><simpara> the name of the icon
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>size</parameter> :</term>
<listitem><simpara> the icon size or -1
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.8
</para></refsect2>
</refsect1>
</refentry>
|
