2 <!DOCTYPE book PUBLIC '-//OASIS//DTD DocBook XML V4.5//EN'
3 'http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd' [
4 <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
5 <!ENTITY version SYSTEM "version.xml">
7 <book lang="en" id="gio" xmlns:xi="http://www.w3.org/2003/XInclude">
8 <title>GIO Reference Manual</title>
10 <title>GIO Reference Manual</title>
13 The latest version of this documentation can be found on-line at
14 <ulink role="online-location" url="https://developer.gnome.org/gio/unstable/">https://developer.gnome.org/gio/unstable/</ulink>.
18 <xi:include href="xml/overview.xml"/>
21 <title>API Reference</title>
22 <chapter id="file_ops">
23 <title>File Operations</title>
24 <xi:include href="xml/gfile.xml"/>
25 <xi:include href="xml/gfileattribute.xml"/>
26 <xi:include href="xml/gfileinfo.xml"/>
27 <xi:include href="xml/gfileenumerator.xml"/>
28 <xi:include href="xml/gioerror.xml"/>
29 <xi:include href="xml/gmountoperation.xml"/>
31 <chapter id="file_mon">
32 <title>File System Monitoring</title>
33 <xi:include href="xml/gfilemonitor.xml"/>
36 <title>File-related Utilities</title>
37 <xi:include href="xml/gfilenamecompleter.xml"/>
40 <title>Asynchronous I/O</title>
41 <xi:include href="xml/gcancellable.xml"/>
42 <xi:include href="xml/gasyncresult.xml"/>
43 <xi:include href="xml/gtask.xml"/>
44 <xi:include href="xml/gioscheduler.xml"/>
45 <xi:include href="xml/gsimpleasyncresult.xml"/>
47 <chapter id="conversion">
48 <title>Data conversion</title>
49 <xi:include href="xml/gconverter.xml"/>
50 <xi:include href="xml/gcharsetconverter.xml"/>
51 <xi:include href="xml/gzcompressor.xml"/>
52 <xi:include href="xml/gzdecompressor.xml"/>
54 <chapter id="streaming">
55 <title>Streaming I/O</title>
56 <xi:include href="xml/gseekable.xml"/>
57 <xi:include href="xml/ginputstream.xml"/>
58 <xi:include href="xml/goutputstream.xml"/>
59 <xi:include href="xml/giostream.xml"/>
60 <xi:include href="xml/gsimpleiostream.xml"/>
61 <xi:include href="xml/gfileinputstream.xml"/>
62 <xi:include href="xml/gfileoutputstream.xml"/>
63 <xi:include href="xml/gfileiostream.xml"/>
64 <xi:include href="xml/gfiledescriptorbased.xml"/>
65 <xi:include href="xml/gfilterinputstream.xml"/>
66 <xi:include href="xml/gfilteroutputstream.xml"/>
67 <xi:include href="xml/gmemoryinputstream.xml"/>
68 <xi:include href="xml/gmemoryoutputstream.xml"/>
69 <xi:include href="xml/gbufferedinputstream.xml"/>
70 <xi:include href="xml/gbufferedoutputstream.xml"/>
71 <xi:include href="xml/gdatainputstream.xml"/>
72 <xi:include href="xml/gdataoutputstream.xml"/>
73 <xi:include href="xml/gunixinputstream.xml"/>
74 <xi:include href="xml/gunixoutputstream.xml"/>
75 <xi:include href="xml/gconverterinputstream.xml"/>
76 <xi:include href="xml/gconverteroutputstream.xml"/>
77 <xi:include href="xml/gpollableinputstream.xml"/>
78 <xi:include href="xml/gpollableoutputstream.xml"/>
79 <xi:include href="xml/gpollableutils.xml"/>
82 <title>File types and applications</title>
83 <xi:include href="xml/gcontenttype.xml"/>
84 <xi:include href="xml/gappinfo.xml"/>
85 <xi:include href="xml/gappinfomonitor.xml"/>
86 <xi:include href="xml/gdesktopappinfo.xml"/>
88 <chapter id="volume_mon">
89 <title>Volumes and Drives</title>
90 <xi:include href="xml/gvolumemonitor.xml"/>
91 <xi:include href="xml/gvolume.xml"/>
92 <xi:include href="xml/gmount.xml"/>
93 <xi:include href="xml/gdrive.xml"/>
94 <xi:include href="xml/gunixmounts.xml"/>
98 <xi:include href="xml/gicon.xml"/>
99 <xi:include href="xml/gfileicon.xml"/>
100 <xi:include href="xml/gbytesicon.xml"/>
101 <xi:include href="xml/gloadableicon.xml"/>
102 <xi:include href="xml/gthemedicon.xml"/>
103 <xi:include href="xml/gemblemedicon.xml"/>
104 <xi:include href="xml/gemblem.xml"/>
106 <chapter id="failable_initialization">
107 <title>Failable Initialization</title>
108 <xi:include href="xml/ginitable.xml"/>
109 <xi:include href="xml/gasyncinitable.xml"/>
111 <chapter id="subprocesses">
112 <title>Subprocesses</title>
113 <xi:include href="xml/gsubprocess.xml"/>
114 <xi:include href="xml/gsubprocesslauncher.xml"/>
116 <chapter id="networking">
117 <title>Low-level network support</title>
118 <xi:include href="xml/gsocket.xml"/>
119 <xi:include href="xml/gdatagrambased.xml"/>
120 <xi:include href="xml/ginetaddress.xml"/>
121 <xi:include href="xml/ginetaddressmask.xml"/>
122 <xi:include href="xml/gsocketaddress.xml"/>
123 <xi:include href="xml/ginetsocketaddress.xml"/>
124 <xi:include href="xml/gunixsocketaddress.xml"/>
125 <xi:include href="xml/gnativesocketaddress.xml"/>
126 <xi:include href="xml/gsocketcontrolmessage.xml"/>
127 <xi:include href="xml/gunixfdlist.xml"/>
128 <xi:include href="xml/gunixfdmessage.xml"/>
129 <xi:include href="xml/gcredentials.xml"/>
130 <xi:include href="xml/gunixcredentialsmessage.xml"/>
131 <xi:include href="xml/gproxy.xml"/>
132 <xi:include href="xml/gproxyaddress.xml"/>
133 <xi:include href="xml/gnetworking.xml"/>
135 <chapter id="highlevel-socket">
136 <title>High-level network functionallity</title>
137 <xi:include href="xml/gsocketclient.xml"/>
138 <xi:include href="xml/gsocketconnection.xml"/>
139 <xi:include href="xml/gunixconnection.xml"/>
140 <xi:include href="xml/gtcpconnection.xml"/>
141 <xi:include href="xml/gtcpwrapperconnection.xml"/>
142 <xi:include href="xml/gsocketlistener.xml"/>
143 <xi:include href="xml/gsocketservice.xml"/>
144 <xi:include href="xml/gthreadedsocketservice.xml"/>
145 <xi:include href="xml/gnetworkmonitor.xml"/>
148 <title>TLS (SSL) support</title>
149 <xi:include href="xml/gtls.xml"/>
150 <xi:include href="xml/gtlscertificate.xml"/>
151 <xi:include href="xml/gtlsconnection.xml"/>
152 <xi:include href="xml/gtlsclientconnection.xml"/>
153 <xi:include href="xml/gtlsserverconnection.xml"/>
154 <xi:include href="xml/gdtlsconnection.xml"/>
155 <xi:include href="xml/gdtlsclientconnection.xml"/>
156 <xi:include href="xml/gdtlsserverconnection.xml"/>
157 <xi:include href="xml/gtlsbackend.xml"/>
158 <xi:include href="xml/gtlsdatabase.xml"/>
159 <xi:include href="xml/gtlsfiledatabase.xml"/>
160 <xi:include href="xml/gtlsinteraction.xml"/>
161 <xi:include href="xml/gtlspassword.xml"/>
163 <chapter id="resolver">
164 <title>DNS resolution</title>
165 <xi:include href="xml/gresolver.xml"/>
166 <xi:include href="xml/gproxyresolver.xml"/>
167 <xi:include href="xml/gsimpleproxyresolver.xml"/>
168 <xi:include href="xml/gsocketconnectable.xml"/>
169 <xi:include href="xml/gsocketaddressenumerator.xml"/>
170 <xi:include href="xml/gproxyaddressenumerator.xml"/>
171 <xi:include href="xml/gnetworkaddress.xml"/>
172 <xi:include href="xml/gnetworkservice.xml"/>
173 <xi:include href="xml/gsrvtarget.xml"/>
175 <chapter id="gdbus-lowlevel">
176 <title>Low-level D-Bus Support</title>
177 <xi:include href="xml/gdbusutils.xml"/>
178 <xi:include href="xml/gdbusaddress.xml"/>
179 <xi:include href="xml/gdbusintrospection.xml"/>
180 <xi:include href="xml/gdbuserror.xml"/>
181 <xi:include href="xml/gdbusmessage.xml"/>
182 <xi:include href="xml/gdbusconnection.xml"/>
183 <xi:include href="xml/gdbusmethodinvocation.xml"/>
184 <xi:include href="xml/gdbusserver.xml"/>
185 <xi:include href="xml/gdbusauthobserver.xml"/>
187 <chapter id="gdbus-convenience">
188 <title>High-level D-Bus Support</title>
189 <xi:include href="xml/gdbusnameowning.xml"/>
190 <xi:include href="xml/gdbusnamewatching.xml"/>
191 <xi:include href="xml/gdbusinterface.xml"/>
192 <xi:include href="xml/gdbusinterfaceskeleton.xml"/>
193 <xi:include href="xml/gdbusproxy.xml"/>
194 <xi:include href="xml/gdbusobject.xml"/>
195 <xi:include href="xml/gdbusobjectskeleton.xml"/>
196 <xi:include href="xml/gdbusobjectproxy.xml"/>
197 <xi:include href="xml/gdbusobjectmanager.xml"/>
198 <xi:include href="xml/gdbusobjectmanagerserver.xml"/>
199 <xi:include href="xml/gdbusobjectmanagerclient.xml"/>
201 <chapter id="settings">
202 <title>Settings</title>
203 <xi:include href="xml/gsettings.xml"/>
204 <xi:include href="xml/gsettingsbackend.xml"/>
205 <xi:include href="xml/gsettingsschema.xml"/>
207 <chapter id="resources">
208 <title>Resources</title>
209 <xi:include href="xml/gresource.xml"/>
211 <chapter id='permissions'>
212 <title>Permissions</title>
213 <xi:include href="xml/gpermission.xml"/>
214 <xi:include href="xml/gsimplepermission.xml"/>
216 <chapter id='data-models'>
217 <title>Data Models</title>
218 <xi:include href="xml/glistmodel.xml"/>
219 <xi:include href="xml/gliststore.xml"/>
222 <chapter id="application">
223 <title>Application support</title>
224 <xi:include href="xml/gapplication.xml"/>
225 <xi:include href="xml/gapplicationcommandline.xml"/>
226 <xi:include href="xml/gactiongroup.xml"/>
227 <xi:include href="xml/gactionmap.xml"/>
228 <xi:include href="xml/gsimpleactiongroup.xml"/>
229 <xi:include href="xml/gaction.xml"/>
230 <xi:include href="xml/gsimpleaction.xml"/>
231 <xi:include href="xml/gpropertyaction.xml"/>
232 <xi:include href="xml/gremoteactiongroup.xml"/>
233 <xi:include href="xml/gactiongroupexporter.xml"/>
234 <xi:include href="xml/gdbusactiongroup.xml"/>
235 <xi:include href="xml/gmenumodel.xml"/>
236 <xi:include href="xml/gmenu.xml"/>
237 <xi:include href="xml/gmenuexporter.xml"/>
238 <xi:include href="xml/gdbusmenumodel.xml"/>
239 <xi:include href="xml/gnotification.xml"/>
241 <chapter id="extending">
242 <title>Extending GIO</title>
243 <xi:include href="xml/gvfs.xml"/>
244 <xi:include href="xml/giomodule.xml"/>
245 <xi:include href="xml/extensionpoints.xml"/>
248 <title>GIO Tools</title>
249 <xi:include href="gio-querymodules.xml"/>
250 <xi:include href="gsettings.xml"/>
251 <xi:include href="glib-compile-schemas.xml"/>
252 <xi:include href="glib-compile-resources.xml"/>
253 <xi:include href="gdbus.xml"/>
254 <xi:include href="xml/gdbus-codegen.xml"/>
255 <xi:include href="gresource.xml"/>
256 <xi:include href="gapplication.xml"/>
257 <xi:include href="gio.xml"/>
259 <chapter id="testing">
260 <title>GIO Testing</title>
261 <xi:include href="xml/gtestdbus.xml"/>
263 <xi:include href="gio-docs-platform.xml"/>
266 <part id="migrating">
267 <title>Migrating to GIO</title>
268 <xi:include href="xml/migrating-posix.xml"/>
269 <xi:include href="xml/migrating-gnome-vfs.xml"/>
270 <xi:include href="xml/migrating-gconf.xml"/>
271 <xi:include href="xml/migrating-gdbus.xml"/>
274 <chapter id="gio-hierarchy">
275 <title>Object Hierarchy</title>
276 <xi:include href="xml/tree_index.sgml"/>
279 <index id="api-index-full">
280 <title id="index-all">Index</title>
281 <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
283 <index id="api-index-deprecated" role="deprecated">
284 <title>Index of deprecated symbols</title>
285 <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
287 <index id="api-index-2-18" role="2.18">
288 <title>Index of new symbols in 2.18</title>
289 <xi:include href="xml/api-index-2.18.xml"><xi:fallback /></xi:include>
291 <index id="api-index-2-20" role="2.20">
292 <title>Index of new symbols in 2.20</title>
293 <xi:include href="xml/api-index-2.20.xml"><xi:fallback /></xi:include>
295 <index id="api-index-2-22" role="2.22">
296 <title>Index of new symbols in 2.22</title>
297 <xi:include href="xml/api-index-2.22.xml"><xi:fallback /></xi:include>
299 <index id="api-index-2-24" role="2.24">
300 <title>Index of new symbols in 2.24</title>
301 <xi:include href="xml/api-index-2.24.xml"><xi:fallback /></xi:include>
303 <index id="api-index-2-26" role="2.26">
304 <title>Index of new symbols in 2.26</title>
305 <xi:include href="xml/api-index-2.26.xml"><xi:fallback /></xi:include>
307 <index id="api-index-2-28" role="2.28">
308 <title>Index of new symbols in 2.28</title>
309 <xi:include href="xml/api-index-2.28.xml"><xi:fallback /></xi:include>
311 <index id="api-index-2-30" role="2.30">
312 <title>Index of new symbols in 2.30</title>
313 <xi:include href="xml/api-index-2.30.xml"><xi:fallback /></xi:include>
315 <index id="api-index-2-32" role="2.32">
316 <title>Index of new symbols in 2.32</title>
317 <xi:include href="xml/api-index-2.32.xml"><xi:fallback /></xi:include>
319 <index id="api-index-2-34" role="2.34">
320 <title>Index of new symbols in 2.34</title>
321 <xi:include href="xml/api-index-2.34.xml"><xi:fallback /></xi:include>
323 <index id="api-index-2-36" role="2.36">
324 <title>Index of new symbols in 2.36</title>
325 <xi:include href="xml/api-index-2.36.xml"><xi:fallback /></xi:include>
327 <index id="api-index-2-38" role="2.38">
328 <title>Index of new symbols in 2.38</title>
329 <xi:include href="xml/api-index-2.38.xml"><xi:fallback /></xi:include>
331 <index id="api-index-2-40" role="2.40">
332 <title>Index of new symbols in 2.40</title>
333 <xi:include href="xml/api-index-2.40.xml"><xi:fallback /></xi:include>
335 <index id="api-index-2-42" role="2.42">
336 <title>Index of new symbols in 2.42</title>
337 <xi:include href="xml/api-index-2.42.xml"><xi:fallback /></xi:include>
339 <index id="api-index-2-44" role="2.44">
340 <title>Index of new symbols in 2.44</title>
341 <xi:include href="xml/api-index-2.44.xml"><xi:fallback /></xi:include>
343 <index id="api-index-2-46" role="2.46">
344 <title>Index of new symbols in 2.46</title>
345 <xi:include href="xml/api-index-2.46.xml"><xi:fallback /></xi:include>
347 <index id="api-index-2-48" role="2.48">
348 <title>Index of new symbols in 2.48</title>
349 <xi:include href="xml/api-index-2.48.xml"><xi:fallback /></xi:include>
351 <index id="api-index-2-50" role="2.50">
352 <title>Index of new symbols in 2.50</title>
353 <xi:include href="xml/api-index-2.50.xml"><xi:fallback /></xi:include>
355 <index id="api-index-2-52" role="2.52">
356 <title>Index of new symbols in 2.52</title>
357 <xi:include href="xml/api-index-2.52.xml"><xi:fallback /></xi:include>
359 <index id="api-index-2-54" role="2.54">
360 <title>Index of new symbols in 2.54</title>
361 <xi:include href="xml/api-index-2.54.xml"><xi:fallback /></xi:include>
363 <index id="api-index-2-56" role="2.56">
364 <title>Index of new symbols in 2.56</title>
365 <xi:include href="xml/api-index-2.56.xml"><xi:fallback /></xi:include>
367 <index id="api-index-2-58" role="2.58">
368 <title>Index of new symbols in 2.58</title>
369 <xi:include href="xml/api-index-2.58.xml"><xi:fallback /></xi:include>
371 <index id="api-index-2-60" role="2.60">
372 <title>Index of new symbols in 2.60</title>
373 <xi:include href="xml/api-index-2.60.xml"><xi:fallback /></xi:include>
376 <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>