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/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     </chapter>
 242     <chapter id="extending">
 243         <title>Extending GIO</title>
 244         <xi:include href="xml/gvfs.xml"/>
 245         <xi:include href="xml/giomodule.xml"/>
 246         <xi:include href="xml/extensionpoints.xml"/>
 247     </chapter>
 248     <chapter id="tools">
 249         <title>GIO Tools</title>
 250         <xi:include href="gio-querymodules.xml"/>
 251         <xi:include href="gsettings.xml"/>
 252         <xi:include href="glib-compile-schemas.xml"/>
 253         <xi:include href="glib-compile-resources.xml"/>
 254         <xi:include href="gdbus.xml"/>
 255         <xi:include href="xml/gdbus-codegen.xml"/>
 256         <xi:include href="gresource.xml"/>
 257         <xi:include href="gapplication.xml"/>
 258         <xi:include href="gio.xml"/>
 259     </chapter>
 260     <chapter id="testing">
 261         <title>GIO Testing</title>
 262         <xi:include href="xml/gtestdbus.xml"/>
 263     </chapter>
 264     <xi:include href="gio-docs-platform.xml"/>
 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   <index id="api-index-2-54" role="2.54">
 361     <title>Index of new symbols in 2.54</title>
 362     <xi:include href="xml/api-index-2.54.xml"><xi:fallback /></xi:include>
 363   </index>
 364   <index id="api-index-2-56" role="2.56">
 365     <title>Index of new symbols in 2.56</title>
 366     <xi:include href="xml/api-index-2.56.xml"><xi:fallback /></xi:include>
 367   </index>
 368   <index id="api-index-2-58" role="2.58">
 369     <title>Index of new symbols in 2.58</title>
 370     <xi:include href="xml/api-index-2.58.xml"><xi:fallback /></xi:include>
 371   </index>
 372   <index id="api-index-2-60" role="2.60">
 373     <title>Index of new symbols in 2.60</title>
 374     <xi:include href="xml/api-index-2.60.xml"><xi:fallback /></xi:include>
 375   </index>
 376   <index id="api-index-2-62" role="2.62">
 377     <title>Index of new symbols in 2.62</title>
 378     <xi:include href="xml/api-index-2.62.xml"><xi:fallback /></xi:include>
 379   </index>
 380   <index id="api-index-2-64" role="2.64">
 381     <title>Index of new symbols in 2.64</title>
 382     <xi:include href="xml/api-index-2.64.xml"><xi:fallback /></xi:include>
 383   </index>
 384   <index id="api-index-2-66" role="2.66">
 385     <title>Index of new symbols in 2.66</title>
 386     <xi:include href="xml/api-index-2.66.xml"><xi:fallback /></xi:include>
 387   </index>
 388   <index id="api-index-2-68" role="2.68">
 389     <title>Index of new symbols in 2.68</title>
 390     <xi:include href="xml/api-index-2.68.xml"><xi:fallback /></xi:include>
 391   </index>
 392
 393   <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
 394
 395 </book>