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