Imported Upstream version 2.69.1
[platform/upstream/glib.git] / docs / reference / gio / gio-docs.xml
1 <?xml version="1.0"?>
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">
6 ]>
7 <book lang="en" id="gio" xmlns:xi="http://www.w3.org/2003/XInclude">
8 <title>GIO Reference Manual</title>
9   <bookinfo>
10     <title>GIO Reference Manual</title>
11     <releaseinfo>
12       for GIO &version;
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>.
15     </releaseinfo>
16   </bookinfo>
17
18   <xi:include href="xml/overview.xml"/>
19
20   <part>
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"/>
30     </chapter>
31     <chapter id="file_mon">
32         <title>File System Monitoring</title>
33         <xi:include href="xml/gfilemonitor.xml"/>
34     </chapter>
35     <chapter id="utils">
36         <title>File-related Utilities</title>
37         <xi:include href="xml/gfilenamecompleter.xml"/>
38     </chapter>
39     <chapter id="async">
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"/>
46     </chapter>
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/gzlibcompressor.xml"/>
52         <xi:include href="xml/gzlibdecompressor.xml"/>
53     </chapter>
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"/>
80     </chapter>
81     <chapter id="types">
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"/>
87     </chapter>
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"/>
95     </chapter>
96     <chapter id="icons">
97         <title>Icons</title>
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"/>
105     </chapter>
106     <chapter id="failable_initialization">
107         <title>Failable Initialization</title>
108         <xi:include href="xml/ginitable.xml"/>
109         <xi:include href="xml/gasyncinitable.xml"/>
110     </chapter>
111     <chapter id="subprocesses">
112       <title>Subprocesses</title>
113       <xi:include href="xml/gsubprocess.xml"/>
114       <xi:include href="xml/gsubprocesslauncher.xml"/>
115     </chapter>
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"/>
134     </chapter>
135     <chapter id="highlevel-socket">
136       <title>High-level network functionality</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"/>
146     </chapter>
147     <chapter id="tls">
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"/>
162     </chapter>
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"/>
174     </chapter>
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"/>
186     </chapter>
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"/>
200     </chapter>
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"/>
206     </chapter>
207     <chapter id="resources">
208         <title>Resources</title>
209         <xi:include href="xml/gresource.xml"/>
210     </chapter>
211     <chapter id='permissions'>
212         <title>Permissions</title>
213         <xi:include href="xml/gpermission.xml"/>
214         <xi:include href="xml/gsimplepermission.xml"/>
215     </chapter>
216     <chapter id='data-models'>
217         <title>Data Models</title>
218         <xi:include href="xml/glistmodel.xml"/>
219         <xi:include href="xml/gliststore.xml"/>
220     </chapter>
221
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/gmemorymonitor.xml"/>
236         <xi:include href="xml/gmenumodel.xml"/>
237         <xi:include href="xml/gmenu.xml"/>
238         <xi:include href="xml/gmenuexporter.xml"/>
239         <xi:include href="xml/gdbusmenumodel.xml"/>
240         <xi:include href="xml/gnotification.xml"/>
241         <xi:include href="xml/gpowerprofilemonitor.xml"/>
242     </chapter>
243     <chapter id="extending">
244         <title>Extending GIO</title>
245         <xi:include href="xml/gvfs.xml"/>
246         <xi:include href="xml/giomodule.xml"/>
247         <xi:include href="xml/extensionpoints.xml"/>
248     </chapter>
249     <chapter id="tools">
250         <title>GIO Tools</title>
251         <xi:include href="gio-querymodules.xml"/>
252         <xi:include href="gsettings.xml"/>
253         <xi:include href="glib-compile-schemas.xml"/>
254         <xi:include href="glib-compile-resources.xml"/>
255         <xi:include href="gdbus.xml"/>
256         <xi:include href="xml/gdbus-codegen.xml"/>
257         <xi:include href="gresource.xml"/>
258         <xi:include href="gapplication.xml"/>
259         <xi:include href="gio.xml"/>
260     </chapter>
261     <chapter id="testing">
262         <title>GIO Testing</title>
263         <xi:include href="xml/gtestdbus.xml"/>
264     </chapter>
265     <xi:include href="gio-docs-platform.xml"/>
266   </part>
267
268   <part id="migrating">
269     <title>Migrating to GIO</title>
270     <xi:include href="xml/migrating-posix.xml"/>
271     <xi:include href="xml/migrating-gnome-vfs.xml"/>
272     <xi:include href="xml/migrating-gconf.xml"/>
273     <xi:include href="xml/migrating-gdbus.xml"/>
274   </part>
275
276   <chapter id="gio-hierarchy">
277     <title>Object Hierarchy</title>
278       <xi:include href="xml/tree_index.sgml"/>
279   </chapter>
280   
281   <index id="api-index-full">
282     <title id="index-all">Index</title>
283     <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
284   </index>
285   <index id="api-index-deprecated" role="deprecated">
286     <title>Index of deprecated symbols</title>
287     <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
288   </index>
289   <index id="api-index-2-18" role="2.18">
290     <title>Index of new symbols in 2.18</title>
291     <xi:include href="xml/api-index-2.18.xml"><xi:fallback /></xi:include>
292   </index>
293   <index id="api-index-2-20" role="2.20">
294     <title>Index of new symbols in 2.20</title>
295     <xi:include href="xml/api-index-2.20.xml"><xi:fallback /></xi:include>
296   </index>
297   <index id="api-index-2-22" role="2.22">
298     <title>Index of new symbols in 2.22</title>
299     <xi:include href="xml/api-index-2.22.xml"><xi:fallback /></xi:include>
300   </index>
301   <index id="api-index-2-24" role="2.24">
302     <title>Index of new symbols in 2.24</title>
303     <xi:include href="xml/api-index-2.24.xml"><xi:fallback /></xi:include>
304   </index>
305   <index id="api-index-2-26" role="2.26">
306     <title>Index of new symbols in 2.26</title>
307     <xi:include href="xml/api-index-2.26.xml"><xi:fallback /></xi:include>
308   </index>
309   <index id="api-index-2-28" role="2.28">
310     <title>Index of new symbols in 2.28</title>
311     <xi:include href="xml/api-index-2.28.xml"><xi:fallback /></xi:include>
312   </index>
313   <index id="api-index-2-30" role="2.30">
314     <title>Index of new symbols in 2.30</title>
315     <xi:include href="xml/api-index-2.30.xml"><xi:fallback /></xi:include>
316   </index>
317   <index id="api-index-2-32" role="2.32">
318     <title>Index of new symbols in 2.32</title>
319     <xi:include href="xml/api-index-2.32.xml"><xi:fallback /></xi:include>
320   </index>
321   <index id="api-index-2-34" role="2.34">
322     <title>Index of new symbols in 2.34</title>
323     <xi:include href="xml/api-index-2.34.xml"><xi:fallback /></xi:include>
324   </index>
325   <index id="api-index-2-36" role="2.36">
326     <title>Index of new symbols in 2.36</title>
327     <xi:include href="xml/api-index-2.36.xml"><xi:fallback /></xi:include>
328   </index>
329   <index id="api-index-2-38" role="2.38">
330     <title>Index of new symbols in 2.38</title>
331     <xi:include href="xml/api-index-2.38.xml"><xi:fallback /></xi:include>
332   </index>
333   <index id="api-index-2-40" role="2.40">
334     <title>Index of new symbols in 2.40</title>
335     <xi:include href="xml/api-index-2.40.xml"><xi:fallback /></xi:include>
336   </index>
337   <index id="api-index-2-42" role="2.42">
338     <title>Index of new symbols in 2.42</title>
339     <xi:include href="xml/api-index-2.42.xml"><xi:fallback /></xi:include>
340   </index>
341   <index id="api-index-2-44" role="2.44">
342     <title>Index of new symbols in 2.44</title>
343     <xi:include href="xml/api-index-2.44.xml"><xi:fallback /></xi:include>
344   </index>
345   <index id="api-index-2-46" role="2.46">
346     <title>Index of new symbols in 2.46</title>
347     <xi:include href="xml/api-index-2.46.xml"><xi:fallback /></xi:include>
348   </index>
349   <index id="api-index-2-48" role="2.48">
350     <title>Index of new symbols in 2.48</title>
351     <xi:include href="xml/api-index-2.48.xml"><xi:fallback /></xi:include>
352   </index>
353   <index id="api-index-2-50" role="2.50">
354     <title>Index of new symbols in 2.50</title>
355     <xi:include href="xml/api-index-2.50.xml"><xi:fallback /></xi:include>
356   </index>
357   <index id="api-index-2-52" role="2.52">
358     <title>Index of new symbols in 2.52</title>
359     <xi:include href="xml/api-index-2.52.xml"><xi:fallback /></xi:include>
360   </index>
361   <index id="api-index-2-54" role="2.54">
362     <title>Index of new symbols in 2.54</title>
363     <xi:include href="xml/api-index-2.54.xml"><xi:fallback /></xi:include>
364   </index>
365   <index id="api-index-2-56" role="2.56">
366     <title>Index of new symbols in 2.56</title>
367     <xi:include href="xml/api-index-2.56.xml"><xi:fallback /></xi:include>
368   </index>
369   <index id="api-index-2-58" role="2.58">
370     <title>Index of new symbols in 2.58</title>
371     <xi:include href="xml/api-index-2.58.xml"><xi:fallback /></xi:include>
372   </index>
373   <index id="api-index-2-60" role="2.60">
374     <title>Index of new symbols in 2.60</title>
375     <xi:include href="xml/api-index-2.60.xml"><xi:fallback /></xi:include>
376   </index>
377   <index id="api-index-2-62" role="2.62">
378     <title>Index of new symbols in 2.62</title>
379     <xi:include href="xml/api-index-2.62.xml"><xi:fallback /></xi:include>
380   </index>
381   <index id="api-index-2-64" role="2.64">
382     <title>Index of new symbols in 2.64</title>
383     <xi:include href="xml/api-index-2.64.xml"><xi:fallback /></xi:include>
384   </index>
385   <index id="api-index-2-66" role="2.66">
386     <title>Index of new symbols in 2.66</title>
387     <xi:include href="xml/api-index-2.66.xml"><xi:fallback /></xi:include>
388   </index>
389   <index id="api-index-2-68" role="2.68">
390     <title>Index of new symbols in 2.68</title>
391     <xi:include href="xml/api-index-2.68.xml"><xi:fallback /></xi:include>
392   </index>
393   <index id="api-index-2-70" role="2.70">
394     <title>Index of new symbols in 2.70</title>
395     <xi:include href="xml/api-index-2.70.xml"><xi:fallback /></xi:include>
396   </index>
397
398   <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
399
400 </book>