2 <!-- Fully Loaded Interface -->
3 <interface name="org.project.Bar">
4 <annotation name="org.gtk.GDBus.DocString" value="The org.project.Bar interface is very complicated."/>
5 <annotation name="org.gtk.GDBus.DocString.Short" value="Brief interface doc string"/>
7 <method name="HelloWorld">
8 <annotation name="org.gtk.GDBus.DocString" value="Method <emphasis>documentation</emphasis> blablablabla."/>
9 <annotation name="ExistingAnnotation" value="blah"/>
10 <annotation name="org.gtk.GDBus.ExistingInternalAnnotation" value="booh"/>
11 <arg name="greeting" direction="in" type="s">
12 <annotation name="org.gtk.GDBus.DocString" value="in param doc"/>
14 <arg name="response" direction="out" type="s">
15 <annotation name="org.gtk.GDBus.DocString" value="out param doc"/>
19 <method name="TestPrimitiveTypes">
20 <arg direction="in" type="y" name="val_byte" />
21 <arg direction="in" type="b" name="val_boolean" />
22 <arg direction="in" type="n" name="val_int16" />
23 <arg direction="in" type="q" name="val_uint16" />
24 <arg direction="in" type="i" name="val_int32" />
25 <arg direction="in" type="u" name="val_uint32" />
26 <arg direction="in" type="x" name="val_int64" />
27 <arg direction="in" type="t" name="val_uint64" />
28 <arg direction="in" type="d" name="val_double" />
29 <arg direction="in" type="s" name="val_string" />
30 <arg direction="in" type="o" name="val_objpath" />
31 <arg direction="in" type="g" name="val_signature" />
32 <arg direction="in" type="ay" name="val_bytestring" />
33 <arg direction="out" type="y" name="ret_byte" />
34 <arg direction="out" type="b" name="ret_boolean" />
35 <arg direction="out" type="n" name="ret_int16" />
36 <arg direction="out" type="q" name="ret_uint16" />
37 <arg direction="out" type="i" name="ret_int32" />
38 <arg direction="out" type="u" name="ret_uint32" />
39 <arg direction="out" type="x" name="ret_int64" />
40 <arg direction="out" type="t" name="ret_uint64" />
41 <arg direction="out" type="d" name="ret_double" />
42 <arg direction="out" type="s" name="ret_string" />
43 <arg direction="out" type="o" name="ret_objpath" />
44 <arg direction="out" type="g" name="ret_signature" />
45 <arg direction="out" type="ay" name="ret_bytestring" />
48 <method name="TestNonPrimitiveTypes">
49 <arg direction="in" type="a{ss}" name="dict_s_to_s" />
50 <arg direction="in" type="a{s(ii)}" name="dict_s_to_pairs" />
51 <arg direction="in" type="(iss)" name="a_struct" />
52 <arg direction="in" type="as" name="array_of_strings" />
53 <arg direction="in" type="ao" name="array_of_objpaths" />
54 <arg direction="in" type="ag" name="array_of_signatures" />
55 <arg direction="in" type="aay" name="array_of_bytestrings" />
56 <arg direction="out" type="ay" name="result" />
59 <method name="RequestSignalEmission">
60 <arg direction="in" type="i" name="which_one" />
63 <method name="RequestMultiPropertyMods"/>
65 <method name="UnimplementedMethod"/>
67 <signal name="TestSignal">
68 <annotation name="org.gtk.GDBus.DocString" value="Signal documentation."/>
69 <arg type="i" name="val_int32">
70 <annotation name="org.gtk.GDBus.DocString" value="Signal param docs"/>
72 <arg type="as" name="array_of_strings" />
73 <arg type="aay" name="array_of_bytestrings" />
74 <arg type="a{s(ii)}" name="dict_s_to_pairs" />
77 <signal name="AnotherSignal">
78 <arg type="s" name="word" />
81 <property name="y" type="y" access="readwrite">
82 <annotation name="org.gtk.GDBus.DocString" value="<para>Property docs, yah...</para><para>Second paragraph.</para>"/>
84 <property name="b" type="b" access="readwrite"/>
85 <property name="n" type="n" access="readwrite"/>
86 <property name="q" type="q" access="readwrite"/>
87 <property name="i" type="i" access="readwrite"/>
88 <property name="u" type="u" access="readwrite"/>
89 <property name="x" type="x" access="readwrite"/>
90 <property name="t" type="t" access="readwrite"/>
91 <property name="d" type="d" access="readwrite"/>
92 <property name="s" type="s" access="readwrite"/>
93 <property name="o" type="o" access="readwrite"/>
94 <property name="g" type="g" access="readwrite"/>
95 <property name="ay" type="ay" access="readwrite"/>
96 <property name="as" type="as" access="readwrite"/>
97 <property name="aay" type="aay" access="readwrite"/>
98 <property name="ao" type="ao" access="readwrite"/>
99 <property name="ag" type="ag" access="readwrite"/>
100 <property name="FinallyNormalName" type="s" access="readwrite"/>
101 <property name="ReadonlyProperty" type="s" access="read"/>
102 <property name="WriteonlyProperty" type="s" access="write"/>
104 <!-- unset properties -->
105 <property name="unset_i" type="i" access="readwrite"/>
106 <property name="unset_d" type="d" access="readwrite"/>
107 <property name="unset_s" type="s" access="readwrite"/>
108 <property name="unset_o" type="o" access="readwrite"/>
109 <property name="unset_g" type="g" access="readwrite"/>
110 <property name="unset_ay" type="ay" access="readwrite"/>
111 <property name="unset_as" type="as" access="readwrite"/>
112 <property name="unset_ao" type="ao" access="readwrite"/>
113 <property name="unset_ag" type="ag" access="readwrite"/>
114 <property name="unset_struct" type="(idsogayasaoag)" access="readwrite"/>
115 </interface> <!-- End org.project.Bar -->
118 <interface name="org.project.Bar.Frobnicator">
119 <method name="RandomMethod"/>
123 <interface name="org.project.Baz">
126 <!-- Outside D-Bus prefix -->
127 <interface name="com.acme.Coyote">
129 <method name="Sleep"/>
130 <method name="Attack"/>
131 <signal name="Surprised"/>
132 <property name="Mood" type="s" access="read"/>
135 <!-- force various names -->
136 <interface name="com.acme.Rocket">
137 <!-- Forcing the typename via an annotation -->
138 <annotation name="org.gtk.GDBus.C.Name" value="Rocket123"/>
140 <!-- ditto method -->
141 <method name="Ignite">
142 <annotation name="org.gtk.GDBus.C.Name" value="ignite_xyz"/>
145 <!-- ditto signal -->
146 <signal name="Exploded">
147 <annotation name="org.gtk.GDBus.C.Name" value="exploded-xyz"/>
150 <!-- ditto property -->
151 <property name="Speed" type="d" access="read">
152 <annotation name="org.gtk.GDBus.C.Name" value="speed-xyz"/>
155 <property name="Direction" type="(ddd)" access="read"/>
157 <!-- Check there's no conflict with the GType iface_name_get_type() function -->
158 <property name="Type" type="s" access="read"/>
161 <!-- Test interface for forcing use of GVariant -->
162 <interface name="org.project.Bat">
164 <!-- Forcing GVariant for types that would be mapped -->
165 <method name="ForceMethod">
166 <arg name="force_in_i" type="i" direction="in">
167 <annotation name="org.gtk.GDBus.C.ForceGVariant" value="true"/>
169 <arg name="force_in_s" type="s" direction="in">
170 <annotation name="org.gtk.GDBus.C.ForceGVariant" value="true"/>
172 <arg name="force_in_ay" type="ay" direction="in">
173 <annotation name="org.gtk.GDBus.C.ForceGVariant" value="true"/>
175 <arg name="force_in_struct" type="(i)" direction="in">
176 <annotation name="org.gtk.GDBus.C.ForceGVariant" value="true"/>
178 <arg name="force_out_i" type="i" direction="out">
179 <annotation name="org.gtk.GDBus.C.ForceGVariant" value="true"/>
181 <arg name="force_out_s" type="s" direction="out">
182 <annotation name="org.gtk.GDBus.C.ForceGVariant" value="true"/>
184 <arg name="force_out_ay" type="ay" direction="out">
185 <annotation name="org.gtk.GDBus.C.ForceGVariant" value="true"/>
187 <arg name="force_out_struct" type="(i)" direction="out">
188 <annotation name="org.gtk.GDBus.C.ForceGVariant" value="true"/>
192 <signal name="ForceSignal">
193 <arg name="force_i" type="i">
194 <annotation name="org.gtk.GDBus.C.ForceGVariant" value="true"/>
196 <arg name="force_s" type="s">
197 <annotation name="org.gtk.GDBus.C.ForceGVariant" value="true"/>
199 <arg name="force_ay" type="ay">
200 <annotation name="org.gtk.GDBus.C.ForceGVariant" value="true"/>
202 <arg name="force_struct" type="(i)">
203 <annotation name="org.gtk.GDBus.C.ForceGVariant" value="true"/>
207 <property name="force_i" type="i" access="readwrite">
208 <annotation name="org.gtk.GDBus.C.ForceGVariant" value="true"/>
210 <property name="force_s" type="s" access="readwrite">
211 <annotation name="org.gtk.GDBus.C.ForceGVariant" value="true"/>
213 <property name="force_ay" type="ay" access="readwrite">
214 <annotation name="org.gtk.GDBus.C.ForceGVariant" value="true"/>
216 <property name="force_struct" type="(i)" access="readwrite">
217 <annotation name="org.gtk.GDBus.C.ForceGVariant" value="true"/>
220 </interface> <!-- End org.project.Bat -->
222 <!-- Test interface for g-authorized-method -->
223 <interface name="org.project.Authorize">
224 <method name="CheckNotAuthorized"/>
225 <method name="CheckAuthorized"/>
226 <method name="CheckNotAuthorizedFromObject"/>
227 </interface> <!-- End org.project.Authorize -->
229 <!-- Test interfaces for handling methods in a thread -->
230 <interface name="org.project.MethodThreads">
231 <method name="GetSelf">
232 <arg name="self_pointer" direction="out" type="s"/>
234 </interface> <!-- End org.project.MethodThreads -->
237 org.project.InlineDocs:
238 @short_description: The short description
240 Here is the <emphasis>longer</emphasis> description.
244 <interface name="org.project.InlineDocs">
248 @greeting: The docs for greeting parameter.
249 @response: The docs for response parameter.
251 The docs for the actual method.
255 Test of inline links: The #org.project.Bar D-Bus interface,
256 org.project.Bar.HelloWorld() method, the
257 #org.project.Bar::TestSignal, the
258 #org.project.InlineDocs:Property3 property.
260 <method name="FooMethod">
261 <arg name="greeting" direction="in" type="s"/>
262 <arg name="response" direction="out" type="s"/>
265 <!-- Method2: foo -->
266 <method name="Method2">
267 <arg name="greeting" direction="in" type="s"/>
268 <arg name="response" direction="out" type="s"/>
273 @blah: The docs for blah parameter.
274 @boo: The docs for boo parameter.
276 The docs for the actual signal.
278 <signal name="BarSignal">
279 <!-- Non-Doc comment -->
280 <arg name="blah" type="s"/>
281 <arg name="boo" type="s"/>
284 <!-- BazProperty: The docs for the property. -->
285 <property name="BazProperty" type="s" access="read"/>
287 <!-- Property2: Another property
288 This should be a new paragraph.
290 <property name="Property2" type="s" access="read"/>
294 This should NOT be a new paragraph.
296 <property name="Property3" type="s" access="read"/>
299 First line. With trailing whitespace.
300 Second line (same paragraph).
302 <property name="Property4" type="s" access="read"/>
305 First line (second paragraph). With trailing whitespace.
306 Second line (same paragraph).
309 2 should include indented space
315 <property name="Property5" type="s" access="read"/>
320 Here's some fancy use of XML inside the comment.
323 <term><option>namespace</option></term>
325 <para>The namespace to use for generated code. In CamelCase format.</para>
329 <term><option>output-prefix</option></term>
332 A prefix to use for all generated files. Defaults to <filename>generated</filename>.
338 <property name="FancyProperty" type="s" access="read"/>
341 <interface name="ChangingInterfaceV1">
342 <method name="FooMethod"/>
343 <method name="BarMethod"/>
344 <method name="BazMethod"/>
345 <signal name="FooSignal"/>
346 <signal name="BarSignal"/>
347 <signal name="BazSignal"/>
350 <interface name="ChangingInterfaceV2">
355 <signal name="NewSignalIn2"/>
360 <method name="NewMethodIn2"/>
362 <!-- reverse order -->
363 <signal name="BazSignal"/>
364 <signal name="BarSignal"/>
365 <signal name="FooSignal"/>
366 <method name="BazMethod"/>
367 <method name="BarMethod"/>
368 <method name="FooMethod"/>
371 <interface name="ChangingInterfaceV10">
376 <signal name="AddedSignalIn10"/>
377 <method name="AddedMethodIn10">
378 <annotation name="org.gtk.GDBus.Since" value="10.0"/>
385 <signal name="NewSignalIn2"/>
390 <method name="NewMethodIn2"/>
392 <!-- reverse order -->
393 <signal name="BazSignal"/>
394 <signal name="BarSignal"/>
395 <signal name="FooSignal"/>
396 <method name="BazMethod"/>
397 <method name="BarMethod"/>
398 <method name="FooMethod"/>
401 <interface name="TestUglyCaseInterface">
402 <annotation name="org.gtk.GDBus.C.Name" value="TesT_ugly_CASE_Interface"/>
404 <method name="GetiSCSIServers">
405 <annotation name="org.gtk.GDBus.C.Name" value="Get_iSCSI_Servers"/>
408 <signal name="serversUPDATEDNOW">
409 <annotation name="org.gtk.GDBus.C.Name" value="Servers_UPDATED_NOW"/>
412 <property name="UGLYNAME" type="i" access="readwrite">
413 <annotation name="org.gtk.GDBus.C.Name" value="UGLY_NAME"/>