gi-ibus-1.5.3: IBus bindings
CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellSafe-Inferred
LanguageHaskell2010

GI.IBus.Objects.InputContext

Description

An IBusInputContext is a proxy object of BusInputContext, which manages the context for input methods that supports text input in various natural languages.

Clients call the IBusInputContext to invoke BusInputContext, through which invokes IBusEngine.

Synopsis

Exported types

newtype InputContext Source #

Memory-managed wrapper type.

Constructors

InputContext (ManagedPtr InputContext) 

Instances

Instances details
Eq InputContext Source # 
Instance details

Defined in GI.IBus.Objects.InputContext

GObject InputContext Source # 
Instance details

Defined in GI.IBus.Objects.InputContext

ManagedPtrNewtype InputContext Source # 
Instance details

Defined in GI.IBus.Objects.InputContext

Methods

toManagedPtr :: InputContext -> ManagedPtr InputContext

TypedObject InputContext Source # 
Instance details

Defined in GI.IBus.Objects.InputContext

Methods

glibType :: IO GType

HasParentTypes InputContext Source # 
Instance details

Defined in GI.IBus.Objects.InputContext

IsGValue (Maybe InputContext) Source #

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

Instance details

Defined in GI.IBus.Objects.InputContext

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes InputContext Source # 
Instance details

Defined in GI.IBus.Objects.InputContext

type ParentTypes InputContext = '[Proxy, DBusProxy, Object, AsyncInitable, DBusInterface, Initable]

class (GObject o, IsDescendantOf InputContext o) => IsInputContext o Source #

Type class for types which can be safely cast to InputContext, for instance with toInputContext.

Instances

Instances details
(GObject o, IsDescendantOf InputContext o) => IsInputContext o Source # 
Instance details

Defined in GI.IBus.Objects.InputContext

toInputContext :: (MonadIO m, IsInputContext o) => o -> m InputContext Source #

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

Methods

cancelHandWriting

inputContextCancelHandWriting Source #

Arguments

:: (HasCallStack, MonadIO m, IsInputContext a) 
=> a

context: An IBusInputContext.

-> Word32

nStrokes: The number of strokes to be removed. Pass 0 to remove all.

-> m () 

Clear handwriting stroke(s) in the current input method engine.

see_also: cancelHandWriting

focusIn

inputContextFocusIn Source #

Arguments

:: (HasCallStack, MonadIO m, IsInputContext a) 
=> a

context: An InputContext.

-> m () 

Invoked when the client application get focus. An asynchronous IPC will be performed.

see_also: Engine::focus_in.

focusOut

inputContextFocusOut Source #

Arguments

:: (HasCallStack, MonadIO m, IsInputContext a) 
=> a

context: An InputContext.

-> m () 

Invoked when the client application get focus. An asynchronous IPC will be performed.

see_also: Engine::focus_out.

getEngine

inputContextGetEngine Source #

Arguments

:: (HasCallStack, MonadIO m, IsInputContext a) 
=> a

context: An InputContext.

-> m EngineDesc

Returns: An IME engine description for the context, or NULL.

Gets an IME engine description for the context. A synchronous IPC will be performed.

getEngineAsync

inputContextGetEngineAsync Source #

Arguments

:: (HasCallStack, MonadIO m, IsInputContext a, IsCancellable b) 
=> a

context: An InputContext.

-> 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 () 

An asynchronous IPC will be performed.

getEngineAsyncFinish

inputContextGetEngineAsyncFinish Source #

Arguments

:: (HasCallStack, MonadIO m, IsInputContext a, IsAsyncResult b) 
=> a

context: An InputContext.

-> b

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

-> m EngineDesc

Returns: An IME engine description for the context, or Nothing. (Can throw GError)

Finishes an operation started with inputContextGetEngineAsync.

getInputContext

inputContextGetInputContext Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusConnection a) 
=> Text

path: The path to the object that emitting the signal.

-> a

connection: A GDBusConnection.

-> m InputContext

Returns: An existing InputContext.

Gets an existing IBusInputContext.

getInputContextAsync

inputContextGetInputContextAsync Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusConnection a, IsCancellable b) 
=> Text

path: The path to the object that emitting the signal.

-> a

connection: A DBusConnection.

-> Maybe b

cancellable: A Cancellable or Nothing.

-> Maybe AsyncReadyCallback

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

-> m () 

Gets an existing InputContext asynchronously.

getInputContextAsyncFinish

inputContextGetInputContextAsyncFinish Source #

Arguments

:: (HasCallStack, MonadIO m, IsAsyncResult a) 
=> a

res: A AsyncResult obtained from the AsyncReadyCallback pass to inputContextGetInputContextAsync.

-> m InputContext

Returns: An existing InputContext. (Can throw GError)

Finishes an operation started with inputContextGetInputContextAsync.

needsSurroundingText

inputContextNeedsSurroundingText Source #

Arguments

:: (HasCallStack, MonadIO m, IsInputContext a) 
=> a

context: An InputContext.

-> m Bool

Returns: True if surrounding-text is needed by the current engine; False otherwise.

Check whether the current engine requires surrounding-text.

new

inputContextNew Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusConnection a, IsCancellable b) 
=> Text

path: The path to the object that emitting the signal.

-> a

connection: A DBusConnection.

-> Maybe b

cancellable: A Cancellable or Nothing.

-> m InputContext

Returns: A newly allocated InputContext. (Can throw GError)

Creates a new InputContext.

newAsync

inputContextNewAsync Source #

Arguments

:: (HasCallStack, MonadIO m, IsDBusConnection a, IsCancellable b) 
=> Text

path: The path to the object that emitting the signal.

-> a

connection: A DBusConnection.

-> Maybe b

cancellable: A Cancellable or Nothing.

-> Maybe AsyncReadyCallback

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

-> m () 

Creates a new InputContext asynchronously.

newAsyncFinish

inputContextNewAsyncFinish Source #

Arguments

:: (HasCallStack, MonadIO m, IsAsyncResult a) 
=> a

res: A AsyncResult obtained from the AsyncReadyCallback pass to inputContextNewAsync.

-> m InputContext

Returns: A newly allocated InputContext. (Can throw GError)

Finishes an operation started with inputContextNewAsync.

processHandWritingEvent

inputContextProcessHandWritingEvent Source #

Arguments

:: (HasCallStack, MonadIO m, IsInputContext a) 
=> a

context: An IBusInputContext.

-> Double

coordinates: An array of gdouble (0.0 to 1.0) which represents a stroke (i.e. [x1, y1, x2, y2, x3, y3, ...]).

-> Word32

coordinatesLen: The number of elements in the array. The number should be even and >= 4.

-> m () 

Pass a handwriting stroke to an input method engine.

In this API, a coordinate (0.0, 0.0) represents the top-left corner of an area for handwriting, and (1.0, 1.0) does the bottom-right. Therefore, for example, if a user writes a character 'L', the array would be something like [0.0, 0.0, 0.0, 1.0, 1.0, 1.0] and coordinates_len would be 6.

The function is usually called when a user releases the mouse button in a hand writing area.

see_also: processHandWritingEvent

processKeyEvent

inputContextProcessKeyEvent Source #

Arguments

:: (HasCallStack, MonadIO m, IsInputContext a) 
=> a

context: An InputContext.

-> Word32

keyval: Key symbol of a key event.

-> Word32

keycode: Keycode of a key event.

-> Word32

state: Key modifier flags.

-> m Bool

Returns: True for successfully process the key; False otherwise.

See also: inputContextProcessKeyEventAsync

Pass the key event to input method engine and wait for the reply from ibus (i.e. synchronous IPC).

processKeyEventAsync

inputContextProcessKeyEventAsync Source #

Arguments

:: (HasCallStack, MonadIO m, IsInputContext a, IsCancellable b) 
=> a

context: An IBusInputContext.

-> Word32

keyval: Key symbol of a key event.

-> Word32

keycode: Keycode of a key event.

-> Word32

state: Key modifier flags.

-> Int32

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

-> Maybe b

cancellable: A GCancellable or NULL.

-> Maybe AsyncReadyCallback

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

-> m () 

Pass the key event to input method engine.

Key symbols are characters/symbols produced by key press, for example, pressing "s" generates key symbol "s"; pressing shift-"s" generates key symbol "S". Same key on keyboard may produce different key symbols on different keyboard layout. e.g., "s" key on QWERTY keyboard produces "o" in DVORAK layout.

Unlike key symbol, keycode is only determined by the location of the key, and irrelevant of the keyboard layout.

Briefly speaking, input methods that expect certain keyboard layout should use keycode; otherwise keyval is sufficient. For example, Chewing, Cangjie, Wubi expect an en-US QWERTY keyboard, these should use keycode; while pinyin can rely on keyval only, as it is less sensitive to the keyboard layout change, DVORAK users can still use DVORAK layout to input pinyin.

Use keymapLookupKeysym to convert keycode to keysym in given keyboard layout.

see_also: processKeyEvent

processKeyEventAsyncFinish

inputContextProcessKeyEventAsyncFinish Source #

Arguments

:: (HasCallStack, MonadIO m, IsInputContext a, IsAsyncResult b) 
=> a

context: An InputContext.

-> b

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

-> m ()

(Can throw GError)

Finishes an operation started with inputContextProcessKeyEventAsync.

propertyActivate

inputContextPropertyActivate Source #

Arguments

:: (HasCallStack, MonadIO m, IsInputContext a) 
=> a

context: An InputContext.

-> Text

propName: A property name (e.g. "InputMode.WideLatin")

-> Word32

state: A status of the property (e.g. PROP_STATE_CHECKED)

-> m () 

Activate the property asynchronously.

See also: Engine::property_activate

reset

inputContextReset Source #

Arguments

:: (HasCallStack, MonadIO m, IsInputContext a) 
=> a

context: An InputContext.

-> m () 

Invoked when the IME is reset. An asynchronous IPC will be performed.

see_also: reset

setCapabilities

inputContextSetCapabilities Source #

Arguments

:: (HasCallStack, MonadIO m, IsInputContext a) 
=> a

context: An IBusInputContext.

-> Word32

capabilities: Capabilities flags of IBusEngine, see Capabilite

-> m () 

Set the capabilities flags of client application asynchronously. When IBUS_CAP_FOCUS is not set, IBUS_CAP_PREEDIT_TEXT, IBUS_CAP_AUXILIARY_TEXT, IBUS_CAP_LOOKUP_TABLE, and IBUS_CAP_PROPERTY have to be all set. The panel component does nothing for an application that doesn't support focus.

see_also: setCapabilities

setClientCommitPreedit

inputContextSetClientCommitPreedit Source #

Arguments

:: (HasCallStack, MonadIO m, IsInputContext a) 
=> a

context: An InputContext.

-> Bool

clientCommit: True if your input context commits pre-edit texts with Space or Enter key events or mouse click events. False if ibus-daemon commits pre-edit texts with those events. The default is False. The behavior is decided with engineUpdatePreeditTextWithMode to commit, clear or keep the pre-edit text and this API is important in ibus-hangul.

-> m () 

Set whether InputContext commits pre-edit texts or not. If True, 'update-preedit-text-with-mode' signal is emitted instead of 'update-preedit-text' signal. If your client receives the 'update-preedit-text-with-mode' signal, the client needs to implement commit_text() of pre-edit text when GtkIMContextClass.focus_out() is called in case an IME desires that behavior but it depends on each IME.

See also engineUpdatePreeditTextWithMode.

setContentType

inputContextSetContentType Source #

Arguments

:: (HasCallStack, MonadIO m, IsInputContext a) 
=> a

context: An InputContext.

-> Word32

purpose: Primary purpose of the input context, as an InputPurpose.

-> Word32

hints: Hints that augment purpose, as an InputHints.

-> m () 

Set content-type (primary purpose and hints) of the context. This information is particularly useful to implement intelligent behavior in engines, such as automatic input-mode switch and text prediction. For example, to restrict input to numbers, the client can call this function with purpose set to IBUS_INPUT_PURPOSE_NUMBER.

See also: setContentType

setCursorLocation

inputContextSetCursorLocation Source #

Arguments

:: (HasCallStack, MonadIO m, IsInputContext a) 
=> a

context: An IBusInputContext.

-> Int32

x: X coordinate of the cursor.

-> Int32

y: Y coordinate of the cursor.

-> Int32

w: Width of the cursor.

-> Int32

h: Height of the cursor.

-> m () 

Set the cursor location of IBus input context asynchronously.

see_also: setCursorLocation

setCursorLocationRelative

inputContextSetCursorLocationRelative Source #

Arguments

:: (HasCallStack, MonadIO m, IsInputContext a) 
=> a

context: An IBusInputContext.

-> Int32

x: X coordinate of the cursor.

-> Int32

y: Y coordinate of the cursor.

-> Int32

w: Width of the cursor.

-> Int32

h: Height of the cursor.

-> m () 

Set the relative cursor location of IBus input context asynchronously.

setEngine

inputContextSetEngine Source #

Arguments

:: (HasCallStack, MonadIO m, IsInputContext a) 
=> a

context: An InputContext.

-> Text

name: A name of the engine.

-> m () 

Invoked when the IME engine is changed. An asynchronous IPC will be performed.

setSurroundingText

inputContextSetSurroundingText Source #

Arguments

:: (HasCallStack, MonadIO m, IsInputContext a, IsText b) 
=> a

context: An InputContext.

-> b

text: An Text surrounding the current cursor on the application.

-> Word32

cursorPos: Current cursor position in characters in text.

-> Word32

anchorPos: Anchor position of selection in text.

-> m () 

No description available in the introspection data.

Signals

commitText

type C_InputContextCommitTextCallback = Ptr () -> Ptr Text -> Ptr () -> IO () Source #

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

type InputContextCommitTextCallback Source #

Arguments

 = Text

text: Text to be committed.

-> IO () 

Emitted when the text is going to be committed.

(Note: The text object is floating, and it will be released after the signal. If signal handler wants to keep the object, the handler should use objectRefSink to get the ownership of the object.)

afterInputContextCommitText :: (IsInputContext a, MonadIO m) => a -> InputContextCommitTextCallback -> m SignalHandlerId Source #

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

after inputContext #commitText callback

onInputContextCommitText :: (IsInputContext a, MonadIO m) => a -> InputContextCommitTextCallback -> m SignalHandlerId Source #

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

on inputContext #commitText callback

cursorDownLookupTable

type C_InputContextCursorDownLookupTableCallback = Ptr () -> Ptr () -> IO () Source #

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

type InputContextCursorDownLookupTableCallback = IO () Source #

Emitted to select next candidate of lookup table.

afterInputContextCursorDownLookupTable :: (IsInputContext a, MonadIO m) => a -> InputContextCursorDownLookupTableCallback -> m SignalHandlerId Source #

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

after inputContext #cursorDownLookupTable callback

onInputContextCursorDownLookupTable :: (IsInputContext a, MonadIO m) => a -> InputContextCursorDownLookupTableCallback -> m SignalHandlerId Source #

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

on inputContext #cursorDownLookupTable callback

cursorUpLookupTable

type C_InputContextCursorUpLookupTableCallback = Ptr () -> Ptr () -> IO () Source #

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

type InputContextCursorUpLookupTableCallback = IO () Source #

Emitted to select previous candidate of lookup table.

afterInputContextCursorUpLookupTable :: (IsInputContext a, MonadIO m) => a -> InputContextCursorUpLookupTableCallback -> m SignalHandlerId Source #

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

after inputContext #cursorUpLookupTable callback

onInputContextCursorUpLookupTable :: (IsInputContext a, MonadIO m) => a -> InputContextCursorUpLookupTableCallback -> m SignalHandlerId Source #

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

on inputContext #cursorUpLookupTable callback

deleteSurroundingText

type C_InputContextDeleteSurroundingTextCallback = Ptr () -> Int32 -> Word32 -> Ptr () -> IO () Source #

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

type InputContextDeleteSurroundingTextCallback Source #

Arguments

 = Int32

offset: the character offset from the cursor position of the text to be deleted. A negative value indicates a position before the cursor.

-> Word32

nChars: the number of characters to be deleted.

-> IO () 

Emitted to delete surrounding text event from IME to client of IME.

afterInputContextDeleteSurroundingText :: (IsInputContext a, MonadIO m) => a -> InputContextDeleteSurroundingTextCallback -> m SignalHandlerId Source #

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

after inputContext #deleteSurroundingText callback

onInputContextDeleteSurroundingText :: (IsInputContext a, MonadIO m) => a -> InputContextDeleteSurroundingTextCallback -> m SignalHandlerId Source #

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

on inputContext #deleteSurroundingText callback

disabled

type C_InputContextDisabledCallback = Ptr () -> Ptr () -> IO () Source #

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

type InputContextDisabledCallback = IO () Source #

Emitted when an IME is disabled.

afterInputContextDisabled :: (IsInputContext a, MonadIO m) => a -> InputContextDisabledCallback -> m SignalHandlerId Source #

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

after inputContext #disabled callback

onInputContextDisabled :: (IsInputContext a, MonadIO m) => a -> InputContextDisabledCallback -> m SignalHandlerId Source #

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

on inputContext #disabled callback

enabled

type C_InputContextEnabledCallback = Ptr () -> Ptr () -> IO () Source #

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

type InputContextEnabledCallback = IO () Source #

Emitted when an IME is enabled.

afterInputContextEnabled :: (IsInputContext a, MonadIO m) => a -> InputContextEnabledCallback -> m SignalHandlerId Source #

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

after inputContext #enabled callback

onInputContextEnabled :: (IsInputContext a, MonadIO m) => a -> InputContextEnabledCallback -> m SignalHandlerId Source #

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

on inputContext #enabled callback

forwardKeyEvent

type C_InputContextForwardKeyEventCallback = Ptr () -> Word32 -> Word32 -> Word32 -> Ptr () -> IO () Source #

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

type InputContextForwardKeyEventCallback Source #

Arguments

 = Word32

keyval: Key symbol of the keyboard event.

-> Word32

keycode: Key symbol of the keyboard event.

-> Word32

modifiers: Key modifier flags.

-> IO () 

Emitted to forward key event from IME to client of IME.

afterInputContextForwardKeyEvent :: (IsInputContext a, MonadIO m) => a -> InputContextForwardKeyEventCallback -> m SignalHandlerId Source #

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

after inputContext #forwardKeyEvent callback

onInputContextForwardKeyEvent :: (IsInputContext a, MonadIO m) => a -> InputContextForwardKeyEventCallback -> m SignalHandlerId Source #

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

on inputContext #forwardKeyEvent callback

hideAuxiliaryText

type C_InputContextHideAuxiliaryTextCallback = Ptr () -> Ptr () -> IO () Source #

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

type InputContextHideAuxiliaryTextCallback = IO () Source #

Emitted to hide auxiliary text.

afterInputContextHideAuxiliaryText :: (IsInputContext a, MonadIO m) => a -> InputContextHideAuxiliaryTextCallback -> m SignalHandlerId Source #

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

after inputContext #hideAuxiliaryText callback

onInputContextHideAuxiliaryText :: (IsInputContext a, MonadIO m) => a -> InputContextHideAuxiliaryTextCallback -> m SignalHandlerId Source #

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

on inputContext #hideAuxiliaryText callback

hideLookupTable

type C_InputContextHideLookupTableCallback = Ptr () -> Ptr () -> IO () Source #

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

type InputContextHideLookupTableCallback = IO () Source #

Emitted to hide lookup table.

afterInputContextHideLookupTable :: (IsInputContext a, MonadIO m) => a -> InputContextHideLookupTableCallback -> m SignalHandlerId Source #

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

after inputContext #hideLookupTable callback

onInputContextHideLookupTable :: (IsInputContext a, MonadIO m) => a -> InputContextHideLookupTableCallback -> m SignalHandlerId Source #

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

on inputContext #hideLookupTable callback

hidePreeditText

type C_InputContextHidePreeditTextCallback = Ptr () -> Ptr () -> IO () Source #

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

type InputContextHidePreeditTextCallback = IO () Source #

Emitted to hide preedit text.

afterInputContextHidePreeditText :: (IsInputContext a, MonadIO m) => a -> InputContextHidePreeditTextCallback -> m SignalHandlerId Source #

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

after inputContext #hidePreeditText callback

onInputContextHidePreeditText :: (IsInputContext a, MonadIO m) => a -> InputContextHidePreeditTextCallback -> m SignalHandlerId Source #

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

on inputContext #hidePreeditText callback

pageDownLookupTable

type C_InputContextPageDownLookupTableCallback = Ptr () -> Ptr () -> IO () Source #

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

type InputContextPageDownLookupTableCallback = IO () Source #

Emitted to view the next page of lookup table.

afterInputContextPageDownLookupTable :: (IsInputContext a, MonadIO m) => a -> InputContextPageDownLookupTableCallback -> m SignalHandlerId Source #

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

after inputContext #pageDownLookupTable callback

onInputContextPageDownLookupTable :: (IsInputContext a, MonadIO m) => a -> InputContextPageDownLookupTableCallback -> m SignalHandlerId Source #

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

on inputContext #pageDownLookupTable callback

pageUpLookupTable

type C_InputContextPageUpLookupTableCallback = Ptr () -> Ptr () -> IO () Source #

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

type InputContextPageUpLookupTableCallback = IO () Source #

Emitted to view the previous page of lookup table.

afterInputContextPageUpLookupTable :: (IsInputContext a, MonadIO m) => a -> InputContextPageUpLookupTableCallback -> m SignalHandlerId Source #

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

after inputContext #pageUpLookupTable callback

onInputContextPageUpLookupTable :: (IsInputContext a, MonadIO m) => a -> InputContextPageUpLookupTableCallback -> m SignalHandlerId Source #

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

on inputContext #pageUpLookupTable callback

registerProperties

type C_InputContextRegisterPropertiesCallback = Ptr () -> Ptr PropList -> Ptr () -> IO () Source #

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

type InputContextRegisterPropertiesCallback Source #

Arguments

 = PropList

props: An IBusPropList that contains properties.

-> IO () 

Emitted to register the properties in props.

(Note: The props object is floating, and it will be released after the signal. If signal handler wants to keep the object, the handler should use objectRefSink to get the ownership of the object.)

afterInputContextRegisterProperties :: (IsInputContext a, MonadIO m) => a -> InputContextRegisterPropertiesCallback -> m SignalHandlerId Source #

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

after inputContext #registerProperties callback

onInputContextRegisterProperties :: (IsInputContext a, MonadIO m) => a -> InputContextRegisterPropertiesCallback -> m SignalHandlerId Source #

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

on inputContext #registerProperties callback

showAuxiliaryText

type C_InputContextShowAuxiliaryTextCallback = Ptr () -> Ptr () -> IO () Source #

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

type InputContextShowAuxiliaryTextCallback = IO () Source #

Emitted to show auxiliary text.

afterInputContextShowAuxiliaryText :: (IsInputContext a, MonadIO m) => a -> InputContextShowAuxiliaryTextCallback -> m SignalHandlerId Source #

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

after inputContext #showAuxiliaryText callback

onInputContextShowAuxiliaryText :: (IsInputContext a, MonadIO m) => a -> InputContextShowAuxiliaryTextCallback -> m SignalHandlerId Source #

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

on inputContext #showAuxiliaryText callback

showLookupTable

type C_InputContextShowLookupTableCallback = Ptr () -> Ptr () -> IO () Source #

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

type InputContextShowLookupTableCallback = IO () Source #

Emitted to show lookup table.

afterInputContextShowLookupTable :: (IsInputContext a, MonadIO m) => a -> InputContextShowLookupTableCallback -> m SignalHandlerId Source #

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

after inputContext #showLookupTable callback

onInputContextShowLookupTable :: (IsInputContext a, MonadIO m) => a -> InputContextShowLookupTableCallback -> m SignalHandlerId Source #

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

on inputContext #showLookupTable callback

showPreeditText

type C_InputContextShowPreeditTextCallback = Ptr () -> Ptr () -> IO () Source #

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

type InputContextShowPreeditTextCallback = IO () Source #

Emitted to show preedit text.

afterInputContextShowPreeditText :: (IsInputContext a, MonadIO m) => a -> InputContextShowPreeditTextCallback -> m SignalHandlerId Source #

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

after inputContext #showPreeditText callback

onInputContextShowPreeditText :: (IsInputContext a, MonadIO m) => a -> InputContextShowPreeditTextCallback -> m SignalHandlerId Source #

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

on inputContext #showPreeditText callback

updateAuxiliaryText

type C_InputContextUpdateAuxiliaryTextCallback = Ptr () -> Ptr Text -> CInt -> Ptr () -> IO () Source #

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

type InputContextUpdateAuxiliaryTextCallback Source #

Arguments

 = Text

text: An auxiliary text

-> Bool

visible: The visibility of text

-> IO () 

Emitted to hide auxilary text.

(Note: The text object is floating, and it will be released after the signal. If signal handler wants to keep the object, the handler should use objectRefSink to get the ownership of the object.)

afterInputContextUpdateAuxiliaryText :: (IsInputContext a, MonadIO m) => a -> InputContextUpdateAuxiliaryTextCallback -> m SignalHandlerId Source #

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

after inputContext #updateAuxiliaryText callback

onInputContextUpdateAuxiliaryText :: (IsInputContext a, MonadIO m) => a -> InputContextUpdateAuxiliaryTextCallback -> m SignalHandlerId Source #

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

on inputContext #updateAuxiliaryText callback

updateLookupTable

type C_InputContextUpdateLookupTableCallback = Ptr () -> Ptr LookupTable -> CInt -> Ptr () -> IO () Source #

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

type InputContextUpdateLookupTableCallback Source #

Arguments

 = LookupTable

table: An IBusLookupTable to be updated.

-> Bool

visible: Whether the table should be visible.

-> IO () 

Emitted to update lookup table.

(Note: The table object is floating, and it will be released after the signal. If signal handler wants to keep the object, the handler should use objectRefSink to get the ownership of the object.)

afterInputContextUpdateLookupTable :: (IsInputContext a, MonadIO m) => a -> InputContextUpdateLookupTableCallback -> m SignalHandlerId Source #

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

after inputContext #updateLookupTable callback

onInputContextUpdateLookupTable :: (IsInputContext a, MonadIO m) => a -> InputContextUpdateLookupTableCallback -> m SignalHandlerId Source #

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

on inputContext #updateLookupTable callback

updatePreeditText

type C_InputContextUpdatePreeditTextCallback = Ptr () -> Ptr Text -> Word32 -> CInt -> Ptr () -> IO () Source #

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

type InputContextUpdatePreeditTextCallback Source #

Arguments

 = Text

text: Text to be updated.

-> Word32

cursorPos: Cursor position.

-> Bool

visible: Whether the update is visible.

-> IO () 

Emitted to update preedit text.

(Note: The text object is floating, and it will be released after the signal. If signal handler wants to keep the object, the handler should use objectRefSink to get the ownership of the object.)

afterInputContextUpdatePreeditText :: (IsInputContext a, MonadIO m) => a -> InputContextUpdatePreeditTextCallback -> m SignalHandlerId Source #

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

after inputContext #updatePreeditText callback

onInputContextUpdatePreeditText :: (IsInputContext a, MonadIO m) => a -> InputContextUpdatePreeditTextCallback -> m SignalHandlerId Source #

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

on inputContext #updatePreeditText callback

updatePreeditTextWithMode

type C_InputContextUpdatePreeditTextWithModeCallback = Ptr () -> Ptr Text -> Word32 -> CInt -> Word32 -> Ptr () -> IO () Source #

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

type InputContextUpdatePreeditTextWithModeCallback Source #

Arguments

 = Text

text: Text to be updated.

-> Word32

cursorPos: Cursor position.

-> Bool

visible: Whether the update is visible.

-> Word32

mode: Preedit mode.

-> IO () 

Emitted to update preedit text with the mode.

(Note: The text object is floating, and it will be released after the signal. If signal handler wants to keep the object, the handler should use objectRefSink to get the ownership of the object.)

afterInputContextUpdatePreeditTextWithMode :: (IsInputContext a, MonadIO m) => a -> InputContextUpdatePreeditTextWithModeCallback -> m SignalHandlerId Source #

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

after inputContext #updatePreeditTextWithMode callback

onInputContextUpdatePreeditTextWithMode :: (IsInputContext a, MonadIO m) => a -> InputContextUpdatePreeditTextWithModeCallback -> m SignalHandlerId Source #

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

on inputContext #updatePreeditTextWithMode callback

updateProperty

type C_InputContextUpdatePropertyCallback = Ptr () -> Ptr Property -> Ptr () -> IO () Source #

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

type InputContextUpdatePropertyCallback Source #

Arguments

 = Property

prop: The IBusProperty to be updated.

-> IO () 

Emitted to update the property prop.

(Note: The prop object is floating, and it will be released after the signal. If signal handler wants to keep the object, the handler should use objectRefSink to get the ownership of the object.)

afterInputContextUpdateProperty :: (IsInputContext a, MonadIO m) => a -> InputContextUpdatePropertyCallback -> m SignalHandlerId Source #

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

after inputContext #updateProperty callback

onInputContextUpdateProperty :: (IsInputContext a, MonadIO m) => a -> InputContextUpdatePropertyCallback -> m SignalHandlerId Source #

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

on inputContext #updateProperty callback