~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: 2007-07-06 14:00:42 UTC
  • mfrom: (1.1.3 upstream)
  • Revision ID: james.westby@ubuntu.com-20070706140042-zh5qmx99npmoe454
Tags: 0.74-1
* New upstream release.
* debian/rules:
  + Update shlibs to >= 0.74 because of new API.
* debian/control:
  + Use ${binary:Version} to make lintian happy.

Show diffs side-by-side

added added

removed removed

Lines of Context:
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
5
5
<title>DBus GObject related functions</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.71.0">
7
7
<link rel="start" href="index.html" title="D-Bus GLib bindings - Reference Manual">
8
8
<link rel="up" href="ch02.html" title="API Reference">
9
9
<link rel="prev" href="dbus-glib-DBusGConnection.html" title="DBusGConnection">
10
10
<link rel="next" href="dbus-glib-DBusGMessage.html" title="DBusGMessage">
11
 
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
<link rel="chapter" href="ch01.html" title="Introduction">
14
14
<link rel="chapter" href="ch02.html" title="API Reference">
23
23
<th width="100%" align="center">D-Bus GLib bindings - Reference Manual</th>
24
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
25
</tr>
26
 
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2535977" class="shortcut">Top</a>
 
26
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2582765" class="shortcut">Top</a>
27
27
                  &#160;|&#160;
28
 
                  <a href="#id2554120" class="shortcut">Description</a></nobr></td></tr>
 
28
                  <a href="#id2578823" class="shortcut">Description</a></nobr></td></tr>
29
29
</table>
30
30
<div class="refentry" lang="en">
31
31
<a name="dbus-glib-DBus-GObject-related-functions"></a><div class="titlepage"></div>
32
32
<div class="refnamediv"><table width="100%"><tr>
33
33
<td valign="top">
34
34
<h2>
35
 
<a name="id2535977"></a><span class="refentrytitle">DBus GObject related functions</span>
 
35
<a name="id2582765"></a><span class="refentrytitle">DBus GObject related functions</span>
36
36
</h2>
37
37
<p>DBus GObject related functions &#8212; Exporting a <span class="type">GObject</span> remotely</p>
38
38
</td>
39
39
<td valign="top" align="right"></td>
40
40
</tr></table></div>
41
41
<div class="refsect1" lang="en">
42
 
<a name="id2525138"></a><h2>Stability Level</h2>
 
42
<a name="id2561124"></a><h2>Stability Level</h2>
43
43
Stable, unless otherwise indicated
44
44
</div>
45
45
<div class="refsynopsisdiv">
48
48
 
49
49
 
50
50
 
51
 
#define     <a href="dbus-glib-DBus-GObject-related-functions.html#DBUS-TYPE-G-OBJECT-PATH:CAPS">DBUS_TYPE_G_OBJECT_PATH</a>
52
 
            <a href="dbus-glib-DBus-GObject-related-functions.html#DBusGObjectInfo">DBusGObjectInfo</a>;
53
 
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,
54
 
                                             const <a href="dbus-glib-DBus-GObject-related-functions.html#DBusGObjectInfo">DBusGObjectInfo</a> *info);
55
 
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);
56
 
void        <a href="dbus-glib-DBus-GObject-related-functions.html#dbus-g-object-register-marshaller">dbus_g_object_register_marshaller</a>
57
 
                                            (GClosureMarshal marshaller,
58
 
                                             GType rettype,
59
 
                                             ...);
60
 
void        <a href="dbus-glib-DBus-GObject-related-functions.html#dbus-g-object-register-marshaller-array">dbus_g_object_register_marshaller_array</a>
61
 
                                            (GClosureMarshal marshaller,
62
 
                                             GType rettype,
63
 
                                             guint n_types,
64
 
                                             const GType *types);
 
51
#define             <a href="dbus-glib-DBus-GObject-related-functions.html#DBUS-TYPE-G-OBJECT-PATH:CAPS">DBUS_TYPE_G_OBJECT_PATH</a>
 
52
                    <a href="dbus-glib-DBus-GObject-related-functions.html#DBusGObjectInfo">DBusGObjectInfo</a>;
 
53
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,
 
54
                                                         const <a href="dbus-glib-DBus-GObject-related-functions.html#DBusGObjectInfo">DBusGObjectInfo</a> *info);
 
55
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);
 
56
void                <a href="dbus-glib-DBus-GObject-related-functions.html#dbus-g-object-register-marshaller">dbus_g_object_register_marshaller</a>   (GClosureMarshal marshaller,
 
57
                                                         GType rettype,
 
58
                                                         ...);
 
59
void                <a href="dbus-glib-DBus-GObject-related-functions.html#dbus-g-object-register-marshaller-array">dbus_g_object_register_marshaller_array</a>
 
60
                                                        (GClosureMarshal marshaller,
 
61
                                                         GType rettype,
 
62
                                                         guint n_types,
 
63
                                                         const GType *types);
65
64
</pre>
66
65
</div>
67
66
<div class="refsect1" lang="en">
68
 
<a name="id2554120"></a><h2>Description</h2>
 
67
<a name="id2578823"></a><h2>Description</h2>
69
68
<p>
70
69
FIXME</p>
71
70
<p>
73
72
</p>
74
73
</div>
75
74
<div class="refsect1" lang="en">
76
 
<a name="id2554140"></a><h2>Details</h2>
 
75
<a name="id2578842"></a><h2>Details</h2>
77
76
<div class="refsect2" lang="en">
78
 
<a name="id2554150"></a><h3>
 
77
<a name="id2578853"></a><h3>
79
78
<a name="DBUS-TYPE-G-OBJECT-PATH:CAPS"></a>DBUS_TYPE_G_OBJECT_PATH</h3>
80
 
<a class="indexterm" name="id2550996"></a><pre class="programlisting">#define DBUS_TYPE_G_OBJECT_PATH (dbus_g_object_path_get_g_type ())
 
79
<a class="indexterm" name="id2575699"></a><pre class="programlisting">#define DBUS_TYPE_G_OBJECT_PATH (dbus_g_object_path_get_g_type ())
81
80
</pre>
82
81
<p>
83
82
 
85
84
</div>
86
85
<hr>
87
86
<div class="refsect2" lang="en">
88
 
<a name="id2551012"></a><h3>
 
87
<a name="id2575715"></a><h3>
89
88
<a name="DBusGObjectInfo"></a>DBusGObjectInfo</h3>
90
 
<a class="indexterm" name="id2551025"></a><pre class="programlisting">typedef struct {
 
89
<a class="indexterm" name="id2575728"></a><pre class="programlisting">typedef struct {
91
90
  int   format_version;
92
91
                       
93
92
  const DBusGMethodInfo *method_infos;
107
106
<col align="left" valign="top">
108
107
<tbody>
109
108
<tr>
110
 
<td>
111
 
<span class="term">int&#160;<em class="structfield"><code>format_version</code></em>;</span></td>
 
109
<td><span class="term">int&#160;<em class="structfield"><code>format_version</code></em>;</span></td>
112
110
<td> Allows us to change the rest of this struct
113
111
  by adding DBusGObjectInfo2, DBusGObjectInfo3, etc.
114
112
</td>
115
113
</tr>
116
114
<tr>
117
 
<td>
118
 
<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>
 
115
<td><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>
119
116
<td>  Array of method pointers 
120
117
</td>
121
118
</tr>
122
119
<tr>
123
 
<td>
124
 
<span class="term">int&#160;<em class="structfield"><code>n_method_infos</code></em>;</span></td>
 
120
<td><span class="term">int&#160;<em class="structfield"><code>n_method_infos</code></em>;</span></td>
125
121
<td> Length of the infos array 
126
122
</td>
127
123
</tr>
128
124
<tr>
129
 
<td>
130
 
<span class="term">const&#160;char&#160;*<em class="structfield"><code>data</code></em>;</span></td>
 
125
<td><span class="term">const&#160;char&#160;*<em class="structfield"><code>data</code></em>;</span></td>
131
126
<td> Introspection data 
132
127
</td>
133
128
</tr>
134
129
<tr>
135
 
<td>
136
 
<span class="term">const&#160;char&#160;*<em class="structfield"><code>exported_signals</code></em>;</span></td>
 
130
<td><span class="term">const&#160;char&#160;*<em class="structfield"><code>exported_signals</code></em>;</span></td>
137
131
<td> Exported signals
138
132
</td>
139
133
</tr>
140
134
<tr>
141
 
<td>
142
 
<span class="term">const&#160;char&#160;*<em class="structfield"><code>exported_properties</code></em>;</span></td>
 
135
<td><span class="term">const&#160;char&#160;*<em class="structfield"><code>exported_properties</code></em>;</span></td>
143
136
<td> Exported properties 
144
137
</td>
145
138
</tr>
148
141
</div>
149
142
<hr>
150
143
<div class="refsect2" lang="en">
151
 
<a name="id2550454"></a><h3>
 
144
<a name="id2580202"></a><h3>
152
145
<a name="dbus-g-object-type-install-info"></a>dbus_g_object_type_install_info ()</h3>
153
 
<a class="indexterm" name="id2550468"></a><pre class="programlisting">void        dbus_g_object_type_install_info (GType object_type,
154
 
                                             const <a href="dbus-glib-DBus-GObject-related-functions.html#DBusGObjectInfo">DBusGObjectInfo</a> *info);</pre>
 
146
<a class="indexterm" name="id2580215"></a><pre class="programlisting">void                dbus_g_object_type_install_info     (GType object_type,
 
147
                                                         const <a href="dbus-glib-DBus-GObject-related-functions.html#DBusGObjectInfo">DBusGObjectInfo</a> *info);</pre>
155
148
<p>
156
149
Install introspection information about the given object <span class="type">GType</span>
157
150
sufficient to allow methods on the object to be invoked by name.
170
163
<col align="left" valign="top">
171
164
<tbody>
172
165
<tr>
173
 
<td>
174
 
<span class="term"><em class="parameter"><code>object_type</code></em>&#160;:</span></td>
 
166
<td><span class="term"><em class="parameter"><code>object_type</code></em>&#160;:</span></td>
175
167
<td> <span class="type">GType</span> for the object
176
168
</td>
177
169
</tr>
178
170
<tr>
179
 
<td>
180
 
<span class="term"><em class="parameter"><code>info</code></em>&#160;:</span></td>
 
171
<td><span class="term"><em class="parameter"><code>info</code></em>&#160;:</span></td>
181
172
<td> introspection data generated by <span class="type">dbus-glib-tool</span>
182
173
</td>
183
174
</tr>
186
177
</div>
187
178
<hr>
188
179
<div class="refsect2" lang="en">
189
 
<a name="id2550590"></a><h3>
 
180
<a name="id2580338"></a><h3>
190
181
<a name="dbus-g-object-path-get-g-type"></a>dbus_g_object_path_get_g_type ()</h3>
191
 
<a class="indexterm" name="id2550603"></a><pre class="programlisting">GType       dbus_g_object_path_get_g_type   (void);</pre>
 
182
<a class="indexterm" name="id2580351"></a><pre class="programlisting">GType               dbus_g_object_path_get_g_type       (void);</pre>
192
183
<p>
193
184
 
194
185
</p>
195
186
<div class="variablelist"><table border="0">
196
187
<col align="left" valign="top">
197
188
<tbody><tr>
198
 
<td>
199
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
189
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
200
190
<td>
201
191
 
202
192
 
206
196
</div>
207
197
<hr>
208
198
<div class="refsect2" lang="en">
209
 
<a name="id2550640"></a><h3>
 
199
<a name="id2580388"></a><h3>
210
200
<a name="dbus-g-object-register-marshaller"></a>dbus_g_object_register_marshaller ()</h3>
211
 
<a class="indexterm" name="id2550654"></a><pre class="programlisting">void        dbus_g_object_register_marshaller
212
 
                                            (GClosureMarshal marshaller,
213
 
                                             GType rettype,
214
 
                                             ...);</pre>
 
201
<a class="indexterm" name="id2580402"></a><pre class="programlisting">void                dbus_g_object_register_marshaller   (GClosureMarshal marshaller,
 
202
                                                         GType rettype,
 
203
                                                         ...);</pre>
215
204
<p>
216
205
Register a <span class="type">GClosureMarshal</span> to be used for signal invocations,
217
206
giving its return type and a list of parameter types,
226
215
<col align="left" valign="top">
227
216
<tbody>
228
217
<tr>
229
 
<td>
230
 
<span class="term"><em class="parameter"><code>marshaller</code></em>&#160;:</span></td>
 
218
<td><span class="term"><em class="parameter"><code>marshaller</code></em>&#160;:</span></td>
231
219
<td> a GClosureMarshal to be used for invocation
232
220
</td>
233
221
</tr>
234
222
<tr>
235
 
<td>
236
 
<span class="term"><em class="parameter"><code>rettype</code></em>&#160;:</span></td>
 
223
<td><span class="term"><em class="parameter"><code>rettype</code></em>&#160;:</span></td>
237
224
<td> a GType for the return type of the function
238
225
@:... The parameter <span class="type">GTypes</span>, followed by <code class="literal">G_TYPE_INVALID</code>
239
226
</td>
240
227
</tr>
241
228
<tr>
242
 
<td>
243
 
<span class="term"><em class="parameter"><code>...</code></em>&#160;:</span></td>
 
229
<td><span class="term"><em class="parameter"><code>...</code></em>&#160;:</span></td>
244
230
<td>
245
231
 
246
232
 
251
237
</div>
252
238
<hr>
253
239
<div class="refsect2" lang="en">
254
 
<a name="id2553226"></a><h3>
 
240
<a name="id2577931"></a><h3>
255
241
<a name="dbus-g-object-register-marshaller-array"></a>dbus_g_object_register_marshaller_array ()</h3>
256
 
<a class="indexterm" name="id2553240"></a><pre class="programlisting">void        dbus_g_object_register_marshaller_array
257
 
                                            (GClosureMarshal marshaller,
258
 
                                             GType rettype,
259
 
                                             guint n_types,
260
 
                                             const GType *types);</pre>
 
242
<a class="indexterm" name="id2577944"></a><pre class="programlisting">void                dbus_g_object_register_marshaller_array
 
243
                                                        (GClosureMarshal marshaller,
 
244
                                                         GType rettype,
 
245
                                                         guint n_types,
 
246
                                                         const GType *types);</pre>
261
247
<p>
262
248
Register a <span class="type">GClosureMarshal</span> to be used for signal invocations.
263
249
<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>
268
254
<col align="left" valign="top">
269
255
<tbody>
270
256
<tr>
271
 
<td>
272
 
<span class="term"><em class="parameter"><code>marshaller</code></em>&#160;:</span></td>
 
257
<td><span class="term"><em class="parameter"><code>marshaller</code></em>&#160;:</span></td>
273
258
<td> a <span class="type">GClosureMarshal</span> to be used for invocation
274
259
</td>
275
260
</tr>
276
261
<tr>
277
 
<td>
278
 
<span class="term"><em class="parameter"><code>rettype</code></em>&#160;:</span></td>
 
262
<td><span class="term"><em class="parameter"><code>rettype</code></em>&#160;:</span></td>
279
263
<td> a <span class="type">GType</span> for the return type of the function
280
264
</td>
281
265
</tr>
282
266
<tr>
283
 
<td>
284
 
<span class="term"><em class="parameter"><code>n_types</code></em>&#160;:</span></td>
 
267
<td><span class="term"><em class="parameter"><code>n_types</code></em>&#160;:</span></td>
285
268
<td> number of function parameters
286
269
</td>
287
270
</tr>
288
271
<tr>
289
 
<td>
290
 
<span class="term"><em class="parameter"><code>types</code></em>&#160;:</span></td>
 
272
<td><span class="term"><em class="parameter"><code>types</code></em>&#160;:</span></td>
291
273
<td> a C array of GTypes values
292
274
</td>
293
275
</tr>
296
278
</div>
297
279
</div>
298
280
<div class="refsect1" lang="en">
299
 
<a name="id2568342"></a><h2>See Also</h2>
 
281
<a name="id2593045"></a><h2>See Also</h2>
300
282
<span class="type">GObject</span>
301
283
</div>
302
284
</div>