gio Constants — the built-in constants of the gio module
Gio AppInfo Create Flags Constants Gio Ask Password Flags Constants Gio Data Stream Byte Order Constants Gio Data Stream Newline Type Constants Gio Emblem Origin Constants Gio Error Constants Gio File Attribute Constants Gio File Attribute Type Constants Gio File Attribute Flags Constants Gio File Create Flags Constants Gio File Copy Flags Constants Gio File Monitor Flags Constants Gio File Query Info Flags Constants Gio File Type Constants Gio Mount Mount Flags Constants Gio Mount Operation Result Constants Gio Mount Unmount Flags Constants Gio Password Save Constants
Flags that are used to request specific information from the user, or to notify the user of their choices in an authentication situation.
| operation supports anonymous users. |
| operation requires a domain. |
| operation requires a password. |
| operation requires a username. |
| operation supports saving settings. |
Flags used when creating a gio.AppInfo
| No flags. |
| Application opens in a terminal window. |
| Application supports URI arguments. |
Used to ensure proper endianness of streaming data sources across various machine architectures.
| Selects Big Endian byte order. |
| Selects endianness based on host machine's architecture. |
| Selects Little Endian byte order. |
Used when checking for or setting the line endings for a given file.
| Selects "LF" line endings, common on most modern UNIX platforms. |
| Selects "CR" line endings. |
| Selects "CR, LF" line ending, common on Microsoft Windows. |
| Automatically try to handle any line ending type. |
GEmblemOrigin is used to add information about the origin of the emblem to GEmblem.
| Embleme adds device-specific information. |
| Emblem depicts live metadata, such as "readonly". |
| Emblem comes from a user-defined tag, e.g. set by nautilus (in the future). |
| Emblem of unknown origin. |
GIOError Error codes returned by GIO functions.
| File is already mounted. |
| File is busy. |
| Operation was cancelled. See
gio.Cancellable.
|
| Backup couldn't be created. |
| File was closed. |
| File already exists error. |
| Generic error condition for when any operation fails. |
| Operation failed and a helper program has already interacted with the user. Do not display any error dialog. |
| Filename is too many characters. |
| Host couldn't be found (remote operations). |
| Invalid argument. |
| Filename is invalid or contains invalid characters. |
| File is a directory error. |
| File is not a directory. |
| File is a directory that isn't empty. |
| File not found error. |
| File cannot be mounted. |
| File isn't mounted. |
| File is not a regular file. |
| Operation not supported for the current backend. |
| File is not a symbolic link. |
| No space left on drive. |
| Operations are still pending. |
| Permission denied. |
| File is read only. |
| Operation timed out. |
| File contains too many symbolic links. |
| The current process has too many files open and can't open any more. Duplicate descriptors do count toward this limit. Since 2.20 |
| Operation would block. |
| Operation would merge files. |
| Operation would be recursive. |
| File's Entity Tag was incorrect. |
The file attributes.
| "standard::type" A key in the "standard" namespace for storing file types. Corresponding Gio File Attribute Type Constants is gio.FILE_ATTRIBUTE_TYPE_UINT32. The value for this key should contain a Gio File Type Constants |
| "standard::is-hidden" A key in the "standard" namespace for checking if a file is hidden. Corresponding Gio File Attribute Type Constants is gio.FILE_ATTRIBUTE_TYPE_BOOLEAN. |
| "standard::is-backup" A key in the "standard" namespace for checking if a file is a backup file. Corresponding Gio File Attribute Type Constants is gio.FILE_ATTRIBUTE_TYPE_BOOLEAN. |
| "standard::is-symlink" A key in the "standard" namespace for checking if the file is a symlink. Typically the actual type is something else, if we followed the symlink to get the type. Corresponding Gio File Attribute Type Constants is gio.FILE_ATTRIBUTE_TYPE_BOOLEAN. |
| "standard::is-virtual" A key in the "standard" namespace for checking if a file is virtual. Corresponding Gio File Attribute Type Constants is gio.FILE_ATTRIBUTE_TYPE_BOOLEAN. |
| "standard::name" A key in the "standard" namespace for getting the name of the file. The name is the on-disk filename which may not be in any known encoding, and can thus not be generally displayed as is. Use gio.FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME if you need to display the name in a user interface. Corresponding GFileAttributeType is gio.FILE_ATTRIBUTE_TYPE_BYTE_STRING. |
| "standard::display-name" A key in the "standard" namespace for getting the display name of the file. A display name is guaranteed to be in UTF8 and can thus be displayed in the UI. Corresponding Gio File Attribute Type Constants is gio.FILE_ATTRIBUTE_TYPE_STRING. |
| "standard::edit-name" A key in the "standard" namespace for edit name of the file. An edit name is similar to the display name, but it is meant to be used when you want to rename the file in the UI. The display name might contain information you don't want in the new filename (such as "(invalid unicode)" if the filename was in an invalid encoding). Corresponding Gio File Attribute Type Constants is gio.FILE_ATTRIBUTE_TYPE_STRING. |
| "standard::copy-name" A key in the "standard" namespace for getting the copy name of the file. The copy name is an optional version of the name. If available it's always in UTF8, and corresponds directly to the original filename (only transcoded to UTF8). This is useful if you want to copy the file to another filesystem that might have a different encoding. If the filename is not a valid string in the encoding selected for the filesystem it is in then the copy name will not be set. Corresponding Gio File Attribute Type Constants is gio.FILE_ATTRIBUTE_TYPE_STRING. |
|
"standard::icon" A key in the "standard" namespace for getting the icon for the file. Corresponding
Gio File Attribute Type Constants
is gio.FILE_ATTRIBUTE_TYPE_OBJECT. The value for this key should contain a
gio.Icon.
|
| "standard::content-type" A key in the "standard" namespace for getting the content type of the file. Corresponding Gio File Attribute Type Constants is gio.FILE_ATTRIBUTE_TYPE_STRING. The value for this key should contain a valid content type. |
| "standard::fast-content-type" A key in the "standard" namespace for getting the fast content type. The fast content type isn't as reliable as the regular one, as it only uses the filename to guess it, but it is faster to calculate than the regular content type. Corresponding Gio File Attribute Type Constants is gio.FILE_ATTRIBUTE_TYPE_STRING. |
| "standard::size" A key in the "standard" namespace for getting the file's size (in bytes). Corresponding Gio File Attribute Type Constants is gio.FILE_ATTRIBUTE_TYPE_UINT64. |
| "standard::symlink-target" A key in the "standard" namespace for getting the target URI for the file, in the case of gio.FILE_TYPE_SHORTCUT or gio.FILE_TYPE_MOUNTABLE files. Corresponding Gio File Attribute Type Constants is G_FILE_ATTRIBUTE_TYPE_STRING. |
| "standard::sort-order" A key in the "standard" namespace for setting the sort order of a file. Corresponding Gio File Attribute Type Constants is gio.FILE_ATTRIBUTE_TYPE_INT32. An example use would be in file managers, which would use this key to set the order files are displayed. Files with smaller sort order should be sorted first, and files without sort order as if sort order was zero. |
| "etag::value" A key in the "etag" namespace for getting the value of the file's entity tag. Corresponding Gio File Attribute Type Constants is gio.FILE_ATTRIBUTE_TYPE_STRING. |
| "id::file" A key in the "id" namespace for getting a file identifier. Corresponding Gio File Attribute Type Constants is gio.FILE_ATTRIBUTE_TYPE_STRING. An example use would be during listing files, to avoid recursive directory scanning. |
| "id::filesystem" A key in the "id" namespace for getting the file system identifier. Corresponding Gio File Attribute Type Constants is gio.FILE_ATTRIBUTE_TYPE_STRING. An example use would be during drag and drop to see if the source and target are on the same filesystem (default to move) or not (default to copy). |
|
"access::can-read" A key in the "access" namespace for getting read privileges. Corresponding
Gio File Attribute Type Constants
is G_FILE_ATTRIBUTE_TYPE_BOOLEAN. This attribute will be True
if the user is able to read the file.
|
|
"access::can-write" A key in the "access" namespace for getting write privileges.Corresponding
Gio File Attribute Type Constants
is gio.FILE_ATTRIBUTE_TYPE_BOOLEAN. This attribute will be True
if the user is able to write to the file.
|
|
"access::can-execute" A key in the "access" namespace for getting execution privileges. Corresponding
Gio File Attribute Type Constants
is gio.FILE_ATTRIBUTE_TYPE_BOOLEAN. This attribute will be True
if the user is able to execute the file.
|
|
"access::can-delete" A key in the "access" namespace for checking deletion privileges. Corresponding
Gio File Attribute Type Constants
is gio.FILE_ATTRIBUTE_TYPE_BOOLEAN. This attribute will be True
if the user is able to delete the file.
|
|
"access::can-trash" A key in the "access" namespace for checking trashing privileges. Corresponding
Gio File Attribute Type Constants
is gio.FILE_ATTRIBUTE_TYPE_BOOLEAN. This attribute will be True
if the user is able to move the file to the trash.
|
|
"access::can-rename" A key in the "access" namespace for checking renaming privileges. Corresponding
Gio File Attribute Type Constants
is G_FILE_ATTRIBUTE_TYPE_BOOLEAN. This attribute will be True
if the user is able to rename the file.
|
| "mountable::can-mount" A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) is mountable. Corresponding Gio File Attribute Type Constants is gio.FILE_ATTRIBUTE_TYPE_BOOLEAN. |
| "mountable::can-unmount" A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) is unmountable. Corresponding Gio File Attribute Type Constants is gio.FILE_ATTRIBUTE_TYPE_BOOLEAN. |
| "mountable::can-eject" A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) can be ejected. Corresponding Gio File Attribute Type Constants is gio.FILE_ATTRIBUTE_TYPE_BOOLEAN. |
| "mountable::unix-device" A key in the "mountable" namespace for getting the unix device. Corresponding Gio File Attribute Type Constants is gio.FILE_ATTRIBUTE_TYPE_UINT32. |
| "mountable::hal-udi" A key in the "mountable" namespace for getting the HAL UDI for the mountable file. Corresponding Gio File Attribute Type Constants is gio.FILE_ATTRIBUTE_TYPE_STRING. |
| "time::modified" A key in the "time" namespace for getting the time the file was last modified. Corresponding Gio File Attribute Type Constants is gio.FILE_ATTRIBUTE_TYPE_UINT64, and contains the UNIX time since the file was modified. |
| "time::modified-usec" A key in the "time" namespace for getting the miliseconds of the time the file was last modified. This should be used in conjunction with G_FILE_ATTRIBUTE_TIME_MODIFIED. Corresponding Gio File Attribute Type Constants is G_FILE_ATTRIBUTE_TYPE_UINT32. |
| "time::access" A key in the "time" namespace for getting the time the file was last accessed. Corresponding Gio File Attribute Type Constants is gio.FILE_ATTRIBUTE_TYPE_UINT64, and contains the UNIX time since the file was last accessed. |
| "time::access-usec" A key in the "time" namespace for getting the microseconds of the time the file was last accessed. This should be used in conjunction with G_FILE_ATTRIBUTE_TIME_ACCESS. Corresponding Gio File Attribute Type Constants is gio.FILE_ATTRIBUTE_TYPE_UINT32. |
| "time::changed" A key in the "time" namespace for getting the time the file was last changed. Corresponding Gio File Attribute Type Constants is gio.FILE_ATTRIBUTE_TYPE_UINT64, and contains the UNIX time since the file was last changed. This corresponds to the traditional UNIX ctime. |
| "time::changed-usec" A key in the "time" namespace for getting the microseconds of the time the file was last changed. This should be used in conjunction with G_FILE_ATTRIBUTE_TIME_CHANGED. Corresponding Gio File Attribute Type Constants is gio.FILE_ATTRIBUTE_TYPE_UINT32. |
| "time::created" A key in the "time" namespace for getting the time the file was created. Corresponding Gio File Attribute Type Constants is gio.FILE_ATTRIBUTE_TYPE_UINT64, and contains the UNIX time since the file was created. This corresponds to the NTFS ctime. |
| "time::created-usec" A key in the "time" namespace for getting the microseconds of the time the file was created. This should be used in conjunction with G_FILE_ATTRIBUTE_TIME_CREATED. Corresponding Gio File Attribute Type Constants is gio.FILE_ATTRIBUTE_TYPE_UINT32. |
| "unix::device" A key in the "unix" namespace for getting the device id of the device the file is located on (see stat() documentation). This attribute is only available for UNIX file systems. Corresponding Gio File Attribute Type Constants is gio.FILE_ATTRIBUTE_TYPE_UINT32. |
| "unix::inode" A key in the "unix" namespace for getting the inode of the file. This attribute is only available for UNIX file systems. Corresponding Gio File Attribute Type Constants is G_FILE_ATTRIBUTE_TYPE_UINT64. |
| "unix::mode" A key in the "unix" namespace for getting the mode of the file (e.g. whether the file is a regular file, symlink, etc). See lstat() documentation. This attribute is only available for UNIX file systems. Corresponding Gio File Attribute Type Constants is gio.FILE_ATTRIBUTE_TYPE_UINT32. |
| "unix::nlink" A key in the "unix" namespace for getting the number of hard links for a file. See lstat() documentation. This attribute is only available for UNIX file systems. Corresponding Gio File Attribute Type Constants is gio.FILE_ATTRIBUTE_TYPE_UINT32. |
| "unix::uid" A key in the "unix" namespace for getting the user ID for the file. This attribute is only available for UNIX file systems. Corresponding Gio File Attribute Type Constants is gio.FILE_ATTRIBUTE_TYPE_UINT32. |
| "unix::gid" A key in the "unix" namespace for getting the group ID for the file. This attribute is only available for UNIX file systems. Corresponding Gio File Attribute Type Constants is gio.FILE_ATTRIBUTE_TYPE_UINT32. |
| "unix::rdev" A key in the "unix" namespace for getting the device ID for the file (if it is a special file). See lstat() documentation. This attribute is only available for UNIX file systems. Corresponding Gio File Attribute Type Constants is gio.FILE_ATTRIBUTE_TYPE_UINT32. |
| "unix::block-size" A key in the "unix" namespace for getting the block size for the file system. This attribute is only available for UNIX file systems. Corresponding Gio File Attribute Type Constants is gio.FILE_ATTRIBUTE_TYPE_UINT32. |
| "unix::blocks" A key in the "unix" namespace for getting the number of blocks allocated for the file. This attribute is only available for UNIX file systems. Corresponding Gio File Attribute Type Constants is G_FILE_ATTRIBUTE_TYPE_UINT64. |
|
"unix::is-mountpoint" A key in the "unix" namespace for checking if the file represents
a UNIX mount point. This attribute is True if the file is a UNIX mount point.
This attribute is only available for UNIX file systems. Corresponding
GFileAttributeType
is gio.FILE_ATTRIBUTE_TYPE_BOOLEAN.
|
|
"dos::is-archive" A key in the "dos" namespace for checking if the file's archive
flag is set. This attribute is True if the archive flag is set.
This attribute is only available for DOS file systems. Corresponding
Gio File Attribute Type Constants
is G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
|
|
"dos::is-system" A key in the "dos" namespace for checking if the file's backup
flag is set. This attribute is True if the backup flag is set.
This attribute is only available for DOS file systems. Corresponding
Gio File Attribute Type Constants is
G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
|
| "owner::user" A key in the "owner" namespace for getting the user name of the file's owner. Corresponding Gio File Attribute Type Constants is G_FILE_ATTRIBUTE_TYPE_STRING. |
| "owner::user-real" A key in the "owner" namespace for getting the real name of the user that owns the file. Corresponding Gio File Attribute Type Constants is G_FILE_ATTRIBUTE_TYPE_STRING. |
| "owner::group" A key in the "owner" namespace for getting the file owner's group. Corresponding Gio File Attribute Type Constants is G_FILE_ATTRIBUTE_TYPE_STRING. |
| "thumbnail::path" A key in the "thumbnail" namespace for getting the path to the thumbnail image. Corresponding Gio File Attribute Type Constants is G_FILE_ATTRIBUTE_TYPE_BYTE_STRING. |
|
"thumbnail::failed" A key in the "thumbnail" namespace for checking if thumbnailing failed. This attribute
is True if thumbnailing failed. Corresponding
Gio File Attribute Type Constants is
G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
|
|
"preview::icon" A key in the "preview" namespace for getting a
gio.Icon
that can be used to get preview of the file. For example, it
may be a low resolution thumbnail without metadata. Corresponding
Gio File Attribute Type Constants is
G_FILE_ATTRIBUTE_TYPE_OBJECT. The value for this key should contain a GIcon.
|
|
"filesystem::size" A key in the "filesystem" namespace for getting the total
size (in bytes) of the file system, used in
query_filesystem_info().
Corresponding
Gio File Attribute Type Constants
is G_FILE_ATTRIBUTE_TYPE_UINT64.
|
| "filesystem::free" A key in the "filesystem" namespace for getting the number of bytes of free space left on the file system. Corresponding Gio File Attribute Type Constants is G_FILE_ATTRIBUTE_TYPE_UINT64. |
| "filesystem::type" A key in the "filesystem" namespace for getting the file system's type. Corresponding Gio File Attribute Type Constants is G_FILE_ATTRIBUTE_TYPE_STRING. |
|
"filesystem::readonly" A key in the "filesystem" namespace for checking if the
file system is read only. Is set to True if the file system
is read only. Corresponding
Gio File Attribute Type Constants
is G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
|
| "gvfs::backend" A key in the "gvfs" namespace that gets the name of the current GVFS backend in use. Corresponding Gio File Attribute Type Constants is G_FILE_ATTRIBUTE_TYPE_STRING. |
| "selinux::context" A key in the "selinux" namespace for getting the file's SELinux context. Corresponding Gio File Attribute Type Constants is G_FILE_ATTRIBUTE_TYPE_STRING. Note that this attribute is only available if GLib has been built with SELinux support. |
| "trash::item-count" A key in the "trash" namespace. When requested against "trash:///" returns the number of (toplevel) items in the trash folder. Corresponding Gio File Attribute Type Constants is G_FILE_ATTRIBUTE_TYPE_UINT32. |
| "filesystem::use-preview" A key in the "filesystem" namespace for hinting a file manager application whether it should preview (e.g. thumbnail) files on the file system. The value for this key contain a GFilesystemPreviewType. |
| "standard::description" A key in the "standard" namespace for getting the description of the file. The description is a utf8 string that describes the file, generally containing the filename, but can also contain furter information. Example descriptions could be "filename (on hostname)" for a remote file or "filename (in trash)" for a file in the trash. This is useful for instance as the window title when displaying a directory or for a bookmarks menu. Corresponding Gio File Attribute Type Constants is G_FILE_ATTRIBUTE_TYPE_STRING. |
The data types for file attributes.
| a boolean value. |
| a zero terminated string of non-zero bytes. |
| a signed 4-byte/32-bit integer. |
| a signed 8-byte/64-bit integer. |
| indicates an invalid or uninitalized type. |
| a gobject.GObject. |
| a null terminated UTF8 string. |
| an unsigned 4-byte/32-bit integer. |
| an unsigned 8-byte/64-bit integer. |
Flags specifying the behaviour of an attribute.
| no flags set. |
| copy the attribute values when the file is copied. |
| copy the attribute values when the file is moved. |
Flags used when an operation may create a file.
| No flags set. |
| Create a file that can only be accessed by the current user. |
| Replace the destination as if it didn't exist before. Don't try to keep any old permissions, replace instead of following links. This is generally useful if you're doing a "copy over" rather than a "save new version of" replace operation. You can think of it as "unlink destination" before writing to it, although the implementation may not be exactly like that. |
Flags used when copying or moving files.
| No flags set. |
| Overwrite any existing files. |
| Make a backup of any existing files. |
| Don't follow symlinks. |
| Copy all file metadata instead of just default set used for copy
(see gio.FileInfo). |
| Don't use copy and delete fallback if native move not supported. |
| Leaves target file with default perms, instead of setting the source file perms. |
Flags used to set what a
gio.FileMonitor
will watch for.
| No flags set. |
| Watch for mount events. |
Flags used when querying a
gio.FileInfo.
| No flags set. |
| Don't follow symlinks. |
Indicates the file's on-disk type.
| File handle represents a directory. |
| File is a mountable location. |
| File handle represents a regular file. |
| File is a shortcut (Windows systems). |
| File is a "special" file, such as a socket, fifo, block device, or character device. |
| File handle represents a symbolic link (Unix systems). |
| File's type is unknown. |
Flags used when unmounting a mount.
| No flags set. |
| Unmount even if there are outstanding file operations on the mount. |
returned as a result when a request for information is send by the mounting operation.
| The request was fulfilled and the user specified data is now available. |
| The user requested the mount operation to be aborted. |
| The request was unhandled (i.e. not implemented). |
is used to indicate the lifespan of a saved password.
Gvfs stores passwords in the Gnome keyring when this flag allows it to, and later retrieves it again from there.
| save a password for the session. |
| never save a password. |
| save a password permanently. |