RubyGems - glib2 - Versions diffs - 2.2.5-x86-mingw32 → 3.0.0-x86-mingw32 - Mend

glib2 2.2.5-x86-mingw32 → 3.0.0-x86-mingw32

Files changed (1979) hide show

data/vendor/local/share/gtk-doc/html/gio/GDrive.html CHANGED Viewed

@@ -2,7 +2,7 @@
 <html>
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>GIO Reference Manual: GDrive</title>
+<title>GDrive: GIO Reference Manual</title>
 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
 <link rel="home" href="index.html" title="GIO Reference Manual">
 <link rel="up" href="volume_mon.html" title="Volumes and Drives">
@@ -272,22 +272,22 @@
 <tr>
 <td class="signal_type"><span class="returnvalue">void</span></td>
 <td class="signal_name"><a class="link" href="GDrive.html#GDrive-changed" title="The “changed” signal">changed</a></td>
-<td class="signal_flags">Run Last</td>
+<td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
 </tr>
 <tr>
 <td class="signal_type"><span class="returnvalue">void</span></td>
 <td class="signal_name"><a class="link" href="GDrive.html#GDrive-disconnected" title="The “disconnected” signal">disconnected</a></td>
-<td class="signal_flags">Run Last</td>
+<td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
 </tr>
 <tr>
 <td class="signal_type"><span class="returnvalue">void</span></td>
 <td class="signal_name"><a class="link" href="GDrive.html#GDrive-eject-button" title="The “eject-button” signal">eject-button</a></td>
-<td class="signal_flags">Run Last</td>
+<td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
 </tr>
 <tr>
 <td class="signal_type"><span class="returnvalue">void</span></td>
 <td class="signal_name"><a class="link" href="GDrive.html#GDrive-stop-button" title="The “stop-button” signal">stop-button</a></td>
-<td class="signal_flags">Run Last</td>
+<td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
 </tr>
 </tbody>
 </table></div>
@@ -1763,7 +1763,7 @@ user_function (<a class="link" href="GDrive.html" title="GDrive"><span class="ty
 </tbody>
 </table></div>
 </div>
-<p>Flags: Run Last</p>
+<p>Flags: <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
 </div>
 <hr>
 <div class="refsect2">
@@ -1797,7 +1797,7 @@ finalized.</p>
 </tbody>
 </table></div>
 </div>
-<p>Flags: Run Last</p>
+<p>Flags: <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
 </div>
 <hr>
 <div class="refsect2">
@@ -1829,7 +1829,7 @@ been pressed.</p>
 </tbody>
 </table></div>
 </div>
-<p>Flags: Run Last</p>
+<p>Flags: <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
 </div>
 <hr>
 <div class="refsect2">
@@ -1861,7 +1861,7 @@ been pressed.</p>
 </tbody>
 </table></div>
 </div>
-<p>Flags: Run Last</p>
+<p>Flags: <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
 <p class="since">Since 2.22</p>
 </div>
 </div>

data/vendor/local/share/gtk-doc/html/gio/GEmblem.html CHANGED Viewed

@@ -2,7 +2,7 @@
 <html>
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>GIO Reference Manual: GEmblem</title>
+<title>GEmblem: GIO Reference Manual</title>
 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
 <link rel="home" href="index.html" title="GIO Reference Manual">
 <link rel="up" href="icons.html" title="Icons">

data/vendor/local/share/gtk-doc/html/gio/GEmblemedIcon.html CHANGED Viewed

@@ -2,7 +2,7 @@
 <html>
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>GIO Reference Manual: GEmblemedIcon</title>
+<title>GEmblemedIcon: GIO Reference Manual</title>
 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
 <link rel="home" href="index.html" title="GIO Reference Manual">
 <link rel="up" href="icons.html" title="Icons">

data/vendor/local/share/gtk-doc/html/gio/GFile.html CHANGED Viewed

@@ -2,7 +2,7 @@
 <html>
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>GIO Reference Manual: GFile</title>
+<title>GFile: GIO Reference Manual</title>
 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
 <link rel="home" href="index.html" title="GIO Reference Manual">
 <link rel="up" href="file_ops.html" title="File Operations">
@@ -635,7 +635,7 @@
 </tr>
 <tr>
 <td class="function_type">
-<a class="link" href="gio-GFileAttribute.html#GFileAttributeInfoList" title="GFileAttributeInfoList"><span class="returnvalue">GFileAttributeInfoList</span></a> *
+<a class="link" href="gio-GFileAttribute.html#GFileAttributeInfoList"><span class="returnvalue">GFileAttributeInfoList</span></a> *
 </td>
 <td class="function_name">
 <a class="link" href="GFile.html#g-file-query-settable-attributes" title="g_file_query_settable_attributes ()">g_file_query_settable_attributes</a> <span class="c_punctuation">()</span>
@@ -643,7 +643,7 @@
 </tr>
 <tr>
 <td class="function_type">
-<a class="link" href="gio-GFileAttribute.html#GFileAttributeInfoList" title="GFileAttributeInfoList"><span class="returnvalue">GFileAttributeInfoList</span></a> *
+<a class="link" href="gio-GFileAttribute.html#GFileAttributeInfoList"><span class="returnvalue">GFileAttributeInfoList</span></a> *
 </td>
 <td class="function_name">
 <a class="link" href="GFile.html#g-file-query-writable-namespaces" title="g_file_query_writable_namespaces ()">g_file_query_writable_namespaces</a> <span class="c_punctuation">()</span>
@@ -1105,9 +1105,7 @@
 </div>
 <div class="refsect1">
 <a name="GFile.object-hierarchy"></a><h2>Object Hierarchy</h2>
-<pre class="screen">    GFlags
-    <span class="lineart">╰──</span> GFileMonitorFlags
-    GInterface
+<pre class="screen">    GInterface
     <span class="lineart">╰──</span> GFile
 </pre>
 </div>
@@ -1177,9 +1175,14 @@ simply have <a class="link" href="async.html" title="Asynchronous I/O"><code cla
 I/O functions call a <a class="link" href="GAsyncResult.html#GAsyncReadyCallback" title="GAsyncReadyCallback ()"><span class="type">GAsyncReadyCallback</span></a> which is then used to finalize
 the operation, producing a GAsyncResult which is then passed to the
 function's matching <code class="function">_finish()</code> operation.</p>
-<p>Some <a class="link" href="GFile.html" title="GFile"><span class="type">GFile</span></a> operations do not have synchronous analogs, as they may
-take a very long time to finish, and blocking may leave an application
-unusable. Notable cases include:</p>
+<p>It is highly recommended to use asynchronous calls when running within a
+shared main loop, such as in the main thread of an application. This avoids
+I/O operations blocking other sources on the main loop from being dispatched.
+Synchronous I/O operations should be performed from worker threads. See the
+introduction to asynchronous programming section for
+more.</p>
+<p>Some <a class="link" href="GFile.html" title="GFile"><span class="type">GFile</span></a> operations almost always take a noticeable amount of time, and
+so do not have synchronous analogs. Notable cases include:</p>
 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
 <li class="listitem"><p>g_file_mount_mountable() to mount a mountable file.</p></li>
 <li class="listitem"><p>g_file_unmount_mountable_with_operation() to unmount a mountable file.</p></li>
@@ -1436,7 +1439,7 @@ to <code class="function">main()</code>.  <a href="../glib/glib-Windows-Compatib
 the commandline.  <a class="link" href="GApplication.html" title="GApplication"><span class="type">GApplication</span></a> also uses UTF-8 but
 <a class="link" href="GApplicationCommandLine.html#g-application-command-line-create-file-for-arg" title="g_application_command_line_create_file_for_arg ()"><code class="function">g_application_command_line_create_file_for_arg()</code></a> may be more useful
 for you there.  It is also always possible to use this function with
-<a href="../glib/glib-Commandline-option-parser.html#GOptionContext"><span class="type">GOptionContext</span></a> arguments of type <code class="literal">G_OPTION_ARG_FILENAME</code>.</p>
+<a href="../glib/glib-Commandline-option-parser.html#GOptionContext"><span class="type">GOptionContext</span></a> arguments of type <a href="../glib/glib-Commandline-option-parser.html#G-OPTION-ARG-FILENAME:CAPS"><code class="literal">G_OPTION_ARG_FILENAME</code></a>.</p>
 <div class="refsect3">
 <a name="id-1.4.2.2.9.7.6"></a><h4>Parameters</h4>
 <div class="informaltable"><table width="100%" border="0">
@@ -1657,7 +1660,7 @@ add to a <a href="../glib/glib-Hash-Tables.html#GHashTable"><span class="type">G
 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 g_file_equal (<em class="parameter"><code><a class="link" href="GFile.html" title="GFile"><span class="type">GFile</span></a> *file1</code></em>,
               <em class="parameter"><code><a class="link" href="GFile.html" title="GFile"><span class="type">GFile</span></a> *file2</code></em>);</pre>
-<p>Checks equality of two given <a href="GFile.html"><span class="type">GFiles</span></a>.</p>
+<p>Checks if the two given <a href="GFile.html"><span class="type">GFiles</span></a> refer to the same file.</p>
 <p>Note that two <a href="GFile.html"><span class="type">GFiles</span></a> that differ can still refer to the same
 file on the filesystem due to various forms of filename
 aliasing.</p>
@@ -2025,6 +2028,8 @@ pathname match <em class="parameter"><code>prefix</code></em>
 . Only full pathname elements are matched,
 so a path like /foo is not considered a prefix of /foobar, only
 of /foo/bar.</p>
+<p>A <a class="link" href="GFile.html" title="GFile"><span class="type">GFile</span></a> is not a prefix of itself. If you want to check for
+equality, use <a class="link" href="GFile.html#g-file-equal" title="g_file_equal ()"><code class="function">g_file_equal()</code></a>.</p>
 <p>This call does no I/O, as it works purely on names. As such it can
 sometimes return <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> even if <em class="parameter"><code>file</code></em>
  is inside a <em class="parameter"><code>prefix</code></em>
@@ -2035,7 +2040,7 @@ of <em class="parameter"><code>prefix</code></em>
 .</p>
 <p>Virtual: prefix_matches</p>
 <div class="refsect3">
-<a name="id-1.4.2.2.9.22.8"></a><h4>Parameters</h4>
+<a name="id-1.4.2.2.9.22.9"></a><h4>Parameters</h4>
 <div class="informaltable"><table width="100%" border="0">
 <colgroup>
 <col width="150px" class="parameters_name">
@@ -2057,7 +2062,7 @@ of <em class="parameter"><code>prefix</code></em>
 </table></div>
 </div>
 <div class="refsect3">
-<a name="id-1.4.2.2.9.22.9"></a><h4>Returns</h4>
+<a name="id-1.4.2.2.9.22.10"></a><h4>Returns</h4>
 <p>  <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the <em class="parameter"><code>files</code></em>
 's parent, grandparent, etc is <em class="parameter"><code>prefix</code></em>
 ,
@@ -2579,14 +2584,15 @@ by triggering the cancellable object from another thread. If the
 operation was cancelled, the error <a class="link" href="gio-GIOError.html#G-IO-ERROR-CANCELLED:CAPS"><code class="literal">G_IO_ERROR_CANCELLED</code></a> will be
 returned.</p>
 <p>If you pass in a non-<a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> <em class="parameter"><code>etag</code></em>
- value, then this value is
-compared to the current entity tag of the file, and if they differ
-an <a class="link" href="gio-GIOError.html#G-IO-ERROR-WRONG-ETAG:CAPS"><code class="literal">G_IO_ERROR_WRONG_ETAG</code></a> error is returned. This generally means
-that the file has been changed since you last read it. You can get
-the new etag from <a class="link" href="GFileOutputStream.html#g-file-output-stream-get-etag" title="g_file_output_stream_get_etag ()"><code class="function">g_file_output_stream_get_etag()</code></a> after you've
-finished writing and closed the <a class="link" href="GFileOutputStream.html" title="GFileOutputStream"><span class="type">GFileOutputStream</span></a>. When you load
-a new file you can use <a class="link" href="GFileInputStream.html#g-file-input-stream-query-info" title="g_file_input_stream_query_info ()"><code class="function">g_file_input_stream_query_info()</code></a> to get
-the etag of the file.</p>
+ value and <em class="parameter"><code>file</code></em>
+ already exists, then
+this value is compared to the current entity tag of the file, and if
+they differ an <a class="link" href="gio-GIOError.html#G-IO-ERROR-WRONG-ETAG:CAPS"><code class="literal">G_IO_ERROR_WRONG_ETAG</code></a> error is returned. This
+generally means that the file has been changed since you last read
+it. You can get the new etag from <a class="link" href="GFileOutputStream.html#g-file-output-stream-get-etag" title="g_file_output_stream_get_etag ()"><code class="function">g_file_output_stream_get_etag()</code></a>
+after you've finished writing and closed the <a class="link" href="GFileOutputStream.html" title="GFileOutputStream"><span class="type">GFileOutputStream</span></a>. When
+you load a new file you can use <a class="link" href="GFileInputStream.html#g-file-input-stream-query-info" title="g_file_input_stream_query_info ()"><code class="function">g_file_input_stream_query_info()</code></a> to
+get the etag of the file.</p>
 <p>If <em class="parameter"><code>make_backup</code></em>
  is <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, this function will attempt to make a
 backup of the current file before overwriting it. If this fails
@@ -5164,7 +5170,7 @@ was cancelled, the error <a class="link" href="gio-GIOError.html#G-IO-ERROR-CANC
 <hr>
 <div class="refsect2">
 <a name="g-file-query-settable-attributes"></a><h3>g_file_query_settable_attributes ()</h3>
-<pre class="programlisting"><a class="link" href="gio-GFileAttribute.html#GFileAttributeInfoList" title="GFileAttributeInfoList"><span class="returnvalue">GFileAttributeInfoList</span></a> *
+<pre class="programlisting"><a class="link" href="gio-GFileAttribute.html#GFileAttributeInfoList"><span class="returnvalue">GFileAttributeInfoList</span></a> *
 g_file_query_settable_attributes (<em class="parameter"><code><a class="link" href="GFile.html" title="GFile"><span class="type">GFile</span></a> *file</code></em>,
                                   <em class="parameter"><code><a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a> *cancellable</code></em>,
                                   <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
@@ -5207,7 +5213,7 @@ was cancelled, the error <a class="link" href="gio-GIOError.html#G-IO-ERROR-CANC
 </div>
 <div class="refsect3">
 <a name="id-1.4.2.2.9.76.8"></a><h4>Returns</h4>
-<p> a <a class="link" href="gio-GFileAttribute.html#GFileAttributeInfoList" title="GFileAttributeInfoList"><span class="type">GFileAttributeInfoList</span></a> describing the settable attributes.
+<p> a <a class="link" href="gio-GFileAttribute.html#GFileAttributeInfoList"><span class="type">GFileAttributeInfoList</span></a> describing the settable attributes.
 When you are done with it, release it with
 <a class="link" href="gio-GFileAttribute.html#g-file-attribute-info-list-unref" title="g_file_attribute_info_list_unref ()"><code class="function">g_file_attribute_info_list_unref()</code></a></p>
 <p></p>
@@ -5216,7 +5222,7 @@ When you are done with it, release it with
 <hr>
 <div class="refsect2">
 <a name="g-file-query-writable-namespaces"></a><h3>g_file_query_writable_namespaces ()</h3>
-<pre class="programlisting"><a class="link" href="gio-GFileAttribute.html#GFileAttributeInfoList" title="GFileAttributeInfoList"><span class="returnvalue">GFileAttributeInfoList</span></a> *
+<pre class="programlisting"><a class="link" href="gio-GFileAttribute.html#GFileAttributeInfoList"><span class="returnvalue">GFileAttributeInfoList</span></a> *
 g_file_query_writable_namespaces (<em class="parameter"><code><a class="link" href="GFile.html" title="GFile"><span class="type">GFile</span></a> *file</code></em>,
                                   <em class="parameter"><code><a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a> *cancellable</code></em>,
                                   <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
@@ -5257,7 +5263,7 @@ was cancelled, the error <a class="link" href="gio-GIOError.html#G-IO-ERROR-CANC
 </div>
 <div class="refsect3">
 <a name="id-1.4.2.2.9.77.7"></a><h4>Returns</h4>
-<p> a <a class="link" href="gio-GFileAttribute.html#GFileAttributeInfoList" title="GFileAttributeInfoList"><span class="type">GFileAttributeInfoList</span></a> describing the writable namespaces.
+<p> a <a class="link" href="gio-GFileAttribute.html#GFileAttributeInfoList"><span class="type">GFileAttributeInfoList</span></a> describing the writable namespaces.
 When you are done with it, release it with
 <a class="link" href="gio-GFileAttribute.html#g-file-attribute-info-list-unref" title="g_file_attribute_info_list_unref ()"><code class="function">g_file_attribute_info_list_unref()</code></a></p>
 <p></p>
@@ -9373,18 +9379,21 @@ necessarily represent files or directories that currently exist.</p>
 </tr>
 <tr>
 <td class="struct_member_name"><p><em class="structfield"><code><a name="GFileIface.measure-disk-usage"></a>measure_disk_usage</code></em> ()</p></td>
-<td> </td>
-<td> </td>
+<td class="struct_member_description"><p>Recursively measures the disk usage of <em class="parameter"><code>file</code></em>
+. Since 2.38</p></td>
+<td class="struct_member_annotations"> </td>
 </tr>
 <tr>
 <td class="struct_member_name"><p><em class="structfield"><code><a name="GFileIface.measure-disk-usage-async"></a>measure_disk_usage_async</code></em> ()</p></td>
-<td> </td>
-<td> </td>
+<td class="struct_member_description"><p>Asynchronously recursively measures the disk usage of <em class="parameter"><code>file</code></em>
+. Since 2.38</p></td>
+<td class="struct_member_annotations"> </td>
 </tr>
 <tr>
 <td class="struct_member_name"><p><em class="structfield"><code><a name="GFileIface.measure-disk-usage-finish"></a>measure_disk_usage_finish</code></em> ()</p></td>
-<td> </td>
-<td> </td>
+<td class="struct_member_description"><p>Finishes an asynchronous recursive measurement of the disk usage of <em class="parameter"><code>file</code></em>
+. Since 2.38</p></td>
+<td class="struct_member_annotations"> </td>
 </tr>
 </tbody>
 </table></div>

data/vendor/local/share/gtk-doc/html/gio/GFileDescriptorBased.html CHANGED Viewed

@@ -2,7 +2,7 @@
 <html>
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>GIO Reference Manual: GFileDescriptorBased</title>
+<title>GFileDescriptorBased: GIO Reference Manual</title>
 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
 <link rel="home" href="index.html" title="GIO Reference Manual">
 <link rel="up" href="streaming.html" title="Streaming I/O">
@@ -58,10 +58,16 @@
 <col width="150px" class="name">
 <col class="description">
 </colgroup>
-<tbody><tr>
+<tbody>
+<tr>
 <td class="datatype_keyword"> </td>
 <td class="function_name"><a class="link" href="GFileDescriptorBased.html#GFileDescriptorBased-struct" title="GFileDescriptorBased">GFileDescriptorBased</a></td>
-</tr></tbody>
+</tr>
+<tr>
+<td class="datatype_keyword">struct</td>
+<td class="function_name"><a class="link" href="GFileDescriptorBased.html#GFileDescriptorBasedIface" title="struct GFileDescriptorBasedIface">GFileDescriptorBasedIface</a></td>
+</tr>
+</tbody>
 </table></div>
 </div>
 <div class="refsect1">
@@ -103,7 +109,7 @@ file when using it.</p>
 g_file_descriptor_based_get_fd (<em class="parameter"><code><a class="link" href="GFileDescriptorBased.html" title="GFileDescriptorBased"><span class="type">GFileDescriptorBased</span></a> *fd_based</code></em>);</pre>
 <p>Gets the underlying file descriptor.</p>
 <div class="refsect3">
-<a name="id-1.4.7.9.10.2.5"></a><h4>Parameters</h4>
+<a name="id-1.4.7.10.10.2.5"></a><h4>Parameters</h4>
 <div class="informaltable"><table width="100%" border="0">
 <colgroup>
 <col width="150px" class="parameters_name">
@@ -118,7 +124,7 @@ g_file_descriptor_based_get_fd (<em class="parameter"><code><a class="link" href
 </table></div>
 </div>
 <div class="refsect3">
-<a name="id-1.4.7.9.10.2.6"></a><h4>Returns</h4>
+<a name="id-1.4.7.10.10.2.6"></a><h4>Returns</h4>
 <p> The file descriptor</p>
 <p></p>
 </div>
@@ -132,6 +138,40 @@ g_file_descriptor_based_get_fd (<em class="parameter"><code><a class="link" href
 <pre class="programlisting">typedef struct _GFileDescriptorBased GFileDescriptorBased;</pre>
 <p>An interface for file descriptor based io objects.</p>
 </div>
+<hr>
+<div class="refsect2">
+<a name="GFileDescriptorBasedIface"></a><h3>struct GFileDescriptorBasedIface</h3>
+<pre class="programlisting">struct GFileDescriptorBasedIface {
+  GTypeInterface g_iface;
+  /* Virtual Table */
+  int (*get_fd) (GFileDescriptorBased *fd_based);
+};
+</pre>
+<p>An interface for file descriptor based io objects.</p>
+<div class="refsect3">
+<a name="id-1.4.7.10.11.3.5"></a><h4>Members</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="300px" class="struct_members_name">
+<col class="struct_members_description">
+<col width="200px" class="struct_members_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="struct_member_name"><p><a href="../gobject/gobject-Type-Information.html#GTypeInterface"><span class="type">GTypeInterface</span></a> <em class="structfield"><code><a name="GFileDescriptorBasedIface.g-iface"></a>g_iface</code></em>;</p></td>
+<td class="struct_member_description"><p>The parent interface.</p></td>
+<td class="struct_member_annotations"> </td>
+</tr>
+<tr>
+<td class="struct_member_name"><p><em class="structfield"><code><a name="GFileDescriptorBasedIface.get-fd"></a>get_fd</code></em> ()</p></td>
+<td class="struct_member_description"><p>Gets the underlying file descriptor.</p></td>
+<td class="struct_member_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+</div>
 </div>
 <div class="refsect1">
 <a name="GFileDescriptorBased.see-also"></a><h2>See Also</h2>

data/vendor/local/share/gtk-doc/html/gio/GFileEnumerator.html CHANGED Viewed

@@ -2,7 +2,7 @@
 <html>
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>GIO Reference Manual: GFileEnumerator</title>
+<title>GFileEnumerator: GIO Reference Manual</title>
 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
 <link rel="home" href="index.html" title="GIO Reference Manual">
 <link rel="up" href="file_ops.html" title="File Operations">
@@ -43,6 +43,14 @@
 <tbody>
 <tr>
 <td class="function_type">
+<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
+</td>
+<td class="function_name">
+<a class="link" href="GFileEnumerator.html#g-file-enumerator-iterate" title="g_file_enumerator_iterate ()">g_file_enumerator_iterate</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
 <a class="link" href="GFileInfo.html" title="GFileInfo"><span class="returnvalue">GFileInfo</span></a> *
 </td>
 <td class="function_name">
@@ -200,6 +208,114 @@ on it, and it should be freed with <a href="../gobject/gobject-The-Base-Object-T
 <div class="refsect1">
 <a name="GFileEnumerator.functions_details"></a><h2>Functions</h2>
 <div class="refsect2">
+<a name="g-file-enumerator-iterate"></a><h3>g_file_enumerator_iterate ()</h3>
+<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
+g_file_enumerator_iterate (<em class="parameter"><code><a class="link" href="GFileEnumerator.html" title="GFileEnumerator"><span class="type">GFileEnumerator</span></a> *direnum</code></em>,
+                           <em class="parameter"><code><a class="link" href="GFileInfo.html" title="GFileInfo"><span class="type">GFileInfo</span></a> **out_info</code></em>,
+                           <em class="parameter"><code><a class="link" href="GFile.html" title="GFile"><span class="type">GFile</span></a> **out_child</code></em>,
+                           <em class="parameter"><code><a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a> *cancellable</code></em>,
+                           <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
+<p>This is a version of <a class="link" href="GFileEnumerator.html#g-file-enumerator-next-file" title="g_file_enumerator_next_file ()"><code class="function">g_file_enumerator_next_file()</code></a> that's easier to
+use correctly from C programs.  With <a class="link" href="GFileEnumerator.html#g-file-enumerator-next-file" title="g_file_enumerator_next_file ()"><code class="function">g_file_enumerator_next_file()</code></a>,
+the gboolean return value signifies "end of iteration or error", which
+requires allocation of a temporary <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>.</p>
+<p>In contrast, with this function, a <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> return from
+<code class="function">gs_file_enumerator_iterate()</code> *always* means
+"error".  End of iteration is signaled by <em class="parameter"><code>out_info</code></em>
+ or <em class="parameter"><code>out_child</code></em>
+ being <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p>
+<p>Another crucial difference is that the references for <em class="parameter"><code>out_info</code></em>
+ and
+<em class="parameter"><code>out_child</code></em>
+ are owned by <em class="parameter"><code>direnum</code></em>
+ (they are cached as hidden
+properties).  You must not unref them in your own code.  This makes
+memory management significantly easier for C code in combination
+with loops.</p>
+<p>Finally, this function optionally allows retrieving a <a class="link" href="GFile.html" title="GFile"><span class="type">GFile</span></a> as
+well.</p>
+<p>You must specify at least one of <em class="parameter"><code>out_info</code></em>
+ or <em class="parameter"><code>out_child</code></em>
+.</p>
+<p>The code pattern for correctly using <a class="link" href="GFileEnumerator.html#g-file-enumerator-iterate" title="g_file_enumerator_iterate ()"><code class="function">g_file_enumerator_iterate()</code></a> from C
+is:</p>
+<div class="informalexample">
+  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
+    <tbody>
+      <tr>
+        <td class="listing_lines" align="right"><pre>1
+2
+3
+4
+5
+6
+7
+8
+9
+10
+11
+12
+13</pre></td>
+        <td class="listing_code"><pre class="programlisting"><span class="normal">direnum </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GFile.html#g-file-enumerate-children">g_file_enumerate_children</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">file</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">...);</span>
+<span class="keyword">while</span><span class="normal"> </span><span class="symbol">(</span><span class="normal"><a href="../glib/glib-Standard-Macros.html#TRUE:CAPS">TRUE</a></span><span class="symbol">)</span>
+<span class="normal">  </span><span class="cbracket">{</span>
+<span class="normal">    </span><span class="usertype">GFileInfo</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">info</span><span class="symbol">;</span>
+<span class="normal">    </span><span class="keyword">if</span><span class="normal"> </span><span class="symbol">(!</span><span class="function"><a href="GFileEnumerator.html#g-file-enumerator-iterate">g_file_enumerator_iterate</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">direnum</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">&amp;</span><span class="normal">info</span><span class="symbol">,</span><span class="normal"> <a href="../glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">,</span><span class="normal"> cancellable</span><span class="symbol">,</span><span class="normal"> error</span><span class="symbol">))</span>
+<span class="normal">      </span><span class="keyword">goto</span><span class="normal"> out</span><span class="symbol">;</span>
+<span class="normal">    </span><span class="keyword">if</span><span class="normal"> </span><span class="symbol">(!</span><span class="normal">info</span><span class="symbol">)</span>
+<span class="normal">      </span><span class="keyword">break</span><span class="symbol">;</span>
+<span class="normal">    </span><span class="symbol">...</span><span class="normal"> </span><span class="keyword">do</span><span class="normal"> </span><span class="usertype">stuff</span><span class="normal"> with </span><span class="string">"info"</span><span class="symbol">;</span><span class="normal"> </span><span class="keyword">do</span><span class="normal"> not </span><span class="usertype">unref</span><span class="normal"> it</span><span class="symbol">!</span><span class="normal"> </span><span class="symbol">...</span>
+<span class="normal">  </span><span class="cbracket">}</span>
+<span class="label">out:</span>
+<span class="normal">  </span><span class="function"><a href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">direnum</span><span class="symbol">);</span><span class="normal"> </span><span class="comment">// Note: frees the last @info</span></pre></td>
+      </tr>
+    </tbody>
+  </table>
+</div>
+<p></p>
+<div class="refsect3">
+<a name="id-1.4.2.5.9.2.12"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>direnum</p></td>
+<td class="parameter_description"><p>an open <a class="link" href="GFileEnumerator.html" title="GFileEnumerator"><span class="type">GFileEnumerator</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>out_info</p></td>
+<td class="parameter_description"><p> Output location for the next <a class="link" href="GFileInfo.html" title="GFileInfo"><span class="type">GFileInfo</span></a>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
+<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
+</tr>
+<tr>
+<td class="parameter_name"><p>out_child</p></td>
+<td class="parameter_description"><p> Output location for the next <a class="link" href="GFile.html" title="GFile"><span class="type">GFile</span></a>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
+<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
+</tr>
+<tr>
+<td class="parameter_name"><p>cancellable</p></td>
+<td class="parameter_description"><p>a <a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>error</p></td>
+<td class="parameter_description"><p>a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<p class="since">Since 2.44</p>
+</div>
+<hr>
+<div class="refsect2">
 <a name="g-file-enumerator-next-file"></a><h3>g_file_enumerator_next_file ()</h3>
 <pre class="programlisting"><a class="link" href="GFileInfo.html" title="GFileInfo"><span class="returnvalue">GFileInfo</span></a> *
 g_file_enumerator_next_file (<em class="parameter"><code><a class="link" href="GFileEnumerator.html" title="GFileEnumerator"><span class="type">GFileEnumerator</span></a> *enumerator</code></em>,
@@ -217,7 +333,7 @@ enumerator is at the end, <a href="../glib/glib-Standard-Macros.html#NULL:CAPS">
  will
 be unset.</p>
 <div class="refsect3">
-<a name="id-1.4.2.5.9.2.7"></a><h4>Parameters</h4>
+<a name="id-1.4.2.5.9.3.7"></a><h4>Parameters</h4>
 <div class="informaltable"><table width="100%" border="0">
 <colgroup>
 <col width="150px" class="parameters_name">
@@ -244,7 +360,7 @@ be unset.</p>
 </table></div>
 </div>
 <div class="refsect3">
-<a name="id-1.4.2.5.9.2.8"></a><h4>Returns</h4>
+<a name="id-1.4.2.5.9.3.8"></a><h4>Returns</h4>
 <p> A <a class="link" href="GFileInfo.html" title="GFileInfo"><span class="type">GFileInfo</span></a> or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error
 or end of enumerator.  Free the returned object with
 <a href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when no longer needed. </p>
@@ -264,7 +380,7 @@ enumerator return <a class="link" href="gio-GIOError.html#G-IO-ERROR-CLOSED:CAPS
 is dropped, but you might want to call this function to make
 sure resources are released as early as possible.</p>
 <div class="refsect3">
-<a name="id-1.4.2.5.9.3.6"></a><h4>Parameters</h4>
+<a name="id-1.4.2.5.9.4.6"></a><h4>Parameters</h4>
 <div class="informaltable"><table width="100%" border="0">
 <colgroup>
 <col width="150px" class="parameters_name">
@@ -291,7 +407,7 @@ sure resources are released as early as possible.</p>
 </table></div>
 </div>
 <div class="refsect3">
-<a name="id-1.4.2.5.9.3.7"></a><h4>Returns</h4>
+<a name="id-1.4.2.5.9.4.7"></a><h4>Returns</h4>
 <p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> on success or <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><span class="type">FALSE</span></a> on error.</p>
 <p></p>
 </div>
@@ -324,7 +440,7 @@ result in <a class="link" href="gio-GIOError.html#G-IO-ERROR-PENDING:CAPS"><code
 be executed before an outstanding request with lower priority. Default
 priority is <a href="../glib/glib-The-Main-Event-Loop.html#G-PRIORITY-DEFAULT:CAPS"><code class="literal">G_PRIORITY_DEFAULT</code></a>.</p>
 <div class="refsect3">
-<a name="id-1.4.2.5.9.4.9"></a><h4>Parameters</h4>
+<a name="id-1.4.2.5.9.5.9"></a><h4>Parameters</h4>
 <div class="informaltable"><table width="100%" border="0">
 <colgroup>
 <col width="150px" class="parameters_name">
@@ -375,7 +491,7 @@ g_file_enumerator_next_files_finish (<em class="parameter"><code><a class="link"
                                      <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 <p>Finishes the asynchronous operation started with <a class="link" href="GFileEnumerator.html#g-file-enumerator-next-files-async" title="g_file_enumerator_next_files_async ()"><code class="function">g_file_enumerator_next_files_async()</code></a>.</p>
 <div class="refsect3">
-<a name="id-1.4.2.5.9.5.5"></a><h4>Parameters</h4>
+<a name="id-1.4.2.5.9.6.5"></a><h4>Parameters</h4>
 <div class="informaltable"><table width="100%" border="0">
 <colgroup>
 <col width="150px" class="parameters_name">
@@ -403,7 +519,7 @@ ignore.</p></td>
 </table></div>
 </div>
 <div class="refsect3">
-<a name="id-1.4.2.5.9.5.6"></a><h4>Returns</h4>
+<a name="id-1.4.2.5.9.6.6"></a><h4>Returns</h4>
 <p> a <a href="../glib/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> of <a href="GFileInfo.html"><span class="type">GFileInfos</span></a>. You must free the list with
 <a href="../glib/glib-Doubly-Linked-Lists.html#g-list-free"><code class="function">g_list_free()</code></a> and unref the infos with <a href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when you're
 done with them. </p>
@@ -426,7 +542,7 @@ triggering the cancellable object from another thread. If the operation
 was cancelled, the error <a class="link" href="gio-GIOError.html#G-IO-ERROR-CANCELLED:CAPS"><code class="literal">G_IO_ERROR_CANCELLED</code></a> will be returned in
 <a class="link" href="GFileEnumerator.html#g-file-enumerator-close-finish" title="g_file_enumerator_close_finish ()"><code class="function">g_file_enumerator_close_finish()</code></a>.</p>
 <div class="refsect3">
-<a name="id-1.4.2.5.9.6.6"></a><h4>Parameters</h4>
+<a name="id-1.4.2.5.9.7.6"></a><h4>Parameters</h4>
 <div class="informaltable"><table width="100%" border="0">
 <colgroup>
 <col width="150px" class="parameters_name">
@@ -482,7 +598,7 @@ cancelled by triggering the cancellable object from another thread. If the opera
 was cancelled, the error <a class="link" href="gio-GIOError.html#G-IO-ERROR-CANCELLED:CAPS"><code class="literal">G_IO_ERROR_CANCELLED</code></a> will be set, and <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> will be
 returned.</p>
 <div class="refsect3">
-<a name="id-1.4.2.5.9.7.6"></a><h4>Parameters</h4>
+<a name="id-1.4.2.5.9.8.6"></a><h4>Parameters</h4>
 <div class="informaltable"><table width="100%" border="0">
 <colgroup>
 <col width="150px" class="parameters_name">
@@ -510,7 +626,7 @@ ignore.</p></td>
 </table></div>
 </div>
 <div class="refsect3">
-<a name="id-1.4.2.5.9.7.7"></a><h4>Returns</h4>
+<a name="id-1.4.2.5.9.8.7"></a><h4>Returns</h4>
 <p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the close operation has finished successfully.</p>
 <p></p>
 </div>
@@ -522,7 +638,7 @@ ignore.</p></td>
 g_file_enumerator_is_closed (<em class="parameter"><code><a class="link" href="GFileEnumerator.html" title="GFileEnumerator"><span class="type">GFileEnumerator</span></a> *enumerator</code></em>);</pre>
 <p>Checks if the file enumerator has been closed.</p>
 <div class="refsect3">
-<a name="id-1.4.2.5.9.8.5"></a><h4>Parameters</h4>
+<a name="id-1.4.2.5.9.9.5"></a><h4>Parameters</h4>
 <div class="informaltable"><table width="100%" border="0">
 <colgroup>
 <col width="150px" class="parameters_name">
@@ -537,7 +653,7 @@ g_file_enumerator_is_closed (<em class="parameter"><code><a class="link" href="G
 </table></div>
 </div>
 <div class="refsect3">
-<a name="id-1.4.2.5.9.8.6"></a><h4>Returns</h4>
+<a name="id-1.4.2.5.9.9.6"></a><h4>Returns</h4>
 <p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the <em class="parameter"><code>enumerator</code></em>
 is closed.</p>
 <p></p>
@@ -550,7 +666,7 @@ is closed.</p>
 g_file_enumerator_has_pending (<em class="parameter"><code><a class="link" href="GFileEnumerator.html" title="GFileEnumerator"><span class="type">GFileEnumerator</span></a> *enumerator</code></em>);</pre>
 <p>Checks if the file enumerator has pending operations.</p>
 <div class="refsect3">
-<a name="id-1.4.2.5.9.9.5"></a><h4>Parameters</h4>
+<a name="id-1.4.2.5.9.10.5"></a><h4>Parameters</h4>
 <div class="informaltable"><table width="100%" border="0">
 <colgroup>
 <col width="150px" class="parameters_name">
@@ -565,7 +681,7 @@ g_file_enumerator_has_pending (<em class="parameter"><code><a class="link" href=
 </table></div>
 </div>
 <div class="refsect3">
-<a name="id-1.4.2.5.9.9.6"></a><h4>Returns</h4>
+<a name="id-1.4.2.5.9.10.6"></a><h4>Returns</h4>
 <p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the <em class="parameter"><code>enumerator</code></em>
 has pending operations.</p>
 <p></p>
@@ -579,7 +695,7 @@ g_file_enumerator_set_pending (<em class="parameter"><code><a class="link" href=
                                <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> pending</code></em>);</pre>
 <p>Sets the file enumerator as having pending operations.</p>
 <div class="refsect3">
-<a name="id-1.4.2.5.9.10.5"></a><h4>Parameters</h4>
+<a name="id-1.4.2.5.9.11.5"></a><h4>Parameters</h4>
 <div class="informaltable"><table width="100%" border="0">
 <colgroup>
 <col width="150px" class="parameters_name">
@@ -608,7 +724,7 @@ g_file_enumerator_set_pending (<em class="parameter"><code><a class="link" href=
 g_file_enumerator_get_container (<em class="parameter"><code><a class="link" href="GFileEnumerator.html" title="GFileEnumerator"><span class="type">GFileEnumerator</span></a> *enumerator</code></em>);</pre>
 <p>Get the <a class="link" href="GFile.html" title="GFile"><span class="type">GFile</span></a> container which is being enumerated.</p>
 <div class="refsect3">
-<a name="id-1.4.2.5.9.11.5"></a><h4>Parameters</h4>
+<a name="id-1.4.2.5.9.12.5"></a><h4>Parameters</h4>
 <div class="informaltable"><table width="100%" border="0">
 <colgroup>
 <col width="150px" class="parameters_name">
@@ -623,7 +739,7 @@ g_file_enumerator_get_container (<em class="parameter"><code><a class="link" hre
 </table></div>
 </div>
 <div class="refsect3">
-<a name="id-1.4.2.5.9.11.6"></a><h4>Returns</h4>
+<a name="id-1.4.2.5.9.12.6"></a><h4>Returns</h4>
 <p> the <a class="link" href="GFile.html" title="GFile"><span class="type">GFile</span></a> which is being enumerated. </p>
 <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
 </div>
@@ -658,7 +774,7 @@ inside loops with <a class="link" href="GFileEnumerator.html#g-file-enumerator-n
 <p></p>
 <div class="refsect3">
-<a name="id-1.4.2.5.9.12.8"></a><h4>Parameters</h4>
+<a name="id-1.4.2.5.9.13.8"></a><h4>Parameters</h4>
 <div class="informaltable"><table width="100%" border="0">
 <colgroup>
 <col width="150px" class="parameters_name">
@@ -681,7 +797,7 @@ or the async equivalents.</p></td>
 </table></div>
 </div>
 <div class="refsect3">
-<a name="id-1.4.2.5.9.12.9"></a><h4>Returns</h4>
+<a name="id-1.4.2.5.9.13.9"></a><h4>Returns</h4>
 <p> a <a class="link" href="GFile.html" title="GFile"><span class="type">GFile</span></a> for the <a class="link" href="GFileInfo.html" title="GFileInfo"><span class="type">GFileInfo</span></a> passed it. </p>
 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 </div>