/usr/share/gtk-doc/html/xfconf/xfconf-xfconf-binding.html is in libxfconf-0-dev 4.8.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Xfconf-GObject Binding</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Xfconf Reference Manual">
<link rel="up" href="ch03.html" title="Xfconf Client Library">
<link rel="prev" href="xfconf-xfconf-channel.html" title="XfconfChannel">
<meta name="generator" content="GTK-Doc V1.18 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="xfconf-xfconf-channel.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch03.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Xfconf Reference Manual</th>
<td> </td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#xfconf-xfconf-binding.synopsis" class="shortcut">Top</a>
|
<a href="#xfconf-xfconf-binding.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="xfconf-xfconf-binding"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="xfconf-xfconf-binding.top_of_page"></a>Xfconf-GObject Binding</span></h2>
<p>Xfconf-GObject Binding — Functions to bind Xfconf properties to GObject properties</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="xfconf-xfconf-binding.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"><span class="returnvalue">gulong</span> <a class="link" href="xfconf-xfconf-binding.html#xfconf-g-property-bind" title="xfconf_g_property_bind ()">xfconf_g_property_bind</a> (<em class="parameter"><code><a class="link" href="xfconf-xfconf-channel.html#XfconfChannel"><span class="type">XfconfChannel</span></a> *channel</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *xfconf_property</code></em>,
<em class="parameter"><code><span class="type">GType</span> xfconf_property_type</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> object</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *object_property</code></em>);
<span class="returnvalue">gulong</span> <a class="link" href="xfconf-xfconf-binding.html#xfconf-g-property-bind-gdkcolor" title="xfconf_g_property_bind_gdkcolor ()">xfconf_g_property_bind_gdkcolor</a> (<em class="parameter"><code><a class="link" href="xfconf-xfconf-channel.html#XfconfChannel"><span class="type">XfconfChannel</span></a> *channel</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *xfconf_property</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> object</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *object_property</code></em>);
<span class="returnvalue">void</span> <a class="link" href="xfconf-xfconf-binding.html#xfconf-g-property-unbind" title="xfconf_g_property_unbind ()">xfconf_g_property_unbind</a> (<em class="parameter"><code><span class="type">gulong</span> id</code></em>);
<span class="returnvalue">void</span> <a class="link" href="xfconf-xfconf-binding.html#xfconf-g-property-unbind-by-property" title="xfconf_g_property_unbind_by_property ()">xfconf_g_property_unbind_by_property</a>
(<em class="parameter"><code><a class="link" href="xfconf-xfconf-channel.html#XfconfChannel"><span class="type">XfconfChannel</span></a> *channel</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *xfconf_property</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> object</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *object_property</code></em>);
<span class="returnvalue">void</span> <a class="link" href="xfconf-xfconf-binding.html#xfconf-g-property-unbind-all" title="xfconf_g_property_unbind_all ()">xfconf_g_property_unbind_all</a> (<em class="parameter"><code><span class="type">gpointer</span> channel_or_object</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="xfconf-xfconf-binding.description"></a><h2>Description</h2>
<p>
Often it may be useful to bind an Xfconf property to a GObject property.
Settings dialogs often display the current value of an Xfconf property,
and a user may edit the value to change the value in the Xfconf store.
If the Xfconf property changes outside the settings dialog, the user will
usually want to see the settings dialog automatically update to reflect
the new value.
With a single line of code, Xfconf's binding functionality can automate
all this.
</p>
</div>
<div class="refsect1">
<a name="xfconf-xfconf-binding.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="xfconf-g-property-bind"></a><h3>xfconf_g_property_bind ()</h3>
<pre class="programlisting"><span class="returnvalue">gulong</span> xfconf_g_property_bind (<em class="parameter"><code><a class="link" href="xfconf-xfconf-channel.html#XfconfChannel"><span class="type">XfconfChannel</span></a> *channel</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *xfconf_property</code></em>,
<em class="parameter"><code><span class="type">GType</span> xfconf_property_type</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> object</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *object_property</code></em>);</pre>
<p>
Binds an Xfconf property to a <span class="type">GObject</span> property. If the property
is changed via either the <span class="type">GObject</span> or Xfconf, the corresponding
property will also be updated.
</p>
<p>
Note that <em class="parameter"><code>xfconf_property_type</code></em> is required since <em class="parameter"><code>xfconf_property</code></em>
may or may not already exist in the Xfconf store. The type of
<em class="parameter"><code>object_property</code></em> will be determined automatically. If the two
types do not match, a conversion will be attempted.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>channel</code></em> :</span></p></td>
<td>An <a class="link" href="xfconf-xfconf-channel.html#XfconfChannel"><span class="type">XfconfChannel</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>xfconf_property</code></em> :</span></p></td>
<td>A property on <em class="parameter"><code>channel</code></em>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>xfconf_property_type</code></em> :</span></p></td>
<td>The type of <em class="parameter"><code>xfconf_property</code></em>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
<td>A <span class="type">GObject</span>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>object_property</code></em> :</span></p></td>
<td>A valid property on <em class="parameter"><code>object</code></em>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>an ID number that can be used to later remove the
binding.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="xfconf-g-property-bind-gdkcolor"></a><h3>xfconf_g_property_bind_gdkcolor ()</h3>
<pre class="programlisting"><span class="returnvalue">gulong</span> xfconf_g_property_bind_gdkcolor (<em class="parameter"><code><a class="link" href="xfconf-xfconf-channel.html#XfconfChannel"><span class="type">XfconfChannel</span></a> *channel</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *xfconf_property</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> object</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *object_property</code></em>);</pre>
<p>
Binds an Xfconf property to a <span class="type">GObject</span> property of type
GDK_TYPE_COLOR (aka a <span class="type">GdkColor</span> struct). If the property
is changed via either the <span class="type">GObject</span> or Xfconf, the corresponding
property will also be updated.
</p>
<p>
This is a special-case binding; the GdkColor struct is not
ideal as-is for binding to a property, so it is stored in the
Xfconf store as four 16-bit unsigned ints (red, green, blue, alpha).
Since GdkColor (currently) only supports RGB and not RGBA,
the last value will always be set to 0xFFFF.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>channel</code></em> :</span></p></td>
<td>An <a class="link" href="xfconf-xfconf-channel.html#XfconfChannel"><span class="type">XfconfChannel</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>xfconf_property</code></em> :</span></p></td>
<td>A property on <em class="parameter"><code>channel</code></em>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
<td>A <span class="type">GObject</span>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>object_property</code></em> :</span></p></td>
<td>A valid property on <em class="parameter"><code>object</code></em>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>an ID number that can be used to later remove the
binding.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="xfconf-g-property-unbind"></a><h3>xfconf_g_property_unbind ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> xfconf_g_property_unbind (<em class="parameter"><code><span class="type">gulong</span> id</code></em>);</pre>
<p>
Removes an Xfconf/GObject property binding based on the binding
ID number. See <a class="link" href="xfconf-xfconf-binding.html#xfconf-g-property-bind" title="xfconf_g_property_bind ()"><code class="function">xfconf_g_property_bind()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
<td>A binding ID number.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="xfconf-g-property-unbind-by-property"></a><h3>xfconf_g_property_unbind_by_property ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> xfconf_g_property_unbind_by_property
(<em class="parameter"><code><a class="link" href="xfconf-xfconf-channel.html#XfconfChannel"><span class="type">XfconfChannel</span></a> *channel</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *xfconf_property</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> object</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *object_property</code></em>);</pre>
<p>
Causes an Xfconf channel previously bound to a <span class="type">GObject</span> property
(see <a class="link" href="xfconf-xfconf-binding.html#xfconf-g-property-bind" title="xfconf_g_property_bind ()"><code class="function">xfconf_g_property_bind()</code></a>) to no longer be bound.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>channel</code></em> :</span></p></td>
<td>An <a class="link" href="xfconf-xfconf-channel.html#XfconfChannel"><span class="type">XfconfChannel</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>xfconf_property</code></em> :</span></p></td>
<td>A bound property on <em class="parameter"><code>channel</code></em>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
<td>A <span class="type">GObject</span>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>object_property</code></em> :</span></p></td>
<td>A bound property on <em class="parameter"><code>object</code></em>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="xfconf-g-property-unbind-all"></a><h3>xfconf_g_property_unbind_all ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> xfconf_g_property_unbind_all (<em class="parameter"><code><span class="type">gpointer</span> channel_or_object</code></em>);</pre>
<p>
Unbinds all Xfconf channel bindings (see <a class="link" href="xfconf-xfconf-binding.html#xfconf-g-property-bind" title="xfconf_g_property_bind ()"><code class="function">xfconf_g_property_bind()</code></a>)
to <em class="parameter"><code>object</code></em>. If <em class="parameter"><code>object</code></em> is an <a class="link" href="xfconf-xfconf-channel.html#XfconfChannel"><span class="type">XfconfChannel</span></a>, it will unbind all
xfconf properties on that channel. If <em class="parameter"><code>object</code></em> is a regular <span class="type">GObject</span>
with properties bound to a channel, all those bindings will be
removed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>channel_or_object</code></em> :</span></p></td>
<td>A <span class="type">GObject</span> or <a class="link" href="xfconf-xfconf-channel.html#XfconfChannel"><span class="type">XfconfChannel</span></a>.</td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|