Imported Upstream version 2.55.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/gnetworkaddress.xml"/>
171       <xi:include href="xml/gnetworkservice.xml"/>
172       <xi:include href="xml/gsrvtarget.xml"/>
173     </chapter>
174     <chapter id="gdbus-lowlevel">
175       <title>Low-level D-Bus Support</title>
176       <xi:include href="xml/gdbusutils.xml"/>
177       <xi:include href="xml/gdbusaddress.xml"/>
178       <xi:include href="xml/gdbusintrospection.xml"/>
179       <xi:include href="xml/gdbuserror.xml"/>
180       <xi:include href="xml/gdbusmessage.xml"/>
181       <xi:include href="xml/gdbusconnection.xml"/>
182       <xi:include href="xml/gdbusmethodinvocation.xml"/>
183       <xi:include href="xml/gdbusserver.xml"/>
184       <xi:include href="xml/gdbusauthobserver.xml"/>
185     </chapter>
186     <chapter id="gdbus-convenience">
187       <title>High-level D-Bus Support</title>
188       <xi:include href="xml/gdbusnameowning.xml"/>
189       <xi:include href="xml/gdbusnamewatching.xml"/>
190       <xi:include href="xml/gdbusinterface.xml"/>
191       <xi:include href="xml/gdbusinterfaceskeleton.xml"/>
192       <xi:include href="xml/gdbusproxy.xml"/>
193       <xi:include href="xml/gdbusobject.xml"/>
194       <xi:include href="xml/gdbusobjectskeleton.xml"/>
195       <xi:include href="xml/gdbusobjectproxy.xml"/>
196       <xi:include href="xml/gdbusobjectmanager.xml"/>
197       <xi:include href="xml/gdbusobjectmanagerserver.xml"/>
198       <xi:include href="xml/gdbusobjectmanagerclient.xml"/>
199     </chapter>
200     <chapter id="settings">
201         <title>Settings</title>
202         <xi:include href="xml/gsettings.xml"/>
203         <xi:include href="xml/gsettingsbackend.xml"/>
204         <xi:include href="xml/gsettingsschema.xml"/>
205     </chapter>
206     <chapter id="resources">
207         <title>Resources</title>
208         <xi:include href="xml/gresource.xml"/>
209     </chapter>
210     <chapter id='permissions'>
211         <title>Permissions</title>
212         <xi:include href="xml/gpermission.xml"/>
213         <xi:include href="xml/gsimplepermission.xml"/>
214     </chapter>
215     <chapter id='data-models'>
216         <title>Data Models</title>
217         <xi:include href="xml/glistmodel.xml"/>
218         <xi:include href="xml/gliststore.xml"/>
219     </chapter>
220     <chapter id='registry'>
221         <title>Win32 registry support</title>
222         <xi:include href="xml/gwin32registrykey.xml"/>
223     </chapter>
224     <chapter id="application">
225         <title>Application support</title>
226         <xi:include href="xml/gapplication.xml"/>
227         <xi:include href="xml/gapplicationcommandline.xml"/>
228         <xi:include href="xml/gactiongroup.xml"/>
229         <xi:include href="xml/gactionmap.xml"/>
230         <xi:include href="xml/gsimpleactiongroup.xml"/>
231         <xi:include href="xml/gaction.xml"/>
232         <xi:include href="xml/gsimpleaction.xml"/>
233         <xi:include href="xml/gpropertyaction.xml"/>
234         <xi:include href="xml/gremoteactiongroup.xml"/>
235         <xi:include href="xml/gactiongroupexporter.xml"/>
236         <xi:include href="xml/gdbusactiongroup.xml"/>
237         <xi:include href="xml/gmenumodel.xml"/>
238         <xi:include href="xml/gmenu.xml"/>
239         <xi:include href="xml/gmenuexporter.xml"/>
240         <xi:include href="xml/gdbusmenumodel.xml"/>
241         <xi:include href="xml/gnotification.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   </part>
266
267   <part id="migrating">
268     <title>Migrating to GIO</title>
269     <xi:include href="xml/migrating-posix.xml"/>
270     <xi:include href="xml/migrating-gnome-vfs.xml"/>
271     <xi:include href="xml/migrating-gconf.xml"/>
272     <xi:include href="xml/migrating-gdbus.xml"/>
273   </part>
274
275   <chapter id="gio-hierarchy">
276     <title>Object Hierarchy</title>
277       <xi:include href="xml/tree_index.sgml"/>
278   </chapter>
279   
280   <index id="api-index-full">
281     <title id="index-all">Index</title>
282     <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
283   </index>
284   <index id="api-index-deprecated" role="deprecated">
285     <title>Index of deprecated symbols</title>
286     <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
287   </index>
288   <index id="api-index-2-18" role="2.18">
289     <title>Index of new symbols in 2.18</title>
290     <xi:include href="xml/api-index-2.18.xml"><xi:fallback /></xi:include>
291   </index>
292   <index id="api-index-2-20" role="2.20">
293     <title>Index of new symbols in 2.20</title>
294     <xi:include href="xml/api-index-2.20.xml"><xi:fallback /></xi:include>
295   </index>
296   <index id="api-index-2-22" role="2.22">
297     <title>Index of new symbols in 2.22</title>
298     <xi:include href="xml/api-index-2.22.xml"><xi:fallback /></xi:include>
299   </index>
300   <index id="api-index-2-24" role="2.24">
301     <title>Index of new symbols in 2.24</title>
302     <xi:include href="xml/api-index-2.24.xml"><xi:fallback /></xi:include>
303   </index>
304   <index id="api-index-2-26" role="2.26">
305     <title>Index of new symbols in 2.26</title>
306     <xi:include href="xml/api-index-2.26.xml"><xi:fallback /></xi:include>
307   </index>
308   <index id="api-index-2-28" role="2.28">
309     <title>Index of new symbols in 2.28</title>
310     <xi:include href="xml/api-index-2.28.xml"><xi:fallback /></xi:include>
311   </index>
312   <index id="api-index-2-30" role="2.30">
313     <title>Index of new symbols in 2.30</title>
314     <xi:include href="xml/api-index-2.30.xml"><xi:fallback /></xi:include>
315   </index>
316   <index id="api-index-2-32" role="2.32">
317     <title>Index of new symbols in 2.32</title>
318     <xi:include href="xml/api-index-2.32.xml"><xi:fallback /></xi:include>
319   </index>
320   <index id="api-index-2-34" role="2.34">
321     <title>Index of new symbols in 2.34</title>
322     <xi:include href="xml/api-index-2.34.xml"><xi:fallback /></xi:include>
323   </index>
324   <index id="api-index-2-36" role="2.36">
325     <title>Index of new symbols in 2.36</title>
326     <xi:include href="xml/api-index-2.36.xml"><xi:fallback /></xi:include>
327   </index>
328   <index id="api-index-2-38" role="2.38">
329     <title>Index of new symbols in 2.38</title>
330     <xi:include href="xml/api-index-2.38.xml"><xi:fallback /></xi:include>
331   </index>
332   <index id="api-index-2-40" role="2.40">
333     <title>Index of new symbols in 2.40</title>
334     <xi:include href="xml/api-index-2.40.xml"><xi:fallback /></xi:include>
335   </index>
336   <index id="api-index-2-42" role="2.42">
337     <title>Index of new symbols in 2.42</title>
338     <xi:include href="xml/api-index-2.42.xml"><xi:fallback /></xi:include>
339   </index>
340   <index id="api-index-2-44" role="2.44">
341     <title>Index of new symbols in 2.44</title>
342     <xi:include href="xml/api-index-2.44.xml"><xi:fallback /></xi:include>
343   </index>
344   <index id="api-index-2-46" role="2.46">
345     <title>Index of new symbols in 2.46</title>
346     <xi:include href="xml/api-index-2.46.xml"><xi:fallback /></xi:include>
347   </index>
348   <index id="api-index-2-48" role="2.48">
349     <title>Index of new symbols in 2.48</title>
350     <xi:include href="xml/api-index-2.48.xml"><xi:fallback /></xi:include>
351   </index>
352   <index id="api-index-2-50" role="2.50">
353     <title>Index of new symbols in 2.50</title>
354     <xi:include href="xml/api-index-2.50.xml"><xi:fallback /></xi:include>
355   </index>
356   <index id="api-index-2-52" role="2.52">
357     <title>Index of new symbols in 2.52</title>
358     <xi:include href="xml/api-index-2.52.xml"><xi:fallback /></xi:include>
359   </index>
360
361   <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
362
363 </book>