← 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/html/clutter-Unit-conversion.html

  • 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/html/clutter-Unit-conversion.html
5
5
<title>Unit conversion</title>
6
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7
7
<link rel="home" href="index.html" title="Clutter Reference Manual">
8
 
<link rel="up" href="ch07.html" title="General purpose API">
9
 
<link rel="prev" href="ClutterShader.html" title="ClutterShader">
 
8
<link rel="up" href="ch08.html" title="General purpose API">
 
9
<link rel="prev" href="ClutterDeviceManager.html" title="ClutterDeviceManager">
10
10
<link rel="next" href="clutter-Utilities.html" title="Utilities">
11
 
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.13 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
<link rel="part" href="clutter-overview.html" title="Part I. Overview">
14
14
<link rel="part" href="building-clutter.html" title="Part II. Building Clutter">
17
17
<link rel="chapter" href="ch01.html" title="Abstract classes and interfaces">
18
18
<link rel="chapter" href="ch02.html" title="Base actors">
19
19
<link rel="chapter" href="ch03.html" title="Container actors">
 
20
<link rel="chapter" href="ch04.html" title="Layout managers">
20
21
<link rel="part" href="clutteranimation.html" title="Part V. Clutter Animation Framework">
21
 
<link rel="chapter" href="ch04.html" title="Base classes">
22
 
<link rel="chapter" href="ch05.html" title="Behaviours">
23
 
<link rel="chapter" href="ch06.html" title="High Level API">
 
22
<link rel="chapter" href="ch05.html" title="Base classes">
 
23
<link rel="chapter" href="ch06.html" title="Behaviours">
 
24
<link rel="chapter" href="ch07.html" title="High Level API">
24
25
<link rel="part" href="cluttertools.html" title="Part VI. Clutter Tools">
25
 
<link rel="chapter" href="ch07.html" title="General purpose API">
26
 
<link rel="chapter" href="ch08.html" title="User interface definition">
27
 
<link rel="chapter" href="ch09.html" title="Generic list model">
 
26
<link rel="chapter" href="ch08.html" title="General purpose API">
 
27
<link rel="chapter" href="ch09.html" title="User interface definition">
 
28
<link rel="chapter" href="ch10.html" title="Generic list model">
28
29
<link rel="part" href="clutterbackends.html" title="Part VII. Clutter Backends">
29
30
<link rel="part" href="additionaldocs.html" title="Part VIII. Additional Documentation">
30
31
<link rel="chapter" href="clutter-subclassing-ClutterActor.html" title="Implementing a new actor">
47
48
<link rel="index" href="ix05.html" title="Index of new symbols in 0.6">
48
49
<link rel="index" href="ix06.html" title="Index of new symbols in 0.8">
49
50
<link rel="index" href="ix07.html" title="Index of new symbols in 1.0">
 
51
<link rel="index" href="ix08.html" title="Index of new symbols in 1.2">
50
52
<link rel="appendix" href="license.html" title="Appendix A. License">
51
53
</head>
52
54
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
53
55
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
54
56
<tr valign="middle">
55
 
<td><a accesskey="p" href="ClutterShader.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
56
 
<td><a accesskey="u" href="ch07.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
57
<td><a accesskey="p" href="ClutterDeviceManager.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
58
<td><a accesskey="u" href="ch08.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
57
59
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
58
60
<th width="100%" align="center">Clutter Reference Manual</th>
59
61
<td><a accesskey="n" href="clutter-Utilities.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
60
62
</tr>
61
63
<tr><td colspan="5" class="shortcuts">
62
64
<a href="#clutter-Unit-conversion.synopsis" class="shortcut">Top</a>
63
 
                 | 
64
 
                <a href="#clutter-Unit-conversion.description" class="shortcut">Description</a>
 
65
                   | 
 
66
                  <a href="#clutter-Unit-conversion.description" class="shortcut">Description</a>
65
67
</td></tr>
66
68
</table>
67
69
<div class="refentry" title="Unit conversion">
75
77
</tr></table></div>
76
78
<div class="refsynopsisdiv" title="Synopsis">
77
79
<a name="clutter-Unit-conversion.synopsis"></a><h2>Synopsis</h2>
78
 
<pre class="synopsis">
79
 
enum                <a class="link" href="clutter-Unit-conversion.html#ClutterUnitType" title="enum ClutterUnitType">ClutterUnitType</a>;
 
80
<pre class="synopsis">enum                <a class="link" href="clutter-Unit-conversion.html#ClutterUnitType" title="enum ClutterUnitType">ClutterUnitType</a>;
80
81
                    <a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits">ClutterUnits</a>;
81
 
void                <a class="link" href="clutter-Unit-conversion.html#clutter-units-from-mm" title="clutter_units_from_mm ()">clutter_units_from_mm</a>               (<a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits">ClutterUnits</a> *units,
82
 
                                                         <a
83
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"
84
 
>gfloat</a> mm);
85
 
void                <a class="link" href="clutter-Unit-conversion.html#clutter-units-from-pt" title="clutter_units_from_pt ()">clutter_units_from_pt</a>               (<a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits">ClutterUnits</a> *units,
86
 
                                                         <a
87
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"
88
 
>gfloat</a> pt);
89
 
void                <a class="link" href="clutter-Unit-conversion.html#clutter-units-from-em" title="clutter_units_from_em ()">clutter_units_from_em</a>               (<a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits">ClutterUnits</a> *units,
90
 
                                                         <a
91
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"
92
 
>gfloat</a> em);
93
 
void                <a class="link" href="clutter-Unit-conversion.html#clutter-units-from-em-for-font" title="clutter_units_from_em_for_font ()">clutter_units_from_em_for_font</a>      (<a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits">ClutterUnits</a> *units,
94
 
                                                         const <a
95
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
96
 
>gchar</a> *font_name,
97
 
                                                         <a
98
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"
99
 
>gfloat</a> em);
100
 
void                <a class="link" href="clutter-Unit-conversion.html#clutter-units-from-pixels" title="clutter_units_from_pixels ()">clutter_units_from_pixels</a>           (<a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits">ClutterUnits</a> *units,
101
 
                                                         <a
102
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
103
 
>gint</a> px);
104
 
<a
105
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"
106
 
>gfloat</a>              <a class="link" href="clutter-Unit-conversion.html#clutter-units-to-pixels" title="clutter_units_to_pixels ()">clutter_units_to_pixels</a>             (<a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits">ClutterUnits</a> *units);
107
 
<a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits">ClutterUnits</a> *      <a class="link" href="clutter-Unit-conversion.html#clutter-units-copy" title="clutter_units_copy ()">clutter_units_copy</a>                  (const <a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits">ClutterUnits</a> *units);
108
 
void                <a class="link" href="clutter-Unit-conversion.html#clutter-units-free" title="clutter_units_free ()">clutter_units_free</a>                  (<a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits">ClutterUnits</a> *units);
109
 
<a class="link" href="clutter-Unit-conversion.html#ClutterUnitType" title="enum ClutterUnitType">ClutterUnitType</a>     <a class="link" href="clutter-Unit-conversion.html#clutter-units-get-unit-type" title="clutter_units_get_unit_type ()">clutter_units_get_unit_type</a>         (const <a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits">ClutterUnits</a> *units);
110
 
<a
111
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"
112
 
>gfloat</a>              <a class="link" href="clutter-Unit-conversion.html#clutter-units-get-unit-value" title="clutter_units_get_unit_value ()">clutter_units_get_unit_value</a>        (const <a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits">ClutterUnits</a> *units);
113
 
<a
114
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
115
 
>gboolean</a>            <a class="link" href="clutter-Unit-conversion.html#clutter-units-from-string" title="clutter_units_from_string ()">clutter_units_from_string</a>           (<a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits">ClutterUnits</a> *units,
116
 
                                                         const <a
117
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
118
 
>gchar</a> *str);
119
 
<a
120
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
121
 
>gchar</a> *             <a class="link" href="clutter-Unit-conversion.html#clutter-units-to-string" title="clutter_units_to_string ()">clutter_units_to_string</a>             (const <a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits">ClutterUnits</a> *units);
 
82
<span class="returnvalue">void</span>                <a class="link" href="clutter-Unit-conversion.html#clutter-units-from-cm" title="clutter_units_from_cm ()">clutter_units_from_cm</a>               (<a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits"><span class="returnvalue">ClutterUnits</span></a> *units,
 
83
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="returnvalue">gfloat</span></a> cm);
 
84
<span class="returnvalue">void</span>                <a class="link" href="clutter-Unit-conversion.html#clutter-units-from-em" title="clutter_units_from_em ()">clutter_units_from_em</a>               (<a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits"><span class="returnvalue">ClutterUnits</span></a> *units,
 
85
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="returnvalue">gfloat</span></a> em);
 
86
<span class="returnvalue">void</span>                <a class="link" href="clutter-Unit-conversion.html#clutter-units-from-em-for-font" title="clutter_units_from_em_for_font ()">clutter_units_from_em_for_font</a>      (<a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits"><span class="returnvalue">ClutterUnits</span></a> *units,
 
87
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *font_name,
 
88
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="returnvalue">gfloat</span></a> em);
 
89
<span class="returnvalue">void</span>                <a class="link" href="clutter-Unit-conversion.html#clutter-units-from-mm" title="clutter_units_from_mm ()">clutter_units_from_mm</a>               (<a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits"><span class="returnvalue">ClutterUnits</span></a> *units,
 
90
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="returnvalue">gfloat</span></a> mm);
 
91
<span class="returnvalue">void</span>                <a class="link" href="clutter-Unit-conversion.html#clutter-units-from-pixels" title="clutter_units_from_pixels ()">clutter_units_from_pixels</a>           (<a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits"><span class="returnvalue">ClutterUnits</span></a> *units,
 
92
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> px);
 
93
<span class="returnvalue">void</span>                <a class="link" href="clutter-Unit-conversion.html#clutter-units-from-pt" title="clutter_units_from_pt ()">clutter_units_from_pt</a>               (<a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits"><span class="returnvalue">ClutterUnits</span></a> *units,
 
94
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="returnvalue">gfloat</span></a> pt);
 
95
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="returnvalue">gfloat</span></a>              <a class="link" href="clutter-Unit-conversion.html#clutter-units-to-pixels" title="clutter_units_to_pixels ()">clutter_units_to_pixels</a>             (<a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits"><span class="returnvalue">ClutterUnits</span></a> *units);
 
96
<a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits"><span class="returnvalue">ClutterUnits</span></a> *      <a class="link" href="clutter-Unit-conversion.html#clutter-units-copy" title="clutter_units_copy ()">clutter_units_copy</a>                  (const <a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits"><span class="returnvalue">ClutterUnits</span></a> *units);
 
97
<span class="returnvalue">void</span>                <a class="link" href="clutter-Unit-conversion.html#clutter-units-free" title="clutter_units_free ()">clutter_units_free</a>                  (<a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits"><span class="returnvalue">ClutterUnits</span></a> *units);
 
98
<a class="link" href="clutter-Unit-conversion.html#ClutterUnitType" title="enum ClutterUnitType"><span class="returnvalue">ClutterUnitType</span></a>     <a class="link" href="clutter-Unit-conversion.html#clutter-units-get-unit-type" title="clutter_units_get_unit_type ()">clutter_units_get_unit_type</a>         (const <a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits"><span class="returnvalue">ClutterUnits</span></a> *units);
 
99
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="returnvalue">gfloat</span></a>              <a class="link" href="clutter-Unit-conversion.html#clutter-units-get-unit-value" title="clutter_units_get_unit_value ()">clutter_units_get_unit_value</a>        (const <a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits"><span class="returnvalue">ClutterUnits</span></a> *units);
 
100
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="clutter-Unit-conversion.html#clutter-units-from-string" title="clutter_units_from_string ()">clutter_units_from_string</a>           (<a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits"><span class="returnvalue">ClutterUnits</span></a> *units,
 
101
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *str);
 
102
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             <a class="link" href="clutter-Unit-conversion.html#clutter-units-to-string" title="clutter_units_to_string ()">clutter_units_to_string</a>             (const <a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits"><span class="returnvalue">ClutterUnits</span></a> *units);
122
103
 
123
104
                    <a class="link" href="clutter-Unit-conversion.html#ClutterParamSpecUnits" title="ClutterParamSpecUnits">ClutterParamSpecUnits</a>;
124
 
<a
125
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"
126
 
>GParamSpec</a> *        <a class="link" href="clutter-Unit-conversion.html#clutter-param-spec-units" title="clutter_param_spec_units ()">clutter_param_spec_units</a>            (const <a
127
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
128
 
>gchar</a> *name,
129
 
                                                         const <a
130
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
131
 
>gchar</a> *nick,
132
 
                                                         const <a
133
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
134
 
>gchar</a> *blurb,
135
 
                                                         <a class="link" href="clutter-Unit-conversion.html#ClutterUnitType" title="enum ClutterUnitType">ClutterUnitType</a> default_type,
136
 
                                                         <a
137
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"
138
 
>gfloat</a> minimum,
139
 
                                                         <a
140
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"
141
 
>gfloat</a> maximum,
142
 
                                                         <a
143
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"
144
 
>gfloat</a> default_value,
145
 
                                                         <a
146
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamFlags"
147
 
>GParamFlags</a> flags);
148
 
#define             <a class="link" href="clutter-Unit-conversion.html#CLUTTER-VALUE-HOLDS-UNITS--CAPS" title="CLUTTER_VALUE_HOLDS_UNITS()">CLUTTER_VALUE_HOLDS_UNITS</a>           (x)
149
 
void                <a class="link" href="clutter-Unit-conversion.html#clutter-value-set-units" title="clutter_value_set_units ()">clutter_value_set_units</a>             (<a
150
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"
151
 
>GValue</a> *value,
152
 
                                                         const <a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits">ClutterUnits</a> *units);
153
 
const <a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits">ClutterUnits</a> * <a class="link" href="clutter-Unit-conversion.html#clutter-value-get-units" title="clutter_value_get_units ()">clutter_value_get_units</a>            (const <a
154
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"
155
 
>GValue</a> *value);
 
105
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"><span class="returnvalue">GParamSpec</span></a> *        <a class="link" href="clutter-Unit-conversion.html#clutter-param-spec-units" title="clutter_param_spec_units ()">clutter_param_spec_units</a>            (const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *name,
 
106
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *nick,
 
107
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *blurb,
 
108
                                                         <a class="link" href="clutter-Unit-conversion.html#ClutterUnitType" title="enum ClutterUnitType"><span class="returnvalue">ClutterUnitType</span></a> default_type,
 
109
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="returnvalue">gfloat</span></a> minimum,
 
110
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="returnvalue">gfloat</span></a> maximum,
 
111
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="returnvalue">gfloat</span></a> default_value,
 
112
                                                         <a href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamFlags"><span class="returnvalue">GParamFlags</span></a> flags);
 
113
#define             <a class="link" href="clutter-Unit-conversion.html#CLUTTER-VALUE-HOLDS-UNITS:CAPS" title="CLUTTER_VALUE_HOLDS_UNITS()">CLUTTER_VALUE_HOLDS_UNITS</a>           (x)
 
114
<span class="returnvalue">void</span>                <a class="link" href="clutter-Unit-conversion.html#clutter-value-set-units" title="clutter_value_set_units ()">clutter_value_set_units</a>             (<a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="returnvalue">GValue</span></a> *value,
 
115
                                                         const <a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits"><span class="returnvalue">ClutterUnits</span></a> *units);
 
116
const <a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits"><span class="returnvalue">ClutterUnits</span></a> * <a class="link" href="clutter-Unit-conversion.html#clutter-value-get-units" title="clutter_value_get_units ()">clutter_value_get_units</a>            (const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="returnvalue">GValue</span></a> *value);
156
117
</pre>
157
118
</div>
158
119
<div class="refsect1" title="Description">
162
123
its type, expressed as a value of the <a class="link" href="clutter-Unit-conversion.html#ClutterUnitType" title="enum ClutterUnitType"><span class="type">ClutterUnitType</span></a> enumeration. It is
163
124
possible to use <a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits"><span class="type">ClutterUnits</span></a> to store a position or a size in units
164
125
different than pixels, and convert them whenever needed (for instance
165
 
inside the <span class="type">""</span><code class="function">allocate()</code> virtual function, or inside the
166
 
<span class="type">""</span><code class="function">get_preferred_width()</code> and <span class="type">""</span><code class="function">get_preferred_height()</code>
 
126
inside the <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>::<code class="function">allocate()</code> virtual function, or inside the
 
127
<a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>::<code class="function">get_preferred_width()</code> and <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>::<code class="function">get_preferred_height()</code>
167
128
virtual functions.
168
129
</p>
169
130
<p>
170
131
In order to register a <a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits"><span class="type">ClutterUnits</span></a> property, the <a class="link" href="clutter-Unit-conversion.html#ClutterParamSpecUnits" title="ClutterParamSpecUnits"><span class="type">ClutterParamSpecUnits</span></a>
171
 
<a
172
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"
173
 
><span class="type">GParamSpec</span></a> sub-class should be used:
 
132
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"><span class="type">GParamSpec</span></a> sub-class should be used:
174
133
</p>
175
134
<p>
176
135
</p>
189
148
<p>
190
149
</p>
191
150
<p>
192
 
A <a
193
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"
194
 
><span class="type">GValue</span></a> holding units can be manipulated using <a class="link" href="clutter-Unit-conversion.html#clutter-value-set-units" title="clutter_value_set_units ()"><code class="function">clutter_value_set_units()</code></a>
195
 
and <a class="link" href="clutter-Unit-conversion.html#clutter-value-get-units" title="clutter_value_get_units ()"><code class="function">clutter_value_get_units()</code></a>. <a
196
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"
197
 
><span class="type">GValue</span></a>s containing a <a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits"><span class="type">ClutterUnits</span></a>
198
 
value can also be transformed to <a
199
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"
200
 
><span class="type">GValue</span></a>s initialized with
201
 
<a
202
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#G-TYPE-INT--CAPS"
203
 
><code class="literal">G_TYPE_INT</code></a>, <a
204
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#G-TYPE-FLOAT--CAPS"
205
 
><code class="literal">G_TYPE_FLOAT</code></a> and <a
206
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#G-TYPE-STRING--CAPS"
207
 
><code class="literal">G_TYPE_STRING</code></a> through implicit conversion
208
 
and using <a
209
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#g-value-transform"
210
 
><code class="function">g_value_transform()</code></a>.
 
151
A <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> holding units can be manipulated using <a class="link" href="clutter-Unit-conversion.html#clutter-value-set-units" title="clutter_value_set_units ()"><code class="function">clutter_value_set_units()</code></a>
 
152
and <a class="link" href="clutter-Unit-conversion.html#clutter-value-get-units" title="clutter_value_get_units ()"><code class="function">clutter_value_get_units()</code></a>. <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a>s containing a <a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits"><span class="type">ClutterUnits</span></a>
 
153
value can also be transformed to <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a>s initialized with
 
154
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#G-TYPE-INT:CAPS"><code class="literal">G_TYPE_INT</code></a>, <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#G-TYPE-FLOAT:CAPS"><code class="literal">G_TYPE_FLOAT</code></a> and <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#G-TYPE-STRING:CAPS"><code class="literal">G_TYPE_STRING</code></a> through implicit conversion
 
155
and using <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#g-value-transform"><code class="function">g_value_transform()</code></a>.
211
156
</p>
212
157
<p>
213
158
<a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits"><span class="type">ClutterUnits</span></a> is available since Clutter 1.0</p>
214
 
<p>
215
 
</p>
216
159
</div>
217
160
<div class="refsect1" title="Details">
218
161
<a name="clutter-Unit-conversion.details"></a><h2>Details</h2>
222
165
  CLUTTER_UNIT_PIXEL,
223
166
  CLUTTER_UNIT_EM,
224
167
  CLUTTER_UNIT_MM,
225
 
  CLUTTER_UNIT_POINT
 
168
  CLUTTER_UNIT_POINT,
 
169
  CLUTTER_UNIT_CM
226
170
} ClutterUnitType;
227
171
</pre>
228
172
<p>
230
174
</p>
231
175
<p>
232
176
This enumeration might be expanded at later date</p>
233
 
<p>
234
 
</p>
235
177
<div class="variablelist"><table border="0">
236
178
<col align="left" valign="top">
237
179
<tbody>
238
180
<tr>
239
 
<td><p><a name="CLUTTER-UNIT-PIXEL--CAPS"></a><span class="term"><code class="literal">CLUTTER_UNIT_PIXEL</code></span></p></td>
 
181
<td><p><a name="CLUTTER-UNIT-PIXEL:CAPS"></a><span class="term"><code class="literal">CLUTTER_UNIT_PIXEL</code></span></p></td>
240
182
<td> Unit expressed in pixels (with subpixel precision)
241
183
</td>
242
184
</tr>
243
185
<tr>
244
 
<td><p><a name="CLUTTER-UNIT-EM--CAPS"></a><span class="term"><code class="literal">CLUTTER_UNIT_EM</code></span></p></td>
 
186
<td><p><a name="CLUTTER-UNIT-EM:CAPS"></a><span class="term"><code class="literal">CLUTTER_UNIT_EM</code></span></p></td>
245
187
<td> Unit expressed in em
246
188
</td>
247
189
</tr>
248
190
<tr>
249
 
<td><p><a name="CLUTTER-UNIT-MM--CAPS"></a><span class="term"><code class="literal">CLUTTER_UNIT_MM</code></span></p></td>
 
191
<td><p><a name="CLUTTER-UNIT-MM:CAPS"></a><span class="term"><code class="literal">CLUTTER_UNIT_MM</code></span></p></td>
250
192
<td> Unit expressed in millimeters
251
193
</td>
252
194
</tr>
253
195
<tr>
254
 
<td><p><a name="CLUTTER-UNIT-POINT--CAPS"></a><span class="term"><code class="literal">CLUTTER_UNIT_POINT</code></span></p></td>
 
196
<td><p><a name="CLUTTER-UNIT-POINT:CAPS"></a><span class="term"><code class="literal">CLUTTER_UNIT_POINT</code></span></p></td>
255
197
<td> Unit expressed in points
256
198
</td>
257
199
</tr>
 
200
<tr>
 
201
<td><p><a name="CLUTTER-UNIT-CM:CAPS"></a><span class="term"><code class="literal">CLUTTER_UNIT_CM</code></span></p></td>
 
202
<td> Unit expressed in centimeters
 
203
</td>
 
204
</tr>
258
205
</tbody>
259
206
</table></div>
260
207
<p class="since">Since 1.0</p>
268
215
<p>
269
216
An opaque structure, to be used to store sizing and positioning
270
217
values along with their unit.</p>
271
 
<p>
272
 
</p>
273
 
<p class="since">Since 1.0</p>
274
 
</div>
275
 
<hr>
276
 
<div class="refsect2" title="clutter_units_from_mm ()">
277
 
<a name="clutter-units-from-mm"></a><h3>clutter_units_from_mm ()</h3>
278
 
<pre class="programlisting">void                clutter_units_from_mm               (<a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits">ClutterUnits</a> *units,
279
 
                                                         <a
280
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"
281
 
>gfloat</a> mm);</pre>
282
 
<p>
283
 
Stores a value in millimiters inside <em class="parameter"><code>units</code></em></p>
284
 
<p>
285
 
</p>
286
 
<div class="variablelist"><table border="0">
287
 
<col align="left" valign="top">
288
 
<tbody>
289
 
<tr>
290
 
<td><p><span class="term"><em class="parameter"><code>units</code></em> :</span></p></td>
291
 
<td> a <a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits"><span class="type">ClutterUnits</span></a>
292
 
</td>
293
 
</tr>
294
 
<tr>
295
 
<td><p><span class="term"><em class="parameter"><code>mm</code></em> :</span></p></td>
296
 
<td> millimeters
297
 
</td>
298
 
</tr>
299
 
</tbody>
300
 
</table></div>
301
 
<p class="since">Since 1.0</p>
302
 
</div>
303
 
<hr>
304
 
<div class="refsect2" title="clutter_units_from_pt ()">
305
 
<a name="clutter-units-from-pt"></a><h3>clutter_units_from_pt ()</h3>
306
 
<pre class="programlisting">void                clutter_units_from_pt               (<a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits">ClutterUnits</a> *units,
307
 
                                                         <a
308
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"
309
 
>gfloat</a> pt);</pre>
310
 
<p>
311
 
Stores a value in typographic points inside <em class="parameter"><code>units</code></em></p>
312
 
<p>
313
 
</p>
314
 
<div class="variablelist"><table border="0">
315
 
<col align="left" valign="top">
316
 
<tbody>
317
 
<tr>
318
 
<td><p><span class="term"><em class="parameter"><code>units</code></em> :</span></p></td>
319
 
<td> a <a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits"><span class="type">ClutterUnits</span></a>
320
 
</td>
321
 
</tr>
322
 
<tr>
323
 
<td><p><span class="term"><em class="parameter"><code>pt</code></em> :</span></p></td>
324
 
<td> typographic points
325
 
</td>
326
 
</tr>
327
 
</tbody>
328
 
</table></div>
329
 
<p class="since">Since 1.0</p>
 
218
<p class="since">Since 1.0</p>
 
219
</div>
 
220
<hr>
 
221
<div class="refsect2" title="clutter_units_from_cm ()">
 
222
<a name="clutter-units-from-cm"></a><h3>clutter_units_from_cm ()</h3>
 
223
<pre class="programlisting"><span class="returnvalue">void</span>                clutter_units_from_cm               (<a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits"><span class="returnvalue">ClutterUnits</span></a> *units,
 
224
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="returnvalue">gfloat</span></a> cm);</pre>
 
225
<p>
 
226
Stores a value in centimeters inside <em class="parameter"><code>units</code></em></p>
 
227
<div class="variablelist"><table border="0">
 
228
<col align="left" valign="top">
 
229
<tbody>
 
230
<tr>
 
231
<td><p><span class="term"><em class="parameter"><code>units</code></em> :</span></p></td>
 
232
<td> a <a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits"><span class="type">ClutterUnits</span></a>
 
233
</td>
 
234
</tr>
 
235
<tr>
 
236
<td><p><span class="term"><em class="parameter"><code>cm</code></em> :</span></p></td>
 
237
<td> centimeters
 
238
</td>
 
239
</tr>
 
240
</tbody>
 
241
</table></div>
 
242
<p class="since">Since 1.2</p>
330
243
</div>
331
244
<hr>
332
245
<div class="refsect2" title="clutter_units_from_em ()">
333
246
<a name="clutter-units-from-em"></a><h3>clutter_units_from_em ()</h3>
334
 
<pre class="programlisting">void                clutter_units_from_em               (<a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits">ClutterUnits</a> *units,
335
 
                                                         <a
336
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"
337
 
>gfloat</a> em);</pre>
 
247
<pre class="programlisting"><span class="returnvalue">void</span>                clutter_units_from_em               (<a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits"><span class="returnvalue">ClutterUnits</span></a> *units,
 
248
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="returnvalue">gfloat</span></a> em);</pre>
338
249
<p>
339
250
Stores a value in em inside <em class="parameter"><code>units</code></em>, using the default font
340
251
name as returned by <a class="link" href="clutter-ClutterBackend.html#clutter-backend-get-font-name" title="clutter_backend_get_font_name ()"><code class="function">clutter_backend_get_font_name()</code></a></p>
341
 
<p>
342
 
</p>
343
252
<div class="variablelist"><table border="0">
344
253
<col align="left" valign="top">
345
254
<tbody>
360
269
<hr>
361
270
<div class="refsect2" title="clutter_units_from_em_for_font ()">
362
271
<a name="clutter-units-from-em-for-font"></a><h3>clutter_units_from_em_for_font ()</h3>
363
 
<pre class="programlisting">void                clutter_units_from_em_for_font      (<a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits">ClutterUnits</a> *units,
364
 
                                                         const <a
365
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
366
 
>gchar</a> *font_name,
367
 
                                                         <a
368
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"
369
 
>gfloat</a> em);</pre>
 
272
<pre class="programlisting"><span class="returnvalue">void</span>                clutter_units_from_em_for_font      (<a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits"><span class="returnvalue">ClutterUnits</span></a> *units,
 
273
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *font_name,
 
274
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="returnvalue">gfloat</span></a> em);</pre>
370
275
<p>
371
276
Stores a value in em inside <em class="parameter"><code>units</code></em> using <em class="parameter"><code>font_name</code></em></p>
372
 
<p>
373
 
</p>
374
277
<div class="variablelist"><table border="0">
375
278
<col align="left" valign="top">
376
279
<tbody>
394
297
<p class="since">Since 1.0</p>
395
298
</div>
396
299
<hr>
 
300
<div class="refsect2" title="clutter_units_from_mm ()">
 
301
<a name="clutter-units-from-mm"></a><h3>clutter_units_from_mm ()</h3>
 
302
<pre class="programlisting"><span class="returnvalue">void</span>                clutter_units_from_mm               (<a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits"><span class="returnvalue">ClutterUnits</span></a> *units,
 
303
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="returnvalue">gfloat</span></a> mm);</pre>
 
304
<p>
 
305
Stores a value in millimiters inside <em class="parameter"><code>units</code></em></p>
 
306
<div class="variablelist"><table border="0">
 
307
<col align="left" valign="top">
 
308
<tbody>
 
309
<tr>
 
310
<td><p><span class="term"><em class="parameter"><code>units</code></em> :</span></p></td>
 
311
<td> a <a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits"><span class="type">ClutterUnits</span></a>
 
312
</td>
 
313
</tr>
 
314
<tr>
 
315
<td><p><span class="term"><em class="parameter"><code>mm</code></em> :</span></p></td>
 
316
<td> millimeters
 
317
</td>
 
318
</tr>
 
319
</tbody>
 
320
</table></div>
 
321
<p class="since">Since 1.0</p>
 
322
</div>
 
323
<hr>
397
324
<div class="refsect2" title="clutter_units_from_pixels ()">
398
325
<a name="clutter-units-from-pixels"></a><h3>clutter_units_from_pixels ()</h3>
399
 
<pre class="programlisting">void                clutter_units_from_pixels           (<a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits">ClutterUnits</a> *units,
400
 
                                                         <a
401
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
402
 
>gint</a> px);</pre>
 
326
<pre class="programlisting"><span class="returnvalue">void</span>                clutter_units_from_pixels           (<a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits"><span class="returnvalue">ClutterUnits</span></a> *units,
 
327
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> px);</pre>
403
328
<p>
404
329
Stores a value in pixels inside <em class="parameter"><code>units</code></em></p>
405
 
<p>
406
 
</p>
407
330
<div class="variablelist"><table border="0">
408
331
<col align="left" valign="top">
409
332
<tbody>
422
345
<p class="since">Since 1.0</p>
423
346
</div>
424
347
<hr>
 
348
<div class="refsect2" title="clutter_units_from_pt ()">
 
349
<a name="clutter-units-from-pt"></a><h3>clutter_units_from_pt ()</h3>
 
350
<pre class="programlisting"><span class="returnvalue">void</span>                clutter_units_from_pt               (<a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits"><span class="returnvalue">ClutterUnits</span></a> *units,
 
351
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="returnvalue">gfloat</span></a> pt);</pre>
 
352
<p>
 
353
Stores a value in typographic points inside <em class="parameter"><code>units</code></em></p>
 
354
<div class="variablelist"><table border="0">
 
355
<col align="left" valign="top">
 
356
<tbody>
 
357
<tr>
 
358
<td><p><span class="term"><em class="parameter"><code>units</code></em> :</span></p></td>
 
359
<td> a <a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits"><span class="type">ClutterUnits</span></a>
 
360
</td>
 
361
</tr>
 
362
<tr>
 
363
<td><p><span class="term"><em class="parameter"><code>pt</code></em> :</span></p></td>
 
364
<td> typographic points
 
365
</td>
 
366
</tr>
 
367
</tbody>
 
368
</table></div>
 
369
<p class="since">Since 1.0</p>
 
370
</div>
 
371
<hr>
425
372
<div class="refsect2" title="clutter_units_to_pixels ()">
426
373
<a name="clutter-units-to-pixels"></a><h3>clutter_units_to_pixels ()</h3>
427
 
<pre class="programlisting"><a
428
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"
429
 
>gfloat</a>              clutter_units_to_pixels             (<a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits">ClutterUnits</a> *units);</pre>
 
374
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="returnvalue">gfloat</span></a>              clutter_units_to_pixels             (<a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits"><span class="returnvalue">ClutterUnits</span></a> *units);</pre>
430
375
<p>
431
376
Converts a value in <a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits"><span class="type">ClutterUnits</span></a> to pixels</p>
432
 
<p>
433
 
</p>
434
377
<div class="variablelist"><table border="0">
435
378
<col align="left" valign="top">
436
379
<tbody>
452
395
<hr>
453
396
<div class="refsect2" title="clutter_units_copy ()">
454
397
<a name="clutter-units-copy"></a><h3>clutter_units_copy ()</h3>
455
 
<pre class="programlisting"><a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits">ClutterUnits</a> *      clutter_units_copy                  (const <a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits">ClutterUnits</a> *units);</pre>
 
398
<pre class="programlisting"><a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits"><span class="returnvalue">ClutterUnits</span></a> *      clutter_units_copy                  (const <a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits"><span class="returnvalue">ClutterUnits</span></a> *units);</pre>
456
399
<p>
457
400
Copies <em class="parameter"><code>units</code></em></p>
458
 
<p>
459
 
</p>
460
401
<div class="variablelist"><table border="0">
461
402
<col align="left" valign="top">
462
403
<tbody>
479
420
<hr>
480
421
<div class="refsect2" title="clutter_units_free ()">
481
422
<a name="clutter-units-free"></a><h3>clutter_units_free ()</h3>
482
 
<pre class="programlisting">void                clutter_units_free                  (<a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits">ClutterUnits</a> *units);</pre>
 
423
<pre class="programlisting"><span class="returnvalue">void</span>                clutter_units_free                  (<a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits"><span class="returnvalue">ClutterUnits</span></a> *units);</pre>
483
424
<p>
484
425
Frees the resources allocated by <em class="parameter"><code>units</code></em>
485
426
</p>
486
427
<p>
487
428
You should only call this function on a <a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits"><span class="type">ClutterUnits</span></a>
488
429
created using <a class="link" href="clutter-Unit-conversion.html#clutter-units-copy" title="clutter_units_copy ()"><code class="function">clutter_units_copy()</code></a></p>
489
 
<p>
490
 
</p>
491
430
<div class="variablelist"><table border="0">
492
431
<col align="left" valign="top">
493
432
<tbody><tr>
501
440
<hr>
502
441
<div class="refsect2" title="clutter_units_get_unit_type ()">
503
442
<a name="clutter-units-get-unit-type"></a><h3>clutter_units_get_unit_type ()</h3>
504
 
<pre class="programlisting"><a class="link" href="clutter-Unit-conversion.html#ClutterUnitType" title="enum ClutterUnitType">ClutterUnitType</a>     clutter_units_get_unit_type         (const <a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits">ClutterUnits</a> *units);</pre>
 
443
<pre class="programlisting"><a class="link" href="clutter-Unit-conversion.html#ClutterUnitType" title="enum ClutterUnitType"><span class="returnvalue">ClutterUnitType</span></a>     clutter_units_get_unit_type         (const <a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits"><span class="returnvalue">ClutterUnits</span></a> *units);</pre>
505
444
<p>
506
445
Retrieves the unit type of the value stored inside <em class="parameter"><code>units</code></em></p>
507
 
<p>
508
 
</p>
509
446
<div class="variablelist"><table border="0">
510
447
<col align="left" valign="top">
511
448
<tbody>
527
464
<hr>
528
465
<div class="refsect2" title="clutter_units_get_unit_value ()">
529
466
<a name="clutter-units-get-unit-value"></a><h3>clutter_units_get_unit_value ()</h3>
530
 
<pre class="programlisting"><a
531
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"
532
 
>gfloat</a>              clutter_units_get_unit_value        (const <a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits">ClutterUnits</a> *units);</pre>
 
467
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="returnvalue">gfloat</span></a>              clutter_units_get_unit_value        (const <a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits"><span class="returnvalue">ClutterUnits</span></a> *units);</pre>
533
468
<p>
534
469
Retrieves the value stored inside <em class="parameter"><code>units</code></em></p>
535
 
<p>
536
 
</p>
537
470
<div class="variablelist"><table border="0">
538
471
<col align="left" valign="top">
539
472
<tbody>
555
488
<hr>
556
489
<div class="refsect2" title="clutter_units_from_string ()">
557
490
<a name="clutter-units-from-string"></a><h3>clutter_units_from_string ()</h3>
558
 
<pre class="programlisting"><a
559
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
560
 
>gboolean</a>            clutter_units_from_string           (<a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits">ClutterUnits</a> *units,
561
 
                                                         const <a
562
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
563
 
>gchar</a> *str);</pre>
 
491
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            clutter_units_from_string           (<a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits"><span class="returnvalue">ClutterUnits</span></a> *units,
 
492
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *str);</pre>
564
493
<p>
565
494
Parses a value and updates <em class="parameter"><code>units</code></em> with it
566
495
</p>
570
499
<p>
571
500
</p>
572
501
<div class="informalexample"><pre class="programlisting">
573
 
  number: [0-9]
574
 
  unit_value: &lt;number&gt;+
575
 
  unit_name: px|pt|mm|em
576
 
  units: &lt;unit_value&gt; &lt;unit_name&gt;
 
502
  units: wsp* unit-value wsp* unit-name? wsp*
 
503
  unit-value: number
 
504
  unit-name: 'px' | 'pt' | 'mm' | 'em' | 'cm'
 
505
  number: digit+
 
506
          | digit* sep digit+
 
507
  sep: '.' | ','
 
508
  digit: '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9'
 
509
  wsp: (0x20 | 0x9 | 0xA | 0xB | 0xC | 0xD)+
577
510
</pre></div>
578
511
<p>
579
512
</p>
587
520
  5.1 em
588
521
  24 pt
589
522
  12.6 mm
 
523
  .3 cm
590
524
</pre></div>
591
525
<p>
592
526
</p>
605
539
</p>
606
540
<div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
607
541
<h3 class="title">Note</h3>If no unit is specified, pixels are assumed.</div>
608
 
<p>
609
 
</p>
610
542
<div class="variablelist"><table border="0">
611
543
<col align="left" valign="top">
612
544
<tbody>
622
554
</tr>
623
555
<tr>
624
556
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
625
 
<td> <a
626
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
627
 
><code class="literal">TRUE</code></a> if the string was successfully parsed,
628
 
  and <a
629
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE--CAPS"
630
 
><code class="literal">FALSE</code></a> otherwise
 
557
<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the string was successfully parsed,
 
558
  and <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise
631
559
 
632
560
</td>
633
561
</tr>
638
566
<hr>
639
567
<div class="refsect2" title="clutter_units_to_string ()">
640
568
<a name="clutter-units-to-string"></a><h3>clutter_units_to_string ()</h3>
641
 
<pre class="programlisting"><a
642
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
643
 
>gchar</a> *             clutter_units_to_string             (const <a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits">ClutterUnits</a> *units);</pre>
 
569
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             clutter_units_to_string             (const <a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits"><span class="returnvalue">ClutterUnits</span></a> *units);</pre>
644
570
<p>
645
571
Converts <em class="parameter"><code>units</code></em> into a string
646
572
</p>
652
578
</p>
653
579
<div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
654
580
<h3 class="title">Note</h3>Fractional values are truncated to the second decimal
655
 
position for em and mm, and to the first decimal position for
 
581
position for em, mm and cm, and to the first decimal position for
656
582
typographic points. Pixels are integers.</div>
657
 
<p>
658
 
</p>
659
583
<div class="variablelist"><table border="0">
660
584
<col align="left" valign="top">
661
585
<tbody>
667
591
<tr>
668
592
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
669
593
<td> a newly allocated string containing the encoded
670
 
  <a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits"><span class="type">ClutterUnits</span></a> value. Use <a
671
 
href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"
672
 
><code class="function">g_free()</code></a> to free the string
 
594
  <a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits"><span class="type">ClutterUnits</span></a> value. Use <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> to free the string
673
595
 
674
596
</td>
675
597
</tr>
689
611
} ClutterParamSpecUnits;
690
612
</pre>
691
613
<p>
692
 
<a
693
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"
694
 
><span class="type">GParamSpec</span></a> subclass for unit based properties.</p>
695
 
<p>
696
 
</p>
 
614
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"><span class="type">GParamSpec</span></a> subclass for unit based properties.</p>
697
615
<div class="variablelist"><table border="0">
698
616
<col align="left" valign="top">
699
617
<tbody>
700
618
<tr>
701
 
<td><p><span class="term"><a class="link" href="clutter-Unit-conversion.html#ClutterUnitType" title="enum ClutterUnitType">ClutterUnitType</a> <em class="structfield"><code>default_type</code></em>;</span></p></td>
 
619
<td><p><span class="term"><a class="link" href="clutter-Unit-conversion.html#ClutterUnitType" title="enum ClutterUnitType"><span class="type">ClutterUnitType</span></a> <em class="structfield"><code><a name="ClutterParamSpecUnits.default-type"></a>default_type</code></em>;</span></p></td>
702
620
<td> default type
703
621
</td>
704
622
</tr>
705
623
<tr>
706
 
<td><p><span class="term"><a
707
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"
708
 
>gfloat</a> <em class="structfield"><code>default_value</code></em>;</span></p></td>
 
624
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> <em class="structfield"><code><a name="ClutterParamSpecUnits.default-value"></a>default_value</code></em>;</span></p></td>
709
625
<td> default value
710
626
</td>
711
627
</tr>
712
628
<tr>
713
 
<td><p><span class="term"><a
714
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"
715
 
>gfloat</a> <em class="structfield"><code>minimum</code></em>;</span></p></td>
 
629
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> <em class="structfield"><code><a name="ClutterParamSpecUnits.minimum"></a>minimum</code></em>;</span></p></td>
716
630
<td> lower boundary
717
631
</td>
718
632
</tr>
719
633
<tr>
720
 
<td><p><span class="term"><a
721
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"
722
 
>gfloat</a> <em class="structfield"><code>maximum</code></em>;</span></p></td>
 
634
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> <em class="structfield"><code><a name="ClutterParamSpecUnits.maximum"></a>maximum</code></em>;</span></p></td>
723
635
<td> higher boundary
724
636
</td>
725
637
</tr>
730
642
<hr>
731
643
<div class="refsect2" title="clutter_param_spec_units ()">
732
644
<a name="clutter-param-spec-units"></a><h3>clutter_param_spec_units ()</h3>
733
 
<pre class="programlisting"><a
734
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"
735
 
>GParamSpec</a> *        clutter_param_spec_units            (const <a
736
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
737
 
>gchar</a> *name,
738
 
                                                         const <a
739
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
740
 
>gchar</a> *nick,
741
 
                                                         const <a
742
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
743
 
>gchar</a> *blurb,
744
 
                                                         <a class="link" href="clutter-Unit-conversion.html#ClutterUnitType" title="enum ClutterUnitType">ClutterUnitType</a> default_type,
745
 
                                                         <a
746
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"
747
 
>gfloat</a> minimum,
748
 
                                                         <a
749
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"
750
 
>gfloat</a> maximum,
751
 
                                                         <a
752
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"
753
 
>gfloat</a> default_value,
754
 
                                                         <a
755
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamFlags"
756
 
>GParamFlags</a> flags);</pre>
757
 
<p>
758
 
Creates a <a
759
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"
760
 
><span class="type">GParamSpec</span></a> for properties using <a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits"><span class="type">ClutterUnits</span></a>.</p>
761
 
<p>
762
 
</p>
 
645
<pre class="programlisting"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"><span class="returnvalue">GParamSpec</span></a> *        clutter_param_spec_units            (const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *name,
 
646
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *nick,
 
647
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *blurb,
 
648
                                                         <a class="link" href="clutter-Unit-conversion.html#ClutterUnitType" title="enum ClutterUnitType"><span class="returnvalue">ClutterUnitType</span></a> default_type,
 
649
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="returnvalue">gfloat</span></a> minimum,
 
650
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="returnvalue">gfloat</span></a> maximum,
 
651
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="returnvalue">gfloat</span></a> default_value,
 
652
                                                         <a href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamFlags"><span class="returnvalue">GParamFlags</span></a> flags);</pre>
 
653
<p>
 
654
Creates a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"><span class="type">GParamSpec</span></a> for properties using <a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits"><span class="type">ClutterUnits</span></a>.</p>
763
655
<div class="variablelist"><table border="0">
764
656
<col align="left" valign="top">
765
657
<tbody>
805
697
</tr>
806
698
<tr>
807
699
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
808
 
<td> the newly created <a
809
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"
810
 
><span class="type">GParamSpec</span></a>
 
700
<td> the newly created <a href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"><span class="type">GParamSpec</span></a>
811
701
 
812
702
</td>
813
703
</tr>
817
707
</div>
818
708
<hr>
819
709
<div class="refsect2" title="CLUTTER_VALUE_HOLDS_UNITS()">
820
 
<a name="CLUTTER-VALUE-HOLDS-UNITS--CAPS"></a><h3>CLUTTER_VALUE_HOLDS_UNITS()</h3>
 
710
<a name="CLUTTER-VALUE-HOLDS-UNITS:CAPS"></a><h3>CLUTTER_VALUE_HOLDS_UNITS()</h3>
821
711
<pre class="programlisting">#define CLUTTER_VALUE_HOLDS_UNITS(x)    (G_VALUE_HOLDS ((x), CLUTTER_TYPE_UNITS))
822
712
</pre>
823
713
<p>
824
 
Evaluates to <a
825
 
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
826
 
><code class="literal">TRUE</code></a> if <em class="parameter"><code>x</code></em> holds a <a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits"><span class="type">ClutterUnits</span></a> value</p>
827
 
<p>
828
 
</p>
 
714
Evaluates to <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>x</code></em> holds a <a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits"><span class="type">ClutterUnits</span></a> value</p>
829
715
<div class="variablelist"><table border="0">
830
716
<col align="left" valign="top">
831
717
<tbody><tr>
832
718
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
833
 
<td> a <a
834
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"
835
 
><span class="type">GValue</span></a>
 
719
<td> a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a>
836
720
</td>
837
721
</tr></tbody>
838
722
</table></div>
841
725
<hr>
842
726
<div class="refsect2" title="clutter_value_set_units ()">
843
727
<a name="clutter-value-set-units"></a><h3>clutter_value_set_units ()</h3>
844
 
<pre class="programlisting">void                clutter_value_set_units             (<a
845
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"
846
 
>GValue</a> *value,
847
 
                                                         const <a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits">ClutterUnits</a> *units);</pre>
 
728
<pre class="programlisting"><span class="returnvalue">void</span>                clutter_value_set_units             (<a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="returnvalue">GValue</span></a> *value,
 
729
                                                         const <a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits"><span class="returnvalue">ClutterUnits</span></a> *units);</pre>
848
730
<p>
849
731
Sets <em class="parameter"><code>value</code></em> to <em class="parameter"><code>units</code></em></p>
850
 
<p>
851
 
</p>
852
732
<div class="variablelist"><table border="0">
853
733
<col align="left" valign="top">
854
734
<tbody>
855
735
<tr>
856
736
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
857
 
<td> a <a
858
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"
859
 
><span class="type">GValue</span></a> initialized to <span class="type">CLUTTER_TYPE_UNIT</span>
 
737
<td> a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> initialized to <span class="type">CLUTTER_TYPE_UNIT</span>
860
738
</td>
861
739
</tr>
862
740
<tr>
871
749
<hr>
872
750
<div class="refsect2" title="clutter_value_get_units ()">
873
751
<a name="clutter-value-get-units"></a><h3>clutter_value_get_units ()</h3>
874
 
<pre class="programlisting">const <a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits">ClutterUnits</a> * clutter_value_get_units            (const <a
875
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"
876
 
>GValue</a> *value);</pre>
 
752
<pre class="programlisting">const <a class="link" href="clutter-Unit-conversion.html#ClutterUnits" title="ClutterUnits"><span class="returnvalue">ClutterUnits</span></a> * clutter_value_get_units            (const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="returnvalue">GValue</span></a> *value);</pre>
877
753
<p>
878
754
Gets the <span class="type">ClutterUnit</span>s contained in <em class="parameter"><code>value</code></em>.</p>
879
 
<p>
880
 
</p>
881
755
<div class="variablelist"><table border="0">
882
756
<col align="left" valign="top">
883
757
<tbody>
884
758
<tr>
885
759
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
886
 
<td> a <a
887
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"
888
 
><span class="type">GValue</span></a> initialized to <span class="type">CLUTTER_TYPE_UNIT</span>
 
760
<td> a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> initialized to <span class="type">CLUTTER_TYPE_UNIT</span>
889
761
</td>
890
762
</tr>
891
763
<tr>
892
764
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
893
 
<td> the units inside the passed <a
894
 
href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"
895
 
><span class="type">GValue</span></a>
 
765
<td> the units inside the passed <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a>
896
766
 
897
767
</td>
898
768
</tr>
904
774
</div>
905
775
<div class="footer">
906
776
<hr>
907
 
          Generated by GTK-Doc V1.11</div>
 
777
          Generated by GTK-Doc V1.13</div>
908
778
</body>
909
 
</html>
 
779
</html>
 
 
b'\\ No newline at end of file'