GI.IBus.Objects.Bus

An IBusBus connects with IBus daemon.

Exported types

newtype Bus

Memory-managed wrapper type.

Constructors

Bus (ManagedPtr Bus)

Instances

Eq Bus

Defined in GI.IBus.Objects.Bus

Methods

(==) :: Bus -> Bus -> Bool

(/=) :: Bus -> Bus -> Bool

GObject Bus

Defined in GI.IBus.Objects.Bus

ManagedPtrNewtype Bus

Defined in GI.IBus.Objects.Bus

Methods

toManagedPtr :: Bus -> ManagedPtr Bus

TypedObject Bus

Defined in GI.IBus.Objects.Bus

Methods

glibType :: IO GType

HasParentTypes Bus

Defined in GI.IBus.Objects.Bus

IsGValue (Maybe Bus)

Convert Bus to and from GValue. See toGValue and fromGValue.

Defined in GI.IBus.Objects.Bus

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe Bus -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe Bus)

type ParentTypes Bus

Defined in GI.IBus.Objects.Bus

type ParentTypes Bus = '[Object, Object]

class (GObject o, IsDescendantOf Bus o) => IsBus o

Type class for types which can be safely cast to Bus, for instance with toBus.

Instances

(GObject o, IsDescendantOf Bus o) => IsBus o

Defined in GI.IBus.Objects.Bus

toBus :: (MonadIO m, IsBus o) => o -> m Bus

Cast to Bus, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Methods

addMatch, addMatchAsync, addMatchAsyncFinish, bindProperty, bindPropertyFull, createInputContext, createInputContextAsync, createInputContextAsyncFinish, currentInputContext, currentInputContextAsync, currentInputContextAsyncFinish, destroy, exit, exitAsync, exitAsyncFinish, forceFloating, freezeNotify, getv, hello, isConnected, isFloating, isGlobalEngineEnabled, isGlobalEngineEnabledAsync, isGlobalEngineEnabledAsyncFinish, listActiveEngines, listActiveEnginesAsync, listActiveEnginesAsyncFinish, listEngines, listEnginesAsync, listEnginesAsyncFinish, listNames, listQueuedOwners, nameHasOwner, nameHasOwnerAsync, nameHasOwnerAsyncFinish, notify, notifyByPspec, preloadEngines, preloadEnginesAsync, preloadEnginesAsyncFinish, ref, refSink, registerComponent, registerComponentAsync, registerComponentAsyncFinish, releaseName, releaseNameAsync, releaseNameAsyncFinish, removeMatch, removeMatchAsync, removeMatchAsyncFinish, requestName, requestNameAsync, requestNameAsyncFinish, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getConfig, getConnection, getData, getEnginesByNames, getGlobalEngine, getGlobalEngineAsync, getGlobalEngineAsyncFinish, getIbusProperty, getIbusPropertyAsync, getIbusPropertyAsyncFinish, getNameOwner, getNameOwnerAsync, getNameOwnerAsyncFinish, getProperty, getQdata, getServiceName, getUseGlobalEngine, getUseGlobalEngineAsync, getUseGlobalEngineAsyncFinish, getUseSysLayout, getUseSysLayoutAsync, getUseSysLayoutAsyncFinish.

Setters

setData, setDataFull, setGlobalEngine, setGlobalEngineAsync, setGlobalEngineAsyncFinish, setGlobalShortcutKeys, setGlobalShortcutKeysAsync, setGlobalShortcutKeysAsyncFinish, setIbusProperty, setIbusPropertyAsync, setIbusPropertyAsyncFinish, setProperty, setWatchDbusSignal, setWatchIbusSignal.

addMatch

busAddMatch

Arguments

:: (HasCallStack, MonadIO m, IsBus a)

=> a

bus: An Bus.

-> Text

rule: Match rule.

-> m Bool

Returns: True if the rule is added. False otherwise.

Add a match rule to an Bus synchronously.

addMatchAsync

busAddMatchAsync

Arguments

:: (HasCallStack, MonadIO m, IsBus a, IsCancellable b)

=> a

bus: An Bus.

-> Text

rule: Match rule.

-> Int32

timeoutMsec: The timeout in milliseconds or -1 to use the default timeout.

-> Maybe b

cancellable: A Cancellable or Nothing.

-> Maybe AsyncReadyCallback

callback: A AsyncReadyCallback to call when the request is satisfied or Nothing if you don't care about the result of the method invocation.

-> m ()

Add a match rule to an Bus asynchronously.

addMatchAsyncFinish

busAddMatchAsyncFinish

Arguments

:: (HasCallStack, MonadIO m, IsBus a, IsAsyncResult b)

=> a

bus: An Bus.

-> b

res: A AsyncResult obtained from the AsyncReadyCallback passed to busAddMatchAsync.

-> m ()

(Can throw GError)

Finishes an operation started with busAddMatchAsync.

createInputContext

busCreateInputContext

Arguments

:: (HasCallStack, MonadIO m, IsBus a)

=> a

bus: An Bus.

-> Text

clientName: Name of client.

-> m InputContext

Returns: A newly allocated InputContext if the "CreateInputContext" call is succeeded, Nothing otherwise.

Create an input context for client synchronously.

createInputContextAsync

busCreateInputContextAsync

Arguments

:: (HasCallStack, MonadIO m, IsBus a, IsCancellable b)

=> a

bus: An Bus.

-> Text

clientName: Name of client.

-> Int32

timeoutMsec: The timeout in milliseconds or -1 to use the default timeout.

-> Maybe b

cancellable: A Cancellable or Nothing.

-> Maybe AsyncReadyCallback

callback: A AsyncReadyCallback to call when the request is satisfied. It should not be Nothing.

-> m ()

Create an input context for client asynchronously.

createInputContextAsyncFinish

busCreateInputContextAsyncFinish

Arguments

:: (HasCallStack, MonadIO m, IsBus a, IsAsyncResult b)

=> a

bus: An Bus.

-> b

res: A AsyncResult obtained from the AsyncReadyCallback passed to busCreateInputContextAsync.

-> m InputContext

Returns: A newly allocated InputContext if the "CreateInputContext" call is succeeded, Nothing otherwise. (Can throw GError)

Finishes an operation started with busCreateInputContextAsync.

currentInputContext

busCurrentInputContext

Arguments

:: (HasCallStack, MonadIO m, IsBus a)

=> a

bus: An Bus.

-> m Text

Returns: Name of the currently focused InputContext if the "CurrentInputContext" call succeeded, Nothing otherwise. The return value must be freed with free.

Get the current focused input context synchronously.

currentInputContextAsync

busCurrentInputContextAsync

Arguments

:: (HasCallStack, MonadIO m, IsBus a, IsCancellable b)

=> a

bus: An Bus.

-> Int32

timeoutMsec: The timeout in milliseconds or -1 to use the default timeout.

-> Maybe b

cancellable: A Cancellable or Nothing.

-> Maybe AsyncReadyCallback

callback: A AsyncReadyCallback to call when the request is satisfied or Nothing if you don't care about the result of the method invocation.

-> m ()

Get the current focused input context asynchronously.

currentInputContextAsyncFinish

busCurrentInputContextAsyncFinish

Arguments

:: (HasCallStack, MonadIO m, IsBus a, IsAsyncResult b)

=> a

bus: An Bus.

-> b

res: A AsyncResult obtained from the AsyncReadyCallback passed to busCurrentInputContextAsync.

-> m Text

Returns: Name of the currently focused IBusInputContext if the "CurrentInputContext" call succeeded, Nothing otherwise. The return value must be freed with free. (Can throw GError)

Finishes an operation started with busCurrentInputContextAsync.

exit

busExit

Arguments

:: (HasCallStack, MonadIO m, IsBus a)

=> a

bus: An Bus.

-> Bool

restart: Whether restarting the ibus.

-> m Bool

Returns: True if the "Exit" call is successful, False otherwise.

Exit or restart ibus-daemon synchronously.

exitAsync

busExitAsync

Arguments

:: (HasCallStack, MonadIO m, IsBus a, IsCancellable b)

=> a

bus: An Bus.

-> Bool

restart: Whether restarting the ibus.

-> Int32

timeoutMsec: The timeout in milliseconds or -1 to use the default timeout.

-> Maybe b

cancellable: A Cancellable or Nothing.

-> Maybe AsyncReadyCallback

callback: A AsyncReadyCallback to call when the request is satisfied or Nothing if you don't care about the result of the method invocation.

-> m ()

Exit or restart ibus-daemon asynchronously.

exitAsyncFinish

busExitAsyncFinish

Arguments

:: (HasCallStack, MonadIO m, IsBus a, IsAsyncResult b)

=> a

bus: An Bus.

-> b

res: A AsyncResult obtained from the AsyncReadyCallback passed to busExitAsync.

-> m ()

(Can throw GError)

Finishes an operation started with busExitAsync.

getConfig

busGetConfig

Arguments

:: (HasCallStack, MonadIO m, IsBus a)

=> a

bus: An Bus.

-> m Config

Returns: An Config object which is configurable with bus.

Get the config instance from Bus.

getConnection

busGetConnection

Arguments

:: (HasCallStack, MonadIO m, IsBus a)

=> a

bus: An Bus.

-> m DBusConnection

Returns: A DBusConnection of an Bus instance.

Gets a DBusConnection of an Bus instance.

getEnginesByNames

busGetEnginesByNames

Arguments

:: (HasCallStack, MonadIO m, IsBus a)

=> a

bus: An Bus.

-> [Text]

names: A Nothing-terminated array of names.

-> m [EngineDesc]

Returns: A Nothing-terminated array of engines.

Get engines by given names synchronously. If some engine names do not exist, this function will simply ignore them, and return rest of engines. TODO(penghuang): add asynchronous version

getGlobalEngine

busGetGlobalEngine

Arguments

:: (HasCallStack, MonadIO m, IsBus a)

=> a

bus: An Bus.

-> m EngineDesc

Returns: The description of current global engine, or Nothing if there is no global engine.

Get the description of current global engine synchronously.

getGlobalEngineAsync

busGetGlobalEngineAsync

Arguments

:: (HasCallStack, MonadIO m, IsBus a, IsCancellable b)

=> a

bus: An Bus.

-> Int32

timeoutMsec: The timeout in milliseconds or -1 to use the default timeout.

-> Maybe b

cancellable: A Cancellable or Nothing.

-> Maybe AsyncReadyCallback

callback: A AsyncReadyCallback to call when the request is satisfied or Nothing if you don't care about the result of the method invocation.

-> m ()

Get the description of current global engine asynchronously.

getGlobalEngineAsyncFinish

busGetGlobalEngineAsyncFinish

Arguments

:: (HasCallStack, MonadIO m, IsBus a, IsAsyncResult b)

=> a

bus: An Bus.

-> b

res: A AsyncResult obtained from the AsyncReadyCallback passed to busGetGlobalEngineAsyncFinish.

-> m EngineDesc

Returns: The description of current global engine, or Nothing if there is no global engine. (Can throw GError)

Finishes an operation started with busGetGlobalEngineAsyncFinish.

getIbusProperty

busGetIbusProperty

Arguments

:: (HasCallStack, MonadIO m, IsBus a)

=> a

bus: An Bus.

-> Text

propertyName: property name in org.freedesktop.DBus.Properties.Get

-> m GVariant

Returns: The value in org.freedesktop.DBus.Properties.Get The returned value must be freed with variantUnref.

Get org.freedesktop.DBus.Properties.

getIbusPropertyAsync

busGetIbusPropertyAsync

Arguments

:: (HasCallStack, MonadIO m, IsBus a, IsCancellable b)

=> a

bus: An Bus.

-> Text

propertyName: property name in org.freedesktop.DBus.Properties.Get

-> Int32

timeoutMsec: The timeout in milliseconds or -1 to use the default timeout.

-> Maybe b

cancellable: A Cancellable or Nothing.

-> Maybe AsyncReadyCallback

callback: A AsyncReadyCallback to call when the request is satisfied or Nothing if you don't care about the result of the method invocation.

-> m ()

Get org.freedesktop.DBus.Properties asynchronously.

getIbusPropertyAsyncFinish

busGetIbusPropertyAsyncFinish

Arguments

:: (HasCallStack, MonadIO m, IsBus a, IsAsyncResult b)

=> a

bus: An Bus.

-> b

res: A AsyncResult obtained from the AsyncReadyCallback passed to busGetIbusPropertyAsync.

-> m GVariant

Returns: The value in org.freedesktop.DBus.Properties.Get The returned value must be freed with variantUnref. (Can throw GError)

Finishes an operation started with busGetIbusPropertyAsync.

getNameOwner

busGetNameOwner

Arguments

:: (HasCallStack, MonadIO m, IsBus a)

=> a

bus: An Bus.

-> Text

name: Name.

-> m Text

Returns: Owner of the name. The returned value must be freed with free.

Return the name owner synchronously.

getNameOwnerAsync

busGetNameOwnerAsync

Arguments

:: (HasCallStack, MonadIO m, IsBus a, IsCancellable b)

=> a

bus: An Bus.

-> Text

name: Name.

-> Int32

timeoutMsec: The timeout in milliseconds or -1 to use the default timeout.

-> Maybe b

cancellable: A Cancellable or Nothing.

-> Maybe AsyncReadyCallback

callback: A AsyncReadyCallback to call when the request is satisfied or Nothing if you don't care about the result of the method invocation.

-> m ()

Return the name owner asynchronously.

getNameOwnerAsyncFinish

busGetNameOwnerAsyncFinish

Arguments

:: (HasCallStack, MonadIO m, IsBus a, IsAsyncResult b)

=> a

bus: An Bus.

-> b

res: A AsyncResult obtained from the AsyncReadyCallback passed to busGetNameOwnerAsync.

-> m Text

Returns: Owner of the name. The returned value must be freed with free. (Can throw GError)

Finishes an operation started with busGetNameOwnerAsync.

getServiceName

busGetServiceName

Arguments

:: (HasCallStack, MonadIO m, IsBus a)

=> a

bus: An Bus.

-> m Text

Returns: at dbus name.

Return the main service name to use for calls on the ibus connection.

getUseGlobalEngine

busGetUseGlobalEngine

Arguments

:: (HasCallStack, MonadIO m, IsBus a)

=> a

bus: An Bus.

-> m Bool

Returns: TRUE if "use_global_engine" option is enabled.

Deprecated: (Since version 1.5.3)Currently global engine is always used.

Check if the bus's "use_global_engine" option is enabled or not synchronously.

getUseGlobalEngineAsync

busGetUseGlobalEngineAsync

Arguments

:: (HasCallStack, MonadIO m, IsBus a, IsCancellable b)

=> a

bus: An Bus.

-> Int32

timeoutMsec: The timeout in milliseconds or -1 to use the default timeout.

-> Maybe b

cancellable: A Cancellable or Nothing.

-> Maybe AsyncReadyCallback

callback: A AsyncReadyCallback to call when the request is satisfied or Nothing if you don't care about the result of the method invocation.

-> m ()

Deprecated: (Since version 1.5.3)Currently global engine is always used.

Check if the bus's "use_global_engine" option is enabled or not asynchronously.

getUseGlobalEngineAsyncFinish

busGetUseGlobalEngineAsyncFinish

Arguments

:: (HasCallStack, MonadIO m, IsBus a, IsAsyncResult b)

=> a

bus: An Bus.

-> b

res: A AsyncResult obtained from the AsyncReadyCallback passed to busGetUseGlobalEngineAsync.

-> m ()

(Can throw GError)

Deprecated: (Since version 1.5.3)Currently global engine is always used.

Finishes an operation started with busGetUseGlobalEngineAsync.

getUseSysLayout

busGetUseSysLayout

Arguments

:: (HasCallStack, MonadIO m, IsBus a)

=> a

bus: An Bus.

-> m Bool

Returns: True if "use_sys_layout" option is enabled.

Deprecated: (Since version 1.5.3)Read dconf value/desktop/ibus/general/use_system_keyboard_layout instead.

Check if the bus's "use_sys_layout" option is enabled or not synchronously.

getUseSysLayoutAsync

busGetUseSysLayoutAsync

Arguments

:: (HasCallStack, MonadIO m, IsBus a, IsCancellable b)

=> a

bus: An Bus.

-> Int32

timeoutMsec: The timeout in milliseconds or -1 to use the default timeout.

-> Maybe b

cancellable: A Cancellable or Nothing.

-> Maybe AsyncReadyCallback

callback: A AsyncReadyCallback to call when the request is satisfied or Nothing if you don't care about the result of the method invocation.

-> m ()

Deprecated: (Since version 1.5.3)Read dconf value/desktop/ibus/general/use_system_keyboard_layout instead.

Check if the bus's "use_sys_layout" option is enabled or not asynchronously.

getUseSysLayoutAsyncFinish

busGetUseSysLayoutAsyncFinish

Arguments

:: (HasCallStack, MonadIO m, IsBus a, IsAsyncResult b)

=> a

bus: An Bus.

-> b

res: A AsyncResult obtained from the AsyncReadyCallback passed to busGetUseSysLayoutAsync.

-> m ()

(Can throw GError)

Deprecated: (Since version 1.5.3)Read dconf value/desktop/ibus/general/use_system_keyboard_layout instead.

Finishes an operation started with busGetUseSysLayoutAsync.

hello

busHello

Arguments

:: (HasCallStack, MonadIO m, IsBus a)

=> a

bus: An Bus.

-> m Text

Returns: The unique name of IBus process in DBus.

This function sends a "HELLO" message to DBus daemon, which replies the unique name of current IBus process.

isConnected

busIsConnected

Arguments

:: (HasCallStack, MonadIO m, IsBus a)

=> a

bus: An Bus.

-> m Bool

Returns: True if bus is connected, False otherwise.

Return True if bus is connected to IBus daemon.

isGlobalEngineEnabled

busIsGlobalEngineEnabled

Arguments

:: (HasCallStack, MonadIO m, IsBus a)

=> a

bus: An Bus.

-> m Bool

Returns: True if the current global engine is enabled.

Deprecated: (Since version 1.5.3)Probably this would be used for Chrome OS only.Currently global engine is always used and busGetGlobalEnginereturns NULL until the first global engine is assigned.You can use setLogHandler to disable a warning whenbusGetGlobalEngine returns NULL.

Check if the current global engine is enabled or not synchronously.

isGlobalEngineEnabledAsync

busIsGlobalEngineEnabledAsync

Arguments

:: (HasCallStack, MonadIO m, IsBus a, IsCancellable b)

=> a

bus: An Bus.

-> Int32

timeoutMsec: The timeout in milliseconds or -1 to use the default timeout.

-> Maybe b

cancellable: A Cancellable or Nothing.

-> Maybe AsyncReadyCallback

callback: A AsyncReadyCallback to call when the request is satisfied or Nothing if you don't care about the result of the method invocation.

-> m ()

Deprecated: (Since version 1.5.3)Probably this would be used for Chrome OS only.Currently global engine is always used and busGetGlobalEnginereturns NULL until the first global engine is assigned.You can use setLogHandler to disable a warning whenbusGetGlobalEngine returns NULL.

Check if the current global engine is enabled or not asynchronously.

isGlobalEngineEnabledAsyncFinish

busIsGlobalEngineEnabledAsyncFinish

Arguments

:: (HasCallStack, MonadIO m, IsBus a, IsAsyncResult b)

=> a

bus: An Bus.

-> b

res: A AsyncResult obtained from the AsyncReadyCallback passed to busIsGlobalEngineEnabledAsync.

-> m ()

(Can throw GError)

Deprecated: (Since version 1.5.3)Probably this would be used for Chrome OS only.Currently global engine is always used and busGetGlobalEnginereturns NULL until the first global engine is assigned.You can use setLogHandler to disable a warning whenbusGetGlobalEngine returns NULL.

Finishes an operation started with busIsGlobalEngineEnabledAsync.

listActiveEngines

busListActiveEngines

Arguments

:: (HasCallStack, MonadIO m, IsBus a)

=> a

bus: An Bus.

-> m [EngineDesc]

Returns: A List of active engines.

Deprecated: (Since version 1.5.3)Read dconf value/desktop/ibus/general/preload-engines instead.

List active engines synchronously.

listActiveEnginesAsync

busListActiveEnginesAsync

Arguments

:: (HasCallStack, MonadIO m, IsBus a, IsCancellable b)

=> a

bus: An Bus.

-> Int32

timeoutMsec: The timeout in milliseconds or -1 to use the default timeout.

-> Maybe b

cancellable: A Cancellable or Nothing.

-> Maybe AsyncReadyCallback

callback: A AsyncReadyCallback to call when the request is satisfied or Nothing if you don't care about the result of the method invocation.

-> m ()

Deprecated: (Since version 1.5.3)Read dconf value/desktop/ibus/general/preload-engines instead.

List active engines asynchronously.

listActiveEnginesAsyncFinish

busListActiveEnginesAsyncFinish

Arguments

:: (HasCallStack, MonadIO m, IsBus a, IsAsyncResult b)

=> a

bus: An Bus.

-> b

res: A AsyncResult obtained from the AsyncReadyCallback passed to busListActiveEnginesAsync.

-> m [EngineDesc]

Returns: A List of active engines. (Can throw GError)

Deprecated: (Since version 1.5.3)Read dconf value/desktop/ibus/general/preload-engines instead.

Finishes an operation started with busListActiveEnginesAsync.

listEngines

busListEngines

Arguments

:: (HasCallStack, MonadIO m, IsBus a)

=> a

bus: An Bus.

-> m [EngineDesc]

Returns: A List of engines.

List engines synchronously.

listEnginesAsync

busListEnginesAsync

Arguments

:: (HasCallStack, MonadIO m, IsBus a, IsCancellable b)

=> a

bus: An Bus.

-> Int32

timeoutMsec: The timeout in milliseconds or -1 to use the default timeout.

-> Maybe b

cancellable: A Cancellable or Nothing.

-> Maybe AsyncReadyCallback

callback: A AsyncReadyCallback to call when the request is satisfied or Nothing if you don't care about the result of the method invocation.

-> m ()

List engines asynchronously.

listEnginesAsyncFinish

busListEnginesAsyncFinish

Arguments

:: (HasCallStack, MonadIO m, IsBus a, IsAsyncResult b)

=> a

bus: An Bus.

-> b

res: A AsyncResult obtained from the AsyncReadyCallback passed to busListEnginesAsync.

-> m [EngineDesc]

Returns: A List of engines. (Can throw GError)

Finishes an operation started with busListEnginesAsync.

listNames

busListNames

Arguments

:: (HasCallStack, MonadIO m, IsBus a)

=> a

bus: An Bus.

-> m [Text]

Returns: Lists that attached to bus.

Return lists that attached to bus. <note><para>[FixMe] Not implemented yet, only return Nothing.</para></note> <note><para>[FixMe] Add async version.</para></note>

listQueuedOwners

busListQueuedOwners

Arguments

:: (HasCallStack, MonadIO m, IsBus a)

=> a

bus: An IBusBus.

-> Text

name: Name to be queried.

-> m [Text]

Returns: The unique bus names of connections currently queued for name.

Lists the unique bus names of connections currently queued for a bus name. FIXME add an asynchronous version.

nameHasOwner

busNameHasOwner

Arguments

:: (HasCallStack, MonadIO m, IsBus a)

=> a

bus: An Bus.

-> Text

name: Name to be checked.

-> m Bool

Returns: True if the name has owner, False otherwise.

Checks whether the name has owner synchronously.

nameHasOwnerAsync

busNameHasOwnerAsync

Arguments

:: (HasCallStack, MonadIO m, IsBus a, IsCancellable b)

=> a

bus: An Bus.

-> Text

name: Name to be checked.

-> Int32

timeoutMsec: The timeout in milliseconds or -1 to use the default timeout.

-> Maybe b

cancellable: A Cancellable or Nothing.

-> Maybe AsyncReadyCallback

callback: A AsyncReadyCallback to call when the request is satisfied or Nothing if you don't care about the result of the method invocation.

-> m ()

Checks whether the name has owner asynchronously.

nameHasOwnerAsyncFinish

busNameHasOwnerAsyncFinish

Arguments

:: (HasCallStack, MonadIO m, IsBus a, IsAsyncResult b)

=> a

bus: An Bus.

-> b

res: A AsyncResult obtained from the AsyncReadyCallback passed to busNameHasOwnerAsync.

-> m ()

(Can throw GError)

Finishes an operation started with busNameHasOwnerAsync.

new

busNew

Arguments

:: (HasCallStack, MonadIO m)

=> m Bus

Returns: A newly allocated Bus instance, and the instance is not floating.

Creates a new Bus instance.

newAsync

busNewAsync

Arguments

:: (HasCallStack, MonadIO m)

=> m Bus

Returns: A newly allocated Bus instance, and the instance is not floating.

Creates a new Bus instance. The instance will asynchronously connect to the IBus daemon.

newAsyncClient

busNewAsyncClient

Arguments

:: (HasCallStack, MonadIO m)

=> m Bus

Returns: A newly allocated Bus instance, and the instance is not floating.

Creates a new Bus instance for client use only. It will possibly be limited in what it can do.

The instance will asynchronously connect to the IBus daemon.

preloadEngines

busPreloadEngines

Arguments

:: (HasCallStack, MonadIO m, IsBus a)

=> a

bus: An Bus.

-> [Text]

names: A Nothing-terminated array of engine names.

-> m Bool

Returns: True if components start. False otherwise.

Start bus components by engine names synchronously.

preloadEnginesAsync

busPreloadEnginesAsync

Arguments

:: (HasCallStack, MonadIO m, IsBus a, IsCancellable b)

=> a

bus: An Bus.

-> [Text]

names: A Nothing-terminated array of engine names.

-> Int32

timeoutMsec: The timeout in milliseconds or -1 to use the default timeout.

-> Maybe b

cancellable: A Cancellable or Nothing.

-> Maybe AsyncReadyCallback

callback: A AsyncReadyCallback to call when the request is satisfied or Nothing if you don't care about the result of the method invocation.

-> m ()

Start bus components by engine names asynchronously.

preloadEnginesAsyncFinish

busPreloadEnginesAsyncFinish

Arguments

:: (HasCallStack, MonadIO m, IsBus a, IsAsyncResult b)

=> a

bus: An Bus.

-> b

res: A AsyncResult obtained from the AsyncReadyCallback passed to busPreloadEnginesAsync.

-> m ()

(Can throw GError)

Finishes an operation started with busPreloadEnginesAsync.

registerComponent

busRegisterComponent

Arguments

:: (HasCallStack, MonadIO m, IsBus a, IsComponent b)

=> a

bus: An Bus.

-> b

component: A input engine component.

-> m Bool

Returns: True if the "RegisterComponent" call is successful, False otherwise.

Register a component to an Bus synchronously.

registerComponentAsync

busRegisterComponentAsync

Arguments

:: (HasCallStack, MonadIO m, IsBus a, IsComponent b, IsCancellable c)

=> a

bus: An Bus.

-> b

component: A input engine component.

-> Int32

timeoutMsec: The timeout in milliseconds or -1 to use the default timeout.

-> Maybe c

cancellable: A Cancellable or Nothing.

-> Maybe AsyncReadyCallback

callback: A AsyncReadyCallback to call when the request is satisfied or Nothing if you don't care about the result of the method invocation.

-> m ()

Register a component to an Bus asynchronously.

registerComponentAsyncFinish

busRegisterComponentAsyncFinish

Arguments

:: (HasCallStack, MonadIO m, IsBus a, IsAsyncResult b)

=> a

bus: An Bus.

-> b

res: A AsyncResult obtained from the AsyncReadyCallback passed to busRegisterComponentAsync.

-> m ()

(Can throw GError)

Finishes an operation started with busRegisterComponentAsync.

releaseName

busReleaseName

Arguments

:: (HasCallStack, MonadIO m, IsBus a)

=> a

bus: An Bus.

-> Text

name: Name to be released.

-> m Word32

Returns: 0 if failed; positive number otherwise.

Release a name to IBus daemon synchronously.

releaseNameAsync

busReleaseNameAsync

Arguments

:: (HasCallStack, MonadIO m, IsBus a, IsCancellable b)

=> a

bus: An Bus.

-> Text

name: Name to be released.

-> Int32

timeoutMsec: The timeout in milliseconds or -1 to use the default timeout.

-> Maybe b

cancellable: A Cancellable or Nothing.

-> Maybe AsyncReadyCallback

callback: A AsyncReadyCallback to call when the request is satisfied or Nothing if you don't care about the result of the method invocation.

-> m ()

Release a name to IBus daemon asynchronously.

releaseNameAsyncFinish

busReleaseNameAsyncFinish

Arguments

:: (HasCallStack, MonadIO m, IsBus a, IsAsyncResult b)

=> a

bus: An Bus.

-> b

res: A AsyncResult obtained from the AsyncReadyCallback passed to busReleaseNameAsync.

-> m Word32

Returns: 0 if failed; positive number otherwise. (Can throw GError)

Finishes an operation started with busReleaseNameAsync.

removeMatch

busRemoveMatch

Arguments

:: (HasCallStack, MonadIO m, IsBus a)

=> a

bus: An Bus.

-> Text

rule: Match rule.

-> m Bool

Returns: True if the rule is removed. False otherwise.

Remove a match rule to an Bus synchronously.

removeMatchAsync

busRemoveMatchAsync

Arguments

:: (HasCallStack, MonadIO m, IsBus a, IsCancellable b)

=> a

bus: An Bus.

-> Text

rule: Match rule.

-> Int32

timeoutMsec: The timeout in milliseconds or -1 to use the default timeout.

-> Maybe b

cancellable: A Cancellable or Nothing.

-> Maybe AsyncReadyCallback

callback: A AsyncReadyCallback to call when the request is satisfied or Nothing if you don't care about the result of the method invocation.

-> m ()

Remove a match rule to an IBusBus asynchronously.

removeMatchAsyncFinish

busRemoveMatchAsyncFinish

Arguments

:: (HasCallStack, MonadIO m, IsBus a, IsAsyncResult b)

=> a

bus: An Bus.

-> b

res: A AsyncResult obtained from the AsyncReadyCallback passed to busRemoveMatchAsync.

-> m ()

(Can throw GError)

Finishes an operation started with busRemoveMatchAsync.

requestName

busRequestName

Arguments

:: (HasCallStack, MonadIO m, IsBus a)

=> a

bus: the IBusBus instance to be processed.

-> Text

name: Name to be requested.

-> Word32

flags: IBusBusNameFlag.

-> m Word32

Returns: 0 if failed; IBusBusRequestNameReply otherwise.

Request a name from IBus daemon synchronously.

requestNameAsync

busRequestNameAsync

Arguments

:: (HasCallStack, MonadIO m, IsBus a, IsCancellable b)

=> a

bus: An Bus.

-> Text

name: Name to be requested.

-> Word32

flags: Flags (FixMe).

-> Int32

timeoutMsec: The timeout in milliseconds or -1 to use the default timeout.

-> Maybe b

cancellable: A Cancellable or Nothing.

-> Maybe AsyncReadyCallback

callback: A AsyncReadyCallback to call when the request is satisfied or Nothing if you don't care about the result of the method invocation.

-> m ()

Request a name from IBus daemon asynchronously.

requestNameAsyncFinish

busRequestNameAsyncFinish

Arguments

:: (HasCallStack, MonadIO m, IsBus a, IsAsyncResult b)

=> a

bus: An Bus.

-> b

res: A AsyncResult obtained from the AsyncReadyCallback passed to busRequestNameAsync.

-> m Word32

Returns: 0 if failed; positive number otherwise. (Can throw GError)

Finishes an operation started with busRequestNameAsync.

setGlobalEngine

busSetGlobalEngine

Arguments

:: (HasCallStack, MonadIO m, IsBus a)

=> a

bus: An Bus.

-> Text

globalEngine: A new engine name.

-> m Bool

Returns: True if the global engine was set successfully.

Set current global engine synchronously.

setGlobalEngineAsync

busSetGlobalEngineAsync

Arguments

:: (HasCallStack, MonadIO m, IsBus a, IsCancellable b)

=> a

bus: An Bus.

-> Text

globalEngine: A new engine name.

-> Int32

timeoutMsec: The timeout in milliseconds or -1 to use the default timeout.

-> Maybe b

cancellable: A Cancellable or Nothing.

-> Maybe AsyncReadyCallback

callback: A AsyncReadyCallback to call when the request is satisfied or Nothing if you don't care about the result of the method invocation.

-> m ()

Set current global engine asynchronously.

setGlobalEngineAsyncFinish

busSetGlobalEngineAsyncFinish

Arguments

:: (HasCallStack, MonadIO m, IsBus a, IsAsyncResult b)

=> a

bus: An Bus.

-> b

res: A AsyncResult obtained from the AsyncReadyCallback passed to busSetGlobalEngineAsync.

-> m ()

(Can throw GError)

Finishes an operation started with busSetGlobalEngineAsync.

setGlobalShortcutKeys

busSetGlobalShortcutKeys

Arguments

:: (HasCallStack, MonadIO m, IsBus a)

=> a

bus: An Bus.

-> BusGlobalBindingType

gtype: A BusGlobalBindingType.

-> [ProcessKeyEventData]

keys: A Nothing-terminated array of ProcessKeyEventData. keycode is used for the selecting direction and the forward direction in case of 0, otherwise the backward direction.

-> m Bool

Returns: True if the global shortcut keys are set. False otherwise.

Set global shorcut keys for the Wayland session.

Since: 1.5.29

setGlobalShortcutKeysAsync

busSetGlobalShortcutKeysAsync

Arguments

:: (HasCallStack, MonadIO m, IsBus a, IsCancellable b)

=> a

bus: An Bus.

-> BusGlobalBindingType

gtype: A BusGlobalBindingType.

-> [ProcessKeyEventData]

keys: A Nothing-terminated array of ProcessKeyEventData.

-> Int32

timeoutMsec: The timeout in milliseconds or -1 to use the default timeout.

-> Maybe b

cancellable: A Cancellable or Nothing.

-> Maybe AsyncReadyCallback

callback: A AsyncReadyCallback to call when the request is satisfied or Nothing if you don't care about the result of the method invocation.

-> m ()

Sete global shorcut keys for the Wayland session asynchronously.

Since: 1.5.29

setGlobalShortcutKeysAsyncFinish

busSetGlobalShortcutKeysAsyncFinish

Arguments

:: (HasCallStack, MonadIO m, IsBus a, IsAsyncResult b)

=> a

bus: An Bus.

-> b

res: A AsyncResult obtained from the AsyncReadyCallback passed to busSetGlobalShortcutKeysAsync.

-> m ()

(Can throw GError)

Finishes an operation started with busSetGlobalShortcutKeysAsync.

Since: 1.5.29

setIbusProperty

busSetIbusProperty

Arguments

:: (HasCallStack, MonadIO m, IsBus a)

=> a

bus: An Bus.

-> Text

propertyName: property name in org.freedesktop.DBus.Properties.Set

-> GVariant

value: value in org.freedesktop.DBus.Properties.Set

-> m ()

Set org.freedesktop.DBus.Properties.

setIbusPropertyAsync

busSetIbusPropertyAsync

Arguments

:: (HasCallStack, MonadIO m, IsBus a, IsCancellable b)

=> a

bus: An Bus.

-> Text

propertyName: property name in org.freedesktop.DBus.Properties.Set

-> GVariant

value: value in org.freedesktop.DBus.Properties.Set

-> Int32

timeoutMsec: The timeout in milliseconds or -1 to use the default timeout.

-> Maybe b

cancellable: A Cancellable or Nothing.

-> Maybe AsyncReadyCallback

callback: A AsyncReadyCallback to call when the request is satisfied or Nothing if you don't care about the result of the method invocation.

-> m ()

Set org.freedesktop.DBus.Properties asynchronously.

setIbusPropertyAsyncFinish

busSetIbusPropertyAsyncFinish

Arguments

:: (HasCallStack, MonadIO m, IsBus a, IsAsyncResult b)

=> a

bus: An Bus.

-> b

res: A AsyncResult obtained from the AsyncReadyCallback passed to busSetIbusPropertyAsync.

-> m ()

(Can throw GError)

Finishes an operation started with busSetIbusPropertyAsync.

setWatchDbusSignal

busSetWatchDbusSignal

Arguments

:: (HasCallStack, MonadIO m, IsBus a)

=> a

bus: An Bus.

-> Bool

watch: True if you want ibusbus to emit "name-owner-changed" signal when ibus-daemon emits the NameOwnerChanged DBus signal.

-> m ()

Start or stop watching the NameOwnerChanged DBus signal.

setWatchIbusSignal

busSetWatchIbusSignal

Arguments

:: (HasCallStack, MonadIO m, IsBus a)

=> a

bus: An Bus.

-> Bool

watch: True if you want ibusbus to emit "global-engine-changed" signal when ibus-daemon emits the GlobalEngineChanged IBus signal.

-> m ()

Start or stop watching the GlobalEngineChanged IBus signal.

Properties

clientOnly

Whether the Bus object is for client use only.

constructBusClientOnly :: (IsBus o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “client-only” property. This is rarely needed directly, but it is used by new.

getBusClientOnly :: (MonadIO m, IsBus o) => o -> m Bool

Get the value of the “client-only” property. When overloading is enabled, this is equivalent to

get bus #clientOnly

connectAsync

Whether the Bus object should connect asynchronously to the bus.

constructBusConnectAsync :: (IsBus o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “connect-async” property. This is rarely needed directly, but it is used by new.

getBusConnectAsync :: (MonadIO m, IsBus o) => o -> m Bool

Get the value of the “connect-async” property. When overloading is enabled, this is equivalent to

get bus #connectAsync

Signals

connected

type BusConnectedCallback = IO ()

Emitted when Bus is connected to ibus-daemon.

afterBusConnected :: (IsBus a, MonadIO m) => a -> ((?self :: a) => BusConnectedCallback) -> m SignalHandlerId

Connect a signal handler for the connected signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after bus #connected callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onBusConnected :: (IsBus a, MonadIO m) => a -> ((?self :: a) => BusConnectedCallback) -> m SignalHandlerId

Connect a signal handler for the connected signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on bus #connected callback

disconnected

type BusDisconnectedCallback = IO ()

Emitted when Bus is disconnected from ibus-daemon.

afterBusDisconnected :: (IsBus a, MonadIO m) => a -> ((?self :: a) => BusDisconnectedCallback) -> m SignalHandlerId

Connect a signal handler for the disconnected signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after bus #disconnected callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onBusDisconnected :: (IsBus a, MonadIO m) => a -> ((?self :: a) => BusDisconnectedCallback) -> m SignalHandlerId

Connect a signal handler for the disconnected signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on bus #disconnected callback

globalEngineChanged

type BusGlobalEngineChangedCallback

Arguments

 = Text

name: The name of the new global engine.

-> IO ()

Emitted when global engine is changed.

afterBusGlobalEngineChanged :: (IsBus a, MonadIO m) => a -> ((?self :: a) => BusGlobalEngineChangedCallback) -> m SignalHandlerId

Connect a signal handler for the globalEngineChanged signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after bus #globalEngineChanged callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onBusGlobalEngineChanged :: (IsBus a, MonadIO m) => a -> ((?self :: a) => BusGlobalEngineChangedCallback) -> m SignalHandlerId

Connect a signal handler for the globalEngineChanged signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on bus #globalEngineChanged callback

globalShortcutKeyResponded

type BusGlobalShortcutKeyRespondedCallback

Arguments

 = Word8

type: The type of the global shortcut key.

-> Bool

isPressed: True if the key is pressed.

-> Bool

isBackward: True if the backward key is pressed.

-> IO ()

Emitted when global shortcut key is responded.

afterBusGlobalShortcutKeyResponded :: (IsBus a, MonadIO m) => a -> ((?self :: a) => BusGlobalShortcutKeyRespondedCallback) -> m SignalHandlerId

Connect a signal handler for the globalShortcutKeyResponded signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after bus #globalShortcutKeyResponded callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onBusGlobalShortcutKeyResponded :: (IsBus a, MonadIO m) => a -> ((?self :: a) => BusGlobalShortcutKeyRespondedCallback) -> m SignalHandlerId

Connect a signal handler for the globalShortcutKeyResponded signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on bus #globalShortcutKeyResponded callback

nameOwnerChanged

type BusNameOwnerChangedCallback

Arguments

 = Text

name: The name which ower is changed.

-> Text

oldOwner: The unique bus name of the old owner.

-> Text

newOwner: The unique bus name of the new owner.

-> IO ()

Emitted when D-Bus name owner is changed.

afterBusNameOwnerChanged :: (IsBus a, MonadIO m) => a -> ((?self :: a) => BusNameOwnerChangedCallback) -> m SignalHandlerId

Connect a signal handler for the nameOwnerChanged signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after bus #nameOwnerChanged callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onBusNameOwnerChanged :: (IsBus a, MonadIO m) => a -> ((?self :: a) => BusNameOwnerChangedCallback) -> m SignalHandlerId

Connect a signal handler for the nameOwnerChanged signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on bus #nameOwnerChanged callback