summaryrefslogtreecommitdiffstats
path: root/docs/reference/pygio-constants.xml
blob: dd851266921a938d3022a783060aa50e74f070f6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
<?xml version="1.0" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">

<refentry id="gio-constants">
  <refnamediv>
    <refname>gio Constants</refname>
    <refpurpose>the built-in constants of the gio module</refpurpose>
  </refnamediv>

  <refsect1>
    <title>Synopsis</title>

<programlisting>
<xref linkend="gio-emblem-origin-constants" endterm="gio-emblem-origin-constants-title"></xref>
<xref linkend="gio-error-constants" endterm="gio-error-constants-title"></xref>
</programlisting>

  </refsect1>

  <refsect1 id="gio-constants-description">
    <title>Description</title>

    <refsect2 id="gio-emblem-origin-constants">
      <title id="gio-emblem-origin-constants-title">Gio Emblem Origin Constants</title>

      <para>
	  GEmblemOrigin is used to add information about the origin of the emblem to GEmblem.
      </para>

      <variablelist>
	<varlistentry>
	  <term><literal>gio.EMBLEM_ORIGIN_DEVICE</literal></term>
	  <listitem>
	    <simpara>Embleme adds device-specific information.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>gio.EMBLEM_ORIGIN_LIVEMETADATA</literal></term>
	  <listitem>
	    <simpara>Emblem depicts live metadata, such as "readonly".</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>gio.EMBLEM_ORIGIN_TAG</literal></term>
	  <listitem>
	    <simpara>Emblem comes from a user-defined tag, e.g. set by nautilus (in the future).</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>gio.EMBLEM_ORIGIN_UNKNOWN</literal></term>
	  <listitem>
	    <simpara>Emblem of unknown origin.</simpara>
	  </listitem>
	</varlistentry>
      </variablelist>
    </refsect2>

    <refsect2 id="gio-error-constants">
      <title id="gio-error-constants-title">Gio Error Constants</title>

      <para>
	 GIOError Error codes returned by GIO functions.
      </para>

      <variablelist>
	<varlistentry>
	  <term><literal>gio.ERROR_ALREADY_MOUNTED</literal></term>
	  <listitem>
	    <simpara>File is already mounted.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>gio.ERROR_BUSY</literal></term>
	  <listitem>
	    <simpara>File is busy.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>gio.ERROR_CANCELLED</literal></term>
	  <listitem>
	    <simpara>Operation was cancelled. See
		<link linkend="class-giocancellable"><classname>gio.Cancellable</classname></link>.
	    </simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>gio.ERROR_CANT_CREATE_BACKUP</literal></term>
	  <listitem>
	    <simpara>Backup couldn't be created.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>gio.ERROR_CLOSED</literal></term>
	  <listitem>
	    <simpara>File was closed.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>gio.ERROR_EXISTS</literal></term>
	  <listitem>
	    <simpara>File already exists error.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>gio.ERROR_FAILED</literal></term>
	  <listitem>
	    <simpara>Generic error condition for when any operation fails.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>gio.ERROR_FAILED_HANDLED</literal></term>
	  <listitem>
	    <simpara>Operation failed and a helper program has already interacted with
	    the user. Do not display any error dialog. </simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>gio.ERROR_FILENAME_TOO_LONG</literal></term>
	  <listitem>
	    <simpara>Filename is too many characters.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>gio.ERROR_HOST_NOT_FOUND</literal></term>
	  <listitem>
	    <simpara>Host couldn't be found (remote operations).</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>gio.ERROR_INVALID_ARGUMENT</literal></term>
	  <listitem>
	    <simpara>Invalid argument.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>gio.ERROR_INVALID_FILENAME</literal></term>
	  <listitem>
	    <simpara>Filename is invalid or contains invalid characters.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>gio.ERROR_IS_DIRECTORY</literal></term>
	  <listitem>
	    <simpara>File is a directory error.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>gio.ERROR_NOT_DIRECTORY</literal></term>
	  <listitem>
	    <simpara>File is not a directory.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>gio.ERROR_NOT_EMPTY</literal></term>
	  <listitem>
	    <simpara>File is a directory that isn't empty.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>gio.ERROR_NOT_FOUND</literal></term>
	  <listitem>
	    <simpara>File not found error.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>gio.ERROR_NOT_MOUNTABLE_FILE</literal></term>
	  <listitem>
	    <simpara>File cannot be mounted.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>gio.ERROR_NOT_MOUNTED</literal></term>
	  <listitem>
	    <simpara>File isn't mounted. </simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>gio.ERROR_NOT_REGULAR_FILE</literal></term>
	  <listitem>
	    <simpara>File is not a regular file.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>gio.ERROR_NOT_SUPPORTED</literal></term>
	  <listitem>
	    <simpara>Operation not supported for the current backend.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>gio.ERROR_NOT_SYMBOLIC_LINK</literal></term>
	  <listitem>
	    <simpara>File is not a symbolic link.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>gio.ERROR_NO_SPACE</literal></term>
	  <listitem>
	    <simpara>No space left on drive. </simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>gio.ERROR_PENDING</literal></term>
	  <listitem>
	    <simpara>Operations are still pending.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>gio.ERROR_PERMISSION_DENIED</literal></term>
	  <listitem>
	    <simpara>Permission denied.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>gio.ERROR_READ_ONLY</literal></term>
	  <listitem>
	    <simpara>File is read only. </simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>gio.ERROR_TIMED_OUT</literal></term>
	  <listitem>
	    <simpara>Operation timed out. </simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>gio.ERROR_TOO_MANY_LINKS</literal></term>
	  <listitem>
	    <simpara>File contains too many symbolic links. </simpara>
	  </listitem>
	</varlistentry>
	<!--
	<varlistentry>
	  <term><literal>gio.ERROR_TOO_MANY_OPEN_FILES</literal></term>
	  <listitem>
	    <simpara>The current process has too many files open and can't open any
	    more. Duplicate descriptors do count toward this limit. Since 2.20</simpara>
	  </listitem>
	</varlistentry>
	-->
	<varlistentry>
	  <term><literal>gio.ERROR_WOULD_BLOCK</literal></term>
	  <listitem>
	    <simpara>Operation would block.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>gio.ERROR_WOULD_MERGE</literal></term>
	  <listitem>
	    <simpara>Operation would merge files.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>gio.ERROR_WOULD_RECURSE</literal></term>
	  <listitem>
	    <simpara>Operation would be recursive.</simpara>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><literal>gio.ERROR_WRONG_ETAG</literal></term>
	  <listitem>
	    <simpara>File's Entity Tag was incorrect. </simpara>
	  </listitem>
	</varlistentry>
      </variablelist>
    </refsect2>
  </refsect1>

</refentry>