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  * @G_FILE_MONITOR_SEND_MOVED: Pair DELETED and CREATED events caused
 305  *   by file renames (moves) and send a single G_FILE_MONITOR_EVENT_MOVED
 306  *   event instead (NB: not supported on all backends; the default
 307  *   behaviour -without specifying this flag- is to send single DELETED
 308  *   and CREATED events).
 309  *
 310  * Flags used to set what a #GFileMonitor will watch for.
 311  */
 312 typedef enum {
 313   G_FILE_MONITOR_NONE         = 0,
 314   G_FILE_MONITOR_WATCH_MOUNTS = (1 << 0),
 315   G_FILE_MONITOR_SEND_MOVED   = (1 << 1)
 316 } GFileMonitorFlags;
 317
 318
 319 /**
 320  * GFileType:
 321  * @G_FILE_TYPE_UNKNOWN: File's type is unknown.
 322  * @G_FILE_TYPE_REGULAR: File handle represents a regular file.
 323  * @G_FILE_TYPE_DIRECTORY: File handle represents a directory.
 324  * @G_FILE_TYPE_SYMBOLIC_LINK: File handle represents a symbolic link
 325  *    (Unix systems).
 326  * @G_FILE_TYPE_SPECIAL: File is a "special" file, such as a socket, fifo,
 327  *    block device, or character device.
 328  * @G_FILE_TYPE_SHORTCUT: File is a shortcut (Windows systems).
 329  * @G_FILE_TYPE_MOUNTABLE: File is a mountable location.
 330  *
 331  * Indicates the file's on-disk type.
 332  **/
 333 typedef enum {
 334   G_FILE_TYPE_UNKNOWN = 0,
 335   G_FILE_TYPE_REGULAR,
 336   G_FILE_TYPE_DIRECTORY,
 337   G_FILE_TYPE_SYMBOLIC_LINK,
 338   G_FILE_TYPE_SPECIAL, /* socket, fifo, blockdev, chardev */
 339   G_FILE_TYPE_SHORTCUT,
 340   G_FILE_TYPE_MOUNTABLE
 341 } GFileType;
 342
 343
 344 /**
 345  * GFilesystemPreviewType:
 346  * @G_FILESYSTEM_PREVIEW_TYPE_IF_ALWAYS: Only preview files if user has explicitly requested it.
 347  * @G_FILESYSTEM_PREVIEW_TYPE_IF_LOCAL: Preview files if user has requested preview of "local" files.
 348  * @G_FILESYSTEM_PREVIEW_TYPE_NEVER: Never preview files.
 349  *
 350  * Indicates a hint from the file system whether files should be
 351  * previewed in a file manager. Returned as the value of the key
 352  * #G_FILE_ATTRIBUTE_FILESYSTEM_USE_PREVIEW.
 353  **/
 354 typedef enum {
 355   G_FILESYSTEM_PREVIEW_TYPE_IF_ALWAYS = 0,
 356   G_FILESYSTEM_PREVIEW_TYPE_IF_LOCAL,
 357   G_FILESYSTEM_PREVIEW_TYPE_NEVER
 358 } GFilesystemPreviewType;
 359
 360
 361 /**
 362  * GFileMonitorEvent:
 363  * @G_FILE_MONITOR_EVENT_CHANGED: a file changed.
 364  * @G_FILE_MONITOR_EVENT_CHANGES_DONE_HINT: a hint that this was probably the last change in a set of changes.
 365  * @G_FILE_MONITOR_EVENT_DELETED: a file was deleted.
 366  * @G_FILE_MONITOR_EVENT_CREATED: a file was created.
 367  * @G_FILE_MONITOR_EVENT_ATTRIBUTE_CHANGED: a file attribute was changed.
 368  * @G_FILE_MONITOR_EVENT_PRE_UNMOUNT: the file location will soon be unmounted.
 369  * @G_FILE_MONITOR_EVENT_UNMOUNTED: the file location was unmounted.
 370  * @G_FILE_MONITOR_EVENT_MOVED: the file was moved.
 371  *
 372  * Specifies what type of event a monitor event is.
 373  **/
 374 typedef enum {
 375   G_FILE_MONITOR_EVENT_CHANGED,
 376   G_FILE_MONITOR_EVENT_CHANGES_DONE_HINT,
 377   G_FILE_MONITOR_EVENT_DELETED,
 378   G_FILE_MONITOR_EVENT_CREATED,
 379   G_FILE_MONITOR_EVENT_ATTRIBUTE_CHANGED,
 380   G_FILE_MONITOR_EVENT_PRE_UNMOUNT,
 381   G_FILE_MONITOR_EVENT_UNMOUNTED,
 382   G_FILE_MONITOR_EVENT_MOVED
 383 } GFileMonitorEvent;
 384
 385
 386 /* This enumeration conflicts with GIOError in giochannel.h. However,
 387  * that is only used as a return value in some deprecated functions.
 388  * So, we reuse the same prefix for the enumeration values, but call
 389  * the actual enumeration (which is rarely used) GIOErrorEnum.
 390  */
 391 /**
 392  * GIOErrorEnum:
 393  * @G_IO_ERROR_FAILED: Generic error condition for when any operation fails.
 394  * @G_IO_ERROR_NOT_FOUND: File not found error.
 395  * @G_IO_ERROR_EXISTS: File already exists error.
 396  * @G_IO_ERROR_IS_DIRECTORY: File is a directory error.
 397  * @G_IO_ERROR_NOT_DIRECTORY: File is not a directory.
 398  * @G_IO_ERROR_NOT_EMPTY: File is a directory that isn't empty.
 399  * @G_IO_ERROR_NOT_REGULAR_FILE: File is not a regular file.
 400  * @G_IO_ERROR_NOT_SYMBOLIC_LINK: File is not a symbolic link.
 401  * @G_IO_ERROR_NOT_MOUNTABLE_FILE: File cannot be mounted.
 402  * @G_IO_ERROR_FILENAME_TOO_LONG: Filename is too many characters.
 403  * @G_IO_ERROR_INVALID_FILENAME: Filename is invalid or contains invalid characters.
 404  * @G_IO_ERROR_TOO_MANY_LINKS: File contains too many symbolic links.
 405  * @G_IO_ERROR_NO_SPACE: No space left on drive.
 406  * @G_IO_ERROR_INVALID_ARGUMENT: Invalid argument.
 407  * @G_IO_ERROR_PERMISSION_DENIED: Permission denied.
 408  * @G_IO_ERROR_NOT_SUPPORTED: Operation not supported for the current backend.
 409  * @G_IO_ERROR_NOT_MOUNTED: File isn't mounted.
 410  * @G_IO_ERROR_ALREADY_MOUNTED: File is already mounted.
 411  * @G_IO_ERROR_CLOSED: File was closed.
 412  * @G_IO_ERROR_CANCELLED: Operation was cancelled. See #GCancellable.
 413  * @G_IO_ERROR_PENDING: Operations are still pending.
 414  * @G_IO_ERROR_READ_ONLY: File is read only.
 415  * @G_IO_ERROR_CANT_CREATE_BACKUP: Backup couldn't be created.
 416  * @G_IO_ERROR_WRONG_ETAG: File's Entity Tag was incorrect.
 417  * @G_IO_ERROR_TIMED_OUT: Operation timed out.
 418  * @G_IO_ERROR_WOULD_RECURSE: Operation would be recursive.
 419  * @G_IO_ERROR_BUSY: File is busy.
 420  * @G_IO_ERROR_WOULD_BLOCK: Operation would block.
 421  * @G_IO_ERROR_HOST_NOT_FOUND: Host couldn't be found (remote operations).
 422  * @G_IO_ERROR_WOULD_MERGE: Operation would merge files.
 423  * @G_IO_ERROR_FAILED_HANDLED: Operation failed and a helper program has
 424  *     already interacted with the user. Do not display any error dialog.
 425  * @G_IO_ERROR_TOO_MANY_OPEN_FILES: The current process has too many files
 426  *     open and can't open any more. Duplicate descriptors do count toward
 427  *     this limit. Since 2.20
 428  * @G_IO_ERROR_NOT_INITIALIZED: The object has not been initialized. Since 2.22
 429  * @G_IO_ERROR_ADDRESS_IN_USE: The requested address is already in use. Since 2.22
 430  * @G_IO_ERROR_PARTIAL_INPUT: Need more input to finish operation. Since 2.24
 431  * @G_IO_ERROR_INVALID_DATA: There input data was invalid. Since 2.24
 432  *
 433  * Error codes returned by GIO functions.
 434  *
 435  **/
 436 typedef enum {
 437   G_IO_ERROR_FAILED,
 438   G_IO_ERROR_NOT_FOUND,
 439   G_IO_ERROR_EXISTS,
 440   G_IO_ERROR_IS_DIRECTORY,
 441   G_IO_ERROR_NOT_DIRECTORY,
 442   G_IO_ERROR_NOT_EMPTY,
 443   G_IO_ERROR_NOT_REGULAR_FILE,
 444   G_IO_ERROR_NOT_SYMBOLIC_LINK,
 445   G_IO_ERROR_NOT_MOUNTABLE_FILE,
 446   G_IO_ERROR_FILENAME_TOO_LONG,
 447   G_IO_ERROR_INVALID_FILENAME,
 448   G_IO_ERROR_TOO_MANY_LINKS,
 449   G_IO_ERROR_NO_SPACE,
 450   G_IO_ERROR_INVALID_ARGUMENT,
 451   G_IO_ERROR_PERMISSION_DENIED,
 452   G_IO_ERROR_NOT_SUPPORTED,
 453   G_IO_ERROR_NOT_MOUNTED,
 454   G_IO_ERROR_ALREADY_MOUNTED,
 455   G_IO_ERROR_CLOSED,
 456   G_IO_ERROR_CANCELLED,
 457   G_IO_ERROR_PENDING,
 458   G_IO_ERROR_READ_ONLY,
 459   G_IO_ERROR_CANT_CREATE_BACKUP,
 460   G_IO_ERROR_WRONG_ETAG,
 461   G_IO_ERROR_TIMED_OUT,
 462   G_IO_ERROR_WOULD_RECURSE,
 463   G_IO_ERROR_BUSY,
 464   G_IO_ERROR_WOULD_BLOCK,
 465   G_IO_ERROR_HOST_NOT_FOUND,
 466   G_IO_ERROR_WOULD_MERGE,
 467   G_IO_ERROR_FAILED_HANDLED,
 468   G_IO_ERROR_TOO_MANY_OPEN_FILES,
 469   G_IO_ERROR_NOT_INITIALIZED,
 470   G_IO_ERROR_ADDRESS_IN_USE,
 471   G_IO_ERROR_PARTIAL_INPUT,
 472   G_IO_ERROR_INVALID_DATA
 473 } GIOErrorEnum;
 474
 475
 476 /**
 477  * GAskPasswordFlags:
 478  * @G_ASK_PASSWORD_NEED_PASSWORD: operation requires a password.
 479  * @G_ASK_PASSWORD_NEED_USERNAME: operation requires a username.
 480  * @G_ASK_PASSWORD_NEED_DOMAIN: operation requires a domain.
 481  * @G_ASK_PASSWORD_SAVING_SUPPORTED: operation supports saving settings.
 482  * @G_ASK_PASSWORD_ANONYMOUS_SUPPORTED: operation supports anonymous users.
 483  *
 484  * #GAskPasswordFlags are used to request specific information from the
 485  * user, or to notify the user of their choices in an authentication
 486  * situation.
 487  **/
 488 typedef enum {
 489   G_ASK_PASSWORD_NEED_PASSWORD       = (1 << 0),
 490   G_ASK_PASSWORD_NEED_USERNAME       = (1 << 1),
 491   G_ASK_PASSWORD_NEED_DOMAIN         = (1 << 2),
 492   G_ASK_PASSWORD_SAVING_SUPPORTED    = (1 << 3),
 493   G_ASK_PASSWORD_ANONYMOUS_SUPPORTED = (1 << 4)
 494 } GAskPasswordFlags;
 495
 496
 497 /**
 498  * GPasswordSave:
 499  * @G_PASSWORD_SAVE_NEVER: never save a password.
 500  * @G_PASSWORD_SAVE_FOR_SESSION: save a password for the session.
 501  * @G_PASSWORD_SAVE_PERMANENTLY: save a password permanently.
 502  *
 503  * #GPasswordSave is used to indicate the lifespan of a saved password.
 504  *
 505  * #Gvfs stores passwords in the Gnome keyring when this flag allows it
 506  * to, and later retrieves it again from there.
 507  **/
 508 typedef enum {
 509   G_PASSWORD_SAVE_NEVER,
 510   G_PASSWORD_SAVE_FOR_SESSION,
 511   G_PASSWORD_SAVE_PERMANENTLY
 512 } GPasswordSave;
 513
 514
 515 /**
 516  * GMountOperationResult:
 517  * @G_MOUNT_OPERATION_HANDLED: The request was fulfilled and the
 518  *     user specified data is now available
 519  * @G_MOUNT_OPERATION_ABORTED: The user requested the mount operation
 520  *     to be aborted
 521  * @G_MOUNT_OPERATION_UNHANDLED: The request was unhandled (i.e. not
 522  *     implemented)
 523  *
 524  * #GMountOperationResult is returned as a result when a request for
 525  * information is send by the mounting operation.
 526  **/
 527 typedef enum {
 528   G_MOUNT_OPERATION_HANDLED,
 529   G_MOUNT_OPERATION_ABORTED,
 530   G_MOUNT_OPERATION_UNHANDLED
 531 } GMountOperationResult;
 532
 533
 534 /**
 535  * GOutputStreamSpliceFlags:
 536  * @G_OUTPUT_STREAM_SPLICE_NONE: Do not close either stream.
 537  * @G_OUTPUT_STREAM_SPLICE_CLOSE_SOURCE: Close the source stream after
 538  *     the splice.
 539  * @G_OUTPUT_STREAM_SPLICE_CLOSE_TARGET: Close the target stream after
 540  *     the splice.
 541  *
 542  * GOutputStreamSpliceFlags determine how streams should be spliced.
 543  **/
 544 typedef enum {
 545   G_OUTPUT_STREAM_SPLICE_NONE         = 0,
 546   G_OUTPUT_STREAM_SPLICE_CLOSE_SOURCE = (1 << 0),
 547   G_OUTPUT_STREAM_SPLICE_CLOSE_TARGET = (1 << 1)
 548 } GOutputStreamSpliceFlags;
 549
 550
 551 /**
 552  * GEmblemOrigin:
 553  * @G_EMBLEM_ORIGIN_UNKNOWN: Emblem of unknown origin
 554  * @G_EMBLEM_ORIGIN_DEVICE: Emblem adds device-specific information
 555  * @G_EMBLEM_ORIGIN_LIVEMETADATA: Emblem depicts live metadata, such as "readonly"
 556  * @G_EMBLEM_ORIGIN_TAG: Emblem comes from a user-defined tag, e.g. set by nautilus (in the future)
 557  *
 558  * GEmblemOrigin is used to add information about the origin of the emblem
 559  * to #GEmblem.
 560  *
 561  * Since: 2.18
 562  */
 563 typedef enum  {
 564   G_EMBLEM_ORIGIN_UNKNOWN,
 565   G_EMBLEM_ORIGIN_DEVICE,
 566   G_EMBLEM_ORIGIN_LIVEMETADATA,
 567   G_EMBLEM_ORIGIN_TAG
 568 } GEmblemOrigin;
 569
 570 /**
 571  * GResolverError:
 572  * @G_RESOLVER_ERROR_NOT_FOUND: the requested name/address/service was not
 573  *     found
 574  * @G_RESOLVER_ERROR_TEMPORARY_FAILURE: the requested information could not
 575  *     be looked up due to a network error or similar problem
 576  * @G_RESOLVER_ERROR_INTERNAL: unknown error
 577  *
 578  * An error code used with %G_RESOLVER_ERROR in a #GError returned
 579  * from a #GResolver routine.
 580  *
 581  * Since: 2.22
 582  */
 583 typedef enum {
 584   G_RESOLVER_ERROR_NOT_FOUND,
 585   G_RESOLVER_ERROR_TEMPORARY_FAILURE,
 586   G_RESOLVER_ERROR_INTERNAL
 587 } GResolverError;
 588
 589 /**
 590  * GSocketFamily:
 591  * @G_SOCKET_FAMILY_INVALID: no address family
 592  * @G_SOCKET_FAMILY_IPV4: the IPv4 family
 593  * @G_SOCKET_FAMILY_IPV6: the IPv6 family
 594  * @G_SOCKET_FAMILY_UNIX: the UNIX domain family
 595  *
 596  * The protocol family of a #GSocketAddress. (These values are
 597  * identical to the system defines %AF_INET, %AF_INET6 and %AF_UNIX,
 598  * if available.)
 599  *
 600  * Since: 2.22
 601  */
 602 typedef enum {
 603   G_SOCKET_FAMILY_INVALID,
 604 #ifdef GLIB_SYSDEF_AF_UNIX
 605   G_SOCKET_FAMILY_UNIX = GLIB_SYSDEF_AF_UNIX,
 606 #endif
 607   G_SOCKET_FAMILY_IPV4 = GLIB_SYSDEF_AF_INET,
 608   G_SOCKET_FAMILY_IPV6 = GLIB_SYSDEF_AF_INET6
 609 } GSocketFamily;
 610
 611 /**
 612  * GSocketType:
 613  * @G_SOCKET_TYPE_INVALID: Type unknown or wrong
 614  * @G_SOCKET_TYPE_STREAM: Reliable connection-based byte streams (e.g. TCP).
 615  * @G_SOCKET_TYPE_DATAGRAM: Connectionless, unreliable datagram passing.
 616  *     (e.g. UDP)
 617  * @G_SOCKET_TYPE_SEQPACKET: Reliable connection-based passing of datagrams
 618  *     of fixed maximum length (e.g. SCTP).
 619  *
 620  * Flags used when creating a #GSocket. Some protocols may not implement
 621  * all the socket types.
 622  *
 623  * Since: 2.22
 624  */
 625 typedef enum
 626 {
 627   G_SOCKET_TYPE_INVALID,
 628   G_SOCKET_TYPE_STREAM,
 629   G_SOCKET_TYPE_DATAGRAM,
 630   G_SOCKET_TYPE_SEQPACKET
 631 } GSocketType;
 632
 633 /**
 634  * GSocketMsgFlags:
 635  * @G_SOCKET_MSG_NONE: No flags.
 636  * @G_SOCKET_MSG_OOB: Request to send/receive out of band data.
 637  * @G_SOCKET_MSG_PEEK: Read data from the socket without removing it from
 638  *     the queue.
 639  * @G_SOCKET_MSG_DONTROUTE: Don't use a gateway to send out the packet,
 640  *     only send to hosts on directly connected networks.
 641  *
 642  * Flags used in g_socket_receive_message() and g_socket_send_message().
 643  * The flags listed in the enum are some commonly available flags, but the
 644  * values used for them are the same as on the platform, and any other flags
 645  * are passed in/out as is. So to use a platform specific flag, just include
 646  * the right system header and pass in the flag.
 647  *
 648  * Since: 2.22
 649  */
 650 typedef enum
 651 {
 652   G_SOCKET_MSG_NONE,
 653   G_SOCKET_MSG_OOB = GLIB_SYSDEF_MSG_OOB,
 654   G_SOCKET_MSG_PEEK = GLIB_SYSDEF_MSG_PEEK,
 655   G_SOCKET_MSG_DONTROUTE = GLIB_SYSDEF_MSG_DONTROUTE
 656 } GSocketMsgFlags;
 657
 658 /**
 659  * GSocketProtocol:
 660  * @G_SOCKET_PROTOCOL_UNKNOWN: The protocol type is unknown
 661  * @G_SOCKET_PROTOCOL_DEFAULT: The default protocol for the family/type
 662  * @G_SOCKET_PROTOCOL_TCP: TCP over IP
 663  * @G_SOCKET_PROTOCOL_UDP: UDP over IP
 664  * @G_SOCKET_PROTOCOL_SCTP: SCTP over IP
 665  *
 666  * A protocol identifier is specified when creating a #GSocket, which is a
 667  * family/type specific identifier, where 0 means the default protocol for
 668  * the particular family/type.
 669  *
 670  * This enum contains a set of commonly available and used protocols. You
 671  * can also pass any other identifiers handled by the platform in order to
 672  * use protocols not listed here.
 673  *
 674  * Since: 2.22
 675  */
 676 typedef enum {
 677   G_SOCKET_PROTOCOL_UNKNOWN = -1,
 678   G_SOCKET_PROTOCOL_DEFAULT = 0,
 679   G_SOCKET_PROTOCOL_TCP     = 6,
 680   G_SOCKET_PROTOCOL_UDP     = 17,
 681   G_SOCKET_PROTOCOL_SCTP    = 132
 682 } GSocketProtocol;
 683
 684 /**
 685  * GZlibCompressorFormat:
 686  * @G_ZLIB_COMPRESSOR_FORMAT_ZLIB: deflate compression with zlib header
 687  * @G_ZLIB_COMPRESSOR_FORMAT_GZIP: gzip file format
 688  * @G_ZLIB_COMPRESSOR_FORMAT_RAW: deflate compression with no header
 689  *
 690  * Used to select the type of data format to use for #GZlibDecompressor
 691  * and #GZlibCompressor.
 692  *
 693  * Since: 2.24
 694  */
 695 typedef enum {
 696   G_ZLIB_COMPRESSOR_FORMAT_ZLIB,
 697   G_ZLIB_COMPRESSOR_FORMAT_GZIP,
 698   G_ZLIB_COMPRESSOR_FORMAT_RAW
 699 } GZlibCompressorFormat;
 700
 701 /**
 702  * GUnixSocketAddressType:
 703  * @G_UNIX_SOCKET_ADDRESS_INVALID: invalid
 704  * @G_UNIX_SOCKET_ADDRESS_ANONYMOUS: anonymous
 705  * @G_UNIX_SOCKET_ADDRESS_PATH: a filesystem path
 706  * @G_UNIX_SOCKET_ADDRESS_ABSTRACT: an abstract name
 707  * @G_UNIX_SOCKET_ADDRESS_ABSTRACT_PADDED: an abstract name, 0-padded
 708  *   to the full length of a unix socket name
 709  *
 710  * The type of name used by a #GUnixSocketAddress.
 711  * %G_UNIX_SOCKET_ADDRESS_PATH indicates a traditional unix domain
 712  * socket bound to a filesystem path. %G_UNIX_SOCKET_ADDRESS_ANONYMOUS
 713  * indicates a socket not bound to any name (eg, a client-side socket,
 714  * or a socket created with socketpair()).
 715  *
 716  * For abstract sockets, there are two incompatible ways of naming
 717  * them: the man pages suggest using the entire <literal>struct
 718  * sockaddr_un</literal> as the name, padding the unused parts of the
 719  * %sun_path field with zeroes; this corresponds to
 720  * %G_UNIX_SOCKET_ADDRESS_ABSTRACT_PADDED. However, many programs
 721  * instead just use a portion of %sun_path, and pass an appropriate
 722  * smaller length to bind() or connect(). This is
 723  * %G_UNIX_SOCKET_ADDRESS_ABSTRACT.
 724  *
 725  * Since: 2.26
 726  */
 727 typedef enum {
 728   G_UNIX_SOCKET_ADDRESS_INVALID,
 729   G_UNIX_SOCKET_ADDRESS_ANONYMOUS,
 730   G_UNIX_SOCKET_ADDRESS_PATH,
 731   G_UNIX_SOCKET_ADDRESS_ABSTRACT,
 732   G_UNIX_SOCKET_ADDRESS_ABSTRACT_PADDED
 733 } GUnixSocketAddressType;
 734
 735 G_END_DECLS
 736
 737 #endif /* __GIO_ENUMS_H__ */