Documentation

Extension point for volume monitor functionality. See [Extending GIO][extending-gio].

The string used to obtain a UUID with volumeGetIdentifier.

The string used to obtain a Unix device path with volumeGetIdentifier.

The string used to obtain a NFS mount with volumeGetIdentifier.

The string used to obtain a filesystem label with volumeGetIdentifier.

The string used to obtain a Hal UDI with volumeGetIdentifier.

The string used to obtain the volume class with volumeGetIdentifier.

Known volume classes include device and network. Other classes may be added in the future.

This is intended to be used by applications to classify Volume instances into different sections - for example a file manager or file chooser can use this information to show network volumes under a "Network" heading and device volumes under a "Devices" heading.

Extension point for Vfs functionality. See [Extending GIO][extending-gio].

The purpose used to verify the server certificate in a TLS connection. This is the most common purpose in use. Used by TLS clients.

The purpose used to verify the client certificate in a TLS connection. Used by TLS servers.

Extension point for TLS functionality via TlsBackend. See [Extending GIO][extending-gio].

Extension point for SettingsBackend functionality.

Extension point for proxy resolving functionality. See [Extending GIO][extending-gio].

Extension point for proxy functionality. See [Extending GIO][extending-gio].

Since: 2.26

Extension point for network status monitoring functionality. See [Extending GIO][extending-gio].

Since: 2.30

No description available in the introspection data.

The name of the link that associates a menu item with a submenu.

See also menuItemSetLink.

Since: 2.32

The name of the link that associates a menu item with a section. The linked menu will usually be shown in place of the menu item, using the item's label as a header.

See also menuItemSetLink.

Since: 2.32

The menu item attribute which holds the target with which the item's action will be activated.

See also g_menu_item_set_action_and_target()

Since: 2.32

The menu item attribute which holds the label of the item.

Since: 2.32

The menu item attribute which holds the icon of the item.

The icon is stored in the format returned by iconSerialize.

This attribute is intended only to represent 'noun' icons such as favicons for a webpage, or application icons. It should not be used for 'verbs' (ie: stock icons).

Since: 2.38

The menu item attribute that holds the namespace for all action names in menus that are linked from this item.

Since: 2.36

The menu item attribute which holds the action name of the item. Action names are namespaced with an identifier for the action group in which the action resides. For example, "win." for window-specific actions and "app." for application-wide actions.

See also g_menu_model_get_item_attribute() and g_menu_item_set_attribute().

Since: 2.32

A key in the "unix" namespace for getting the user ID for the file. This attribute is only available for UNIX file systems. Corresponding FileAttributeType is FileAttributeTypeUint32.

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 FileAttributeType is FileAttributeTypeUint32.

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 FileAttributeType is FileAttributeTypeUint32.

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 FileAttributeType is FileAttributeTypeUint32.

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 FileAttributeType is FileAttributeTypeBoolean.

A key in the "unix" namespace for getting the inode of the file. This attribute is only available for UNIX file systems. Corresponding FileAttributeType is FileAttributeTypeUint64.

A key in the "unix" namespace for getting the group ID for the file. This attribute is only available for UNIX file systems. Corresponding FileAttributeType is FileAttributeTypeUint32.

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 FileAttributeType is FileAttributeTypeUint32.

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 FileAttributeType is FileAttributeTypeUint32.

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 FileAttributeType is FileAttributeTypeUint64.

A key in the "trash" namespace. When requested against items in trash:///, will return the original path to the file before it was trashed. Corresponding FileAttributeType is FileAttributeTypeByteString.

Since: 2.24

A key in the "trash" namespace. When requested against trash:/// returns the number of (toplevel) items in the trash folder. Corresponding FileAttributeType is FileAttributeTypeUint32.

A key in the "trash" namespace. When requested against items in trash:///, will return the date and time when the file was trashed. The format of the returned string is YYYY-MM-DDThh:mm:ss. Corresponding FileAttributeType is FileAttributeTypeString.

Since: 2.24

A key in the "time" namespace for getting the microseconds of the time the file was last modified. This should be used in conjunction with FILE_ATTRIBUTE_TIME_MODIFIED. Corresponding FileAttributeType is FileAttributeTypeUint32.

A key in the "time" namespace for getting the time the file was last modified. Corresponding FileAttributeType is FileAttributeTypeUint64, and contains the time since the file was modified, in seconds since the UNIX epoch.

A key in the "time" namespace for getting the microseconds of the time the file was created. This should be used in conjunction with FILE_ATTRIBUTE_TIME_CREATED. Corresponding FileAttributeType is FileAttributeTypeUint32.

A key in the "time" namespace for getting the time the file was created. Corresponding FileAttributeType is FileAttributeTypeUint64, and contains the time since the file was created, in seconds since the UNIX epoch.

This corresponds to the NTFS ctime.

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 FILE_ATTRIBUTE_TIME_CHANGED. Corresponding FileAttributeType is FileAttributeTypeUint32.

A key in the "time" namespace for getting the time the file was last changed. Corresponding FileAttributeType is FileAttributeTypeUint64, and contains the time since the file was last changed, in seconds since the UNIX epoch.

This corresponds to the traditional UNIX ctime.

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 FILE_ATTRIBUTE_TIME_ACCESS. Corresponding FileAttributeType is FileAttributeTypeUint32.

A key in the "time" namespace for getting the time the file was last accessed. Corresponding FileAttributeType is FileAttributeTypeUint64, and contains the time since the file was last accessed, in seconds since the UNIX epoch.

A key in the "thumbnail" namespace for getting the path to the thumbnail image. Corresponding FileAttributeType is FileAttributeTypeByteString.

A key in the "thumbnail" namespace for checking whether the thumbnail is outdated. This attribute is True if the thumbnail is up-to-date with the file it represents, and False if the file has been modified since the thumbnail was generated.

If FILE_ATTRIBUTE_THUMBNAILING_FAILED is True and this attribute is False, it indicates that thumbnailing may be attempted again and may succeed.

Corresponding FileAttributeType is FileAttributeTypeBoolean.

Since: 2.40

A key in the "thumbnail" namespace for checking if thumbnailing failed. This attribute is True if thumbnailing failed. Corresponding FileAttributeType is FileAttributeTypeBoolean.

A key in the "standard" namespace for storing file types. Corresponding FileAttributeType is FileAttributeTypeUint32. The value for this key should contain a FileType.

A key in the "standard" namespace for getting the target URI for the file, in the case of FileTypeShortcut or FileTypeMountable files. Corresponding FileAttributeType is FileAttributeTypeString.

A key in the "standard" namespace for getting the symlink target, if the file is a symlink. Corresponding FileAttributeType is FileAttributeTypeByteString.

A key in the "standard" namespace for getting the symbolic icon for the file. Corresponding FileAttributeType is FileAttributeTypeObject. The value for this key should contain a Icon.

Since: 2.34

A key in the "standard" namespace for setting the sort order of a file. Corresponding FileAttributeType is FileAttributeTypeInt32. 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.

A key in the "standard" namespace for getting the file's size (in bytes). Corresponding FileAttributeType is FileAttributeTypeUint64.

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 FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME if you need to display the name in a user interface. Corresponding FileAttributeType is FileAttributeTypeByteString.

A key in the "standard" namespace for checking if a file is volatile. This is meant for opaque, non-POSIX-like backends to indicate that the URI is not persistent. Applications should look at FILE_ATTRIBUTE_STANDARD_SYMLINK_TARGET for the persistent URI.

Corresponding FileAttributeType is FileAttributeTypeBoolean.

Since: 2.46

A key in the "standard" namespace for checking if a file is virtual. Corresponding FileAttributeType is FileAttributeTypeBoolean.

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 FileAttributeType is FileAttributeTypeBoolean.

A key in the "standard" namespace for checking if a file is hidden. Corresponding FileAttributeType is FileAttributeTypeBoolean.

A key in the "standard" namespace for checking if a file is a backup file. Corresponding FileAttributeType is FileAttributeTypeBoolean.

A key in the "standard" namespace for getting the icon for the file. Corresponding FileAttributeType is FileAttributeTypeObject. The value for this key should contain a Icon.

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 FileAttributeType is FileAttributeTypeString.

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 FileAttributeType is FileAttributeTypeString.

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 FileAttributeType is FileAttributeTypeString.

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 FileAttributeType is FileAttributeTypeString.

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 FileAttributeType is FileAttributeTypeString.

A key in the "standard" namespace for getting the content type of the file. Corresponding FileAttributeType is FileAttributeTypeString. The value for this key should contain a valid content type.

A key in the "standard" namespace for getting the amount of disk space that is consumed by the file (in bytes). This will generally be larger than the file size (due to block size overhead) but can occasionally be smaller (for example, for sparse files). Corresponding FileAttributeType is FileAttributeTypeUint64.

Since: 2.20

A key in the "selinux" namespace for getting the file's SELinux context. Corresponding FileAttributeType is FileAttributeTypeString. Note that this attribute is only available if GLib has been built with SELinux support.

A key in the "recent" namespace for getting time, when the metadata for the file in recent:/// was last changed. Corresponding FileAttributeType is FileAttributeTypeInt64.

Since: 2.52

A key in the "preview" namespace for getting a Icon that can be used to get preview of the file. For example, it may be a low resolution thumbnail without metadata. Corresponding FileAttributeType is FileAttributeTypeObject. The value for this key should contain a Icon.

Since: 2.20

A key in the "owner" namespace for getting the real name of the user that owns the file. Corresponding FileAttributeType is FileAttributeTypeString.

A key in the "owner" namespace for getting the user name of the file's owner. Corresponding FileAttributeType is FileAttributeTypeString.

A key in the "owner" namespace for getting the file owner's group. Corresponding FileAttributeType is FileAttributeTypeString.

A key in the "mountable" namespace for getting the unix device file. Corresponding FileAttributeType is FileAttributeTypeString.

Since: 2.22

A key in the "mountable" namespace for getting the unix device. Corresponding FileAttributeType is FileAttributeTypeUint32.

A key in the "mountable" namespace for getting the DriveStartStopType. Corresponding FileAttributeType is FileAttributeTypeUint32.

Since: 2.22

A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) is automatically polled for media. Corresponding FileAttributeType is FileAttributeTypeBoolean.

Since: 2.22

A key in the "mountable" namespace for getting the HAL UDI for the mountable file. Corresponding FileAttributeType is FileAttributeTypeString.

A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) is unmountable. Corresponding FileAttributeType is FileAttributeTypeBoolean.

A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) can be stopped. Corresponding FileAttributeType is FileAttributeTypeBoolean.

Since: 2.22

A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) can be started degraded. Corresponding FileAttributeType is FileAttributeTypeBoolean.

Since: 2.22

A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) can be started. Corresponding FileAttributeType is FileAttributeTypeBoolean.

Since: 2.22

A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) can be polled. Corresponding FileAttributeType is FileAttributeTypeBoolean.

Since: 2.22

A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) is mountable. Corresponding FileAttributeType is FileAttributeTypeBoolean.

A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) can be ejected. Corresponding FileAttributeType is FileAttributeTypeBoolean.

A key in the "id" namespace for getting the file system identifier. Corresponding FileAttributeType is FileAttributeTypeString. 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).

A key in the "id" namespace for getting a file identifier. Corresponding FileAttributeType is FileAttributeTypeString. An example use would be during listing files, to avoid recursive directory scanning.

A key in the "gvfs" namespace that gets the name of the current GVFS backend in use. Corresponding FileAttributeType is FileAttributeTypeString.

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 FilesystemPreviewType.

A key in the "filesystem" namespace for getting the number of bytes of used on the file system. Corresponding FileAttributeType is FileAttributeTypeUint64.

Since: 2.32

A key in the "filesystem" namespace for getting the file system's type. Corresponding FileAttributeType is FileAttributeTypeString.

A key in the "filesystem" namespace for getting the total size (in bytes) of the file system, used in fileQueryFilesystemInfo. Corresponding FileAttributeType is FileAttributeTypeUint64.

A key in the "filesystem" namespace for checking if the file system is remote. Is set to True if the file system is remote. Corresponding FileAttributeType is FileAttributeTypeBoolean.

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 FileAttributeType is FileAttributeTypeBoolean.

A key in the "filesystem" namespace for getting the number of bytes of free space left on the file system. Corresponding FileAttributeType is FileAttributeTypeUint64.

A key in the "etag" namespace for getting the value of the file's entity tag. Corresponding FileAttributeType is FileAttributeTypeString.

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 FileAttributeType is FileAttributeTypeBoolean.

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 FileAttributeType is FileAttributeTypeBoolean.

A key in the "access" namespace for getting write privileges. Corresponding FileAttributeType is FileAttributeTypeBoolean. This attribute will be True if the user is able to write to the file.

A key in the "access" namespace for checking trashing privileges. Corresponding FileAttributeType is FileAttributeTypeBoolean. This attribute will be True if the user is able to move the file to the trash.

A key in the "access" namespace for checking renaming privileges. Corresponding FileAttributeType is FileAttributeTypeBoolean. This attribute will be True if the user is able to rename the file.

A key in the "access" namespace for getting read privileges. Corresponding FileAttributeType is FileAttributeTypeBoolean. This attribute will be True if the user is able to read the file.

A key in the "access" namespace for getting execution privileges. Corresponding FileAttributeType is FileAttributeTypeBoolean. This attribute will be True if the user is able to execute the file.

A key in the "access" namespace for checking deletion privileges. Corresponding FileAttributeType is FileAttributeTypeBoolean. This attribute will be True if the user is able to delete the file.

Extension point for default handler to URI association. See [Extending GIO][extending-gio].