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
|
<?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="ClutterRectangle">
<refmeta>
<refentrytitle id="top_of_page">ClutterRectangle</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>CLUTTER Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>ClutterRectangle</refname>
<refpurpose>An actor that displays simple rectangles.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="synopsis">
<title id="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="ClutterRectanglePrivate">ClutterRectanglePrivate</link>;
<link linkend="ClutterRectangle-struct">ClutterRectangle</link>;
<link linkend="ClutterActor">ClutterActor</link>* <link linkend="clutter-rectangle-new">clutter_rectangle_new</link> (void);
<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);
<link linkend="void">void</link> <link linkend="clutter-rectangle-get-color">clutter_rectangle_get_color</link> (<link linkend="ClutterRectangle">ClutterRectangle</link> *rectangle,
<link linkend="ClutterColor">ClutterColor</link> *color);
<link linkend="void">void</link> <link linkend="clutter-rectangle-set-color">clutter_rectangle_set_color</link> (<link linkend="ClutterRectangle">ClutterRectangle</link> *rectangle,
const <link linkend="ClutterColor">ClutterColor</link> *color);
</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>
+----ClutterRectangle
</synopsis>
</refsect1>
<refsect1 id="properties">
<title id="properties.title">Properties</title>
<synopsis>
"<link linkend="ClutterRectangle--color">color</link>" <link linkend="ClutterColor">ClutterColor</link> : Read / Write
</synopsis>
</refsect1>
<refsect1 id="desc">
<title id="desc.title">Description</title>
<para>
<link linkend="ClutterRectangle"><type>ClutterRectangle</type></link> is an Actor which draws simple filled rectangles.</para>
<para>
</para>
</refsect1>
<refsect1 id="details">
<title id="details.title">Details</title>
<refsect2>
<title><anchor id="ClutterRectanglePrivate" role="struct"/>ClutterRectanglePrivate</title>
<indexterm><primary>ClutterRectanglePrivate</primary></indexterm><programlisting>typedef struct _ClutterRectanglePrivate ClutterRectanglePrivate;</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="ClutterRectangle-struct" role="struct"/>ClutterRectangle</title>
<indexterm><primary>ClutterRectangle</primary></indexterm><programlisting>typedef struct _ClutterRectangle ClutterRectangle;</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="clutter-rectangle-new" role="function"/>clutter_rectangle_new ()</title>
<indexterm><primary>clutter_rectangle_new</primary></indexterm><programlisting><link linkend="ClutterActor">ClutterActor</link>* clutter_rectangle_new (void);</programlisting>
<para>
Creates a new <link linkend="ClutterActor"><type>ClutterActor</type></link> with a rectangular shape.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="ClutterActor"><type>ClutterActor</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="clutter-rectangle-new-with-color" role="function"/>clutter_rectangle_new_with_color ()</title>
<indexterm><primary>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>
<para>
Creates a new <link linkend="ClutterActor"><type>ClutterActor</type></link> with a rectangular shape
and with <parameter>color</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>color</parameter> :</term>
<listitem><simpara> a <link linkend="ClutterColor"><type>ClutterColor</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="ClutterActor"><type>ClutterActor</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="clutter-rectangle-get-color" role="function"/>clutter_rectangle_get_color ()</title>
<indexterm><primary>clutter_rectangle_get_color</primary></indexterm><programlisting><link linkend="void">void</link> clutter_rectangle_get_color (<link linkend="ClutterRectangle">ClutterRectangle</link> *rectangle,
<link linkend="ClutterColor">ClutterColor</link> *color);</programlisting>
<para>
Retrieves the color of <parameter>rectangle</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>rectangle</parameter> :</term>
<listitem><simpara> a <link linkend="ClutterRectangle"><type>ClutterRectangle</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-rectangle-set-color" role="function"/>clutter_rectangle_set_color ()</title>
<indexterm><primary>clutter_rectangle_set_color</primary></indexterm><programlisting><link linkend="void">void</link> clutter_rectangle_set_color (<link linkend="ClutterRectangle">ClutterRectangle</link> *rectangle,
const <link linkend="ClutterColor">ClutterColor</link> *color);</programlisting>
<para>
Sets the color of <parameter>rectangle</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>rectangle</parameter> :</term>
<listitem><simpara> a <link linkend="ClutterRectangle"><type>ClutterRectangle</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>
</refsect1>
<refsect1 id="property_details">
<title id="property_details.title">Property Details</title>
<refsect2><title><anchor id="ClutterRectangle--color"/>The "<literal>color</literal>" property</title>
<indexterm><primary>ClutterRectangle:color</primary></indexterm><programlisting> "color" <link linkend="ClutterColor">ClutterColor</link> : Read / Write</programlisting>
<para>The color of the rectangle.</para></refsect2>
</refsect1>
</refentry>
|
