/usr/share/gtk-doc/html/dbus-glib/dbus-glib-DBus-GObject-related-functions.html is in libdbus-glib-1-doc 0.108-2.
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 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>DBus GObject related functions: D-Bus GLib bindings - Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="D-Bus GLib bindings - Reference Manual">
<link rel="up" href="ch02.html" title="API Reference">
<link rel="prev" href="dbus-glib-DBusGConnection.html" title="DBusGConnection">
<link rel="next" href="dbus-glib-DBusGMessage.html" title="DBusGMessage">
<meta name="generator" content="GTK-Doc V1.25 (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="#dbus-glib-DBus-GObject-related-functions.description" class="shortcut">Description</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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="dbus-glib-DBusGConnection.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="dbus-glib-DBusGMessage.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="dbus-glib-DBus-GObject-related-functions"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="dbus-glib-DBus-GObject-related-functions.top_of_page"></a>DBus GObject related functions</span></h2>
<p>DBus GObject related functions — Exporting a GObject remotely</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="dbus-glib-DBus-GObject-related-functions.stability-level"></a><h2>Stability Level</h2>
<a href="http://foldoc.org/Stable"><span class="acronym">Stable</span></a>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="dbus-glib-DBus-GObject-related-functions.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="dbus-glib-DBus-GObject-related-functions.html#dbus-g-object-type-install-info" title="dbus_g_object_type_install_info ()">dbus_g_object_type_install_info</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="dbus-glib-DBus-GObject-related-functions.html#dbus-g-object-type-register-shadow-property" title="dbus_g_object_type_register_shadow_property ()">dbus_g_object_type_register_shadow_property</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="dbus-glib-DBus-GObject-related-functions.html#dbus-g-object-register-marshaller" title="dbus_g_object_register_marshaller ()">dbus_g_object_register_marshaller</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="dbus-glib-DBus-GObject-related-functions.html#dbus-g-object-register-marshaller-array" title="dbus_g_object_register_marshaller_array ()">dbus_g_object_register_marshaller_array</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="dbus-glib-DBus-GObject-related-functions.html#dbus-glib-global-set-disable-legacy-property-access" title="dbus_glib_global_set_disable_legacy_property_access ()">dbus_glib_global_set_disable_legacy_property_access</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="dbus-glib-DBus-GObject-related-functions.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="dbus-glib-DBus-GObject-related-functions.html#DBusGObjectInfo" title="struct DBusGObjectInfo">DBusGObjectInfo</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="dbus-glib-DBus-GObject-related-functions.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <dbus/dbus-glib.h>
</pre>
</div>
<div class="refsect1">
<a name="dbus-glib-DBus-GObject-related-functions.description"></a><h2>Description</h2>
<p>FIXME</p>
</div>
<div class="refsect1">
<a name="dbus-glib-DBus-GObject-related-functions.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="dbus-g-object-type-install-info"></a><h3>dbus_g_object_type_install_info ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
dbus_g_object_type_install_info (<em class="parameter"><code><span class="type">GType</span> object_type</code></em>,
<em class="parameter"><code>const <a class="link" href="dbus-glib-DBus-GObject-related-functions.html#DBusGObjectInfo" title="struct DBusGObjectInfo"><span class="type">DBusGObjectInfo</span></a> *info</code></em>);</pre>
<div class="warning">
<p><code class="literal">dbus_g_object_type_install_info</code> is deprecated and should not be used in newly-written code.</p>
<p>New code should use GDBus instead. There is no direct
equivalent for this function.</p>
</div>
<p>Install introspection information about the given object <span class="type">GType</span>
sufficient to allow methods on the object to be invoked by name.
The introspection information is normally generated by
dbus-glib-tool, then this function is called in the
<code class="function">class_init()</code> for the object class.</p>
<p>Once introspection information has been installed, instances of the
object registered with <a class="link" href="dbus-glib-DBusGConnection.html#dbus-g-connection-register-g-object" title="dbus_g_connection_register_g_object ()"><code class="function">dbus_g_connection_register_g_object()</code></a> can have
their methods invoked remotely.</p>
<div class="refsect3">
<a name="dbus-g-object-type-install-info.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>object_type</p></td>
<td class="parameter_description"><p><span class="type">GType</span> for the object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>info</p></td>
<td class="parameter_description"><p>introspection data generated by <span class="type">dbus-glib-tool</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dbus-g-object-type-register-shadow-property"></a><h3>dbus_g_object_type_register_shadow_property ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
dbus_g_object_type_register_shadow_property
(<em class="parameter"><code><span class="type">GType</span> iface_type</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *dbus_prop_name</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *shadow_prop_name</code></em>);</pre>
<div class="warning">
<p><code class="literal">dbus_g_object_type_register_shadow_property</code> is deprecated and should not be used in newly-written code.</p>
<p>New code should use GDBus instead. There is no
equivalent for this function, because GDBus does not conflate
GObject and D-Bus property names in the same way.</p>
</div>
<p>Registers a new property name <em class="parameter"><code>shadow_prop_name</code></em>
that overrides the
<em class="parameter"><code>dbus_prop_name</code></em>
in D-Bus property get/set requests. Since all properties for
all interfaces implemented by a GObject exist in the same namespace, this
allows implementations to use the same property name in two or more D-Bus
interfaces implemented by the same GObject, as long as one of those D-Bus
interface properties is registered with a shadow property name.</p>
<p>For example, if both org.foobar.Baz.InterfaceA and org.foobar.Baz.InterfaceB
have a D-Bus property called "Bork", the developer assigns a shadow property
name to the conflicting property name in one or both of these GInterfaces to
resolve the conflict. Assume the GInterface implementing
org.foobar.Baz.InterfaceA registers a shadow property called "a-bork", while
the GInterface implementing org.foobar.Baz.InterfaceB registers a shadow
property called "b-bork". The GObject implementing both these GInterfaces
would then use <code class="function"><GTKDOCLINK HREF="g-object-class-override-property"><code class="function">g_object_class_override_property()</code></code></GTKDOCLINK> to implement both
"a-bork" and "b-bork" and D-Bus requests for "Bork" on either D-Bus interface
will not conflict.</p>
<div class="refsect3">
<a name="dbus-g-object-type-register-shadow-property.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>iface_type</p></td>
<td class="parameter_description"><p><span class="type">GType</span> for the <span class="type">GInterface</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>dbus_prop_name</p></td>
<td class="parameter_description"><p>D-Bus property name (as specified in the introspection data)
to override with the shadow property name (as specified in the GType's
initialization function, ie glib-style)</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>shadow_prop_name</p></td>
<td class="parameter_description"><p>property name which should override the shadow property</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dbus-g-object-register-marshaller"></a><h3>dbus_g_object_register_marshaller ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
dbus_g_object_register_marshaller (<em class="parameter"><code><span class="type">GClosureMarshal</span> marshaller</code></em>,
<em class="parameter"><code><span class="type">GType</span> rettype</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<div class="warning">
<p><code class="literal">dbus_g_object_register_marshaller</code> is deprecated and should not be used in newly-written code.</p>
<p>New code should use GDBus instead.</p>
</div>
<p>Register a <span class="type">GClosureMarshal</span> to be used for signal invocations,
giving its return type and a list of parameter types,
followed by <code class="literal">G_TYPE_INVALID</code>.</p>
<p>This function is no longer useful, and is only provided
for compatibility with older dbus-glib. The <span class="type">GClosureMarshal</span>
will not be called.</p>
<div class="refsect3">
<a name="dbus-g-object-register-marshaller.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>marshaller</p></td>
<td class="parameter_description"><p>a GClosureMarshal to be used for invocation</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>rettype</p></td>
<td class="parameter_description"><p>a GType for the return type of the function</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p>The parameter <span class="type">GTypes</span>, followed by <code class="literal">G_TYPE_INVALID</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dbus-g-object-register-marshaller-array"></a><h3>dbus_g_object_register_marshaller_array ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
dbus_g_object_register_marshaller_array
(<em class="parameter"><code><span class="type">GClosureMarshal</span> marshaller</code></em>,
<em class="parameter"><code><span class="type">GType</span> rettype</code></em>,
<em class="parameter"><code><span class="type">guint</span> n_types</code></em>,
<em class="parameter"><code>const <span class="type">GType</span> *types</code></em>);</pre>
<div class="warning">
<p><code class="literal">dbus_g_object_register_marshaller_array</code> is deprecated and should not be used in newly-written code.</p>
<p>New code should use GDBus instead.</p>
</div>
<p>Register a <span class="type">GClosureMarshal</span> to be used for signal invocations.
<em class="parameter"><code>see_also</code></em>
<a class="link" href="dbus-glib-DBus-GObject-related-functions.html#dbus-g-object-register-marshaller" title="dbus_g_object_register_marshaller ()"><code class="function">dbus_g_object_register_marshaller()</code></a></p>
<div class="refsect3">
<a name="dbus-g-object-register-marshaller-array.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>marshaller</p></td>
<td class="parameter_description"><p>a <span class="type">GClosureMarshal</span> to be used for invocation</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>rettype</p></td>
<td class="parameter_description"><p>a <span class="type">GType</span> for the return type of the function</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>n_types</p></td>
<td class="parameter_description"><p>number of function parameters</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>types</p></td>
<td class="parameter_description"><p>a C array of GTypes values</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dbus-glib-global-set-disable-legacy-property-access"></a><h3>dbus_glib_global_set_disable_legacy_property_access ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
dbus_glib_global_set_disable_legacy_property_access
(<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<div class="warning">
<p><code class="literal">dbus_glib_global_set_disable_legacy_property_access</code> is deprecated and should not be used in newly-written code.</p>
<p>New code should use GDBus instead. There is no
equivalent for this function.</p>
</div>
<p>For historical reasons, DBus-GLib will allow read-only
access to every GObject property of an object exported
to the bus, regardless of whether or not the property
is listed in the type info installed with
<a class="link" href="dbus-glib-DBus-GObject-related-functions.html#dbus-g-object-type-install-info" title="dbus_g_object_type_install_info ()"><code class="function">dbus_g_object_type_install_info()</code></a>. (Write access is
denied however).</p>
<p>If you wish to restrict even read-only access, you
can call this method to globally change the behavior
for the entire process.</p>
<p class="since">Since: 0.88</p>
</div>
</div>
<div class="refsect1">
<a name="dbus-glib-DBus-GObject-related-functions.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="DBusGObjectInfo"></a><h3>struct DBusGObjectInfo</h3>
<pre class="programlisting">struct DBusGObjectInfo {
int format_version;
const DBusGMethodInfo *method_infos;
int n_method_infos;
const char *data;
const char *exported_signals;
const char *exported_properties;
};
</pre>
<p>Introspection data for a <span class="type">GObject</span>, normally autogenerated by
a tool such as <a class="link" href="dbus-binding-tool.html" title="dbus-binding-tool"><span class="type">dbus-binding-tool</span></a>.</p>
<div class="refsect3">
<a name="DBusGObjectInfo.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><span class="type">int</span> <em class="structfield"><code><a name="DBusGObjectInfo.format-version"></a>format_version</code></em>;</p></td>
<td class="struct_member_description"><p>Allows us to change the rest of this struct
by adding DBusGObjectInfo2, DBusGObjectInfo3, etc.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p>const <a class="link" href="dbus-glib-DBusGMethod.html#DBusGMethodInfo" title="struct DBusGMethodInfo"><span class="type">DBusGMethodInfo</span></a> *<em class="structfield"><code><a name="DBusGObjectInfo.method-infos"></a>method_infos</code></em>;</p></td>
<td class="struct_member_description"><p>Array of method pointers </p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">int</span> <em class="structfield"><code><a name="DBusGObjectInfo.n-method-infos"></a>n_method_infos</code></em>;</p></td>
<td class="struct_member_description"><p>Length of the infos array </p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p>const <span class="type">char</span> *<em class="structfield"><code><a name="DBusGObjectInfo.data"></a>data</code></em>;</p></td>
<td class="struct_member_description"><p>Introspection data </p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p>const <span class="type">char</span> *<em class="structfield"><code><a name="DBusGObjectInfo.exported-signals"></a>exported_signals</code></em>;</p></td>
<td class="struct_member_description"><p>Exported signals</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p>const <span class="type">char</span> *<em class="structfield"><code><a name="DBusGObjectInfo.exported-properties"></a>exported_properties</code></em>;</p></td>
<td class="struct_member_description"><p>Exported properties </p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="dbus-glib-DBus-GObject-related-functions.see-also"></a><h2>See Also</h2>
<p><span class="type">GObject</span></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>
|