Copyright | Will Thompson and Iñaki García Etxebarria |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
- Exported types
- Methods
- cancelHandWriting
- focusIn
- focusOut
- getEngine
- getEngineAsync
- getEngineAsyncFinish
- getInputContext
- getInputContextAsync
- getInputContextAsyncFinish
- needsSurroundingText
- new
- newAsync
- newAsyncFinish
- processHandWritingEvent
- processKeyEvent
- processKeyEventAsync
- processKeyEventAsyncFinish
- propertyActivate
- reset
- setCapabilities
- setClientCommitPreedit
- setContentType
- setCursorLocation
- setCursorLocationRelative
- setEngine
- setSurroundingText
- Signals
- commitText
- cursorDownLookupTable
- cursorUpLookupTable
- deleteSurroundingText
- disabled
- enabled
- forwardKeyEvent
- hideAuxiliaryText
- hideLookupTable
- hidePreeditText
- pageDownLookupTable
- pageUpLookupTable
- registerProperties
- requireSurroundingText
- showAuxiliaryText
- showLookupTable
- showPreeditText
- updateAuxiliaryText
- updateLookupTable
- updatePreeditText
- updatePreeditTextWithMode
- updateProperty
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
- newtype InputContext = InputContext (ManagedPtr InputContext)
- class (GObject o, IsDescendantOf InputContext o) => IsInputContext o
- toInputContext :: (MonadIO m, IsInputContext o) => o -> m InputContext
- inputContextCancelHandWriting :: (HasCallStack, MonadIO m, IsInputContext a) => a -> Word32 -> m ()
- inputContextFocusIn :: (HasCallStack, MonadIO m, IsInputContext a) => a -> m ()
- inputContextFocusOut :: (HasCallStack, MonadIO m, IsInputContext a) => a -> m ()
- inputContextGetEngine :: (HasCallStack, MonadIO m, IsInputContext a) => a -> m EngineDesc
- inputContextGetEngineAsync :: (HasCallStack, MonadIO m, IsInputContext a, IsCancellable b) => a -> Int32 -> Maybe b -> Maybe AsyncReadyCallback -> m ()
- inputContextGetEngineAsyncFinish :: (HasCallStack, MonadIO m, IsInputContext a, IsAsyncResult b) => a -> b -> m EngineDesc
- inputContextGetInputContext :: (HasCallStack, MonadIO m, IsDBusConnection a) => Text -> a -> m InputContext
- inputContextGetInputContextAsync :: (HasCallStack, MonadIO m, IsDBusConnection a, IsCancellable b) => Text -> a -> Maybe b -> Maybe AsyncReadyCallback -> m ()
- inputContextGetInputContextAsyncFinish :: (HasCallStack, MonadIO m, IsAsyncResult a) => a -> m InputContext
- inputContextNeedsSurroundingText :: (HasCallStack, MonadIO m, IsInputContext a) => a -> m Bool
- inputContextNew :: (HasCallStack, MonadIO m, IsDBusConnection a, IsCancellable b) => Text -> a -> Maybe b -> m InputContext
- inputContextNewAsync :: (HasCallStack, MonadIO m, IsDBusConnection a, IsCancellable b) => Text -> a -> Maybe b -> Maybe AsyncReadyCallback -> m ()
- inputContextNewAsyncFinish :: (HasCallStack, MonadIO m, IsAsyncResult a) => a -> m InputContext
- inputContextProcessHandWritingEvent :: (HasCallStack, MonadIO m, IsInputContext a) => a -> Double -> Word32 -> m ()
- inputContextProcessKeyEvent :: (HasCallStack, MonadIO m, IsInputContext a) => a -> Word32 -> Word32 -> Word32 -> m Bool
- inputContextProcessKeyEventAsync :: (HasCallStack, MonadIO m, IsInputContext a, IsCancellable b) => a -> Word32 -> Word32 -> Word32 -> Int32 -> Maybe b -> Maybe AsyncReadyCallback -> m ()
- inputContextProcessKeyEventAsyncFinish :: (HasCallStack, MonadIO m, IsInputContext a, IsAsyncResult b) => a -> b -> m ()
- inputContextPropertyActivate :: (HasCallStack, MonadIO m, IsInputContext a) => a -> Text -> Word32 -> m ()
- inputContextReset :: (HasCallStack, MonadIO m, IsInputContext a) => a -> m ()
- inputContextSetCapabilities :: (HasCallStack, MonadIO m, IsInputContext a) => a -> Word32 -> m ()
- inputContextSetClientCommitPreedit :: (HasCallStack, MonadIO m, IsInputContext a) => a -> Bool -> m ()
- inputContextSetContentType :: (HasCallStack, MonadIO m, IsInputContext a) => a -> Word32 -> Word32 -> m ()
- inputContextSetCursorLocation :: (HasCallStack, MonadIO m, IsInputContext a) => a -> Int32 -> Int32 -> Int32 -> Int32 -> m ()
- inputContextSetCursorLocationRelative :: (HasCallStack, MonadIO m, IsInputContext a) => a -> Int32 -> Int32 -> Int32 -> Int32 -> m ()
- inputContextSetEngine :: (HasCallStack, MonadIO m, IsInputContext a) => a -> Text -> m ()
- inputContextSetSurroundingText :: (HasCallStack, MonadIO m, IsInputContext a, IsText b) => a -> b -> Word32 -> Word32 -> m ()
- type InputContextCommitTextCallback = Text -> IO ()
- afterInputContextCommitText :: (IsInputContext a, MonadIO m) => a -> ((?self :: a) => InputContextCommitTextCallback) -> m SignalHandlerId
- onInputContextCommitText :: (IsInputContext a, MonadIO m) => a -> ((?self :: a) => InputContextCommitTextCallback) -> m SignalHandlerId
- type InputContextCursorDownLookupTableCallback = IO ()
- afterInputContextCursorDownLookupTable :: (IsInputContext a, MonadIO m) => a -> ((?self :: a) => InputContextCursorDownLookupTableCallback) -> m SignalHandlerId
- onInputContextCursorDownLookupTable :: (IsInputContext a, MonadIO m) => a -> ((?self :: a) => InputContextCursorDownLookupTableCallback) -> m SignalHandlerId
- type InputContextCursorUpLookupTableCallback = IO ()
- afterInputContextCursorUpLookupTable :: (IsInputContext a, MonadIO m) => a -> ((?self :: a) => InputContextCursorUpLookupTableCallback) -> m SignalHandlerId
- onInputContextCursorUpLookupTable :: (IsInputContext a, MonadIO m) => a -> ((?self :: a) => InputContextCursorUpLookupTableCallback) -> m SignalHandlerId
- type InputContextDeleteSurroundingTextCallback = Int32 -> Word32 -> IO ()
- afterInputContextDeleteSurroundingText :: (IsInputContext a, MonadIO m) => a -> ((?self :: a) => InputContextDeleteSurroundingTextCallback) -> m SignalHandlerId
- onInputContextDeleteSurroundingText :: (IsInputContext a, MonadIO m) => a -> ((?self :: a) => InputContextDeleteSurroundingTextCallback) -> m SignalHandlerId
- type InputContextDisabledCallback = IO ()
- afterInputContextDisabled :: (IsInputContext a, MonadIO m) => a -> ((?self :: a) => InputContextDisabledCallback) -> m SignalHandlerId
- onInputContextDisabled :: (IsInputContext a, MonadIO m) => a -> ((?self :: a) => InputContextDisabledCallback) -> m SignalHandlerId
- type InputContextEnabledCallback = IO ()
- afterInputContextEnabled :: (IsInputContext a, MonadIO m) => a -> ((?self :: a) => InputContextEnabledCallback) -> m SignalHandlerId
- onInputContextEnabled :: (IsInputContext a, MonadIO m) => a -> ((?self :: a) => InputContextEnabledCallback) -> m SignalHandlerId
- type InputContextForwardKeyEventCallback = Word32 -> Word32 -> Word32 -> IO ()
- afterInputContextForwardKeyEvent :: (IsInputContext a, MonadIO m) => a -> ((?self :: a) => InputContextForwardKeyEventCallback) -> m SignalHandlerId
- onInputContextForwardKeyEvent :: (IsInputContext a, MonadIO m) => a -> ((?self :: a) => InputContextForwardKeyEventCallback) -> m SignalHandlerId
- type InputContextHideAuxiliaryTextCallback = IO ()
- afterInputContextHideAuxiliaryText :: (IsInputContext a, MonadIO m) => a -> ((?self :: a) => InputContextHideAuxiliaryTextCallback) -> m SignalHandlerId
- onInputContextHideAuxiliaryText :: (IsInputContext a, MonadIO m) => a -> ((?self :: a) => InputContextHideAuxiliaryTextCallback) -> m SignalHandlerId
- type InputContextHideLookupTableCallback = IO ()
- afterInputContextHideLookupTable :: (IsInputContext a, MonadIO m) => a -> ((?self :: a) => InputContextHideLookupTableCallback) -> m SignalHandlerId
- onInputContextHideLookupTable :: (IsInputContext a, MonadIO m) => a -> ((?self :: a) => InputContextHideLookupTableCallback) -> m SignalHandlerId
- type InputContextHidePreeditTextCallback = IO ()
- afterInputContextHidePreeditText :: (IsInputContext a, MonadIO m) => a -> ((?self :: a) => InputContextHidePreeditTextCallback) -> m SignalHandlerId
- onInputContextHidePreeditText :: (IsInputContext a, MonadIO m) => a -> ((?self :: a) => InputContextHidePreeditTextCallback) -> m SignalHandlerId
- type InputContextPageDownLookupTableCallback = IO ()
- afterInputContextPageDownLookupTable :: (IsInputContext a, MonadIO m) => a -> ((?self :: a) => InputContextPageDownLookupTableCallback) -> m SignalHandlerId
- onInputContextPageDownLookupTable :: (IsInputContext a, MonadIO m) => a -> ((?self :: a) => InputContextPageDownLookupTableCallback) -> m SignalHandlerId
- type InputContextPageUpLookupTableCallback = IO ()
- afterInputContextPageUpLookupTable :: (IsInputContext a, MonadIO m) => a -> ((?self :: a) => InputContextPageUpLookupTableCallback) -> m SignalHandlerId
- onInputContextPageUpLookupTable :: (IsInputContext a, MonadIO m) => a -> ((?self :: a) => InputContextPageUpLookupTableCallback) -> m SignalHandlerId
- type InputContextRegisterPropertiesCallback = PropList -> IO ()
- afterInputContextRegisterProperties :: (IsInputContext a, MonadIO m) => a -> ((?self :: a) => InputContextRegisterPropertiesCallback) -> m SignalHandlerId
- onInputContextRegisterProperties :: (IsInputContext a, MonadIO m) => a -> ((?self :: a) => InputContextRegisterPropertiesCallback) -> m SignalHandlerId
- type InputContextRequireSurroundingTextCallback = IO ()
- afterInputContextRequireSurroundingText :: (IsInputContext a, MonadIO m) => a -> ((?self :: a) => InputContextRequireSurroundingTextCallback) -> m SignalHandlerId
- onInputContextRequireSurroundingText :: (IsInputContext a, MonadIO m) => a -> ((?self :: a) => InputContextRequireSurroundingTextCallback) -> m SignalHandlerId
- type InputContextShowAuxiliaryTextCallback = IO ()
- afterInputContextShowAuxiliaryText :: (IsInputContext a, MonadIO m) => a -> ((?self :: a) => InputContextShowAuxiliaryTextCallback) -> m SignalHandlerId
- onInputContextShowAuxiliaryText :: (IsInputContext a, MonadIO m) => a -> ((?self :: a) => InputContextShowAuxiliaryTextCallback) -> m SignalHandlerId
- type InputContextShowLookupTableCallback = IO ()
- afterInputContextShowLookupTable :: (IsInputContext a, MonadIO m) => a -> ((?self :: a) => InputContextShowLookupTableCallback) -> m SignalHandlerId
- onInputContextShowLookupTable :: (IsInputContext a, MonadIO m) => a -> ((?self :: a) => InputContextShowLookupTableCallback) -> m SignalHandlerId
- type InputContextShowPreeditTextCallback = IO ()
- afterInputContextShowPreeditText :: (IsInputContext a, MonadIO m) => a -> ((?self :: a) => InputContextShowPreeditTextCallback) -> m SignalHandlerId
- onInputContextShowPreeditText :: (IsInputContext a, MonadIO m) => a -> ((?self :: a) => InputContextShowPreeditTextCallback) -> m SignalHandlerId
- type InputContextUpdateAuxiliaryTextCallback = Text -> Bool -> IO ()
- afterInputContextUpdateAuxiliaryText :: (IsInputContext a, MonadIO m) => a -> ((?self :: a) => InputContextUpdateAuxiliaryTextCallback) -> m SignalHandlerId
- onInputContextUpdateAuxiliaryText :: (IsInputContext a, MonadIO m) => a -> ((?self :: a) => InputContextUpdateAuxiliaryTextCallback) -> m SignalHandlerId
- type InputContextUpdateLookupTableCallback = LookupTable -> Bool -> IO ()
- afterInputContextUpdateLookupTable :: (IsInputContext a, MonadIO m) => a -> ((?self :: a) => InputContextUpdateLookupTableCallback) -> m SignalHandlerId
- onInputContextUpdateLookupTable :: (IsInputContext a, MonadIO m) => a -> ((?self :: a) => InputContextUpdateLookupTableCallback) -> m SignalHandlerId
- type InputContextUpdatePreeditTextCallback = Text -> Word32 -> Bool -> IO ()
- afterInputContextUpdatePreeditText :: (IsInputContext a, MonadIO m) => a -> ((?self :: a) => InputContextUpdatePreeditTextCallback) -> m SignalHandlerId
- onInputContextUpdatePreeditText :: (IsInputContext a, MonadIO m) => a -> ((?self :: a) => InputContextUpdatePreeditTextCallback) -> m SignalHandlerId
- type InputContextUpdatePreeditTextWithModeCallback = Text -> Word32 -> Bool -> Word32 -> IO ()
- afterInputContextUpdatePreeditTextWithMode :: (IsInputContext a, MonadIO m) => a -> ((?self :: a) => InputContextUpdatePreeditTextWithModeCallback) -> m SignalHandlerId
- onInputContextUpdatePreeditTextWithMode :: (IsInputContext a, MonadIO m) => a -> ((?self :: a) => InputContextUpdatePreeditTextWithModeCallback) -> m SignalHandlerId
- type InputContextUpdatePropertyCallback = Property -> IO ()
- afterInputContextUpdateProperty :: (IsInputContext a, MonadIO m) => a -> ((?self :: a) => InputContextUpdatePropertyCallback) -> m SignalHandlerId
- onInputContextUpdateProperty :: (IsInputContext a, MonadIO m) => a -> ((?self :: a) => InputContextUpdatePropertyCallback) -> m SignalHandlerId
Exported types
newtype InputContext Source #
Memory-managed wrapper type.
InputContext (ManagedPtr InputContext) |
Instances
Eq InputContext Source # | |
Defined in GI.IBus.Objects.InputContext (==) :: InputContext -> InputContext -> Bool # (/=) :: InputContext -> InputContext -> Bool # | |
GObject InputContext Source # | |
Defined in GI.IBus.Objects.InputContext | |
ManagedPtrNewtype InputContext Source # | |
Defined in GI.IBus.Objects.InputContext toManagedPtr :: InputContext -> ManagedPtr InputContext | |
TypedObject InputContext Source # | |
Defined in GI.IBus.Objects.InputContext | |
HasParentTypes InputContext Source # | |
Defined in GI.IBus.Objects.InputContext | |
IsGValue (Maybe InputContext) Source # | Convert |
Defined in GI.IBus.Objects.InputContext gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe InputContext -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe InputContext) | |
type ParentTypes InputContext Source # | |
Defined in GI.IBus.Objects.InputContext |
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
(GObject o, IsDescendantOf InputContext o) => IsInputContext o Source # | |
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
Click to display all available methods, including inherited ones
Methods
bindProperty, bindPropertyFull, call, callFinish, callSync, callWithUnixFdList, callWithUnixFdListFinish, callWithUnixFdListSync, cancelHandWriting, destroy, focusIn, focusOut, forceFloating, freezeNotify, getv, init, initAsync, initFinish, isFloating, needsSurroundingText, notify, notifyByPspec, processHandWritingEvent, processKeyEvent, processKeyEventAsync, processKeyEventAsyncFinish, propertyActivate, ref, refSink, reset, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.
Getters
getCachedProperty, getCachedPropertyNames, getConnection, getData, getDefaultTimeout, getEngine, getEngineAsync, getEngineAsyncFinish, getFlags, getInfo, getInterfaceInfo, getInterfaceName, getName, getNameOwner, getObject, getObjectPath, getProperty, getQdata.
Setters
setCachedProperty, setCapabilities, setClientCommitPreedit, setContentType, setCursorLocation, setCursorLocationRelative, setData, setDataFull, setDefaultTimeout, setEngine, setInterfaceInfo, setObject, setProperty, setSurroundingText.
cancelHandWriting
inputContextCancelHandWriting Source #
:: (HasCallStack, MonadIO m, IsInputContext a) | |
=> a |
|
-> Word32 |
|
-> m () |
Clear handwriting stroke(s) in the current input method engine.
see_also: Engine::cancelHandWriting
focusIn
:: (HasCallStack, MonadIO m, IsInputContext a) | |
=> a |
|
-> m () |
Invoked when the client application get focus. An asynchronous IPC will be performed.
see_also: Engine
::focus_in
.
focusOut
:: (HasCallStack, MonadIO m, IsInputContext a) | |
=> a |
|
-> m () |
Invoked when the client application get focus. An asynchronous IPC will be performed.
see_also: Engine
::focus_out
.
getEngine
inputContextGetEngine Source #
:: (HasCallStack, MonadIO m, IsInputContext a) | |
=> a |
|
-> 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 #
:: (HasCallStack, MonadIO m, IsInputContext a, IsCancellable b) | |
=> a |
|
-> Int32 |
|
-> Maybe b |
|
-> Maybe AsyncReadyCallback |
|
-> m () |
An asynchronous IPC will be performed.
getEngineAsyncFinish
inputContextGetEngineAsyncFinish Source #
:: (HasCallStack, MonadIO m, IsInputContext a, IsAsyncResult b) | |
=> a |
|
-> b |
|
-> m EngineDesc | Returns: An IME engine description for the context, or
|
Finishes an operation started with inputContextGetEngineAsync
.
getInputContext
inputContextGetInputContext Source #
:: (HasCallStack, MonadIO m, IsDBusConnection a) | |
=> Text |
|
-> a |
|
-> m InputContext | Returns: An existing |
Gets an existing IBusInputContext.
getInputContextAsync
inputContextGetInputContextAsync Source #
:: (HasCallStack, MonadIO m, IsDBusConnection a, IsCancellable b) | |
=> Text |
|
-> a |
|
-> Maybe b |
|
-> Maybe AsyncReadyCallback |
|
-> m () |
Gets an existing InputContext
asynchronously.
getInputContextAsyncFinish
inputContextGetInputContextAsyncFinish Source #
:: (HasCallStack, MonadIO m, IsAsyncResult a) | |
=> a |
|
-> m InputContext | Returns: An existing |
Finishes an operation started with
inputContextGetInputContextAsync
.
needsSurroundingText
inputContextNeedsSurroundingText Source #
:: (HasCallStack, MonadIO m, IsInputContext a) | |
=> a |
|
-> m Bool | Returns: |
Check whether the current engine requires surrounding-text.
new
:: (HasCallStack, MonadIO m, IsDBusConnection a, IsCancellable b) | |
=> Text |
|
-> a |
|
-> Maybe b |
|
-> m InputContext | Returns: A newly allocated |
Creates a new InputContext
.
newAsync
:: (HasCallStack, MonadIO m, IsDBusConnection a, IsCancellable b) | |
=> Text |
|
-> a |
|
-> Maybe b |
|
-> Maybe AsyncReadyCallback |
|
-> m () |
Creates a new InputContext
asynchronously.
newAsyncFinish
inputContextNewAsyncFinish Source #
:: (HasCallStack, MonadIO m, IsAsyncResult a) | |
=> a |
|
-> m InputContext | Returns: A newly allocated |
Finishes an operation started with inputContextNewAsync
.
processHandWritingEvent
inputContextProcessHandWritingEvent Source #
:: (HasCallStack, MonadIO m, IsInputContext a) | |
=> a |
|
-> Double |
|
-> Word32 |
|
-> 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: Engine::processHandWritingEvent
processKeyEvent
inputContextProcessKeyEvent Source #
:: (HasCallStack, MonadIO m, IsInputContext a) | |
=> a |
|
-> Word32 |
|
-> Word32 |
|
-> Word32 |
|
-> m Bool | Returns: See also: |
Pass the key event to input method engine and wait for the reply from ibus (i.e. synchronous IPC).
processKeyEventAsync
inputContextProcessKeyEventAsync Source #
:: (HasCallStack, MonadIO m, IsInputContext a, IsCancellable b) | |
=> a |
|
-> Word32 |
|
-> Word32 |
|
-> Word32 |
|
-> Int32 |
|
-> Maybe b |
|
-> Maybe AsyncReadyCallback |
|
-> 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: Engine::processKeyEvent
processKeyEventAsyncFinish
inputContextProcessKeyEventAsyncFinish Source #
:: (HasCallStack, MonadIO m, IsInputContext a, IsAsyncResult b) | |
=> a |
|
-> b |
|
-> m () | (Can throw |
Finishes an operation started with
inputContextProcessKeyEventAsync
.
propertyActivate
inputContextPropertyActivate Source #
:: (HasCallStack, MonadIO m, IsInputContext a) | |
=> a |
|
-> Text |
|
-> Word32 |
|
-> m () |
Activate the property asynchronously.
See also: Engine
::property_activate
reset
:: (HasCallStack, MonadIO m, IsInputContext a) | |
=> a |
|
-> m () |
Invoked when the IME is reset. An asynchronous IPC will be performed.
see_also: Engine::reset
setCapabilities
inputContextSetCapabilities Source #
:: (HasCallStack, MonadIO m, IsInputContext a) | |
=> a |
|
-> Word32 |
|
-> 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: Engine::setCapabilities
setClientCommitPreedit
inputContextSetClientCommitPreedit Source #
:: (HasCallStack, MonadIO m, IsInputContext a) | |
=> a |
|
-> Bool |
|
-> 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 #
:: (HasCallStack, MonadIO m, IsInputContext a) | |
=> a |
|
-> Word32 |
|
-> Word32 |
|
-> 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: Engine::setContentType
setCursorLocation
inputContextSetCursorLocation Source #
:: (HasCallStack, MonadIO m, IsInputContext a) | |
=> a |
|
-> Int32 |
|
-> Int32 |
|
-> Int32 |
|
-> Int32 |
|
-> m () |
Set the cursor location of IBus input context asynchronously.
see_also: Engine::setCursorLocation
setCursorLocationRelative
inputContextSetCursorLocationRelative Source #
:: (HasCallStack, MonadIO m, IsInputContext a) | |
=> a |
|
-> Int32 |
|
-> Int32 |
|
-> Int32 |
|
-> Int32 |
|
-> m () |
Set the relative cursor location of IBus input context asynchronously.
setEngine
inputContextSetEngine Source #
:: (HasCallStack, MonadIO m, IsInputContext a) | |
=> a |
|
-> Text |
|
-> m () |
Invoked when the IME engine is changed. An asynchronous IPC will be performed.
setSurroundingText
inputContextSetSurroundingText Source #
:: (HasCallStack, MonadIO m, IsInputContext a, IsText b) | |
=> a |
|
-> b |
|
-> Word32 |
|
-> Word32 |
|
-> m () |
No description available in the introspection data.
Signals
commitText
type InputContextCommitTextCallback Source #
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 -> ((?self :: 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
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.
onInputContextCommitText :: (IsInputContext a, MonadIO m) => a -> ((?self :: 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 InputContextCursorDownLookupTableCallback = IO () Source #
Emitted to select next candidate of lookup table.
afterInputContextCursorDownLookupTable :: (IsInputContext a, MonadIO m) => a -> ((?self :: 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
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.
onInputContextCursorDownLookupTable :: (IsInputContext a, MonadIO m) => a -> ((?self :: 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 InputContextCursorUpLookupTableCallback = IO () Source #
Emitted to select previous candidate of lookup table.
afterInputContextCursorUpLookupTable :: (IsInputContext a, MonadIO m) => a -> ((?self :: 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
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.
onInputContextCursorUpLookupTable :: (IsInputContext a, MonadIO m) => a -> ((?self :: 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 InputContextDeleteSurroundingTextCallback Source #
= Int32 |
|
-> Word32 |
|
-> IO () |
Emitted to delete surrounding text event from IME to client of IME.
afterInputContextDeleteSurroundingText :: (IsInputContext a, MonadIO m) => a -> ((?self :: 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
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.
onInputContextDeleteSurroundingText :: (IsInputContext a, MonadIO m) => a -> ((?self :: 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 InputContextDisabledCallback = IO () Source #
Emitted when an IME is disabled.
afterInputContextDisabled :: (IsInputContext a, MonadIO m) => a -> ((?self :: 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
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.
onInputContextDisabled :: (IsInputContext a, MonadIO m) => a -> ((?self :: 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 InputContextEnabledCallback = IO () Source #
Emitted when an IME is enabled.
afterInputContextEnabled :: (IsInputContext a, MonadIO m) => a -> ((?self :: 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
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.
onInputContextEnabled :: (IsInputContext a, MonadIO m) => a -> ((?self :: 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 InputContextForwardKeyEventCallback Source #
= Word32 |
|
-> Word32 |
|
-> Word32 |
|
-> IO () |
Emitted to forward key event from IME to client of IME.
afterInputContextForwardKeyEvent :: (IsInputContext a, MonadIO m) => a -> ((?self :: 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
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.
onInputContextForwardKeyEvent :: (IsInputContext a, MonadIO m) => a -> ((?self :: 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 InputContextHideAuxiliaryTextCallback = IO () Source #
Emitted to hide auxiliary text.
afterInputContextHideAuxiliaryText :: (IsInputContext a, MonadIO m) => a -> ((?self :: 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
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.
onInputContextHideAuxiliaryText :: (IsInputContext a, MonadIO m) => a -> ((?self :: 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 InputContextHideLookupTableCallback = IO () Source #
Emitted to hide lookup table.
afterInputContextHideLookupTable :: (IsInputContext a, MonadIO m) => a -> ((?self :: 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
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.
onInputContextHideLookupTable :: (IsInputContext a, MonadIO m) => a -> ((?self :: 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 InputContextHidePreeditTextCallback = IO () Source #
Emitted to hide preedit text.
afterInputContextHidePreeditText :: (IsInputContext a, MonadIO m) => a -> ((?self :: 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
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.
onInputContextHidePreeditText :: (IsInputContext a, MonadIO m) => a -> ((?self :: 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 InputContextPageDownLookupTableCallback = IO () Source #
Emitted to view the next page of lookup table.
afterInputContextPageDownLookupTable :: (IsInputContext a, MonadIO m) => a -> ((?self :: 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
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.
onInputContextPageDownLookupTable :: (IsInputContext a, MonadIO m) => a -> ((?self :: 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 InputContextPageUpLookupTableCallback = IO () Source #
Emitted to view the previous page of lookup table.
afterInputContextPageUpLookupTable :: (IsInputContext a, MonadIO m) => a -> ((?self :: 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
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.
onInputContextPageUpLookupTable :: (IsInputContext a, MonadIO m) => a -> ((?self :: 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 InputContextRegisterPropertiesCallback Source #
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 -> ((?self :: 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
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.
onInputContextRegisterProperties :: (IsInputContext a, MonadIO m) => a -> ((?self :: 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
requireSurroundingText
type InputContextRequireSurroundingTextCallback = IO () Source #
Emitted to receive the RequireSurroundingText signal from the daemon.
afterInputContextRequireSurroundingText :: (IsInputContext a, MonadIO m) => a -> ((?self :: a) => InputContextRequireSurroundingTextCallback) -> m SignalHandlerId Source #
Connect a signal handler for the requireSurroundingText signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
inputContext #requireSurroundingText 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.
onInputContextRequireSurroundingText :: (IsInputContext a, MonadIO m) => a -> ((?self :: a) => InputContextRequireSurroundingTextCallback) -> m SignalHandlerId Source #
Connect a signal handler for the requireSurroundingText signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
inputContext #requireSurroundingText callback
showAuxiliaryText
type InputContextShowAuxiliaryTextCallback = IO () Source #
Emitted to show auxiliary text.
afterInputContextShowAuxiliaryText :: (IsInputContext a, MonadIO m) => a -> ((?self :: 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
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.
onInputContextShowAuxiliaryText :: (IsInputContext a, MonadIO m) => a -> ((?self :: 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 InputContextShowLookupTableCallback = IO () Source #
Emitted to show lookup table.
afterInputContextShowLookupTable :: (IsInputContext a, MonadIO m) => a -> ((?self :: 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
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.
onInputContextShowLookupTable :: (IsInputContext a, MonadIO m) => a -> ((?self :: 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 InputContextShowPreeditTextCallback = IO () Source #
Emitted to show preedit text.
afterInputContextShowPreeditText :: (IsInputContext a, MonadIO m) => a -> ((?self :: 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
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.
onInputContextShowPreeditText :: (IsInputContext a, MonadIO m) => a -> ((?self :: 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 InputContextUpdateAuxiliaryTextCallback Source #
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 -> ((?self :: 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
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.
onInputContextUpdateAuxiliaryText :: (IsInputContext a, MonadIO m) => a -> ((?self :: 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 InputContextUpdateLookupTableCallback Source #
= LookupTable |
|
-> Bool |
|
-> 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 -> ((?self :: 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
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.
onInputContextUpdateLookupTable :: (IsInputContext a, MonadIO m) => a -> ((?self :: 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 InputContextUpdatePreeditTextCallback Source #
= Text |
|
-> Word32 |
|
-> Bool |
|
-> 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 -> ((?self :: 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
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.
onInputContextUpdatePreeditText :: (IsInputContext a, MonadIO m) => a -> ((?self :: 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 InputContextUpdatePreeditTextWithModeCallback Source #
= Text |
|
-> Word32 |
|
-> Bool |
|
-> Word32 |
|
-> 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 -> ((?self :: 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
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.
onInputContextUpdatePreeditTextWithMode :: (IsInputContext a, MonadIO m) => a -> ((?self :: 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 InputContextUpdatePropertyCallback Source #
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 -> ((?self :: 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
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.
onInputContextUpdateProperty :: (IsInputContext a, MonadIO m) => a -> ((?self :: 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