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
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
|
<?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="gnomevfs-constants">
<refnamediv>
<refname>gnomevfs Constants</refname>
<refpurpose>the built-in constants of the gnomevfs module</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<programlisting>
<xref linkend="gnomevfs-constants-directory-visit" endterm="gnomevfs-constants-directory-visit-title"></xref>
<xref linkend="gnomevfs-constants-file-flags" endterm="gnomevfs-constants-file-flags-title"></xref>
<xref linkend="gnomevfs-constants-fileinfo-fields" endterm="gnomevfs-constants-fileinfo-fields-title"></xref>
<xref linkend="gnomevfs-constants-file-permissions" endterm="gnomevfs-constants-file-permissions-title"></xref>
<xref linkend="gnomevfs-constants-fileinfo-options" endterm="gnomevfs-constants-fileinfo-options-title"></xref>
<xref linkend="gnomevfs-constants-fileinfo-setmask" endterm="gnomevfs-constants-fileinfo-setmask-title"></xref>
<xref linkend="gnomevfs-constants-openmode" endterm="gnomevfs-constants-openmode-title"></xref>
<xref linkend="gnomevfs-constants-seekmode" endterm="gnomevfs-constants-seekmode-title"></xref>
<xref linkend="gnomevfs-constants-monitortype" endterm="gnomevfs-constants-monitortype-title"></xref>
</programlisting>
</refsect1>
<refsect1 id="gnomevfs-constants-description">
<title>Description</title>
<refsect2 id="gnomevfs-constants-directory-visit">
<title id="gnomevfs-constants-directory-visit-title">gnomevfs Directory Visit Options</title>
<para>These options control the way in which directories are visited.</para>
<variablelist>
<varlistentry>
<term><literal>gnomevfs.DIRECTORY_VISIT_DEFAULT</literal></term>
<listitem><simpara>The default directory visit mode.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>gnomevfs.DIRECTORY_VISIT_SAMEFS</literal></term>
<listitem><simpara>Visit only directories on the same file system as the parent.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>gnomevfs.DIRECTORY_VISIT_LOOPCHECK</literal></term>
<listitem><simpara>Prevent a loop if it would be caused (e.g. by following a symbolic link).</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id="gnomevfs-constants-file-flags">
<title id="gnomevfs-constants-file-flags-title">gnomevfs File Flags</title>
<para>Special flags that a <link linkend="class-gnomevfs-fileinfo">gnomevfs.FileInfo</link> object can have.</para>
<variablelist>
<varlistentry>
<term><literal>gnomevfs.FILE_FLAGS_NONE</literal></term>
<listitem><simpara>No flags.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>gnomevfs.FILE_FLAGS_SYMLINK</literal></term>
<listitem><simpara>Whether the file is a symbolic link.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>gnomevfs.FILE_FLAGS_LOCAL</literal></term>
<listitem><simpara>Whether the file is on a local filesystem.</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id="gnomevfs-constants-fileinfo-fields">
<title id="gnomevfs-constants-fileinfo-fields-title">gnomevfs FileInfo Fields</title>
<para>Flags indicating what fields in a <link linkend="class-gnomevfs-fileinfo">gnomevfs.FileInfo</link> object are valid.</para>
<variablelist>
<varlistentry>
<term><literal>gnomevfs.FILE_INFO_FIELDS_NONE</literal></term>
<listitem><simpara></simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>gnomevfs.FILE_INFO_FIELDS_TYPE</literal></term>
<listitem><simpara></simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>gnomevfs.FILE_INFO_FIELDS_PERMISSIONS</literal></term>
<listitem><simpara></simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>gnomevfs.FILE_INFO_FIELDS_FLAGS</literal></term>
<listitem><simpara></simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>gnomevfs.FILE_INFO_FIELDS_DEVICE</literal></term>
<listitem><simpara></simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>gnomevfs.FILE_INFO_FIELDS_INODE</literal></term>
<listitem><simpara></simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>gnomevfs.FILE_INFO_FIELDS_LINK_COUNT</literal></term>
<listitem><simpara></simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>gnomevfs.FILE_INFO_FIELDS_SIZE</literal></term>
<listitem><simpara></simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>gnomevfs.FILE_INFO_FIELDS_BLOCK_COUNT</literal></term>
<listitem><simpara></simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>gnomevfs.FILE_INFO_FIELDS_IO_BLOCK_SIZE</literal></term>
<listitem><simpara></simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>gnomevfs.FILE_INFO_FIELDS_ATIME</literal></term>
<listitem><simpara></simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>gnomevfs.FILE_INFO_FIELDS_MTIME</literal></term>
<listitem><simpara></simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>gnomevfs.FILE_INFO_FIELDS_CTIME</literal></term>
<listitem><simpara></simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>gnomevfs.FILE_INFO_FIELDS_SYMLINK_NAME</literal></term>
<listitem><simpara></simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>gnomevfs.FILE_INFO_FIELDS_MIME_TYPE</literal></term>
<listitem><simpara></simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id="gnomevfs-constants-file-permissions">
<title id="gnomevfs-constants-file-permissions-title">gnomevfs File Permissions</title>
<para>File permissions. These are essentially the same as the unix permissions field.</para>
<variablelist>
<varlistentry>
<term><literal>gnomevfs.PERM_SUID</literal></term>
<listitem><simpara>Set UID on access.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>gnomevfs.PERM_SGID</literal></term>
<listitem><simpara>Set GID on access.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>gnomevfs.PERM_STICKY</literal></term>
<listitem><simpara>Sticky.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>gnomevfs.PERM_USER_READ</literal></term>
<listitem><simpara>Owner has read permission.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>gnomevfs.PERM_USER_WRITE</literal></term>
<listitem><simpara>Owner has write permission.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>gnomevfs.PERM_USER_EXEC</literal></term>
<listitem><simpara>Owner has execution permission.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>gnomevfs.PERM_USER_ALL</literal></term>
<listitem><simpara>Owner has all permissions.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>gnomevfs.PERM_GROUP_READ</literal></term>
<listitem><simpara>Group has read permission.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>gnomevfs.PERM_GROUP_WRITE</literal></term>
<listitem><simpara>Group has write permission.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>gnomevfs.PERM_GROUP_EXEC</literal></term>
<listitem><simpara>Group has execution permission.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>gnomevfs.PERM_GROUP_ALL</literal></term>
<listitem><simpara>Group has all permissions.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>gnomevfs.PERM_OTHER_READ</literal></term>
<listitem><simpara>Others have read permission.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>gnomevfs.PERM_OTHER_WRITE</literal></term>
<listitem><simpara>Others have write permission.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>gnomevfs.PERM_OTHER_EXEC</literal></term>
<listitem><simpara>Others have execution permission.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>gnomevfs.PERM_OTHER_ALL</literal></term>
<listitem><simpara>Others have all permissions.</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id="gnomevfs-constants-fileinfo-options">
<title id="gnomevfs-constants-fileinfo-options-title">gnomevfs FileInfo Options</title>
<para>These options affect the way file information is retrieved.</para>
<variablelist>
<varlistentry>
<term><literal>gnomevfs.FILE_INFO_DEFAULT</literal></term>
<listitem><simpara></simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>gnomevfs.FILE_INFO_GET_MIME_TYPE</literal></term>
<listitem><simpara>Detect the MIME type.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>gnomevfs.FILE_INFO_FORCE_FAST_MIME_TYPE</literal></term>
<listitem><simpara>Only use fast MIME type detection (file extensions).</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>gnomevfs.FILE_INFO_FORCE_SLOW_MIME_TYPE</literal></term>
<listitem><simpara>Force slow MIME type detection where available (sniffing, algorithmic detection, etc).</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>gnomevfs.FILE_INFO_FOLLOW_LINKS</literal></term>
<listitem><simpara>Automatically follow symbolic links and retrieve the properties of their target (recommended).</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id="gnomevfs-constants-fileinfo-setmask">
<title id="gnomevfs-constants-fileinfo-setmask-title">gnomevfs FileInfo Set Mask</title>
<para>These options affect which file aspects are changed in the <link linkend="">set_file_info</link> method.</para>
<variablelist>
<varlistentry>
<term><literal>gnomevfs.SET_FILE_INFO_NONE</literal></term>
<listitem><simpara>Don't set any file info fields.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>gnomevfs.SET_FILE_INFO_NAME</literal></term>
<listitem><simpara>Change the name.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>gnomevfs.SET_FILE_INFO_PERMISSIONS</literal></term>
<listitem><simpara>Change the permissions.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>gnomevfs.SET_FILE_INFO_OWNER</literal></term>
<listitem><simpara>Change the file's owner.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>gnomevfs.SET_FILE_INFO_TIME</literal></term>
<listitem><simpara>Change the file's time stamp(s).</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id="gnomevfs-constants-openmode">
<title id="gnomevfs-constants-openmode-title">gnomevfs Open Mode Constants</title>
<para>These options affect how files are opened.</para>
<variablelist>
<varlistentry>
<term><literal>gnomevfs.OPEN_NONE</literal></term>
<listitem><simpara></simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>gnomevfs.OPEN_READ</literal></term>
<listitem><simpara>Open the file for reading.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>gnomevfs.OPEN_WRITE</literal></term>
<listitem><simpara>Open the file for writing.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>gnomevfs.OPEN_RANDOM</literal></term>
<listitem><simpara>Allow random access on the file.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>gnomevfs.OPEN_TRUNCATE</literal></term>
<listitem><simpara>Truncate the file.</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id="gnomevfs-constants-seekmode">
<title id="gnomevfs-constants-seekmode-title">gnomevfs Seek Constants</title>
<para>These constants are used to specify the start position for seek operations.</para>
<variablelist>
<varlistentry>
<term><literal>gnomevfs.SEEK_START</literal></term>
<listitem><simpara>The start of the file.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>gnomevfs.SEEK_CURRENT</literal></term>
<listitem><simpara>The current position in the file.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>gnomevfs.SEEK_END</literal></term>
<listitem><simpara>The end of the file.</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id="gnomevfs-constants-monitortype">
<title id="gnomevfs-constants-monitortype-title">gnomevfs Monitor Type Constants</title>
<para>The type of resources that can be monitored.</para>
<variablelist>
<varlistentry>
<term><literal>gnomevfs.MONITOR_FILE</literal></term>
<listitem><simpara>Monitor a file.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>gnomevfs.MONITOR_DIRECTORY</literal></term>
<listitem><simpara>Monitor a directory.</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id="gnomevfs-constants-monitorevents">
<title id="gnomevfs-constants-monitorevents-title">gnomevfs Monitor Events</title>
<para>Types of events that can be recieved from a monitor.</para>
<variablelist>
<varlistentry>
<term><literal>gnomevfs.MONITOR_EVENT_CHANGED</literal></term>
<listitem><simpara>File data was changed.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>gnomevfs.MONITOR_EVENT_DELETED</literal></term>
<listitem><simpara>File was deleted.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>gnomevfs.MONITOR_EVENT_STARTEXECUTING</literal></term>
<listitem><simpara></simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>gnomevfs.MONITOR_EVENT_STOPEXECUTING</literal></term>
<listitem><simpara></simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>gnomevfs.MONITOR_EVENT_CREATED</literal></term>
<listitem><simpara>File was created.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>gnomevfs.MONITOR_EVENT_METADATA_CHANGED</literal></term>
<listitem><simpara>File's metadata was changed.</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
</refentry>
|
