<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Clutter Reference Manual: ClutterSettings</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Clutter Reference Manual">
<link rel="up" href="ch10.html" title="General purpose API">
<link rel="prev" href="ClutterPath.html" title="ClutterPath">
<link rel="next" href="clutter-Stage-Manager.html" title="Stage Manager">
<meta name="generator" content="GTK-Doc V1.20.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#ClutterSettings.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#ClutterSettings.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#ClutterSettings.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch10.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ClutterPath.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="clutter-Stage-Manager.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="ClutterSettings"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="ClutterSettings.top_of_page"></a>ClutterSettings</span></h2>
<p>ClutterSettings — Settings configuration</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="ClutterSettings.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody><tr>
<td class="function_type">
<a class="link" href="ClutterSettings.html" title="ClutterSettings"><span class="returnvalue">ClutterSettings</span></a> *
</td>
<td class="function_name">
<a class="link" href="ClutterSettings.html#clutter-settings-get-default" title="clutter_settings_get_default ()">clutter_settings_get_default</a> <span class="c_punctuation">()</span>
</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterSettings.properties"></a><h2>Properties</h2>
<div class="informaltable"><table border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type">
<a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> *</td>
<td class="property_name"><a class="link" href="ClutterSettings.html#ClutterSettings--backend" title="The “backend” property">backend</a></td>
<td class="property_flags">Write / Construct Only</td>
</tr>
<tr>
<td class="property_type"><span class="type">gint</span></td>
<td class="property_name"><a class="link" href="ClutterSettings.html#ClutterSettings--dnd-drag-threshold" title="The “dnd-drag-threshold” property">dnd-drag-threshold</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gint</span></td>
<td class="property_name"><a class="link" href="ClutterSettings.html#ClutterSettings--double-click-distance" title="The “double-click-distance” property">double-click-distance</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gint</span></td>
<td class="property_name"><a class="link" href="ClutterSettings.html#ClutterSettings--double-click-time" title="The “double-click-time” property">double-click-time</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gint</span></td>
<td class="property_name"><a class="link" href="ClutterSettings.html#ClutterSettings--font-antialias" title="The “font-antialias” property">font-antialias</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gint</span></td>
<td class="property_name"><a class="link" href="ClutterSettings.html#ClutterSettings--font-dpi" title="The “font-dpi” property">font-dpi</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="ClutterSettings.html#ClutterSettings--font-hint-style" title="The “font-hint-style” property">font-hint-style</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gint</span></td>
<td class="property_name"><a class="link" href="ClutterSettings.html#ClutterSettings--font-hinting" title="The “font-hinting” property">font-hinting</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="ClutterSettings.html#ClutterSettings--font-name" title="The “font-name” property">font-name</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="ClutterSettings.html#ClutterSettings--font-subpixel-order" title="The “font-subpixel-order” property">font-subpixel-order</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">guint</span></td>
<td class="property_name"><a class="link" href="ClutterSettings.html#ClutterSettings--fontconfig-timestamp" title="The “fontconfig-timestamp” property">fontconfig-timestamp</a></td>
<td class="property_flags">Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gint</span></td>
<td class="property_name"><a class="link" href="ClutterSettings.html#ClutterSettings--long-press-duration" title="The “long-press-duration” property">long-press-duration</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">guint</span></td>
<td class="property_name"><a class="link" href="ClutterSettings.html#ClutterSettings--password-hint-time" title="The “password-hint-time” property">password-hint-time</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gint</span></td>
<td class="property_name"><a class="link" href="ClutterSettings.html#ClutterSettings--unscaled-font-dpi" title="The “unscaled-font-dpi” property">unscaled-font-dpi</a></td>
<td class="property_flags">Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gint</span></td>
<td class="property_name"><a class="link" href="ClutterSettings.html#ClutterSettings--window-scaling-factor" title="The “window-scaling-factor” property">window-scaling-factor</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterSettings.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="ClutterSettings.html#ClutterSettings-struct" title="ClutterSettings">ClutterSettings</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterSettings.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> ClutterSettings
</pre>
</div>
<div class="refsect1">
<a name="ClutterSettings.description"></a><h2>Description</h2>
<p>Clutter depends on some settings to perform operations like detecting
multiple button press events, or font options to render text.</p>
<p>Usually, Clutter will strive to use the platform's settings in order
to be as much integrated as possible. It is, however, possible to
change these settings on a per-application basis, by using the
<a class="link" href="ClutterSettings.html" title="ClutterSettings"><span class="type">ClutterSettings</span></a> singleton object and setting its properties. It is
also possible, for toolkit developers, to retrieve the settings from
the <a class="link" href="ClutterSettings.html" title="ClutterSettings"><span class="type">ClutterSettings</span></a> properties when implementing new UI elements,
for instance the default font name.</p>
<p><a class="link" href="ClutterSettings.html" title="ClutterSettings"><span class="type">ClutterSettings</span></a> is available since Clutter 1.4</p>
</div>
<div class="refsect1">
<a name="ClutterSettings.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="clutter-settings-get-default"></a><h3>clutter_settings_get_default ()</h3>
<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>
<p>Retrieves the singleton instance of <a class="link" href="ClutterSettings.html" title="ClutterSettings"><span class="type">ClutterSettings</span></a></p>
<div class="refsect3">
<a name="id-1.7.2.11.8.2.5"></a><h4>Returns</h4>
<p> the instance of <a class="link" href="ClutterSettings.html" title="ClutterSettings"><span class="type">ClutterSettings</span></a>. The
returned object is owned by Clutter and it should not be unreferenced
directly. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
<p class="since">Since 1.4</p>
</div>
</div>
<div class="refsect1">
<a name="ClutterSettings.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="ClutterSettings-struct"></a><h3>ClutterSettings</h3>
<pre class="programlisting">typedef struct _ClutterSettings ClutterSettings;</pre>
<p><structname>ClutterSettings</structname> is an opaque structure whose
members cannot be directly accessed.</p>
<p class="since">Since 1.4</p>
</div>
</div>
<div class="refsect1">
<a name="ClutterSettings.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="ClutterSettings--backend"></a><h3>The <code class="literal">“backend”</code> property</h3>
<pre class="programlisting"> “backend” <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> *</pre>
<p>A back pointer to the <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a></p>
<div class="warning"><p><code class="literal">ClutterSettings:backend</code> has been deprecated since version 1.10 and should not be used in newly-written code.</p></div>
<p>Flags: Write / Construct Only</p>
<p class="since">Since 1.4</p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterSettings--dnd-drag-threshold"></a><h3>The <code class="literal">“dnd-drag-threshold”</code> property</h3>
<pre class="programlisting"> “dnd-drag-threshold” <span class="type">gint</span></pre>
<p>The default distance that the cursor of a pointer device
should travel before a drag operation should start.</p>
<p>Flags: Read / Write</p>
<p>Allowed values: >= 1</p>
<p>Default value: 8</p>
<p class="since">Since 1.8</p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterSettings--double-click-distance"></a><h3>The <code class="literal">“double-click-distance”</code> property</h3>
<pre class="programlisting"> “double-click-distance” <span class="type">gint</span></pre>
<p>The maximum distance, in pixels, between button-press events that
determines whether or not to increase the click count by 1.</p>
<p>Flags: Read / Write</p>
<p>Allowed values: >= 0</p>
<p>Default value: 5</p>
<p class="since">Since 1.4</p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterSettings--double-click-time"></a><h3>The <code class="literal">“double-click-time”</code> property</h3>
<pre class="programlisting"> “double-click-time” <span class="type">gint</span></pre>
<p>The time, in milliseconds, that should elapse between button-press
events in order to increase the click count by 1.</p>
<p>Flags: Read / Write</p>
<p>Allowed values: >= 0</p>
<p>Default value: 250</p>
<p class="since">Since 1.4</p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterSettings--font-antialias"></a><h3>The <code class="literal">“font-antialias”</code> property</h3>
<pre class="programlisting"> “font-antialias” <span class="type">gint</span></pre>
<p>Whether or not to use antialiasing when rendering text; a value
of 1 enables it unconditionally; a value of 0 disables it
unconditionally; and -1 will use the system's default.</p>
<p>Flags: Read / Write</p>
<p>Allowed values: [-1,1]</p>
<p>Default value: -1</p>
<p class="since">Since 1.4</p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterSettings--font-dpi"></a><h3>The <code class="literal">“font-dpi”</code> property</h3>
<pre class="programlisting"> “font-dpi” <span class="type">gint</span></pre>
<p>The DPI used when rendering text, as a value of 1024 * dots/inch.</p>
<p>If set to -1, the system's default will be used instead</p>
<p>Flags: Read / Write</p>
<p>Allowed values: [-1,1048576]</p>
<p>Default value: -1</p>
<p class="since">Since 1.4</p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterSettings--font-hint-style"></a><h3>The <code class="literal">“font-hint-style”</code> property</h3>
<pre class="programlisting"> “font-hint-style” <span class="type">gchar</span> *</pre>
<p>The style of the hinting used when rendering text. Valid values
are:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p>hintnone</p></li>
<li class="listitem"><p>hintslight</p></li>
<li class="listitem"><p>hintmedium</p></li>
<li class="listitem"><p>hintfull</p></li>
</ul></div>
<p>Flags: Read / Write</p>
<p>Default value: NULL</p>
<p class="since">Since 1.4</p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterSettings--font-hinting"></a><h3>The <code class="literal">“font-hinting”</code> property</h3>
<pre class="programlisting"> “font-hinting” <span class="type">gint</span></pre>
<p>Whether or not to use hinting when rendering text; a value of 1
unconditionally enables it; a value of 0 unconditionally disables
it; and a value of -1 will use the system's default.</p>
<p>Flags: Read / Write</p>
<p>Allowed values: [-1,1]</p>
<p>Default value: -1</p>
<p class="since">Since 1.4</p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterSettings--font-name"></a><h3>The <code class="literal">“font-name”</code> property</h3>
<pre class="programlisting"> “font-name” <span class="type">gchar</span> *</pre>
<p>The default font name that should be used by text actors, as
a string that can be passed to <code class="function">pango_font_description_from_string()</code>.</p>
<p>Flags: Read / Write</p>
<p>Default value: NULL</p>
<p class="since">Since 1.4</p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterSettings--font-subpixel-order"></a><h3>The <code class="literal">“font-subpixel-order”</code> property</h3>
<pre class="programlisting"> “font-subpixel-order” <span class="type">gchar</span> *</pre>
<p>The type of sub-pixel antialiasing used when rendering text. Valid
values are:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p>none</p></li>
<li class="listitem"><p>rgb</p></li>
<li class="listitem"><p>bgr</p></li>
<li class="listitem"><p>vrgb</p></li>
<li class="listitem"><p>vbgr</p></li>
</ul></div>
<p>Flags: Read / Write</p>
<p>Default value: NULL</p>
<p class="since">Since 1.4</p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterSettings--fontconfig-timestamp"></a><h3>The <code class="literal">“fontconfig-timestamp”</code> property</h3>
<pre class="programlisting"> “fontconfig-timestamp” <span class="type">guint</span></pre>
<p>Timestamp of the current fontconfig configuration.</p>
<p>Flags: Write</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterSettings--long-press-duration"></a><h3>The <code class="literal">“long-press-duration”</code> property</h3>
<pre class="programlisting"> “long-press-duration” <span class="type">gint</span></pre>
<p>Sets the minimum duration for a press to be recognized as a long press
gesture. The duration is expressed in milliseconds.</p>
<p>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>.</p>
<p>Flags: Read / Write</p>
<p>Allowed values: >= 0</p>
<p>Default value: 500</p>
<p class="since">Since 1.8</p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterSettings--password-hint-time"></a><h3>The <code class="literal">“password-hint-time”</code> property</h3>
<pre class="programlisting"> “password-hint-time” <span class="type">guint</span></pre>
<p>How long to show the last input character in hidden entries.</p>
<p>Flags: Read / Write</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterSettings--unscaled-font-dpi"></a><h3>The <code class="literal">“unscaled-font-dpi”</code> property</h3>
<pre class="programlisting"> “unscaled-font-dpi” <span class="type">gint</span></pre>
<p>The resolution of the font, in 1024 * dots/inch, or -1 to use the default.</p>
<p>Flags: Write</p>
<p>Allowed values: [-1,1048576]</p>
<p>Default value: -1</p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterSettings--window-scaling-factor"></a><h3>The <code class="literal">“window-scaling-factor”</code> property</h3>
<pre class="programlisting"> “window-scaling-factor” <span class="type">gint</span></pre>
<p>The scaling factor to be applied to windows.</p>
<p>Flags: Read / Write</p>
<p>Allowed values: >= 1</p>
<p>Default value: 1</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.20.1</div>
</body>
</html>