← Back to branch summary

~oem-solutions-group/unity-2d/clutter-1.0

« back to all changes in this revision

Viewing changes to doc/reference/clutter/xml/clutter-rectangle.xml

  • Committer: Bazaar Package Importer
  • Author(s): Emilio Pozuelo Monfort
  • Date: 2010-03-21 13:27:56 UTC
  • mto: (2.1.3 experimental)
  • mto: This revision was merged to the branch mainline in revision 8.
  • Revision ID: james.westby@ubuntu.com-20100321132756-nf8yd30yxo3zzwcm
Tags: upstream-1.2.2
Import upstream version 1.2.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/clutter/xml/clutter-rectangle.xml
1
 
<?xml version="1.0"?>
2
 
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3
 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
4
 
<!ENTITY version "1.0.8">
5
 
]>
6
 
 
7
 
<refentry id="ClutterRectangle">
8
 
<refmeta>
9
 
<refentrytitle role="top_of_page" id="ClutterRectangle.top_of_page">ClutterRectangle</refentrytitle>
10
 
<manvolnum>3</manvolnum>
11
 
<refmiscinfo>CLUTTER Library</refmiscinfo>
12
 
</refmeta>
13
 
 
14
 
<refnamediv>
15
 
<refname>ClutterRectangle</refname>
16
 
<refpurpose>An actor that displays a simple rectangle.</refpurpose>
17
 
</refnamediv>
18
 
 
19
 
<refsynopsisdiv id="ClutterRectangle.synopsis" role="synopsis">
20
 
<title role="synopsis.title">Synopsis</title>
21
 
 
22
 
<synopsis>
23
 
                    <link linkend="ClutterRectangle-struct">ClutterRectangle</link>;
24
 
                    <link linkend="ClutterRectangleClass">ClutterRectangleClass</link>;
25
 
<link linkend="ClutterActor">ClutterActor</link> *      <link linkend="clutter-rectangle-new">clutter_rectangle_new</link>               (void);
26
 
<link linkend="ClutterActor">ClutterActor</link> *      <link linkend="clutter-rectangle-new-with-color">clutter_rectangle_new_with_color</link>    (const <link linkend="ClutterColor">ClutterColor</link> *color);
27
 
<link linkend="void">void</link>                <link linkend="clutter-rectangle-get-color">clutter_rectangle_get_color</link>         (<link linkend="ClutterRectangle">ClutterRectangle</link> *rectangle,
28
 
                                                         <link linkend="ClutterColor">ClutterColor</link> *color);
29
 
<link linkend="void">void</link>                <link linkend="clutter-rectangle-set-color">clutter_rectangle_set_color</link>         (<link linkend="ClutterRectangle">ClutterRectangle</link> *rectangle,
30
 
                                                         const <link linkend="ClutterColor">ClutterColor</link> *color);
31
 
<link linkend="void">void</link>                <link linkend="clutter-rectangle-get-border-color">clutter_rectangle_get_border_color</link>  (<link linkend="ClutterRectangle">ClutterRectangle</link> *rectangle,
32
 
                                                         <link linkend="ClutterColor">ClutterColor</link> *color);
33
 
<link linkend="void">void</link>                <link linkend="clutter-rectangle-set-border-color">clutter_rectangle_set_border_color</link>  (<link linkend="ClutterRectangle">ClutterRectangle</link> *rectangle,
34
 
                                                         const <link linkend="ClutterColor">ClutterColor</link> *color);
35
 
<link linkend="guint">guint</link>               <link linkend="clutter-rectangle-get-border-width">clutter_rectangle_get_border_width</link>  (<link linkend="ClutterRectangle">ClutterRectangle</link> *rectangle);
36
 
<link linkend="void">void</link>                <link linkend="clutter-rectangle-set-border-width">clutter_rectangle_set_border_width</link>  (<link linkend="ClutterRectangle">ClutterRectangle</link> *rectangle,
37
 
                                                         <link linkend="guint">guint</link> width);
38
 
</synopsis>
39
 
</refsynopsisdiv>
40
 
 
41
 
<refsect1 id="ClutterRectangle.object-hierarchy" role="object_hierarchy">
42
 
<title role="object_hierarchy.title">Object Hierarchy</title>
43
 
<synopsis>
44
 
  <link linkend="GObject">GObject</link>
45
 
   +----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
46
 
         +----<link linkend="ClutterActor">ClutterActor</link>
47
 
               +----ClutterRectangle
48
 
</synopsis>
49
 
</refsect1>
50
 
 
51
 
 
52
 
 
53
 
<refsect1 id="ClutterRectangle.implemented-interfaces" role="impl_interfaces">
54
 
<title role="impl_interfaces.title">Implemented Interfaces</title>
55
 
<para>
56
 
ClutterRectangle implements
57
 
 <link linkend="ClutterScriptable">ClutterScriptable</link>.</para>
58
 
</refsect1>
59
 
 
60
 
 
61
 
<refsect1 id="ClutterRectangle.properties" role="properties">
62
 
<title role="properties.title">Properties</title>
63
 
<synopsis>
64
 
  &quot;<link linkend="ClutterRectangle--border-color">border-color</link>&quot;             <link linkend="ClutterColor">ClutterColor</link>*         : Read / Write
65
 
  &quot;<link linkend="ClutterRectangle--border-width">border-width</link>&quot;             <link linkend="guint">guint</link>                 : Read / Write
66
 
  &quot;<link linkend="ClutterRectangle--color">color</link>&quot;                    <link linkend="ClutterColor">ClutterColor</link>*         : Read / Write
67
 
  &quot;<link linkend="ClutterRectangle--has-border">has-border</link>&quot;               <link linkend="gboolean">gboolean</link>              : Read / Write
68
 
</synopsis>
69
 
</refsect1>
70
 
 
71
 
 
72
 
 
73
 
<refsect1 id="ClutterRectangle.description" role="desc">
74
 
<title role="desc.title">Description</title>
75
 
<para>
76
 
<link linkend="ClutterRectangle"><type>ClutterRectangle</type></link> is a <link linkend="ClutterActor"><type>ClutterActor</type></link> which draws a simple filled rectangle.</para>
77
 
<para>
78
 
</para>
79
 
</refsect1>
80
 
 
81
 
<refsect1 id="ClutterRectangle.details" role="details">
82
 
<title role="details.title">Details</title>
83
 
<refsect2 id="ClutterRectangle-struct" role="struct">
84
 
<title>ClutterRectangle</title>
85
 
<indexterm zone="ClutterRectangle-struct" role="0.1"><primary sortas="Rectangle">ClutterRectangle</primary></indexterm><programlisting>typedef struct _ClutterRectangle ClutterRectangle;</programlisting>
86
 
<para>
87
 
The <link linkend="ClutterRectangle"><type>ClutterRectangle</type></link> structure contains only private data
88
 
and should be accessed using the provided API</para>
89
 
<para>
90
 
</para><para role="since">Since 0.1</para></refsect2>
91
 
<refsect2 id="ClutterRectangleClass" role="struct" condition="since:0.1">
92
 
<title>ClutterRectangleClass</title>
93
 
<indexterm zone="ClutterRectangleClass" role="0.1"><primary sortas="RectangleClass">ClutterRectangleClass</primary></indexterm><programlisting>typedef struct {
94
 
} ClutterRectangleClass;
95
 
</programlisting>
96
 
<para>
97
 
The <link linkend="ClutterRectangleClass"><type>ClutterRectangleClass</type></link> structure contains only private data</para>
98
 
<para>
99
 
</para><para role="since">Since 0.1</para></refsect2>
100
 
<refsect2 id="clutter-rectangle-new" role="function">
101
 
<title>clutter_rectangle_new ()</title>
102
 
<indexterm zone="clutter-rectangle-new"><primary sortas="rectangle_new">clutter_rectangle_new</primary></indexterm><programlisting><link linkend="ClutterActor">ClutterActor</link> *      clutter_rectangle_new               (void);</programlisting>
103
 
<para>
104
 
Creates a new <link linkend="ClutterActor"><type>ClutterActor</type></link> with a rectangular shape.</para>
105
 
<para>
106
 
</para><variablelist role="params">
107
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="ClutterActor"><type>ClutterActor</type></link>
108
 
</simpara></listitem></varlistentry>
109
 
</variablelist></refsect2>
110
 
<refsect2 id="clutter-rectangle-new-with-color" role="function">
111
 
<title>clutter_rectangle_new_with_color ()</title>
112
 
<indexterm zone="clutter-rectangle-new-with-color"><primary sortas="rectangle_new_with_color">clutter_rectangle_new_with_color</primary></indexterm><programlisting><link linkend="ClutterActor">ClutterActor</link> *      clutter_rectangle_new_with_color    (const <link linkend="ClutterColor">ClutterColor</link> *color);</programlisting>
113
 
<para>
114
 
Creates a new <link linkend="ClutterActor"><type>ClutterActor</type></link> with a rectangular shape
115
 
and of the given <parameter>color</parameter>.</para>
116
 
<para>
117
 
</para><variablelist role="params">
118
 
<varlistentry><term><parameter>color</parameter>&#160;:</term>
119
 
<listitem><simpara> a <link linkend="ClutterColor"><type>ClutterColor</type></link>
120
 
</simpara></listitem></varlistentry>
121
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="ClutterActor"><type>ClutterActor</type></link>
122
 
</simpara></listitem></varlistentry>
123
 
</variablelist></refsect2>
124
 
<refsect2 id="clutter-rectangle-get-color" role="function">
125
 
<title>clutter_rectangle_get_color ()</title>
126
 
<indexterm zone="clutter-rectangle-get-color"><primary sortas="rectangle_get_color">clutter_rectangle_get_color</primary></indexterm><programlisting><link linkend="void">void</link>                clutter_rectangle_get_color         (<link linkend="ClutterRectangle">ClutterRectangle</link> *rectangle,
127
 
                                                         <link linkend="ClutterColor">ClutterColor</link> *color);</programlisting>
128
 
<para>
129
 
Retrieves the color of <parameter>rectangle</parameter>.</para>
130
 
<para>
131
 
</para><variablelist role="params">
132
 
<varlistentry><term><parameter>rectangle</parameter>&#160;:</term>
133
 
<listitem><simpara> a <link linkend="ClutterRectangle"><type>ClutterRectangle</type></link>
134
 
</simpara></listitem></varlistentry>
135
 
<varlistentry><term><parameter>color</parameter>&#160;:</term>
136
 
<listitem><simpara> return location for a <link linkend="ClutterColor"><type>ClutterColor</type></link>
137
 
</simpara></listitem></varlistentry>
138
 
</variablelist></refsect2>
139
 
<refsect2 id="clutter-rectangle-set-color" role="function">
140
 
<title>clutter_rectangle_set_color ()</title>
141
 
<indexterm zone="clutter-rectangle-set-color"><primary sortas="rectangle_set_color">clutter_rectangle_set_color</primary></indexterm><programlisting><link linkend="void">void</link>                clutter_rectangle_set_color         (<link linkend="ClutterRectangle">ClutterRectangle</link> *rectangle,
142
 
                                                         const <link linkend="ClutterColor">ClutterColor</link> *color);</programlisting>
143
 
<para>
144
 
Sets the color of <parameter>rectangle</parameter>.</para>
145
 
<para>
146
 
</para><variablelist role="params">
147
 
<varlistentry><term><parameter>rectangle</parameter>&#160;:</term>
148
 
<listitem><simpara> a <link linkend="ClutterRectangle"><type>ClutterRectangle</type></link>
149
 
</simpara></listitem></varlistentry>
150
 
<varlistentry><term><parameter>color</parameter>&#160;:</term>
151
 
<listitem><simpara> a <link linkend="ClutterColor"><type>ClutterColor</type></link>
152
 
</simpara></listitem></varlistentry>
153
 
</variablelist></refsect2>
154
 
<refsect2 id="clutter-rectangle-get-border-color" role="function" condition="since:0.2">
155
 
<title>clutter_rectangle_get_border_color ()</title>
156
 
<indexterm zone="clutter-rectangle-get-border-color" role="0.2"><primary sortas="rectangle_get_border_color">clutter_rectangle_get_border_color</primary></indexterm><programlisting><link linkend="void">void</link>                clutter_rectangle_get_border_color  (<link linkend="ClutterRectangle">ClutterRectangle</link> *rectangle,
157
 
                                                         <link linkend="ClutterColor">ClutterColor</link> *color);</programlisting>
158
 
<para>
159
 
Gets the color of the border used by <parameter>rectangle</parameter> and places
160
 
it into <parameter>color</parameter>.</para>
161
 
<para>
162
 
</para><variablelist role="params">
163
 
<varlistentry><term><parameter>rectangle</parameter>&#160;:</term>
164
 
<listitem><simpara> a <link linkend="ClutterRectangle"><type>ClutterRectangle</type></link>
165
 
</simpara></listitem></varlistentry>
166
 
<varlistentry><term><parameter>color</parameter>&#160;:</term>
167
 
<listitem><simpara> return location for a <link linkend="ClutterColor"><type>ClutterColor</type></link>
168
 
</simpara></listitem></varlistentry>
169
 
</variablelist><para role="since">Since 0.2</para></refsect2>
170
 
<refsect2 id="clutter-rectangle-set-border-color" role="function">
171
 
<title>clutter_rectangle_set_border_color ()</title>
172
 
<indexterm zone="clutter-rectangle-set-border-color"><primary sortas="rectangle_set_border_color">clutter_rectangle_set_border_color</primary></indexterm><programlisting><link linkend="void">void</link>                clutter_rectangle_set_border_color  (<link linkend="ClutterRectangle">ClutterRectangle</link> *rectangle,
173
 
                                                         const <link linkend="ClutterColor">ClutterColor</link> *color);</programlisting>
174
 
<para>
175
 
Sets the color of the border used by <parameter>rectangle</parameter> using <parameter>color</parameter></para>
176
 
<para>
177
 
</para><variablelist role="params">
178
 
<varlistentry><term><parameter>rectangle</parameter>&#160;:</term>
179
 
<listitem><simpara> a <link linkend="ClutterRectangle"><type>ClutterRectangle</type></link>
180
 
</simpara></listitem></varlistentry>
181
 
<varlistentry><term><parameter>color</parameter>&#160;:</term>
182
 
<listitem><simpara> the color of the border
183
 
</simpara></listitem></varlistentry>
184
 
</variablelist></refsect2>
185
 
<refsect2 id="clutter-rectangle-get-border-width" role="function" condition="since:0.2">
186
 
<title>clutter_rectangle_get_border_width ()</title>
187
 
<indexterm zone="clutter-rectangle-get-border-width" role="0.2"><primary sortas="rectangle_get_border_width">clutter_rectangle_get_border_width</primary></indexterm><programlisting><link linkend="guint">guint</link>               clutter_rectangle_get_border_width  (<link linkend="ClutterRectangle">ClutterRectangle</link> *rectangle);</programlisting>
188
 
<para>
189
 
Gets the width (in pixels) of the border used by <parameter>rectangle</parameter></para>
190
 
<para>
191
 
</para><variablelist role="params">
192
 
<varlistentry><term><parameter>rectangle</parameter>&#160;:</term>
193
 
<listitem><simpara> a <link linkend="ClutterRectangle"><type>ClutterRectangle</type></link>
194
 
</simpara></listitem></varlistentry>
195
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the border's width
196
 
 
197
 
</simpara></listitem></varlistentry>
198
 
</variablelist><para role="since">Since 0.2</para></refsect2>
199
 
<refsect2 id="clutter-rectangle-set-border-width" role="function" condition="since:0.2">
200
 
<title>clutter_rectangle_set_border_width ()</title>
201
 
<indexterm zone="clutter-rectangle-set-border-width" role="0.2"><primary sortas="rectangle_set_border_width">clutter_rectangle_set_border_width</primary></indexterm><programlisting><link linkend="void">void</link>                clutter_rectangle_set_border_width  (<link linkend="ClutterRectangle">ClutterRectangle</link> *rectangle,
202
 
                                                         <link linkend="guint">guint</link> width);</programlisting>
203
 
<para>
204
 
Sets the width (in pixel) of the border used by <parameter>rectangle</parameter>.
205
 
A <parameter>width</parameter> of 0 will unset the border.</para>
206
 
<para>
207
 
</para><variablelist role="params">
208
 
<varlistentry><term><parameter>rectangle</parameter>&#160;:</term>
209
 
<listitem><simpara> a <link linkend="ClutterRectangle"><type>ClutterRectangle</type></link>
210
 
</simpara></listitem></varlistentry>
211
 
<varlistentry><term><parameter>width</parameter>&#160;:</term>
212
 
<listitem><simpara> the width of the border
213
 
</simpara></listitem></varlistentry>
214
 
</variablelist><para role="since">Since 0.2</para></refsect2>
215
 
 
216
 
</refsect1>
217
 
<refsect1 id="ClutterRectangle.property-details" role="property_details">
218
 
<title role="property_details.title">Property Details</title>
219
 
<refsect2 id="ClutterRectangle--border-color" role="property"><title>The <literal>&quot;border-color&quot;</literal> property</title>
220
 
<indexterm zone="ClutterRectangle--border-color" role="0.2"><primary sortas="Rectangle:border-color">ClutterRectangle:border-color</primary></indexterm><programlisting>  &quot;border-color&quot;             <link linkend="ClutterColor">ClutterColor</link>*         : Read / Write</programlisting>
221
 
<para>
222
 
The color of the border of the rectangle.</para>
223
 
<para>
224
 
</para><para>Since 0.2</para>
225
 
</refsect2>
226
 
<refsect2 id="ClutterRectangle--border-width" role="property"><title>The <literal>&quot;border-width&quot;</literal> property</title>
227
 
<indexterm zone="ClutterRectangle--border-width" role="0.2"><primary sortas="Rectangle:border-width">ClutterRectangle:border-width</primary></indexterm><programlisting>  &quot;border-width&quot;             <link linkend="guint">guint</link>                 : Read / Write</programlisting>
228
 
<para>
229
 
The width of the border of the rectangle, in pixels.</para>
230
 
<para>
231
 
</para><para>Default value: 0</para>
232
 
<para>Since 0.2</para>
233
 
</refsect2>
234
 
<refsect2 id="ClutterRectangle--color" role="property"><title>The <literal>&quot;color&quot;</literal> property</title>
235
 
<indexterm zone="ClutterRectangle--color"><primary sortas="Rectangle:color">ClutterRectangle:color</primary></indexterm><programlisting>  &quot;color&quot;                    <link linkend="ClutterColor">ClutterColor</link>*         : Read / Write</programlisting>
236
 
<para>
237
 
The color of the rectangle.</para>
238
 
<para>
239
 
</para></refsect2>
240
 
<refsect2 id="ClutterRectangle--has-border" role="property"><title>The <literal>&quot;has-border&quot;</literal> property</title>
241
 
<indexterm zone="ClutterRectangle--has-border" role="0.2"><primary sortas="Rectangle:has-border">ClutterRectangle:has-border</primary></indexterm><programlisting>  &quot;has-border&quot;               <link linkend="gboolean">gboolean</link>              : Read / Write</programlisting>
242
 
<para>
243
 
Whether the <link linkend="ClutterRectangle"><type>ClutterRectangle</type></link> should be displayed with a border.</para>
244
 
<para>
245
 
</para><para>Default value: FALSE</para>
246
 
<para>Since 0.2</para>
247
 
</refsect2>
248
 
</refsect1>
249
 
 
250
 
 
251
 
 
252
 
 
253
 
</refentry>