Imported Upstream version 2.59.0
[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/gzcompressor.xml"/>
52         <xi:include href="xml/gzdecompressor.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/gwin32inputstream.xml"/>
76         <xi:include href="xml/gwin32outputstream.xml"/>
77         <xi:include href="xml/gconverterinputstream.xml"/>
78         <xi:include href="xml/gconverteroutputstream.xml"/>
79         <xi:include href="xml/gpollableinputstream.xml"/>
80         <xi:include href="xml/gpollableoutputstream.xml"/>
81         <xi:include href="xml/gpollableutils.xml"/>
82     </chapter>
83     <chapter id="types">
84         <title>File types and applications</title>
85         <xi:include href="xml/gcontenttype.xml"/>
86         <xi:include href="xml/gappinfo.xml"/>
87         <xi:include href="xml/gappinfomonitor.xml"/>
88         <xi:include href="xml/gdesktopappinfo.xml"/>
89     </chapter>
90     <chapter id="volume_mon">
91         <title>Volumes and Drives</title>
92         <xi:include href="xml/gvolumemonitor.xml"/>
93         <xi:include href="xml/gvolume.xml"/>
94         <xi:include href="xml/gmount.xml"/>
95         <xi:include href="xml/gdrive.xml"/>
96         <xi:include href="xml/gunixmounts.xml"/>
97     </chapter>
98     <chapter id="icons">
99         <title>Icons</title>
100         <xi:include href="xml/gicon.xml"/>
101         <xi:include href="xml/gfileicon.xml"/>
102         <xi:include href="xml/gbytesicon.xml"/>
103         <xi:include href="xml/gloadableicon.xml"/>
104         <xi:include href="xml/gthemedicon.xml"/>
105         <xi:include href="xml/gemblemedicon.xml"/>
106         <xi:include href="xml/gemblem.xml"/>
107     </chapter>
108     <chapter id="failable_initialization">
109         <title>Failable Initialization</title>
110         <xi:include href="xml/ginitable.xml"/>
111         <xi:include href="xml/gasyncinitable.xml"/>
112     </chapter>
113     <chapter id="subprocesses">
114       <title>Subprocesses</title>
115       <xi:include href="xml/gsubprocess.xml"/>
116       <xi:include href="xml/gsubprocesslauncher.xml"/>
117     </chapter>
118     <chapter id="networking">
119       <title>Low-level network support</title>
120       <xi:include href="xml/gsocket.xml"/>
121       <xi:include href="xml/gdatagrambased.xml"/>
122       <xi:include href="xml/ginetaddress.xml"/>
123       <xi:include href="xml/ginetaddressmask.xml"/>
124       <xi:include href="xml/gsocketaddress.xml"/>
125       <xi:include href="xml/ginetsocketaddress.xml"/>
126       <xi:include href="xml/gunixsocketaddress.xml"/>
127       <xi:include href="xml/gsocketcontrolmessage.xml"/>
128       <xi:include href="xml/gunixfdlist.xml"/>
129       <xi:include href="xml/gunixfdmessage.xml"/>
130       <xi:include href="xml/gcredentials.xml"/>
131       <xi:include href="xml/gunixcredentialsmessage.xml"/>
132       <xi:include href="xml/gproxy.xml"/>
133       <xi:include href="xml/gproxyaddress.xml"/>
134       <xi:include href="xml/gnetworking.xml"/>
135     </chapter>
136     <chapter id="highlevel-socket">
137       <title>High-level network functionallity</title>
138       <xi:include href="xml/gsocketclient.xml"/>
139       <xi:include href="xml/gsocketconnection.xml"/>
140       <xi:include href="xml/gunixconnection.xml"/>
141       <xi:include href="xml/gtcpconnection.xml"/>
142       <xi:include href="xml/gtcpwrapperconnection.xml"/>
143       <xi:include href="xml/gsocketlistener.xml"/>
144       <xi:include href="xml/gsocketservice.xml"/>
145       <xi:include href="xml/gthreadedsocketservice.xml"/>
146       <xi:include href="xml/gnetworkmonitor.xml"/>
147     </chapter>
148     <chapter id="tls">
149       <title>TLS (SSL) support</title>
150       <xi:include href="xml/gtls.xml"/>
151       <xi:include href="xml/gtlscertificate.xml"/>
152       <xi:include href="xml/gtlsconnection.xml"/>
153       <xi:include href="xml/gtlsclientconnection.xml"/>
154       <xi:include href="xml/gtlsserverconnection.xml"/>
155       <xi:include href="xml/gdtlsconnection.xml"/>
156       <xi:include href="xml/gdtlsclientconnection.xml"/>
157       <xi:include href="xml/gdtlsserverconnection.xml"/>
158       <xi:include href="xml/gtlsbackend.xml"/>
159       <xi:include href="xml/gtlsdatabase.xml"/>
160       <xi:include href="xml/gtlsfiledatabase.xml"/>
161       <xi:include href="xml/gtlsinteraction.xml"/>
162       <xi:include href="xml/gtlspassword.xml"/>
163     </chapter>
164     <chapter id="resolver">
165       <title>DNS resolution</title>
166       <xi:include href="xml/gresolver.xml"/>
167       <xi:include href="xml/gproxyresolver.xml"/>
168       <xi:include href="xml/gsimpleproxyresolver.xml"/>
169       <xi:include href="xml/gsocketconnectable.xml"/>
170       <xi:include href="xml/gsocketaddressenumerator.xml"/>
171       <xi:include href="xml/gproxyaddressenumerator.xml"/>
172       <xi:include href="xml/gnetworkaddress.xml"/>
173       <xi:include href="xml/gnetworkservice.xml"/>
174       <xi:include href="xml/gsrvtarget.xml"/>
175     </chapter>
176     <chapter id="gdbus-lowlevel">
177       <title>Low-level D-Bus Support</title>
178       <xi:include href="xml/gdbusutils.xml"/>
179       <xi:include href="xml/gdbusaddress.xml"/>
180       <xi:include href="xml/gdbusintrospection.xml"/>
181       <xi:include href="xml/gdbuserror.xml"/>
182       <xi:include href="xml/gdbusmessage.xml"/>
183       <xi:include href="xml/gdbusconnection.xml"/>
184       <xi:include href="xml/gdbusmethodinvocation.xml"/>
185       <xi:include href="xml/gdbusserver.xml"/>
186       <xi:include href="xml/gdbusauthobserver.xml"/>
187     </chapter>
188     <chapter id="gdbus-convenience">
189       <title>High-level D-Bus Support</title>
190       <xi:include href="xml/gdbusnameowning.xml"/>
191       <xi:include href="xml/gdbusnamewatching.xml"/>
192       <xi:include href="xml/gdbusinterface.xml"/>
193       <xi:include href="xml/gdbusinterfaceskeleton.xml"/>
194       <xi:include href="xml/gdbusproxy.xml"/>
195       <xi:include href="xml/gdbusobject.xml"/>
196       <xi:include href="xml/gdbusobjectskeleton.xml"/>
197       <xi:include href="xml/gdbusobjectproxy.xml"/>
198       <xi:include href="xml/gdbusobjectmanager.xml"/>
199       <xi:include href="xml/gdbusobjectmanagerserver.xml"/>
200       <xi:include href="xml/gdbusobjectmanagerclient.xml"/>
201     </chapter>
202     <chapter id="settings">
203         <title>Settings</title>
204         <xi:include href="xml/gsettings.xml"/>
205         <xi:include href="xml/gsettingsbackend.xml"/>
206         <xi:include href="xml/gsettingsschema.xml"/>
207     </chapter>
208     <chapter id="resources">
209         <title>Resources</title>
210         <xi:include href="xml/gresource.xml"/>
211     </chapter>
212     <chapter id='permissions'>
213         <title>Permissions</title>
214         <xi:include href="xml/gpermission.xml"/>
215         <xi:include href="xml/gsimplepermission.xml"/>
216     </chapter>
217     <chapter id='data-models'>
218         <title>Data Models</title>
219         <xi:include href="xml/glistmodel.xml"/>
220         <xi:include href="xml/gliststore.xml"/>
221     </chapter>
222     <chapter id='registry'>
223         <title>Win32 registry support</title>
224         <xi:include href="xml/gwin32registrykey.xml"/>
225     </chapter>
226     <chapter id="application">
227         <title>Application support</title>
228         <xi:include href="xml/gapplication.xml"/>
229         <xi:include href="xml/gapplicationcommandline.xml"/>
230         <xi:include href="xml/gactiongroup.xml"/>
231         <xi:include href="xml/gactionmap.xml"/>
232         <xi:include href="xml/gsimpleactiongroup.xml"/>
233         <xi:include href="xml/gaction.xml"/>
234         <xi:include href="xml/gsimpleaction.xml"/>
235         <xi:include href="xml/gpropertyaction.xml"/>
236         <xi:include href="xml/gremoteactiongroup.xml"/>
237         <xi:include href="xml/gactiongroupexporter.xml"/>
238         <xi:include href="xml/gdbusactiongroup.xml"/>
239         <xi:include href="xml/gmenumodel.xml"/>
240         <xi:include href="xml/gmenu.xml"/>
241         <xi:include href="xml/gmenuexporter.xml"/>
242         <xi:include href="xml/gdbusmenumodel.xml"/>
243         <xi:include href="xml/gnotification.xml"/>
244     </chapter>
245     <chapter id="extending">
246         <title>Extending GIO</title>
247         <xi:include href="xml/gvfs.xml"/>
248         <xi:include href="xml/giomodule.xml"/>
249         <xi:include href="xml/extensionpoints.xml"/>
250     </chapter>
251     <chapter id="tools">
252         <title>GIO Tools</title>
253         <xi:include href="gio-querymodules.xml"/>
254         <xi:include href="gsettings.xml"/>
255         <xi:include href="glib-compile-schemas.xml"/>
256         <xi:include href="glib-compile-resources.xml"/>
257         <xi:include href="gdbus.xml"/>
258         <xi:include href="xml/gdbus-codegen.xml"/>
259         <xi:include href="gresource.xml"/>
260         <xi:include href="gapplication.xml"/>
261         <xi:include href="gio.xml"/>
262     </chapter>
263     <chapter id="testing">
264         <title>GIO Testing</title>
265         <xi:include href="xml/gtestdbus.xml"/>
266     </chapter>
267   </part>
268
269   <part id="migrating">
270     <title>Migrating to GIO</title>
271     <xi:include href="xml/migrating-posix.xml"/>
272     <xi:include href="xml/migrating-gnome-vfs.xml"/>
273     <xi:include href="xml/migrating-gconf.xml"/>
274     <xi:include href="xml/migrating-gdbus.xml"/>
275   </part>
276
277   <chapter id="gio-hierarchy">
278     <title>Object Hierarchy</title>
279       <xi:include href="xml/tree_index.sgml"/>
280   </chapter>
281   
282   <index id="api-index-full">
283     <title id="index-all">Index</title>
284     <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
285   </index>
286   <index id="api-index-deprecated" role="deprecated">
287     <title>Index of deprecated symbols</title>
288     <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
289   </index>
290   <index id="api-index-2-18" role="2.18">
291     <title>Index of new symbols in 2.18</title>
292     <xi:include href="xml/api-index-2.18.xml"><xi:fallback /></xi:include>
293   </index>
294   <index id="api-index-2-20" role="2.20">
295     <title>Index of new symbols in 2.20</title>
296     <xi:include href="xml/api-index-2.20.xml"><xi:fallback /></xi:include>
297   </index>
298   <index id="api-index-2-22" role="2.22">
299     <title>Index of new symbols in 2.22</title>
300     <xi:include href="xml/api-index-2.22.xml"><xi:fallback /></xi:include>
301   </index>
302   <index id="api-index-2-24" role="2.24">
303     <title>Index of new symbols in 2.24</title>
304     <xi:include href="xml/api-index-2.24.xml"><xi:fallback /></xi:include>
305   </index>
306   <index id="api-index-2-26" role="2.26">
307     <title>Index of new symbols in 2.26</title>
308     <xi:include href="xml/api-index-2.26.xml"><xi:fallback /></xi:include>
309   </index>
310   <index id="api-index-2-28" role="2.28">
311     <title>Index of new symbols in 2.28</title>
312     <xi:include href="xml/api-index-2.28.xml"><xi:fallback /></xi:include>
313   </index>
314   <index id="api-index-2-30" role="2.30">
315     <title>Index of new symbols in 2.30</title>
316     <xi:include href="xml/api-index-2.30.xml"><xi:fallback /></xi:include>
317   </index>
318   <index id="api-index-2-32" role="2.32">
319     <title>Index of new symbols in 2.32</title>
320     <xi:include href="xml/api-index-2.32.xml"><xi:fallback /></xi:include>
321   </index>
322   <index id="api-index-2-34" role="2.34">
323     <title>Index of new symbols in 2.34</title>
324     <xi:include href="xml/api-index-2.34.xml"><xi:fallback /></xi:include>
325   </index>
326   <index id="api-index-2-36" role="2.36">
327     <title>Index of new symbols in 2.36</title>
328     <xi:include href="xml/api-index-2.36.xml"><xi:fallback /></xi:include>
329   </index>
330   <index id="api-index-2-38" role="2.38">
331     <title>Index of new symbols in 2.38</title>
332     <xi:include href="xml/api-index-2.38.xml"><xi:fallback /></xi:include>
333   </index>
334   <index id="api-index-2-40" role="2.40">
335     <title>Index of new symbols in 2.40</title>
336     <xi:include href="xml/api-index-2.40.xml"><xi:fallback /></xi:include>
337   </index>
338   <index id="api-index-2-42" role="2.42">
339     <title>Index of new symbols in 2.42</title>
340     <xi:include href="xml/api-index-2.42.xml"><xi:fallback /></xi:include>
341   </index>
342   <index id="api-index-2-44" role="2.44">
343     <title>Index of new symbols in 2.44</title>
344     <xi:include href="xml/api-index-2.44.xml"><xi:fallback /></xi:include>
345   </index>
346   <index id="api-index-2-46" role="2.46">
347     <title>Index of new symbols in 2.46</title>
348     <xi:include href="xml/api-index-2.46.xml"><xi:fallback /></xi:include>
349   </index>
350   <index id="api-index-2-48" role="2.48">
351     <title>Index of new symbols in 2.48</title>
352     <xi:include href="xml/api-index-2.48.xml"><xi:fallback /></xi:include>
353   </index>
354   <index id="api-index-2-50" role="2.50">
355     <title>Index of new symbols in 2.50</title>
356     <xi:include href="xml/api-index-2.50.xml"><xi:fallback /></xi:include>
357   </index>
358   <index id="api-index-2-52" role="2.52">
359     <title>Index of new symbols in 2.52</title>
360     <xi:include href="xml/api-index-2.52.xml"><xi:fallback /></xi:include>
361   </index>
362   <index id="api-index-2-54" role="2.54">
363     <title>Index of new symbols in 2.54</title>
364     <xi:include href="xml/api-index-2.54.xml"><xi:fallback /></xi:include>
365   </index>
366   <index id="api-index-2-56" role="2.56">
367     <title>Index of new symbols in 2.56</title>
368     <xi:include href="xml/api-index-2.56.xml"><xi:fallback /></xi:include>
369   </index>
370   <index id="api-index-2-58" role="2.58">
371     <title>Index of new symbols in 2.58</title>
372     <xi:include href="xml/api-index-2.58.xml"><xi:fallback /></xi:include>
373   </index>
374   <index id="api-index-2-60" role="2.60">
375     <title>Index of new symbols in 2.60</title>
376     <xi:include href="xml/api-index-2.60.xml"><xi:fallback /></xi:include>
377   </index>
378
379   <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
380
381 </book>