gio.types

D types for gio2 library

var DBUS_METHOD_INVOCATION_HANDLED DBUS_METHOD_INVOCATION_UNHANDLED DEBUG_CONTROLLER_EXTENSION_POINT_NAME DESKTOP_APP_INFO_LOOKUP_EXTENSION_POINT_NAME DRIVE_IDENTIFIER_KIND_UNIX_DEVICE FILE_ATTRIBUTE_ACCESS_CAN_DELETE FILE_ATTRIBUTE_ACCESS_CAN_EXECUTE FILE_ATTRIBUTE_ACCESS_CAN_READ FILE_ATTRIBUTE_ACCESS_CAN_RENAME FILE_ATTRIBUTE_ACCESS_CAN_TRASH FILE_ATTRIBUTE_ACCESS_CAN_WRITE FILE_ATTRIBUTE_DOS_IS_ARCHIVE FILE_ATTRIBUTE_DOS_IS_MOUNTPOINT FILE_ATTRIBUTE_DOS_IS_SYSTEM FILE_ATTRIBUTE_DOS_REPARSE_POINT_TAG FILE_ATTRIBUTE_ETAG_VALUE FILE_ATTRIBUTE_FILESYSTEM_FREE FILE_ATTRIBUTE_FILESYSTEM_READONLY FILE_ATTRIBUTE_FILESYSTEM_REMOTE FILE_ATTRIBUTE_FILESYSTEM_SIZE FILE_ATTRIBUTE_FILESYSTEM_TYPE FILE_ATTRIBUTE_FILESYSTEM_USE_PREVIEW FILE_ATTRIBUTE_FILESYSTEM_USED FILE_ATTRIBUTE_GVFS_BACKEND FILE_ATTRIBUTE_ID_FILE FILE_ATTRIBUTE_ID_FILESYSTEM FILE_ATTRIBUTE_MOUNTABLE_CAN_EJECT FILE_ATTRIBUTE_MOUNTABLE_CAN_MOUNT FILE_ATTRIBUTE_MOUNTABLE_CAN_POLL FILE_ATTRIBUTE_MOUNTABLE_CAN_START FILE_ATTRIBUTE_MOUNTABLE_CAN_START_DEGRADED FILE_ATTRIBUTE_MOUNTABLE_CAN_STOP FILE_ATTRIBUTE_MOUNTABLE_CAN_UNMOUNT FILE_ATTRIBUTE_MOUNTABLE_HAL_UDI FILE_ATTRIBUTE_MOUNTABLE_IS_MEDIA_CHECK_AUTOMATIC FILE_ATTRIBUTE_MOUNTABLE_START_STOP_TYPE FILE_ATTRIBUTE_MOUNTABLE_UNIX_DEVICE FILE_ATTRIBUTE_MOUNTABLE_UNIX_DEVICE_FILE FILE_ATTRIBUTE_OWNER_GROUP FILE_ATTRIBUTE_OWNER_USER FILE_ATTRIBUTE_OWNER_USER_REAL FILE_ATTRIBUTE_PREVIEW_ICON FILE_ATTRIBUTE_RECENT_MODIFIED FILE_ATTRIBUTE_SELINUX_CONTEXT FILE_ATTRIBUTE_STANDARD_ALLOCATED_SIZE FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE FILE_ATTRIBUTE_STANDARD_COPY_NAME FILE_ATTRIBUTE_STANDARD_DESCRIPTION FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME FILE_ATTRIBUTE_STANDARD_EDIT_NAME FILE_ATTRIBUTE_STANDARD_FAST_CONTENT_TYPE FILE_ATTRIBUTE_STANDARD_ICON FILE_ATTRIBUTE_STANDARD_IS_BACKUP FILE_ATTRIBUTE_STANDARD_IS_HIDDEN FILE_ATTRIBUTE_STANDARD_IS_SYMLINK FILE_ATTRIBUTE_STANDARD_IS_VIRTUAL FILE_ATTRIBUTE_STANDARD_IS_VOLATILE FILE_ATTRIBUTE_STANDARD_NAME FILE_ATTRIBUTE_STANDARD_SIZE FILE_ATTRIBUTE_STANDARD_SORT_ORDER FILE_ATTRIBUTE_STANDARD_SYMBOLIC_ICON FILE_ATTRIBUTE_STANDARD_SYMLINK_TARGET FILE_ATTRIBUTE_STANDARD_TARGET_URI FILE_ATTRIBUTE_STANDARD_TYPE FILE_ATTRIBUTE_THUMBNAIL_IS_VALID FILE_ATTRIBUTE_THUMBNAIL_IS_VALID_LARGE FILE_ATTRIBUTE_THUMBNAIL_IS_VALID_NORMAL FILE_ATTRIBUTE_THUMBNAIL_IS_VALID_XLARGE FILE_ATTRIBUTE_THUMBNAIL_IS_VALID_XXLARGE FILE_ATTRIBUTE_THUMBNAIL_PATH FILE_ATTRIBUTE_THUMBNAIL_PATH_LARGE FILE_ATTRIBUTE_THUMBNAIL_PATH_NORMAL FILE_ATTRIBUTE_THUMBNAIL_PATH_XLARGE FILE_ATTRIBUTE_THUMBNAIL_PATH_XXLARGE FILE_ATTRIBUTE_THUMBNAILING_FAILED FILE_ATTRIBUTE_THUMBNAILING_FAILED_LARGE FILE_ATTRIBUTE_THUMBNAILING_FAILED_NORMAL FILE_ATTRIBUTE_THUMBNAILING_FAILED_XLARGE FILE_ATTRIBUTE_THUMBNAILING_FAILED_XXLARGE FILE_ATTRIBUTE_TIME_ACCESS FILE_ATTRIBUTE_TIME_ACCESS_NSEC FILE_ATTRIBUTE_TIME_ACCESS_USEC FILE_ATTRIBUTE_TIME_CHANGED FILE_ATTRIBUTE_TIME_CHANGED_NSEC FILE_ATTRIBUTE_TIME_CHANGED_USEC FILE_ATTRIBUTE_TIME_CREATED FILE_ATTRIBUTE_TIME_CREATED_NSEC FILE_ATTRIBUTE_TIME_CREATED_USEC FILE_ATTRIBUTE_TIME_MODIFIED FILE_ATTRIBUTE_TIME_MODIFIED_NSEC FILE_ATTRIBUTE_TIME_MODIFIED_USEC FILE_ATTRIBUTE_TRASH_DELETION_DATE FILE_ATTRIBUTE_TRASH_ITEM_COUNT FILE_ATTRIBUTE_TRASH_ORIG_PATH FILE_ATTRIBUTE_UNIX_BLOCK_SIZE FILE_ATTRIBUTE_UNIX_BLOCKS FILE_ATTRIBUTE_UNIX_DEVICE FILE_ATTRIBUTE_UNIX_GID FILE_ATTRIBUTE_UNIX_INODE FILE_ATTRIBUTE_UNIX_IS_MOUNTPOINT FILE_ATTRIBUTE_UNIX_MODE FILE_ATTRIBUTE_UNIX_NLINK FILE_ATTRIBUTE_UNIX_RDEV FILE_ATTRIBUTE_UNIX_UID MEMORY_MONITOR_EXTENSION_POINT_NAME MENU_ATTRIBUTE_ACTION MENU_ATTRIBUTE_ACTION_NAMESPACE MENU_ATTRIBUTE_ICON MENU_ATTRIBUTE_LABEL MENU_ATTRIBUTE_TARGET MENU_EXPORTER_MAX_SECTION_SIZE MENU_LINK_SECTION MENU_LINK_SUBMENU NATIVE_VOLUME_MONITOR_EXTENSION_POINT_NAME NETWORK_MONITOR_EXTENSION_POINT_NAME POWER_PROFILE_MONITOR_EXTENSION_POINT_NAME PROXY_EXTENSION_POINT_NAME PROXY_RESOLVER_EXTENSION_POINT_NAME SETTINGS_BACKEND_EXTENSION_POINT_NAME TLS_BACKEND_EXTENSION_POINT_NAME TLS_DATABASE_PURPOSE_AUTHENTICATE_CLIENT TLS_DATABASE_PURPOSE_AUTHENTICATE_SERVER VFS_EXTENSION_POINT_NAME VOLUME_IDENTIFIER_KIND_CLASS VOLUME_IDENTIFIER_KIND_HAL_UDI VOLUME_IDENTIFIER_KIND_LABEL VOLUME_IDENTIFIER_KIND_NFS_MOUNT VOLUME_IDENTIFIER_KIND_UNIX_DEVICE VOLUME_IDENTIFIER_KIND_UUID VOLUME_MONITOR_EXTENSION_POINT_NAME
alias AppInfoCreateFlags ApplicationFlags AskPasswordFlags AsyncReadyCallback BusAcquiredCallback BusNameAcquiredCallback BusNameAppearedCallback BusNameLostCallback BusNameOwnerFlags BusNameVanishedCallback BusNameWatcherFlags BusType CancellableSourceFunc ConverterFlags ConverterResult CredentialsType DatagramBasedSourceFunc DataStreamByteOrder DataStreamNewlineType DBusCallFlags DBusCapabilityFlags DBusConnectionFlags DBusError DBusInterfaceGetPropertyFunc DBusInterfaceMethodCallFunc DBusInterfaceSetPropertyFunc DBusInterfaceSkeletonFlags DBusInterfaceVTable DBusMessageByteOrder DBusMessageFilterFunction DBusMessageFlags DBusMessageHeaderField DBusMessageType DBusObjectManagerClientFlags DBusPropertyInfoFlags DBusProxyFlags DBusProxyTypeFunc DBusSendMessageFlags DBusServerFlags DBusSignalCallback DBusSignalFlags DBusSubtreeDispatchFunc DBusSubtreeEnumerateFunc DBusSubtreeFlags DBusSubtreeIntrospectFunc DBusSubtreeVTable DesktopAppLaunchCallback DriveStartFlags DriveStartStopType EmblemOrigin FileAttributeInfoFlags FileAttributeStatus FileAttributeType FileCopyFlags FileCreateFlags FileMeasureFlags FileMeasureProgressCallback FileMonitorEvent FileMonitorFlags FileProgressCallback FileQueryInfoFlags FileReadMoreCallback FilesystemPreviewType FileType InputVector IOErrorEnum IOModuleScopeFlags IOSchedulerJobFunc IOStreamAdapter IOStreamSpliceFlags MemoryMonitorWarningLevel MountMountFlags MountOperationResult MountUnmountFlags NetworkConnectivity NotificationPriority OutputStreamSpliceFlags OutputVector PasswordSave PollableReturn PollableSourceFunc ReallocFunc ResolverError ResolverNameLookupFlags ResolverRecordType ResourceError ResourceFlags ResourceLookupFlags SettingsBindFlags SettingsBindGetMapping SettingsBindSetMapping SettingsGetMapping SimpleAsyncThreadFunc SocketClientEvent SocketFamily SocketListenerEvent SocketMsgFlags SocketProtocol SocketSourceFunc SocketType SubprocessFlags TaskThreadFunc TestDBusFlags TlsAuthenticationMode TlsCertificateFlags TlsCertificateRequestFlags TlsChannelBindingError TlsChannelBindingType TlsDatabaseLookupFlags TlsDatabaseVerifyFlags TlsError TlsInteractionResult TlsPasswordFlags TlsProtocolVersion TlsRehandshakeMode UnixSocketAddressType VfsFileLookupFunc ZlibCompressorFormat

Types 118

Type definition for a function that will be called back when an asynchronous operation within GIO has been completed. #GAsyncReadyCallback callbacks from #GTask are guaranteed to be invoked in a later iteration of the [thread-default main context][g-main-context-push-thread-default] where the #GTask was created. All other users of #GAsyncReadyCallback must likewise call it asynchronously in a later iteration of the main context.

The asynchronous operation is guaranteed to have held a reference to source_object from the time when the *_async() function was called, until after this callback returns.

Parameters

sourceObjectthe object the asynchronous operation was started with.
resa #GAsyncResult.
aliasBusAcquiredCallback = void delegate(gio.dbus_connection.DBusConnection connection, string name)

Invoked when a connection to a message bus has been obtained.

Parameters

connectionThe #GDBusConnection to a message bus.
nameThe name that is requested to be owned.
aliasBusNameAcquiredCallback = void delegate(gio.dbus_connection.DBusConnection connection, string name)

Invoked when the name is acquired.

Parameters

connectionThe #GDBusConnection on which to acquired the name.
nameThe name being owned.
aliasBusNameAppearedCallback = void delegate(gio.dbus_connection.DBusConnection connection, string name, string nameOwner)

Invoked when the name being watched is known to have to have an owner.

Parameters

connectionThe #GDBusConnection the name is being watched on.
nameThe name being watched.
nameOwnerUnique name of the owner of the name being watched.
aliasBusNameLostCallback = void delegate(gio.dbus_connection.DBusConnection connection, string name)

Invoked when the name is lost or connection has been closed.

Parameters

connectionThe #GDBusConnection on which to acquire the name or null if the connection was disconnected.
nameThe name being owned.
aliasBusNameVanishedCallback = void delegate(gio.dbus_connection.DBusConnection connection, string name)

Invoked when the name being watched is known not to have to have an owner.

This is also invoked when the #GDBusConnection on which the watch was established has been closed. In that case, connection will be null.

Parameters

connectionThe #GDBusConnection the name is being watched on, or null.
nameThe name being watched.
aliasCancellableSourceFunc = bool delegate(gio.cancellable.Cancellable cancellable)

This is the function type of the callback used for the #GSource returned by [gio.cancellable.Cancellable.sourceNew].

Parameters

cancellablethe #GCancellable

Returns

it should return false if the source should be removed.
aliasDBusInterfaceGetPropertyFunc = glib.variant.Variant delegate(gio.dbus_connection.DBusConnection connection, string sender, string objectPath, string interfaceName, string propertyName, glib.error.ErrorWrap error)

The type of the get_property function in #GDBusInterfaceVTable.

Parameters

connectionA #GDBusConnection.
senderThe unique bus name of the remote caller.
objectPathThe object path that the method was invoked on.
interfaceNameThe D-Bus interface name for the property.
propertyNameThe name of the property to get the value of.
errorReturn location for error.

Returns

A #GVariant with the value for property_name or null if

error is set. If the returned #GVariant is floating, it is consumed - otherwise its reference count is decreased by one.

aliasDBusInterfaceMethodCallFunc = void delegate(gio.dbus_connection.DBusConnection connection, string sender, string objectPath, string interfaceName, string methodName, glib.variant.Variant parameters, gio.dbus_method_invocation.DBusMethodInvocation invocation)

The type of the method_call function in #GDBusInterfaceVTable.

Parameters

connectionA #GDBusConnection.
senderThe unique bus name of the remote caller.
objectPathThe object path that the method was invoked on.
interfaceNameThe D-Bus interface name the method was invoked on.
methodNameThe name of the method that was invoked.
parametersA #GVariant tuple with parameters.
invocationA #GDBusMethodInvocation object that must be used to return a value or error.
aliasDBusInterfaceSetPropertyFunc = bool delegate(gio.dbus_connection.DBusConnection connection, string sender, string objectPath, string interfaceName, string propertyName, glib.variant.Variant value, glib.error.ErrorWrap error)

The type of the set_property function in #GDBusInterfaceVTable.

Parameters

connectionA #GDBusConnection.
senderThe unique bus name of the remote caller.
objectPathThe object path that the method was invoked on.
interfaceNameThe D-Bus interface name for the property.
propertyNameThe name of the property to get the value of.
valueThe value to set the property to.
errorReturn location for error.

Returns

true if the property was set to value, false if error is set.

Signature for function used in [gio.dbus_connection.DBusConnection.addFilter].

A filter function is passed a #GDBusMessage and expected to return a #GDBusMessage too. Passive filter functions that don't modify the message can simply return the message object:

static GDBusMessage *
passive_filter (GDBusConnection *connection
               GDBusMessage    *message,
               gboolean         incoming,
               gpointer         user_data)
{
 // inspect message
 return message;
}
Filter functions that wants to drop a message can simply return null:
static GDBusMessage *
drop_filter (GDBusConnection *connection
            GDBusMessage    *message,
            gboolean         incoming,
            gpointer         user_data)
{
 if (should_drop_message)
   {
     g_object_unref (message);
     message = NULL;
   }
 return message;
}
Finally, a filter function may modify a message by copying it:
static GDBusMessage *
modifying_filter (GDBusConnection *connection
                 GDBusMessage    *message,
                 gboolean         incoming,
                 gpointer         user_data)
{
 GDBusMessage *copy;
 GError *error;

 error = NULL;
 copy = g_dbus_message_copy (message, &error);
 // handle error being set
 g_object_unref (message);

 // modify copy

 return copy;
}
If the returned #GDBusMessage is different from message and cannot be sent on connection (it could use features, such as file descriptors, not compatible with connection), then a warning is logged to standard error. Applications can check this ahead of time using [gio.dbus_message.DBusMessage.toBlob] passing a #GDBusCapabilityFlags value obtained from connection.

Parameters

connectionA #GDBusConnection.
messageA locked #GDBusMessage that the filter function takes ownership of.
incomingtrue if it is a message received from the other peer, false if it is a message to be sent to the other peer.

Returns

A #GDBusMessage that will be freed with

[gobject.object.ObjectWrap.unref] or null to drop the message. Passive filter functions can simply return the passed message object.

aliasDBusProxyTypeFunc = gobject.types.GType delegate(gio.dbus_object_manager_client.DBusObjectManagerClient manager, string objectPath, string interfaceName)

Function signature for a function used to determine the #GType to use for an interface proxy (if interface_name is not null) or object proxy (if interface_name is null).

This function is called in the [thread-default main loop][g-main-context-push-thread-default] that manager was constructed in.

Parameters

managerA #GDBusObjectManagerClient.
objectPathThe object path of the remote object.
interfaceNameThe interface name of the remote object or null if a #GDBusObjectProxy #GType is requested.

Returns

A #GType to use for the remote object. The returned type

must be a #GDBusProxy or #GDBusObjectProxy -derived type.

aliasDBusSignalCallback = void delegate(gio.dbus_connection.DBusConnection connection, string senderName, string objectPath, string interfaceName, string signalName, glib.variant.Variant parameters)

Signature for callback function used in [gio.dbus_connection.DBusConnection.signalSubscribe].

Parameters

connectionA #GDBusConnection.
senderNameThe unique bus name of the sender of the signal, or null on a peer-to-peer D-Bus connection.
objectPathThe object path that the signal was emitted on.
interfaceNameThe name of the interface.
signalNameThe name of the signal.
parametersA #GVariant tuple with parameters for the signal.
aliasDBusSubtreeDispatchFunc = gio.types.DBusInterfaceVTable delegate(gio.dbus_connection.DBusConnection connection, string sender, string objectPath, string interfaceName, string node, out void * outUserData)

The type of the dispatch function in #GDBusSubtreeVTable.

Subtrees are flat. node, if non-null, is always exactly one segment of the object path (ie: it never contains a slash).

Parameters

connectionA #GDBusConnection.
senderThe unique bus name of the remote caller.
objectPathThe object path that was registered with [gio.dbus_connection.DBusConnection.registerSubtree].
interfaceNameThe D-Bus interface name that the method call or property access is for.
nodeA node that is a child of object_path (relative to object_path) or null for the root of the subtree.
outUserDataReturn location for user data to pass to functions in the returned #GDBusInterfaceVTable.

Returns

A #GDBusInterfaceVTable or null if you don't want to handle the methods.
aliasDBusSubtreeEnumerateFunc = string[] delegate(gio.dbus_connection.DBusConnection connection, string sender, string objectPath)

The type of the enumerate function in #GDBusSubtreeVTable.

This function is called when generating introspection data and also when preparing to dispatch incoming messages in the event that the [gio.types.DBusSubtreeFlags.DispatchToUnenumeratedNodes] flag is not specified (ie: to verify that the object path is valid).

Hierarchies are not supported; the items that you return should not contain the `/` character.

The return value will be freed with [glib.global.strfreev].

Parameters

connectionA #GDBusConnection.
senderThe unique bus name of the remote caller.
objectPathThe object path that was registered with [gio.dbus_connection.DBusConnection.registerSubtree].

Returns

A newly allocated array of strings for node names that are children of object_path.
aliasDBusSubtreeIntrospectFunc = gio.dbus_interface_info.DBusInterfaceInfo[] delegate(gio.dbus_connection.DBusConnection connection, string sender, string objectPath, string node)

The type of the introspect function in #GDBusSubtreeVTable.

Subtrees are flat. node, if non-null, is always exactly one segment of the object path (ie: it never contains a slash).

This function should return null to indicate that there is no object at this node.

If this function returns non-null, the return value is expected to be a null-terminated array of pointers to #GDBusInterfaceInfo structures describing the interfaces implemented by node. This array will have [gio.dbus_interface_info.DBusInterfaceInfo.unref] called on each item before being freed with [glib.global.gfree].

The difference between returning null and an array containing zero items is that the standard DBus interfaces will returned to the remote introspector in the empty array case, but not in the null case.

Parameters

connectionA #GDBusConnection.
senderThe unique bus name of the remote caller.
objectPathThe object path that was registered with [gio.dbus_connection.DBusConnection.registerSubtree].
nodeA node that is a child of object_path (relative to object_path) or null for the root of the subtree.

Returns

A null-terminated array of pointers to #GDBusInterfaceInfo, or null.

This is the function type of the callback used for the #GSource returned by [gio.datagram_based.DatagramBased.createSource].

Parameters

datagramBasedthe #GDatagramBased
conditionthe current condition at the source fired

Returns

[glib.types.SOURCE_REMOVE] if the source should be removed,

[glib.types.SOURCE_CONTINUE] otherwise

During invocation, [gio.desktop_app_info.DesktopAppInfo.launchUrisAsManager] may create one or more child processes. This callback is invoked once for each, providing the process ID.

Parameters

appinfoa #GDesktopAppInfo
pidProcess identifier
aliasFileMeasureProgressCallback = void delegate(bool reporting, ulong currentSize, ulong numDirs, ulong numFiles)

This callback type is used by [gio.file.File.measureDiskUsage] to make periodic progress reports when measuring the amount of disk spaced used by a directory.

These calls are made on a best-effort basis and not all types of #GFile will support them. At the minimum, however, one call will always be made immediately.

In the case that there is no support, reporting will be set to false (and the other values undefined) and no further calls will be made. Otherwise, the reporting will be true and the other values all-zeros during the first (immediate) call. In this way, you can know which type of progress UI to show without a delay.

For [gio.file.File.measureDiskUsage] the callback is made directly. For [gio.file.File.measureDiskUsageAsync] the callback is made via the default main context of the calling thread (ie: the same way that the final async result would be reported).

current_size is in the same units as requested by the operation (see [gio.types.FileMeasureFlags.ApparentSize]).

The frequency of the updates is implementation defined, but is ideally about once every 200ms.

The last progress callback may or may not be equal to the final result. Always check the async result to get the final value.

Parameters

reportingtrue if more reports will come
currentSizethe current cumulative size measurement
numDirsthe number of directories visited so far
numFilesthe number of non-directory files encountered
aliasFileProgressCallback = void delegate(long currentNumBytes, long totalNumBytes)

When doing file operations that may take a while, such as moving a file or copying a file, a progress callback is used to pass how far along that operation is to the application.

Parameters

currentNumBytesthe current number of bytes in the operation.
totalNumBytesthe total number of bytes in the operation.
aliasFileReadMoreCallback = bool delegate(string fileContents, long fileSize)

When loading the partial contents of a file with [gio.file.File.loadPartialContentsAsync], it may become necessary to determine if any more data from the file should be loaded. A #GFileReadMoreCallback function facilitates this by returning true if more data should be read, or false otherwise.

Parameters

fileContentsthe data as currently read.
fileSizethe size of the data currently read.

Returns

true if more data should be read back. false otherwise.

I/O Job function.

Long-running jobs should periodically check the cancellable to see if they have been cancelled.

Parameters

joba #GIOSchedulerJob.
cancellableoptional #GCancellable object, null to ignore.

Returns

true if this function should be called again to

complete the job, false if the job is complete (or cancelled)

Deprecated

Use [glib.thread_pool.ThreadPool] or

[gio.task.Task.runInThread]

aliasPollableSourceFunc = bool delegate(gobject.object.ObjectWrap pollableStream)

This is the function type of the callback used for the #GSource returned by [gio.pollable_input_stream.PollableInputStream.createSource] and [gio.pollable_output_stream.PollableOutputStream.createSource].

Parameters

pollableStreamthe #GPollableInputStream or #GPollableOutputStream

Returns

it should return false if the source should be removed.
aliasReallocFunc = void * delegate(size_t size)

Changes the size of the memory block pointed to by data to size bytes.

The function should have the same semantics as realloc().

Parameters

sizesize to reallocate data to

Returns

a pointer to the reallocated memory

The type for the function that is used to convert from #GSettings to an object property. The value is already initialized to hold values of the appropriate type.

Parameters

valuereturn location for the property value
variantthe #GVariant

Returns

true if the conversion succeeded, false in case of an error

The type for the function that is used to convert an object property value to a #GVariant for storing it in #GSettings.

Parameters

valuea #GValue containing the property value to map
expectedTypethe #GVariantType to create

Returns

a new #GVariant holding the data from value,

or null in case of an error

aliasSettingsGetMapping = bool delegate(glib.variant.Variant value, out void * result)

The type of the function that is used to convert from a value stored in a #GSettings to a value that is useful to the application.

If the value is successfully mapped, the result should be stored at result and true returned. If mapping fails (for example, if value is not in the right format) then false should be returned.

If value is null then it means that the mapping function is being given a "last chance" to successfully return a valid value. true must be returned in this case.

Parameters

valuethe #GVariant to map, or null
resultthe result of the mapping

Returns

true if the conversion succeeded, false in case of an error

Simple thread function that runs an asynchronous operation and checks for cancellation.

Parameters

resa #GSimpleAsyncResult.
objecta #GObject.
cancellableoptional #GCancellable object, null to ignore.
aliasSocketSourceFunc = bool delegate(gio.socket.Socket socket, glib.types.IOCondition condition)

This is the function type of the callback used for the #GSource returned by [gio.socket.Socket.createSource].

Parameters

socketthe #GSocket
conditionthe current condition at the source fired.

Returns

it should return false if the source should be removed.
aliasTaskThreadFunc = void delegate(gio.task.Task task, gobject.object.ObjectWrap sourceObject, gio.cancellable.Cancellable cancellable)

The prototype for a task function to be run in a thread via [gio.task.Task.runInThread] or [gio.task.Task.runInThreadSync].

If the return-on-cancel flag is set on task, and cancellable gets cancelled, then the #GTask will be completed immediately (as though [gio.task.Task.returnErrorIfCancelled] had been called), without waiting for the task function to complete. However, the task function will continue running in its thread in the background. The function therefore needs to be careful about how it uses externally-visible state in this case. See [gio.task.Task.setReturnOnCancel] for more details.

Other than in that case, task will be completed when the #GTaskThreadFunc returns, not when it calls a g_task_return_ function.

Parameters

taskthe #GTask
sourceObjecttask's source object
cancellabletask's #GCancellable, or null
aliasVfsFileLookupFunc = gio.file.File delegate(gio.vfs.Vfs vfs, string identifier)

This function type is used by [gio.vfs.Vfs.registerUriScheme] to make it possible for a client to associate an URI scheme to a different #GFile implementation.

The client should return a reference to the new file that has been created for uri, or null to continue with the default implementation.

Parameters

vfsa #GVfs
identifierthe identifier to look up a #GFile for. This can either be an URI or a parse name as returned by [gio.file.File.getParseName]

Returns

a #GFile for identifier.

Variables 130

enumvarDBUS_METHOD_INVOCATION_HANDLED = true

The value returned by handlers of the signals generated by the gdbus-codegen tool to indicate that a method call has been handled by an implementation. It is equal to true, but using this macro is sometimes more readable.

In code that needs to be backwards-compatible with older GLib, use true instead, often written like this:

g_dbus_method_invocation_return_error (invocation, ...);
 return TRUE;    // handled

enumvarDBUS_METHOD_INVOCATION_UNHANDLED = false

The value returned by handlers of the signals generated by the gdbus-codegen tool to indicate that a method call has not been handled by an implementation. It is equal to false, but using this macro is sometimes more readable.

In code that needs to be backwards-compatible with older GLib, use false instead.

enumvarDEBUG_CONTROLLER_EXTENSION_POINT_NAME = "gio-debug-controller"

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

enumvarDESKTOP_APP_INFO_LOOKUP_EXTENSION_POINT_NAME = "gio-desktop-app-info-lookup"

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

Deprecated

The #GDesktopAppInfoLookup interface is deprecated and

unused by GIO.

enumvarDRIVE_IDENTIFIER_KIND_UNIX_DEVICE = "unix-device"

The string used to obtain a Unix device path with [gio.drive.Drive.getIdentifier].

enumvarFILE_ATTRIBUTE_ACCESS_CAN_DELETE = "access::can-delete"

A key in the "access" namespace for checking deletion privileges.

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Boolean].

This attribute will be true if the user is able to delete the file.

enumvarFILE_ATTRIBUTE_ACCESS_CAN_EXECUTE = "access::can-execute"

A key in the "access" namespace for getting execution privileges.

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Boolean].

This attribute will be true if the user is able to execute the file.

enumvarFILE_ATTRIBUTE_ACCESS_CAN_READ = "access::can-read"

A key in the "access" namespace for getting read privileges.

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Boolean].

This attribute will be true if the user is able to read the file.

enumvarFILE_ATTRIBUTE_ACCESS_CAN_RENAME = "access::can-rename"

A key in the "access" namespace for checking renaming privileges.

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Boolean].

This attribute will be true if the user is able to rename the file.

enumvarFILE_ATTRIBUTE_ACCESS_CAN_TRASH = "access::can-trash"

A key in the "access" namespace for checking trashing privileges.

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Boolean].

This attribute will be true if the user is able to move the file to the trash.

enumvarFILE_ATTRIBUTE_ACCESS_CAN_WRITE = "access::can-write"

A key in the "access" namespace for getting write privileges.

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Boolean].

This attribute will be true if the user is able to write to the file.

enumvarFILE_ATTRIBUTE_DOS_IS_ARCHIVE = "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 #GFileAttributeType is [gio.types.FileAttributeType.Boolean].

enumvarFILE_ATTRIBUTE_DOS_IS_MOUNTPOINT = "dos::is-mountpoint"

A key in the "dos" namespace for checking if the file is a NTFS mount point (a volume mount or a junction point).

This attribute is true if file is a reparse point of type

IO_REPARSE_TAG_MOUNT_POINT.

This attribute is only available for DOS file systems.

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Boolean].

enumvarFILE_ATTRIBUTE_DOS_IS_SYSTEM = "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 #GFileAttributeType is [gio.types.FileAttributeType.Boolean].

enumvarFILE_ATTRIBUTE_DOS_REPARSE_POINT_TAG = "dos::reparse-point-tag"

A key in the "dos" namespace for getting the file NTFS reparse tag.

This value is 0 for files that are not reparse points.

See the Reparse Tags page for possible reparse tag values.

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Uint32].

enumvarFILE_ATTRIBUTE_ETAG_VALUE = "etag::value"

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

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.String].

enumvarFILE_ATTRIBUTE_FILESYSTEM_FREE = "filesystem::free"

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

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Uint64].

enumvarFILE_ATTRIBUTE_FILESYSTEM_READONLY = "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 #GFileAttributeType is [gio.types.FileAttributeType.Boolean].

enumvarFILE_ATTRIBUTE_FILESYSTEM_REMOTE = "filesystem::remote"

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 #GFileAttributeType is [gio.types.FileAttributeType.Boolean].

enumvarFILE_ATTRIBUTE_FILESYSTEM_SIZE = "filesystem::size"

A key in the "filesystem" namespace for getting the total size (in bytes) of the file system, used in [gio.file.File.queryFilesystemInfo].

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Uint64].

enumvarFILE_ATTRIBUTE_FILESYSTEM_TYPE = "filesystem::type"

A key in the "filesystem" namespace for getting the file system's type.

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.String].

enumvarFILE_ATTRIBUTE_FILESYSTEM_USED = "filesystem::used"

A key in the "filesystem" namespace for getting the number of bytes used by data on the file system.

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Uint64].

enumvarFILE_ATTRIBUTE_FILESYSTEM_USE_PREVIEW = "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.

enumvarFILE_ATTRIBUTE_GVFS_BACKEND = "gvfs::backend"

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

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.String].

enumvarFILE_ATTRIBUTE_ID_FILE = "id::file"

A key in the "id" namespace for getting a file identifier.

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.String].

An example use would be during listing files, to avoid recursive directory scanning.

enumvarFILE_ATTRIBUTE_ID_FILESYSTEM = "id::filesystem"

A key in the "id" namespace for getting the file system identifier.

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.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).

enumvarFILE_ATTRIBUTE_MOUNTABLE_CAN_EJECT = "mountable::can-eject"

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

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Boolean].

enumvarFILE_ATTRIBUTE_MOUNTABLE_CAN_MOUNT = "mountable::can-mount"

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

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Boolean].

enumvarFILE_ATTRIBUTE_MOUNTABLE_CAN_POLL = "mountable::can-poll"

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

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Boolean].

enumvarFILE_ATTRIBUTE_MOUNTABLE_CAN_START = "mountable::can-start"

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

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Boolean].

enumvarFILE_ATTRIBUTE_MOUNTABLE_CAN_START_DEGRADED = "mountable::can-start-degraded"

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

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Boolean].

enumvarFILE_ATTRIBUTE_MOUNTABLE_CAN_STOP = "mountable::can-stop"

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

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Boolean].

enumvarFILE_ATTRIBUTE_MOUNTABLE_CAN_UNMOUNT = "mountable::can-unmount"

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

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Boolean].

enumvarFILE_ATTRIBUTE_MOUNTABLE_HAL_UDI = "mountable::hal-udi"

A key in the "mountable" namespace for getting the HAL UDI for the mountable file.

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.String].

enumvarFILE_ATTRIBUTE_MOUNTABLE_IS_MEDIA_CHECK_AUTOMATIC = "mountable::is-media-check-automatic"

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

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Boolean].

enumvarFILE_ATTRIBUTE_MOUNTABLE_START_STOP_TYPE = "mountable::start-stop-type"

A key in the "mountable" namespace for getting the #GDriveStartStopType.

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Uint32].

enumvarFILE_ATTRIBUTE_MOUNTABLE_UNIX_DEVICE = "mountable::unix-device"

A key in the "mountable" namespace for getting the unix device.

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Uint32].

enumvarFILE_ATTRIBUTE_MOUNTABLE_UNIX_DEVICE_FILE = "mountable::unix-device-file"

A key in the "mountable" namespace for getting the unix device file.

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.String].

enumvarFILE_ATTRIBUTE_OWNER_GROUP = "owner::group"

A key in the "owner" namespace for getting the file owner's group.

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.String].

enumvarFILE_ATTRIBUTE_OWNER_USER = "owner::user"

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

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.String].

enumvarFILE_ATTRIBUTE_OWNER_USER_REAL = "owner::user-real"

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

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.String].

enumvarFILE_ATTRIBUTE_PREVIEW_ICON = "preview::icon"

A key in the "preview" namespace for getting a #GIcon that can be used to get preview of the file.

For example, it may be a low resolution thumbnail without metadata.

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Object].

The value for this key should contain a #GIcon.

enumvarFILE_ATTRIBUTE_RECENT_MODIFIED = "recent::modified"

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

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Int64].

enumvarFILE_ATTRIBUTE_SELINUX_CONTEXT = "selinux::context"

A key in the "selinux" namespace for getting the file's SELinux context.

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.String].

Note that this attribute is only available if GLib has been built with SELinux support.

enumvarFILE_ATTRIBUTE_STANDARD_ALLOCATED_SIZE = "standard::allocated-size"

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 #GFileAttributeType is [gio.types.FileAttributeType.Uint64].

enumvarFILE_ATTRIBUTE_STANDARD_CONTENT_TYPE = "standard::content-type"

A key in the "standard" namespace for getting the content type of the file.

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.String].

The value for this key should contain a valid content type.

enumvarFILE_ATTRIBUTE_STANDARD_COPY_NAME = "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 #GFileAttributeType is [gio.types.FileAttributeType.String].

enumvarFILE_ATTRIBUTE_STANDARD_DESCRIPTION = "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 further 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 #GFileAttributeType is [gio.types.FileAttributeType.String].

enumvarFILE_ATTRIBUTE_STANDARD_DISPLAY_NAME = "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 UTF-8 and can thus be displayed in the UI. It is guaranteed to be set on every file.

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.String].

enumvarFILE_ATTRIBUTE_STANDARD_EDIT_NAME = "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 #GFileAttributeType is [gio.types.FileAttributeType.String].

enumvarFILE_ATTRIBUTE_STANDARD_FAST_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 #GFileAttributeType is [gio.types.FileAttributeType.String].

enumvarFILE_ATTRIBUTE_STANDARD_ICON = "standard::icon"

A key in the "standard" namespace for getting the icon for the file.

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Object].

The value for this key should contain a #GIcon.

enumvarFILE_ATTRIBUTE_STANDARD_IS_BACKUP = "standard::is-backup"

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

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Boolean].

enumvarFILE_ATTRIBUTE_STANDARD_IS_HIDDEN = "standard::is-hidden"

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

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Boolean].

enumvarFILE_ATTRIBUTE_STANDARD_IS_SYMLINK = "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.

On Windows NTFS mountpoints are considered to be symlinks as well.

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Boolean].

enumvarFILE_ATTRIBUTE_STANDARD_IS_VIRTUAL = "standard::is-virtual"

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

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Boolean].

enumvarFILE_ATTRIBUTE_STANDARD_IS_VOLATILE = "standard::is-volatile"

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 [gio.types.FILE_ATTRIBUTE_STANDARD_SYMLINK_TARGET] for the persistent URI.

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Boolean].

enumvarFILE_ATTRIBUTE_STANDARD_NAME = "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. It is guaranteed to be set on every file.

Use [gio.types.FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME] if you need to display the name in a user interface.

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.ByteString].

enumvarFILE_ATTRIBUTE_STANDARD_SIZE = "standard::size"

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

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Uint64].

enumvarFILE_ATTRIBUTE_STANDARD_SORT_ORDER = "standard::sort-order"

A key in the "standard" namespace for setting the sort order of a file.

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.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.

enumvarFILE_ATTRIBUTE_STANDARD_SYMBOLIC_ICON = "standard::symbolic-icon"

A key in the "standard" namespace for getting the symbolic icon for the file.

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Object].

The value for this key should contain a #GIcon.

enumvarFILE_ATTRIBUTE_STANDARD_SYMLINK_TARGET = "standard::symlink-target"

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

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.ByteString].

enumvarFILE_ATTRIBUTE_STANDARD_TARGET_URI = "standard::target-uri"

A key in the "standard" namespace for getting the target URI for the file, in the case of [gio.types.FileType.Shortcut] or [gio.types.FileType.Mountable] files.

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.String].

enumvarFILE_ATTRIBUTE_STANDARD_TYPE = "standard::type"

A key in the "standard" namespace for storing file types.

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Uint32].

The value for this key should contain a #GFileType.

enumvarFILE_ATTRIBUTE_THUMBNAILING_FAILED = "thumbnail::failed"

A key in the "thumbnail" namespace for checking if thumbnailing failed.

This attribute is true if thumbnailing failed.

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Boolean].

enumvarFILE_ATTRIBUTE_THUMBNAILING_FAILED_LARGE = "thumbnail::failed-large"

A key in the "thumbnail" namespace for checking if thumbnailing failed for the large image.

This attribute is true if thumbnailing failed.

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Boolean].

enumvarFILE_ATTRIBUTE_THUMBNAILING_FAILED_NORMAL = "thumbnail::failed-normal"

A key in the "thumbnail" namespace for checking if thumbnailing failed for the normal image.

This attribute is true if thumbnailing failed.

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Boolean].

enumvarFILE_ATTRIBUTE_THUMBNAILING_FAILED_XLARGE = "thumbnail::failed-xlarge"

A key in the "thumbnail" namespace for checking if thumbnailing failed for the x-large image.

This attribute is true if thumbnailing failed.

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Boolean].

enumvarFILE_ATTRIBUTE_THUMBNAILING_FAILED_XXLARGE = "thumbnail::failed-xxlarge"

A key in the "thumbnail" namespace for checking if thumbnailing failed for the xx-large image.

This attribute is true if thumbnailing failed.

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Boolean].

enumvarFILE_ATTRIBUTE_THUMBNAIL_IS_VALID = "thumbnail::is-valid"

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 [gio.types.FILE_ATTRIBUTE_THUMBNAILING_FAILED] is true and this attribute is false, it indicates that thumbnailing may be attempted again and may succeed.

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Boolean].

enumvarFILE_ATTRIBUTE_THUMBNAIL_IS_VALID_LARGE = "thumbnail::is-valid-large"

A key in the "thumbnail" namespace for checking whether the large thumbnail is outdated.

This attribute is true if the large thumbnail is up-to-date with the file it represents, and false if the file has been modified since the thumbnail was generated.

If [gio.types.FILE_ATTRIBUTE_THUMBNAILING_FAILED_LARGE] is true and this attribute is false, it indicates that thumbnailing may be attempted again and may succeed.

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Boolean].

enumvarFILE_ATTRIBUTE_THUMBNAIL_IS_VALID_NORMAL = "thumbnail::is-valid-normal"

A key in the "thumbnail" namespace for checking whether the normal thumbnail is outdated.

This attribute is true if the normal thumbnail is up-to-date with the file it represents, and false if the file has been modified since the thumbnail was generated.

If [gio.types.FILE_ATTRIBUTE_THUMBNAILING_FAILED_NORMAL] is true and this attribute is false, it indicates that thumbnailing may be attempted again and may succeed.

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Boolean].

enumvarFILE_ATTRIBUTE_THUMBNAIL_IS_VALID_XLARGE = "thumbnail::is-valid-xlarge"

A key in the "thumbnail" namespace for checking whether the x-large thumbnail is outdated.

This attribute is true if the x-large thumbnail is up-to-date with the file it represents, and false if the file has been modified since the thumbnail was generated.

If [gio.types.FILE_ATTRIBUTE_THUMBNAILING_FAILED_XLARGE] is true and this attribute is false, it indicates that thumbnailing may be attempted again and may succeed.

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Boolean].

enumvarFILE_ATTRIBUTE_THUMBNAIL_IS_VALID_XXLARGE = "thumbnail::is-valid-xxlarge"

A key in the "thumbnail" namespace for checking whether the xx-large thumbnail is outdated.

This attribute is true if the x-large thumbnail is up-to-date with the file it represents, and false if the file has been modified since the thumbnail was generated.

If [gio.types.FILE_ATTRIBUTE_THUMBNAILING_FAILED_XXLARGE] is true and this attribute is false, it indicates that thumbnailing may be attempted again and may succeed.

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Boolean].

enumvarFILE_ATTRIBUTE_THUMBNAIL_PATH = "thumbnail::path"

A key in the "thumbnail" namespace for getting the path to the thumbnail image with the biggest size available.

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.ByteString].

enumvarFILE_ATTRIBUTE_THUMBNAIL_PATH_LARGE = "thumbnail::path-large"

A key in the "thumbnail" namespace for getting the path to the large thumbnail image.

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.ByteString].

enumvarFILE_ATTRIBUTE_THUMBNAIL_PATH_NORMAL = "thumbnail::path-normal"

A key in the "thumbnail" namespace for getting the path to the normal thumbnail image.

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.ByteString].

enumvarFILE_ATTRIBUTE_THUMBNAIL_PATH_XLARGE = "thumbnail::path-xlarge"

A key in the "thumbnail" namespace for getting the path to the x-large thumbnail image.

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.ByteString].

enumvarFILE_ATTRIBUTE_THUMBNAIL_PATH_XXLARGE = "thumbnail::path-xxlarge"

A key in the "thumbnail" namespace for getting the path to the xx-large thumbnail image.

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.ByteString].

enumvarFILE_ATTRIBUTE_TIME_ACCESS = "time::access"

A key in the "time" namespace for getting the time the file was last accessed.

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Uint64], and contains the time since the file was last accessed, in seconds since the UNIX epoch.

enumvarFILE_ATTRIBUTE_TIME_ACCESS_NSEC = "time::access-nsec"

A key in the "time" namespace for getting the nanoseconds of the time the file was last accessed. This should be used in conjunction with #G_FILE_ATTRIBUTE_TIME_ACCESS. Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Uint32].

enumvarFILE_ATTRIBUTE_TIME_ACCESS_USEC = "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 [gio.types.FILE_ATTRIBUTE_TIME_ACCESS].

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Uint32].

enumvarFILE_ATTRIBUTE_TIME_CHANGED = "time::changed"

A key in the "time" namespace for getting the time the file was last changed.

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Uint64], and contains the time since the file was last changed, in seconds since the UNIX epoch.

This corresponds to the traditional UNIX ctime.

enumvarFILE_ATTRIBUTE_TIME_CHANGED_NSEC = "time::changed-nsec"

A key in the "time" namespace for getting the nanoseconds of the time the file was last changed. This should be used in conjunction with #G_FILE_ATTRIBUTE_TIME_CHANGED. Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Uint32].

enumvarFILE_ATTRIBUTE_TIME_CHANGED_USEC = "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 [gio.types.FILE_ATTRIBUTE_TIME_CHANGED].

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Uint32].

enumvarFILE_ATTRIBUTE_TIME_CREATED = "time::created"

A key in the "time" namespace for getting the time the file was created.

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Uint64], and contains the time since the file was created, in seconds since the UNIX epoch.

This may correspond to Linux stx_btime, FreeBSD st_birthtim, NetBSD st_birthtime or NTFS ctime.

enumvarFILE_ATTRIBUTE_TIME_CREATED_NSEC = "time::created-nsec"

A key in the "time" namespace for getting the nanoseconds of the time the file was created. This should be used in conjunction with #G_FILE_ATTRIBUTE_TIME_CREATED. Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Uint32].

enumvarFILE_ATTRIBUTE_TIME_CREATED_USEC = "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 [gio.types.FILE_ATTRIBUTE_TIME_CREATED].

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Uint32].

enumvarFILE_ATTRIBUTE_TIME_MODIFIED = "time::modified"

A key in the "time" namespace for getting the time the file was last modified.

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Uint64], and contains the time since the file was modified, in seconds since the UNIX epoch.

enumvarFILE_ATTRIBUTE_TIME_MODIFIED_NSEC = "time::modified-nsec"

A key in the "time" namespace for getting the nanoseconds of the time the file was last modified. This should be used in conjunction with #G_FILE_ATTRIBUTE_TIME_MODIFIED. Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Uint32].

enumvarFILE_ATTRIBUTE_TIME_MODIFIED_USEC = "time::modified-usec"

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 [gio.types.FILE_ATTRIBUTE_TIME_MODIFIED].

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Uint32].

enumvarFILE_ATTRIBUTE_TRASH_DELETION_DATE = "trash::deletion-date"

A key in the "trash" namespace for getting the deletion date and time of a file inside the trash:/// folder.

The format of the returned string is YYYY-MM-DDThh:mm:ss.

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.String].

enumvarFILE_ATTRIBUTE_TRASH_ITEM_COUNT = "trash::item-count"

A key in the "trash" namespace for getting the number of (toplevel) items that are present in the trash:/// folder.

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Uint32].

enumvarFILE_ATTRIBUTE_TRASH_ORIG_PATH = "trash::orig-path"

A key in the "trash" namespace for getting the original path of a file inside the trash:/// folder before it was trashed.

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.ByteString].

enumvarFILE_ATTRIBUTE_UNIX_BLOCKS = "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 #GFileAttributeType is [gio.types.FileAttributeType.Uint64].

enumvarFILE_ATTRIBUTE_UNIX_BLOCK_SIZE = "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 #GFileAttributeType is [gio.types.FileAttributeType.Uint32].

enumvarFILE_ATTRIBUTE_UNIX_DEVICE = "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 #GFileAttributeType is [gio.types.FileAttributeType.Uint32].

enumvarFILE_ATTRIBUTE_UNIX_GID = "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 #GFileAttributeType is [gio.types.FileAttributeType.Uint32].

enumvarFILE_ATTRIBUTE_UNIX_INODE = "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 #GFileAttributeType is [gio.types.FileAttributeType.Uint64].

enumvarFILE_ATTRIBUTE_UNIX_IS_MOUNTPOINT = "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.

Since 2.58, `/` is considered to be a mount point.

This attribute is only available for UNIX file systems.

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Boolean].

enumvarFILE_ATTRIBUTE_UNIX_MODE = "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 the documentation for lstat(): this attribute is equivalent to the st_mode member of struct stat, and includes both the file type and permissions.

This attribute is only available for UNIX file systems.

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Uint32].

enumvarFILE_ATTRIBUTE_UNIX_NLINK = "unix::nlink"

A key in the "unix" namespace for getting the number of hard links for a file.

See the documentation for lstat().

This attribute is only available for UNIX file systems.

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Uint32].

enumvarFILE_ATTRIBUTE_UNIX_RDEV = "unix::rdev"

A key in the "unix" namespace for getting the device ID for the file (if it is a special file).

See the documentation for lstat().

This attribute is only available for UNIX file systems.

Corresponding #GFileAttributeType is [gio.types.FileAttributeType.Uint32].

enumvarFILE_ATTRIBUTE_UNIX_UID = "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 #GFileAttributeType is [gio.types.FileAttributeType.Uint32].

enumvarMEMORY_MONITOR_EXTENSION_POINT_NAME = "gio-memory-monitor"

Extension point for memory usage monitoring functionality. See [Extending GIO][extending-gio].

enumvarMENU_ATTRIBUTE_ACTION = "action"

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 [gio.menu_model.MenuModel.getItemAttribute] and [gio.menu_item.MenuItem.setAttribute].

enumvarMENU_ATTRIBUTE_ACTION_NAMESPACE = "action-namespace"

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

enumvarMENU_ATTRIBUTE_ICON = "icon"

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

The icon is stored in the format returned by [gio.icon.Icon.serialize].

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

enumvarMENU_ATTRIBUTE_LABEL = "label"

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

enumvarMENU_ATTRIBUTE_TARGET = "target"

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

See also [gio.menu_item.MenuItem.setActionAndTarget]

enumvarMENU_EXPORTER_MAX_SECTION_SIZE = 1000

The maximum number of entries in a menu section supported by [gio.dbus_connection.DBusConnection.exportMenuModel].

The exact value of the limit may change in future GLib versions.

enumvarMENU_LINK_SECTION = "section"

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 [gio.menu_item.MenuItem.setLink].

enumvarMENU_LINK_SUBMENU = "submenu"

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

See also [gio.menu_item.MenuItem.setLink].

enumvarNATIVE_VOLUME_MONITOR_EXTENSION_POINT_NAME = "gio-native-volume-monitor"
enumvarNETWORK_MONITOR_EXTENSION_POINT_NAME = "gio-network-monitor"

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

enumvarPOWER_PROFILE_MONITOR_EXTENSION_POINT_NAME = "gio-power-profile-monitor"

Extension point for power profile usage monitoring functionality. See [Extending GIO][extending-gio].

enumvarPROXY_EXTENSION_POINT_NAME = "gio-proxy"

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

enumvarPROXY_RESOLVER_EXTENSION_POINT_NAME = "gio-proxy-resolver"

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

enumvarSETTINGS_BACKEND_EXTENSION_POINT_NAME = "gsettings-backend"

Extension point for #GSettingsBackend functionality.

enumvarTLS_BACKEND_EXTENSION_POINT_NAME = "gio-tls-backend"

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

enumvarTLS_DATABASE_PURPOSE_AUTHENTICATE_CLIENT = "1.3.6.1.5.5.7.3.2"

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

enumvarTLS_DATABASE_PURPOSE_AUTHENTICATE_SERVER = "1.3.6.1.5.5.7.3.1"

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

enumvarVFS_EXTENSION_POINT_NAME = "gio-vfs"

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

enumvarVOLUME_IDENTIFIER_KIND_CLASS = "class"

The string used to obtain the volume class with [gio.volume.Volume.getIdentifier].

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

This is intended to be used by applications to classify #GVolume 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.

enumvarVOLUME_IDENTIFIER_KIND_HAL_UDI = "hal-udi"

The string used to obtain a Hal UDI with [gio.volume.Volume.getIdentifier].

Deprecated

Do not use, HAL is deprecated.
enumvarVOLUME_IDENTIFIER_KIND_LABEL = "label"

The string used to obtain a filesystem label with [gio.volume.Volume.getIdentifier].

enumvarVOLUME_IDENTIFIER_KIND_NFS_MOUNT = "nfs-mount"

The string used to obtain a NFS mount with [gio.volume.Volume.getIdentifier].

enumvarVOLUME_IDENTIFIER_KIND_UNIX_DEVICE = "unix-device"

The string used to obtain a Unix device path with [gio.volume.Volume.getIdentifier].

enumvarVOLUME_IDENTIFIER_KIND_UUID = "uuid"

The string used to obtain a UUID with [gio.volume.Volume.getIdentifier].

enumvarVOLUME_MONITOR_EXTENSION_POINT_NAME = "gio-volume-monitor"

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