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
|
<?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="ClutterLabel">
<refmeta>
<refentrytitle id="top_of_page">ClutterLabel</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>CLUTTER Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>ClutterLabel</refname>
<refpurpose>Actor for displaying text</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="synopsis">
<title id="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="ClutterLabelPrivate">ClutterLabelPrivate</link>;
<link linkend="ClutterLabel-struct">ClutterLabel</link>;
<link linkend="ClutterActor">ClutterActor</link>* <link linkend="clutter-label-new">clutter_label_new</link> (void);
<link linkend="ClutterActor">ClutterActor</link>* <link linkend="clutter-label-new-with-text">clutter_label_new_with_text</link> (const <link linkend="gchar">gchar</link> *font_name,
const <link linkend="gchar">gchar</link> *text);
<link linkend="void">void</link> <link linkend="clutter-label-set-text">clutter_label_set_text</link> (<link linkend="ClutterLabel">ClutterLabel</link> *label,
const <link linkend="gchar">gchar</link> *text);
const <link linkend="gchar">gchar</link>* <link linkend="clutter-label-get-text">clutter_label_get_text</link> (<link linkend="ClutterLabel">ClutterLabel</link> *label);
<link linkend="void">void</link> <link linkend="clutter-label-set-font-name">clutter_label_set_font_name</link> (<link linkend="ClutterLabel">ClutterLabel</link> *label,
const <link linkend="gchar">gchar</link> *font_name);
const <link linkend="gchar">gchar</link>* <link linkend="clutter-label-get-font-name">clutter_label_get_font_name</link> (<link linkend="ClutterLabel">ClutterLabel</link> *label);
<link linkend="void">void</link> <link linkend="clutter-label-set-color">clutter_label_set_color</link> (<link linkend="ClutterLabel">ClutterLabel</link> *label,
const <link linkend="ClutterColor">ClutterColor</link> *color);
<link linkend="void">void</link> <link linkend="clutter-label-get-color">clutter_label_get_color</link> (<link linkend="ClutterLabel">ClutterLabel</link> *label,
<link linkend="ClutterColor">ClutterColor</link> *color);
<link linkend="void">void</link> <link linkend="clutter-label-set-text-extents">clutter_label_set_text_extents</link> (<link linkend="ClutterLabel">ClutterLabel</link> *label,
<link linkend="gint">gint</link> width,
<link linkend="gint">gint</link> height);
<link linkend="void">void</link> <link linkend="clutter-label-get-text-extents">clutter_label_get_text_extents</link> (<link linkend="ClutterLabel">ClutterLabel</link> *label,
<link linkend="gint">gint</link> *width,
<link linkend="gint">gint</link> *height);
</synopsis>
</refsynopsisdiv>
<refsect1 id="object_hierarchy">
<title id="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----<link linkend="ClutterActor">ClutterActor</link>
+----<link linkend="ClutterTexture">ClutterTexture</link>
+----ClutterLabel
</synopsis>
</refsect1>
<refsect1 id="properties">
<title id="properties.title">Properties</title>
<synopsis>
"<link linkend="ClutterLabel--color">color</link>" <link linkend="ClutterColor">ClutterColor</link> : Read / Write
"<link linkend="ClutterLabel--font-name">font-name</link>" <link linkend="gchararray">gchararray</link> : Read / Write / Construct
"<link linkend="ClutterLabel--text">text</link>" <link linkend="gchararray">gchararray</link> : Read / Write / Construct
</synopsis>
</refsect1>
<refsect1 id="desc">
<title id="desc.title">Description</title>
<para>
<link linkend="ClutterLabel"><type>ClutterLabel</type></link> is a <link linkend="ClutterTexture"><type>ClutterTexture</type></link> that displays text.</para>
<para>
</para>
</refsect1>
<refsect1 id="details">
<title id="details.title">Details</title>
<refsect2>
<title><anchor id="ClutterLabelPrivate" role="struct"/>ClutterLabelPrivate</title>
<indexterm><primary>ClutterLabelPrivate</primary></indexterm><programlisting>typedef struct _ClutterLabelPrivate ClutterLabelPrivate;</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="ClutterLabel-struct" role="struct"/>ClutterLabel</title>
<indexterm><primary>ClutterLabel</primary></indexterm><programlisting>typedef struct _ClutterLabel ClutterLabel;</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="clutter-label-new" role="function"/>clutter_label_new ()</title>
<indexterm><primary>clutter_label_new</primary></indexterm><programlisting><link linkend="ClutterActor">ClutterActor</link>* clutter_label_new (void);</programlisting>
<para>
Creates a new, empty <link linkend="ClutterLabel"><type>ClutterLabel</type></link>.
</para>
<para>
Return: the newly created <link linkend="ClutterLabel"><type>ClutterLabel</type></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="clutter-label-new-with-text" role="function"/>clutter_label_new_with_text ()</title>
<indexterm><primary>clutter_label_new_with_text</primary></indexterm><programlisting><link linkend="ClutterActor">ClutterActor</link>* clutter_label_new_with_text (const <link linkend="gchar">gchar</link> *font_name,
const <link linkend="gchar">gchar</link> *text);</programlisting>
<para>
Creates a new <link linkend="ClutterLabel"><type>ClutterLabel</type></link> displaying <parameter>text</parameter> using <parameter>font_name</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>font_name</parameter> :</term>
<listitem><simpara> the name (and size) of the font to be used
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>text</parameter> :</term>
<listitem><simpara> the text to be displayed
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a <link linkend="ClutterLabel"><type>ClutterLabel</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="clutter-label-set-text" role="function"/>clutter_label_set_text ()</title>
<indexterm><primary>clutter_label_set_text</primary></indexterm><programlisting><link linkend="void">void</link> clutter_label_set_text (<link linkend="ClutterLabel">ClutterLabel</link> *label,
const <link linkend="gchar">gchar</link> *text);</programlisting>
<para>
Sets <parameter>text</parameter> as the text to be displayed by <parameter>label</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>label</parameter> :</term>
<listitem><simpara> a <link linkend="ClutterLabel"><type>ClutterLabel</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>text</parameter> :</term>
<listitem><simpara> the text to be displayed
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="clutter-label-get-text" role="function"/>clutter_label_get_text ()</title>
<indexterm><primary>clutter_label_get_text</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* clutter_label_get_text (<link linkend="ClutterLabel">ClutterLabel</link> *label);</programlisting>
<para>
Retrieves the text displayed by <parameter>label</parameter></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>label</parameter> :</term>
<listitem><simpara> a <link linkend="ClutterLabel"><type>ClutterLabel</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the text of the label. The returned string is
owned by <link linkend="ClutterLabel"><type>ClutterLabel</type></link> and should not be modified or freed.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="clutter-label-set-font-name" role="function"/>clutter_label_set_font_name ()</title>
<indexterm><primary>clutter_label_set_font_name</primary></indexterm><programlisting><link linkend="void">void</link> clutter_label_set_font_name (<link linkend="ClutterLabel">ClutterLabel</link> *label,
const <link linkend="gchar">gchar</link> *font_name);</programlisting>
<para>
Sets <parameter>font_name</parameter> as the font used by <parameter>label</parameter>.
</para>
<para>
<parameter>font_name</parameter> must be a string containing the font name and its
size, similarly to what you would feed to the
<link linkend="pango-font-description-from-string"><function>pango_font_description_from_string()</function></link> function.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>label</parameter> :</term>
<listitem><simpara> a <link linkend="ClutterLabel"><type>ClutterLabel</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>font_name</parameter> :</term>
<listitem><simpara> a font name and size, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> for the default font
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="clutter-label-get-font-name" role="function"/>clutter_label_get_font_name ()</title>
<indexterm><primary>clutter_label_get_font_name</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* clutter_label_get_font_name (<link linkend="ClutterLabel">ClutterLabel</link> *label);</programlisting>
<para>
Retrieves the font used by <parameter>label</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>label</parameter> :</term>
<listitem><simpara> a <link linkend="ClutterLabel"><type>ClutterLabel</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a string containing the font name, in a format
understandable by <link linkend="pango-font-description-from-string"><function>pango_font_description_from_string()</function></link>. The
string is owned by <link linkend="ClutterLabel"><type>ClutterLabel</type></link> and should not be modified
or freed.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="clutter-label-set-color" role="function"/>clutter_label_set_color ()</title>
<indexterm><primary>clutter_label_set_color</primary></indexterm><programlisting><link linkend="void">void</link> clutter_label_set_color (<link linkend="ClutterLabel">ClutterLabel</link> *label,
const <link linkend="ClutterColor">ClutterColor</link> *color);</programlisting>
<para>
Sets the color of <parameter>label</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>label</parameter> :</term>
<listitem><simpara> a <link linkend="ClutterLabel"><type>ClutterLabel</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>color</parameter> :</term>
<listitem><simpara> a <link linkend="ClutterColor"><type>ClutterColor</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="clutter-label-get-color" role="function"/>clutter_label_get_color ()</title>
<indexterm><primary>clutter_label_get_color</primary></indexterm><programlisting><link linkend="void">void</link> clutter_label_get_color (<link linkend="ClutterLabel">ClutterLabel</link> *label,
<link linkend="ClutterColor">ClutterColor</link> *color);</programlisting>
<para>
Retrieves the color of <parameter>label</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>label</parameter> :</term>
<listitem><simpara> a <link linkend="ClutterLabel"><type>ClutterLabel</type></link>
</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></refsect2>
<refsect2>
<title><anchor id="clutter-label-set-text-extents" role="function"/>clutter_label_set_text_extents ()</title>
<indexterm><primary>clutter_label_set_text_extents</primary></indexterm><programlisting><link linkend="void">void</link> clutter_label_set_text_extents (<link linkend="ClutterLabel">ClutterLabel</link> *label,
<link linkend="gint">gint</link> width,
<link linkend="gint">gint</link> height);</programlisting>
<para>
Sets the maximum extents of the label's text.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>label</parameter> :</term>
<listitem><simpara> a <link linkend="ClutterLabel"><type>ClutterLabel</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>width</parameter> :</term>
<listitem><simpara> the width of the text
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>height</parameter> :</term>
<listitem><simpara> the height of the text
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="clutter-label-get-text-extents" role="function"/>clutter_label_get_text_extents ()</title>
<indexterm><primary>clutter_label_get_text_extents</primary></indexterm><programlisting><link linkend="void">void</link> clutter_label_get_text_extents (<link linkend="ClutterLabel">ClutterLabel</link> *label,
<link linkend="gint">gint</link> *width,
<link linkend="gint">gint</link> *height);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>label</parameter> :</term>
<listitem><simpara> a <link linkend="ClutterLabel"><type>ClutterLabel</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>width</parameter> :</term>
<listitem><simpara> return location for the width of the extents or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>height</parameter> :</term>
<listitem><simpara> return location for the height of the extents or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 id="property_details">
<title id="property_details.title">Property Details</title>
<refsect2><title><anchor id="ClutterLabel--color"/>The "<literal>color</literal>" property</title>
<indexterm><primary>ClutterLabel:color</primary></indexterm><programlisting> "color" <link linkend="ClutterColor">ClutterColor</link> : Read / Write</programlisting>
<para>Font Colour.</para></refsect2>
<refsect2><title><anchor id="ClutterLabel--font-name"/>The "<literal>font-name</literal>" property</title>
<indexterm><primary>ClutterLabel:font-name</primary></indexterm><programlisting> "font-name" <link linkend="gchararray">gchararray</link> : Read / Write / Construct</programlisting>
<para>Pango font description.</para><para>Default value: NULL</para>
</refsect2>
<refsect2><title><anchor id="ClutterLabel--text"/>The "<literal>text</literal>" property</title>
<indexterm><primary>ClutterLabel:text</primary></indexterm><programlisting> "text" <link linkend="gchararray">gchararray</link> : Read / Write / Construct</programlisting>
<para>Text to render.</para><para>Default value: NULL</para>
</refsect2>
</refsect1>
</refentry>
|
