← Back to branch summary

~ubuntu-branches/ubuntu/precise/clutter-1.0/precise

« back to all changes in this revision

Viewing changes to doc/reference/clutter/xml/clutter-behaviour-scale.xml

  • Committer: Bazaar Package Importer
  • Author(s): Emilio Pozuelo Monfort
  • Date: 2010-03-21 13:27:56 UTC
  • mto: (2.1.3 experimental) (1.3.1 upstream)
  • 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-behaviour-scale.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="ClutterBehaviourScale">
8
 
<refmeta>
9
 
<refentrytitle role="top_of_page" id="ClutterBehaviourScale.top_of_page">ClutterBehaviourScale</refentrytitle>
10
 
<manvolnum>3</manvolnum>
11
 
<refmiscinfo>CLUTTER Library</refmiscinfo>
12
 
</refmeta>
13
 
 
14
 
<refnamediv>
15
 
<refname>ClutterBehaviourScale</refname>
16
 
<refpurpose>A behaviour controlling scale</refpurpose>
17
 
</refnamediv>
18
 
 
19
 
<refsynopsisdiv id="ClutterBehaviourScale.synopsis" role="synopsis">
20
 
<title role="synopsis.title">Synopsis</title>
21
 
 
22
 
<synopsis>
23
 
enum                <link linkend="ClutterGravity">ClutterGravity</link>;
24
 
                    <link linkend="ClutterBehaviourScale-struct">ClutterBehaviourScale</link>;
25
 
                    <link linkend="ClutterBehaviourScaleClass">ClutterBehaviourScaleClass</link>;
26
 
<link linkend="ClutterBehaviour">ClutterBehaviour</link> *  <link linkend="clutter-behaviour-scale-new">clutter_behaviour_scale_new</link>         (<link linkend="ClutterAlpha">ClutterAlpha</link> *alpha,
27
 
                                                         <link linkend="gdouble">gdouble</link> x_scale_start,
28
 
                                                         <link linkend="gdouble">gdouble</link> y_scale_start,
29
 
                                                         <link linkend="gdouble">gdouble</link> x_scale_end,
30
 
                                                         <link linkend="gdouble">gdouble</link> y_scale_end);
31
 
<link linkend="void">void</link>                <link linkend="clutter-behaviour-scale-set-bounds">clutter_behaviour_scale_set_bounds</link>  (<link linkend="ClutterBehaviourScale">ClutterBehaviourScale</link> *scale,
32
 
                                                         <link linkend="gdouble">gdouble</link> x_scale_start,
33
 
                                                         <link linkend="gdouble">gdouble</link> y_scale_start,
34
 
                                                         <link linkend="gdouble">gdouble</link> x_scale_end,
35
 
                                                         <link linkend="gdouble">gdouble</link> y_scale_end);
36
 
<link linkend="void">void</link>                <link linkend="clutter-behaviour-scale-get-bounds">clutter_behaviour_scale_get_bounds</link>  (<link linkend="ClutterBehaviourScale">ClutterBehaviourScale</link> *scale,
37
 
                                                         <link linkend="gdouble">gdouble</link> *x_scale_start,
38
 
                                                         <link linkend="gdouble">gdouble</link> *y_scale_start,
39
 
                                                         <link linkend="gdouble">gdouble</link> *x_scale_end,
40
 
                                                         <link linkend="gdouble">gdouble</link> *y_scale_end);
41
 
</synopsis>
42
 
</refsynopsisdiv>
43
 
 
44
 
<refsect1 id="ClutterBehaviourScale.object-hierarchy" role="object_hierarchy">
45
 
<title role="object_hierarchy.title">Object Hierarchy</title>
46
 
<synopsis>
47
 
  <link linkend="GObject">GObject</link>
48
 
   +----<link linkend="ClutterBehaviour">ClutterBehaviour</link>
49
 
         +----ClutterBehaviourScale
50
 
</synopsis>
51
 
</refsect1>
52
 
 
53
 
 
54
 
 
55
 
 
56
 
 
57
 
<refsect1 id="ClutterBehaviourScale.properties" role="properties">
58
 
<title role="properties.title">Properties</title>
59
 
<synopsis>
60
 
  &quot;<link linkend="ClutterBehaviourScale--x-scale-end">x-scale-end</link>&quot;              <link linkend="gdouble">gdouble</link>               : Read / Write
61
 
  &quot;<link linkend="ClutterBehaviourScale--x-scale-start">x-scale-start</link>&quot;            <link linkend="gdouble">gdouble</link>               : Read / Write
62
 
  &quot;<link linkend="ClutterBehaviourScale--y-scale-end">y-scale-end</link>&quot;              <link linkend="gdouble">gdouble</link>               : Read / Write
63
 
  &quot;<link linkend="ClutterBehaviourScale--y-scale-start">y-scale-start</link>&quot;            <link linkend="gdouble">gdouble</link>               : Read / Write
64
 
</synopsis>
65
 
</refsect1>
66
 
 
67
 
 
68
 
 
69
 
<refsect1 id="ClutterBehaviourScale.description" role="desc">
70
 
<title role="desc.title">Description</title>
71
 
<para>
72
 
A <link linkend="ClutterBehaviourScale"><type>ClutterBehaviourScale</type></link> interpolates actors size between two values.</para>
73
 
<para>
74
 
</para>
75
 
</refsect1>
76
 
 
77
 
<refsect1 id="ClutterBehaviourScale.details" role="details">
78
 
<title role="details.title">Details</title>
79
 
<refsect2 id="ClutterGravity" role="enum" condition="since:0.2">
80
 
<title>enum ClutterGravity</title>
81
 
<indexterm zone="ClutterGravity" role="0.2"><primary sortas="Gravity">ClutterGravity</primary></indexterm><programlisting>typedef enum { /*&lt; prefix=CLUTTER_GRAVITY &gt;*/
82
 
  CLUTTER_GRAVITY_NONE       = 0,
83
 
  CLUTTER_GRAVITY_NORTH,
84
 
  CLUTTER_GRAVITY_NORTH_EAST,
85
 
  CLUTTER_GRAVITY_EAST,
86
 
  CLUTTER_GRAVITY_SOUTH_EAST,
87
 
  CLUTTER_GRAVITY_SOUTH,
88
 
  CLUTTER_GRAVITY_SOUTH_WEST,
89
 
  CLUTTER_GRAVITY_WEST,
90
 
  CLUTTER_GRAVITY_NORTH_WEST,
91
 
  CLUTTER_GRAVITY_CENTER
92
 
} ClutterGravity;
93
 
</programlisting>
94
 
<para>
95
 
Gravity of the scaling operations. When a gravity different than
96
 
<link linkend="CLUTTER-GRAVITY-NONE--CAPS"><literal>CLUTTER_GRAVITY_NONE</literal></link> is used, an actor is scaled keeping the position
97
 
of the specified portion at the same coordinates.</para>
98
 
<para>
99
 
</para><variablelist role="enum">
100
 
<varlistentry id="CLUTTER-GRAVITY-NONE--CAPS" role="constant">
101
 
<term><literal>CLUTTER_GRAVITY_NONE</literal></term>
102
 
<listitem><simpara> Do not apply any gravity
103
 
</simpara></listitem>
104
 
</varlistentry>
105
 
<varlistentry id="CLUTTER-GRAVITY-NORTH--CAPS" role="constant">
106
 
<term><literal>CLUTTER_GRAVITY_NORTH</literal></term>
107
 
<listitem><simpara> Scale from topmost downwards
108
 
</simpara></listitem>
109
 
</varlistentry>
110
 
<varlistentry id="CLUTTER-GRAVITY-NORTH-EAST--CAPS" role="constant">
111
 
<term><literal>CLUTTER_GRAVITY_NORTH_EAST</literal></term>
112
 
<listitem><simpara> Scale from the top right corner
113
 
</simpara></listitem>
114
 
</varlistentry>
115
 
<varlistentry id="CLUTTER-GRAVITY-EAST--CAPS" role="constant">
116
 
<term><literal>CLUTTER_GRAVITY_EAST</literal></term>
117
 
<listitem><simpara> Scale from the right side
118
 
</simpara></listitem>
119
 
</varlistentry>
120
 
<varlistentry id="CLUTTER-GRAVITY-SOUTH-EAST--CAPS" role="constant">
121
 
<term><literal>CLUTTER_GRAVITY_SOUTH_EAST</literal></term>
122
 
<listitem><simpara> Scale from the bottom right corner
123
 
</simpara></listitem>
124
 
</varlistentry>
125
 
<varlistentry id="CLUTTER-GRAVITY-SOUTH--CAPS" role="constant">
126
 
<term><literal>CLUTTER_GRAVITY_SOUTH</literal></term>
127
 
<listitem><simpara> Scale from the bottom upwards
128
 
</simpara></listitem>
129
 
</varlistentry>
130
 
<varlistentry id="CLUTTER-GRAVITY-SOUTH-WEST--CAPS" role="constant">
131
 
<term><literal>CLUTTER_GRAVITY_SOUTH_WEST</literal></term>
132
 
<listitem><simpara> Scale from the bottom left corner
133
 
</simpara></listitem>
134
 
</varlistentry>
135
 
<varlistentry id="CLUTTER-GRAVITY-WEST--CAPS" role="constant">
136
 
<term><literal>CLUTTER_GRAVITY_WEST</literal></term>
137
 
<listitem><simpara> Scale from the left side
138
 
</simpara></listitem>
139
 
</varlistentry>
140
 
<varlistentry id="CLUTTER-GRAVITY-NORTH-WEST--CAPS" role="constant">
141
 
<term><literal>CLUTTER_GRAVITY_NORTH_WEST</literal></term>
142
 
<listitem><simpara> Scale from the top left corner
143
 
</simpara></listitem>
144
 
</varlistentry>
145
 
<varlistentry id="CLUTTER-GRAVITY-CENTER--CAPS" role="constant">
146
 
<term><literal>CLUTTER_GRAVITY_CENTER</literal></term>
147
 
<listitem><simpara> Scale from the center.
148
 
</simpara></listitem>
149
 
</varlistentry>
150
 
</variablelist><para role="since">Since 0.2</para></refsect2>
151
 
<refsect2 id="ClutterBehaviourScale-struct" role="struct">
152
 
<title>ClutterBehaviourScale</title>
153
 
<indexterm zone="ClutterBehaviourScale-struct" role="0.2"><primary sortas="BehaviourScale">ClutterBehaviourScale</primary></indexterm><programlisting>typedef struct _ClutterBehaviourScale ClutterBehaviourScale;</programlisting>
154
 
<para>
155
 
The <link linkend="ClutterBehaviourScale"><type>ClutterBehaviourScale</type></link> struct contains only private data and
156
 
should be accessed using the provided API</para>
157
 
<para>
158
 
</para><para role="since">Since 0.2</para></refsect2>
159
 
<refsect2 id="ClutterBehaviourScaleClass" role="struct" condition="since:0.2">
160
 
<title>ClutterBehaviourScaleClass</title>
161
 
<indexterm zone="ClutterBehaviourScaleClass" role="0.2"><primary sortas="BehaviourScaleClass">ClutterBehaviourScaleClass</primary></indexterm><programlisting>typedef struct {
162
 
} ClutterBehaviourScaleClass;
163
 
</programlisting>
164
 
<para>
165
 
The <link linkend="ClutterBehaviourScaleClass"><type>ClutterBehaviourScaleClass</type></link> struct contains only private data</para>
166
 
<para>
167
 
</para><para role="since">Since 0.2</para></refsect2>
168
 
<refsect2 id="clutter-behaviour-scale-new" role="function" condition="since:0.2">
169
 
<title>clutter_behaviour_scale_new ()</title>
170
 
<indexterm zone="clutter-behaviour-scale-new" role="0.2"><primary sortas="behaviour_scale_new">clutter_behaviour_scale_new</primary></indexterm><programlisting><link linkend="ClutterBehaviour">ClutterBehaviour</link> *  clutter_behaviour_scale_new         (<link linkend="ClutterAlpha">ClutterAlpha</link> *alpha,
171
 
                                                         <link linkend="gdouble">gdouble</link> x_scale_start,
172
 
                                                         <link linkend="gdouble">gdouble</link> y_scale_start,
173
 
                                                         <link linkend="gdouble">gdouble</link> x_scale_end,
174
 
                                                         <link linkend="gdouble">gdouble</link> y_scale_end);</programlisting>
175
 
<para>
176
 
Creates a new  <link linkend="ClutterBehaviourScale"><type>ClutterBehaviourScale</type></link> instance.</para>
177
 
<para>
178
 
</para><variablelist role="params">
179
 
<varlistentry><term><parameter>alpha</parameter>&#160;:</term>
180
 
<listitem><simpara> a <link linkend="ClutterAlpha"><type>ClutterAlpha</type></link>
181
 
</simpara></listitem></varlistentry>
182
 
<varlistentry><term><parameter>x_scale_start</parameter>&#160;:</term>
183
 
<listitem><simpara> initial scale factor on the X axis
184
 
</simpara></listitem></varlistentry>
185
 
<varlistentry><term><parameter>y_scale_start</parameter>&#160;:</term>
186
 
<listitem><simpara> initial scale factor on the Y axis
187
 
</simpara></listitem></varlistentry>
188
 
<varlistentry><term><parameter>x_scale_end</parameter>&#160;:</term>
189
 
<listitem><simpara> final scale factor on the X axis
190
 
</simpara></listitem></varlistentry>
191
 
<varlistentry><term><parameter>y_scale_end</parameter>&#160;:</term>
192
 
<listitem><simpara> final scale factor on the Y axis
193
 
</simpara></listitem></varlistentry>
194
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the newly created <link linkend="ClutterBehaviourScale"><type>ClutterBehaviourScale</type></link>
195
 
 
196
 
</simpara></listitem></varlistentry>
197
 
</variablelist><para role="since">Since 0.2</para></refsect2>
198
 
<refsect2 id="clutter-behaviour-scale-set-bounds" role="function" condition="since:0.6">
199
 
<title>clutter_behaviour_scale_set_bounds ()</title>
200
 
<indexterm zone="clutter-behaviour-scale-set-bounds" role="0.6"><primary sortas="behaviour_scale_set_bounds">clutter_behaviour_scale_set_bounds</primary></indexterm><programlisting><link linkend="void">void</link>                clutter_behaviour_scale_set_bounds  (<link linkend="ClutterBehaviourScale">ClutterBehaviourScale</link> *scale,
201
 
                                                         <link linkend="gdouble">gdouble</link> x_scale_start,
202
 
                                                         <link linkend="gdouble">gdouble</link> y_scale_start,
203
 
                                                         <link linkend="gdouble">gdouble</link> x_scale_end,
204
 
                                                         <link linkend="gdouble">gdouble</link> y_scale_end);</programlisting>
205
 
<para>
206
 
Sets the bounds used by scale behaviour.</para>
207
 
<para>
208
 
</para><variablelist role="params">
209
 
<varlistentry><term><parameter>scale</parameter>&#160;:</term>
210
 
<listitem><simpara> a <link linkend="ClutterBehaviourScale"><type>ClutterBehaviourScale</type></link>
211
 
</simpara></listitem></varlistentry>
212
 
<varlistentry><term><parameter>x_scale_start</parameter>&#160;:</term>
213
 
<listitem><simpara> initial scale factor on the X axis
214
 
</simpara></listitem></varlistentry>
215
 
<varlistentry><term><parameter>y_scale_start</parameter>&#160;:</term>
216
 
<listitem><simpara> initial scale factor on the Y axis
217
 
</simpara></listitem></varlistentry>
218
 
<varlistentry><term><parameter>x_scale_end</parameter>&#160;:</term>
219
 
<listitem><simpara> final scale factor on the X axis
220
 
</simpara></listitem></varlistentry>
221
 
<varlistentry><term><parameter>y_scale_end</parameter>&#160;:</term>
222
 
<listitem><simpara> final scale factor on the Y axis
223
 
</simpara></listitem></varlistentry>
224
 
</variablelist><para role="since">Since 0.6</para></refsect2>
225
 
<refsect2 id="clutter-behaviour-scale-get-bounds" role="function" condition="since:0.4">
226
 
<title>clutter_behaviour_scale_get_bounds ()</title>
227
 
<indexterm zone="clutter-behaviour-scale-get-bounds" role="0.4"><primary sortas="behaviour_scale_get_bounds">clutter_behaviour_scale_get_bounds</primary></indexterm><programlisting><link linkend="void">void</link>                clutter_behaviour_scale_get_bounds  (<link linkend="ClutterBehaviourScale">ClutterBehaviourScale</link> *scale,
228
 
                                                         <link linkend="gdouble">gdouble</link> *x_scale_start,
229
 
                                                         <link linkend="gdouble">gdouble</link> *y_scale_start,
230
 
                                                         <link linkend="gdouble">gdouble</link> *x_scale_end,
231
 
                                                         <link linkend="gdouble">gdouble</link> *y_scale_end);</programlisting>
232
 
<para>
233
 
Retrieves the bounds used by scale behaviour.</para>
234
 
<para>
235
 
</para><variablelist role="params">
236
 
<varlistentry><term><parameter>scale</parameter>&#160;:</term>
237
 
<listitem><simpara> a <link linkend="ClutterBehaviourScale"><type>ClutterBehaviourScale</type></link>
238
 
</simpara></listitem></varlistentry>
239
 
<varlistentry><term><parameter>x_scale_start</parameter>&#160;:</term>
240
 
<listitem><simpara> return location for the initial scale factor on the X
241
 
  axis, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
242
 
</simpara></listitem></varlistentry>
243
 
<varlistentry><term><parameter>y_scale_start</parameter>&#160;:</term>
244
 
<listitem><simpara> return location for the initial scale factor on the Y
245
 
  axis, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
246
 
</simpara></listitem></varlistentry>
247
 
<varlistentry><term><parameter>x_scale_end</parameter>&#160;:</term>
248
 
<listitem><simpara> return location for the final scale factor on the X axis,
249
 
  or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
250
 
</simpara></listitem></varlistentry>
251
 
<varlistentry><term><parameter>y_scale_end</parameter>&#160;:</term>
252
 
<listitem><simpara> return location for the final scale factor on the Y axis,
253
 
  or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
254
 
</simpara></listitem></varlistentry>
255
 
</variablelist><para role="since">Since 0.4</para></refsect2>
256
 
 
257
 
</refsect1>
258
 
<refsect1 id="ClutterBehaviourScale.property-details" role="property_details">
259
 
<title role="property_details.title">Property Details</title>
260
 
<refsect2 id="ClutterBehaviourScale--x-scale-end" role="property"><title>The <literal>&quot;x-scale-end&quot;</literal> property</title>
261
 
<indexterm zone="ClutterBehaviourScale--x-scale-end" role="0.6"><primary sortas="BehaviourScale:x-scale-end">ClutterBehaviourScale:x-scale-end</primary></indexterm><programlisting>  &quot;x-scale-end&quot;              <link linkend="gdouble">gdouble</link>               : Read / Write</programlisting>
262
 
<para>
263
 
The final scaling factor on the X axis for the actors.</para>
264
 
<para>
265
 
</para><para>Allowed values: &gt;= 0</para>
266
 
<para>Default value: 1</para>
267
 
<para>Since 0.6</para>
268
 
</refsect2>
269
 
<refsect2 id="ClutterBehaviourScale--x-scale-start" role="property"><title>The <literal>&quot;x-scale-start&quot;</literal> property</title>
270
 
<indexterm zone="ClutterBehaviourScale--x-scale-start" role="0.6"><primary sortas="BehaviourScale:x-scale-start">ClutterBehaviourScale:x-scale-start</primary></indexterm><programlisting>  &quot;x-scale-start&quot;            <link linkend="gdouble">gdouble</link>               : Read / Write</programlisting>
271
 
<para>
272
 
The initial scaling factor on the X axis for the actors.</para>
273
 
<para>
274
 
</para><para>Allowed values: &gt;= 0</para>
275
 
<para>Default value: 1</para>
276
 
<para>Since 0.6</para>
277
 
</refsect2>
278
 
<refsect2 id="ClutterBehaviourScale--y-scale-end" role="property"><title>The <literal>&quot;y-scale-end&quot;</literal> property</title>
279
 
<indexterm zone="ClutterBehaviourScale--y-scale-end" role="0.6"><primary sortas="BehaviourScale:y-scale-end">ClutterBehaviourScale:y-scale-end</primary></indexterm><programlisting>  &quot;y-scale-end&quot;              <link linkend="gdouble">gdouble</link>               : Read / Write</programlisting>
280
 
<para>
281
 
The final scaling factor on the Y axis for the actors.</para>
282
 
<para>
283
 
</para><para>Allowed values: &gt;= 0</para>
284
 
<para>Default value: 1</para>
285
 
<para>Since 0.6</para>
286
 
</refsect2>
287
 
<refsect2 id="ClutterBehaviourScale--y-scale-start" role="property"><title>The <literal>&quot;y-scale-start&quot;</literal> property</title>
288
 
<indexterm zone="ClutterBehaviourScale--y-scale-start" role="0.6"><primary sortas="BehaviourScale:y-scale-start">ClutterBehaviourScale:y-scale-start</primary></indexterm><programlisting>  &quot;y-scale-start&quot;            <link linkend="gdouble">gdouble</link>               : Read / Write</programlisting>
289
 
<para>
290
 
The initial scaling factor on the Y axis for the actors.</para>
291
 
<para>
292
 
</para><para>Allowed values: &gt;= 0</para>
293
 
<para>Default value: 1</para>
294
 
<para>Since 0.6</para>
295
 
</refsect2>
296
 
</refsect1>
297
 
 
298
 
 
299
 
 
300
 
 
301
 
</refentry>