Gio¶
API reference for the Gio namespace (version 2.0), generated from GObject-Introspection.
Classes¶
- Action —
GActionrepresents a single named action. The main interface to an action is that it can be activated with Action.activate. This results… - ActionEntry — This struct defines a single action. It is for use with ActionMap.add_action_entries. The order of the items in the structure are intended…
- ActionGroup —
GActionGrouprepresents a group of actions. Actions can be used to expose functionality in a structured way, either from one part of a… - ActionGroupInterface — The virtual function table for ActionGroup.
- ActionInterface — The virtual function table for Action.
- ActionMap —
GActionMapis an interface for action containers. TheGActionMapinterface is implemented by ActionGroup implementations that operate… - ActionMapInterface — The virtual function table for ActionMap.
- AppInfo — Information about an installed application and methods to launch it (with file arguments).
GAppInfoandGAppLaunchContextare used for… - AppInfoIface — Application Information interface, for operating system portability.
- AppInfoMonitor —
GAppInfoMonitormonitors application information for changes.GAppInfoMonitoris a very simple object used for monitoring the app info… - AppLaunchContext — Integrating the launch with the launching application. This is used to handle for instance startup notification and launching the new…
- AppLaunchContextClass
- AppLaunchContextPrivate
- Application —
GApplicationis the core class for application support. AGApplicationis the foundation of an application. It wraps some low-level… - ApplicationClass — Virtual function table for Application.
- ApplicationCommandLine —
GApplicationCommandLinerepresents a command-line invocation of an application. It is created by Application and emitted in the… - ApplicationCommandLineClass — The ApplicationCommandLineClass-struct contains private data only.
- ApplicationCommandLinePrivate
- ApplicationPrivate
- AsyncInitable —
GAsyncInitableis an interface for asynchronously initializable objects. This is the asynchronous version of Initable; it behaves the… - AsyncInitableIface — Provides an interface for asynchronous initializing object such that initialization may fail.
- AsyncResult —
GAsyncResultprovides a base class for implementing asynchronous function results. Asynchronous operations are broken up into two… - AsyncResultIface — Interface definition for AsyncResult.
- BufferedInputStream — Buffered input stream implements FilterInputStream and provides for buffered reads. By default,
GBufferedInputStream's buffer size is set… - BufferedInputStreamClass
- BufferedInputStreamPrivate
- BufferedOutputStream — Buffered output stream implements FilterOutputStream and provides for buffered writes. By default,
GBufferedOutputStream's buffer size is… - BufferedOutputStreamClass
- BufferedOutputStreamPrivate
- BytesIcon —
GBytesIconspecifies an image held in memory in a common format (usually PNG) to be used as icon. - Cancellable —
GCancellableallows operations to be cancelled.GCancellableis a thread-safe operation cancellation stack used throughout GIO to allow… - CancellableClass
- CancellablePrivate
- CharsetConverter —
GCharsetConverteris an implementation of Converter based onGLib.IConv. - CharsetConverterClass
- Converter —
GConverteris an interface for streaming conversions.GConverteris implemented by objects that convert binary data in various ways.… - ConverterIface — Provides an interface for converting data from one type to another type. The conversion can be stateful and may fail at any place.
- ConverterInputStream — Converter input stream implements InputStream and allows conversion of data of various types during reading. As of GLib 2.34,…
- ConverterInputStreamClass
- ConverterInputStreamPrivate
- ConverterOutputStream — Converter output stream implements OutputStream and allows conversion of data of various types during reading. As of GLib 2.34,…
- ConverterOutputStreamClass
- ConverterOutputStreamPrivate
- Credentials — The
GCredentialstype is a reference-counted wrapper for native credentials. The information inGCredentialsis typically used for… - CredentialsClass — Class structure for Credentials.
- DBusActionGroup —
GDBusActionGroupis an implementation of the ActionGroup interface.GDBusActionGroupcan be used as a proxy for an action group that is… - DBusAnnotationInfo — Information about an annotation.
- DBusArgInfo — Information about an argument for a method or a signal.
- DBusAuthObserver —
GDBusAuthObserverprovides a mechanism for participating in how a DBusServer (or a DBusConnection) authenticates remote peers. Simply… - DBusConnection — The
GDBusConnectiontype is used for D-Bus connections to remote peers such as a message buses. It is a low-level API that offers a lot… - DBusErrorEntry — Struct used in DBusError.register_error_domain.
- DBusInterface — Base type for D-Bus interfaces. The
GDBusInterfacetype is the base type for D-Bus interfaces both on the service side (see… - DBusInterfaceIface — Base type for D-Bus interfaces.
- DBusInterfaceInfo — Information about a D-Bus interface.
- DBusInterfaceSkeleton — Abstract base class for D-Bus interfaces on the service side.
- DBusInterfaceSkeletonClass — Class structure for DBusInterfaceSkeleton.
- DBusInterfaceSkeletonPrivate
- DBusInterfaceVTable — Virtual table for handling properties and method calls for a D-Bus interface. Since 2.38, if you want to handle getting/setting D-Bus…
- DBusMenuModel —
GDBusMenuModelis an implementation of MenuModel that can be used as a proxy for a menu model that is exported over D-Bus with… - DBusMessage — A type for representing D-Bus messages that can be sent or received on a DBusConnection.
- DBusMethodInfo — Information about a method on a D-Bus interface.
- DBusMethodInvocation — Instances of the
GDBusMethodInvocationclass are used when handling D-Bus method calls. It provides a way to asynchronously return… - DBusNodeInfo — Information about nodes in a remote object hierarchy.
- DBusObject — The
GDBusObjecttype is the base type for D-Bus objects on both the service side (see DBusObjectSkeleton) and the client side (see… - DBusObjectIface — Base object type for D-Bus objects.
- DBusObjectManager — The
GDBusObjectManagertype is the base type for service- and client-side implementations of the standardized… - DBusObjectManagerClient —
GDBusObjectManagerClientis used to create, monitor and delete object proxies for remote objects exported by a DBusObjectManagerServer… - DBusObjectManagerClientClass — Class structure for DBusObjectManagerClient.
- DBusObjectManagerClientPrivate
- DBusObjectManagerIface — Base type for D-Bus object managers.
- DBusObjectManagerServer —
GDBusObjectManagerServeris used to export DBusObject instances using the standardizedorg.freedesktop.DBus.ObjectManagerinterface.… - DBusObjectManagerServerClass — Class structure for DBusObjectManagerServer.
- DBusObjectManagerServerPrivate
- DBusObjectProxy — A
GDBusObjectProxyis an object used to represent a remote object with one or more D-Bus interfaces. Normally, you don’t instantiate a… - DBusObjectProxyClass — Class structure for DBusObjectProxy.
- DBusObjectProxyPrivate
- DBusObjectSkeleton — A
GDBusObjectSkeletoninstance is essentially a group of D-Bus interfaces. The set of exported interfaces on the object may be dynamic… - DBusObjectSkeletonClass — Class structure for DBusObjectSkeleton.
- DBusObjectSkeletonPrivate
- DBusPropertyInfo — Information about a D-Bus property on a D-Bus interface.
- DBusProxy —
GDBusProxyis a base class used for proxies to access a D-Bus interface on a remote object. AGDBusProxycan be constructed for both… - DBusProxyClass — Class structure for DBusProxy.
- DBusProxyPrivate
- DBusServer —
GDBusServeris a helper for listening to and accepting D-Bus connections. This can be used to create a new D-Bus server, allowing two… - DBusSignalInfo — Information about a signal on a D-Bus interface.
- DBusSubtreeVTable — Virtual table for handling subtrees registered with DBusConnection.register_subtree.
- DataInputStream — Data input stream implements InputStream and includes functions for reading structured data directly from a binary input stream.
- DataInputStreamClass
- DataInputStreamPrivate
- DataOutputStream — Data output stream implements OutputStream and includes functions for writing data directly to an output stream.
- DataOutputStreamClass
- DataOutputStreamPrivate
- DatagramBased — Interface for socket-like objects with datagram semantics. A
GDatagramBasedis a networking interface for representing datagram-based… - DatagramBasedInterface — Provides an interface for socket-like objects which have datagram semantics, following the Berkeley sockets API. The interface methods are…
- DebugController —
GDebugControlleris an interface to expose control of debugging features and debug output. It is implemented on Linux using… - DebugControllerDBus —
GDebugControllerDBusis an implementation of DebugController which exposes debug settings as a D-Bus object. It is a Initable object, and… - DebugControllerDBusClass — The virtual function table for DebugControllerDBus.
- DebugControllerInterface — The virtual function table for DebugController.
- Drive —
GDriverepresents a piece of hardware connected to the machine. It’s generally only created for removable hardware or hardware with… - DriveIface — Interface for creating Drive implementations.
- DtlsClientConnection —
GDtlsClientConnectionis the client-side subclass of DtlsConnection, representing a client-side DTLS connection. - DtlsClientConnectionInterface — vtable for a DtlsClientConnection implementation.
- DtlsConnection —
GDtlsConnectionis the base DTLS connection class type, which wraps a DatagramBased and provides DTLS encryption on top of it. Its… - DtlsConnectionInterface — Virtual method table for a DtlsConnection implementation.
- DtlsServerConnection —
GDtlsServerConnectionis the server-side subclass of DtlsConnection, representing a server-side DTLS connection. - DtlsServerConnectionInterface — vtable for a DtlsServerConnection implementation.
- Emblem —
GEmblemis an implementation of Icon that supports having an emblem, which is an icon with additional properties. It can than be added to… - EmblemClass
- EmblemedIcon —
GEmblemedIconis an implementation of Icon that supports adding an emblem to an icon. Adding multiple emblems to an icon is ensured via… - EmblemedIconClass
- EmblemedIconPrivate
- File —
GFileis a high level abstraction for manipulating files on a virtual file system.GFiles are lightweight, immutable objects that do no… - FileAttributeInfo — Information about a specific attribute.
- FileAttributeInfoList — Acts as a lightweight registry for possible valid file attributes. The registry stores Key-Value pair formats as
GFileAttributeInfos. - FileAttributeMatcher — Determines if a string matches a file attribute.
- FileEnumerator —
GFileEnumeratorallows you to operate on a set of File objects, returning a FileInfo structure for each file enumerated (e.g.… - FileEnumeratorClass
- FileEnumeratorPrivate
- FileIOStream —
GFileIOStreamprovides I/O streams that both read and write to the same file handle.GFileIOStreamimplements Seekable, which allows… - FileIOStreamClass
- FileIOStreamPrivate
- FileIcon —
GFileIconspecifies an icon by pointing to an image file to be used as icon. It implements LoadableIcon. - FileIconClass
- FileIface — An interface for writing VFS file handles.
- FileInfo — Stores information about a file system object referenced by a File. Functionality for manipulating basic metadata for files.
GFileInfo… - FileInfoClass
- FileInputStream —
GFileInputStreamprovides input streams that take their content from a file.GFileInputStreamimplements Seekable, which allows the… - FileInputStreamClass
- FileInputStreamPrivate
- FileMonitor — Monitors a file or directory for changes. To obtain a
GFileMonitorfor a file or directory, use File.monitor, File.monitor_file, or… - FileMonitorClass
- FileMonitorPrivate
- FileOutputStream —
GFileOutputStreamprovides output streams that write their content to a file.GFileOutputStreamimplements Seekable, which allows the… - FileOutputStreamClass
- FileOutputStreamPrivate
- FilenameCompleter — Completes partial file and directory names given a partial string by looking in the file system for clues. Can return a list of possible…
- FilenameCompleterClass
- FilterInputStream — Base class for input stream implementations that perform some kind of filtering operation on a base stream. Typical examples of filtering…
- FilterInputStreamClass
- FilterOutputStream — Base class for output stream implementations that perform some kind of filtering operation on a base stream. Typical examples of filtering…
- FilterOutputStreamClass
- IOExtension — IOExtension is an opaque data structure and can only be accessed using the following functions.
- IOExtensionPoint —
GIOExtensionPointprovides a mechanism for modules to extend the functionality of the library or application that loaded it in an… - IOModule — Provides an interface and default functions for loading and unloading modules. This is used internally to make GIO extensible, but can also…
- IOModuleClass
- IOModuleScope — Represents a scope for loading IO modules. A scope can be used for blocking duplicate modules, or blocking a module you don't want to load.…
- IOSchedulerJob — Opaque class for defining and scheduling IO jobs.
- IOStream —
GIOStreamrepresents an object that has both read and write streams. Generally the two streams act as separate input and output streams,… - IOStreamAdapter
- IOStreamClass
- IOStreamPrivate
- IPTosMessage — Contains the type of service (ToS) byte of an IPv4 header. This consists of the DSCP field as per RFC 2474, and the ECN field as per RFC…
- IPTosMessageClass
- IPv6TclassMessage — Contains the Traffic Class byte of an IPv6 header. This consists of the DSCP field as per RFC 2474, and the ECN field as per RFC 3168. It…
- IPv6TclassMessageClass
- Icon —
GIconis a very minimal interface for icons. It provides functions for checking the equality of two icons, hashing of icons and… - IconIface — GIconIface is used to implement GIcon types for various different systems. See ThemedIcon and LoadableIcon for examples of how to implement…
- InetAddress —
GInetAddressrepresents an IPv4 or IPv6 internet address. Use Resolver.lookup_by_name or Resolver.lookup_by_name_async to look up the… - InetAddressClass
- InetAddressMask —
GInetAddressMaskrepresents a range of IPv4 or IPv6 addresses described by a base address and a length indicating how many bits of the… - InetAddressMaskClass
- InetAddressMaskPrivate
- InetAddressPrivate
- InetSocketAddress — An IPv4 or IPv6 socket address. That is, the combination of a InetAddress and a port number. In UNIX terms,
GInetSocketAddress… - InetSocketAddressClass
- InetSocketAddressPrivate
- Initable —
GInitableis implemented by objects that can fail during initialization. If an object implements this interface then it must be… - InitableIface — Provides an interface for initializing object such that initialization may fail.
- InputMessage — Structure used for scatter/gather data input when receiving multiple messages or packets in one go. You generally pass in an array of empty…
- InputStream —
GInputStreamis a base class for implementing streaming input. It has functions to read from a stream (InputStream.read), to close a… - InputStreamClass
- InputStreamPrivate
- InputVector — Structure used for scatter/gather data input. You generally pass in an array of
GInputVectorsand the operation will store the read data… - ListModel —
GListModelis an interface that represents a mutable list of GObject.Object. Its main intention is as a model for various widgets in user… - ListModelInterface — The virtual function table for ListModel.
- ListStore —
GListStoreis a simple implementation of ListModel that stores all items in memory. It provides insertions, deletions, and lookups in… - ListStoreClass
- LoadableIcon —
GLoadableIconextends the Icon interface and adds the ability to load icons from streams. - LoadableIconIface — Interface for icons that can be loaded as a stream.
- MemoryInputStream —
GMemoryInputStreamis a class for using arbitrary memory chunks as input for GIO streaming input operations. As of GLib 2.34,… - MemoryInputStreamClass
- MemoryInputStreamPrivate
- MemoryMonitor —
GMemoryMonitorwill monitor system memory and suggest to the application when to free memory so as to leave more room for other… - MemoryMonitorInterface — The virtual function table for MemoryMonitor.
- MemoryOutputStream —
GMemoryOutputStreamis a class for using arbitrary memory chunks as output for GIO streaming output operations. As of GLib 2.34,… - MemoryOutputStreamClass
- MemoryOutputStreamPrivate
- Menu —
GMenuis a simple implementation of MenuModel. You populate aGMenuby adding MenuItem instances to it. There are some convenience… - MenuAttributeIter — MenuAttributeIter is an opaque structure type. You must access it using the functions below.
- MenuAttributeIterClass
- MenuAttributeIterPrivate
- MenuItem — MenuItem is an opaque structure type. You must access it using the functions below.
- MenuLinkIter — MenuLinkIter is an opaque structure type. You must access it using the functions below.
- MenuLinkIterClass
- MenuLinkIterPrivate
- MenuModel —
GMenuModelrepresents the contents of a menu — an ordered list of menu items. The items are associated with actions, which can be… - MenuModelClass
- MenuModelPrivate
- Mount — The
GMountinterface represents a user-visible mount, such as a mounted file system.GMountis a ‘mounted’ filesystem that you can… - MountIface — Interface for implementing operations for mounts.
- MountOperation —
GMountOperationprovides a mechanism for interacting with the user. It can be used for authenticating mountable operations, such as loop… - MountOperationClass
- MountOperationPrivate
- NativeSocketAddress — A socket address of some unknown native type. This corresponds to a general
struct sockaddrof a type not otherwise handled by GLib. - NativeSocketAddressClass
- NativeSocketAddressPrivate
- NativeVolumeMonitor
- NativeVolumeMonitorClass
- NetworkAddress —
GNetworkAddressprovides an easy way to resolve a hostname and then attempt to connect to that host, handling the possibility of multiple… - NetworkAddressClass
- NetworkAddressPrivate
- NetworkMonitor —
GNetworkMonitorprovides an easy-to-use cross-platform API for monitoring network connectivity. On Linux, the available implementations… - NetworkMonitorInterface — The virtual function table for NetworkMonitor.
- NetworkService — Like NetworkAddress does with hostnames,
GNetworkServiceprovides an easy way to resolve a SRV record, and then attempt to connect to one… - NetworkServiceClass
- NetworkServicePrivate
- Notification —
GNotificationis a mechanism for creating a notification to be shown to the user — typically as a pop-up notification presented by the… - OutputMessage — Structure used for scatter/gather data output when sending multiple messages or packets in one go. You generally pass in an array of…
- OutputStream —
GOutputStreamis a base class for implementing streaming output. It has functions to write to a stream (OutputStream.write), to close a… - OutputStreamClass
- OutputStreamPrivate
- OutputVector — Structure used for scatter/gather data output. You generally pass in an array of
GOutputVectorsand the operation will use all the… - Permission — A
GPermissionrepresents the status of the caller’s permission to perform a certain action. You can query if the action is currently… - PermissionClass
- PermissionPrivate
- PollableInputStream —
GPollableInputStreamis implemented by InputStreams that can be polled for readiness to read. This can be used when interfacing with a… - PollableInputStreamInterface — The interface for pollable input streams. The default implementation of
can_pollalways returnsTrue. The default implementation of… - PollableOutputStream —
GPollableOutputStreamis implemented by OutputStreams that can be polled for readiness to write. This can be used when interfacing with a… - PollableOutputStreamInterface — The interface for pollable output streams. The default implementation of
can_pollalways returnsTrue. The default implementation of… - PowerProfileMonitor —
GPowerProfileMonitormakes it possible for applications as well as OS components to monitor system power profiles and act upon them. It… - PowerProfileMonitorInterface — The virtual function table for PowerProfileMonitor.
- PropertyAction — A
GPropertyActionis a way to get a Action with a state value reflecting and controlling the value of a GObject.Object property. The… - Proxy — A
GProxyhandles connecting to a remote host via a given type of proxy server. It is implemented by thegio-proxyextension point. The… - ProxyAddress — A InetSocketAddress representing a connection via a proxy server.
- ProxyAddressClass — Class structure for ProxyAddress.
- ProxyAddressEnumerator —
GProxyAddressEnumeratoris a wrapper around SocketAddressEnumerator which takes the SocketAddress instances returned by the… - ProxyAddressEnumeratorClass — Class structure for ProxyAddressEnumerator.
- ProxyAddressEnumeratorPrivate
- ProxyAddressPrivate
- ProxyInterface — Provides an interface for handling proxy connection and payload.
- ProxyResolver —
GProxyResolverprovides synchronous and asynchronous network proxy resolution.GProxyResolveris used within SocketClient through the… - ProxyResolverInterface — The virtual function table for ProxyResolver.
- RemoteActionGroup — The
GRemoteActionGroupinterface is implemented by ActionGroup instances that either transmit action invocations to other processes or… - RemoteActionGroupInterface — The virtual function table for RemoteActionGroup.
- Resolver — The object that handles DNS resolution. Use Resolver.get_default to get the default resolver.
GResolverprovides cancellable synchronous… - ResolverClass
- ResolverPrivate
- Resource — Applications and libraries often contain binary or textual data that is really part of the application, rather than user data. For instance…
- Seekable —
GSeekableis implemented by streams (implementations of InputStream or OutputStream) that support seeking. Seekable streams largely fall… - SeekableIface — Provides an interface for implementing seekable functionality on I/O Streams.
- Settings — The
GSettingsclass provides a convenient API for storing and retrieving application settings. Reads and writes can be considered to be… - SettingsBackend — The
GSettingsBackendinterface defines a generic interface for non-strictly-typed data that is stored in a hierarchy. To implement an… - SettingsBackendClass — Class structure for SettingsBackend.
- SettingsBackendPrivate
- SettingsClass
- SettingsPrivate
- SettingsSchema — The SettingsSchemaSource and
GSettingsSchemaAPIs provide a mechanism for advanced control over the loading of schemas and a mechanism… - SettingsSchemaKey — SettingsSchemaKey is an opaque data structure and can only be accessed using the following functions.
- SettingsSchemaSource — This is an opaque structure type. You may not access it directly.
- SimpleAction — A
GSimpleActionis the obvious simple implementation of the Action interface. This is the easiest way to create an action for purposes of… - SimpleActionGroup —
GSimpleActionGroupis a hash table filled with Action objects, implementing the ActionGroup and ActionMap interfaces. - SimpleActionGroupClass
- SimpleActionGroupPrivate
- SimpleAsyncResult — As of GLib 2.46,
GSimpleAsyncResultis deprecated in favor of Task, which provides a simpler API.GSimpleAsyncResultimplements… - SimpleAsyncResultClass
- SimpleIOStream —
GSimpleIOStreamcreates a IOStream from an arbitrary InputStream and OutputStream. This allows any pair of input and output streams to be… - SimplePermission —
GSimplePermissionis a trivial implementation of Permission that represents a permission that is either always or never allowed. The… - SimpleProxyResolver —
GSimpleProxyResolveris a simple ProxyResolver implementation that handles a single default proxy, multiple URI-scheme-specific proxies,… - SimpleProxyResolverClass
- SimpleProxyResolverPrivate
- Socket — A
GSocketis a low-level networking primitive. It is a more or less direct mapping of the BSD socket API in a portable GObject based API.… - SocketAddress —
GSocketAddressis the equivalent of struct sockaddr) and its subtypes in the BSD sockets API. This is an abstract class; use… - SocketAddressClass
- SocketAddressEnumerator —
GSocketAddressEnumeratoris an enumerator type for SocketAddress instances. It is returned by enumeration functions such as… - SocketAddressEnumeratorClass — Class structure for SocketAddressEnumerator.
- SocketClass
- SocketClient —
GSocketClientis a lightweight high-level utility class for connecting to a network host using a connection oriented socket type. You… - SocketClientClass
- SocketClientPrivate
- SocketConnectable — Objects that describe one or more potential socket endpoints implement
GSocketConnectable. Callers can then use… - SocketConnectableIface — Provides an interface for returning a SocketAddressEnumerator and ProxyAddressEnumerator
- SocketConnection —
GSocketConnectionis a IOStream for a connected socket. They can be created either by SocketClient when connecting to a host, or by… - SocketConnectionClass
- SocketConnectionPrivate
- SocketControlMessage — A
GSocketControlMessageis a special-purpose utility message that can be sent to or received from a Socket. These types of messages are… - SocketControlMessageClass — Class structure for SocketControlMessage.
- SocketControlMessagePrivate
- SocketListener — A
GSocketListeneris an object that keeps track of a set of server sockets and helps you accept sockets from any of the socket, either… - SocketListenerClass — Class structure for SocketListener.
- SocketListenerPrivate
- SocketPrivate
- SocketService — A
GSocketServiceis an object that represents a service that is provided to the network or over local sockets. When a new connection is… - SocketServiceClass — Class structure for SocketService.
- SocketServicePrivate
- SrvTarget — A single target host/port that a network service is running on. SRV (service) records are used by some network protocols to provide…
- StaticResource —
GStaticResourceis an opaque data structure and can only be accessed using the following functions. - Subprocess —
GSubprocessallows the creation of and interaction with child processes. Processes can be communicated with using standard GIO-style APIs… - SubprocessLauncher — This class contains a set of options for launching child processes, such as where its standard input and output will be directed, the…
- Task — A
GTaskrepresents and manages a cancellable ‘task’. #### Asynchronous operations The most common usage ofGTaskis as a AsyncResult,… - TaskClass
- TcpConnection — This is the subclass of SocketConnection that is created for TCP/IP sockets.
- TcpConnectionClass
- TcpConnectionPrivate
- TcpWrapperConnection — A
GTcpWrapperConnectioncan be used to wrap a IOStream that is based on a Socket, but which is not actually a SocketConnection. This is… - TcpWrapperConnectionClass
- TcpWrapperConnectionPrivate
- TestDBus — A helper class for testing code which uses D-Bus without touching the user’s session bus. Note that
GTestDBusmodifies the user’s… - ThemedIcon —
GThemedIconis an implementation of Icon that supports icon themes.GThemedIconcontains a list of all of the icons present in an icon… - ThemedIconClass
- ThreadedResolver — ThreadedResolver is an implementation of Resolver which calls the libc lookup functions in threads to allow them to run asynchronously.
- ThreadedResolverClass
- ThreadedSocketService — A
GThreadedSocketServiceis a simple subclass of SocketService that handles incoming connections by creating a worker thread and… - ThreadedSocketServiceClass
- ThreadedSocketServicePrivate
- TlsBackend — TLS (Transport Layer Security, aka SSL) and DTLS backend. This is an internal type used to coordinate the different classes implemented by…
- TlsBackendInterface — Provides an interface for describing TLS-related types.
- TlsCertificate — A certificate used for TLS authentication and encryption. This can represent either a certificate only (eg, the certificate received by a…
- TlsCertificateClass
- TlsCertificatePrivate
- TlsClientConnection —
GTlsClientConnectionis the client-side subclass of TlsConnection, representing a client-side TLS connection. - TlsClientConnectionInterface — vtable for a TlsClientConnection implementation.
- TlsConnection —
GTlsConnectionis the base TLS connection class type, which wraps a IOStream and provides TLS encryption on top of it. Its subclasses,… - TlsConnectionClass — The class structure for the TlsConnection type.
- TlsConnectionPrivate
- TlsDatabase —
GTlsDatabaseis used to look up certificates and other information from a certificate or key store. It is an abstract base class which… - TlsDatabaseClass — The class for TlsDatabase. Derived classes should implement the various virtual methods. _async and _finish methods have a default…
- TlsDatabasePrivate
- TlsFileDatabase —
GTlsFileDatabaseis implemented by TlsDatabase objects which load their certificate information from a file. It is an interface which TLS… - TlsFileDatabaseInterface — Provides an interface for TlsFileDatabase implementations.
- TlsInteraction —
GTlsInteractionprovides a mechanism for the TLS connection and database code to interact with the user. It can be used to ask the user… - TlsInteractionClass — The class for TlsInteraction. Derived classes implement the various virtual interaction methods to handle TLS interactions. Derived classes…
- TlsInteractionPrivate
- TlsPassword — An abstract interface representing a password used in TLS. Often used in user interaction such as unlocking a key storage token.
- TlsPasswordClass — Class structure for TlsPassword.
- TlsPasswordPrivate
- TlsServerConnection —
GTlsServerConnectionis the server-side subclass of TlsConnection, representing a server-side TLS connection. - TlsServerConnectionInterface — vtable for a TlsServerConnection implementation.
- UnixConnection — This is the subclass of SocketConnection that is created for UNIX domain sockets. It contains functions to do some of the UNIX socket…
- UnixConnectionClass
- UnixConnectionPrivate
- UnixCredentialsMessage — This SocketControlMessage contains a Credentials instance. It may be sent using Socket.send_message and received using…
- UnixCredentialsMessageClass — Class structure for UnixCredentialsMessage.
- UnixCredentialsMessagePrivate
- UnixFDList — A
GUnixFDListcontains a list of file descriptors. It owns the file descriptors that it contains, closing them when finalized. It may be… - UnixFDListClass
- UnixFDListPrivate
- UnixSocketAddress — Support for UNIX-domain (also known as local) sockets, corresponding to
struct sockaddr_un. UNIX domain sockets are generally visible in… - UnixSocketAddressClass
- UnixSocketAddressPrivate
- Vfs — Entry point for using GIO functionality.
- VfsClass
- Volume — The
GVolumeinterface represents user-visible objects that can be mounted. For example, a file system partition on a USB flash drive, or… - VolumeIface — Interface for implementing operations for mountable volumes.
- VolumeMonitor —
GVolumeMonitoris for listing the user interesting devices and volumes on the computer. In other words, what a file selector or file… - VolumeMonitorClass
- ZlibCompressor —
GZlibCompressoris an implementation of Converter that compresses data using zlib. - ZlibCompressorClass
- ZlibDecompressor —
GZlibDecompressoris an implementation of Converter that decompresses data compressed with zlib. - ZlibDecompressorClass
Functions¶
bus_get¶
def bus_get(bus_type: BusType | int, cancellable: Cancellable | None = ..., callback: AsyncReadyCallback | None = ...) -> None
Asynchronously connects to the message bus specified by bus_type.
When the operation is finished, callback will be invoked. You can
then call bus_get_finish to get the result of the operation.
This is an asynchronous failable function. See bus_get_sync for
the synchronous version.
Parameters:
bus_type— aBusTypecancellable— aCancellableorNonecallback— aGAsyncReadyCallbackto call when the request is satisfied
bus_get_finish¶
Finishes an operation started with bus_get.
The returned object is a singleton, that is, shared with other
callers of bus_get and bus_get_sync for bus_type. In the
event that you need a private message bus connection, use
dbus_address_get_for_bus_sync and
DBusConnection.new_for_address with
G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT and
G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION flags.
Note that the returned DBusConnection object will (usually) have
the DBusConnection:exit-on-close property set to True.
Parameters:
res— aAsyncResultobtained from theGAsyncReadyCallbackpassed tobus_get
bus_get_sync¶
Synchronously connects to the message bus specified by bus_type.
Note that the returned object may shared with other callers,
e.g. if two separate parts of a process calls this function with
the same bus_type, they will share the same object.
This is a synchronous failable function. See bus_get and
bus_get_finish for the asynchronous version.
The returned object is a singleton, that is, shared with other
callers of bus_get and bus_get_sync for bus_type. In the
event that you need a private message bus connection, use
dbus_address_get_for_bus_sync and
DBusConnection.new_for_address with
G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT and
G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION flags.
Note that the returned DBusConnection object will (usually) have
the DBusConnection:exit-on-close property set to True.
Parameters:
bus_type— aBusTypecancellable— aCancellableorNone
bus_own_name¶
def bus_own_name(bus_type: BusType | int, name: str, flags: BusNameOwnerFlags | int, bus_acquired_handler: BusAcquiredCallback | None = ..., name_acquired_handler: BusNameAcquiredCallback | None = ..., name_lost_handler: BusNameLostCallback | None = ...) -> int
Requests ownership of name on the bus specified by bus_type.
It asynchronously calls name_acquired_handler and name_lost_handler when
the name is acquired and lost, respectively.
Callbacks will be invoked in the thread-default
main context (see GLib.MainContext.push_thread_default)
of the thread you are calling this function from.
You are guaranteed that one of the name_acquired_handler and name_lost_handler
callbacks will be invoked after calling this function — there are three
possible cases:
name_lost_handlerwith aNULLconnection (if a connection to the bus can’t be made).bus_acquired_handlerthenname_lost_handler(if the name can’t be obtained).bus_acquired_handlerthenname_acquired_handler(if the name was obtained).
When you are done owning the name, call bus_unown_name with the
owner ID this function returns.
If the name is acquired or lost (for example another application
could acquire the name if you allow replacement or the application
currently owning the name exits), the handlers are also invoked.
If the DBusConnection that is used for attempting to own the name
closes, then name_lost_handler is invoked since it is no longer
possible for other processes to access the process.
You cannot use bus_own_name several times for the same name (unless
interleaved with calls to bus_unown_name) — only the first call
will work.
Another guarantee is that invocations of name_acquired_handler
and name_lost_handler are guaranteed to alternate; that
is, if name_acquired_handler is invoked then you are
guaranteed that the next time one of the handlers is invoked, it
will be name_lost_handler. The reverse is also true.
If you plan on exporting objects (using, for example,
DBusConnection.register_object), note that it is generally too late
to export the objects in name_acquired_handler. Instead, you can do this
in bus_acquired_handler since you are guaranteed that this will run
before name is requested from the bus.
This behavior makes it very simple to write applications that want
to own names and export objects.
Simply register objects to be exported in bus_acquired_handler and
unregister the objects (if any) in name_lost_handler.
Parameters:
bus_type— the type of bus to own a name onname— the well-known name to ownflags— a set of flags with ownership optionsbus_acquired_handler— handler to invoke when connected to the bus of typebus_type, orNULLto ignorename_acquired_handler— handler to invoke whennameis acquired, orNULLto ignorename_lost_handler— handler to invoke whennameis lost, orNULLto ignore
bus_own_name_on_connection¶
def bus_own_name_on_connection(connection: DBusConnection, name: str, flags: BusNameOwnerFlags | int, name_acquired_handler: BusNameAcquiredCallback | None = ..., name_lost_handler: BusNameLostCallback | None = ...) -> int
Like bus_own_name but takes a DBusConnection instead
of a BusType.
Parameters:
connection— a bus connectionname— the well-known name to ownflags— a set of flags with ownership optionsname_acquired_handler— handler to invoke whennameis acquired, orNULLto ignorename_lost_handler— handler to invoke whennameis lost, orNULLto ignore
bus_own_name_on_connection_with_closures¶
def bus_own_name_on_connection_with_closures(connection: DBusConnection, name: str, flags: BusNameOwnerFlags | int, name_acquired_closure: GObject.Closure | None = ..., name_lost_closure: GObject.Closure | None = ...) -> int
Version of bus_own_name_on_connection using closures instead of
callbacks for easier binding in other languages.
Parameters:
connection— a bus connectionname— the well-known name to ownflags— a set of flags with ownership optionsname_acquired_closure— closure to invoke whennameis acquired, orNULLto ignorename_lost_closure— closure to invoke whennameis lost, orNULLto ignore
bus_own_name_with_closures¶
def bus_own_name_with_closures(bus_type: BusType | int, name: str, flags: BusNameOwnerFlags | int, bus_acquired_closure: GObject.Closure | None = ..., name_acquired_closure: GObject.Closure | None = ..., name_lost_closure: GObject.Closure | None = ...) -> int
Version of [funcGio.bus_own_name using closures instead of callbacks for
easier binding in other languages.
Parameters:
bus_type— the type of bus to own a name onname— the well-known name to ownflags— a set of flags with ownership optionsbus_acquired_closure— closure to invoke when connected to the bus of typebus_type, orNULLto ignorename_acquired_closure— closure to invoke whennameis acquired, orNULLto ignorename_lost_closure— closure to invoke whennameis lost, orNULLto ignore
bus_unown_name¶
Stops owning a name.
Note that there may still be D-Bus traffic to process (relating to owning
and unowning the name) in the current thread-default
GLib.MainContext after this function has returned. You should
continue to iterate the GLib.MainContext until the
GLib.DestroyNotify function passed to bus_own_name is
called, in order to avoid memory leaks through callbacks queued on the
GLib.MainContext after it’s stopped being iterated.
Parameters:
owner_id— an identifier obtained frombus_own_name
bus_unwatch_name¶
Stops watching a name.
Note that there may still be D-Bus traffic to process (relating to watching
and unwatching the name) in the current thread-default GLib.MainContext after
this function has returned. You should continue to iterate the GLib.MainContext
until the GDestroyNotify function passed to bus_watch_name is called, in
order to avoid memory leaks through callbacks queued on the GLib.MainContext
after it’s stopped being iterated.
Parameters:
watcher_id— An identifier obtained frombus_watch_name
bus_watch_name¶
def bus_watch_name(bus_type: BusType | int, name: str, flags: BusNameWatcherFlags | int, name_appeared_handler: BusNameAppearedCallback | None = ..., name_vanished_handler: BusNameVanishedCallback | None = ...) -> int
Starts watching name on the bus specified by bus_type and calls
name_appeared_handler and name_vanished_handler when the name is
known to have an owner respectively known to lose its
owner. Callbacks will be invoked in the thread-default main context
(see GLib.MainContext.push_thread_default)
of the thread you are calling this function from.
You are guaranteed that one of the handlers will be invoked after
calling this function. When you are done watching the name, just
call bus_unwatch_name with the watcher id this function
returns.
If the name vanishes or appears (for example the application owning
the name could restart), the handlers are also invoked. If the
DBusConnection that is used for watching the name disconnects, then
name_vanished_handler is invoked since it is no longer
possible to access the name.
Another guarantee is that invocations of name_appeared_handler
and name_vanished_handler are guaranteed to alternate; that
is, if name_appeared_handler is invoked then you are
guaranteed that the next time one of the handlers is invoked, it
will be name_vanished_handler. The reverse is also true.
This behavior makes it very simple to write applications that want
to take action when a certain name exists.
Basically, the application should create object proxies in
name_appeared_handler and destroy them again (if any) in
name_vanished_handler.
Parameters:
bus_type— The type of bus to watch a name on.name— The name (well-known or unique) to watch.flags— Flags from theBusNameWatcherFlagsenumeration.name_appeared_handler— Handler to invoke whennameis known to exist orNone.name_vanished_handler— Handler to invoke whennameis known to not exist orNone.
bus_watch_name_on_connection¶
def bus_watch_name_on_connection(connection: DBusConnection, name: str, flags: BusNameWatcherFlags | int, name_appeared_handler: BusNameAppearedCallback | None = ..., name_vanished_handler: BusNameVanishedCallback | None = ...) -> int
Like bus_watch_name but takes a DBusConnection instead of a
BusType.
Parameters:
connection— ADBusConnection.name— The name (well-known or unique) to watch.flags— Flags from theBusNameWatcherFlagsenumeration.name_appeared_handler— Handler to invoke whennameis known to exist orNone.name_vanished_handler— Handler to invoke whennameis known to not exist orNone.
bus_watch_name_on_connection_with_closures¶
def bus_watch_name_on_connection_with_closures(connection: DBusConnection, name: str, flags: BusNameWatcherFlags | int, name_appeared_closure: GObject.Closure | None = ..., name_vanished_closure: GObject.Closure | None = ...) -> int
Version of bus_watch_name_on_connection using closures instead of callbacks for
easier binding in other languages.
Parameters:
connection— ADBusConnection.name— The name (well-known or unique) to watch.flags— Flags from theBusNameWatcherFlagsenumeration.name_appeared_closure—GObject.Closureto invoke whennameis known to exist orNone.name_vanished_closure—GObject.Closureto invoke whennameis known to not exist orNone.
bus_watch_name_with_closures¶
def bus_watch_name_with_closures(bus_type: BusType | int, name: str, flags: BusNameWatcherFlags | int, name_appeared_closure: GObject.Closure | None = ..., name_vanished_closure: GObject.Closure | None = ...) -> int
Version of bus_watch_name using closures instead of callbacks for
easier binding in other languages.
Parameters:
bus_type— The type of bus to watch a name on.name— The name (well-known or unique) to watch.flags— Flags from theBusNameWatcherFlagsenumeration.name_appeared_closure—GObject.Closureto invoke whennameis known to exist orNone.name_vanished_closure—GObject.Closureto invoke whennameis known to not exist orNone.
content_type_can_be_executable¶
Checks if a content type can be executable. Note that for instance things like text files can be executables (i.e. scripts and batch files).
Parameters:
type— a content type string
content_type_equals¶
Compares two content types for equality.
Parameters:
type1— a content type stringtype2— a content type string
content_type_from_mime_type¶
Tries to find a content type based on the mime type name.
Parameters:
mime_type— a mime type string
content_type_get_description¶
Gets the human readable description of the content type.
Parameters:
type— a content type string
content_type_get_generic_icon_name¶
Gets the generic icon name for a content type.
See the shared-mime-info specification for more on the generic icon name.
Parameters:
type— a content type string
content_type_get_icon¶
Gets the icon for a content type.
Parameters:
type— a content type string
content_type_get_mime_dirs¶
Get the list of directories which MIME data is loaded from. See
content_type_set_mime_dirs for details.
content_type_get_mime_type¶
Gets the mime type for the content type, if one is registered.
Parameters:
type— a content type string
content_type_get_symbolic_icon¶
Gets the symbolic icon for a content type.
Parameters:
type— a content type string
content_type_guess¶
def content_type_guess(filename: str | bytes | os.PathLike[str] | os.PathLike[bytes] | None = ..., data: list[int] | None = ...) -> tuple[str, bool]
Guesses the content type based on example data. If the function is
uncertain, result_uncertain will be set to True. Either filename
or data may be None, in which case the guess will be based solely
on the other argument.
Parameters:
filename— a path, orNonedata— a stream of data, orNone
content_type_guess_for_tree¶
Tries to guess the type of the tree with root root, by
looking at the files it contains. The result is an array
of content types, with the best guess coming first.
The types returned all have the form x-content/foo, e.g. x-content/audio-cdda (for audio CDs) or x-content/image-dcf (for a camera memory card). See the shared-mime-info specification for more on x-content types.
This function is useful in the implementation of
Mount.guess_content_type.
Parameters:
root— the root of the tree to guess a type for
content_type_is_a¶
Determines if type is a subset of supertype.
Parameters:
type— a content type stringsupertype— a content type string
content_type_is_mime_type¶
Determines if type is a subset of mime_type.
Convenience wrapper around content_type_is_a.
Parameters:
type— a content type stringmime_type— a mime type string
content_type_is_unknown¶
Checks if the content type is the generic "unknown" type. On UNIX this is the "application/octet-stream" mimetype, while on win32 it is "*" and on OSX it is a dynamic type or octet-stream.
Parameters:
type— a content type string
content_type_set_mime_dirs¶
Set the list of directories used by GIO to load the MIME database.
If dirs is None, the directories used are the default:
- the
mimesubdirectory of the directory in$XDG_DATA_HOME - the
mimesubdirectory of every directory in$XDG_DATA_DIRS
This function is intended to be used when writing tests that depend on information stored in the MIME database, in order to control the data.
Typically, in case your tests use GLib.TEST_OPTION_ISOLATE_DIRS, but they
depend on the system’s MIME database, you should call this function
with dirs set to None before calling g_test_init(), for instance:
// Load MIME data from the system
g_content_type_set_mime_dirs (NULL);
// Isolate the environment
g_test_init (&argc, &argv, G_TEST_OPTION_ISOLATE_DIRS, NULL);
…
return g_test_run ();
Parameters:
dirs—None-terminated list of directories to load MIME data from, including anymime/subdirectory, and with the first directory to try listed first
content_types_get_registered¶
Gets a list of strings containing all the registered content types
known to the system. The list and its data should be freed using
g_list_free_full (list, g_free).
dbus_address_escape_value¶
Escape string so it can appear in a D-Bus address as the value
part of a key-value pair.
For instance, if string is /run/bus-for-:0,
this function would return /run/bus-for-%3A0,
which could be used in a D-Bus address like
unix:nonce-tcp:host=127.0.0.1,port=42,noncefile=/run/bus-for-%3A0.
Parameters:
string— an unescaped string to be included in a D-Bus address as the value in a key-value pair
dbus_address_get_for_bus_sync¶
def dbus_address_get_for_bus_sync(bus_type: BusType | int, cancellable: Cancellable | None = ...) -> str
Synchronously looks up the D-Bus address for the well-known message
bus instance specified by bus_type. This may involve using various
platform specific mechanisms.
The returned address will be in the D-Bus address format.
Parameters:
bus_type— aBusTypecancellable— aCancellableorNone
dbus_address_get_stream¶
def dbus_address_get_stream(address: str, cancellable: Cancellable | None = ..., callback: AsyncReadyCallback | None = ...) -> None
Asynchronously connects to an endpoint specified by address and
sets up the connection so it is in a state to run the client-side
of the D-Bus authentication conversation. address must be in the
D-Bus address format.
When the operation is finished, callback will be invoked. You can
then call dbus_address_get_stream_finish to get the result of
the operation.
This is an asynchronous failable function. See
dbus_address_get_stream_sync for the synchronous version.
Parameters:
address— A valid D-Bus address.cancellable— ACancellableorNone.callback— AGAsyncReadyCallbackto call when the request is satisfied.
dbus_address_get_stream_finish¶
Finishes an operation started with dbus_address_get_stream.
A server is not required to set a GUID, so out_guid may be set to None
even on success.
Parameters:
res— AAsyncResultobtained from the GAsyncReadyCallback passed todbus_address_get_stream.
dbus_address_get_stream_sync¶
def dbus_address_get_stream_sync(address: str, cancellable: Cancellable | None = ...) -> tuple[IOStream, str]
Synchronously connects to an endpoint specified by address and
sets up the connection so it is in a state to run the client-side
of the D-Bus authentication conversation. address must be in the
D-Bus address format.
A server is not required to set a GUID, so out_guid may be set to None
even on success.
This is a synchronous failable function. See
dbus_address_get_stream for the asynchronous version.
Parameters:
address— A valid D-Bus address.cancellable— ACancellableorNone.
dbus_escape_object_path¶
This is a language binding friendly version of dbus_escape_object_path_bytestring.
Parameters:
s— the string to escape
dbus_escape_object_path_bytestring¶
Escapes bytes for use in a D-Bus object path component.
bytes is an array of zero or more nonzero bytes in an
unspecified encoding, followed by a single zero byte.
The escaping method consists of replacing all non-alphanumeric
characters (see g_ascii_isalnum()) with their hexadecimal value
preceded by an underscore (_). For example:
foo.bar.baz will become foo_2ebar_2ebaz.
This method is appropriate to use when the input is nearly a valid object path component but is not when your input is far from being a valid object path component. Other escaping algorithms are also valid to use with D-Bus object paths.
This can be reversed with dbus_unescape_object_path.
Parameters:
bytes— the string of bytes to escape
dbus_generate_guid¶
Generate a D-Bus GUID that can be used with
e.g. DBusConnection.new.
See the D-Bus specification regarding what strings are valid D-Bus GUIDs. The specification refers to these as ‘UUIDs’ whereas GLib (for historical reasons) refers to them as ‘GUIDs’. The terms are interchangeable.
Note that D-Bus GUIDs do not follow RFC 4122.
dbus_gvalue_to_gvariant¶
Converts a GObject.Value to a GLib.Variant of the type indicated by the type
parameter.
The conversion is using the following rules:
G_TYPE_STRING: 's', 'o', 'g' or 'ay'G_TYPE_STRV: 'as', 'ao' or 'aay'G_TYPE_BOOLEAN: 'b'G_TYPE_UCHAR: 'y'G_TYPE_INT: 'i', 'n'G_TYPE_UINT: 'u', 'q'G_TYPE_INT64: 'x'G_TYPE_UINT64: 't'G_TYPE_DOUBLE: 'd'G_TYPE_VARIANT: AnyGLib.VariantType
This can fail if e.g. gvalue is of type G_TYPE_STRING and type
is 'i', i.e. G_VARIANT_TYPE_INT32. It will also fail for any GType
(including e.g. G_TYPE_OBJECT and G_TYPE_BOXED derived-types) not
in the table above.
Note that if gvalue is of type G_TYPE_VARIANT and its value is
None, the empty GLib.Variant instance (never None) for type is
returned (e.g. 0 for scalar types, the empty string for string types,
'/' for object path types, the empty array for any array type and so on).
See the dbus_gvariant_to_gvalue function for how to convert a
GLib.Variant to a GObject.Value.
Parameters:
gvalue— AGObject.Valueto convert to aGLib.Varianttype— AGLib.VariantType
dbus_gvariant_to_gvalue¶
Converts a GLib.Variant to a GObject.Value. If value is floating, it is consumed.
The rules specified in the dbus_gvalue_to_gvariant function are
used - this function is essentially its reverse form. So, a GLib.Variant
containing any basic or string array type will be converted to a GObject.Value
containing a basic value or string array. Any other GLib.Variant (handle,
variant, tuple, dict entry) will be converted to a GObject.Value containing that
GLib.Variant.
The conversion never fails - a valid GObject.Value is always returned in
out_gvalue.
Parameters:
value— AGLib.Variant.
dbus_is_address¶
Checks if string is a
D-Bus address.
This doesn't check if string is actually supported by DBusServer
or DBusConnection - use dbus_is_supported_address to do more
checks.
Parameters:
string— A string.
dbus_is_error_name¶
Check whether string is a valid D-Bus error name.
This function returns the same result as dbus_is_interface_name,
because D-Bus error names are defined to have exactly the
same syntax as interface names.
Parameters:
string— The string to check.
dbus_is_guid¶
Checks if string is a D-Bus GUID.
See the documentation for dbus_generate_guid for more information about
the format of a GUID.
Parameters:
string— The string to check.
dbus_is_interface_name¶
Checks if string is a valid D-Bus interface name.
Parameters:
string— The string to check.
dbus_is_member_name¶
Checks if string is a valid D-Bus member (e.g. signal or method) name.
Parameters:
string— The string to check.
dbus_is_name¶
Checks if string is a valid D-Bus bus name (either unique or well-known).
Parameters:
string— The string to check.
dbus_is_supported_address¶
Like dbus_is_address but also checks if the library supports the
transports in string and that key/value pairs for each transport
are valid. See the specification of the
D-Bus address format.
Parameters:
string— A string.
dbus_is_unique_name¶
Checks if string is a valid D-Bus unique bus name.
Parameters:
string— The string to check.
dbus_unescape_object_path¶
Unescapes an string that was previously escaped with
dbus_escape_object_path. If the string is in a format that could
not have been returned by dbus_escape_object_path, this function
returns None.
Encoding alphanumeric characters which do not need to be
encoded is not allowed (e.g _63 is not valid, the string
should contain c instead).
Parameters:
s— the string to unescape
io_error_from_errno¶
Converts errno.h error codes into GIO error codes.
The fallback value IOErrorEnum.FAILED is returned for error codes not
currently handled (but note that future GLib releases may return a more
specific value instead).
As errno is global and may be modified by intermediate function
calls, you should save its value immediately after the call returns,
and use the saved value instead of errno:
Parameters:
err_no— Error number as defined in errno.h.
io_error_from_file_error¶
Converts GLib.FileError error codes into GIO error codes.
Parameters:
file_error— aGLib.FileError.
io_error_quark¶
Gets the GIO Error Quark.
io_modules_load_all_in_directory¶
def io_modules_load_all_in_directory(dirname: str | bytes | os.PathLike[str] | os.PathLike[bytes]) -> list[IOModule]
Loads all the modules in the specified directory.
If don't require all modules to be initialized (and thus registering
all gtypes) then you can use io_modules_scan_all_in_directory
which allows delayed/lazy loading of modules.
Parameters:
dirname— pathname for a directory containing modules to load.
io_modules_load_all_in_directory_with_scope¶
def io_modules_load_all_in_directory_with_scope(dirname: str | bytes | os.PathLike[str] | os.PathLike[bytes], scope: IOModuleScope) -> list[IOModule]
Loads all the modules in the specified directory.
If don't require all modules to be initialized (and thus registering
all gtypes) then you can use io_modules_scan_all_in_directory
which allows delayed/lazy loading of modules.
Parameters:
dirname— pathname for a directory containing modules to load.scope— a scope to use when scanning the modules.
io_modules_scan_all_in_directory¶
def io_modules_scan_all_in_directory(dirname: str | bytes | os.PathLike[str] | os.PathLike[bytes]) -> None
Scans all the modules in the specified directory, ensuring that any extension point implemented by a module is registered.
This may not actually load and initialize all the types in each
module, some modules may be lazily loaded and initialized when
an extension point it implements is used with e.g.
IOExtensionPoint.get_extensions or
IOExtensionPoint.get_extension_by_name.
If you need to guarantee that all types are loaded in all the modules,
use io_modules_load_all_in_directory.
Parameters:
dirname— pathname for a directory containing modules to scan.
io_modules_scan_all_in_directory_with_scope¶
def io_modules_scan_all_in_directory_with_scope(dirname: str | bytes | os.PathLike[str] | os.PathLike[bytes], scope: IOModuleScope) -> None
Scans all the modules in the specified directory, ensuring that any extension point implemented by a module is registered.
This may not actually load and initialize all the types in each
module, some modules may be lazily loaded and initialized when
an extension point it implements is used with e.g.
IOExtensionPoint.get_extensions or
IOExtensionPoint.get_extension_by_name.
If you need to guarantee that all types are loaded in all the modules,
use io_modules_load_all_in_directory.
Parameters:
dirname— pathname for a directory containing modules to scan.scope— a scope to use when scanning the modules
io_scheduler_cancel_all_jobs¶
:::warning Deprecated since 2.36 This API is deprecated. :::
Cancels all cancellable I/O jobs.
A job is cancellable if a Cancellable was passed into
io_scheduler_push_job.
io_scheduler_push_job¶
def io_scheduler_push_job(job_func: IOSchedulerJobFunc, io_priority: int, cancellable: Cancellable | None = ...) -> None
:::warning Deprecated since 2.36 This API is deprecated. :::
Schedules the I/O job to run in another thread.
notify will be called on user_data after job_func has returned,
regardless whether the job was cancelled or has run to completion.
If cancellable is not None, it can be used to cancel the I/O job
by calling Cancellable.cancel or by calling
io_scheduler_cancel_all_jobs.
Parameters:
job_func— aGIOSchedulerJobFunc.io_priority— the I/O priority of the request.cancellable— optionalCancellableobject,Noneto ignore.
keyfile_settings_backend_new¶
def keyfile_settings_backend_new(filename: str, root_path: str, root_group: str | None = ...) -> SettingsBackend
Creates a keyfile-backed SettingsBackend.
The filename of the keyfile to use is given by filename.
All settings read to or written from the backend must fall under the
path given in root_path (which must start and end with a slash and
not contain two consecutive slashes). root_path may be "/".
If root_group is non-NULL then it specifies the name of the keyfile
group used for keys that are written directly below root_path. For
example, if root_path is "/apps/example/" and root_group is
"toplevel", then setting the key "/apps/example/enabled" to true will
cause the following to appear in the keyfile:
If root_group is NULL then it is not permitted to store keys
directly below the root_path.
For keys not stored directly below root_path (ie: in a sub-path),
the name of the subpath (with the final slash stripped) is used as
the name of the keyfile group. To continue the example, if
"/apps/example/profiles/default/font-size" were set to
12 then the following would appear in the keyfile:
The backend will refuse writes (and return writability as being
false) for keys outside of root_path and, in the event that
root_group is NULL, also for keys directly under root_path.
Writes will also be refused if the backend detects that it has the
inability to rewrite the keyfile (ie: the containing directory is not
writable).
There is no checking done for your key namespace clashing with the
syntax of the key file format. For example, if you have [ or ]
characters in your path names or = in your key names you may be in
trouble.
The backend reads default values from a keyfile called defaults in
the directory specified by the GKeyfileSettingsBackend:defaults-dir
property, and a list of locked keys from a text file with the name locks in
the same location.
Parameters:
filename— the filename of the keyfileroot_path— the path under which all settings keys appearroot_group— the group name corresponding toroot_path, orNULLto disallow storing keys directly beneathroot_path
memory_settings_backend_new¶
Creates a memory-backed SettingsBackend.
This backend allows changes to settings, but does not write them to any backing storage, so the next time you run your application, the memory backend will start out with the default values again.
networking_init¶
Initializes the platform networking libraries (eg, on Windows, this calls WSAStartup()). GLib will call this itself if it is needed, so you only need to call it if you directly call system networking functions (without calling any GLib networking functions first).
null_settings_backend_new¶
Creates a readonly SettingsBackend.
This backend does not allow changes to settings, so all settings will always have their default values.
pollable_source_new¶
Utility method for PollableInputStream and PollableOutputStream
implementations. Creates a new GLib.Source that expects a callback of
type GPollableSourceFunc. The new source does not actually do
anything on its own; use GLib.Source.add_child_source to add other
sources to it to cause it to trigger.
Parameters:
pollable_stream— the stream associated with the new source
pollable_source_new_full¶
def pollable_source_new_full(pollable_stream: GObject.Object, child_source: GLib.Source | None = ..., cancellable: Cancellable | None = ...) -> GLib.Source
Utility method for PollableInputStream and PollableOutputStream
implementations. Creates a new GLib.Source, as with
pollable_source_new, but also attaching child_source (with a
dummy callback), and cancellable, if they are non-None.
Parameters:
pollable_stream— the stream associated with the new sourcechild_source— optional child source to attachcancellable— optionalCancellableto attach
pollable_stream_read¶
def pollable_stream_read(stream: InputStream, buffer: list[int], blocking: bool, cancellable: Cancellable | None = ...) -> int
Tries to read from stream, as with InputStream.read (if
blocking is True) or PollableInputStream.read_nonblocking
(if blocking is False). This can be used to more easily share
code between blocking and non-blocking implementations of a method.
If blocking is False, then stream must be a
PollableInputStream for which PollableInputStream.can_poll
returns True, or else the behavior is undefined. If blocking is
True, then stream does not need to be a PollableInputStream.
Parameters:
stream— aInputStreambuffer— a buffer to read data intoblocking— whether to do blocking I/Ocancellable— optionalCancellableobject,Noneto ignore.
pollable_stream_write¶
def pollable_stream_write(stream: OutputStream, buffer: list[int], blocking: bool, cancellable: Cancellable | None = ...) -> int
Tries to write to stream, as with OutputStream.write (if
blocking is True) or PollableOutputStream.write_nonblocking
(if blocking is False). This can be used to more easily share
code between blocking and non-blocking implementations of a method.
If blocking is False, then stream must be a
PollableOutputStream for which
PollableOutputStream.can_poll returns True or else the
behavior is undefined. If blocking is True, then stream does not
need to be a PollableOutputStream.
Parameters:
stream— aOutputStream.buffer— the buffer containing the data to write.blocking— whether to do blocking I/Ocancellable— optionalCancellableobject,Noneto ignore.
pollable_stream_write_all¶
def pollable_stream_write_all(stream: OutputStream, buffer: list[int], blocking: bool, cancellable: Cancellable | None = ...) -> tuple[bool, int]
Tries to write count bytes to stream, as with
OutputStream.write_all, but using pollable_stream_write
rather than OutputStream.write.
On a successful write of count bytes, True is returned, and
bytes_written is set to count.
If there is an error during the operation (including
IOErrorEnum.WOULD_BLOCK in the non-blocking case), False is
returned and error is set to indicate the error status,
bytes_written is updated to contain the number of bytes written
into the stream before the error occurred.
As with pollable_stream_write, if blocking is False, then
stream must be a PollableOutputStream for which
PollableOutputStream.can_poll returns True or else the
behavior is undefined. If blocking is True, then stream does not
need to be a PollableOutputStream.
Parameters:
stream— aOutputStream.buffer— the buffer containing the data to write.blocking— whether to do blocking I/Ocancellable— optionalCancellableobject,Noneto ignore.
resources_enumerate_children¶
Returns all the names of children at the specified path in the set of
globally registered resources.
The return result is a NULL terminated list of strings which should
be released with GLib.strfreev.
lookup_flags controls the behaviour of the lookup.
Parameters:
path— A path name inside the resourcelookup_flags— AResourceLookupFlags
resources_get_info¶
Looks for a file at the specified path in the set of
globally registered resources and if found returns information about it.
lookup_flags controls the behaviour of the lookup.
Parameters:
path— A path name inside the resourcelookup_flags— AResourceLookupFlags
resources_has_children¶
Returns whether the specified path in the set of
globally registered resources has children.
Parameters:
path— A pathname
resources_lookup_data¶
Looks for a file at the specified path in the set of
globally registered resources and returns a GLib.Bytes that
lets you directly access the data in memory.
The data is always followed by a zero byte, so you
can safely use the data as a C string. However, that byte
is not included in the size of the GLib.Bytes.
For uncompressed resource files this is a pointer directly into the resource bundle, which is typically in some read-only data section in the program binary. For compressed files we allocate memory on the heap and automatically uncompress the data.
lookup_flags controls the behaviour of the lookup.
Parameters:
path— A path name inside the resourcelookup_flags— AResourceLookupFlags
resources_open_stream¶
Looks for a file at the specified path in the set of
globally registered resources and returns a InputStream
that lets you read the data.
lookup_flags controls the behaviour of the lookup.
Parameters:
path— A path name inside the resourcelookup_flags— AResourceLookupFlags
resources_register¶
Registers the resource with the process-global set of resources.
Once a resource is registered the files in it can be accessed
with the global resource lookup functions like
resources_lookup_data.
Parameters:
resource— AResource
resources_unregister¶
Unregisters the resource from the process-global set of resources.
Parameters:
resource— AResource
simple_async_report_gerror_in_idle¶
def simple_async_report_gerror_in_idle(object: GObject.Object | None, callback: AsyncReadyCallback | None, error: GLib.Error) -> None
:::warning Deprecated since 2.46 This API is deprecated. :::
Reports an error in an idle function. Similar to
g_simple_async_report_error_in_idle(), but takes a GLib.Error rather
than building a new one.
Parameters:
object— aGObject.Object, orNonecallback— aGAsyncReadyCallback.error— theGLib.Errorto report
Enumerations¶
AppInfoCreateFlags¶
Bit flags.
NONE=0— No flags.NEEDS_TERMINAL=1— Application opens in a terminal window.SUPPORTS_URIS=2— Application supports URI arguments.SUPPORTS_STARTUP_NOTIFICATION=4— Application supports startup notification. Since 2.26
ApplicationFlags¶
Bit flags.
FLAGS_NONE=0— Default flags.DEFAULT_FLAGS=0— Default flags.IS_SERVICE=1— Run as a service. In this mode, registration fails if the service is already running, and the application will initially wait up to 10 seconds for an initial activation message to arrive.IS_LAUNCHER=2— Don't try to become the primary instance.HANDLES_OPEN=4— This application handles opening files (in the primary instance). Note that this flag only affects the default implementation of local_command_line(), and has no effect ifApplicationFlags.HANDLES_COMMAND_LINEis given. SeeApplication.runfor details.HANDLES_COMMAND_LINE=8— This application handles command line arguments (in the primary instance). Note that this flag only affect the default implementation of local_command_line(). SeeApplication.runfor details.SEND_ENVIRONMENT=16— Send the environment of the launching process to the primary instance. Set this flag if your application is expected to behave differently depending on certain environment variables. For instance, an editor might be expected to use theGIT_COMMITTER_NAMEenvironment variable when editing a git commit message. The environment is available to theApplication::command-line signal handler, viaApplicationCommandLine.getenv.NON_UNIQUE=32— Make no attempts to do any of the typical single-instance application negotiation, even if the application ID is given. The application neither attempts to become the owner of the application ID nor does it check if an existing owner already exists. Everything occurs in the local process. Since: 2.30.CAN_OVERRIDE_APP_ID=64— Allow users to override the application ID from the command line with--gapplication-app-id. Since: 2.48ALLOW_REPLACEMENT=128— Allow another instance to take over the bus name. Since: 2.60REPLACE=256— Take over from another instance. This flag is usually set by passing--gapplication-replaceon the commandline. Since: 2.60
AskPasswordFlags¶
Bit flags.
NEED_PASSWORD=1— operation requires a password.NEED_USERNAME=2— operation requires a username.NEED_DOMAIN=4— operation requires a domain.SAVING_SUPPORTED=8— operation supports saving settings.ANONYMOUS_SUPPORTED=16— operation supports anonymous users.TCRYPT=32— operation takes TCRYPT parameters (Since: 2.58)
BusNameOwnerFlags¶
Bit flags.
NONE=0— No flags set.ALLOW_REPLACEMENT=1— Allow another message bus connection to claim the name.REPLACE=2— If another message bus connection owns the name and have specifiedBusNameOwnerFlags.ALLOW_REPLACEMENT, then take the name from the other connection.DO_NOT_QUEUE=4— If another message bus connection owns the name, immediately return an error frombus_own_namerather than entering the waiting queue for that name.
BusNameWatcherFlags¶
Bit flags.
NONE=0— No flags set.AUTO_START=1— If no-one owns the name when beginning to watch the name, ask the bus to launch an owner for the name.
BusType¶
Enumeration.
STARTER=-1— An alias for the message bus that activated the process, if any.NONE=0— Not a message bus.SYSTEM=1— The system-wide message bus.SESSION=2— The login session message bus.
ConverterFlags¶
Bit flags.
NONE=0— No flags.INPUT_AT_END=1— At end of input dataFLUSH=2— Flush data
ConverterResult¶
Enumeration.
ERROR=0— There was an error during conversion.CONVERTED=1— Some data was consumed or producedFINISHED=2— The conversion is finishedFLUSHED=3— Flushing is finished
CredentialsType¶
Enumeration.
INVALID=0— Indicates an invalid native credential type.LINUX_UCRED=1— The native credentials type is astruct ucred.FREEBSD_CMSGCRED=2— The native credentials type is astruct cmsgcred.OPENBSD_SOCKPEERCRED=3— The native credentials type is astruct sockpeercred. Added in 2.30.SOLARIS_UCRED=4— The native credentials type is aucred_t. Added in 2.40.NETBSD_UNPCBID=5— The native credentials type is astruct unpcbid. Added in 2.42.APPLE_XUCRED=6— The native credentials type is astruct xucred. Added in 2.66.WIN32_PID=7— The native credentials type is a PIDDWORD. Added in 2.72.
DBusCallFlags¶
Bit flags.
NONE=0— No flags set.NO_AUTO_START=1— The bus must not launch an owner for the destination name in response to this method invocation.ALLOW_INTERACTIVE_AUTHORIZATION=2— the caller is prepared to wait for interactive authorization. Since 2.46.
DBusCapabilityFlags¶
Bit flags.
NONE=0— No flags set.UNIX_FD_PASSING=1— The connection supports exchanging UNIX file descriptors with the remote peer.
DBusConnectionFlags¶
Bit flags.
NONE=0— No flags set.AUTHENTICATION_CLIENT=1— Perform authentication against server.AUTHENTICATION_SERVER=2— Perform authentication against client.AUTHENTICATION_ALLOW_ANONYMOUS=4— When authenticating as a server, allow the anonymous authentication method.MESSAGE_BUS_CONNECTION=8— Pass this flag if connecting to a peer that is a message bus. This means that the Hello() method will be invoked as part of the connection setup.DELAY_MESSAGE_PROCESSING=16— If set, processing of D-Bus messages is delayed untilDBusConnection.start_message_processingis called.AUTHENTICATION_REQUIRE_SAME_USER=32— When authenticating as a server, require the UID of the peer to be the same as the UID of the server. (Since: 2.68)CROSS_NAMESPACE=64— When authenticating, try to use protocols that work across a Linux user namespace boundary, even if this reduces interoperability with older D-Bus implementations. This currently affects client-sideEXTERNALauthentication, for which this flag makes connections to a server in another user namespace succeed, but causes a deadlock when connecting to a GDBus server older than 2.73.3. Since: 2.74
DBusError¶
Enumeration.
FAILED=0— A generic error; "something went wrong" - see the error message for more.NO_MEMORY=1— There was not enough memory to complete an operation.SERVICE_UNKNOWN=2— The bus doesn't know how to launch a service to supply the bus name you wanted.NAME_HAS_NO_OWNER=3— The bus name you referenced doesn't exist (i.e. no application owns it).NO_REPLY=4— No reply to a message expecting one, usually means a timeout occurred.IO_ERROR=5— Something went wrong reading or writing to a socket, for example.BAD_ADDRESS=6— A D-Bus bus address was malformed.NOT_SUPPORTED=7— Requested operation isn't supported (like ENOSYS on UNIX).LIMITS_EXCEEDED=8— Some limited resource is exhausted.ACCESS_DENIED=9— Security restrictions don't allow doing what you're trying to do.AUTH_FAILED=10— Authentication didn't work.NO_SERVER=11— Unable to connect to server (probably caused by ECONNREFUSED on a socket).TIMEOUT=12— Certain timeout errors, possibly ETIMEDOUT on a socket. Note thatDBusError.NO_REPLYis used for message reply timeouts. Warning: this is confusingly-named given thatDBusError.TIMED_OUTalso exists. We can't fix it for compatibility reasons so just be careful.NO_NETWORK=13— No network access (probably ENETUNREACH on a socket).ADDRESS_IN_USE=14— Can't bind a socket since its address is in use (i.e. EADDRINUSE).DISCONNECTED=15— The connection is disconnected and you're trying to use it.INVALID_ARGS=16— Invalid arguments passed to a method call.FILE_NOT_FOUND=17— Missing file.FILE_EXISTS=18— Existing file and the operation you're using does not silently overwrite.UNKNOWN_METHOD=19— Method name you invoked isn't known by the object you invoked it on.TIMED_OUT=20— Certain timeout errors, e.g. while starting a service. Warning: this is confusingly-named given thatDBusError.TIMEOUTalso exists. We can't fix it for compatibility reasons so just be careful.MATCH_RULE_NOT_FOUND=21— Tried to remove or modify a match rule that didn't exist.MATCH_RULE_INVALID=22— The match rule isn't syntactically valid.SPAWN_EXEC_FAILED=23— While starting a new process, the exec() call failed.SPAWN_FORK_FAILED=24— While starting a new process, the fork() call failed.SPAWN_CHILD_EXITED=25— While starting a new process, the child exited with a status code.SPAWN_CHILD_SIGNALED=26— While starting a new process, the child exited on a signal.SPAWN_FAILED=27— While starting a new process, something went wrong.SPAWN_SETUP_FAILED=28— We failed to setup the environment correctly.SPAWN_CONFIG_INVALID=29— We failed to setup the config parser correctly.SPAWN_SERVICE_INVALID=30— Bus name was not valid.SPAWN_SERVICE_NOT_FOUND=31— Service file not found in system-services directory.SPAWN_PERMISSIONS_INVALID=32— Permissions are incorrect on the setuid helper.SPAWN_FILE_INVALID=33— Service file invalid (Name, User or Exec missing).SPAWN_NO_MEMORY=34— Tried to get a UNIX process ID and it wasn't available.UNIX_PROCESS_ID_UNKNOWN=35— Tried to get a UNIX process ID and it wasn't available.INVALID_SIGNATURE=36— A type signature is not valid.INVALID_FILE_CONTENT=37— A file contains invalid syntax or is otherwise broken.SELINUX_SECURITY_CONTEXT_UNKNOWN=38— Asked for SELinux security context and it wasn't available.ADT_AUDIT_DATA_UNKNOWN=39— Asked for ADT audit data and it wasn't available.OBJECT_PATH_IN_USE=40— There's already an object with the requested object path.UNKNOWN_OBJECT=41— Object you invoked a method on isn't known. Since 2.42UNKNOWN_INTERFACE=42— Interface you invoked a method on isn't known by the object. Since 2.42UNKNOWN_PROPERTY=43— Property you tried to access isn't known by the object. Since 2.42PROPERTY_READ_ONLY=44— Property you tried to set is read-only. Since 2.42
DBusInterfaceSkeletonFlags¶
Bit flags.
NONE=0— No flags set.HANDLE_METHOD_INVOCATIONS_IN_THREAD=1— Each method invocation is handled in a thread dedicated to the invocation. This means that the method implementation can use blocking IO without blocking any other part of the process. It also means that the method implementation must use locking to access data structures used by other threads.
DBusMessageByteOrder¶
Enumeration.
BIG_ENDIAN=66— The byte order is big endian.LITTLE_ENDIAN=108— The byte order is little endian.
DBusMessageFlags¶
Bit flags.
NONE=0— No flags set.NO_REPLY_EXPECTED=1— A reply is not expected.NO_AUTO_START=2— The bus must not launch an owner for the destination name in response to this message.ALLOW_INTERACTIVE_AUTHORIZATION=4— If set on a method call, this flag means that the caller is prepared to wait for interactive authorization. Since 2.46.
DBusMessageHeaderField¶
Enumeration.
INVALID=0— Not a valid header field.PATH=1— The object path.INTERFACE=2— The interface name.MEMBER=3— The method or signal name.ERROR_NAME=4— The name of the error that occurred.REPLY_SERIAL=5— The serial number the message is a reply to.DESTINATION=6— The name the message is intended for.SENDER=7— Unique name of the sender of the message (filled in by the bus).SIGNATURE=8— The signature of the message body.NUM_UNIX_FDS=9— The number of UNIX file descriptors that accompany the message.
DBusMessageType¶
Enumeration.
INVALID=0— Message is of invalid type.METHOD_CALL=1— Method call.METHOD_RETURN=2— Method reply.ERROR=3— Error reply.SIGNAL=4— Signal emission.
DBusObjectManagerClientFlags¶
Bit flags.
NONE=0— No flags set.DO_NOT_AUTO_START=1— If not set and the manager is for a well-known name, then request the bus to launch an owner for the name if no-one owns the name. This flag can only be used in managers for well-known names.
DBusPropertyInfoFlags¶
Bit flags.
NONE=0— No flags set.READABLE=1— Property is readable.WRITABLE=2— Property is writable.
DBusProxyFlags¶
Bit flags.
NONE=0— No flags set.DO_NOT_LOAD_PROPERTIES=1— Don't load properties.DO_NOT_CONNECT_SIGNALS=2— Don't connect to signals on the remote object.DO_NOT_AUTO_START=4— If the proxy is for a well-known name, do not ask the bus to launch an owner during proxy initialization or a method call. This flag is only meaningful in proxies for well-known names.GET_INVALIDATED_PROPERTIES=8— If set, the property value for any invalidated property will be (asynchronously) retrieved upon receiving thePropertiesChangedD-Bus signal and the property will not cause emission of theDBusProxy::g-properties-changed signal. When the value is received theDBusProxy::g-properties-changed signal is emitted for the property along with the retrieved value. Since 2.32.DO_NOT_AUTO_START_AT_CONSTRUCTION=16— If the proxy is for a well-known name, do not ask the bus to launch an owner during proxy initialization, but allow it to be autostarted by a method call. This flag is only meaningful in proxies for well-known names, and only ifDBusProxyFlags.DO_NOT_AUTO_STARTis not also specified.NO_MATCH_RULE=32— Don't actually send the AddMatch D-Bus call for this signal subscription. This gives you more control over which match rules you add (but you must add them manually). (Since: 2.72)
DBusSendMessageFlags¶
Bit flags.
NONE=0— No flags set.PRESERVE_SERIAL=1— Do not automatically assign a serial number from theDBusConnectionobject when sending a message.
DBusServerFlags¶
Bit flags.
NONE=0— No flags set.RUN_IN_THREAD=1— AllDBusServer::new-connection signals will run in separated dedicated threads (see signal for details).AUTHENTICATION_ALLOW_ANONYMOUS=2— Allow the anonymous authentication method.AUTHENTICATION_REQUIRE_SAME_USER=4— Require the UID of the peer to be the same as the UID of the server when authenticating. (Since: 2.68)
DBusSignalFlags¶
Bit flags.
NONE=0— No flags set.NO_MATCH_RULE=1— Don't actually send the AddMatch D-Bus call for this signal subscription. This gives you more control over which match rules you add (but you must add them manually).MATCH_ARG0_NAMESPACE=2— Match first arguments that contain a bus or interface name with the given namespace.MATCH_ARG0_PATH=4— Match first arguments that contain an object path that is either equivalent to the given path, or one of the paths is a subpath of the other.
DBusSubtreeFlags¶
Bit flags.
NONE=0— No flags set.DISPATCH_TO_UNENUMERATED_NODES=1— Method calls to objects not in the enumerated range will still be dispatched. This is useful if you want to dynamically spawn objects in the subtree.
DataStreamByteOrder¶
Enumeration.
BIG_ENDIAN=0— Selects Big Endian byte order.LITTLE_ENDIAN=1— Selects Little Endian byte order.HOST_ENDIAN=2— Selects endianness based on host machine's architecture.
DataStreamNewlineType¶
Enumeration.
LF=0— Selects "LF" line endings, common on most modern UNIX platforms.CR=1— Selects "CR" line endings.CR_LF=2— Selects "CR, LF" line ending, common on Microsoft Windows.ANY=3— Automatically try to handle any line ending type.
DriveStartFlags¶
Bit flags.
NONE=0— No flags set.
DriveStartStopType¶
Enumeration.
UNKNOWN=0— Unknown or drive doesn't support start/stop.SHUTDOWN=1— The stop method will physically shut down the drive and e.g. power down the port the drive is attached to.NETWORK=2— The start/stop methods are used for connecting/disconnect to the drive over the network.MULTIDISK=3— The start/stop methods will assemble/disassemble a virtual drive from several physical drives.PASSWORD=4— The start/stop methods will unlock/lock the disk (for example using the ATASECURITY UNLOCK DEVICEcommand)
EcnCodePoint¶
Enumeration.
NO_ECN=0— Not ECN-capable transportECT_1=1— ECN Capable Transport(1)ECT_0=2— ECN Capable Transport(0)ECT_CE=3— Congestion Experienced
EmblemOrigin¶
Enumeration.
UNKNOWN=0— Emblem of unknown originDEVICE=1— Emblem adds device-specific informationLIVEMETADATA=2— Emblem depicts live metadata, such as "readonly"TAG=3— Emblem comes from a user-defined tag, e.g. set by nautilus (in the future)
FileAttributeInfoFlags¶
Bit flags.
NONE=0— no flags set.COPY_WITH_FILE=1— copy the attribute values when the file is copied.COPY_WHEN_MOVED=2— copy the attribute values when the file is moved.
FileAttributeStatus¶
Enumeration.
UNSET=0— Attribute value is unset (empty).SET=1— Attribute value is set.ERROR_SETTING=2— Indicates an error in setting the value.
FileAttributeType¶
Enumeration.
INVALID=0— indicates an invalid or uninitialized type.STRING=1— a null terminated UTF8 string.BYTE_STRING=2— a zero terminated string of non-zero bytes.BOOLEAN=3— a boolean value.UINT32=4— an unsigned 4-byte/32-bit integer.INT32=5— a signed 4-byte/32-bit integer.UINT64=6— an unsigned 8-byte/64-bit integer.INT64=7— a signed 8-byte/64-bit integer.OBJECT=8— aGObject.Object.STRINGV=9— aNoneterminated char **. Since 2.22
FileCopyFlags¶
Bit flags.
NONE=0— No flags set.OVERWRITE=1— Overwrite any existing filesBACKUP=2— Make a backup of any existing files.NOFOLLOW_SYMLINKS=4— Don't follow symlinks.ALL_METADATA=8— Copy all file metadata instead of just default set used for copy (seeFileInfo).NO_FALLBACK_FOR_MOVE=16— Don't use copy and delete fallback if native move not supported.TARGET_DEFAULT_PERMS=32— Leaves target file with default perms, instead of setting the source file perms.TARGET_DEFAULT_MODIFIED_TIME=64— Use default modification timestamps instead of copying them from the source file. Since 2.80
FileCreateFlags¶
Bit flags.
NONE=0— No flags set.PRIVATE=1— Create a file that can only be accessed by the current user.REPLACE_DESTINATION=2— 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. This flag can only be used withFile.replaceand its variants, includingFile.replace_contents. Since 2.20
FileMeasureFlags¶
Bit flags.
NONE=0— No flags set.REPORT_ANY_ERROR=2— Report any error encountered while traversing the directory tree. Normally errors are only reported for the toplevel file.APPARENT_SIZE=4— Tally usage based on apparent file sizes. Normally, the block-size is used, if available, as this is a more accurate representation of disk space used. Compare withdu --apparent-size. Since GLib 2.78. and similarly todusince GNU Coreutils 9.2, this will ignore the sizes of file types other than regular files and links, as the sizes of other file types are not specified in a standard way.NO_XDEV=8— Do not cross mount point boundaries. Compare withdu -x.
FileMonitorEvent¶
Enumeration.
CHANGED=0— a file changed.CHANGES_DONE_HINT=1— a hint that this was probably the last change in a set of changes.DELETED=2— a file was deleted.CREATED=3— a file was created.ATTRIBUTE_CHANGED=4— a file attribute was changed.PRE_UNMOUNT=5— the file location will soon be unmounted.UNMOUNTED=6— the file location was unmounted.MOVED=7— the file was moved -- only sent if the (deprecated)FileMonitorFlags.SEND_MOVEDflag is setRENAMED=8— the file was renamed within the current directory -- only sent if theFileMonitorFlags.WATCH_MOVESflag is set. Since: 2.46.MOVED_IN=9— the file was moved into the monitored directory from another location -- only sent if theFileMonitorFlags.WATCH_MOVESflag is set. Since: 2.46.MOVED_OUT=10— the file was moved out of the monitored directory to another location -- only sent if theFileMonitorFlags.WATCH_MOVESflag is set. Since: 2.46
FileMonitorFlags¶
Bit flags.
NONE=0— No flags set.WATCH_MOUNTS=1— Watch for mount events.SEND_MOVED=2— Pair DELETED and CREATED events caused by file renames (moves) and send a single G_FILE_MONITOR_EVENT_MOVED event instead (NB: not supported on all backends; the default behaviour -without specifying this flag- is to send single DELETED and CREATED events). Deprecated since 2.46: useFileMonitorFlags.WATCH_MOVESinstead.WATCH_HARD_LINKS=4— Watch for changes to the file made via another hard link. Since 2.36.WATCH_MOVES=8— Watch for rename operations on a monitored directory. This causesFileMonitorEvent.RENAMED,FileMonitorEvent.MOVED_INandFileMonitorEvent.MOVED_OUTevents to be emitted when possible. Since: 2.46.
FileQueryInfoFlags¶
Bit flags.
NONE=0— No flags set.NOFOLLOW_SYMLINKS=1— Don't follow symlinks.
FileType¶
Enumeration.
UNKNOWN=0— File's type is unknown.REGULAR=1— File handle represents a regular file.DIRECTORY=2— File handle represents a directory.SYMBOLIC_LINK=3— File handle represents a symbolic link (Unix systems).SPECIAL=4— File is a "special" file, such as a socket, fifo, block device, or character device.SHORTCUT=5— File is a shortcut (Windows systems).MOUNTABLE=6— File is a mountable location.
FilesystemPreviewType¶
Enumeration.
IF_ALWAYS=0— Only preview files if user has explicitly requested it.IF_LOCAL=1— Preview files if user has requested preview of "local" files.NEVER=2— Never preview files.
IOErrorEnum¶
Enumeration.
FAILED=0— Generic error condition for when an operation fails and no more specificIOErrorEnumvalue is defined.NOT_FOUND=1— File not found.EXISTS=2— File already exists.IS_DIRECTORY=3— File is a directory.NOT_DIRECTORY=4— File is not a directory.NOT_EMPTY=5— File is a directory that isn't empty.NOT_REGULAR_FILE=6— File is not a regular file.NOT_SYMBOLIC_LINK=7— File is not a symbolic link.NOT_MOUNTABLE_FILE=8— File cannot be mounted.FILENAME_TOO_LONG=9— Filename is too many characters.INVALID_FILENAME=10— Filename is invalid or contains invalid characters.TOO_MANY_LINKS=11— File contains too many symbolic links.NO_SPACE=12— No space left on drive.INVALID_ARGUMENT=13— Invalid argument.PERMISSION_DENIED=14— Permission denied.NOT_SUPPORTED=15— Operation (or one of its parameters) not supportedNOT_MOUNTED=16— File isn't mounted.ALREADY_MOUNTED=17— File is already mounted.CLOSED=18— File was closed.CANCELLED=19— Operation was cancelled. SeeCancellable.PENDING=20— Operations are still pending.READ_ONLY=21— File is read only.CANT_CREATE_BACKUP=22— Backup couldn't be created.WRONG_ETAG=23— File's Entity Tag was incorrect.TIMED_OUT=24— Operation timed out.WOULD_RECURSE=25— Operation would be recursive.BUSY=26— File is busy.WOULD_BLOCK=27— Operation would block.HOST_NOT_FOUND=28— Host couldn't be found (remote operations).WOULD_MERGE=29— Operation would merge files.FAILED_HANDLED=30— Operation failed and a helper program has already interacted with the user. Do not display any error dialog.TOO_MANY_OPEN_FILES=31— The current process has too many files open and can't open any more. Duplicate descriptors do count toward this limit. Since 2.20NOT_INITIALIZED=32— The object has not been initialized. Since 2.22ADDRESS_IN_USE=33— The requested address is already in use. Since 2.22PARTIAL_INPUT=34— Need more input to finish operation. Since 2.24INVALID_DATA=35— The input data was invalid. Since 2.24DBUS_ERROR=36— A remote object generated an error that doesn't correspond to a locally registeredGLib.Errorerror domain. UseDBusError.get_remote_errorto extract the D-Bus error name andDBusError.strip_remote_errorto fix up the message so it matches what was received on the wire. Since 2.26.HOST_UNREACHABLE=37— Host unreachable. Since 2.26NETWORK_UNREACHABLE=38— Network unreachable. Since 2.26CONNECTION_REFUSED=39— Connection refused. Since 2.26PROXY_FAILED=40— Connection to proxy server failed. Since 2.26PROXY_AUTH_FAILED=41— Proxy authentication failed. Since 2.26PROXY_NEED_AUTH=42— Proxy server needs authentication. Since 2.26PROXY_NOT_ALLOWED=43— Proxy connection is not allowed by ruleset. Since 2.26BROKEN_PIPE=44— Broken pipe. Since 2.36CONNECTION_CLOSED=44— Connection closed by peer. Note that this is the same code asIOErrorEnum.BROKEN_PIPE; before 2.44 some "connection closed" errors returnedIOErrorEnum.BROKEN_PIPE, but others returnedIOErrorEnum.FAILED. Now they should all return the same value, which has this more logical name. Since 2.44.NOT_CONNECTED=45— Transport endpoint is not connected. Since 2.44MESSAGE_TOO_LARGE=46— Message too large. Since 2.48.NO_SUCH_DEVICE=47— No such device found. Since 2.74DESTINATION_UNSET=48— Destination address unset. Since 2.80
IOModuleScopeFlags¶
Bit flags.
NONE=0— No module scan flagsBLOCK_DUPLICATES=1— When using this scope to load or scan modules, automatically block a modules which has the same base basename as previously loaded module.
IOStreamSpliceFlags¶
Bit flags.
NONE=0— Do not close either stream.CLOSE_STREAM1=1— Close the first stream after the splice.CLOSE_STREAM2=2— Close the second stream after the splice.WAIT_FOR_BOTH=4— Wait for both splice operations to finish before calling the callback.
MemoryMonitorWarningLevel¶
Enumeration.
LOW=50— Memory on the device is low, processes should free up unneeded resources (for example, in-memory caches) so they can be used elsewhere.MEDIUM=100— Same asG_MEMORY_MONITOR_WARNING_LEVEL_LOWbut the device has even less free memory, so processes should try harder to free up unneeded resources. If your process does not need to stay running, it is a good time for it to quit.CRITICAL=255— The system will soon start terminating processes to reclaim memory, including background processes.
MountMountFlags¶
Bit flags.
NONE=0— No flags set.
MountOperationResult¶
Enumeration.
HANDLED=0— The request was fulfilled and the user specified data is now availableABORTED=1— The user requested the mount operation to be abortedUNHANDLED=2— The request was unhandled (i.e. not implemented)
MountUnmountFlags¶
Bit flags.
NONE=0— No flags set.FORCE=1— Unmount even if there are outstanding file operations on the mount.
NetworkConnectivity¶
Enumeration.
LOCAL=1— The host is not configured with a route to the Internet; it may or may not be connected to a local network.LIMITED=2— The host is connected to a network, but does not appear to be able to reach the full Internet, perhaps due to upstream network problems.PORTAL=3— The host is behind a captive portal and cannot reach the full Internet.FULL=4— The host is connected to a network, and appears to be able to reach the full Internet.
NotificationPriority¶
Enumeration.
NORMAL=0— the default priority, to be used for the majority of notifications (for example email messages, software updates, completed download/sync operations)LOW=1— for notifications that do not require immediate attention - typically used for contextual background information, such as contact birthdays or local weatherHIGH=2— for events that require more attention, usually because responses are time-sensitive (for example chat and SMS messages or alarms)URGENT=3— for urgent notifications, or notifications that require a response in a short space of time (for example phone calls or emergency warnings)
OutputStreamSpliceFlags¶
Bit flags.
NONE=0— Do not close either stream.CLOSE_SOURCE=1— Close the source stream after the splice.CLOSE_TARGET=2— Close the target stream after the splice.
PasswordSave¶
Enumeration.
NEVER=0— never save a password.FOR_SESSION=1— save a password for the session.PERMANENTLY=2— save a password permanently.
PollableReturn¶
Enumeration.
FAILED=0— Generic error condition for when an operation fails.OK=1— The operation was successfully finished.WOULD_BLOCK=-27— The operation would block.
ResolverError¶
Enumeration.
NOT_FOUND=0— the requested name/address/service was not foundTEMPORARY_FAILURE=1— the requested information could not be looked up due to a network error or similar problemINTERNAL=2— unknown error
ResolverNameLookupFlags¶
Bit flags.
DEFAULT=0— default behavior (same asResolver.lookup_by_name)IPV4_ONLY=1— only resolve ipv4 addressesIPV6_ONLY=2— only resolve ipv6 addresses
ResolverRecordType¶
Enumeration.
SRV=1— look up DNS SRV records for a domainMX=2— look up DNS MX records for a domainTXT=3— look up DNS TXT records for a nameSOA=4— look up DNS SOA records for a zoneNS=5— look up DNS NS records for a domain
ResourceError¶
Enumeration.
NOT_FOUND=0— no file was found at the requested pathINTERNAL=1— unknown error
ResourceFlags¶
Bit flags.
NONE=0— No flags set.COMPRESSED=1— The file is compressed.
ResourceLookupFlags¶
Bit flags.
NONE=0— No flags set.
SettingsBindFlags¶
Bit flags.
DEFAULT=0— Equivalent toG_SETTINGS_BIND_GET|G_SETTINGS_BIND_SETGET=1— Update theGObject.Objectproperty when the setting changes. It is an error to use this flag if the property is not writable.SET=2— Update the setting when theGObject.Objectproperty changes. It is an error to use this flag if the property is not readable.NO_SENSITIVITY=4— Do not try to bind a ‘sensitivity’ property to the writability of the settingGET_NO_CHANGES=8— When set in addition toSettingsBindFlags.GET, set theGObject.Objectproperty value initially from the setting, but do not listen for changes of the settingINVERT_BOOLEAN=16— When passed toSettings.bind, uses a pair of mapping functions that invert the boolean value when mapping between the setting and the property. The setting and property must both be booleans. You cannot pass this flag toSettings.bind_with_mapping.
SocketClientEvent¶
Enumeration.
RESOLVING=0— The client is doing a DNS lookup.RESOLVED=1— The client has completed a DNS lookup.CONNECTING=2— The client is connecting to a remote host (either a proxy or the destination server).CONNECTED=3— The client has connected to a remote host.PROXY_NEGOTIATING=4— The client is negotiating with a proxy to connect to the destination server.PROXY_NEGOTIATED=5— The client has negotiated with the proxy server.TLS_HANDSHAKING=6— The client is performing a TLS handshake.TLS_HANDSHAKED=7— The client has performed a TLS handshake.COMPLETE=8— The client is done with a particularSocketConnectable.
SocketFamily¶
Enumeration.
INVALID=0— no address familyUNIX=1— the UNIX domain familyIPV4=2— the IPv4 familyIPV6=10— the IPv6 family
SocketListenerEvent¶
Enumeration.
BINDING=0— The listener is about to bind a socket.BOUND=1— The listener has bound a socket.LISTENING=2— The listener is about to start listening on this socket.LISTENED=3— The listener is now listening on this socket.
SocketMsgFlags¶
Bit flags.
NONE=0— No flags.OOB=1— Request to send/receive out of band data.PEEK=2— Read data from the socket without removing it from the queue.DONTROUTE=4— Don't use a gateway to send out the packet, only send to hosts on directly connected networks.
SocketProtocol¶
Enumeration.
UNKNOWN=-1— The protocol type is unknownDEFAULT=0— The default protocol for the family/typeTCP=6— TCP over IPUDP=17— UDP over IPSCTP=132— SCTP over IP
SocketType¶
Enumeration.
INVALID=0— Type unknown or wrongSTREAM=1— Reliable connection-based byte streams (e.g. TCP).DATAGRAM=2— Connectionless, unreliable datagram passing. (e.g. UDP)SEQPACKET=3— Reliable connection-based passing of datagrams of fixed maximum length (e.g. SCTP).
SubprocessFlags¶
Bit flags.
NONE=0— No flags.STDIN_PIPE=1— create a pipe for the stdin of the spawned process that can be accessed withSubprocess.get_stdin_pipe.STDIN_INHERIT=2— stdin is inherited from the calling process.STDOUT_PIPE=4— create a pipe for the stdout of the spawned process that can be accessed withSubprocess.get_stdout_pipe.STDOUT_SILENCE=8— silence the stdout of the spawned process (ie: redirect to/dev/null).STDERR_PIPE=16— create a pipe for the stderr of the spawned process that can be accessed withSubprocess.get_stderr_pipe.STDERR_SILENCE=32— silence the stderr of the spawned process (ie: redirect to/dev/null).STDERR_MERGE=64— merge the stderr of the spawned process with whatever the stdout happens to be. This is a good way of directing both streams to a common log file, for example.INHERIT_FDS=128— spawned processes will inherit the file descriptors of their parent, unless those descriptors have been explicitly marked as close-on-exec. This flag has no effect over the "standard" file descriptors (stdin, stdout, stderr).SEARCH_PATH_FROM_ENVP=256— if path searching is needed when spawning the subprocess, use thePATHin the launcher environment. (Since: 2.72)
TestDBusFlags¶
Bit flags.
NONE=0— No flags.
TlsAuthenticationMode¶
Enumeration.
NONE=0— client authentication not requiredREQUESTED=1— client authentication is requestedREQUIRED=2— client authentication is required
TlsCertificateFlags¶
Bit flags.
NO_FLAGS=0— No flags set. Since: 2.74UNKNOWN_CA=1— The signing certificate authority is not known.BAD_IDENTITY=2— The certificate does not match the expected identity of the site that it was retrieved from.NOT_ACTIVATED=4— The certificate's activation time is still in the futureEXPIRED=8— The certificate has expiredREVOKED=16— The certificate has been revoked according to theTlsConnection's certificate revocation list.INSECURE=32— The certificate's algorithm is considered insecure.GENERIC_ERROR=64— Some other error occurred validating the certificateVALIDATE_ALL=127— the combination of all of the above flags
TlsCertificateRequestFlags¶
Bit flags.
NONE=0— No flags
TlsChannelBindingError¶
Enumeration.
NOT_IMPLEMENTED=0— Either entire binding retrieval facility or specific binding type is not implemented in the TLS backend.INVALID_STATE=1— The handshake is not yet complete on the connection which is a strong requirement for any existing binding type.NOT_AVAILABLE=2— Handshake is complete but binding data is not available. That normally indicates the TLS implementation failed to provide the binding data. For example, some implementations do not provide a peer certificate for resumed connections.NOT_SUPPORTED=3— Binding type is not supported on the current connection. This error could be triggered when requestingtls-server-end-pointbinding data for a certificate which has no hash function or uses multiple hash functions.GENERAL_ERROR=4— Any other backend error preventing binding data retrieval.
TlsChannelBindingType¶
Enumeration.
UNIQUE=0—tls-uniquebinding typeSERVER_END_POINT=1—tls-server-end-pointbinding typeEXPORTER=2—tls-exporterbinding type. Since: 2.74
TlsDatabaseLookupFlags¶
Bit flags.
NONE=0— No lookup flagsKEYPAIR=1— Restrict lookup to certificates that have a private key.
TlsDatabaseVerifyFlags¶
Bit flags.
NONE=0— No verification flags
TlsError¶
Enumeration.
UNAVAILABLE=0— No TLS provider is availableMISC=1— Miscellaneous TLS errorBAD_CERTIFICATE=2— The certificate presented could not be parsed or failed validation.NOT_TLS=3— The TLS handshake failed because the peer does not seem to be a TLS server.HANDSHAKE=4— The TLS handshake failed because the peer's certificate was not acceptable.CERTIFICATE_REQUIRED=5— The TLS handshake failed because the server requested a client-side certificate, but none was provided. SeeTlsConnection.set_certificate.EOF=6— The TLS connection was closed without proper notice, which may indicate an attack. SeeTlsConnection.set_require_close_notify.INAPPROPRIATE_FALLBACK=7— The TLS handshake failed because the client sent the fallback SCSV, indicating a protocol downgrade attack. Since: 2.60BAD_CERTIFICATE_PASSWORD=8— The certificate failed to load because a password was incorrect. Since: 2.72
TlsInteractionResult¶
Enumeration.
UNHANDLED=0— The interaction was unhandled (i.e. not implemented).HANDLED=1— The interaction completed, and resulting data is available.FAILED=2— The interaction has failed, or was cancelled. and the operation should be aborted.
TlsPasswordFlags¶
Bit flags.
NONE=0— No flagsRETRY=2— The password was wrong, and the user should retry.MANY_TRIES=4— Hint to the user that the password has been wrong many times, and the user may not have many chances left.FINAL_TRY=8— Hint to the user that this is the last try to get this password right.PKCS11_USER=16— For PKCS #11, the user PIN is required. Since: 2.70.PKCS11_SECURITY_OFFICER=32— For PKCS #11, the security officer PIN is required. Since: 2.70.PKCS11_CONTEXT_SPECIFIC=64— For PKCS #11, the context-specific PIN is required. Since: 2.70.
TlsProtocolVersion¶
Enumeration.
UNKNOWN=0— No protocol version or unknown protocol versionSSL_3_0=1— SSL 3.0, which is insecure and should not be usedTLS_1_0=2— TLS 1.0, which is insecure and should not be usedTLS_1_1=3— TLS 1.1, which is insecure and should not be usedTLS_1_2=4— TLS 1.2, defined by RFC 5246TLS_1_3=5— TLS 1.3, defined by RFC 8446DTLS_1_0=201— DTLS 1.0, which is insecure and should not be usedDTLS_1_2=202— DTLS 1.2, defined by RFC 6347
TlsRehandshakeMode¶
Enumeration.
NEVER=0— Never allow rehandshakingSAFELY=1— Allow safe rehandshaking onlyUNSAFELY=2— Allow unsafe rehandshaking
UnixSocketAddressType¶
Enumeration.
INVALID=0— invalidANONYMOUS=1— anonymousPATH=2— a filesystem pathABSTRACT=3— an abstract nameABSTRACT_PADDED=4— an abstract name, 0-padded to the full length of a unix socket name
ZlibCompressorFormat¶
Enumeration.
ZLIB=0— deflate compression with zlib headerGZIP=1— gzip file formatRAW=2— deflate compression with no header
Constants¶
DBUS_METHOD_INVOCATION_HANDLED¶
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:
DBUS_METHOD_INVOCATION_UNHANDLED¶
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.
DEBUG_CONTROLLER_EXTENSION_POINT_NAME¶
Extension point for debug control functionality. See Extending GIO.
DRIVE_IDENTIFIER_KIND_UNIX_DEVICE¶
The string used to obtain a Unix device path with Drive.get_identifier.
FILE_ATTRIBUTE_ACCESS_CAN_DELETE¶
A key in the "access" namespace for checking deletion privileges.
Corresponding FileAttributeType is FileAttributeType.BOOLEAN.
This attribute will be True if the user is able to delete the file.
FILE_ATTRIBUTE_ACCESS_CAN_EXECUTE¶
A key in the "access" namespace for getting execution privileges.
Corresponding FileAttributeType is FileAttributeType.BOOLEAN.
This attribute will be True if the user is able to execute the file.
FILE_ATTRIBUTE_ACCESS_CAN_READ¶
A key in the "access" namespace for getting read privileges.
Corresponding FileAttributeType is FileAttributeType.BOOLEAN.
This attribute will be True if the user is able to read the file.
FILE_ATTRIBUTE_ACCESS_CAN_RENAME¶
A key in the "access" namespace for checking renaming privileges.
Corresponding FileAttributeType is FileAttributeType.BOOLEAN.
This attribute will be True if the user is able to rename the file.
FILE_ATTRIBUTE_ACCESS_CAN_TRASH¶
A key in the "access" namespace for checking trashing privileges.
Corresponding FileAttributeType is FileAttributeType.BOOLEAN.
This attribute will be True if the user is able to move the file to
the trash.
FILE_ATTRIBUTE_ACCESS_CAN_WRITE¶
A key in the "access" namespace for getting write privileges.
Corresponding FileAttributeType is FileAttributeType.BOOLEAN.
This attribute will be True if the user is able to write to the file.
FILE_ATTRIBUTE_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 FileAttributeType is FileAttributeType.BOOLEAN.
FILE_ATTRIBUTE_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 FileAttributeType is FileAttributeType.BOOLEAN.
FILE_ATTRIBUTE_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 FileAttributeType is FileAttributeType.BOOLEAN.
FILE_ATTRIBUTE_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 FileAttributeType is FileAttributeType.UINT32.
FILE_ATTRIBUTE_ETAG_VALUE¶
A key in the "etag" namespace for getting the value of the file's entity tag.
Corresponding FileAttributeType is FileAttributeType.STRING.
FILE_ATTRIBUTE_FILESYSTEM_FREE¶
A key in the "filesystem" namespace for getting the number of bytes of free space left on the file system.
Corresponding FileAttributeType is FileAttributeType.UINT64.
FILE_ATTRIBUTE_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 FileAttributeType is FileAttributeType.BOOLEAN.
FILE_ATTRIBUTE_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 FileAttributeType is FileAttributeType.BOOLEAN.
FILE_ATTRIBUTE_FILESYSTEM_SIZE¶
A key in the "filesystem" namespace for getting the total size (in
bytes) of the file system, used in File.query_filesystem_info.
Corresponding FileAttributeType is FileAttributeType.UINT64.
FILE_ATTRIBUTE_FILESYSTEM_TYPE¶
A key in the "filesystem" namespace for getting the file system's type.
Corresponding FileAttributeType is FileAttributeType.STRING.
FILE_ATTRIBUTE_FILESYSTEM_USED¶
A key in the "filesystem" namespace for getting the number of bytes used by data on the file system.
Corresponding FileAttributeType is FileAttributeType.UINT64.
FILE_ATTRIBUTE_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 FilesystemPreviewType.
FILE_ATTRIBUTE_GVFS_BACKEND¶
A key in the "gvfs" namespace that gets the name of the current GVFS backend in use.
Corresponding FileAttributeType is FileAttributeType.STRING.
FILE_ATTRIBUTE_ID_FILE¶
A key in the "id" namespace for getting a file identifier.
Corresponding FileAttributeType is FileAttributeType.STRING.
An example use would be during listing files, to avoid recursive directory scanning.
For local files on Linux, this is a combination of the file’s device number and inode, so is invariant with respect to hard linking. The format used by other VFS implementations may vary, and some VFS backends may not set it.
For simply seeing if two File instances refer to the same path
on disk, see File.equal.
FILE_ATTRIBUTE_ID_FILESYSTEM¶
A key in the "id" namespace for getting the file system identifier.
Corresponding FileAttributeType is 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).
FILE_ATTRIBUTE_MOUNTABLE_CAN_EJECT¶
A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) can be ejected.
Corresponding FileAttributeType is FileAttributeType.BOOLEAN.
FILE_ATTRIBUTE_MOUNTABLE_CAN_MOUNT¶
A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) is mountable.
Corresponding FileAttributeType is FileAttributeType.BOOLEAN.
FILE_ATTRIBUTE_MOUNTABLE_CAN_POLL¶
A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) can be polled.
Corresponding FileAttributeType is FileAttributeType.BOOLEAN.
FILE_ATTRIBUTE_MOUNTABLE_CAN_START¶
A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) can be started.
Corresponding FileAttributeType is FileAttributeType.BOOLEAN.
FILE_ATTRIBUTE_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 FileAttributeType is FileAttributeType.BOOLEAN.
FILE_ATTRIBUTE_MOUNTABLE_CAN_STOP¶
A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) can be stopped.
Corresponding FileAttributeType is FileAttributeType.BOOLEAN.
FILE_ATTRIBUTE_MOUNTABLE_CAN_UNMOUNT¶
A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) is unmountable.
Corresponding FileAttributeType is FileAttributeType.BOOLEAN.
FILE_ATTRIBUTE_MOUNTABLE_HAL_UDI¶
A key in the "mountable" namespace for getting the HAL UDI for the mountable file.
Corresponding FileAttributeType is FileAttributeType.STRING.
FILE_ATTRIBUTE_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 FileAttributeType is FileAttributeType.BOOLEAN.
FILE_ATTRIBUTE_MOUNTABLE_START_STOP_TYPE¶
A key in the "mountable" namespace for getting the DriveStartStopType.
Corresponding FileAttributeType is FileAttributeType.UINT32.
FILE_ATTRIBUTE_MOUNTABLE_UNIX_DEVICE¶
A key in the "mountable" namespace for getting the unix device.
Corresponding FileAttributeType is FileAttributeType.UINT32.
FILE_ATTRIBUTE_MOUNTABLE_UNIX_DEVICE_FILE¶
A key in the "mountable" namespace for getting the unix device file.
Corresponding FileAttributeType is FileAttributeType.STRING.
FILE_ATTRIBUTE_OWNER_GROUP¶
A key in the "owner" namespace for getting the file owner's group.
Corresponding FileAttributeType is FileAttributeType.STRING.
FILE_ATTRIBUTE_OWNER_USER¶
A key in the "owner" namespace for getting the user name of the file's owner.
Corresponding FileAttributeType is FileAttributeType.STRING.
FILE_ATTRIBUTE_OWNER_USER_REAL¶
A key in the "owner" namespace for getting the real name of the user that owns the file.
Corresponding FileAttributeType is FileAttributeType.STRING.
FILE_ATTRIBUTE_PREVIEW_ICON¶
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 FileAttributeType.OBJECT.
The value for this key should contain a Icon.
FILE_ATTRIBUTE_RECENT_MODIFIED¶
A key in the "recent" namespace for getting time, when the metadata for the
file in recent:/// was last changed.
Corresponding FileAttributeType is FileAttributeType.INT64.
FILE_ATTRIBUTE_SELINUX_CONTEXT¶
A key in the "selinux" namespace for getting the file's SELinux context.
Corresponding FileAttributeType is FileAttributeType.STRING.
Note that this attribute is only available if GLib has been built with SELinux support.
FILE_ATTRIBUTE_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 FileAttributeType is FileAttributeType.UINT64.
FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE¶
A key in the "standard" namespace for getting the content type of the file.
Corresponding FileAttributeType is FileAttributeType.STRING.
The value for this key should contain a valid content type.
FILE_ATTRIBUTE_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 FileAttributeType is FileAttributeType.STRING.
FILE_ATTRIBUTE_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 FileAttributeType is FileAttributeType.STRING.
FILE_ATTRIBUTE_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 FileAttributeType is FileAttributeType.STRING.
FILE_ATTRIBUTE_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 FileAttributeType is FileAttributeType.STRING.
FILE_ATTRIBUTE_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 FileAttributeType is FileAttributeType.STRING.
FILE_ATTRIBUTE_STANDARD_ICON¶
A key in the "standard" namespace for getting the icon for the file.
Corresponding FileAttributeType is FileAttributeType.OBJECT.
The value for this key should contain a Icon.
FILE_ATTRIBUTE_STANDARD_IS_BACKUP¶
A key in the "standard" namespace for checking if a file is a backup file.
The exact semantics of what constitutes a backup file are backend-specific.
For local files, a file is considered a backup if its name ends with ~
and it is a regular file. This follows the POSIX convention used by text
editors such as Emacs.
Corresponding FileAttributeType is FileAttributeType.BOOLEAN.
FILE_ATTRIBUTE_STANDARD_IS_HIDDEN¶
A key in the "standard" namespace for checking if a file is hidden.
Corresponding FileAttributeType is FileAttributeType.BOOLEAN.
FILE_ATTRIBUTE_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 FileAttributeType is FileAttributeType.BOOLEAN.
FILE_ATTRIBUTE_STANDARD_IS_VIRTUAL¶
A key in the "standard" namespace for checking if a file is virtual.
Corresponding FileAttributeType is FileAttributeType.BOOLEAN.
FILE_ATTRIBUTE_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 FILE_ATTRIBUTE_STANDARD_SYMLINK_TARGET for the persistent URI.
Corresponding FileAttributeType is FileAttributeType.BOOLEAN.
FILE_ATTRIBUTE_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 FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME if you need to display the
name in a user interface.
Corresponding FileAttributeType is FileAttributeType.BYTE_STRING.
FILE_ATTRIBUTE_STANDARD_SIZE¶
A key in the "standard" namespace for getting the file's size (in bytes).
Corresponding FileAttributeType is FileAttributeType.UINT64.
FILE_ATTRIBUTE_STANDARD_SORT_ORDER¶
A key in the "standard" namespace for setting the sort order of a file.
Corresponding FileAttributeType is 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.
FILE_ATTRIBUTE_STANDARD_SYMBOLIC_ICON¶
A key in the "standard" namespace for getting the symbolic icon for the file.
Corresponding FileAttributeType is FileAttributeType.OBJECT.
The value for this key should contain a Icon.
FILE_ATTRIBUTE_STANDARD_SYMLINK_TARGET¶
A key in the "standard" namespace for getting the symlink target, if the file is a symlink.
Corresponding FileAttributeType is FileAttributeType.BYTE_STRING.
FILE_ATTRIBUTE_STANDARD_TARGET_URI¶
A key in the "standard" namespace for getting the target URI for the file, in
the case of FileType.SHORTCUT or FileType.MOUNTABLE files.
Corresponding FileAttributeType is FileAttributeType.STRING.
FILE_ATTRIBUTE_STANDARD_TYPE¶
A key in the "standard" namespace for storing file types.
Corresponding FileAttributeType is FileAttributeType.UINT32.
The value for this key should contain a FileType.
FILE_ATTRIBUTE_THUMBNAILING_FAILED¶
A key in the "thumbnail" namespace for checking if thumbnailing failed.
This attribute is True if thumbnailing failed.
Corresponding FileAttributeType is FileAttributeType.BOOLEAN.
FILE_ATTRIBUTE_THUMBNAILING_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 FileAttributeType is FileAttributeType.BOOLEAN.
FILE_ATTRIBUTE_THUMBNAILING_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 FileAttributeType is FileAttributeType.BOOLEAN.
FILE_ATTRIBUTE_THUMBNAILING_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 FileAttributeType is FileAttributeType.BOOLEAN.
FILE_ATTRIBUTE_THUMBNAILING_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 FileAttributeType is FileAttributeType.BOOLEAN.
FILE_ATTRIBUTE_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 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 FileAttributeType.BOOLEAN.
FILE_ATTRIBUTE_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 FILE_ATTRIBUTE_THUMBNAILING_FAILED_LARGE is True and this attribute
is False, it indicates that thumbnailing may be attempted again and may
succeed.
Corresponding FileAttributeType is FileAttributeType.BOOLEAN.
FILE_ATTRIBUTE_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 FILE_ATTRIBUTE_THUMBNAILING_FAILED_NORMAL is True and this attribute
is False, it indicates that thumbnailing may be attempted again and may
succeed.
Corresponding FileAttributeType is FileAttributeType.BOOLEAN.
FILE_ATTRIBUTE_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 FILE_ATTRIBUTE_THUMBNAILING_FAILED_XLARGE is True and this attribute
is False, it indicates that thumbnailing may be attempted again and may
succeed.
Corresponding FileAttributeType is FileAttributeType.BOOLEAN.
FILE_ATTRIBUTE_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 FILE_ATTRIBUTE_THUMBNAILING_FAILED_XXLARGE is True and this attribute
is False, it indicates that thumbnailing may be attempted again and may
succeed.
Corresponding FileAttributeType is FileAttributeType.BOOLEAN.
FILE_ATTRIBUTE_THUMBNAIL_PATH¶
A key in the "thumbnail" namespace for getting the path to the thumbnail image with the biggest size available.
Corresponding FileAttributeType is FileAttributeType.BYTE_STRING.
FILE_ATTRIBUTE_THUMBNAIL_PATH_LARGE¶
A key in the "thumbnail" namespace for getting the path to the large thumbnail image.
Corresponding FileAttributeType is FileAttributeType.BYTE_STRING.
FILE_ATTRIBUTE_THUMBNAIL_PATH_NORMAL¶
A key in the "thumbnail" namespace for getting the path to the normal thumbnail image.
Corresponding FileAttributeType is FileAttributeType.BYTE_STRING.
FILE_ATTRIBUTE_THUMBNAIL_PATH_XLARGE¶
A key in the "thumbnail" namespace for getting the path to the x-large thumbnail image.
Corresponding FileAttributeType is FileAttributeType.BYTE_STRING.
FILE_ATTRIBUTE_THUMBNAIL_PATH_XXLARGE¶
A key in the "thumbnail" namespace for getting the path to the xx-large thumbnail image.
Corresponding FileAttributeType is FileAttributeType.BYTE_STRING.
FILE_ATTRIBUTE_TIME_ACCESS¶
A key in the "time" namespace for getting the time the file was last accessed.
Corresponding FileAttributeType is FileAttributeType.UINT64, and
contains the time since the file was last accessed, in seconds since the
UNIX epoch.
FILE_ATTRIBUTE_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 FileAttributeType is
FileAttributeType.UINT32.
FILE_ATTRIBUTE_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 FILE_ATTRIBUTE_TIME_ACCESS.
Corresponding FileAttributeType is FileAttributeType.UINT32.
FILE_ATTRIBUTE_TIME_CHANGED¶
A key in the "time" namespace for getting the time the file was last changed.
Corresponding FileAttributeType is 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.
FILE_ATTRIBUTE_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 FileAttributeType is
FileAttributeType.UINT32.
FILE_ATTRIBUTE_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 FILE_ATTRIBUTE_TIME_CHANGED.
Corresponding FileAttributeType is FileAttributeType.UINT32.
FILE_ATTRIBUTE_TIME_CREATED¶
A key in the "time" namespace for getting the time the file was created.
Corresponding FileAttributeType is 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.
FILE_ATTRIBUTE_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 FileAttributeType is
FileAttributeType.UINT32.
FILE_ATTRIBUTE_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 FILE_ATTRIBUTE_TIME_CREATED.
Corresponding FileAttributeType is FileAttributeType.UINT32.
FILE_ATTRIBUTE_TIME_MODIFIED¶
A key in the "time" namespace for getting the time the file was last modified.
Corresponding FileAttributeType is FileAttributeType.UINT64, and
contains the time since the file was modified, in seconds since the UNIX
epoch.
FILE_ATTRIBUTE_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 FileAttributeType is
FileAttributeType.UINT32.
FILE_ATTRIBUTE_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 FILE_ATTRIBUTE_TIME_MODIFIED.
Corresponding FileAttributeType is FileAttributeType.UINT32.
FILE_ATTRIBUTE_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 FileAttributeType is FileAttributeType.STRING.
FILE_ATTRIBUTE_TRASH_ITEM_COUNT¶
A key in the "trash" namespace for getting the number of (toplevel) items
that are present in the trash:/// folder.
Corresponding FileAttributeType is FileAttributeType.UINT32.
FILE_ATTRIBUTE_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 FileAttributeType is FileAttributeType.BYTE_STRING.
FILE_ATTRIBUTE_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 FileAttributeType is FileAttributeType.UINT64.
FILE_ATTRIBUTE_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 FileAttributeType is FileAttributeType.UINT32.
FILE_ATTRIBUTE_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 FileAttributeType is FileAttributeType.UINT32.
FILE_ATTRIBUTE_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 FileAttributeType is FileAttributeType.UINT32.
FILE_ATTRIBUTE_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 FileAttributeType is FileAttributeType.UINT64.
FILE_ATTRIBUTE_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 FileAttributeType is FileAttributeType.BOOLEAN.
FILE_ATTRIBUTE_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 FileAttributeType is FileAttributeType.UINT32.
FILE_ATTRIBUTE_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 FileAttributeType is FileAttributeType.UINT32.
FILE_ATTRIBUTE_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 FileAttributeType is FileAttributeType.UINT32.
FILE_ATTRIBUTE_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 FileAttributeType is FileAttributeType.UINT32.
MEMORY_MONITOR_EXTENSION_POINT_NAME¶
Extension point for memory usage monitoring functionality. See Extending GIO.
MENU_ATTRIBUTE_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 g_menu_model_get_item_attribute() and g_menu_item_set_attribute().
MENU_ATTRIBUTE_ACTION_NAMESPACE¶
The menu item attribute that holds the namespace for all action names in menus that are linked from this item.
MENU_ATTRIBUTE_ICON¶
The menu item attribute which holds the icon of the item.
The icon is stored in the format returned by 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).
MENU_ATTRIBUTE_LABEL¶
The menu item attribute which holds the label of the item.
MENU_ATTRIBUTE_TARGET¶
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()
MENU_EXPORTER_MAX_SECTION_SIZE¶
The maximum number of entries in a menu section supported by
DBusConnection.export_menu_model.
The exact value of the limit may change in future GLib versions.
MENU_LINK_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 MenuItem.set_link.
MENU_LINK_SUBMENU¶
The name of the link that associates a menu item with a submenu.
See also MenuItem.set_link.
NATIVE_VOLUME_MONITOR_EXTENSION_POINT_NAME¶
NETWORK_MONITOR_EXTENSION_POINT_NAME¶
Extension point for network status monitoring functionality. See Extending GIO.
POWER_PROFILE_MONITOR_EXTENSION_POINT_NAME¶
Extension point for power profile usage monitoring functionality. See Extending GIO.
PROXY_EXTENSION_POINT_NAME¶
Extension point for proxy functionality. See Extending GIO.
PROXY_RESOLVER_EXTENSION_POINT_NAME¶
Extension point for proxy resolving functionality. See Extending GIO.
SETTINGS_BACKEND_EXTENSION_POINT_NAME¶
Extension point for SettingsBackend functionality.
TLS_BACKEND_EXTENSION_POINT_NAME¶
Extension point for TLS functionality via TlsBackend.
See Extending GIO.
TLS_DATABASE_PURPOSE_AUTHENTICATE_CLIENT¶
The purpose used to verify the client certificate in a TLS connection. Used by TLS servers.
TLS_DATABASE_PURPOSE_AUTHENTICATE_SERVER¶
The purpose used to verify the server certificate in a TLS connection. This is the most common purpose in use. Used by TLS clients.
VFS_EXTENSION_POINT_NAME¶
Extension point for Vfs functionality.
See Extending GIO.
VOLUME_IDENTIFIER_KIND_CLASS¶
The string used to obtain the volume class with Volume.get_identifier.
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 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.
VOLUME_IDENTIFIER_KIND_HAL_UDI¶
The string used to obtain a Hal UDI with Volume.get_identifier.
VOLUME_IDENTIFIER_KIND_LABEL¶
The string used to obtain a filesystem label with Volume.get_identifier.
VOLUME_IDENTIFIER_KIND_NFS_MOUNT¶
The string used to obtain a NFS mount with Volume.get_identifier.
VOLUME_IDENTIFIER_KIND_UNIX_DEVICE¶
The string used to obtain a Unix device path with Volume.get_identifier.
VOLUME_IDENTIFIER_KIND_UUID¶
The string used to obtain a UUID with Volume.get_identifier.
VOLUME_MONITOR_EXTENSION_POINT_NAME¶
Extension point for volume monitor functionality. See Extending GIO.
Callbacks¶
AsyncReadyCallback¶
BusAcquiredCallback¶
BusNameAcquiredCallback¶
BusNameAppearedCallback¶
BusNameLostCallback¶
BusNameVanishedCallback¶
CancellableSourceFunc¶
DBusInterfaceGetPropertyFunc¶
DBusInterfaceGetPropertyFunc = Callable[[connection: DBusConnection, sender: str | None, object_path: str, interface_name: str, property_name: str, error: GLib.Error], GLib.Variant]
DBusInterfaceMethodCallFunc¶
DBusInterfaceMethodCallFunc = Callable[[connection: DBusConnection, sender: str | None, object_path: str, interface_name: str | None, method_name: str, parameters: GLib.Variant, invocation: DBusMethodInvocation], None]
DBusInterfaceSetPropertyFunc¶
DBusInterfaceSetPropertyFunc = Callable[[connection: DBusConnection, sender: str | None, object_path: str, interface_name: str, property_name: str, value: GLib.Variant, error: GLib.Error], bool]
DBusMessageFilterFunction¶
DBusMessageFilterFunction = Callable[[connection: DBusConnection, message: DBusMessage, incoming: bool], DBusMessage]
DBusProxyTypeFunc¶
DBusProxyTypeFunc = Callable[[manager: DBusObjectManagerClient, object_path: str, interface_name: str | None], type | GObject.Type]
DBusSignalCallback¶
DBusSignalCallback = Callable[[connection: DBusConnection, sender_name: str | None, object_path: str, interface_name: str, signal_name: str, parameters: GLib.Variant], None]
DBusSubtreeDispatchFunc¶
DBusSubtreeDispatchFunc = Callable[[connection: DBusConnection, sender: str, object_path: str, interface_name: str, node: str, out_user_data: int], DBusInterfaceVTable]
DBusSubtreeEnumerateFunc¶
DBusSubtreeEnumerateFunc = Callable[[connection: DBusConnection, sender: str, object_path: str], list[str]]
DBusSubtreeIntrospectFunc¶
DBusSubtreeIntrospectFunc = Callable[[connection: DBusConnection, sender: str, object_path: str, node: str], list[DBusInterfaceInfo]]
DatagramBasedSourceFunc¶
DatagramBasedSourceFunc = Callable[[datagram_based: DatagramBased, condition: GLib.IOCondition | int], bool]
FileMeasureProgressCallback¶
FileMeasureProgressCallback = Callable[[reporting: bool, current_size: int, num_dirs: int, num_files: int], None]
FileProgressCallback¶
FileReadMoreCallback¶
IOSchedulerJobFunc¶
PollableSourceFunc¶
ReallocFunc¶
SettingsBindGetMapping¶
SettingsBindSetMapping¶
SettingsBindSetMapping = Callable[[value: GObject.Value, expected_type: GLib.VariantType], GLib.Variant]
SettingsGetMapping¶
SimpleAsyncThreadFunc¶
SimpleAsyncThreadFunc = Callable[[res: SimpleAsyncResult, object: GObject.Object, cancellable: Cancellable | None], None]
SocketSourceFunc¶
TaskThreadFunc¶
TaskThreadFunc = Callable[[task: Task, source_object: GObject.Object, task_data: int | None, cancellable: Cancellable | None], None]