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  *
 160  * Flags used when an operation may create a file.
 161  */
 162 typedef enum {
 163   G_FILE_CREATE_NONE    = 0,
 164   G_FILE_CREATE_PRIVATE = (1 << 0)
 165 } GFileCreateFlags;
 166
 167
 168 /**
 169  * GMountMountFlags:
 170  * @G_MOUNT_MOUNT_NONE: No flags set.
 171  *
 172  * Flags used when mounting a mount.
 173  */
 174 typedef enum {
 175   G_MOUNT_MOUNT_NONE = 0
 176 } GMountMountFlags;
 177
 178
 179 /**
 180  * GMountUnmountFlags:
 181  * @G_MOUNT_UNMOUNT_NONE: No flags set.
 182  * @G_MOUNT_UNMOUNT_FORCE: Unmount even if there are outstanding
 183  *  file operations on the mount.
 184  *
 185  * Flags used when an unmounting a mount.
 186  */
 187 typedef enum {
 188   G_MOUNT_UNMOUNT_NONE  = 0,
 189   G_MOUNT_UNMOUNT_FORCE = (1 << 0)
 190 } GMountUnmountFlags;
 191
 192
 193 /**
 194  * GFileCopyFlags:
 195  * @G_FILE_COPY_NONE: No flags set.
 196  * @G_FILE_COPY_OVERWRITE: Overwrite any existing files
 197  * @G_FILE_COPY_BACKUP: Make a backup of any existing files.
 198  * @G_FILE_COPY_NOFOLLOW_SYMLINKS: Don't follow symlinks.
 199  * @G_FILE_COPY_ALL_METADATA: Copy all file metadata instead of just default set used for copy (see #GFileInfo).
 200  * @G_FILE_COPY_NO_FALLBACK_FOR_MOVE: Don't use copy and delete fallback if native move not supported.
 201  *
 202  * Flags used when copying or moving files.
 203  */
 204 typedef enum {
 205   G_FILE_COPY_NONE                 = 0,          /*< nick=none >*/
 206   G_FILE_COPY_OVERWRITE            = (1 << 0),
 207   G_FILE_COPY_BACKUP               = (1 << 1),
 208   G_FILE_COPY_NOFOLLOW_SYMLINKS    = (1 << 2),
 209   G_FILE_COPY_ALL_METADATA         = (1 << 3),
 210   G_FILE_COPY_NO_FALLBACK_FOR_MOVE = (1 << 4)
 211 } GFileCopyFlags;
 212
 213
 214 /**
 215  * GFileMonitorFlags:
 216  * @G_FILE_MONITOR_NONE: No flags set.
 217  * @G_FILE_MONITOR_WATCH_MOUNTS: Watch for mount events.
 218  *
 219  * Flags used to set what a #GFileMonitor will watch for.
 220  */
 221 typedef enum {
 222   G_FILE_MONITOR_NONE         = 0,
 223   G_FILE_MONITOR_WATCH_MOUNTS = (1 << 0)
 224 } GFileMonitorFlags;
 225
 226
 227 /**
 228  * GFileType:
 229  * @G_FILE_TYPE_UNKNOWN: File's type is unknown.
 230  * @G_FILE_TYPE_REGULAR: File handle represents a regular file.
 231  * @G_FILE_TYPE_DIRECTORY: File handle represents a directory.
 232  * @G_FILE_TYPE_SYMBOLIC_LINK: File handle represents a symbolic link
 233  *    (Unix systems).
 234  * @G_FILE_TYPE_SPECIAL: File is a "special" file, such as a socket, fifo,
 235  *    block device, or character device.
 236  * @G_FILE_TYPE_SHORTCUT: File is a shortcut (Windows systems).
 237  * @G_FILE_TYPE_MOUNTABLE: File is a mountable location.
 238  *
 239  * Indicates the file's on-disk type.
 240  **/
 241 typedef enum {
 242   G_FILE_TYPE_UNKNOWN = 0,
 243   G_FILE_TYPE_REGULAR,
 244   G_FILE_TYPE_DIRECTORY,
 245   G_FILE_TYPE_SYMBOLIC_LINK,
 246   G_FILE_TYPE_SPECIAL, /* socket, fifo, blockdev, chardev */
 247   G_FILE_TYPE_SHORTCUT,
 248   G_FILE_TYPE_MOUNTABLE
 249 } GFileType;
 250
 251
 252 /**
 253  * GFilesystemPreviewType:
 254  * @G_FILESYSTEM_PREVIEW_TYPE_IF_ALWAYS: Only preview files if user has explicitly requested it.
 255  * @G_FILESYSTEM_PREVIEW_TYPE_IF_LOCAL: Preview files if user has requested preview of "local" files.
 256  * @G_FILESYSTEM_PREVIEW_TYPE_NEVER: Never preview files.
 257  *
 258  * Indicates a hint from the file system whether files should be
 259  * previewed in a file manager. Returned as the value of the key
 260  * #G_FILE_ATTRIBUTE_FILESYSTEM_USE_PREVIEW.
 261  **/
 262 typedef enum {
 263   G_FILESYSTEM_PREVIEW_TYPE_IF_ALWAYS = 0,
 264   G_FILESYSTEM_PREVIEW_TYPE_IF_LOCAL,
 265   G_FILESYSTEM_PREVIEW_TYPE_NEVER
 266 } GFilesystemPreviewType;
 267
 268
 269 /**
 270  * GFileMonitorEvent:
 271  * @G_FILE_MONITOR_EVENT_CHANGED: a file changed.
 272  * @G_FILE_MONITOR_EVENT_CHANGES_DONE_HINT: a hint that this was probably the last change in a set of changes.
 273  * @G_FILE_MONITOR_EVENT_DELETED: a file was deleted.
 274  * @G_FILE_MONITOR_EVENT_CREATED: a file was created.
 275  * @G_FILE_MONITOR_EVENT_ATTRIBUTE_CHANGED: a file attribute was changed.
 276  * @G_FILE_MONITOR_EVENT_PRE_UNMOUNT: the file location will soon be unmounted.
 277  * @G_FILE_MONITOR_EVENT_UNMOUNTED: the file location was unmounted.
 278  *
 279  * Specifies what type of event a monitor event is.
 280  **/
 281 typedef enum {
 282   G_FILE_MONITOR_EVENT_CHANGED,
 283   G_FILE_MONITOR_EVENT_CHANGES_DONE_HINT,
 284   G_FILE_MONITOR_EVENT_DELETED,
 285   G_FILE_MONITOR_EVENT_CREATED,
 286   G_FILE_MONITOR_EVENT_ATTRIBUTE_CHANGED,
 287   G_FILE_MONITOR_EVENT_PRE_UNMOUNT,
 288   G_FILE_MONITOR_EVENT_UNMOUNTED
 289 } GFileMonitorEvent;
 290
 291
 292 /* This enumeration conflicts with GIOError in giochannel.h. However,
 293  * that is only used as a return value in some deprecated functions.
 294  * So, we reuse the same prefix for the enumeration values, but call
 295  * the actual enumeration (which is rarely used) GIOErrorEnum.
 296  */
 297 /**
 298  * GIOErrorEnum:
 299  * @G_IO_ERROR_FAILED: Generic error condition for when any operation fails.
 300  * @G_IO_ERROR_NOT_FOUND: File not found error.
 301  * @G_IO_ERROR_EXISTS: File already exists error.
 302  * @G_IO_ERROR_IS_DIRECTORY: File is a directory error.
 303  * @G_IO_ERROR_NOT_DIRECTORY: File is not a directory.
 304  * @G_IO_ERROR_NOT_EMPTY: File is a directory that isn't empty.
 305  * @G_IO_ERROR_NOT_REGULAR_FILE: File is not a regular file.
 306  * @G_IO_ERROR_NOT_SYMBOLIC_LINK: File is not a symbolic link.
 307  * @G_IO_ERROR_NOT_MOUNTABLE_FILE: File cannot be mounted.
 308  * @G_IO_ERROR_FILENAME_TOO_LONG: Filename is too many characters.
 309  * @G_IO_ERROR_INVALID_FILENAME: Filename is invalid or contains invalid characters.
 310  * @G_IO_ERROR_TOO_MANY_LINKS: File contains too many symbolic links.
 311  * @G_IO_ERROR_NO_SPACE: No space left on drive.
 312  * @G_IO_ERROR_INVALID_ARGUMENT: Invalid argument.
 313  * @G_IO_ERROR_PERMISSION_DENIED: Permission denied.
 314  * @G_IO_ERROR_NOT_SUPPORTED: Operation not supported for the current backend.
 315  * @G_IO_ERROR_NOT_MOUNTED: File isn't mounted.
 316  * @G_IO_ERROR_ALREADY_MOUNTED: File is already mounted.
 317  * @G_IO_ERROR_CLOSED: File was closed.
 318  * @G_IO_ERROR_CANCELLED: Operation was cancelled. See #GCancellable.
 319  * @G_IO_ERROR_PENDING: Operations are still pending.
 320  * @G_IO_ERROR_READ_ONLY: File is read only.
 321  * @G_IO_ERROR_CANT_CREATE_BACKUP: Backup couldn't be created.
 322  * @G_IO_ERROR_WRONG_ETAG: File's Entity Tag was incorrect.
 323  * @G_IO_ERROR_TIMED_OUT: Operation timed out.
 324  * @G_IO_ERROR_WOULD_RECURSE: Operation would be recursive.
 325  * @G_IO_ERROR_BUSY: File is busy.
 326  * @G_IO_ERROR_WOULD_BLOCK: Operation would block.
 327  * @G_IO_ERROR_HOST_NOT_FOUND: Host couldn't be found (remote operations).
 328  * @G_IO_ERROR_WOULD_MERGE: Operation would merge files.
 329  * @G_IO_ERROR_FAILED_HANDLED: Operation failed and a helper program has already interacted with the user. Do not display any error dialog.
 330  *
 331  * Error codes returned by GIO functions.
 332  *
 333  **/
 334 typedef enum {
 335   G_IO_ERROR_FAILED,
 336   G_IO_ERROR_NOT_FOUND,
 337   G_IO_ERROR_EXISTS,
 338   G_IO_ERROR_IS_DIRECTORY,
 339   G_IO_ERROR_NOT_DIRECTORY,
 340   G_IO_ERROR_NOT_EMPTY,
 341   G_IO_ERROR_NOT_REGULAR_FILE,
 342   G_IO_ERROR_NOT_SYMBOLIC_LINK,
 343   G_IO_ERROR_NOT_MOUNTABLE_FILE,
 344   G_IO_ERROR_FILENAME_TOO_LONG,
 345   G_IO_ERROR_INVALID_FILENAME,
 346   G_IO_ERROR_TOO_MANY_LINKS,
 347   G_IO_ERROR_NO_SPACE,
 348   G_IO_ERROR_INVALID_ARGUMENT,
 349   G_IO_ERROR_PERMISSION_DENIED,
 350   G_IO_ERROR_NOT_SUPPORTED,
 351   G_IO_ERROR_NOT_MOUNTED,
 352   G_IO_ERROR_ALREADY_MOUNTED,
 353   G_IO_ERROR_CLOSED,
 354   G_IO_ERROR_CANCELLED,
 355   G_IO_ERROR_PENDING,
 356   G_IO_ERROR_READ_ONLY,
 357   G_IO_ERROR_CANT_CREATE_BACKUP,
 358   G_IO_ERROR_WRONG_ETAG,
 359   G_IO_ERROR_TIMED_OUT,
 360   G_IO_ERROR_WOULD_RECURSE,
 361   G_IO_ERROR_BUSY,
 362   G_IO_ERROR_WOULD_BLOCK,
 363   G_IO_ERROR_HOST_NOT_FOUND,
 364   G_IO_ERROR_WOULD_MERGE,
 365   G_IO_ERROR_FAILED_HANDLED
 366 } GIOErrorEnum;
 367
 368
 369 /**
 370  * GAskPasswordFlags:
 371  * @G_ASK_PASSWORD_NEED_PASSWORD: operation requires a password.
 372  * @G_ASK_PASSWORD_NEED_USERNAME: operation requires a username.
 373  * @G_ASK_PASSWORD_NEED_DOMAIN: operation requires a domain.
 374  * @G_ASK_PASSWORD_SAVING_SUPPORTED: operation supports saving settings.
 375  * @G_ASK_PASSWORD_ANONYMOUS_SUPPORTED: operation supports anonymous users.
 376  *
 377  * #GAskPasswordFlags are used to request specific information from the
 378  * user, or to notify the user of their choices in an authentication
 379  * situation.
 380  *
 381  **/
 382 typedef enum {
 383   G_ASK_PASSWORD_NEED_PASSWORD       = (1 << 0),
 384   G_ASK_PASSWORD_NEED_USERNAME       = (1 << 1),
 385   G_ASK_PASSWORD_NEED_DOMAIN         = (1 << 2),
 386   G_ASK_PASSWORD_SAVING_SUPPORTED    = (1 << 3),
 387   G_ASK_PASSWORD_ANONYMOUS_SUPPORTED = (1 << 4)
 388 } GAskPasswordFlags;
 389
 390
 391 /**
 392  * GPasswordSave:
 393  * @G_PASSWORD_SAVE_NEVER: never save a password.
 394  * @G_PASSWORD_SAVE_FOR_SESSION: save a password for the session.
 395  * @G_PASSWORD_SAVE_PERMANENTLY: save a password permanently.
 396  *
 397  * #GPasswordSave is used to indicate the lifespan of a saved password.
 398  *
 399  * #Gvfs stores passwords in the Gnome keyring when this flag allows it
 400  * to, and later retrieves it again from there.
 401  **/
 402 typedef enum {
 403   G_PASSWORD_SAVE_NEVER,
 404   G_PASSWORD_SAVE_FOR_SESSION,
 405   G_PASSWORD_SAVE_PERMANENTLY
 406 } GPasswordSave;
 407
 408
 409 /**
 410  * GMountOperationResult:
 411  * @G_MOUNT_OPERATION_HANDLED: The request was fulfilled and the user specified data is now availible
 412  * @G_MOUNT_OPERATION_ABORTED: The user requested the mount operation to be aborted
 413  * @G_MOUNT_OPERATION_UNHANDLED: The request was unhandled (i.e. not implemented)
 414  *
 415  * #GMountOperationResult is returned as a result when a request for information
 416  * is send by the mounting operation.
 417  **/
 418 typedef enum {
 419   G_MOUNT_OPERATION_HANDLED,
 420   G_MOUNT_OPERATION_ABORTED,
 421   G_MOUNT_OPERATION_UNHANDLED
 422 } GMountOperationResult;
 423
 424
 425 /**
 426  * GOutputStreamSpliceFlags:
 427  * @G_OUTPUT_STREAM_SPLICE_NONE: Do not close either stream.
 428  * @G_OUTPUT_STREAM_SPLICE_CLOSE_SOURCE: Close the source stream after the splice.
 429  * @G_OUTPUT_STREAM_SPLICE_CLOSE_TARGET: Close the target stream after the splice.
 430  *
 431  * GOutputStreamSpliceFlags determine how streams should be spliced.
 432  **/
 433 typedef enum {
 434   G_OUTPUT_STREAM_SPLICE_NONE         = 0,
 435   G_OUTPUT_STREAM_SPLICE_CLOSE_SOURCE = (1 << 0),
 436   G_OUTPUT_STREAM_SPLICE_CLOSE_TARGET = (1 << 1)
 437 } GOutputStreamSpliceFlags;
 438
 439
 440
 441 G_END_DECLS
 442
 443 #endif /* __GIO_ENUMS_H__ */