GI.IBus.Objects.Factory

An IBusFactory is an Service that creates input method engine (IME) instance. It provides CreateEngine remote method, which creates an IME instance by name, and returns the D-Bus object path to IBus daemon.

see_also: Engine

Exported types

newtype Factory

Memory-managed wrapper type.

Constructors

Factory (ManagedPtr Factory)

Instances

Eq Factory

Defined in GI.IBus.Objects.Factory

Methods

(==) :: Factory -> Factory -> Bool

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

GObject Factory

Defined in GI.IBus.Objects.Factory

ManagedPtrNewtype Factory

Defined in GI.IBus.Objects.Factory

Methods

toManagedPtr :: Factory -> ManagedPtr Factory

TypedObject Factory

Defined in GI.IBus.Objects.Factory

Methods

glibType :: IO GType

HasParentTypes Factory

Defined in GI.IBus.Objects.Factory

IsGValue (Maybe Factory)

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

Defined in GI.IBus.Objects.Factory

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes Factory

Defined in GI.IBus.Objects.Factory

type ParentTypes Factory = '[Service, Object, Object]

class (GObject o, IsDescendantOf Factory o) => IsFactory o

Type class for types which can be safely cast to Factory, for instance with toFactory.

Instances

(GObject o, IsDescendantOf Factory o) => IsFactory o

Defined in GI.IBus.Objects.Factory

toFactory :: (MonadIO m, IsFactory o) => o -> m Factory

Cast to Factory, 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

addEngine, bindProperty, bindPropertyFull, createEngine, destroy, emitSignal, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, register, runDispose, stealData, stealQdata, thawNotify, unref, unregister, watchClosure.

Getters

getConnection, getData, getObjectPath, getProperty, getQdata.

Setters

setData, setDataFull, setProperty.

addEngine

factoryAddEngine

Arguments

:: (HasCallStack, MonadIO m, IsFactory a)

=> a

factory: An IBusFactory.

-> Text

engineName: Name of an engine.

-> GType

engineType: GType of an engine.

-> m ()

Add an engine to the factory.

createEngine

factoryCreateEngine

Arguments

:: (HasCallStack, MonadIO m, IsFactory a)

=> a

factory: An Factory.

-> Text

engineName: Name of an engine.

-> m Engine

Returns: Engine with engineName.

Creates an Engine with engineName.

new

factoryNew

Arguments

:: (HasCallStack, MonadIO m, IsDBusConnection a)

=> a

connection: An GDBusConnection.

-> m Factory

Returns: A newly allocated Factory.

Creates a new Factory.

Signals

createEngine

type C_FactoryCreateEngineCallback = Ptr () -> CString -> Ptr () -> IO (Ptr Engine)

Type for the callback on the (unwrapped) C side.

type FactoryCreateEngineCallback

Arguments

 = Text

engineName: the engine_name which received the signal

-> IO (Maybe Engine)

Returns: An IBusEngine

The createEngine signal is a signal to create IBusEngine with engineName, which gets emitted when IBusFactory received CreateEngine dbus method. The callback functions will be called until a callback returns a non-null object of IBusEngine.

afterFactoryCreateEngine :: (IsFactory a, MonadIO m) => a -> FactoryCreateEngineCallback -> m SignalHandlerId

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

after factory #createEngine callback

genClosure_FactoryCreateEngine :: MonadIO m => FactoryCreateEngineCallback -> m (GClosure C_FactoryCreateEngineCallback)

Wrap the callback into a GClosure.

mk_FactoryCreateEngineCallback :: C_FactoryCreateEngineCallback -> IO (FunPtr C_FactoryCreateEngineCallback)

Generate a function pointer callable from C code, from a C_FactoryCreateEngineCallback.

noFactoryCreateEngineCallback :: Maybe FactoryCreateEngineCallback

A convenience synonym for Nothing :: Maybe FactoryCreateEngineCallback.

onFactoryCreateEngine :: (IsFactory a, MonadIO m) => a -> FactoryCreateEngineCallback -> m SignalHandlerId

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

on factory #createEngine callback

wrap_FactoryCreateEngineCallback :: FactoryCreateEngineCallback -> C_FactoryCreateEngineCallback

Wrap a FactoryCreateEngineCallback into a C_FactoryCreateEngineCallback.