Add GZlibDecompressor for zlib decompression
[dana/cg-glib.git] / gio / gioenums.h
1 /* GIO - GLib Input, Output and Streaming Library
2  *
3  * Copyright (C) 2006-2007 Red Hat, Inc.
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General
16  * Public License along with this library; if not, write to the
17  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
18  * Boston, MA 02111-1307, USA.
19  *
20  * Author: Alexander Larsson <alexl@redhat.com>
21  */
22
23 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
24 #error "Only <gio/gio.h> can be included directly."
25 #endif
26
27 #ifndef __GIO_ENUMS_H__
28 #define __GIO_ENUMS_H__
29
30 #include <glib-object.h>
31
32 G_BEGIN_DECLS
33
34
35 /**
36  * GAppInfoCreateFlags:
37  * @G_APP_INFO_CREATE_NONE: No flags.
38  * @G_APP_INFO_CREATE_NEEDS_TERMINAL: Application opens in a terminal window.
39  * @G_APP_INFO_CREATE_SUPPORTS_URIS: Application supports URI arguments.
40  *
41  * Flags used when creating a #GAppInfo.
42  */
43 typedef enum {
44   G_APP_INFO_CREATE_NONE           = 0,         /*< nick=none >*/
45   G_APP_INFO_CREATE_NEEDS_TERMINAL = (1 << 0),  /*< nick=needs-terminal >*/
46   G_APP_INFO_CREATE_SUPPORTS_URIS  = (1 << 1)   /*< nick=supports-uris >*/
47 } GAppInfoCreateFlags;
48
49 /**
50  * GConverterFlags:
51  * @G_CONVERTER_NO_FLAGS: No flags.
52  * @G_CONVERTER_INPUT_AT_END: At end of input data
53  * @G_CONVERTER_FLUSH: Flush data
54  *
55  * Flags used when calling a g_converter_convert().
56  *
57  * Since: 2.24
58  */
59 typedef enum {
60   G_CONVERTER_NO_FLAGS     = 0,         /*< nick=none >*/
61   G_CONVERTER_INPUT_AT_END = (1 << 0),  /*< nick=input-at-end >*/
62   G_CONVERTER_FLUSH        = (1 << 1),  /*< nick=flush >*/
63 } GConverterFlags;
64
65 /**
66  * GConverterResult:
67  * @G_CONVERTER_ERROR: There was an error during conversion.
68  * @G_CONVERTER_CONVERTED: Some data was consumed or produced
69  * @G_CONVERTER_FINISHED: The conversion is finished
70  * @G_CONVERTER_FLUSHED: Flushing is finished
71  *
72  * Results returned from g_converter_convert().
73  *
74  * Since: 2.24
75  */
76 typedef enum {
77   G_CONVERTER_ERROR     = 0, /*< nick=error >*/
78   G_CONVERTER_CONVERTED = 1,  /*< nick=converted >*/
79   G_CONVERTER_FINISHED  = 2,  /*< nick=finished >*/
80   G_CONVERTER_FLUSHED   = 3,  /*< nick=flushed >*/
81 } GConverterResult;
82
83
84 /**
85  * GDataStreamByteOrder:
86  * @G_DATA_STREAM_BYTE_ORDER_BIG_ENDIAN: Selects Big Endian byte order.
87  * @G_DATA_STREAM_BYTE_ORDER_LITTLE_ENDIAN: Selects Little Endian byte order.
88  * @G_DATA_STREAM_BYTE_ORDER_HOST_ENDIAN: Selects endianness based on host machine's architecture.
89  *
90  * #GDataStreamByteOrder is used to ensure proper endianness of streaming data sources
91  * across various machine architectures.
92  *
93  **/
94 typedef enum {
95   G_DATA_STREAM_BYTE_ORDER_BIG_ENDIAN,
96   G_DATA_STREAM_BYTE_ORDER_LITTLE_ENDIAN,
97   G_DATA_STREAM_BYTE_ORDER_HOST_ENDIAN
98 } GDataStreamByteOrder;
99
100
101 /**
102  * GDataStreamNewlineType:
103  * @G_DATA_STREAM_NEWLINE_TYPE_LF: Selects "LF" line endings, common on most modern UNIX platforms.
104  * @G_DATA_STREAM_NEWLINE_TYPE_CR: Selects "CR" line endings.
105  * @G_DATA_STREAM_NEWLINE_TYPE_CR_LF: Selects "CR, LF" line ending, common on Microsoft Windows.
106  * @G_DATA_STREAM_NEWLINE_TYPE_ANY: Automatically try to handle any line ending type.
107  *
108  * #GDataStreamNewlineType is used when checking for or setting the line endings for a given file.
109  **/
110 typedef enum {
111   G_DATA_STREAM_NEWLINE_TYPE_LF,
112   G_DATA_STREAM_NEWLINE_TYPE_CR,
113   G_DATA_STREAM_NEWLINE_TYPE_CR_LF,
114   G_DATA_STREAM_NEWLINE_TYPE_ANY
115 } GDataStreamNewlineType;
116
117
118 /**
119  * GFileAttributeType:
120  * @G_FILE_ATTRIBUTE_TYPE_INVALID: indicates an invalid or uninitalized type.
121  * @G_FILE_ATTRIBUTE_TYPE_STRING: a null terminated UTF8 string.
122  * @G_FILE_ATTRIBUTE_TYPE_BYTE_STRING: a zero terminated string of non-zero bytes.
123  * @G_FILE_ATTRIBUTE_TYPE_BOOLEAN: a boolean value.
124  * @G_FILE_ATTRIBUTE_TYPE_UINT32: an unsigned 4-byte/32-bit integer.
125  * @G_FILE_ATTRIBUTE_TYPE_INT32: a signed 4-byte/32-bit integer.
126  * @G_FILE_ATTRIBUTE_TYPE_UINT64: an unsigned 8-byte/64-bit integer.
127  * @G_FILE_ATTRIBUTE_TYPE_INT64: a signed 8-byte/64-bit integer.
128  * @G_FILE_ATTRIBUTE_TYPE_OBJECT: a #GObject.
129  * @G_FILE_ATTRIBUTE_TYPE_STRINGV: a %NULL terminated char **. Since 2.22
130  *
131  * The data types for file attributes.
132  **/
133 typedef enum {
134   G_FILE_ATTRIBUTE_TYPE_INVALID = 0,
135   G_FILE_ATTRIBUTE_TYPE_STRING,
136   G_FILE_ATTRIBUTE_TYPE_BYTE_STRING, /* zero terminated string of non-zero bytes */
137   G_FILE_ATTRIBUTE_TYPE_BOOLEAN,
138   G_FILE_ATTRIBUTE_TYPE_UINT32,
139   G_FILE_ATTRIBUTE_TYPE_INT32,
140   G_FILE_ATTRIBUTE_TYPE_UINT64,
141   G_FILE_ATTRIBUTE_TYPE_INT64,
142   G_FILE_ATTRIBUTE_TYPE_OBJECT,
143   G_FILE_ATTRIBUTE_TYPE_STRINGV
144 } GFileAttributeType;
145
146
147 /**
148  * GFileAttributeInfoFlags:
149  * @G_FILE_ATTRIBUTE_INFO_NONE: no flags set.
150  * @G_FILE_ATTRIBUTE_INFO_COPY_WITH_FILE: copy the attribute values when the file is copied.
151  * @G_FILE_ATTRIBUTE_INFO_COPY_WHEN_MOVED: copy the attribute values when the file is moved.
152  *
153  * Flags specifying the behaviour of an attribute.
154  **/
155 typedef enum {
156   G_FILE_ATTRIBUTE_INFO_NONE            = 0,
157   G_FILE_ATTRIBUTE_INFO_COPY_WITH_FILE  = (1 << 0),
158   G_FILE_ATTRIBUTE_INFO_COPY_WHEN_MOVED = (1 << 1)
159 } GFileAttributeInfoFlags;
160
161
162 /**
163  * GFileAttributeStatus:
164  * @G_FILE_ATTRIBUTE_STATUS_UNSET: Attribute value is unset (empty).
165  * @G_FILE_ATTRIBUTE_STATUS_SET: Attribute value is set.
166  * @G_FILE_ATTRIBUTE_STATUS_ERROR_SETTING: Indicates an error in setting the value.
167  *
168  * Used by g_file_set_attributes_from_info() when setting file attributes.
169  **/
170 typedef enum {
171   G_FILE_ATTRIBUTE_STATUS_UNSET = 0,
172   G_FILE_ATTRIBUTE_STATUS_SET,
173   G_FILE_ATTRIBUTE_STATUS_ERROR_SETTING
174 } GFileAttributeStatus;
175
176
177 /**
178  * GFileQueryInfoFlags:
179  * @G_FILE_QUERY_INFO_NONE: No flags set.
180  * @G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS: Don't follow symlinks.
181  *
182  * Flags used when querying a #GFileInfo.
183  */
184 typedef enum {
185   G_FILE_QUERY_INFO_NONE              = 0,
186   G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS = (1 << 0)   /*< nick=nofollow-symlinks >*/
187 } GFileQueryInfoFlags;
188
189
190 /**
191  * GFileCreateFlags:
192  * @G_FILE_CREATE_NONE: No flags set.
193  * @G_FILE_CREATE_PRIVATE: Create a file that can only be
194  *    accessed by the current user.
195  * @G_FILE_CREATE_REPLACE_DESTINATION: Replace the destination
196  *    as if it didn't exist before. Don't try to keep any old
197  *    permissions, replace instead of following links. This
198  *    is generally useful if you're doing a "copy over" 
199  *    rather than a "save new version of" replace operation.
200  *    You can think of it as "unlink destination" before
201  *    writing to it, although the implementation may not
202  *    be exactly like that. Since 2.20
203  *
204  * Flags used when an operation may create a file.
205  */
206 typedef enum {
207   G_FILE_CREATE_NONE    = 0,
208   G_FILE_CREATE_PRIVATE = (1 << 0),
209   G_FILE_CREATE_REPLACE_DESTINATION = (1 << 1)
210 } GFileCreateFlags;
211
212
213 /**
214  * GMountMountFlags:
215  * @G_MOUNT_MOUNT_NONE: No flags set.
216  *
217  * Flags used when mounting a mount.
218  */
219 typedef enum {
220   G_MOUNT_MOUNT_NONE = 0
221 } GMountMountFlags;
222
223
224 /**
225  * GMountUnmountFlags:
226  * @G_MOUNT_UNMOUNT_NONE: No flags set.
227  * @G_MOUNT_UNMOUNT_FORCE: Unmount even if there are outstanding
228  *  file operations on the mount.
229  *
230  * Flags used when an unmounting a mount.
231  */
232 typedef enum {
233   G_MOUNT_UNMOUNT_NONE  = 0,
234   G_MOUNT_UNMOUNT_FORCE = (1 << 0)
235 } GMountUnmountFlags;
236
237 /**
238  * GDriveStartFlags:
239  * @G_DRIVE_START_NONE: No flags set.
240  *
241  * Flags used when starting a drive.
242  *
243  * Since: 2.22
244  */
245 typedef enum {
246   G_DRIVE_START_NONE = 0
247 } GDriveStartFlags;
248
249 /**
250  * GDriveStartStopType:
251  * @G_DRIVE_START_STOP_TYPE_UNKNOWN: Unknown or drive doesn't support
252  *    start/stop.
253  * @G_DRIVE_START_STOP_TYPE_SHUTDOWN: The stop method will physically
254  *    shut down the drive and e.g. power down the port the drive is
255  *    attached to.
256  * @G_DRIVE_START_STOP_TYPE_NETWORK: The start/stop methods are used
257  *    for connecting/disconnect to the drive over the network.
258  * @G_DRIVE_START_STOP_TYPE_MULTIDISK: The start/stop methods will
259  *    assemble/disassemble a virtual drive from several physical
260  *    drives.
261  * @G_DRIVE_START_STOP_TYPE_PASSWORD: The start/stop methods will
262  *    unlock/lock the disk (for example using the ATA <quote>SECURITY
263  *    UNLOCK DEVICE</quote> command)
264  *
265  * Enumeration describing how a drive can be started/stopped.
266  *
267  * Since: 2.22
268  */
269 typedef enum {
270   G_DRIVE_START_STOP_TYPE_UNKNOWN,
271   G_DRIVE_START_STOP_TYPE_SHUTDOWN,
272   G_DRIVE_START_STOP_TYPE_NETWORK,
273   G_DRIVE_START_STOP_TYPE_MULTIDISK,
274   G_DRIVE_START_STOP_TYPE_PASSWORD
275 } GDriveStartStopType;
276
277 /**
278  * GFileCopyFlags:
279  * @G_FILE_COPY_NONE: No flags set.
280  * @G_FILE_COPY_OVERWRITE: Overwrite any existing files
281  * @G_FILE_COPY_BACKUP: Make a backup of any existing files.
282  * @G_FILE_COPY_NOFOLLOW_SYMLINKS: Don't follow symlinks.
283  * @G_FILE_COPY_ALL_METADATA: Copy all file metadata instead of just default set used for copy (see #GFileInfo).
284  * @G_FILE_COPY_NO_FALLBACK_FOR_MOVE: Don't use copy and delete fallback if native move not supported.
285  * @G_FILE_COPY_TARGET_DEFAULT_PERMS: Leaves target file with default perms, instead of setting the source file perms.
286  *
287  * Flags used when copying or moving files.
288  */
289 typedef enum {
290   G_FILE_COPY_NONE                 = 0,          /*< nick=none >*/
291   G_FILE_COPY_OVERWRITE            = (1 << 0),
292   G_FILE_COPY_BACKUP               = (1 << 1),
293   G_FILE_COPY_NOFOLLOW_SYMLINKS    = (1 << 2),
294   G_FILE_COPY_ALL_METADATA         = (1 << 3),
295   G_FILE_COPY_NO_FALLBACK_FOR_MOVE = (1 << 4),
296   G_FILE_COPY_TARGET_DEFAULT_PERMS = (1 << 5)
297 } GFileCopyFlags;
298
299
300 /**
301  * GFileMonitorFlags:
302  * @G_FILE_MONITOR_NONE: No flags set.
303  * @G_FILE_MONITOR_WATCH_MOUNTS: Watch for mount events.
304  *
305  * Flags used to set what a #GFileMonitor will watch for.
306  */
307 typedef enum {
308   G_FILE_MONITOR_NONE         = 0,
309   G_FILE_MONITOR_WATCH_MOUNTS = (1 << 0)
310 } GFileMonitorFlags;
311
312
313 /**
314  * GFileType:
315  * @G_FILE_TYPE_UNKNOWN: File's type is unknown.
316  * @G_FILE_TYPE_REGULAR: File handle represents a regular file.
317  * @G_FILE_TYPE_DIRECTORY: File handle represents a directory.
318  * @G_FILE_TYPE_SYMBOLIC_LINK: File handle represents a symbolic link
319  *    (Unix systems).
320  * @G_FILE_TYPE_SPECIAL: File is a "special" file, such as a socket, fifo,
321  *    block device, or character device.
322  * @G_FILE_TYPE_SHORTCUT: File is a shortcut (Windows systems).
323  * @G_FILE_TYPE_MOUNTABLE: File is a mountable location.
324  *
325  * Indicates the file's on-disk type.
326  **/
327 typedef enum {
328   G_FILE_TYPE_UNKNOWN = 0,
329   G_FILE_TYPE_REGULAR,
330   G_FILE_TYPE_DIRECTORY,
331   G_FILE_TYPE_SYMBOLIC_LINK,
332   G_FILE_TYPE_SPECIAL, /* socket, fifo, blockdev, chardev */
333   G_FILE_TYPE_SHORTCUT,
334   G_FILE_TYPE_MOUNTABLE
335 } GFileType;
336
337
338 /**
339  * GFilesystemPreviewType:
340  * @G_FILESYSTEM_PREVIEW_TYPE_IF_ALWAYS: Only preview files if user has explicitly requested it.
341  * @G_FILESYSTEM_PREVIEW_TYPE_IF_LOCAL: Preview files if user has requested preview of "local" files.
342  * @G_FILESYSTEM_PREVIEW_TYPE_NEVER: Never preview files.
343  *
344  * Indicates a hint from the file system whether files should be
345  * previewed in a file manager. Returned as the value of the key
346  * #G_FILE_ATTRIBUTE_FILESYSTEM_USE_PREVIEW.
347  **/
348 typedef enum {
349   G_FILESYSTEM_PREVIEW_TYPE_IF_ALWAYS = 0,
350   G_FILESYSTEM_PREVIEW_TYPE_IF_LOCAL,
351   G_FILESYSTEM_PREVIEW_TYPE_NEVER
352 } GFilesystemPreviewType;
353
354
355 /**
356  * GFileMonitorEvent:
357  * @G_FILE_MONITOR_EVENT_CHANGED: a file changed.
358  * @G_FILE_MONITOR_EVENT_CHANGES_DONE_HINT: a hint that this was probably the last change in a set of changes.
359  * @G_FILE_MONITOR_EVENT_DELETED: a file was deleted.
360  * @G_FILE_MONITOR_EVENT_CREATED: a file was created.
361  * @G_FILE_MONITOR_EVENT_ATTRIBUTE_CHANGED: a file attribute was changed.
362  * @G_FILE_MONITOR_EVENT_PRE_UNMOUNT: the file location will soon be unmounted.
363  * @G_FILE_MONITOR_EVENT_UNMOUNTED: the file location was unmounted.
364  *
365  * Specifies what type of event a monitor event is.
366  **/
367 typedef enum {
368   G_FILE_MONITOR_EVENT_CHANGED,
369   G_FILE_MONITOR_EVENT_CHANGES_DONE_HINT,
370   G_FILE_MONITOR_EVENT_DELETED,
371   G_FILE_MONITOR_EVENT_CREATED,
372   G_FILE_MONITOR_EVENT_ATTRIBUTE_CHANGED,
373   G_FILE_MONITOR_EVENT_PRE_UNMOUNT,
374   G_FILE_MONITOR_EVENT_UNMOUNTED
375 } GFileMonitorEvent;
376
377
378 /* This enumeration conflicts with GIOError in giochannel.h. However,
379  * that is only used as a return value in some deprecated functions.
380  * So, we reuse the same prefix for the enumeration values, but call
381  * the actual enumeration (which is rarely used) GIOErrorEnum.
382  */
383 /**
384  * GIOErrorEnum:
385  * @G_IO_ERROR_FAILED: Generic error condition for when any operation fails.
386  * @G_IO_ERROR_NOT_FOUND: File not found error.
387  * @G_IO_ERROR_EXISTS: File already exists error.
388  * @G_IO_ERROR_IS_DIRECTORY: File is a directory error.
389  * @G_IO_ERROR_NOT_DIRECTORY: File is not a directory.
390  * @G_IO_ERROR_NOT_EMPTY: File is a directory that isn't empty.
391  * @G_IO_ERROR_NOT_REGULAR_FILE: File is not a regular file.
392  * @G_IO_ERROR_NOT_SYMBOLIC_LINK: File is not a symbolic link.
393  * @G_IO_ERROR_NOT_MOUNTABLE_FILE: File cannot be mounted.
394  * @G_IO_ERROR_FILENAME_TOO_LONG: Filename is too many characters.
395  * @G_IO_ERROR_INVALID_FILENAME: Filename is invalid or contains invalid characters.
396  * @G_IO_ERROR_TOO_MANY_LINKS: File contains too many symbolic links.
397  * @G_IO_ERROR_NO_SPACE: No space left on drive.
398  * @G_IO_ERROR_INVALID_ARGUMENT: Invalid argument.
399  * @G_IO_ERROR_PERMISSION_DENIED: Permission denied.
400  * @G_IO_ERROR_NOT_SUPPORTED: Operation not supported for the current backend.
401  * @G_IO_ERROR_NOT_MOUNTED: File isn't mounted.
402  * @G_IO_ERROR_ALREADY_MOUNTED: File is already mounted.
403  * @G_IO_ERROR_CLOSED: File was closed.
404  * @G_IO_ERROR_CANCELLED: Operation was cancelled. See #GCancellable.
405  * @G_IO_ERROR_PENDING: Operations are still pending.
406  * @G_IO_ERROR_READ_ONLY: File is read only.
407  * @G_IO_ERROR_CANT_CREATE_BACKUP: Backup couldn't be created.
408  * @G_IO_ERROR_WRONG_ETAG: File's Entity Tag was incorrect.
409  * @G_IO_ERROR_TIMED_OUT: Operation timed out.
410  * @G_IO_ERROR_WOULD_RECURSE: Operation would be recursive.
411  * @G_IO_ERROR_BUSY: File is busy.
412  * @G_IO_ERROR_WOULD_BLOCK: Operation would block.
413  * @G_IO_ERROR_HOST_NOT_FOUND: Host couldn't be found (remote operations).
414  * @G_IO_ERROR_WOULD_MERGE: Operation would merge files.
415  * @G_IO_ERROR_FAILED_HANDLED: Operation failed and a helper program has 
416  *     already interacted with the user. Do not display any error dialog.
417  * @G_IO_ERROR_TOO_MANY_OPEN_FILES: The current process has too many files 
418  *     open and can't open any more. Duplicate descriptors do count toward 
419  *     this limit. Since 2.20
420  * @G_IO_ERROR_NOT_INITIALIZED: The object has not been initialized. Since 2.22
421  * @G_IO_ERROR_ADDRESS_IN_USE: The requested address is already in use. Since 2.22
422  * @G_IO_ERROR_PARTIAL_INPUT: Need more input to finish operation. Since 2.24
423  * @G_IO_ERROR_INVALID_DATA: There input data was invalid. Since 2.24
424  *
425  * Error codes returned by GIO functions.
426  *
427  **/
428 typedef enum {
429   G_IO_ERROR_FAILED,
430   G_IO_ERROR_NOT_FOUND,
431   G_IO_ERROR_EXISTS,
432   G_IO_ERROR_IS_DIRECTORY,
433   G_IO_ERROR_NOT_DIRECTORY,
434   G_IO_ERROR_NOT_EMPTY,
435   G_IO_ERROR_NOT_REGULAR_FILE,
436   G_IO_ERROR_NOT_SYMBOLIC_LINK,
437   G_IO_ERROR_NOT_MOUNTABLE_FILE,
438   G_IO_ERROR_FILENAME_TOO_LONG,
439   G_IO_ERROR_INVALID_FILENAME,
440   G_IO_ERROR_TOO_MANY_LINKS,
441   G_IO_ERROR_NO_SPACE,
442   G_IO_ERROR_INVALID_ARGUMENT,
443   G_IO_ERROR_PERMISSION_DENIED,
444   G_IO_ERROR_NOT_SUPPORTED,
445   G_IO_ERROR_NOT_MOUNTED,
446   G_IO_ERROR_ALREADY_MOUNTED,
447   G_IO_ERROR_CLOSED,
448   G_IO_ERROR_CANCELLED,
449   G_IO_ERROR_PENDING,
450   G_IO_ERROR_READ_ONLY,
451   G_IO_ERROR_CANT_CREATE_BACKUP,
452   G_IO_ERROR_WRONG_ETAG,
453   G_IO_ERROR_TIMED_OUT,
454   G_IO_ERROR_WOULD_RECURSE,
455   G_IO_ERROR_BUSY,
456   G_IO_ERROR_WOULD_BLOCK,
457   G_IO_ERROR_HOST_NOT_FOUND,
458   G_IO_ERROR_WOULD_MERGE,
459   G_IO_ERROR_FAILED_HANDLED,
460   G_IO_ERROR_TOO_MANY_OPEN_FILES,
461   G_IO_ERROR_NOT_INITIALIZED,
462   G_IO_ERROR_ADDRESS_IN_USE,
463   G_IO_ERROR_PARTIAL_INPUT,
464   G_IO_ERROR_INVALID_DATA
465 } GIOErrorEnum;
466
467
468 /**
469  * GAskPasswordFlags:
470  * @G_ASK_PASSWORD_NEED_PASSWORD: operation requires a password.
471  * @G_ASK_PASSWORD_NEED_USERNAME: operation requires a username.
472  * @G_ASK_PASSWORD_NEED_DOMAIN: operation requires a domain.
473  * @G_ASK_PASSWORD_SAVING_SUPPORTED: operation supports saving settings.
474  * @G_ASK_PASSWORD_ANONYMOUS_SUPPORTED: operation supports anonymous users.
475  *
476  * #GAskPasswordFlags are used to request specific information from the
477  * user, or to notify the user of their choices in an authentication
478  * situation.
479  **/
480 typedef enum {
481   G_ASK_PASSWORD_NEED_PASSWORD       = (1 << 0),
482   G_ASK_PASSWORD_NEED_USERNAME       = (1 << 1),
483   G_ASK_PASSWORD_NEED_DOMAIN         = (1 << 2),
484   G_ASK_PASSWORD_SAVING_SUPPORTED    = (1 << 3),
485   G_ASK_PASSWORD_ANONYMOUS_SUPPORTED = (1 << 4)
486 } GAskPasswordFlags;
487
488
489 /**
490  * GPasswordSave:
491  * @G_PASSWORD_SAVE_NEVER: never save a password.
492  * @G_PASSWORD_SAVE_FOR_SESSION: save a password for the session.
493  * @G_PASSWORD_SAVE_PERMANENTLY: save a password permanently.
494  *
495  * #GPasswordSave is used to indicate the lifespan of a saved password.
496  *
497  * #Gvfs stores passwords in the Gnome keyring when this flag allows it
498  * to, and later retrieves it again from there.
499  **/
500 typedef enum {
501   G_PASSWORD_SAVE_NEVER,
502   G_PASSWORD_SAVE_FOR_SESSION,
503   G_PASSWORD_SAVE_PERMANENTLY
504 } GPasswordSave;
505
506
507 /**
508  * GMountOperationResult:
509  * @G_MOUNT_OPERATION_HANDLED: The request was fulfilled and the
510  *     user specified data is now available
511  * @G_MOUNT_OPERATION_ABORTED: The user requested the mount operation
512  *     to be aborted
513  * @G_MOUNT_OPERATION_UNHANDLED: The request was unhandled (i.e. not
514  *     implemented)
515  *
516  * #GMountOperationResult is returned as a result when a request for
517  * information is send by the mounting operation.
518  **/
519 typedef enum {
520   G_MOUNT_OPERATION_HANDLED,
521   G_MOUNT_OPERATION_ABORTED,
522   G_MOUNT_OPERATION_UNHANDLED
523 } GMountOperationResult;
524
525
526 /**
527  * GOutputStreamSpliceFlags:
528  * @G_OUTPUT_STREAM_SPLICE_NONE: Do not close either stream.
529  * @G_OUTPUT_STREAM_SPLICE_CLOSE_SOURCE: Close the source stream after
530  *     the splice.
531  * @G_OUTPUT_STREAM_SPLICE_CLOSE_TARGET: Close the target stream after
532  *     the splice.
533  *
534  * GOutputStreamSpliceFlags determine how streams should be spliced.
535  **/
536 typedef enum {
537   G_OUTPUT_STREAM_SPLICE_NONE         = 0,
538   G_OUTPUT_STREAM_SPLICE_CLOSE_SOURCE = (1 << 0),
539   G_OUTPUT_STREAM_SPLICE_CLOSE_TARGET = (1 << 1)
540 } GOutputStreamSpliceFlags;
541
542
543 /**
544  * GEmblemOrigin:
545  * @G_EMBLEM_ORIGIN_UNKNOWN: Emblem of unknown origin
546  * @G_EMBLEM_ORIGIN_DEVICE: Emblem adds device-specific information
547  * @G_EMBLEM_ORIGIN_LIVEMETADATA: Emblem depicts live metadata, such as "readonly"
548  * @G_EMBLEM_ORIGIN_TAG: Emblem comes from a user-defined tag, e.g. set by nautilus (in the future)
549  *
550  * GEmblemOrigin is used to add information about the origin of the emblem
551  * to #GEmblem.
552  *
553  * Since: 2.18
554  */
555 typedef enum  {
556   G_EMBLEM_ORIGIN_UNKNOWN,
557   G_EMBLEM_ORIGIN_DEVICE,
558   G_EMBLEM_ORIGIN_LIVEMETADATA,
559   G_EMBLEM_ORIGIN_TAG
560 } GEmblemOrigin;
561
562 /**
563  * GResolverError:
564  * @G_RESOLVER_ERROR_NOT_FOUND: the requested name/address/service was not
565  *     found
566  * @G_RESOLVER_ERROR_TEMPORARY_FAILURE: the requested information could not
567  *     be looked up due to a network error or similar problem
568  * @G_RESOLVER_ERROR_INTERNAL: unknown error
569  *
570  * An error code used with %G_RESOLVER_ERROR in a #GError returned
571  * from a #GResolver routine.
572  *
573  * Since: 2.22
574  */
575 typedef enum {
576   G_RESOLVER_ERROR_NOT_FOUND,
577   G_RESOLVER_ERROR_TEMPORARY_FAILURE,
578   G_RESOLVER_ERROR_INTERNAL
579 } GResolverError;
580
581 /**
582  * GSocketFamily:
583  * @G_SOCKET_FAMILY_INVALID: no address family
584  * @G_SOCKET_FAMILY_IPV4: the IPv4 family
585  * @G_SOCKET_FAMILY_IPV6: the IPv6 family
586  * @G_SOCKET_FAMILY_UNIX: the UNIX domain family
587  *
588  * The protocol family of a #GSocketAddress. (These values are
589  * identical to the system defines %AF_INET, %AF_INET6 and %AF_UNIX,
590  * if available.)
591  *
592  * Since: 2.22
593  */
594 typedef enum {
595   G_SOCKET_FAMILY_INVALID,
596 #ifdef GLIB_SYSDEF_AF_UNIX
597   G_SOCKET_FAMILY_UNIX = GLIB_SYSDEF_AF_UNIX,
598 #endif
599   G_SOCKET_FAMILY_IPV4 = GLIB_SYSDEF_AF_INET,
600   G_SOCKET_FAMILY_IPV6 = GLIB_SYSDEF_AF_INET6
601 } GSocketFamily;
602
603 /**
604  * GSocketType:
605  * @G_SOCKET_TYPE_INVALID: Type unknown or wrong
606  * @G_SOCKET_TYPE_STREAM: Reliable connection-based byte streams (e.g. TCP).
607  * @G_SOCKET_TYPE_DATAGRAM: Connectionless, unreliable datagram passing.
608  *     (e.g. UDP)
609  * @G_SOCKET_TYPE_SEQPACKET: Reliable connection-based passing of datagrams
610  *     of fixed maximum length (e.g. SCTP).
611  *
612  * Flags used when creating a #GSocket. Some protocols may not implement
613  * all the socket types.
614  *
615  * Since: 2.22
616  */
617 typedef enum
618 {
619   G_SOCKET_TYPE_INVALID,
620   G_SOCKET_TYPE_STREAM,
621   G_SOCKET_TYPE_DATAGRAM,
622   G_SOCKET_TYPE_SEQPACKET
623 } GSocketType;
624
625 /**
626  * GSocketMsgFlags:
627  * @G_SOCKET_MSG_NONE: No flags.
628  * @G_SOCKET_MSG_OOB: Request to send/receive out of band data.
629  * @G_SOCKET_MSG_PEEK: Read data from the socket without removing it from
630  *     the queue.
631  * @G_SOCKET_MSG_DONTROUTE: Don't use a gateway to send out the packet,
632  *     only send to hosts on directly connected networks.
633  *
634  * Flags used in g_socket_receive_message() and g_socket_send_message().
635  * The flags listed in the enum are some commonly available flags, but the
636  * values used for them are the same as on the platform, and any other flags
637  * are passed in/out as is. So to use a platform specific flag, just include
638  * the right system header and pass in the flag.
639  *
640  * Since: 2.22
641  */
642 typedef enum
643 {
644   G_SOCKET_MSG_NONE,
645   G_SOCKET_MSG_OOB = GLIB_SYSDEF_MSG_OOB,
646   G_SOCKET_MSG_PEEK = GLIB_SYSDEF_MSG_PEEK,
647   G_SOCKET_MSG_DONTROUTE = GLIB_SYSDEF_MSG_DONTROUTE
648 } GSocketMsgFlags;
649
650 /**
651  * GSocketProtocol:
652  * @G_SOCKET_PROTOCOL_UNKNOWN: The protocol type is unknown
653  * @G_SOCKET_PROTOCOL_DEFAULT: The default protocol for the family/type
654  * @G_SOCKET_PROTOCOL_TCP: TCP over IP
655  * @G_SOCKET_PROTOCOL_UDP: UDP over IP
656  * @G_SOCKET_PROTOCOL_SCTP: SCTP over IP
657  *
658  * A protocol identifier is specified when creating a #GSocket, which is a
659  * family/type specific identifier, where 0 means the default protocol for
660  * the particular family/type.
661  *
662  * This enum contains a set of commonly available and used protocols. You
663  * can also pass any other identifiers handled by the platform in order to
664  * use protocols not listed here.
665  *
666  * Since: 2.22
667  */
668 typedef enum {
669   G_SOCKET_PROTOCOL_UNKNOWN = -1,
670   G_SOCKET_PROTOCOL_DEFAULT = 0,
671   G_SOCKET_PROTOCOL_TCP     = 6,
672   G_SOCKET_PROTOCOL_UDP     = 17,
673   G_SOCKET_PROTOCOL_SCTP    = 132
674 } GSocketProtocol;
675
676 /**
677  * GZlibCompressorFormat:
678  * @G_ZLIB_COMRESSOR_FORMAT_RAW: Raw zlib compression data
679  * @G_ZLIB_COMRESSOR_FORMAT_GZIP: gzip file format
680  *
681  * Used to select the type of data format to use for #GZlibDecompressor
682  * and #GZlibCompressor.
683  *
684  * Since: 2.24
685  */
686 typedef enum {
687   G_ZLIB_COMPRESSOR_FORMAT_RAW,
688   G_ZLIB_COMPRESSOR_FORMAT_GZIP
689 } GZlibCompressorFormat;
690
691 G_END_DECLS
692
693 #endif /* __GIO_ENUMS_H__ */