1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>ClutterSettings</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7 <link rel="home" href="index.html" title="Clutter Reference Manual">
8 <link rel="up" href="ch11.html" title="General purpose API">
9 <link rel="prev" href="ClutterPath.html" title="ClutterPath">
10 <link rel="next" href="clutter-Stage-Manager.html" title="Stage Manager">
11 <meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
17 <td><a accesskey="p" href="ClutterPath.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="ch11.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20 <th width="100%" align="center">Clutter Reference Manual</th>
21 <td><a accesskey="n" href="clutter-Stage-Manager.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#ClutterSettings.synopsis" class="shortcut">Top</a>
26 <a href="#ClutterSettings.description" class="shortcut">Description</a>
28 <a href="#ClutterSettings.object-hierarchy" class="shortcut">Object Hierarchy</a>
30 <a href="#ClutterSettings.properties" class="shortcut">Properties</a>
33 <div class="refentry">
34 <a name="ClutterSettings"></a><div class="titlepage"></div>
35 <div class="refnamediv"><table width="100%"><tr>
37 <h2><span class="refentrytitle"><a name="ClutterSettings.top_of_page"></a>ClutterSettings</span></h2>
38 <p>ClutterSettings — Settings configuration</p>
40 <td valign="top" align="right"></td>
42 <div class="refsynopsisdiv">
43 <a name="ClutterSettings.synopsis"></a><h2>Synopsis</h2>
44 <pre class="synopsis"> <a class="link" href="ClutterSettings.html#ClutterSettings-struct" title="ClutterSettings">ClutterSettings</a>;
45 <a class="link" href="ClutterSettings.html" title="ClutterSettings"><span class="returnvalue">ClutterSettings</span></a> * <a class="link" href="ClutterSettings.html#clutter-settings-get-default" title="clutter_settings_get_default ()">clutter_settings_get_default</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
48 <div class="refsect1">
49 <a name="ClutterSettings.object-hierarchy"></a><h2>Object Hierarchy</h2>
50 <pre class="synopsis">
55 <div class="refsect1">
56 <a name="ClutterSettings.properties"></a><h2>Properties</h2>
57 <pre class="synopsis">
58 "<a class="link" href="ClutterSettings.html#ClutterSettings--backend" title='The "backend" property'>backend</a>" <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a>* : Write / Construct Only
59 "<a class="link" href="ClutterSettings.html#ClutterSettings--dnd-drag-threshold" title='The "dnd-drag-threshold" property'>dnd-drag-threshold</a>" <span class="type">gint</span> : Read / Write
60 "<a class="link" href="ClutterSettings.html#ClutterSettings--double-click-distance" title='The "double-click-distance" property'>double-click-distance</a>" <span class="type">gint</span> : Read / Write
61 "<a class="link" href="ClutterSettings.html#ClutterSettings--double-click-time" title='The "double-click-time" property'>double-click-time</a>" <span class="type">gint</span> : Read / Write
62 "<a class="link" href="ClutterSettings.html#ClutterSettings--font-antialias" title='The "font-antialias" property'>font-antialias</a>" <span class="type">gint</span> : Read / Write
63 "<a class="link" href="ClutterSettings.html#ClutterSettings--font-dpi" title='The "font-dpi" property'>font-dpi</a>" <span class="type">gint</span> : Read / Write
64 "<a class="link" href="ClutterSettings.html#ClutterSettings--font-hint-style" title='The "font-hint-style" property'>font-hint-style</a>" <span class="type">gchar</span>* : Read / Write
65 "<a class="link" href="ClutterSettings.html#ClutterSettings--font-hinting" title='The "font-hinting" property'>font-hinting</a>" <span class="type">gint</span> : Read / Write
66 "<a class="link" href="ClutterSettings.html#ClutterSettings--font-name" title='The "font-name" property'>font-name</a>" <span class="type">gchar</span>* : Read / Write
67 "<a class="link" href="ClutterSettings.html#ClutterSettings--font-subpixel-order" title='The "font-subpixel-order" property'>font-subpixel-order</a>" <span class="type">gchar</span>* : Read / Write
68 "<a class="link" href="ClutterSettings.html#ClutterSettings--fontconfig-timestamp" title='The "fontconfig-timestamp" property'>fontconfig-timestamp</a>" <span class="type">guint</span> : Write
69 "<a class="link" href="ClutterSettings.html#ClutterSettings--long-press-duration" title='The "long-press-duration" property'>long-press-duration</a>" <span class="type">gint</span> : Read / Write
70 "<a class="link" href="ClutterSettings.html#ClutterSettings--password-hint-time" title='The "password-hint-time" property'>password-hint-time</a>" <span class="type">guint</span> : Read / Write
73 <div class="refsect1">
74 <a name="ClutterSettings.description"></a><h2>Description</h2>
76 Clutter depends on some settings to perform operations like detecting
77 multiple button press events, or font options to render text.
80 Usually, Clutter will strive to use the platform's settings in order
81 to be as much integrated as possible. It is, however, possible to
82 change these settings on a per-application basis, by using the
83 <a class="link" href="ClutterSettings.html" title="ClutterSettings"><span class="type">ClutterSettings</span></a> singleton object and setting its properties. It is
84 also possible, for toolkit developers, to retrieve the settings from
85 the <a class="link" href="ClutterSettings.html" title="ClutterSettings"><span class="type">ClutterSettings</span></a> properties when implementing new UI elements,
86 for instance the default font name.
89 <a class="link" href="ClutterSettings.html" title="ClutterSettings"><span class="type">ClutterSettings</span></a> is available since Clutter 1.4
92 <div class="refsect1">
93 <a name="ClutterSettings.details"></a><h2>Details</h2>
94 <div class="refsect2">
95 <a name="ClutterSettings-struct"></a><h3>ClutterSettings</h3>
96 <pre class="programlisting">typedef struct _ClutterSettings ClutterSettings;</pre>
98 <span class="structname">ClutterSettings</span> is an opaque structure whose
99 members cannot be directly accessed.
101 <p class="since">Since 1.4</p>
104 <div class="refsect2">
105 <a name="clutter-settings-get-default"></a><h3>clutter_settings_get_default ()</h3>
106 <pre class="programlisting"><a class="link" href="ClutterSettings.html" title="ClutterSettings"><span class="returnvalue">ClutterSettings</span></a> * clutter_settings_get_default (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
108 Retrieves the singleton instance of <a class="link" href="ClutterSettings.html" title="ClutterSettings"><span class="type">ClutterSettings</span></a>
110 <div class="variablelist"><table border="0">
111 <col align="left" valign="top">
113 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
114 <td>the instance of <a class="link" href="ClutterSettings.html" title="ClutterSettings"><span class="type">ClutterSettings</span></a>. The
115 returned object is owned by Clutter and it should not be unreferenced
116 directly. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
120 <p class="since">Since 1.4</p>
123 <div class="refsect1">
124 <a name="ClutterSettings.property-details"></a><h2>Property Details</h2>
125 <div class="refsect2">
126 <a name="ClutterSettings--backend"></a><h3>The <code class="literal">"backend"</code> property</h3>
127 <pre class="programlisting"> "backend" <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a>* : Write / Construct Only</pre>
128 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
129 <h3 class="title">Warning</h3>
130 <p><code class="literal">ClutterSettings:backend</code> is deprecated and should not be used in newly-written code. 1.10</p>
133 A back pointer to the <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a>
135 <p class="since">Since 1.4</p>
138 <div class="refsect2">
139 <a name="ClutterSettings--dnd-drag-threshold"></a><h3>The <code class="literal">"dnd-drag-threshold"</code> property</h3>
140 <pre class="programlisting"> "dnd-drag-threshold" <span class="type">gint</span> : Read / Write</pre>
142 The default distance that the cursor of a pointer device
143 should travel before a drag operation should start.
145 <p>Allowed values: >= 1</p>
146 <p>Default value: 8</p>
147 <p class="since">Since 1.8</p>
150 <div class="refsect2">
151 <a name="ClutterSettings--double-click-distance"></a><h3>The <code class="literal">"double-click-distance"</code> property</h3>
152 <pre class="programlisting"> "double-click-distance" <span class="type">gint</span> : Read / Write</pre>
154 The maximum distance, in pixels, between button-press events that
155 determines whether or not to increase the click count by 1.
157 <p>Allowed values: >= 0</p>
158 <p>Default value: 5</p>
159 <p class="since">Since 1.4</p>
162 <div class="refsect2">
163 <a name="ClutterSettings--double-click-time"></a><h3>The <code class="literal">"double-click-time"</code> property</h3>
164 <pre class="programlisting"> "double-click-time" <span class="type">gint</span> : Read / Write</pre>
166 The time, in milliseconds, that should elapse between button-press
167 events in order to increase the click count by 1.
169 <p>Allowed values: >= 0</p>
170 <p>Default value: 250</p>
171 <p class="since">Since 1.4</p>
174 <div class="refsect2">
175 <a name="ClutterSettings--font-antialias"></a><h3>The <code class="literal">"font-antialias"</code> property</h3>
176 <pre class="programlisting"> "font-antialias" <span class="type">gint</span> : Read / Write</pre>
178 Whether or not to use antialiasing when rendering text; a value
179 of 1 enables it unconditionally; a value of 0 disables it
180 unconditionally; and -1 will use the system's default.
182 <p>Allowed values: [G_MAXULONG,1]</p>
183 <p>Default value: -1</p>
184 <p class="since">Since 1.4</p>
187 <div class="refsect2">
188 <a name="ClutterSettings--font-dpi"></a><h3>The <code class="literal">"font-dpi"</code> property</h3>
189 <pre class="programlisting"> "font-dpi" <span class="type">gint</span> : Read / Write</pre>
191 The DPI used when rendering text, as a value of 1024 * dots/inch.
194 If set to -1, the system's default will be used instead
196 <p>Allowed values: [G_MAXULONG,1048576]</p>
197 <p>Default value: -1</p>
198 <p class="since">Since 1.4</p>
201 <div class="refsect2">
202 <a name="ClutterSettings--font-hint-style"></a><h3>The <code class="literal">"font-hint-style"</code> property</h3>
203 <pre class="programlisting"> "font-hint-style" <span class="type">gchar</span>* : Read / Write</pre>
205 The style of the hinting used when rendering text. Valid values
208 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
209 <li class="listitem">hintnone</li>
210 <li class="listitem">hintslight</li>
211 <li class="listitem">hintmedium</li>
212 <li class="listitem">hintfull</li>
216 <p>Default value: NULL</p>
217 <p class="since">Since 1.4</p>
220 <div class="refsect2">
221 <a name="ClutterSettings--font-hinting"></a><h3>The <code class="literal">"font-hinting"</code> property</h3>
222 <pre class="programlisting"> "font-hinting" <span class="type">gint</span> : Read / Write</pre>
224 Whether or not to use hinting when rendering text; a value of 1
225 unconditionally enables it; a value of 0 unconditionally disables
226 it; and a value of -1 will use the system's default.
228 <p>Allowed values: [G_MAXULONG,1]</p>
229 <p>Default value: -1</p>
230 <p class="since">Since 1.4</p>
233 <div class="refsect2">
234 <a name="ClutterSettings--font-name"></a><h3>The <code class="literal">"font-name"</code> property</h3>
235 <pre class="programlisting"> "font-name" <span class="type">gchar</span>* : Read / Write</pre>
237 The default font name that should be used by text actors, as
238 a string that can be passed to <code class="function">pango_font_description_from_string()</code>.
240 <p>Default value: NULL</p>
241 <p class="since">Since 1.4</p>
244 <div class="refsect2">
245 <a name="ClutterSettings--font-subpixel-order"></a><h3>The <code class="literal">"font-subpixel-order"</code> property</h3>
246 <pre class="programlisting"> "font-subpixel-order" <span class="type">gchar</span>* : Read / Write</pre>
248 The type of sub-pixel antialiasing used when rendering text. Valid
251 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
252 <li class="listitem">none</li>
253 <li class="listitem">rgb</li>
254 <li class="listitem">bgr</li>
255 <li class="listitem">vrgb</li>
256 <li class="listitem">vbgr</li>
260 <p>Default value: NULL</p>
261 <p class="since">Since 1.4</p>
264 <div class="refsect2">
265 <a name="ClutterSettings--fontconfig-timestamp"></a><h3>The <code class="literal">"fontconfig-timestamp"</code> property</h3>
266 <pre class="programlisting"> "fontconfig-timestamp" <span class="type">guint</span> : Write</pre>
267 <p>Timestamp of the current fontconfig configuration.</p>
268 <p>Default value: 0</p>
271 <div class="refsect2">
272 <a name="ClutterSettings--long-press-duration"></a><h3>The <code class="literal">"long-press-duration"</code> property</h3>
273 <pre class="programlisting"> "long-press-duration" <span class="type">gint</span> : Read / Write</pre>
275 Sets the minimum duration for a press to be recognized as a long press
276 gesture. The duration is expressed in milliseconds.
279 See also <a class="link" href="ClutterClickAction.html#ClutterClickAction--long-press-duration" title='The "long-press-duration" property'><span class="type">"long-press-duration"</span></a>.
281 <p>Allowed values: >= 0</p>
282 <p>Default value: 500</p>
283 <p class="since">Since 1.8</p>
286 <div class="refsect2">
287 <a name="ClutterSettings--password-hint-time"></a><h3>The <code class="literal">"password-hint-time"</code> property</h3>
288 <pre class="programlisting"> "password-hint-time" <span class="type">guint</span> : Read / Write</pre>
289 <p>How long to show the last input character in hidden entries.</p>
290 <p>Default value: 0</p>
296 Generated by GTK-Doc V1.18.1</div>