Up: cl-cffi-gtk4 API documentation

Package gio

This is the API documentation of a Lisp binding to GIO. GIO is striving to provide a modern, easy-to-use VFS API that sits at the right level in the library stack, as well as other generally useful APIs for desktop applications (such as networking and D-Bus support). The goal is to overcome the shortcomings of GnomeVFS and provide an API that is so good that developers prefer it over raw POSIX calls. Among other things that means using GObject. It also means not cloning the POSIX API, but providing higher-level, document-centric interfaces.

About This Package

File Operations
Asynchronous I/O
File types and applications
Icons
Resources
Permissions
Data models
Application support

File Operations


GFile

GFlags gio:file-query-info-flags
Flags used when querying a g:file-info instance. ...

Interface gio:file
The g:file interface is a high level abstraction for manipulating files on a virtual file system. ...

Type gio:file-as-namestring
The g:file-as-namestring type specifier represents and performs automatic conversion between a Lisp namestring and a g:file object for files on a virtual file system. ...

Function gio:file-new-for-path (path)
Constructs a g:file object for a given path. ...

Function gio:file-new-for-uri (uri)
Constructs a g:file object for a given URI. ...

Function gio:file-new-for-commandline-arg (arg)
Creates a g:file object with the given arg from the command line. ...

Function gio:file-new-for-commandline-arg-and-cwd (arg cwd)
Creates a g:file object with the given arg from the command line. ...

Function gio:file-query-info (file attributes flags &optional cancellable)
Gets the requested information about the specified file. ...

Function gio:file-parse-name (parsename)
Constructs a g:file object with the given parsename, that is, something given by the g:file-get-parse-name function. ...

Function gio:file-basename (file)
Gets the base name, the last component of the path, for a given g:file object. ...

Function gio:file-path (file)
Gets the local pathname for file, if one exists. ...

Function gio:file-uri (file)
Gets the local pathname for file, if one exists. ...

Function gio:file-get-parse-name (file)
Gets the parse name for the file. ...


GFileInfo

Class gio:file-info
The g:file-info class implements methods for getting information that all files should contain, and allows for manipulation of extended attributes. ...

Function gio:file-info-new ()
Creates a new g:file-info instance. ...

Function gio:file-info-clear-status (info)

Function gio:file-info-access-date-time (info)

Function gio:file-info-attribute-as-string (info attribute)

Function gio:file-info-attribute-boolean (info)

Function gio:file-info-modification-date-time (info)

Function gio:file-info-name (info)

Function gio:file-info-size (info)

Function gio:file-info-has-attribute (info attribute)

Function gio:file-info-has-namespace (info namespace)

Function gio:file-info-list-attributes (info &optional namespace)

Asynchronous I/O


GCancellable

Class gio:cancellable
The gio:cancellable object allows operations to be cancelled. ...

Callback gio:cancellable-source-func
This is the function type of the callback used for the g:source instance returned by the g:cancellable-source-new function. ...

Function gio:cancellable-new ()
Creates a new g:cancellable object. ...

Function gio:cancellable-is-cancelled (cancellable)
Checks if a cancellable job has been cancelled. ...

Function gio:cancellable-source-new (cancellable)
Creates a source that triggers if cancellable is cancelled and calls its g:cancellable-source-func callback function. ...

Function gio:cancellable-current ()
Gets the top cancellable from the stack. ...

Function gio:cancellable-pop-current (cancellalbe)
Pops cancellable off the cancellable stack (verifying that cancellable is on the top of the stack). ...

Function gio:cancellable-push-current (cancellable)
Pushes cancellable onto the cancellable stack. ...

Function gio:cancellable-reset (cancellabel)
Resets cancellable to its uncancelled state. ...

Function gio:cancellable-cancel (cancellable)
Will set cancellable to cancelled, and will emit the "cancelled" signal. ...


GAsyncResult

Interface gio:async-result
Provides a base class for implementing asynchronous function results. ...

Callback gio:async-ready-callback
Type definition for a function that will be called back when an asynchronous operation within GIO has been completed. ...

Function gio:async-result-user-data (result)
Gets the user data from a g:async-result instance. ...

Function gio:async-result-source-object (result)
Gets the source object from a g:async-result instance. ...

Function gio:async-result-is-tagged (result tag)
Checks if result has the given tag, generally a function pointer indicating the result function was created by. ...


GTask

Class gio:task
The g:task class represents and manages a cancellable "task". ...

Accessor gio:task-completed (object)
Gets the value of the completed property. ...

Function gio:task-new (source cancellable func)
Creates a g:task instance acting on source, which will eventually be used to invoke callback in the current thread-default main context. ...

Function gio:task-task-data (task)

Function gio:task-priority (task)
The g:task-priority function gets the priority of the task. ...

Function gio:task-check-cancellable (task)
The g:task-check-cancellable function gets the check-cancellable flag of task. ...

Function gio:task-cancellable (task)
Gets the g:cancellable instance of the task. ...

Function gio:task-context (task)
Gets the g:main-context instance that task will return its result in ...

Function gio:task-source-object (task)
Gets the source object from task. ...

Function gio:task-return-boolean (task result)
Sets the result of the g:task instance to result and completes the task. ...

Function gio:task-return-pointer (task result)

Function gio:task-propagate-pointer (task)

Function gio:task-run-in-thread (task func)

Symbol gio:task-thread-func

File types and applications


Introduction to GContentType

A content type is a platform specific string that defines the type of a file. On UNIX it is a MIME type like "text/plain" or "image/png". On Win32 it is an extension string like ".doc", ".txt" or a perceived string like "audio". Such strings can be looked up in the registry at HKEY_CLASSES_ROOT. On macOS it is a Uniform Type Identifier such as com.apple.application.

Functions for GContentType

Function gio:content-type-equals (ctype1 ctype2)
Compares two content types for equality. ...

Function gio:content-type-is-a (ctype supertype)
Determines if ctype is a subset of supertype. ...

Function gio:content-type-is-mime-type (ctype mimetype)
Determines if ctype is a subset of mimetype. ...

Function gio:content-type-is-unknown (ctype)
Checks if the content type is the generic "unknown" content type. ...

Function gio:content-type-description (ctype)
Gets the human readable description of the content type. ...

Function gio:content-type-mime-type (ctype)
Gets the MIME type for the content type, if one is registered. ...

Function gio:content-type-mime-dirs ()
The g:content-type-mime-type function gets the list of directories which MIME data is loaded from. ...

Function gio:content-type-icon (ctype)
Gets the icon for a content type. ...

Function gio:content-type-symbolic-icon (ctype)
Gets the symbolic icon for a content type. ...

Function gio:content-type-generic-icon-name (ctype)
Gets the generic icon name for a content type. ...

Function gio:content-type-can-be-executable (ctype)
Checks if a content type can be executable. ...

Function gio:content-type-from-mime-type (mimetype)
Tries to find a content type based on the MIME type name. ...

Function gio:content-types-registered ()
Gets a list of strings containing all the registered content types known to the system. ...


GAppInfo

GFlags gio:app-info-create-flags
Flags used when creating a g:app-info instance. ...

Interface gio:app-info
Information about an installed application and methods to launch it with file arguments. ...

Function gio:app-info-create-from-commandline (cmdline application flags)
Creates a new g:app-info instance from the given information. ...

Function gio:app-info-dup (info)
Creates a duplicate of an application info. ...

Function gio:app-info-equal (info1 info2)
Checks if two application infos are equal. ...

Function gio:app-info-id (info)
Gets the ID of an application. ...

Function gio:app-info-name (info)
Gets the installed name of the application. ...

Function gio:app-info-display-name (info)
Gets the display name of the application. ...

Function gio:app-info-description (info)
Gets a human readable description of an installed application. ...

Function gio:app-info-executable (info)
Gets the name of the executable for the installed application. ...

Function gio:app-info-commandline (info)
Gets the commandline with which the application will be started. ...

Function gio:app-info-icon (info)
Gets the icon for the application. ...

Function gio:app-info-launch (info files context)
Launches the application. ...

Function gio:app-info-supports-files (info)
Checks if the application accepts files as arguments. ...

Function gio:app-info-supports-uris (info)
Checks if the application supports reading files and directories from URIs. ...

Function gio:app-info-launch-uris (info uris context)
Launches the application. ...

Function gio:app-info-should-show (info)
Checks if the application info should be shown in menus that list available applications. ...

Function gio:app-info-can-delete (info)
Obtains the information whether the application info can be deleted. ...

Function gio:app-info-delete (info)
Tries to delete an application info. ...

Function gio:app-info-reset-type-associations (content-type)
Removes all changes to the type associations done by the g:app-info-set-as-default-for-type, g:app-info-set-as-default-for-extension, g:app-info-add-supports-type or g:app-info-remove-supports-type function. ...

Function gio:app-info-set-as-default-for-type (info content-type)
Sets the application as the default handler for a given content type. ...

Function gio:app-info-set-as-default-for-extension (info extension)
Sets the application as the default handler for the given file extension. ...

Function gio:app-info-set-as-last-used-for-type (info content-type)
Sets the application as the last used application for a given content type. ...

Function gio:app-info-add-supports-type (info content-type)
Adds a content type to the application information to indicate the application is capable of opening files with the given content type. ...

Function gio:app-info-can-remove-supports-type (info)
Checks if a supported content type can be removed from an application. ...

Function gio:app-info-remove-supports-type (info content-type)
Removes a supported content type from an application information, if possible. ...

Function gio:app-info-supported-types (info)
Retrieves the list of content types that info claims to support. ...

Function gio:app-info-all ()
Gets a list of all application infos for the applications currently registered on this system. ...

Function gio:app-info-all-for-type (content-type)
Gets a list of all application infos for a given content type, including the recommended and fallback application infos. ...

Function gio:app-info-default-for-type (content-type must-support-uris)
Gets the default application info for a given content type. ...

Function gio:app-info-default-for-uri-scheme (uri-scheme)
Gets the default application for handling URIs with the given URI scheme. ...

Function gio:app-info-fallback-for-type (content-type)
Gets a list of fallback application infos for a given content type, that is, those applications which claim to support the given content type by MIME type subclassing and not directly. ...

Function gio:app-info-recommended-for-type (content-type)
Gets a list of recommended application infos for a given content type, that is, those applications which claim to support the given content type exactly, and not by MIME type subclassing. ...

Function gio:app-info-launch-default-for-uri (uri &optional context)
Utility function that launches the default application registered to handle the specified URI. ...

Function gio:app-info-launch-default-for-uri-async (uri context cancellable func)
Asynchronous version of the g:app-info-launch-default-for-uri function. ...

Function gio:app-info-launch-default-for-uri-finish (result)
Finishes an asynchronous g:app-info-launch-default-for-uri-async operation. ...

Class gio:app-launch-context
Integrating the launch with the launching application. ...

Function gio:app-launch-context-new ()
Creates a new application launch context. ...

Function gio:app-launch-context-setenv (context variable value)
Arranges for variable to be set to value in the child's environment when context is used to launch an application. ...

Function gio:app-launch-context-unsetenv (context variable)
Arranges for variable to be unset in the child's environment when context is used to launch an application. ...

Function gio:app-launch-context-environment (context)
Gets the complete environment variable list to be passed to the child process when context is used to launch an application. ...

Function gio:app-launch-context-display (context info files)
Gets the display string for the context. ...

Function gio:app-launch-context-startup-notify-id (context info files)
Initiates startup notification for the application and returns the DESKTOP_STARTUP_ID for the launched operation, if supported. ...

Function gio:app-launch-context-launch-failed (context startup-notify-id)
Called when an application has failed to launch, so that it can cancel the application startup notification started in the g:app-launch-context-startup-notify-id function. ...

Icons


GIcon

Interface gio:icon
The g:icon interface is a very minimal interface for icons. ...

Function gio:icon-hash (icon)
Gets a hash for an icon. ...

Function gio:icon-equal (icon1 icon2)
Checks if two icons are equal. ...

Function gio:icon-to-string (icon)
Generates a textual representation of the icon that can be used for serialization such as when passing the icon to a different process or saving it to persistent storage. ...

Function gio:icon-new-for-string (str)
Generate a g:icon object from the str argument. ...

Function gio:icon-serialize (icon)
Serializes a g:icon object into a g:variant parameter. ...

Function gio:icon-deserialize (value)
Deserializes a g:icon object previously serialized using the g:icon-serialize function. ...


GFileIcon

Class gio:file-icon
The g:file-icon class specifies an icon by pointing to an image file to be used as icon. ...

Accessor gio:file-icon-file (object)
Accessor of the file slot of the g:file-icon class. ...

Function gio:file-icon-new (file)
Creates a new icon for a file. ...


GLoadableIcon

Interface gio:loadable-icon
Extends the g:icon interface and adds the ability to load icons from streams. ...


GThemedIcon

Class gio:themed-icon
The g:themed-icon class is an implementation of the g:icon interface that supports icon themes. ...

Accessor gio:themed-icon-name (object)
Accessor of the name slot of the g:themed-icon class. ...

Accessor gio:themed-icon-names (object)
Accessor of the names slot of the g:themed-icon class. ...

Accessor gio:themed-icon-use-default-fallbacks (object)
Accessor of the use-default-fallbacks slot of the g:themed-icon class. ...

Function gio:themed-icon-new (name)
Creates a new themed icon for the icon name. ...

Function gio:themed-icon-new-from-names (&rest names)
Creates a new themed icon for names. ...

Function gio:themed-icon-new-with-default-fallbacks (name)
Creates a new themed icon for name, and all the names that can be created by shortening iconname at '-' characters. ...

Function gio:themed-icon-prepend-name (icon name)
Prepend a name to the list of icons from within icon. ...

Function gio:themed-icon-append-name (icon name)
Append a name to the list of icons from within icon. ...


GEmblem

GEnum gio:emblem-origin
The g:emblem-origin enumeration is used to add information about the origin of the emblem to a g:emblem object. ...

Class gio:emblem
The g:emblem class is an implementation of the g:icon class that supports having an emblem, which is an icon with additional properties. ...

Accessor gio:emblem-icon (object)
Accessor of the icon slot of the g:emblem class. ...

Accessor gio:emblem-origin (object)
Accessor of the origin slot of the g:emblem class. ...

Function gio:emblem-new (icon)
Creates a new emblem for an icon. ...

Function gio:emblem-new-with-origin (icon origin)
Creates a new emblem for an icon. ...


GEmblemedIcon

Class gio:emblemed-icon
The g:emblemed-icon class is an implementation of the g:icon interface that supports adding an emblem to an icon. ...

Accessor gio:emblemed-icon-gicon (object)
Accessor of the gicon slot of the g:emblemed-icon class. ...

Function gio:emblemed-icon-new (icon emblem)
Creates a new emblemed icon for icon with the emblem emblem. ...

Function gio:emblemed-icon-icon (emblemed)
Gets the main icon for the emblemed icon. ...

Function gio:emblemed-icon-emblems (emblemed)
Gets the list of emblems for the emblemed icon. ...

Function gio:emblemed-icon-add-emblem (emblemed emblem)
Adds emblem to the list emblems for the emblemed icon. ...

Function gio:emblemed-icon-clear-emblems (emblemed)
Removes all the emblems from the emblemed icon. ...

Resources

GFlags gio:resource-flags
The g:resource-flags flags give information about a particular file inside a resource bundle. ...

GFlags gio:resource-lookup-flags
The g:resource-lookup-flags flags determine how resource path lookups are handled. ...

GBoxed gio:resource
Applications and libraries often contain binary or textual data that is really part of the application, rather than user data. ...

Macro gio:with-resource ((resource path) &body body)
The g:with-resource macro allocates a new g:resource instance, loads the resource from a file, register the resource with the process-global set of resources and executes the body that uses the resources. ...

Macro gio:with-resources (vars &body body)
The g:with-resources macro creates new variable bindings and executes the body that use these bindings. ...

Function gio:resource-load (path)
Loads a binary resource bundle and creates a g:resource instance representation of it, allowing you to query it for data. ...

Function gio:resource-lookup-data (resource path lookup)
Looks for a file at the specified path in the resource and returns a pointer that lets you directly access the data in memory. ...

Function gio:resource-enumerate-children (resource path lookup)
Returns all the names of children at the specified path in the resource. ...

Function gio:resource-info (resource path lookup)
Looks for a file at the specified path in the resource and if found returns information about it. ...

Function gio:resources-register (resource)
Registers the resource with the process-global set of resources. ...

Function gio:resources-unregister (resource)
Unregisters the resource from the process-global set of resources. ...

Function gio:resources-lookup-data (path &optional lookup)
Looks for a file at the specified path in the set of globally registered resources and returns a pointer that lets you directly access the data in memory. ...

Function gio:resources-enumerate-children (path lookup)
Returns all the names of children at the specified path in the set of globally registered resources. ...

Function gio:resources-info (path lookup)
Looks for a file at the specified path in the set of globally registered resources and if found returns information about it. ...

Permissions


GPermission

Class gio:permission
A g:permission object represents the status of the permission of the caller to perform a certain action. ...

Accessor gio:permission-allowed (object)
Accessor of the allowed slot of the g:permission class. ...

Accessor gio:permission-can-acquire (object)
Accessor of the can-acquire slot of the g:permission class. ...

Accessor gio:permission-can-release (object)
Accessor of the can-release slot of the g:permission class. ...

Function gio:permission-acquire (permission &optional cancellable)
Attempts to acquire the permission represented by permission. ...

Function gio:permission-release (permission &optional cancellable)
Attempts to release the permission represented by permission. ...


GSimplePermission

Class gio:simple-permission
The g:simple-permission class is a trivial implementation of the g:permission class that represents a permission that is either always or never allowed. ...

Function gio:simple-permission-new (allowed)
Creates a new g:permission instance that represents an action that is either always or never allowed. ...

Data models


GListModel

Interface gio:list-model
The g:list-model interface is an interface that represents a mutable list of g:object instances. ...

Function gio:list-model-item-type (model)
Gets the type of the items in the list model. ...

Function gio:list-model-n-items (model)
Gets the number of items in the list model. ...

Function gio:list-model-item (model pos)
Get the item at pos. ...

Function gio:list-model-items-changed (model pos removed added)
Emits the "items-changed" signal on model. ...


GListStore

Class gio:list-store
The g:list-store object is an implementation of the g:list-model interface that stores all items in memory. ...

Accessor gio:list-store-item-type (object)
Accessor of the item-type slot of the g:list-store class. ...

Accessor gio:list-store-n-items (object)
Accessor of the n-items slot of the g:list-store class. ...

Function gio:list-store-new (gtype)
Creates a new list store with items of gtype type. ...

Function gio:list-store-insert (store pos item)
Inserts the item into the list store at pos. ...

Callback gio:compare-data-func
Specifies the type of a comparison function used to compare two values. ...

Function gio:list-store-insert-sorted (store item func)
Inserts the item into the list store at a position to be determined by the func callback function. ...

Function gio:list-store-append (store item)
Appends the item to the list store. ...

Function gio:list-store-remove (store pos)
Removes the item from the list store that is at pos. ...

Function gio:list-store-remove-all (store)
Removes all items from the list store. ...

Function gio:list-store-splice (store pos n &rest additions)
Changes the list store by removing n items and adding additions to it. ...

Function gio:list-store-sort (store func)
Sort the items in the list store according to func. ...

Function gio:list-store-find (store item)
Looks up the given item in the list store by looping over the items until the first occurrence of item. ...

Callback gio:equal-func-full
Specifies the type of a callback function used to test two values for equality. ...

Function gio:list-store-find-with-equal-func (store item func)
Looks up the given item in the list store by looping over the items and comparing them with the func callback function until the first occurrence of item which matches. ...

Application support


GApplication

GFlags gio:application-flags
Flags used to define the behaviour of a g:application instance. ...

Class gio:application
The g:application class is the foundation of an application. ...

Accessor gio:application-action-group (object)
Accessor of the action-group slot of the g:application class. ...

Accessor gio:application-application-id (object)
Accessor of the application-id slot of the g:application class. ...

Accessor gio:application-flags (object)
Accessor of the flags slot of the g:application class. ...

Accessor gio:application-inactivity-timeout (object)
Accessor of the inactivity-timeout slot of the g:application class. ...

Accessor gio:application-is-busy (object)
Accessor of the is-busy slot of the g:application class. ...

Accessor gio:application-is-registered (object)
Accessor of the is-registered slot of the g:application class. ...

Accessor gio:application-is-remote (object)
Accessor of the is-remote slot of the g:application class. ...

Accessor gio:application-resource-base-path (object)
Accessor of the resource-base-path slot of the g:application class. ...

Accessor gio:application-version (object)
Accessor of the version slot of the g:application class. ...

Function gio:application-id-is-valid (id)
Checks if the id argument is a valid application identifier. ...

Function gio:application-new (id flags)
Creates a new g:application instance. ...

Function gio:application-register (application)
Attempts registration of the application. ...

Function gio:application-hold (application)
Increases the use count of the application. ...

Function gio:application-release (application)
Decrease the use count of the application. ...

Function gio:application-quit (application)
Immediately quits the application. ...

Function gio:application-activate (application)
Activates the application. ...

Function gio:application-open (application files &optional hint)
This results in the "open" signal being emitted in the primary instance. ...

Function gio:application-run (application argv)
Runs the application. ...

Function gio:application-send-notification (application id notification)
Sends a notification on behalf of the application to the desktop shell. ...

Function gio:application-withdraw-notification (application id)
Withdraws a notification that was sent with the g:application-send-notification function. ...

Function gio:application-add-main-option-entries (application entries)
Adds main option entries to be handled by the application. ...

Function gio:application-add-main-option (application long short flags arg desc argdesc)
Adds an option to be handled by the application. ...

Function gio:application-add-option-group (application group)
Adds a g:option-group instance to the command line handling of the application. ...

Function gio:application-set-option-context-parameter-string (application parameter)
Sets the parameter string to be used by the command line handling of the application. ...

Function gio:application-set-option-context-summary (application summary)
Adds a summary to the application option context. ...

Function gio:application-set-option-context-description (application description)
Adds a description to the application option context. ...

Function gio:application-default ()
Accessor of the default application for the process. ...

Function gio:application-mark-busy (application)
Increases the busy count of the application. ...

Function gio:application-unmark-busy (application)
Decreases the busy count of the application. ...

Function gio:application-bind-busy-property (application object property)
Marks the application as busy while the property on the object is true. ...

Function gio:application-unbind-busy-property (application object property)
Destroys a binding between the property and the busy state of the application that was previously created with the g:application-bind-busy-property function. ...


GApplicationCommandLine

Class gio:application-command-line
The g:application-command-line class represents a command line invocation of an application. ...

Accessor gio:application-command-line-is-remote (object)
Determines if the command line represents a remote invocation. ...

Function gio:application-command-line-arguments (cmdline)
Gets the list of arguments that was passed on the command line. ...

Function gio:application-command-line-cwd (cmdline)
Gets the working directory of the command line invocation. ...

Function gio:application-command-line-environ (cmdline)
Gets the contents of the environ variable of the command line invocation, as would be returned by the g_get_environ() function. ...

Function gio:application-command-line-options-dict (cmdline)
Gets the options that were passed to the g:application-command-line instance. ...

Function gio:application-command-line-create-file-for-arg (cmdline arg)
Creates a g:file object corresponding to a filename that was given as part of the invocation of the command line. ...

Function gio:application-command-line-getenv (cmdline name)
Gets the value of a particular environment variable of the command line invocation, as would be returned by the g_getenv() function. ...

Function gio:application-command-line-platform-data (cmdline)
Gets the platform data associated with the invocation of cmdline. ...

Function gio:application-command-line-exit-status (cmdline)
Accessor of the exit status of a g:application-command-line instance. ...


GActionGroup

Interface gio:action-group
The g:action-group interface represents a group of actions. ...

Function gio:action-group-list-actions (group)
Lists the actions contained within the action group. ...

Function gio:action-group-has-action (group name)
Checks if the named action exists within the action group. ...

Function gio:action-group-action-enabled (group name)
Checks if the named action within the action group is currently enabled. ...

Function gio:action-group-action-parameter-type (group name)
Queries the type of the parameter that must be given when activating the named action within the action group. ...

Function gio:action-group-action-state-type (group name)
Queries the type of the state of the named action within the action group. ...

Function gio:action-group-action-state-hint (group name)
Requests a hint about the valid range of values for the state of the named action within the action group. ...

Function gio:action-group-action-state (group name)
Queries the current state of the named action within the action group. ...

Function gio:action-group-change-action-state (group name parameter)
Request for the state of the named action within the action group to be changed to the parameter argument. ...

Function gio:action-group-activate-action (group name parameter)
Activate the named action within the action group. ...

Function gio:action-group-action-added (group name)
Emits the "action-added" signal on the action group. ...

Function gio:action-group-action-removed (group name)
Emits the "action-removed" signal on the action group. ...

Function gio:action-group-action-enabled-changed (group name enabled)
Emits the "action-enabled-changed" signal on the action group. ...

Function gio:action-group-action-state-changed (group name state)
Emits the "action-state-changed" signal on the action group. ...


GActionMap

Interface gio:action-map
The g:action-map interface is implemented by g:action-group implementations that operate by containing a number of named g:action instances, such as a g:simple-action-group object. ...

Function gio:action-map-lookup-action (map name)
Looks up the action with the given name in the action map. ...

Function gio:action-map-add-action-entries (map entries)
A convenience function for creating multiple g:simple-action instances and adding them to a g:action-map object. ...

Function gio:action-map-add-action (map action)
Adds an action to the action map. ...

Function gio:action-map-remove-action (map name)
Removes the named action from the action map. ...


GSimpleActionGroup

Class gio:simple-action-group
The g:simple-action-group class is a hash table filled with g:action instances, implementing the g:action-group and g:action-map interfaces. ...

Function gio:simple-action-group-new ()
Creates a new, empty, action group. ...

Function gio:simple-action-group-lookup (group name)
Looks up the action with the name name in the action group. ...

Function gio:simple-action-group-insert (group action)
Adds an action to the action group. ...

Function gio:simple-action-group-remove (group name)
Removes the named action from the action group. ...

Function gio:simple-action-group-add-entries (group entries)
A convenience function for creating multiple g:simple-action instances and adding them to the action group. ...


GAction

Interface gio:action
The g:action interface represents a single named action. ...

Accessor gio:action-enabled (object)
Accessor of the enabled slot of the g:action class. ...

Accessor gio:action-name (object)
Accessor of the name slot of the g:action class. ...

Accessor gio:action-parameter-type (object)
Accessor of the parameter-type slot of the g:action class. ...

Accessor gio:action-state (object)
Accessor of the state slot of the g:action class. ...

Accessor gio:action-state-type (object)
Accessor of the state-type slot of the action class. ...

Function gio:action-name-is-valid (name)
Checks if the action name is valid. ...

Function gio:action-state-hint (action)
Requests a hint about the valid range of values for the state of the action. ...

Function gio:action-change-state (action value)
Request for the state of the action to be changed to value. ...

Function gio:action-activate (action &optional parameter)
Activates the action. ...

Function gio:action-parse-detailed-name (detailed)
Parses a detailed action name into its separate name and target components. ...

Function gio:action-print-detailed-name (name &optional value)
Formats a detailed action name from an action name and a target value. ...


GSimpleAction

Class gio:simple-action
The g:simple-action class is the obvious simple implementation of the g:action interface. ...

Accessor gio:simple-action-enabled (object)
Accessor of the enabled slot of the g:simple-action class. ...

Accessor gio:simple-action-name (object)
Accessor of the name slot of the g:simple-action class. ...

Accessor gio:simple-action-parameter-type (object)
Accessor of the parameter-type slot of the g:simple-action class. ...

Accessor gio:simple-action-state (object)
Accessor of the state slot of the g:simple-action class. ...

Accessor gio:simple-action-state-type (object)
Accessor of the state-type slot of the g:simple-action class. ...

Function gio:simple-action-new (name vtype)
Creates a new action. ...

Function gio:simple-action-new-stateful (name vtype state)
Creates a new stateful action. ...

Function gio:simple-action-set-state-hint (action hint)
Sets the state hint for the action. ...


GPropertyAction

Class gio:property-action
The g:property-action class is a way to get a g:action object with a state value reflecting and controlling the value of a g:object property. ...

Accessor gio:property-action-enabled (object)
Accessor of the enabled slot of the g:property-action class. ...

Accessor gio:property-action-invert-boolean (object)
If true, the state of the action will be the negation of the property value, provided the property is boolean. ...

Accessor gio:property-action-name (object)
The name of the action. This is mostly meaningful for identifying the action once it has been added to a g:action-map instance. ...

Accessor gio:property-action-object (object)
The object slot of the g:property-action class is not readable and not writable. ...

Accessor gio:property-action-parameter-type (object)
The type of the parameter that must be given when activating the action. ...

Accessor gio:property-action-property-name (object)
The property-name slot of the g:property-action class is not readable and not writable. ...

Accessor gio:property-action-state (object)
The state of the action, or the cffi:null-pointer value if the action is stateless. ...

Accessor gio:property-action-state-type (object)
The variant parameter type of the state that the action has, or nil if the action is stateless. ...

Function gio:property-action-new (name object property)
Creates an action corresponding to the value of property on the object. ...


GMenuModel

Class gio:menu-model
The g:menu-model class represents the contents of a menu - an ordered list of menu items. ...

Function gio:menu-model-is-mutable (model)
Queries if the menu model is mutable. ...

Function gio:menu-model-n-items (model)
Query the number of items in the menu model. ...

Function gio:menu-model-item-attribute-value (model index attribute vtype)
Queries the item at position index in model for the attribute specified by attribute. ...

Function gio:menu-model-item-link (model index link)
Queries the item at position index in model for the link specified by link. ...

Function gio:menu-model-iterate-item-attributes (model index)
Creates a g:menu-attribute-iter object to iterate over the attributes of the item at position item in model. ...

Function gio:menu-model-iterate-item-links (model index)
Creates a g:menu-link-iter object to iterate over the links of the item at position index in model. ...

Function gio:menu-model-items-changed (model pos removed added)
Requests emission of the "items-changed" signal on model. ...

Class gio:menu-attribute-iter
The g:menu-attribute-iter class is an opaque structure type. ...

Function gio:menu-attribute-iter-next (iter)
Attempts to advance the iterator to the next, possibly first, attribute. ...

Function gio:menu-attribute-iter-name (iter)
Gets the name of the attribute at the current iterator position, as a string. ...

Function gio:menu-attribute-iter-value (iter)
Gets the value of the attribute at the current iterator position, as a string. ...

Class gio:menu-link-iter
The g:menu-link-iter class is an opaque structure type. ...

Function gio:menu-link-iter-next (iter)
Attempts to advance the iterator to the next, possibly first, link. ...

Function gio:menu-link-iter-name (iter)
Gets the name of the link at the current iterator position, as a string. ...

Function gio:menu-link-iter-value (iter)
Gets the linked g:menu-model object at the current iterator position. ...


GMenu

Class gio:menu
The g:menu class is an implementation of the abstract g:menu-model class. ...

Function gio:menu-new ()
Creates a new g:menu object. ...

Function gio:menu-freeze (menu)
Marks the menu as frozen. ...

Function gio:menu-insert (menu pos label action)
Convenience function for inserting a normal menu item into the menu. ...

Function gio:menu-prepend (menu label action)
Convenience function for prepending a normal menu item to the start of the menu. ...

Function gio:menu-append (menu label action)
Convenience function for appending a normal menu item to the end of the menu. ...

Function gio:menu-insert-item (menu pos item)
Inserts a menu item into the menu. ...

Function gio:menu-prepend-item (menu item)
Prepends the menu item to the start of the menu. ...

Function gio:menu-append-item (menu item)
Appends the menu item to the end of the menu. ...

Function gio:menu-insert-section (menu pos label section)
Convenience function for inserting a section menu item into menu. ...

Function gio:menu-prepend-section (menu label section)
Convenience function for prepending a section menu to the start of the menu. ...

Function gio:menu-append-section (menu label section)
Convenience function for appending a section menu to the emd of the menu. ...

Function gio:menu-insert-submenu (menu pos label submenu)
Convenience function for inserting a submenu into the menu. ...

Function gio:menu-prepend-submenu (menu label submenu)
Convenience function for prepending a submenu to the start of the menu. ...

Function gio:menu-append-submenu (menu label submenu)
Convenience function for appending a submenu to the end of the menu. ...

Function gio:menu-remove (menu pos)
Removes an item from the menu. ...

Function gio:menu-remove-all (menu)
Removes all items in the menu. ...

Class gio:menu-item
The g:menu-item object is an opaque structure type. ...

Function gio:menu-item-new (label action)
Creates a new g:menu-item object. ...

Function gio:menu-item-new-section (label section)
Creates a new g:menu-item object representing a section. ...

Function gio:menu-item-new-submenu (label submenu)
Creates a new g:menu-item object representing a submenu. ...

Function gio:menu-item-new-from-model (model index)
Creates a g:menu-item object as an exact copy of an existing menu item in a g:menu-model object. ...

Function gio:menu-item-set-label (item label)
Sets or unsets the "label" attribute of the menu item. ...

Function gio:menu-item-set-icon (item icon)
Sets or unsets the "icon" attribute on the menu item. ...

Function gio:menu-item-set-action-and-target-value (item action value)
Sets or unsets the "action" and "target" attributes of the menu item. ...

Function gio:menu-item-set-detailed-action (item action)
Sets the "action" attribute and possibly the "target" attribute of the menu item. ...

Function gio:menu-item-set-section (item section)
Sets or unsets the "section" link of the menu item to section. ...

Function gio:menu-item-set-submenu (item submenu)
Sets or unsets the "submenu" link of the menu item to submenu. ...

Function gio:menu-item-attribute-value (item attribute &optional vtype)
The g:menu-item-attribute-value function queries the named attribute on the menu item. ...

Function gio:menu-item-link (item link)
The g:menu-item-link function queries the named link on item. ...


GNotification

GEnum gio:notification-priority
Priority levels for g:notification instances. ...

Class gio:notification
The g:notification class is a mechanism for creating a notification to be shown to the user, typically as a pop-up notification presented by the desktop environment shell. ...

Function gio:notification-new (title)
Creates a new notification with title as its title. ...

Function gio:notification-set-title (notification title)
Sets the title of the notification. ...

Function gio:notification-set-body (notification body)
Sets the body of the notification. ...

Function gio:notification-set-icon (notification icon)
Sets the icon of the notification. ...

Function gio:notification-set-priority (notification priority)
Sets the priority of the notification. ...

Function gio:notification-set-default-action (notification action)
Sets the default action of the notification to action. ...

Function gio:notification-add-button (notification label action)
Adds a button to the notification that activates the action in action when clicked. ...

Exported Symbol Index

action, Interface
action-group, Interface
action-map, Interface
app-info, Interface
app-launch-context, Class
application, Class
application-command-line, Class
async-result, Interface
cancellable, Class
emblem, Class
emblemed-icon, Class
file, Interface
file-icon, Class
file-info, Class
icon, Interface
list-model, Interface
list-store, Class
loadable-icon, Interface
menu, Class
menu-attribute-iter, Class
menu-item, Class
menu-link-iter, Class
menu-model, Class
notification, Class
permission, Class
property-action, Class
resource, GBoxed
simple-action, Class
simple-action-group, Class
simple-permission, Class
task, Class
themed-icon, Class
action-activate, Function
action-change-state, Function
action-enabled, Accessor
action-group-action-added, Function
action-group-action-enabled, Function
action-group-action-enabled-changed, Function
action-group-action-parameter-type, Function
action-group-action-removed, Function
action-group-action-state, Function
action-group-action-state-changed, Function
action-group-action-state-hint, Function
action-group-action-state-type, Function
action-group-activate-action, Function
action-group-change-action-state, Function
action-group-has-action, Function
action-group-list-actions, Function
action-map-add-action, Function
action-map-add-action-entries, Function
action-map-lookup-action, Function
action-map-remove-action, Function
action-name, Accessor
action-name-is-valid, Function
action-parameter-type, Accessor
action-parse-detailed-name, Function
action-print-detailed-name, Function
action-state, Accessor
action-state-hint, Function
action-state-type, Accessor
app-info-add-supports-type, Function
app-info-all, Function
app-info-all-for-type, Function
app-info-can-delete, Function
app-info-can-remove-supports-type, Function
app-info-commandline, Function
app-info-create-from-commandline, Function
app-info-default-for-type, Function
app-info-default-for-uri-scheme, Function
app-info-delete, Function
app-info-description, Function
app-info-display-name, Function
app-info-dup, Function
app-info-equal, Function
app-info-executable, Function
app-info-fallback-for-type, Function
app-info-icon, Function
app-info-id, Function
app-info-launch, Function
app-info-launch-default-for-uri, Function
app-info-launch-default-for-uri-async, Function
app-info-launch-default-for-uri-finish, Function
app-info-launch-uris, Function
app-info-name, Function
app-info-recommended-for-type, Function
app-info-remove-supports-type, Function
app-info-reset-type-associations, Function
app-info-set-as-default-for-extension, Function
app-info-set-as-default-for-type, Function
app-info-set-as-last-used-for-type, Function
app-info-should-show, Function
app-info-supported-types, Function
app-info-supports-files, Function
app-info-supports-uris, Function
app-launch-context-display, Function
app-launch-context-environment, Function
app-launch-context-launch-failed, Function
app-launch-context-new, Function
app-launch-context-setenv, Function
app-launch-context-startup-notify-id, Function
app-launch-context-unsetenv, Function
application-action-group, Accessor
application-activate, Function
application-add-main-option, Function
application-add-main-option-entries, Function
application-add-option-group, Function
application-application-id, Accessor
application-bind-busy-property, Function
application-command-line-arguments, Function
application-command-line-create-file-for-arg, Function
application-command-line-cwd, Function
application-command-line-environ, Function
application-command-line-exit-status, Function
application-command-line-getenv, Function
application-command-line-is-remote, Accessor
application-command-line-options-dict, Function
application-command-line-platform-data, Function
application-default, Function
application-flags, Accessor
application-hold, Function
application-id-is-valid, Function
application-inactivity-timeout, Accessor
application-is-busy, Accessor
application-is-registered, Accessor
application-is-remote, Accessor
application-mark-busy, Function
application-new, Function
application-open, Function
application-quit, Function
application-register, Function
application-release, Function
application-resource-base-path, Accessor
application-run, Function
application-send-notification, Function
application-set-option-context-description, Function
application-set-option-context-parameter-string, Function
application-set-option-context-summary, Function
application-unbind-busy-property, Function
application-unmark-busy, Function
application-version, Accessor
application-withdraw-notification, Function
async-result-is-tagged, Function
async-result-source-object, Function
async-result-user-data, Function
cancellable-cancel, Function
cancellable-current, Function
cancellable-is-cancelled, Function
cancellable-new, Function
cancellable-pop-current, Function
cancellable-push-current, Function
cancellable-reset, Function
cancellable-source-new, Function
content-type-can-be-executable, Function
content-type-description, Function
content-type-equals, Function
content-type-from-mime-type, Function
content-type-generic-icon-name, Function
content-type-icon, Function
content-type-is-a, Function
content-type-is-mime-type, Function
content-type-is-unknown, Function
content-type-mime-dirs, Function
content-type-mime-type, Function
content-type-symbolic-icon, Function
content-types-registered, Function
emblem-icon, Accessor
emblem-new, Function
emblem-new-with-origin, Function
emblem-origin, Accessor
emblemed-icon-add-emblem, Function
emblemed-icon-clear-emblems, Function
emblemed-icon-emblems, Function
emblemed-icon-gicon, Accessor
emblemed-icon-icon, Function
emblemed-icon-new, Function
file-basename, Function
file-get-parse-name, Function
file-icon-file, Accessor
file-icon-new, Function
file-info-access-date-time, Function  (undocumented)
file-info-attribute-as-string, Function  (undocumented)
file-info-attribute-boolean, Function  (undocumented)
file-info-clear-status, Function  (undocumented)
file-info-has-attribute, Function  (undocumented)
file-info-has-namespace, Function  (undocumented)
file-info-list-attributes, Function  (undocumented)
file-info-modification-date-time, Function  (undocumented)
file-info-name, Function  (undocumented)
file-info-new, Function
file-info-size, Function  (undocumented)
file-new-for-commandline-arg, Function
file-new-for-commandline-arg-and-cwd, Function
file-new-for-path, Function
file-new-for-uri, Function
file-parse-name, Function
file-path, Function
file-query-info, Function
file-uri, Function
icon-deserialize, Function
icon-equal, Function
icon-hash, Function
icon-new-for-string, Function
icon-serialize, Function
icon-to-string, Function
list-model-get-item-impl, Generic Function  (undocumented)
list-model-get-item-type-impl, Generic Function  (undocumented)
list-model-get-n-items-impl, Generic Function  (undocumented)
list-model-item, Function
list-model-item-type, Function
list-model-items-changed, Function
list-model-n-items, Function
list-store-append, Function
list-store-find, Function
list-store-find-with-equal-func, Function
list-store-insert, Function
list-store-insert-sorted, Function
list-store-item-type, Accessor
list-store-n-items, Accessor
list-store-new, Function
list-store-remove, Function
list-store-remove-all, Function
list-store-sort, Function
list-store-splice, Function
menu-append, Function
menu-append-item, Function
menu-append-section, Function
menu-append-submenu, Function
menu-attribute-iter-name, Function
menu-attribute-iter-next, Function
menu-attribute-iter-value, Function
menu-freeze, Function
menu-insert, Function
menu-insert-item, Function
menu-insert-section, Function
menu-insert-submenu, Function
menu-item-attribute-value, Function
menu-item-link, Function
menu-item-new, Function
menu-item-new-from-model, Function
menu-item-new-section, Function
menu-item-new-submenu, Function
menu-item-set-action-and-target-value, Function
menu-item-set-detailed-action, Function
menu-item-set-icon, Function
menu-item-set-label, Function
menu-item-set-section, Function
menu-item-set-submenu, Function
menu-link-iter-name, Function
menu-link-iter-next, Function
menu-link-iter-value, Function
menu-model-is-mutable, Function
menu-model-item-attribute-value, Function
menu-model-item-link, Function
menu-model-items-changed, Function
menu-model-iterate-item-attributes, Function
menu-model-iterate-item-links, Function
menu-model-n-items, Function
menu-new, Function
menu-prepend, Function
menu-prepend-item, Function
menu-prepend-section, Function
menu-prepend-submenu, Function
menu-remove, Function
menu-remove-all, Function
notification-add-button, Function
notification-new, Function
notification-set-body, Function
notification-set-default-action, Function
notification-set-icon, Function
notification-set-priority, Function
notification-set-title, Function
permission-acquire, Function
permission-allowed, Accessor
permission-can-acquire, Accessor
permission-can-release, Accessor
permission-release, Function
property-action-enabled, Accessor
property-action-invert-boolean, Accessor
property-action-name, Accessor
property-action-new, Function
property-action-object, Accessor
property-action-parameter-type, Accessor
property-action-property-name, Accessor
property-action-state, Accessor
property-action-state-type, Accessor
resource-enumerate-children, Function
resource-info, Function
resource-load, Function
resource-lookup-data, Function
resources-enumerate-children, Function
resources-info, Function
resources-lookup-data, Function
resources-register, Function
resources-unregister, Function
simple-action-enabled, Accessor
simple-action-group-add-entries, Function
simple-action-group-insert, Function
simple-action-group-lookup, Function
simple-action-group-new, Function
simple-action-group-remove, Function
simple-action-name, Accessor
simple-action-new, Function
simple-action-new-stateful, Function
simple-action-parameter-type, Accessor
simple-action-set-state-hint, Function
simple-action-state, Accessor
simple-action-state-type, Accessor
simple-permission-new, Function
task-cancellable, Function
task-check-cancellable, Function
task-completed, Accessor
task-context, Function
task-new, Function
task-priority, Function
task-propagate-pointer, Function  (undocumented)
task-return-boolean, Function
task-return-pointer, Function  (undocumented)
task-run-in-thread, Function  (undocumented)
task-source-object, Function
task-task-data, Function  (undocumented)
themed-icon-append-name, Function
themed-icon-name, Accessor
themed-icon-names, Accessor
themed-icon-new, Function
themed-icon-new-from-names, Function
themed-icon-new-with-default-fallbacks, Function
themed-icon-prepend-name, Function
themed-icon-use-default-fallbacks, Accessor
with-resource, Macro
with-resources, Macro
app-info-create-flags, GFlags
application-flags, GFlags
async-ready-callback, Callback
cancellable-source-func, Callback
compare-data-func, Callback
emblem-origin, GEnum
equal-func-full, Callback
file-query-info-flags, GFlags
notification-priority, GEnum
resource-flags, GFlags
resource-lookup-flags, GFlags
task-thread-func, Symbol  (undocumented)
file-as-namestring, Type