← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/dbus-glib/oneiric-updates

« back to all changes in this revision

Viewing changes to doc/reference/html/dbus-glib-DBus-GObject-related-functions.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastian Dröge
  • Date: 2006-11-01 10:51:01 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20061101105101-2dbr969h8k05n1b2
Tags: 0.72-0ubuntu1
* Sync with pkg-utopia SVN. This is infact 0.72-1 which sits in NEW
* New upstream release
* debian/control:
  + Require libdbus-1-dev (>= 0.94) and libglib2.0-dev (>= 2.6)
  + Add build dependency on gtk-doc-tools (>= 1.4)
* debian/control,
  debian/libdbus-glib-1-doc.install:
  + Add libdbus-glib-1-doc package

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/html/dbus-glib-DBus-GObject-related-functions.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html>
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
 
5
<title>DBus GObject related functions</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
 
7
<link rel="start" href="index.html" title="D-Bus GLib bindings - Reference Manual">
 
8
<link rel="up" href="ch02.html" title="API Reference">
 
9
<link rel="prev" href="dbus-glib-DBusGConnection.html" title="DBusGConnection">
 
10
<link rel="next" href="dbus-glib-DBusGMessage.html" title="DBusGMessage">
 
11
<meta name="generator" content="GTK-Doc V1.6 (XML mode)">
 
12
<link rel="stylesheet" href="style.css" type="text/css">
 
13
<link rel="chapter" href="ch01.html" title="Introduction">
 
14
<link rel="chapter" href="ch02.html" title="API Reference">
 
15
<link rel="chapter" href="ch03.html" title="Tools Reference">
 
16
</head>
 
17
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
18
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
 
19
<tr valign="middle">
 
20
<td><a accesskey="p" href="dbus-glib-DBusGConnection.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
21
<td><a accesskey="u" href="ch02.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
22
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
23
<th width="100%" align="center">D-Bus GLib bindings - Reference Manual</th>
 
24
<td><a accesskey="n" href="dbus-glib-DBusGMessage.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
25
</tr>
 
26
<tr><td colspan="5" class="shortcuts"><nobr><a href="#top_of_page" class="shortcut">Top</a>
 
27
                  &#160;|&#160;
 
28
                  <a href="#desc" class="shortcut">Description</a></nobr></td></tr>
 
29
</table>
 
30
<div class="refentry" lang="en">
 
31
<a name="dbus-glib-DBus-GObject-related-functions"></a><div class="titlepage"></div>
 
32
<div class="refnamediv"><table width="100%"><tr>
 
33
<td valign="top">
 
34
<h2><span class="refentrytitle"><a name="top_of_page"></a>DBus GObject related functions</span></h2>
 
35
<p>DBus GObject related functions &#8212; Exporting a <span class="type">GObject</span> remotely</p>
 
36
</td>
 
37
<td valign="top" align="right"></td>
 
38
</tr></table></div>
 
39
<div class="refsect1" lang="en">
 
40
<a name="id2528778"></a><h2>Stability Level</h2>
 
41
Stable, unless otherwise indicated
 
42
</div>
 
43
<div class="refsynopsisdiv">
 
44
<a name="synopsis"></a><h2>Synopsis</h2>
 
45
<pre class="synopsis">
 
46
 
 
47
 
 
48
 
 
49
#define     <a href="dbus-glib-DBus-GObject-related-functions.html#DBUS-TYPE-G-OBJECT-PATH:CAPS">DBUS_TYPE_G_OBJECT_PATH</a>
 
50
            <a href="dbus-glib-DBus-GObject-related-functions.html#DBusGObjectInfo">DBusGObjectInfo</a>;
 
51
void        <a href="dbus-glib-DBus-GObject-related-functions.html#dbus-g-object-type-install-info">dbus_g_object_type_install_info</a> (GType object_type,
 
52
                                             const <a href="dbus-glib-DBus-GObject-related-functions.html#DBusGObjectInfo">DBusGObjectInfo</a> *info);
 
53
GType       <a href="dbus-glib-DBus-GObject-related-functions.html#dbus-g-object-path-get-g-type">dbus_g_object_path_get_g_type</a>   (void);
 
54
void        <a href="dbus-glib-DBus-GObject-related-functions.html#dbus-g-object-register-marshaller">dbus_g_object_register_marshaller</a>
 
55
                                            (GClosureMarshal marshaller,
 
56
                                             GType rettype,
 
57
                                             ...);
 
58
void        <a href="dbus-glib-DBus-GObject-related-functions.html#dbus-g-object-register-marshaller-array">dbus_g_object_register_marshaller_array</a>
 
59
                                            (GClosureMarshal marshaller,
 
60
                                             GType rettype,
 
61
                                             guint n_types,
 
62
                                             const GType *types);
 
63
</pre>
 
64
</div>
 
65
<div class="refsect1" lang="en">
 
66
<a name="desc"></a><h2>Description</h2>
 
67
<p>
 
68
FIXME</p>
 
69
<p>
 
70
 
 
71
</p>
 
72
</div>
 
73
<div class="refsect1" lang="en">
 
74
<a name="details"></a><h2>Details</h2>
 
75
<div class="refsect2" lang="en">
 
76
<a name="id2546508"></a><h3>
 
77
<a name="DBUS-TYPE-G-OBJECT-PATH:CAPS"></a>DBUS_TYPE_G_OBJECT_PATH</h3>
 
78
<a class="indexterm" name="id2543352"></a><pre class="programlisting">#define DBUS_TYPE_G_OBJECT_PATH (dbus_g_object_path_get_g_type ())
 
79
</pre>
 
80
<p>
 
81
 
 
82
</p>
 
83
</div>
 
84
<hr>
 
85
<div class="refsect2" lang="en">
 
86
<a name="id2543368"></a><h3>
 
87
<a name="DBusGObjectInfo"></a>DBusGObjectInfo</h3>
 
88
<a class="indexterm" name="id2543380"></a><pre class="programlisting">typedef struct {
 
89
  int   format_version;
 
90
                       
 
91
  const DBusGMethodInfo *method_infos;
 
92
  int   n_method_infos;                
 
93
  const char *data; 
 
94
  const char *exported_signals;  
 
95
  const char *exported_properties; 
 
96
} DBusGObjectInfo;
 
97
</pre>
 
98
<p>
 
99
Introspection data for a <span class="type">GObject</span>, normally autogenerated by
 
100
a tool such as <a href="dbus-binding-tool.html" title="dbus-binding-tool"><span class="type">dbus-binding-tool</span></a>.</p>
 
101
<p>
 
102
 
 
103
</p>
 
104
<div class="variablelist"><table border="0">
 
105
<col align="left" valign="top">
 
106
<tbody>
 
107
<tr>
 
108
<td>
 
109
<span class="term">int&#160;<em class="structfield"><code>format_version</code></em>;</span></td>
 
110
<td> Allows us to change the rest of this struct
 
111
  by adding DBusGObjectInfo2, DBusGObjectInfo3, etc.
 
112
</td>
 
113
</tr>
 
114
<tr>
 
115
<td>
 
116
<span class="term">const&#160;<a href="dbus-glib-DBusGMethod.html#DBusGMethodInfo">DBusGMethodInfo</a>&#160;*<em class="structfield"><code>method_infos</code></em>;</span></td>
 
117
<td>  Array of method pointers 
 
118
</td>
 
119
</tr>
 
120
<tr>
 
121
<td>
 
122
<span class="term">int&#160;<em class="structfield"><code>n_method_infos</code></em>;</span></td>
 
123
<td> Length of the infos array 
 
124
</td>
 
125
</tr>
 
126
<tr>
 
127
<td>
 
128
<span class="term">const&#160;char&#160;*<em class="structfield"><code>data</code></em>;</span></td>
 
129
<td> Introspection data 
 
130
</td>
 
131
</tr>
 
132
<tr>
 
133
<td>
 
134
<span class="term">const&#160;char&#160;*<em class="structfield"><code>exported_signals</code></em>;</span></td>
 
135
<td> Exported signals
 
136
</td>
 
137
</tr>
 
138
<tr>
 
139
<td>
 
140
<span class="term">const&#160;char&#160;*<em class="structfield"><code>exported_properties</code></em>;</span></td>
 
141
<td> Exported properties 
 
142
</td>
 
143
</tr>
 
144
</tbody>
 
145
</table></div>
 
146
</div>
 
147
<hr>
 
148
<div class="refsect2" lang="en">
 
149
<a name="id2528288"></a><h3>
 
150
<a name="dbus-g-object-type-install-info"></a>dbus_g_object_type_install_info ()</h3>
 
151
<a class="indexterm" name="id2528302"></a><pre class="programlisting">void        dbus_g_object_type_install_info (GType object_type,
 
152
                                             const <a href="dbus-glib-DBus-GObject-related-functions.html#DBusGObjectInfo">DBusGObjectInfo</a> *info);</pre>
 
153
<p>
 
154
Install introspection information about the given object <span class="type">GType</span>
 
155
sufficient to allow methods on the object to be invoked by name.
 
156
The introspection information is normally generated by
 
157
dbus-glib-tool, then this function is called in the
 
158
<code class="function">class_init()</code> for the object class.
 
159
</p>
 
160
<p>
 
161
Once introspection information has been installed, instances of the
 
162
object registered with #<a href="dbus-glib-DBusGConnection.html#dbus-g-connection-register-g-object"><code class="function">dbus_g_connection_register_g_object()</code></a> can have
 
163
their methods invoked remotely.</p>
 
164
<p>
 
165
 
 
166
</p>
 
167
<div class="variablelist"><table border="0">
 
168
<col align="left" valign="top">
 
169
<tbody>
 
170
<tr>
 
171
<td>
 
172
<span class="term"><em class="parameter"><code>object_type</code></em>&#160;:</span></td>
 
173
<td> <span class="type">GType</span> for the object
 
174
</td>
 
175
</tr>
 
176
<tr>
 
177
<td>
 
178
<span class="term"><em class="parameter"><code>info</code></em>&#160;:</span></td>
 
179
<td> introspection data generated by <span class="type">dbus-glib-tool</span>
 
180
</td>
 
181
</tr>
 
182
</tbody>
 
183
</table></div>
 
184
</div>
 
185
<hr>
 
186
<div class="refsect2" lang="en">
 
187
<a name="id2528424"></a><h3>
 
188
<a name="dbus-g-object-path-get-g-type"></a>dbus_g_object_path_get_g_type ()</h3>
 
189
<a class="indexterm" name="id2528437"></a><pre class="programlisting">GType       dbus_g_object_path_get_g_type   (void);</pre>
 
190
<p>
 
191
 
 
192
</p>
 
193
<div class="variablelist"><table border="0">
 
194
<col align="left" valign="top">
 
195
<tbody><tr>
 
196
<td>
 
197
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
198
<td>
 
199
 
 
200
 
 
201
</td>
 
202
</tr></tbody>
 
203
</table></div>
 
204
</div>
 
205
<hr>
 
206
<div class="refsect2" lang="en">
 
207
<a name="id2528474"></a><h3>
 
208
<a name="dbus-g-object-register-marshaller"></a>dbus_g_object_register_marshaller ()</h3>
 
209
<a class="indexterm" name="id2528488"></a><pre class="programlisting">void        dbus_g_object_register_marshaller
 
210
                                            (GClosureMarshal marshaller,
 
211
                                             GType rettype,
 
212
                                             ...);</pre>
 
213
<p>
 
214
Register a <span class="type">GClosureMarshal</span> to be used for signal invocations,
 
215
giving its return type and a list of parameter types,
 
216
followed by <code class="literal">G_TYPE_INVALID</code>.
 
217
</p>
 
218
<p>
 
219
This function will not be needed once GLib includes libffi.</p>
 
220
<p>
 
221
 
 
222
</p>
 
223
<div class="variablelist"><table border="0">
 
224
<col align="left" valign="top">
 
225
<tbody>
 
226
<tr>
 
227
<td>
 
228
<span class="term"><em class="parameter"><code>marshaller</code></em>&#160;:</span></td>
 
229
<td> a GClosureMarshal to be used for invocation
 
230
</td>
 
231
</tr>
 
232
<tr>
 
233
<td>
 
234
<span class="term"><em class="parameter"><code>rettype</code></em>&#160;:</span></td>
 
235
<td> a GType for the return type of the function
 
236
@:... The parameter <span class="type">GTypes</span>, followed by <code class="literal">G_TYPE_INVALID</code>
 
237
</td>
 
238
</tr>
 
239
<tr>
 
240
<td>
 
241
<span class="term"><em class="parameter"><code>...</code></em>&#160;:</span></td>
 
242
<td>
 
243
 
 
244
 
 
245
</td>
 
246
</tr>
 
247
</tbody>
 
248
</table></div>
 
249
</div>
 
250
<hr>
 
251
<div class="refsect2" lang="en">
 
252
<a name="id2545583"></a><h3>
 
253
<a name="dbus-g-object-register-marshaller-array"></a>dbus_g_object_register_marshaller_array ()</h3>
 
254
<a class="indexterm" name="id2545596"></a><pre class="programlisting">void        dbus_g_object_register_marshaller_array
 
255
                                            (GClosureMarshal marshaller,
 
256
                                             GType rettype,
 
257
                                             guint n_types,
 
258
                                             const GType *types);</pre>
 
259
<p>
 
260
Register a <span class="type">GClosureMarshal</span> to be used for signal invocations.
 
261
<em class="parameter"><code>see_also</code></em> <a href="dbus-glib-DBus-GObject-related-functions.html#dbus-g-object-register-marshaller"><span class="type">dbus_g_object_register_marshaller</span></a></p>
 
262
<p>
 
263
 
 
264
</p>
 
265
<div class="variablelist"><table border="0">
 
266
<col align="left" valign="top">
 
267
<tbody>
 
268
<tr>
 
269
<td>
 
270
<span class="term"><em class="parameter"><code>marshaller</code></em>&#160;:</span></td>
 
271
<td> a <span class="type">GClosureMarshal</span> to be used for invocation
 
272
</td>
 
273
</tr>
 
274
<tr>
 
275
<td>
 
276
<span class="term"><em class="parameter"><code>rettype</code></em>&#160;:</span></td>
 
277
<td> a <span class="type">GType</span> for the return type of the function
 
278
</td>
 
279
</tr>
 
280
<tr>
 
281
<td>
 
282
<span class="term"><em class="parameter"><code>n_types</code></em>&#160;:</span></td>
 
283
<td> number of function parameters
 
284
</td>
 
285
</tr>
 
286
<tr>
 
287
<td>
 
288
<span class="term"><em class="parameter"><code>types</code></em>&#160;:</span></td>
 
289
<td> a C array of GTypes values
 
290
</td>
 
291
</tr>
 
292
</tbody>
 
293
</table></div>
 
294
</div>
 
295
</div>
 
296
<div class="refsect1" lang="en">
 
297
<a name="id2560700"></a><h2>See Also</h2>
 
298
<span class="type">GObject</span>
 
299
</div>
 
300
</div>
 
301
</body>
 
302
</html>