gi-gio-2.0.11: Gio bindings

CopyrightWill Thompson, Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (garetxe@gmail.com)
Safe HaskellNone
LanguageHaskell2010

GI.Gio.Callbacks

Contents

Description

 

Synopsis

Signals

ActionEntryActivateFieldCallback

ActionEntryChangeStateFieldCallback

AsyncReadyCallback

dynamic_AsyncReadyCallback Source #

Arguments

:: (HasCallStack, MonadIO m, IsObject a, IsAsyncResult b) 
=> FunPtr C_AsyncReadyCallback 
-> a

sourceObject: the object the asynchronous operation was started with.

-> b

res: a AsyncResult.

-> Ptr ()

userData: user data passed to the callback.

-> m () 

BusAcquiredCallback

dynamic_BusAcquiredCallback Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusConnection a) 
=> FunPtr C_BusAcquiredCallback 
-> a

connection: The DBusConnection to a message bus.

-> Text

name: The name that is requested to be owned.

-> Ptr ()

userData: User data passed to g_bus_own_name().

-> m () 

BusNameAcquiredCallback

dynamic_BusNameAcquiredCallback Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusConnection a) 
=> FunPtr C_BusNameAcquiredCallback 
-> a

connection: The DBusConnection on which to acquired the name.

-> Text

name: The name being owned.

-> Ptr ()

userData: User data passed to g_bus_own_name() or g_bus_own_name_on_connection().

-> m () 

BusNameAppearedCallback

dynamic_BusNameAppearedCallback Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusConnection a) 
=> FunPtr C_BusNameAppearedCallback 
-> a

connection: The DBusConnection the name is being watched on.

-> Text

name: The name being watched.

-> Text

nameOwner: Unique name of the owner of the name being watched.

-> Ptr ()

userData: User data passed to g_bus_watch_name().

-> m () 

BusNameLostCallback

dynamic_BusNameLostCallback Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusConnection a) 
=> FunPtr C_BusNameLostCallback 
-> a

connection: The DBusConnection on which to acquire the name or Nothing if the connection was disconnected.

-> Text

name: The name being owned.

-> Ptr ()

userData: User data passed to g_bus_own_name() or g_bus_own_name_on_connection().

-> m () 

BusNameVanishedCallback

dynamic_BusNameVanishedCallback Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusConnection a) 
=> FunPtr C_BusNameVanishedCallback 
-> a

connection: The DBusConnection the name is being watched on, or Nothing.

-> Text

name: The name being watched.

-> Ptr ()

userData: User data passed to g_bus_watch_name().

-> m () 

CancellableSourceFunc

dynamic_CancellableSourceFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsCancellable a) 
=> FunPtr C_CancellableSourceFunc 
-> Maybe a

cancellable: the Cancellable

-> Ptr ()

userData: data passed in by the user.

-> m Bool

Returns: it should return False if the source should be removed.

DBusInterfaceGetPropertyFunc

dynamic_DBusInterfaceGetPropertyFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusConnection a) 
=> FunPtr C_DBusInterfaceGetPropertyFunc 
-> a

connection: A DBusConnection.

-> Text

sender: The unique bus name of the remote caller.

-> Text

objectPath: The object path that the method was invoked on.

-> Text

interfaceName: The D-Bus interface name for the property.

-> Text

propertyName: The name of the property to get the value of.

-> GError

error: Return location for error.

-> Ptr ()

userData: The userData gpointer passed to g_dbus_connection_register_object().

-> m GVariant

Returns: A GVariant with the value for propertyName or Nothing if error is set. If the returned GVariant is floating, it is consumed - otherwise its reference count is decreased by one.

DBusInterfaceMethodCallFunc

dynamic_DBusInterfaceMethodCallFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusConnection a, IsDBusMethodInvocation b) 
=> FunPtr C_DBusInterfaceMethodCallFunc 
-> a

connection: A DBusConnection.

-> Text

sender: The unique bus name of the remote caller.

-> Text

objectPath: The object path that the method was invoked on.

-> Text

interfaceName: The D-Bus interface name the method was invoked on.

-> Text

methodName: The name of the method that was invoked.

-> GVariant

parameters: A GVariant tuple with parameters.

-> b

invocation: A DBusMethodInvocation object that must be used to return a value or error.

-> Ptr ()

userData: The userData gpointer passed to g_dbus_connection_register_object().

-> m () 

DBusInterfaceSetPropertyFunc

dynamic_DBusInterfaceSetPropertyFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusConnection a) 
=> FunPtr C_DBusInterfaceSetPropertyFunc 
-> a

connection: A DBusConnection.

-> Text

sender: The unique bus name of the remote caller.

-> Text

objectPath: The object path that the method was invoked on.

-> Text

interfaceName: The D-Bus interface name for the property.

-> Text

propertyName: The name of the property to get the value of.

-> GVariant

value: The value to set the property to.

-> GError

error: Return location for error.

-> Ptr ()

userData: The userData gpointer passed to g_dbus_connection_register_object().

-> m Bool

Returns: True if the property was set to value, False if error is set.

DBusMessageFilterFunction

dynamic_DBusMessageFilterFunction Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusConnection a, IsDBusMessage b) 
=> FunPtr C_DBusMessageFilterFunction 
-> a

connection: A DBusConnection.

-> b

message: A locked DBusMessage that the filter function takes ownership of.

-> Bool

incoming: True if it is a message received from the other peer, False if it is a message to be sent to the other peer.

-> Ptr ()

userData: User data passed when adding the filter.

-> m (Maybe DBusMessage)

Returns: A DBusMessage that will be freed with objectUnref or Nothing to drop the message. Passive filter functions can simply return the passed message object.

DBusProxyTypeFunc

dynamic_DBusProxyTypeFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusObjectManagerClient a) 
=> FunPtr C_DBusProxyTypeFunc 
-> a

manager: A DBusObjectManagerClient.

-> Text

objectPath: The object path of the remote object.

-> Maybe Text

interfaceName: The interface name of the remote object or Nothing if a DBusObjectProxy GType is requested.

-> Ptr ()

userData: User data.

-> m GType

Returns: A GType to use for the remote object. The returned type must be a DBusProxy or DBusObjectProxy -derived type.

DBusSignalCallback

dynamic_DBusSignalCallback Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusConnection a) 
=> FunPtr C_DBusSignalCallback 
-> a

connection: A DBusConnection.

-> Text

senderName: The unique bus name of the sender of the signal.

-> Text

objectPath: The object path that the signal was emitted on.

-> Text

interfaceName: The name of the interface.

-> Text

signalName: The name of the signal.

-> GVariant

parameters: A GVariant tuple with parameters for the signal.

-> Ptr ()

userData: User data passed when subscribing to the signal.

-> m () 

DBusSubtreeDispatchFunc

dynamic_DBusSubtreeDispatchFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusConnection a) 
=> FunPtr C_DBusSubtreeDispatchFunc 
-> a

connection: A DBusConnection.

-> Text

sender: The unique bus name of the remote caller.

-> Text

objectPath: The object path that was registered with dBusConnectionRegisterSubtree.

-> Text

interfaceName: The D-Bus interface name that the method call or property access is for.

-> Text

node: A node that is a child of objectPath (relative to objectPath) or Nothing for the root of the subtree.

-> Ptr ()

outUserData: Return location for user data to pass to functions in the returned DBusInterfaceVTable (never Nothing).

-> Ptr ()

userData: The userData gpointer passed to dBusConnectionRegisterSubtree.

-> m DBusInterfaceVTable

Returns: A DBusInterfaceVTable or Nothing if you don't want to handle the methods.

DBusSubtreeIntrospectFunc

dynamic_DBusSubtreeIntrospectFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusConnection a) 
=> FunPtr C_DBusSubtreeIntrospectFunc 
-> a

connection: A DBusConnection.

-> Text

sender: The unique bus name of the remote caller.

-> Text

objectPath: The object path that was registered with dBusConnectionRegisterSubtree.

-> Text

node: A node that is a child of objectPath (relative to objectPath) or Nothing for the root of the subtree.

-> Ptr ()

userData: The userData gpointer passed to dBusConnectionRegisterSubtree.

-> m DBusInterfaceInfo

Returns: A Nothing-terminated array of pointers to DBusInterfaceInfo, or Nothing.

DatagramBasedSourceFunc

dynamic_DatagramBasedSourceFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsDatagramBased a) 
=> FunPtr C_DatagramBasedSourceFunc 
-> a

datagramBased: the DatagramBased

-> [IOCondition]

condition: the current condition at the source fired

-> Ptr ()

userData: data passed in by the user

-> m Bool

Returns: SOURCE_REMOVE if the source should be removed, SOURCE_CONTINUE otherwise

DesktopAppLaunchCallback

dynamic_DesktopAppLaunchCallback Source #

Arguments

:: (HasCallStack, MonadIO m, IsDesktopAppInfo a) 
=> FunPtr C_DesktopAppLaunchCallback 
-> a

appinfo: a DesktopAppInfo

-> Int32

pid: Process identifier

-> Ptr ()

userData: User data

-> m () 

FileMeasureProgressCallback

dynamic_FileMeasureProgressCallback Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_FileMeasureProgressCallback 
-> Bool

reporting: True if more reports will come

-> Word64

currentSize: the current cumulative size measurement

-> Word64

numDirs: the number of directories visited so far

-> Word64

numFiles: the number of non-directory files encountered

-> Ptr ()

userData: the data passed to the original request for this callback

-> m () 

FileProgressCallback

dynamic_FileProgressCallback Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_FileProgressCallback 
-> Int64

currentNumBytes: the current number of bytes in the operation.

-> Int64

totalNumBytes: the total number of bytes in the operation.

-> Ptr ()

userData: user data passed to the callback.

-> m () 

FileReadMoreCallback

dynamic_FileReadMoreCallback Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_FileReadMoreCallback 
-> Text

fileContents: the data as currently read.

-> Int64

fileSize: the size of the data currently read.

-> Ptr ()

callbackData: data passed to the callback.

-> m Bool

Returns: True if more data should be read back. False otherwise.

IOSchedulerJobFunc

dynamic_IOSchedulerJobFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsCancellable a) 
=> FunPtr C_IOSchedulerJobFunc 
-> IOSchedulerJob

job: a IOSchedulerJob.

-> Maybe a

cancellable: optional Cancellable object, Nothing to ignore.

-> Ptr ()

userData: the data to pass to callback function

-> m Bool

Returns: True if this function should be called again to complete the job, False if the job is complete (or cancelled)

PollableSourceFunc

dynamic_PollableSourceFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsObject a) 
=> FunPtr C_PollableSourceFunc 
-> a

pollableStream: the PollableInputStream or PollableOutputStream

-> Ptr ()

userData: data passed in by the user.

-> m Bool

Returns: it should return False if the source should be removed.

ReallocFunc

type C_ReallocFunc = Ptr () -> Word64 -> IO (Ptr ()) Source #

type ReallocFunc = Ptr () -> Word64 -> IO (Ptr ()) Source #

dynamic_ReallocFunc Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_ReallocFunc 
-> Ptr ()

data: memory block to reallocate

-> Word64

size: size to reallocate data to

-> m (Ptr ())

Returns: a pointer to the reallocated memory

SettingsBindGetMapping

dynamic_SettingsBindGetMapping Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_SettingsBindGetMapping 
-> GValue

value: return location for the property value

-> GVariant

variant: the GVariant

-> Ptr ()

userData: user data that was specified when the binding was created

-> m Bool

Returns: True if the conversion succeeded, False in case of an error

SettingsBindSetMapping

dynamic_SettingsBindSetMapping Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_SettingsBindSetMapping 
-> GValue

value: a Value containing the property value to map

-> VariantType

expectedType: the VariantType to create

-> Ptr ()

userData: user data that was specified when the binding was created

-> m GVariant

Returns: a new GVariant holding the data from value, or Nothing in case of an error

SettingsGetMapping

dynamic_SettingsGetMapping Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> FunPtr C_SettingsGetMapping 
-> GVariant

value: the GVariant to map, or Nothing

-> Ptr ()

userData: the user data that was passed to settingsGetMapped

-> m (Bool, Ptr ())

Returns: True if the conversion succeeded, False in case of an error

SimpleAsyncThreadFunc

dynamic_SimpleAsyncThreadFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsSimpleAsyncResult a, IsObject b, IsCancellable c) 
=> FunPtr C_SimpleAsyncThreadFunc 
-> a

res: a SimpleAsyncResult.

-> b

object: a Object.

-> Maybe c

cancellable: optional Cancellable object, Nothing to ignore.

-> m () 

SocketSourceFunc

dynamic_SocketSourceFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsSocket a) 
=> FunPtr C_SocketSourceFunc 
-> a

socket: the Socket

-> [IOCondition]

condition: the current condition at the source fired.

-> Ptr ()

userData: data passed in by the user.

-> m Bool

Returns: it should return False if the source should be removed.

TaskThreadFunc

dynamic_TaskThreadFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsTask a, IsObject b, IsCancellable c) 
=> FunPtr C_TaskThreadFunc 
-> a

task: the Task

-> b

sourceObject: task's source object

-> Ptr ()

taskData: task's task data

-> Maybe c

cancellable: task's Cancellable, or Nothing

-> m () 

VfsFileLookupFunc

dynamic_VfsFileLookupFunc Source #

Arguments

:: (HasCallStack, MonadIO m, IsVfs a) 
=> FunPtr C_VfsFileLookupFunc 
-> a

vfs: a Vfs

-> Text

identifier: the identifier to lookup a File for. This can either be an URI or a parse name as returned by fileGetParseName

-> Ptr ()

userData: user data passed to the function

-> m File

Returns: a File for identifier.