Imported Upstream version 2.28.6
[platform/upstream/pygobject2.git] / docs / reference / pygio-constants.xml
1 <?xml version="1.0" standalone="no"?>
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3     "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
4
5 <refentry id="gio-constants">
6   <refnamediv>
7     <refname>gio Constants</refname>
8     <refpurpose>the built-in constants of the gio module</refpurpose>
9   </refnamediv>
10
11   <refsect1>
12     <title>Synopsis</title>
13
14 <programlisting>
15 <xref linkend="gio-app-info-constants" endterm="gio-app-info-constants-title"></xref>
16 <xref linkend="gio-ask-password-flags-constants" endterm="gio-ask-password-flags-constants-title"></xref>
17 <xref linkend="gio-data-stream-byte-order-constants" endterm="gio-data-stream-byte-order-constants-title"></xref>
18 <xref linkend="gio-data-stream-newline-type-constants" endterm="gio-data-stream-newline-type-constants-title"></xref>
19 <xref linkend="gio-emblem-origin-constants" endterm="gio-emblem-origin-constants-title"></xref>
20 <xref linkend="gio-error-constants" endterm="gio-error-constants-title"></xref>
21 <xref linkend="gio-file-attribute-constants" endterm="gio-file-attribute-constants-title"></xref>
22 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref>
23 <xref linkend="gio-file-attribute-flags-constants" endterm="gio-file-attribute-flags-constants-title"></xref>
24 <xref linkend="gio-file-create-flags-constants" endterm="gio-file-create-flags-constants-title"></xref>
25 <xref linkend="gio-file-copy-flags-constants" endterm="gio-file-copy-flags-constants-title"></xref>
26 <xref linkend="gio-file-monitor-flags-constants" endterm="gio-file-monitor-flags-constants-title"></xref>
27 <xref linkend="gio-file-query-info-flags-constants" endterm="gio-file-query-info-flags-constants-title"></xref>
28 <xref linkend="gio-file-type-constants" endterm="gio-file-type-constants-title"></xref>
29 <xref linkend="gio-mount-mount-flags-constants" endterm="gio-mount-mount-flags-constants-title"></xref>
30 <xref linkend="gio-mount-operation-result-constants" endterm="gio-mount-operation-result-constants-title"></xref>
31 <xref linkend="gio-mount-unmount-flags-constants" endterm="gio-mount-unmount-flags-constants-title"></xref>
32 <xref linkend="gio-password-save-constants" endterm="gio-password-save-constants-title"></xref>
33 </programlisting>
34
35   </refsect1>
36
37   <refsect1 id="gio-constants-description">
38     <title>Description</title>
39
40     <refsect2 id="gio-ask-password-flags-constants">
41       <title id="gio-ask-password-flags-constants-title">Gio Ask Password Flags Constants</title>
42
43       <para>
44           Flags that are used to request specific information from the user, or to
45           notify the user of their choices in an authentication situation.
46       </para>
47
48       <variablelist>
49         <varlistentry>
50           <term><literal>gio.ASK_PASSWORD_ANONYMOUS_SUPPORTED</literal></term>
51           <listitem>
52             <simpara>operation supports anonymous users.</simpara>
53           </listitem>
54         </varlistentry>
55         <varlistentry>
56           <term><literal>gio.ASK_PASSWORD_NEED_DOMAIN</literal></term>
57           <listitem>
58             <simpara>operation requires a domain.</simpara>
59           </listitem>
60         </varlistentry>
61         <varlistentry>
62           <term><literal>gio.ASK_PASSWORD_NEED_PASSWORD</literal></term>
63           <listitem>
64             <simpara>operation requires a password.</simpara>
65           </listitem>
66         </varlistentry>
67         <varlistentry>
68           <term><literal>gio.ASK_PASSWORD_NEED_USERNAME</literal></term>
69           <listitem>
70             <simpara>operation requires a username.</simpara>
71           </listitem>
72         </varlistentry>
73         <varlistentry>
74           <term><literal>gio.ASK_PASSWORD_SAVING_SUPPORTED</literal></term>
75           <listitem>
76             <simpara>operation supports saving settings.</simpara>
77           </listitem>
78         </varlistentry>
79       </variablelist>
80     </refsect2>
81
82     <refsect2 id="gio-app-info-constants">
83       <title id="gio-app-info-constants-title">Gio AppInfo Create Flags Constants</title>
84
85       <para>
86           Flags used when creating a <link linkend="class-gioappinfo"><classname>gio.AppInfo</classname></link>
87       </para>
88
89       <variablelist>
90         <varlistentry>
91           <term><literal>gio.APP_INFO_CREATE_NONE</literal></term>
92           <listitem>
93             <simpara>No flags.</simpara>
94           </listitem>
95         </varlistentry>
96         <varlistentry>
97           <term><literal>gio.APP_INFO_CREATE_NEEDS_TERMINAL</literal></term>
98           <listitem>
99             <simpara>Application opens in a terminal window. </simpara>
100           </listitem>
101         </varlistentry>
102         <varlistentry>
103           <term><literal>gio.APP_INFO_CREATE_SUPPORTS_URIS</literal></term>
104           <listitem>
105             <simpara>Application supports URI arguments. </simpara>
106           </listitem>
107         </varlistentry>
108       </variablelist>
109     </refsect2>
110
111     <refsect2 id="gio-data-stream-byte-order-constants">
112       <title id="gio-data-stream-byte-order-constants-title">Gio Data Stream Byte Order Constants</title>
113
114       <para>
115           Used to ensure proper endianness of streaming data sources across various machine architectures.
116       </para>
117
118       <variablelist>
119         <varlistentry>
120           <term><literal>gio.DATA_STREAM_BYTE_ORDER_BIG_ENDIAN</literal></term>
121           <listitem>
122             <simpara>Selects Big Endian byte order.</simpara>
123           </listitem>
124         </varlistentry>
125         <varlistentry>
126           <term><literal>gio.DATA_STREAM_BYTE_ORDER_HOST_ENDIAN</literal></term>
127           <listitem>
128             <simpara>Selects endianness based on host machine's architecture.</simpara>
129           </listitem>
130         </varlistentry>
131         <varlistentry>
132           <term><literal>gio.DATA_STREAM_BYTE_ORDER_LITTLE_ENDIAN</literal></term>
133           <listitem>
134             <simpara>Selects Little Endian byte order.</simpara>
135           </listitem>
136         </varlistentry>
137       </variablelist>
138     </refsect2>
139
140     <refsect2 id="gio-data-stream-newline-type-constants">
141       <title id="gio-data-stream-newline-type-constants-title">Gio Data Stream Newline Type Constants</title>
142
143       <para>
144           Used when checking for or setting the line endings for a given file.
145       </para>
146
147       <variablelist>
148         <varlistentry>
149           <term><literal>gio.DATA_STREAM_NEWLINE_TYPE_LF</literal></term>
150           <listitem>
151             <simpara>Selects "LF" line endings, common on most modern UNIX platforms.</simpara>
152           </listitem>
153         </varlistentry>
154         <varlistentry>
155           <term><literal>gio.DATA_STREAM_NEWLINE_TYPE_CR</literal></term>
156           <listitem>
157             <simpara>Selects "CR" line endings.</simpara>
158           </listitem>
159         </varlistentry>
160         <varlistentry>
161           <term><literal>gio.DATA_STREAM_NEWLINE_TYPE_CR_LF</literal></term>
162           <listitem>
163             <simpara>Selects "CR, LF" line ending, common on Microsoft Windows.</simpara>
164           </listitem>
165         </varlistentry>
166         <varlistentry>
167           <term><literal>gio.DATA_STREAM_NEWLINE_TYPE_ANY</literal></term>
168           <listitem>
169             <simpara>Automatically try to handle any line ending type.</simpara>
170           </listitem>
171         </varlistentry>
172       </variablelist>
173     </refsect2>
174
175     <refsect2 id="gio-emblem-origin-constants">
176       <title id="gio-emblem-origin-constants-title">Gio Emblem Origin Constants</title>
177
178       <para>
179           GEmblemOrigin is used to add information about the origin of the emblem to GEmblem.
180       </para>
181
182       <variablelist>
183         <varlistentry>
184           <term><literal>gio.EMBLEM_ORIGIN_DEVICE</literal></term>
185           <listitem>
186             <simpara>Embleme adds device-specific information.</simpara>
187           </listitem>
188         </varlistentry>
189         <varlistentry>
190           <term><literal>gio.EMBLEM_ORIGIN_LIVEMETADATA</literal></term>
191           <listitem>
192             <simpara>Emblem depicts live metadata, such as "readonly".</simpara>
193           </listitem>
194         </varlistentry>
195         <varlistentry>
196           <term><literal>gio.EMBLEM_ORIGIN_TAG</literal></term>
197           <listitem>
198             <simpara>Emblem comes from a user-defined tag, e.g. set by nautilus (in the future).</simpara>
199           </listitem>
200         </varlistentry>
201         <varlistentry>
202           <term><literal>gio.EMBLEM_ORIGIN_UNKNOWN</literal></term>
203           <listitem>
204             <simpara>Emblem of unknown origin.</simpara>
205           </listitem>
206         </varlistentry>
207       </variablelist>
208     </refsect2>
209
210     <refsect2 id="gio-error-constants">
211       <title id="gio-error-constants-title">Gio Error Constants</title>
212
213       <para>
214          GIOError Error codes returned by GIO functions.
215       </para>
216
217       <variablelist>
218         <varlistentry>
219           <term><literal>gio.ERROR_ALREADY_MOUNTED</literal></term>
220           <listitem>
221             <simpara>File is already mounted.</simpara>
222           </listitem>
223         </varlistentry>
224         <varlistentry>
225           <term><literal>gio.ERROR_BUSY</literal></term>
226           <listitem>
227             <simpara>File is busy.</simpara>
228           </listitem>
229         </varlistentry>
230         <varlistentry>
231           <term><literal>gio.ERROR_CANCELLED</literal></term>
232           <listitem>
233             <simpara>Operation was cancelled. See
234                 <link linkend="class-giocancellable"><classname>gio.Cancellable</classname></link>.
235             </simpara>
236           </listitem>
237         </varlistentry>
238         <varlistentry>
239           <term><literal>gio.ERROR_CANT_CREATE_BACKUP</literal></term>
240           <listitem>
241             <simpara>Backup couldn't be created.</simpara>
242           </listitem>
243         </varlistentry>
244         <varlistentry>
245           <term><literal>gio.ERROR_CLOSED</literal></term>
246           <listitem>
247             <simpara>File was closed.</simpara>
248           </listitem>
249         </varlistentry>
250         <varlistentry>
251           <term><literal>gio.ERROR_EXISTS</literal></term>
252           <listitem>
253             <simpara>File already exists error.</simpara>
254           </listitem>
255         </varlistentry>
256         <varlistentry>
257           <term><literal>gio.ERROR_FAILED</literal></term>
258           <listitem>
259             <simpara>Generic error condition for when any operation fails.</simpara>
260           </listitem>
261         </varlistentry>
262         <varlistentry>
263           <term><literal>gio.ERROR_FAILED_HANDLED</literal></term>
264           <listitem>
265             <simpara>Operation failed and a helper program has already interacted with
266             the user. Do not display any error dialog. </simpara>
267           </listitem>
268         </varlistentry>
269         <varlistentry>
270           <term><literal>gio.ERROR_FILENAME_TOO_LONG</literal></term>
271           <listitem>
272             <simpara>Filename is too many characters.</simpara>
273           </listitem>
274         </varlistentry>
275         <varlistentry>
276           <term><literal>gio.ERROR_HOST_NOT_FOUND</literal></term>
277           <listitem>
278             <simpara>Host couldn't be found (remote operations).</simpara>
279           </listitem>
280         </varlistentry>
281         <varlistentry>
282           <term><literal>gio.ERROR_INVALID_ARGUMENT</literal></term>
283           <listitem>
284             <simpara>Invalid argument.</simpara>
285           </listitem>
286         </varlistentry>
287         <varlistentry>
288           <term><literal>gio.ERROR_INVALID_FILENAME</literal></term>
289           <listitem>
290             <simpara>Filename is invalid or contains invalid characters.</simpara>
291           </listitem>
292         </varlistentry>
293         <varlistentry>
294           <term><literal>gio.ERROR_IS_DIRECTORY</literal></term>
295           <listitem>
296             <simpara>File is a directory error.</simpara>
297           </listitem>
298         </varlistentry>
299         <varlistentry>
300           <term><literal>gio.ERROR_NOT_DIRECTORY</literal></term>
301           <listitem>
302             <simpara>File is not a directory.</simpara>
303           </listitem>
304         </varlistentry>
305         <varlistentry>
306           <term><literal>gio.ERROR_NOT_EMPTY</literal></term>
307           <listitem>
308             <simpara>File is a directory that isn't empty.</simpara>
309           </listitem>
310         </varlistentry>
311         <varlistentry>
312           <term><literal>gio.ERROR_NOT_FOUND</literal></term>
313           <listitem>
314             <simpara>File not found error.</simpara>
315           </listitem>
316         </varlistentry>
317         <varlistentry>
318           <term><literal>gio.ERROR_NOT_MOUNTABLE_FILE</literal></term>
319           <listitem>
320             <simpara>File cannot be mounted.</simpara>
321           </listitem>
322         </varlistentry>
323         <varlistentry>
324           <term><literal>gio.ERROR_NOT_MOUNTED</literal></term>
325           <listitem>
326             <simpara>File isn't mounted. </simpara>
327           </listitem>
328         </varlistentry>
329         <varlistentry>
330           <term><literal>gio.ERROR_NOT_REGULAR_FILE</literal></term>
331           <listitem>
332             <simpara>File is not a regular file.</simpara>
333           </listitem>
334         </varlistentry>
335         <varlistentry>
336           <term><literal>gio.ERROR_NOT_SUPPORTED</literal></term>
337           <listitem>
338             <simpara>Operation not supported for the current backend.</simpara>
339           </listitem>
340         </varlistentry>
341         <varlistentry>
342           <term><literal>gio.ERROR_NOT_SYMBOLIC_LINK</literal></term>
343           <listitem>
344             <simpara>File is not a symbolic link.</simpara>
345           </listitem>
346         </varlistentry>
347         <varlistentry>
348           <term><literal>gio.ERROR_NO_SPACE</literal></term>
349           <listitem>
350             <simpara>No space left on drive. </simpara>
351           </listitem>
352         </varlistentry>
353         <varlistentry>
354           <term><literal>gio.ERROR_PENDING</literal></term>
355           <listitem>
356             <simpara>Operations are still pending.</simpara>
357           </listitem>
358         </varlistentry>
359         <varlistentry>
360           <term><literal>gio.ERROR_PERMISSION_DENIED</literal></term>
361           <listitem>
362             <simpara>Permission denied.</simpara>
363           </listitem>
364         </varlistentry>
365         <varlistentry>
366           <term><literal>gio.ERROR_READ_ONLY</literal></term>
367           <listitem>
368             <simpara>File is read only. </simpara>
369           </listitem>
370         </varlistentry>
371         <varlistentry>
372           <term><literal>gio.ERROR_TIMED_OUT</literal></term>
373           <listitem>
374             <simpara>Operation timed out. </simpara>
375           </listitem>
376         </varlistentry>
377         <varlistentry>
378           <term><literal>gio.ERROR_TOO_MANY_LINKS</literal></term>
379           <listitem>
380             <simpara>File contains too many symbolic links. </simpara>
381           </listitem>
382         </varlistentry>
383         <varlistentry>
384           <term><literal>gio.ERROR_TOO_MANY_OPEN_FILES</literal></term>
385           <listitem>
386             <simpara>The current process has too many files open and can't open any
387             more. Duplicate descriptors do count toward this limit. Since 2.20</simpara>
388           </listitem>
389         </varlistentry>
390         <varlistentry>
391           <term><literal>gio.ERROR_WOULD_BLOCK</literal></term>
392           <listitem>
393             <simpara>Operation would block.</simpara>
394           </listitem>
395         </varlistentry>
396         <varlistentry>
397           <term><literal>gio.ERROR_WOULD_MERGE</literal></term>
398           <listitem>
399             <simpara>Operation would merge files.</simpara>
400           </listitem>
401         </varlistentry>
402         <varlistentry>
403           <term><literal>gio.ERROR_WOULD_RECURSE</literal></term>
404           <listitem>
405             <simpara>Operation would be recursive.</simpara>
406           </listitem>
407         </varlistentry>
408         <varlistentry>
409           <term><literal>gio.ERROR_WRONG_ETAG</literal></term>
410           <listitem>
411             <simpara>File's Entity Tag was incorrect. </simpara>
412           </listitem>
413         </varlistentry>
414       </variablelist>
415     </refsect2>
416
417     <refsect2 id="gio-file-attribute-constants">
418       <title id="gio-file-attribute-constants-title">Gio File Attribute Constants</title>
419
420       <para>
421           The file attributes.
422       </para>
423
424       <variablelist>
425         <varlistentry>
426           <term><literal>gio.FILE_ATTRIBUTE_STANDARD_TYPE</literal></term>
427           <listitem>
428             <simpara>
429                 "standard::type" A key in the "standard" namespace for storing file types. Corresponding
430                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref>
431                 is gio.FILE_ATTRIBUTE_TYPE_UINT32. The value for this key should contain a
432                 <xref linkend="gio-file-type-constants" endterm="gio-file-type-constants-title"></xref>
433             </simpara>
434           </listitem>
435         </varlistentry>
436         <varlistentry>
437           <term><literal>gio.FILE_ATTRIBUTE_STANDARD_IS_HIDDEN</literal></term>
438           <listitem>
439             <simpara>
440                 "standard::is-hidden" A key in the "standard" namespace for checking if a file is hidden. Corresponding
441                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref>
442                 is gio.FILE_ATTRIBUTE_TYPE_BOOLEAN.
443             </simpara>
444           </listitem>
445         </varlistentry>
446         <varlistentry>
447           <term><literal>gio.FILE_ATTRIBUTE_STANDARD_IS_BACKUP</literal></term>
448           <listitem>
449             <simpara>
450                 "standard::is-backup" A key in the "standard" namespace for checking if a file is a backup file. Corresponding
451                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref>
452                 is gio.FILE_ATTRIBUTE_TYPE_BOOLEAN.
453             </simpara>
454           </listitem>
455         </varlistentry>
456         <varlistentry>
457           <term><literal>gio.FILE_ATTRIBUTE_STANDARD_IS_SYMLINK</literal></term>
458           <listitem>
459             <simpara>
460                 "standard::is-symlink" A key in the "standard" namespace for checking if the file is a symlink.
461                 Typically the actual type is something else, if we followed the symlink to get the type. Corresponding
462                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref>
463                 is gio.FILE_ATTRIBUTE_TYPE_BOOLEAN.
464             </simpara>
465           </listitem>
466         </varlistentry>
467         <varlistentry>
468           <term><literal>gio.FILE_ATTRIBUTE_STANDARD_IS_VIRTUAL</literal></term>
469           <listitem>
470             <simpara>
471                 "standard::is-virtual" A key in the "standard" namespace for checking if a file is virtual. Corresponding
472                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref>
473                 is gio.FILE_ATTRIBUTE_TYPE_BOOLEAN.
474             </simpara>
475           </listitem>
476         </varlistentry>
477         <varlistentry>
478           <term><literal>gio.FILE_ATTRIBUTE_STANDARD_NAME</literal></term>
479           <listitem>
480             <simpara>
481                 "standard::name" A key in the "standard" namespace for getting the name of the file.
482                 The name is the on-disk filename which may not be in any known encoding,
483                 and can thus not be generally displayed as is. Use
484                 gio.FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME if you need to display the name in a user
485                 interface. Corresponding GFileAttributeType is gio.FILE_ATTRIBUTE_TYPE_BYTE_STRING.
486             </simpara>
487           </listitem>
488         </varlistentry>
489         <varlistentry>
490           <term><literal>gio.FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME</literal></term>
491           <listitem>
492             <simpara>
493                 "standard::display-name" A key in the "standard" namespace for getting the display
494                 name of the file. A display name is guaranteed to be in UTF8 and can thus be displayed
495                 in the UI. Corresponding
496                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref>
497                 is gio.FILE_ATTRIBUTE_TYPE_STRING.
498             </simpara>
499           </listitem>
500         </varlistentry>
501         <varlistentry>
502           <term><literal>gio.FILE_ATTRIBUTE_STANDARD_EDIT_NAME</literal></term>
503           <listitem>
504             <simpara>
505                 "standard::edit-name" A key in the "standard" namespace for edit name of the file.
506                 An edit name is similar to the display name, but it is meant to be used when you want
507                 to rename the file in the UI. The display name might contain information you don't
508                 want in the new filename (such as "(invalid unicode)" if the filename was in an
509                 invalid encoding). Corresponding
510                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref>
511                 is gio.FILE_ATTRIBUTE_TYPE_STRING.
512             </simpara>
513           </listitem>
514         </varlistentry>
515         <varlistentry>
516           <term><literal>gio.FILE_ATTRIBUTE_STANDARD_COPY_NAME</literal></term>
517           <listitem>
518             <simpara>
519                 "standard::copy-name" A key in the "standard" namespace for getting the copy
520                 name of the file. The copy name is an optional version of the name. If available
521                 it's always in UTF8, and corresponds directly to the original filename (only transcoded
522                 to UTF8). This is useful if you want to copy the file to another filesystem that might
523                 have a different encoding. If the filename is not a valid string in the encoding selected
524                 for the filesystem it is in then the copy name will not be set. Corresponding
525                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref>
526                 is gio.FILE_ATTRIBUTE_TYPE_STRING.
527             </simpara>
528           </listitem>
529         </varlistentry>
530         <varlistentry>
531           <term><literal>gio.FILE_ATTRIBUTE_STANDARD_ICON</literal></term>
532           <listitem>
533             <simpara>
534                 "standard::icon" A key in the "standard" namespace for getting the icon for the file. Corresponding
535                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref>
536                 is gio.FILE_ATTRIBUTE_TYPE_OBJECT. The value for this key should contain a
537                 <link linkend="class-gioicon"><classname>gio.Icon</classname></link>.
538             </simpara>
539           </listitem>
540         </varlistentry>
541         <varlistentry>
542           <term><literal>gio.FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE</literal></term>
543           <listitem>
544             <simpara>
545                 "standard::content-type" A key in the "standard" namespace for getting the content type of the file. Corresponding
546                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref>
547                 is gio.FILE_ATTRIBUTE_TYPE_STRING. The value for this key should contain a valid content type.
548             </simpara>
549           </listitem>
550         </varlistentry>
551         <varlistentry>
552           <term><literal>gio.FILE_ATTRIBUTE_STANDARD_FAST_CONTENT_TYPE</literal></term>
553           <listitem>
554             <simpara>
555                 "standard::fast-content-type" A key in the "standard" namespace for getting the fast
556                 content type. The fast content type isn't as reliable as the regular one, as it
557                 only uses the filename to guess it, but it is faster to calculate than the regular
558                 content type. Corresponding
559                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref>
560                 is gio.FILE_ATTRIBUTE_TYPE_STRING.
561             </simpara>
562           </listitem>
563         </varlistentry>
564         <varlistentry>
565           <term><literal>gio.FILE_ATTRIBUTE_STANDARD_SIZE</literal></term>
566           <listitem>
567             <simpara>
568                 "standard::size" A key in the "standard" namespace for getting the file's size (in bytes). Corresponding
569                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref>
570                 is gio.FILE_ATTRIBUTE_TYPE_UINT64.
571             </simpara>
572           </listitem>
573         </varlistentry>
574         <varlistentry>
575           <term><literal>gio.FILE_ATTRIBUTE_STANDARD_SYMLINK_TARGET</literal></term>
576           <listitem>
577             <simpara>
578                 "standard::symlink-target" A key in the "standard" namespace for getting the target URI
579                 for the file, in the case of gio.FILE_TYPE_SHORTCUT or gio.FILE_TYPE_MOUNTABLE files. Corresponding
580                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref>
581                 is G_FILE_ATTRIBUTE_TYPE_STRING.
582             </simpara>
583           </listitem>
584         </varlistentry>
585         <varlistentry>
586           <term><literal>gio.FILE_ATTRIBUTE_STANDARD_SORT_ORDER</literal></term>
587           <listitem>
588             <simpara>
589                 "standard::sort-order" A key in the "standard" namespace for setting the sort order of a file. Corresponding
590                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref>
591                 is gio.FILE_ATTRIBUTE_TYPE_INT32. An example use would be in file managers, which would use this
592                 key to set the order files are displayed. Files with smaller sort order should be sorted first,
593                 and files without sort order as if sort order was zero.
594             </simpara>
595           </listitem>
596         </varlistentry>
597         <varlistentry>
598           <term><literal>gio.FILE_ATTRIBUTE_ETAG_VALUE</literal></term>
599           <listitem>
600             <simpara>
601                 "etag::value" A key in the "etag" namespace for getting the value of the file's entity tag. Corresponding
602                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref>
603                 is gio.FILE_ATTRIBUTE_TYPE_STRING.
604             </simpara>
605           </listitem>
606         </varlistentry>
607         <varlistentry>
608           <term><literal>gio.FILE_ATTRIBUTE_ID_FILE</literal></term>
609           <listitem>
610             <simpara>
611                 "id::file" A key in the "id" namespace for getting a file identifier. Corresponding
612                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref>
613                 is gio.FILE_ATTRIBUTE_TYPE_STRING. An example use would be during listing files,
614                 to avoid recursive directory scanning.
615             </simpara>
616           </listitem>
617         </varlistentry>
618         <varlistentry>
619           <term><literal>gio.FILE_ATTRIBUTE_ID_FILESYSTEM</literal></term>
620           <listitem>
621             <simpara>
622                 "id::filesystem" A key in the "id" namespace for getting the file system identifier. Corresponding
623                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref>
624                 is gio.FILE_ATTRIBUTE_TYPE_STRING. An example use would be during drag and
625                 drop to see if the source and target are on the same filesystem (default to move) or not (default to copy).
626             </simpara>
627           </listitem>
628         </varlistentry>
629         <varlistentry>
630           <term><literal>gio.FILE_ATTRIBUTE_ACCESS_CAN_READ</literal></term>
631           <listitem>
632             <simpara>
633                 "access::can-read" A key in the "access" namespace for getting read privileges. Corresponding
634                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref>
635                 is G_FILE_ATTRIBUTE_TYPE_BOOLEAN. This attribute will be <literal>True</literal>
636                 if the user is able to read the file.
637             </simpara>
638           </listitem>
639         </varlistentry>
640         <varlistentry>
641           <term><literal>gio.FILE_ATTRIBUTE_ACCESS_CAN_WRITE</literal></term>
642           <listitem>
643             <simpara>
644                 "access::can-write" A key in the "access" namespace for getting write privileges.Corresponding
645                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref>
646                 is gio.FILE_ATTRIBUTE_TYPE_BOOLEAN. This attribute will be <literal>True</literal>
647                 if the user is able to write to the file.
648             </simpara>
649           </listitem>
650         </varlistentry>
651         <varlistentry>
652           <term><literal>gio.FILE_ATTRIBUTE_ACCESS_CAN_EXECUTE</literal></term>
653           <listitem>
654             <simpara>
655                 "access::can-execute" A key in the "access" namespace for getting execution privileges. Corresponding
656                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref>
657                 is gio.FILE_ATTRIBUTE_TYPE_BOOLEAN. This attribute will be <literal>True</literal>
658                 if the user is able to execute the file.
659             </simpara>
660           </listitem>
661         </varlistentry>
662         <varlistentry>
663           <term><literal>gio.FILE_ATTRIBUTE_ACCESS_CAN_DELETE</literal></term>
664           <listitem>
665             <simpara>
666                 "access::can-delete" A key in the "access" namespace for checking deletion privileges. Corresponding
667                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref>
668                 is gio.FILE_ATTRIBUTE_TYPE_BOOLEAN. This attribute will be <literal>True</literal>
669                 if the user is able to delete the file.
670             </simpara>
671           </listitem>
672         </varlistentry>
673         <varlistentry>
674           <term><literal>gio.FILE_ATTRIBUTE_ACCESS_CAN_TRASH</literal></term>
675           <listitem>
676             <simpara>
677                 "access::can-trash" A key in the "access" namespace for checking trashing privileges. Corresponding
678                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref>
679                 is gio.FILE_ATTRIBUTE_TYPE_BOOLEAN. This attribute will be <literal>True</literal>
680                 if the user is able to move the file to the trash.
681             </simpara>
682           </listitem>
683         </varlistentry>
684         <varlistentry>
685           <term><literal>gio.FILE_ATTRIBUTE_ACCESS_CAN_RENAME</literal></term>
686           <listitem>
687             <simpara>
688                 "access::can-rename" A key in the "access" namespace for checking renaming privileges. Corresponding
689                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref>
690                 is G_FILE_ATTRIBUTE_TYPE_BOOLEAN. This attribute will be <literal>True</literal>
691                 if the user is able to rename the file.
692             </simpara>
693           </listitem>
694         </varlistentry>
695         <varlistentry>
696           <term><literal>gio.FILE_ATTRIBUTE_MOUNTABLE_CAN_MOUNT</literal></term>
697           <listitem>
698             <simpara>
699                 "mountable::can-mount" A key in the "mountable" namespace for checking if
700                 a file (of type G_FILE_TYPE_MOUNTABLE) is mountable. Corresponding
701                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref>
702                 is gio.FILE_ATTRIBUTE_TYPE_BOOLEAN.
703             </simpara>
704           </listitem>
705         </varlistentry>
706         <varlistentry>
707           <term><literal>gio.FILE_ATTRIBUTE_MOUNTABLE_CAN_UNMOUNT</literal></term>
708           <listitem>
709             <simpara>
710                 "mountable::can-unmount" A key in the "mountable" namespace for checking if a file
711                 (of type G_FILE_TYPE_MOUNTABLE) is unmountable. Corresponding
712                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref>
713                 is gio.FILE_ATTRIBUTE_TYPE_BOOLEAN.
714             </simpara>
715           </listitem>
716         </varlistentry>
717         <varlistentry>
718           <term><literal>gio.FILE_ATTRIBUTE_MOUNTABLE_CAN_EJECT</literal></term>
719           <listitem>
720             <simpara>
721                 "mountable::can-eject" A key in the "mountable" namespace for checking if a file
722                 (of type G_FILE_TYPE_MOUNTABLE) can be ejected. Corresponding
723                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref>
724                 is gio.FILE_ATTRIBUTE_TYPE_BOOLEAN.
725             </simpara>
726           </listitem>
727         </varlistentry>
728         <varlistentry>
729           <term><literal>gio.FILE_ATTRIBUTE_MOUNTABLE_UNIX_DEVICE</literal></term>
730           <listitem>
731             <simpara>
732                 "mountable::unix-device" A key in the "mountable" namespace for getting the unix device. Corresponding
733                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref>
734                 is gio.FILE_ATTRIBUTE_TYPE_UINT32.
735             </simpara>
736           </listitem>
737         </varlistentry>
738         <varlistentry>
739           <term><literal>gio.FILE_ATTRIBUTE_MOUNTABLE_HAL_UDI</literal></term>
740           <listitem>
741             <simpara>
742                 "mountable::hal-udi" A key in the "mountable" namespace for getting the
743                 HAL UDI for the mountable file. Corresponding
744                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref>
745                 is gio.FILE_ATTRIBUTE_TYPE_STRING.
746             </simpara>
747           </listitem>
748         </varlistentry>
749         <varlistentry>
750           <term><literal>gio.FILE_ATTRIBUTE_TIME_MODIFIED</literal></term>
751           <listitem>
752             <simpara>
753                 "time::modified" A key in the "time" namespace for getting the time the file was last modified. Corresponding
754                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref>
755                 is gio.FILE_ATTRIBUTE_TYPE_UINT64, and contains the UNIX time since the file was modified.
756             </simpara>
757           </listitem>
758         </varlistentry>
759         <varlistentry>
760           <term><literal>gio.FILE_ATTRIBUTE_TIME_MODIFIED_USEC</literal></term>
761           <listitem>
762             <simpara>
763                 "time::modified-usec" A key in the "time" namespace for getting the miliseconds
764                 of the time the file was last modified. This should be used in conjunction
765                 with G_FILE_ATTRIBUTE_TIME_MODIFIED. Corresponding
766                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref>
767                 is G_FILE_ATTRIBUTE_TYPE_UINT32.
768             </simpara>
769           </listitem>
770         </varlistentry>
771         <varlistentry>
772           <term><literal>gio.FILE_ATTRIBUTE_TIME_ACCESS</literal></term>
773           <listitem>
774             <simpara>
775                 "time::access" A key in the "time" namespace for getting the time the file was last accessed. Corresponding
776                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref>
777                 is gio.FILE_ATTRIBUTE_TYPE_UINT64, and contains the UNIX time since the file was last accessed.
778             </simpara>
779           </listitem>
780         </varlistentry>
781         <varlistentry>
782           <term><literal>gio.FILE_ATTRIBUTE_TIME_ACCESS_USEC</literal></term>
783           <listitem>
784             <simpara>
785                 "time::access-usec" A key in the "time" namespace for getting the microseconds of
786                 the time the file was last accessed. This should be used in conjunction
787                 with G_FILE_ATTRIBUTE_TIME_ACCESS. Corresponding
788                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref>
789                 is gio.FILE_ATTRIBUTE_TYPE_UINT32.
790             </simpara>
791           </listitem>
792         </varlistentry>
793         <varlistentry>
794           <term><literal>gio.FILE_ATTRIBUTE_TIME_CHANGED</literal></term>
795           <listitem>
796             <simpara>
797                 "time::changed" A key in the "time" namespace for getting the time the
798                 file was last changed. Corresponding
799                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref>
800                 is gio.FILE_ATTRIBUTE_TYPE_UINT64, and contains the UNIX time since the file was last changed.
801                 This corresponds to the traditional UNIX ctime.
802             </simpara>
803           </listitem>
804         </varlistentry>
805         <varlistentry>
806           <term><literal>gio.FILE_ATTRIBUTE_TIME_CHANGED_USEC</literal></term>
807           <listitem>
808             <simpara>
809                 "time::changed-usec" A key in the "time" namespace for getting the microseconds
810                 of the time the file was last changed. This should be used in conjunction
811                 with G_FILE_ATTRIBUTE_TIME_CHANGED. Corresponding
812                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref>
813                 is gio.FILE_ATTRIBUTE_TYPE_UINT32.
814             </simpara>
815           </listitem>
816         </varlistentry>
817         <varlistentry>
818           <term><literal>gio.FILE_ATTRIBUTE_TIME_CREATED</literal></term>
819           <listitem>
820             <simpara>
821                 "time::created" A key in the "time" namespace for getting the time the file was created. Corresponding
822                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref>
823                 is gio.FILE_ATTRIBUTE_TYPE_UINT64, and contains the UNIX time since the file was created.
824                 This corresponds to the NTFS ctime.
825             </simpara>
826           </listitem>
827         </varlistentry>
828         <varlistentry>
829           <term><literal>gio.FILE_ATTRIBUTE_TIME_CREATED_USEC</literal></term>
830           <listitem>
831             <simpara>
832                 "time::created-usec" A key in the "time" namespace for getting the microseconds of the time the
833                 file was created. This should be used in conjunction with G_FILE_ATTRIBUTE_TIME_CREATED. Corresponding
834                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref>
835                 is gio.FILE_ATTRIBUTE_TYPE_UINT32.
836             </simpara>
837           </listitem>
838         </varlistentry>
839         <varlistentry>
840           <term><literal>gio.FILE_ATTRIBUTE_UNIX_DEVICE</literal></term>
841           <listitem>
842             <simpara>
843                 "unix::device" A key in the "unix" namespace for getting the device id of the device the file
844                 is located on (see stat() documentation). This attribute is only available
845                 for UNIX file systems. Corresponding
846                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref>
847                 is gio.FILE_ATTRIBUTE_TYPE_UINT32.
848             </simpara>
849           </listitem>
850         </varlistentry>
851         <varlistentry>
852           <term><literal>gio.FILE_ATTRIBUTE_UNIX_INODE</literal></term>
853           <listitem>
854             <simpara>
855                 "unix::inode" A key in the "unix" namespace for getting the inode of the file. This attribute is only
856                 available for UNIX file systems. Corresponding
857                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref>
858                 is G_FILE_ATTRIBUTE_TYPE_UINT64.
859             </simpara>
860           </listitem>
861         </varlistentry>
862         <varlistentry>
863           <term><literal>gio.FILE_ATTRIBUTE_UNIX_MODE</literal></term>
864           <listitem>
865             <simpara>
866                 "unix::mode" A key in the "unix" namespace for getting the mode of the file (e.g.
867                 whether the file is a regular file, symlink, etc). See lstat() documentation.
868                 This attribute is only available for UNIX file systems. Corresponding
869                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref>
870                 is gio.FILE_ATTRIBUTE_TYPE_UINT32.
871             </simpara>
872           </listitem>
873         </varlistentry>
874         <varlistentry>
875           <term><literal>gio.FILE_ATTRIBUTE_UNIX_NLINK</literal></term>
876           <listitem>
877             <simpara>
878                 "unix::nlink" A key in the "unix" namespace for getting the number of hard links
879                 for a file. See lstat() documentation. This attribute is only available for UNIX
880                 file systems. Corresponding
881                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref>
882                 is gio.FILE_ATTRIBUTE_TYPE_UINT32.
883             </simpara>
884           </listitem>
885         </varlistentry>
886         <varlistentry>
887           <term><literal>gio.FILE_ATTRIBUTE_UNIX_UID</literal></term>
888           <listitem>
889             <simpara>
890                 "unix::uid" A key in the "unix" namespace for getting the user ID for the file. This attribute
891                 is only available for UNIX file systems. Corresponding
892                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref>
893                 is gio.FILE_ATTRIBUTE_TYPE_UINT32.
894             </simpara>
895           </listitem>
896         </varlistentry>
897         <varlistentry>
898           <term><literal>gio.FILE_ATTRIBUTE_UNIX_GID</literal></term>
899           <listitem>
900             <simpara>
901                 "unix::gid" A key in the "unix" namespace for getting the group ID for the file.
902                 This attribute is only available for UNIX file systems. Corresponding
903                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref>
904                 is gio.FILE_ATTRIBUTE_TYPE_UINT32.
905             </simpara>
906           </listitem>
907         </varlistentry>
908         <varlistentry>
909           <term><literal>gio.FILE_ATTRIBUTE_UNIX_RDEV</literal></term>
910           <listitem>
911             <simpara>
912                 "unix::rdev" A key in the "unix" namespace for getting the device ID for the file
913                 (if it is a special file). See lstat() documentation. This attribute is only available
914                 for UNIX file systems. Corresponding
915                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref>
916                 is gio.FILE_ATTRIBUTE_TYPE_UINT32.
917             </simpara>
918           </listitem>
919         </varlistentry>
920         <varlistentry>
921           <term><literal>gio.FILE_ATTRIBUTE_UNIX_BLOCK_SIZE</literal></term>
922           <listitem>
923             <simpara>
924                 "unix::block-size" A key in the "unix" namespace for getting the block size for
925                 the file system. This attribute is only available for UNIX file systems. Corresponding
926                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref>
927                 is gio.FILE_ATTRIBUTE_TYPE_UINT32.
928             </simpara>
929           </listitem>
930         </varlistentry>
931         <varlistentry>
932           <term><literal>gio.FILE_ATTRIBUTE_UNIX_BLOCKS</literal></term>
933           <listitem>
934             <simpara>
935                 "unix::blocks" A key in the "unix" namespace for getting the number of blocks allocated
936                 for the file. This attribute is only available for UNIX file systems. Corresponding
937                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref>
938                 is G_FILE_ATTRIBUTE_TYPE_UINT64.
939             </simpara>
940           </listitem>
941         </varlistentry>
942         <varlistentry>
943           <term><literal>gio.FILE_ATTRIBUTE_UNIX_IS_MOUNTPOINT</literal></term>
944           <listitem>
945             <simpara>
946                 "unix::is-mountpoint" A key in the "unix" namespace for checking if the file represents
947                 a UNIX mount point. This attribute is <literal>True</literal> if the file is a UNIX mount point.
948                 This attribute is only available for UNIX file systems. Corresponding
949                 GFileAttributeType
950                 is gio.FILE_ATTRIBUTE_TYPE_BOOLEAN.
951             </simpara>
952           </listitem>
953         </varlistentry>
954         <varlistentry>
955           <term><literal>gio.FILE_ATTRIBUTE_DOS_IS_ARCHIVE</literal></term>
956           <listitem>
957             <simpara>
958                 "dos::is-archive" A key in the "dos" namespace for checking if the file's archive
959                 flag is set. This attribute is <literal>True</literal> if the archive flag is set.
960                 This attribute is only available for DOS file systems. Corresponding
961                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref>
962                 is G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
963             </simpara>
964           </listitem>
965         </varlistentry>
966         <varlistentry>
967           <term><literal>gio.FILE_ATTRIBUTE_DOS_IS_SYSTEM</literal></term>
968           <listitem>
969             <simpara>
970                 "dos::is-system" A key in the "dos" namespace for checking if the file's backup
971                 flag is set. This attribute is <literal>True</literal> if the backup flag is set.
972                 This attribute is only available for DOS file systems. Corresponding
973                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref> is
974                 G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
975             </simpara>
976           </listitem>
977         </varlistentry>
978         <varlistentry>
979           <term><literal>gio.FILE_ATTRIBUTE_OWNER_USER</literal></term>
980           <listitem>
981             <simpara>
982                 "owner::user" A key in the "owner" namespace for getting the user name
983                 of the file's owner. Corresponding
984                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref>
985                 is G_FILE_ATTRIBUTE_TYPE_STRING.
986             </simpara>
987           </listitem>
988         </varlistentry>
989         <varlistentry>
990           <term><literal>gio.FILE_ATTRIBUTE_OWNER_USER_REAL</literal></term>
991           <listitem>
992             <simpara>
993                 "owner::user-real" A key in the "owner" namespace for getting the real name
994                 of the user that owns the file. Corresponding
995                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref> is
996                 G_FILE_ATTRIBUTE_TYPE_STRING.
997             </simpara>
998           </listitem>
999         </varlistentry>
1000         <varlistentry>
1001           <term><literal>gio.FILE_ATTRIBUTE_OWNER_GROUP</literal></term>
1002           <listitem>
1003             <simpara>
1004                 "owner::group" A key in the "owner" namespace for getting the file owner's
1005                 group. Corresponding
1006                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref>
1007                 is G_FILE_ATTRIBUTE_TYPE_STRING.
1008             </simpara>
1009           </listitem>
1010         </varlistentry>
1011         <varlistentry>
1012           <term><literal>gio.FILE_ATTRIBUTE_THUMBNAIL_PATH</literal></term>
1013           <listitem>
1014             <simpara>
1015                 "thumbnail::path" A key in the "thumbnail" namespace for getting the path
1016                 to the thumbnail image. Corresponding
1017                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref>
1018                 is G_FILE_ATTRIBUTE_TYPE_BYTE_STRING.
1019             </simpara>
1020           </listitem>
1021         </varlistentry>
1022         <varlistentry>
1023           <term><literal>gio.FILE_ATTRIBUTE_THUMBNAILING_FAILED</literal></term>
1024           <listitem>
1025             <simpara>
1026                 "thumbnail::failed" A key in the "thumbnail" namespace for checking if thumbnailing failed. This attribute
1027                 is <literal>True</literal> if thumbnailing failed. Corresponding
1028                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref> is
1029                 G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
1030             </simpara>
1031           </listitem>
1032         </varlistentry>
1033         <varlistentry>
1034           <term><literal>gio.FILE_ATTRIBUTE_PREVIEW_ICON</literal></term>
1035           <listitem>
1036             <simpara>
1037                 "preview::icon" A key in the "preview" namespace for getting a
1038                 <link linkend="class-gioicon"><classname>gio.Icon</classname></link>
1039                 that can be used to get preview of the file. For example, it
1040                 may be a low resolution thumbnail without metadata. Corresponding
1041                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref> is
1042                 G_FILE_ATTRIBUTE_TYPE_OBJECT. The value for this key should contain a GIcon.
1043             </simpara>
1044           </listitem>
1045         </varlistentry>
1046         <varlistentry>
1047           <term><literal>gio.FILE_ATTRIBUTE_FILESYSTEM_SIZE</literal></term>
1048           <listitem>
1049             <simpara>
1050                 "filesystem::size" A key in the "filesystem" namespace for getting the total
1051                 size (in bytes) of the file system, used in
1052                 <methodname><link linkend="method-giofile--query-filesystem-info">query_filesystem_info</link></methodname>().
1053                 Corresponding
1054                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref>
1055                 is G_FILE_ATTRIBUTE_TYPE_UINT64.
1056             </simpara>
1057           </listitem>
1058         </varlistentry>
1059         <varlistentry>
1060           <term><literal>gio.FILE_ATTRIBUTE_FILESYSTEM_FREE</literal></term>
1061           <listitem>
1062             <simpara>
1063                 "filesystem::free" A key in the "filesystem" namespace for getting the number of bytes of free space left
1064                 on the file system. Corresponding
1065                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref>
1066                 is G_FILE_ATTRIBUTE_TYPE_UINT64.
1067             </simpara>
1068           </listitem>
1069         </varlistentry>
1070         <varlistentry>
1071           <term><literal>gio.FILE_ATTRIBUTE_FILESYSTEM_TYPE</literal></term>
1072           <listitem>
1073             <simpara>
1074                 "filesystem::type" A key in the "filesystem" namespace for getting the file system's type. Corresponding
1075                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref>
1076                 is G_FILE_ATTRIBUTE_TYPE_STRING.
1077             </simpara>
1078           </listitem>
1079         </varlistentry>
1080         <varlistentry>
1081           <term><literal>gio.FILE_ATTRIBUTE_FILESYSTEM_READONLY</literal></term>
1082           <listitem>
1083             <simpara>
1084                 "filesystem::readonly" A key in the "filesystem" namespace for checking if the
1085                 file system is read only. Is set to <literal>True</literal> if the file system
1086                 is read only. Corresponding
1087                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref>
1088                 is G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
1089             </simpara>
1090           </listitem>
1091         </varlistentry>
1092         <varlistentry>
1093           <term><literal>gio.FILE_ATTRIBUTE_GVFS_BACKEND</literal></term>
1094           <listitem>
1095             <simpara>
1096                 "gvfs::backend" A key in the "gvfs" namespace that gets the name of the current GVFS backend in use. Corresponding
1097                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref>
1098                 is G_FILE_ATTRIBUTE_TYPE_STRING.
1099             </simpara>
1100           </listitem>
1101         </varlistentry>
1102         <varlistentry>
1103           <term><literal>gio.FILE_ATTRIBUTE_SELINUX_CONTEXT</literal></term>
1104           <listitem>
1105             <simpara>
1106                 "selinux::context" A key in the "selinux" namespace for getting the file's SELinux context. Corresponding
1107                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref>
1108                 is G_FILE_ATTRIBUTE_TYPE_STRING.
1109                 Note that this attribute is only available if GLib has been built with SELinux support.
1110             </simpara>
1111           </listitem>
1112         </varlistentry>
1113         <varlistentry>
1114           <term><literal>gio.FILE_ATTRIBUTE_TRASH_ITEM_COUNT</literal></term>
1115           <listitem>
1116             <simpara>
1117                 "trash::item-count" A key in the "trash" namespace. When requested against "trash:///" returns the number
1118                 of (toplevel) items in the trash folder. Corresponding
1119                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref>
1120                 is G_FILE_ATTRIBUTE_TYPE_UINT32.
1121             </simpara>
1122           </listitem>
1123         </varlistentry>
1124         <varlistentry>
1125           <term><literal>gio.FILE_ATTRIBUTE_FILESYSTEM_USE_PREVIEW</literal></term>
1126           <listitem>
1127             <simpara>
1128                 "filesystem::use-preview" A key in the "filesystem" namespace for hinting a file manager
1129                 application whether it should preview (e.g. thumbnail) files on the file system.
1130                 The value for this key contain a GFilesystemPreviewType.
1131             </simpara>
1132           </listitem>
1133         </varlistentry>
1134         <varlistentry>
1135           <term><literal>gio.FILE_ATTRIBUTE_STANDARD_DESCRIPTION</literal></term>
1136           <listitem>
1137             <simpara>
1138                 "standard::description" A key in the "standard" namespace for getting the description
1139                 of the file. The description is a utf8 string that describes the file, generally containing
1140                 the filename, but can also contain furter information. Example descriptions could be
1141                 "filename (on hostname)" for a remote file or "filename (in trash)" for a
1142                 file in the trash. This is useful for instance as the window title when
1143                 displaying a directory or for a bookmarks menu. Corresponding
1144                 <xref linkend="gio-file-attribute-type-constants" endterm="gio-file-attribute-type-constants-title"></xref>
1145                 is G_FILE_ATTRIBUTE_TYPE_STRING.
1146             </simpara>
1147           </listitem>
1148         </varlistentry>
1149       </variablelist>
1150     </refsect2>
1151
1152     <refsect2 id="gio-file-attribute-type-constants">
1153       <title id="gio-file-attribute-type-constants-title">Gio File Attribute Type Constants</title>
1154
1155       <para>
1156           The data types for file attributes.
1157       </para>
1158
1159       <variablelist>
1160         <varlistentry>
1161           <term><literal>gio.FILE_ATTRIBUTE_TYPE_BOOLEAN</literal></term>
1162           <listitem>
1163             <simpara>a boolean value.</simpara>
1164           </listitem>
1165         </varlistentry>
1166         <varlistentry>
1167           <term><literal>gio.FILE_ATTRIBUTE_TYPE_BYTE_STRING</literal></term>
1168           <listitem>
1169             <simpara>a zero terminated string of non-zero bytes.</simpara>
1170           </listitem>
1171         </varlistentry>
1172         <varlistentry>
1173           <term><literal>gio.FILE_ATTRIBUTE_TYPE_INT32</literal></term>
1174           <listitem>
1175             <simpara>a signed 4-byte/32-bit integer.</simpara>
1176           </listitem>
1177         </varlistentry>
1178         <varlistentry>
1179           <term><literal>gio.FILE_ATTRIBUTE_TYPE_INT64</literal></term>
1180           <listitem>
1181             <simpara>a signed 8-byte/64-bit integer.</simpara>
1182           </listitem>
1183         </varlistentry>
1184         <varlistentry>
1185           <term><literal>gio.FILE_ATTRIBUTE_TYPE_INVALID</literal></term>
1186           <listitem>
1187             <simpara>indicates an invalid or uninitalized type.</simpara>
1188           </listitem>
1189         </varlistentry>
1190         <varlistentry>
1191           <term><literal>gio.FILE_ATTRIBUTE_TYPE_OBJECT</literal></term>
1192           <listitem>
1193             <simpara>a <link linkend="class-gobject">gobject.GObject</link>.</simpara>
1194           </listitem>
1195         </varlistentry>
1196         <varlistentry>
1197           <term><literal>gio.FILE_ATTRIBUTE_TYPE_STRING</literal></term>
1198           <listitem>
1199             <simpara>a null terminated UTF8 string.</simpara>
1200           </listitem>
1201         </varlistentry>
1202         <varlistentry>
1203           <term><literal>gio.FILE_ATTRIBUTE_TYPE_UINT32</literal></term>
1204           <listitem>
1205             <simpara>an unsigned 4-byte/32-bit integer.</simpara>
1206           </listitem>
1207         </varlistentry>
1208         <varlistentry>
1209           <term><literal>gio.FILE_ATTRIBUTE_TYPE_UINT64</literal></term>
1210           <listitem>
1211             <simpara>an unsigned 8-byte/64-bit integer.</simpara>
1212           </listitem>
1213         </varlistentry>
1214       </variablelist>
1215     </refsect2>
1216
1217     <refsect2 id="gio-file-attribute-flags-constants">
1218       <title id="gio-file-attribute-flags-constants-title">Gio File Attribute Flags Constants</title>
1219
1220       <para>
1221           Flags specifying the behaviour of an attribute.
1222       </para>
1223
1224       <variablelist>
1225         <varlistentry>
1226           <term><literal>gio.FILE_ATTRIBUTE_INFO_NONE</literal></term>
1227           <listitem>
1228             <simpara>no flags set.</simpara>
1229           </listitem>
1230         </varlistentry>
1231         <varlistentry>
1232           <term><literal>gio.FILE_ATTRIBUTE_INFO_COPY_WITH_FILE</literal></term>
1233           <listitem>
1234             <simpara>copy the attribute values when the file is copied.</simpara>
1235           </listitem>
1236         </varlistentry>
1237         <varlistentry>
1238           <term><literal>gio.FILE_ATTRIBUTE_INFO_COPY_WHEN_MOVED</literal></term>
1239           <listitem>
1240             <simpara>copy the attribute values when the file is moved.</simpara>
1241           </listitem>
1242         </varlistentry>
1243       </variablelist>
1244     </refsect2>
1245
1246     <refsect2 id="gio-file-create-flags-constants">
1247       <title id="gio-file-create-flags-constants-title">Gio File Create Flags Constants</title>
1248
1249       <para>
1250           Flags used when an operation may create a file.
1251       </para>
1252
1253       <variablelist>
1254         <varlistentry>
1255           <term><literal>gio.FILE_CREATE_NONE</literal></term>
1256           <listitem>
1257             <simpara>No flags set.</simpara>
1258           </listitem>
1259         </varlistentry>
1260         <varlistentry>
1261           <term><literal>gio.FILE_CREATE_PRIVATE</literal></term>
1262           <listitem>
1263             <simpara>Create a file that can only be accessed by the current user.</simpara>
1264           </listitem>
1265         </varlistentry>
1266         <varlistentry>
1267           <term><literal>gio.FILE_CREATE_REPLACE_DESTINATION</literal></term>
1268           <listitem>
1269             <simpara>
1270                 Replace the destination as if it didn't exist before. Don't try
1271                 to keep any old permissions, replace instead of following links. This is
1272                 generally useful if you're doing a "copy over" rather than a "save new version of"
1273                 replace operation. You can think of it as "unlink destination" before writing
1274                 to it, although the implementation may not be exactly like that.
1275             </simpara>
1276           </listitem>
1277         </varlistentry>
1278       </variablelist>
1279     </refsect2>
1280
1281     <refsect2 id="gio-file-copy-flags-constants">
1282       <title id="gio-file-copy-flags-constants-title">Gio File Copy Flags Constants</title>
1283
1284       <para>
1285           Flags used when copying or moving files.
1286       </para>
1287
1288       <variablelist>
1289         <varlistentry>
1290           <term><literal>gio.FILE_COPY_NONE</literal></term>
1291           <listitem>
1292             <simpara>No flags set.</simpara>
1293           </listitem>
1294         </varlistentry>
1295         <varlistentry>
1296           <term><literal>gio.FILE_COPY_OVERWRITE</literal></term>
1297           <listitem>
1298             <simpara>Overwrite any existing files.</simpara>
1299           </listitem>
1300         </varlistentry>
1301         <varlistentry>
1302           <term><literal>gio.FILE_COPY_BACKUP</literal></term>
1303           <listitem>
1304             <simpara>Make a backup of any existing files.</simpara>
1305           </listitem>
1306         </varlistentry>
1307         <varlistentry>
1308           <term><literal>gio.FILE_COPY_NOFOLLOW_SYMLINKS</literal></term>
1309           <listitem>
1310             <simpara>Don't follow symlinks.</simpara>
1311           </listitem>
1312         </varlistentry>
1313         <varlistentry>
1314           <term><literal>gio.FILE_COPY_ALL_METADATA</literal></term>
1315           <listitem>
1316             <simpara>Copy all file metadata instead of just default set used for copy
1317             (see <link linkend="class-giofileinfo"><classname>gio.FileInfo</classname></link>).</simpara>
1318           </listitem>
1319         </varlistentry>
1320         <varlistentry>
1321           <term><literal>gio.FILE_COPY_NO_FALLBACK_FOR_MOVE</literal></term>
1322           <listitem>
1323             <simpara>Don't use copy and delete fallback if native move not supported.</simpara>
1324           </listitem>
1325         </varlistentry>
1326         <varlistentry>
1327           <term><literal>gio.FILE_COPY_TARGET_DEFAULT_PERMS</literal></term>
1328           <listitem>
1329             <simpara>Leaves target file with default perms, instead of setting the source file perms.</simpara>
1330           </listitem>
1331         </varlistentry>
1332       </variablelist>
1333     </refsect2>
1334
1335     <refsect2 id="gio-file-monitor-flags-constants">
1336       <title id="gio-file-monitor-flags-constants-title">Gio File Monitor Flags Constants</title>
1337
1338       <para>
1339             Flags used to set what a
1340             <link linkend="class-giofilemonitor"><classname>gio.FileMonitor</classname></link>
1341             will watch for.
1342       </para>
1343
1344       <variablelist>
1345         <varlistentry>
1346           <term><literal>gio.FILE_MONITOR_NONE</literal></term>
1347           <listitem>
1348             <simpara>No flags set.</simpara>
1349           </listitem>
1350         </varlistentry>
1351         <varlistentry>
1352           <term><literal>gio.FILE_MONITOR_WATCH_MOUNTS</literal></term>
1353           <listitem>
1354             <simpara>Watch for mount events.</simpara>
1355           </listitem>
1356         </varlistentry>
1357       </variablelist>
1358     </refsect2>
1359
1360     <refsect2 id="gio-file-query-info-flags-constants">
1361       <title id="gio-file-query-info-flags-constants-title">Gio File Query Info Flags Constants</title>
1362
1363       <para>
1364           Flags used when querying a
1365           <link linkend="class-giofile"><classname>gio.FileInfo</classname></link>.
1366       </para>
1367
1368       <variablelist>
1369         <varlistentry>
1370           <term><literal>gio.FILE_QUERY_INFO_NONE</literal></term>
1371           <listitem>
1372             <simpara>No flags set.</simpara>
1373           </listitem>
1374         </varlistentry>
1375         <varlistentry>
1376           <term><literal>gio.FILE_QUERY_INFO_NOFOLLOW_SYMLINKS</literal></term>
1377           <listitem>
1378             <simpara>Don't follow symlinks.</simpara>
1379           </listitem>
1380         </varlistentry>
1381       </variablelist>
1382     </refsect2>
1383
1384     <refsect2 id="gio-file-type-constants">
1385       <title id="gio-file-type-constants-title">Gio File Type Constants</title>
1386
1387       <para>
1388           Indicates the file's on-disk type.
1389       </para>
1390
1391       <variablelist>
1392         <varlistentry>
1393           <term><literal>gio.FILE_TYPE_DIRECTORY</literal></term>
1394           <listitem>
1395             <simpara>File handle represents a directory.</simpara>
1396           </listitem>
1397         </varlistentry>
1398         <varlistentry>
1399           <term><literal>gio.FILE_TYPE_MOUNTABLE</literal></term>
1400           <listitem>
1401             <simpara>File is a mountable location.</simpara>
1402           </listitem>
1403         </varlistentry>
1404         <varlistentry>
1405           <term><literal>gio.FILE_TYPE_REGULAR</literal></term>
1406           <listitem>
1407             <simpara>File handle represents a regular file.</simpara>
1408           </listitem>
1409         </varlistentry>
1410         <varlistentry>
1411           <term><literal>gio.FILE_TYPE_SHORTCUT</literal></term>
1412           <listitem>
1413             <simpara>File is a shortcut (Windows systems).</simpara>
1414           </listitem>
1415         </varlistentry>
1416         <varlistentry>
1417           <term><literal>gio.FILE_TYPE_SPECIAL</literal></term>
1418           <listitem>
1419             <simpara>File is a "special" file, such as a socket, fifo, block device, or character device.</simpara>
1420           </listitem>
1421         </varlistentry>
1422         <varlistentry>
1423           <term><literal>gio.FILE_TYPE_SYMBOLIC_LINK</literal></term>
1424           <listitem>
1425             <simpara>File handle represents a symbolic link (Unix systems).</simpara>
1426           </listitem>
1427         </varlistentry>
1428         <varlistentry>
1429           <term><literal>gio.FILE_TYPE_UNKNOWN</literal></term>
1430           <listitem>
1431             <simpara>File's type is unknown.</simpara>
1432           </listitem>
1433         </varlistentry>
1434       </variablelist>
1435     </refsect2>
1436
1437     <refsect2 id="gio-mount-mount-flags-constants">
1438       <title id="gio-mount-mount-flags-constants-title">Gio Mount Mount Flags Constants</title>
1439
1440       <para>
1441           Flags used when mounting a mount.
1442       </para>
1443
1444       <variablelist>
1445         <varlistentry>
1446           <term><literal>gio.MOUNT_MOUNT_NONE</literal></term>
1447           <listitem>
1448             <simpara>No flags set.</simpara>
1449           </listitem>
1450         </varlistentry>
1451       </variablelist>
1452     </refsect2>
1453
1454     <refsect2 id="gio-mount-unmount-flags-constants">
1455       <title id="gio-mount-unmount-flags-constants-title">Gio Mount Unmount Flags Constants</title>
1456
1457       <para>
1458           Flags used when unmounting a mount.
1459       </para>
1460
1461       <variablelist>
1462         <varlistentry>
1463           <term><literal>gio.MOUNT_UNMOUNT_NONE</literal></term>
1464           <listitem>
1465             <simpara>No flags set.</simpara>
1466           </listitem>
1467         </varlistentry>
1468         <varlistentry>
1469           <term><literal>gio.MOUNT_UNMOUNT_FORCE</literal></term>
1470           <listitem>
1471             <simpara>Unmount even if there are outstanding file operations on the mount.</simpara>
1472           </listitem>
1473         </varlistentry>
1474       </variablelist>
1475     </refsect2>
1476
1477     <refsect2 id="gio-mount-operation-result-constants">
1478       <title id="gio-mount-operation-result-constants-title">Gio Mount Operation Result Constants</title>
1479
1480       <para>
1481           returned as a result when a request for information is send by the mounting operation.
1482       </para>
1483
1484       <variablelist>
1485         <varlistentry>
1486           <term><literal>gio.MOUNT_OPERATION_HANDLED</literal></term>
1487           <listitem>
1488             <simpara>The request was fulfilled and the user specified data is now available.</simpara>
1489           </listitem>
1490         </varlistentry>
1491         <varlistentry>
1492           <term><literal>gio.MOUNT_OPERATION_ABORTED</literal></term>
1493           <listitem>
1494             <simpara>The user requested the mount operation to be aborted.</simpara>
1495           </listitem>
1496         </varlistentry>
1497         <varlistentry>
1498           <term><literal>gio.MOUNT_OPERATION_UNHANDLED</literal></term>
1499           <listitem>
1500             <simpara>The request was unhandled (i.e. not implemented).</simpara>
1501           </listitem>
1502         </varlistentry>
1503       </variablelist>
1504     </refsect2>
1505
1506     <refsect2 id="gio-password-save-constants">
1507       <title id="gio-password-save-constants-title">Gio Password Save Constants</title>
1508
1509       <para>
1510           is used to indicate the lifespan of a saved password.
1511       </para>
1512       <para>
1513           Gvfs stores passwords in the Gnome keyring when this flag allows it to,
1514           and later retrieves it again from there.
1515       </para>
1516
1517       <variablelist>
1518         <varlistentry>
1519           <term><literal>gio.PASSWORD_SAVE_FOR_SESSION</literal></term>
1520           <listitem>
1521             <simpara>save a password for the session.</simpara>
1522           </listitem>
1523         </varlistentry>
1524         <varlistentry>
1525           <term><literal>gio.PASSWORD_SAVE_NEVER</literal></term>
1526           <listitem>
1527             <simpara>never save a password.</simpara>
1528           </listitem>
1529         </varlistentry>
1530         <varlistentry>
1531           <term><literal>gio.PASSWORD_SAVE_PERMANENTLY</literal></term>
1532           <listitem>
1533             <simpara>save a password permanently.</simpara>
1534           </listitem>
1535         </varlistentry>
1536       </variablelist>
1537     </refsect2>
1538   </refsect1>
1539
1540 </refentry>