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
- commitText
- deleteSurroundingText
- forwardKeyEvent
- getContentType
- getName
- getSurroundingText
- hideAuxiliaryText
- hideLookupTable
- hidePreeditText
- new
- newWithType
- registerProperties
- showAuxiliaryText
- showLookupTable
- showPreeditText
- updateAuxiliaryText
- updateLookupTable
- updateLookupTableFast
- updatePreeditText
- updatePreeditTextWithMode
- updateProperty
- Properties
- Signals
An IBusEngine provides infrastructure for input method engine. Developers can "extend" this class for input method engine development.
see_also: Component
, EngineDesc
Synopsis
- newtype Engine = Engine (ManagedPtr Engine)
- class (GObject o, IsDescendantOf Engine o) => IsEngine o
- toEngine :: (MonadIO m, IsEngine o) => o -> m Engine
- engineCommitText :: (HasCallStack, MonadIO m, IsEngine a, IsText b) => a -> b -> m ()
- engineDeleteSurroundingText :: (HasCallStack, MonadIO m, IsEngine a) => a -> Int32 -> Word32 -> m ()
- engineForwardKeyEvent :: (HasCallStack, MonadIO m, IsEngine a) => a -> Word32 -> Word32 -> Word32 -> m ()
- engineGetContentType :: (HasCallStack, MonadIO m, IsEngine a) => a -> m (Word32, Word32)
- engineGetName :: (HasCallStack, MonadIO m, IsEngine a) => a -> m Text
- engineGetSurroundingText :: (HasCallStack, MonadIO m, IsEngine a) => a -> m (Text, Word32, Word32)
- engineHideAuxiliaryText :: (HasCallStack, MonadIO m, IsEngine a) => a -> m ()
- engineHideLookupTable :: (HasCallStack, MonadIO m, IsEngine a) => a -> m ()
- engineHidePreeditText :: (HasCallStack, MonadIO m, IsEngine a) => a -> m ()
- engineNew :: (HasCallStack, MonadIO m, IsDBusConnection a) => Text -> Text -> a -> m Engine
- engineNewWithType :: (HasCallStack, MonadIO m, IsDBusConnection a) => GType -> Text -> Text -> a -> m Engine
- engineRegisterProperties :: (HasCallStack, MonadIO m, IsEngine a, IsPropList b) => a -> b -> m ()
- engineShowAuxiliaryText :: (HasCallStack, MonadIO m, IsEngine a) => a -> m ()
- engineShowLookupTable :: (HasCallStack, MonadIO m, IsEngine a) => a -> m ()
- engineShowPreeditText :: (HasCallStack, MonadIO m, IsEngine a) => a -> m ()
- engineUpdateAuxiliaryText :: (HasCallStack, MonadIO m, IsEngine a, IsText b) => a -> b -> Bool -> m ()
- engineUpdateLookupTable :: (HasCallStack, MonadIO m, IsEngine a, IsLookupTable b) => a -> b -> Bool -> m ()
- engineUpdateLookupTableFast :: (HasCallStack, MonadIO m, IsEngine a, IsLookupTable b) => a -> b -> Bool -> m ()
- engineUpdatePreeditText :: (HasCallStack, MonadIO m, IsEngine a, IsText b) => a -> b -> Word32 -> Bool -> m ()
- engineUpdatePreeditTextWithMode :: (HasCallStack, MonadIO m, IsEngine a, IsText b) => a -> b -> Word32 -> Bool -> PreeditFocusMode -> m ()
- engineUpdateProperty :: (HasCallStack, MonadIO m, IsEngine a, IsProperty b) => a -> b -> m ()
- constructEngineActiveSurroundingText :: (IsEngine o, MonadIO m) => Bool -> m (GValueConstruct o)
- getEngineActiveSurroundingText :: (MonadIO m, IsEngine o) => o -> m Bool
- constructEngineEngineName :: (IsEngine o, MonadIO m) => Text -> m (GValueConstruct o)
- getEngineEngineName :: (MonadIO m, IsEngine o) => o -> m (Maybe Text)
- constructEngineHasFocusId :: (IsEngine o, MonadIO m) => Bool -> m (GValueConstruct o)
- getEngineHasFocusId :: (MonadIO m, IsEngine o) => o -> m Bool
- type EngineCancelHandWritingCallback = Word32 -> IO ()
- afterEngineCancelHandWriting :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineCancelHandWritingCallback) -> m SignalHandlerId
- onEngineCancelHandWriting :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineCancelHandWritingCallback) -> m SignalHandlerId
- type EngineCandidateClickedCallback = Word32 -> Word32 -> Word32 -> IO ()
- afterEngineCandidateClicked :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineCandidateClickedCallback) -> m SignalHandlerId
- onEngineCandidateClicked :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineCandidateClickedCallback) -> m SignalHandlerId
- type EngineCursorDownCallback = IO ()
- afterEngineCursorDown :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineCursorDownCallback) -> m SignalHandlerId
- onEngineCursorDown :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineCursorDownCallback) -> m SignalHandlerId
- type EngineCursorUpCallback = IO ()
- afterEngineCursorUp :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineCursorUpCallback) -> m SignalHandlerId
- onEngineCursorUp :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineCursorUpCallback) -> m SignalHandlerId
- type EngineDisableCallback = IO ()
- afterEngineDisable :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineDisableCallback) -> m SignalHandlerId
- onEngineDisable :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineDisableCallback) -> m SignalHandlerId
- type EngineEnableCallback = IO ()
- afterEngineEnable :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineEnableCallback) -> m SignalHandlerId
- onEngineEnable :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineEnableCallback) -> m SignalHandlerId
- type EngineFocusInCallback = IO ()
- afterEngineFocusIn :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineFocusInCallback) -> m SignalHandlerId
- onEngineFocusIn :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineFocusInCallback) -> m SignalHandlerId
- type EngineFocusInIdCallback = Text -> Text -> IO ()
- afterEngineFocusInId :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineFocusInIdCallback) -> m SignalHandlerId
- onEngineFocusInId :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineFocusInIdCallback) -> m SignalHandlerId
- type EngineFocusOutCallback = IO ()
- afterEngineFocusOut :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineFocusOutCallback) -> m SignalHandlerId
- onEngineFocusOut :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineFocusOutCallback) -> m SignalHandlerId
- type EngineFocusOutIdCallback = Text -> IO ()
- afterEngineFocusOutId :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineFocusOutIdCallback) -> m SignalHandlerId
- onEngineFocusOutId :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineFocusOutIdCallback) -> m SignalHandlerId
- type EnginePageDownCallback = IO ()
- afterEnginePageDown :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EnginePageDownCallback) -> m SignalHandlerId
- onEnginePageDown :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EnginePageDownCallback) -> m SignalHandlerId
- type EnginePageUpCallback = IO ()
- afterEnginePageUp :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EnginePageUpCallback) -> m SignalHandlerId
- onEnginePageUp :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EnginePageUpCallback) -> m SignalHandlerId
- type EngineProcessHandWritingEventCallback = Ptr () -> Word32 -> IO ()
- afterEngineProcessHandWritingEvent :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineProcessHandWritingEventCallback) -> m SignalHandlerId
- onEngineProcessHandWritingEvent :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineProcessHandWritingEventCallback) -> m SignalHandlerId
- type EngineProcessKeyEventCallback = Word32 -> Word32 -> Word32 -> IO Bool
- afterEngineProcessKeyEvent :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineProcessKeyEventCallback) -> m SignalHandlerId
- onEngineProcessKeyEvent :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineProcessKeyEventCallback) -> m SignalHandlerId
- type EnginePropertyActivateCallback = Text -> Word32 -> IO ()
- afterEnginePropertyActivate :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EnginePropertyActivateCallback) -> m SignalHandlerId
- onEnginePropertyActivate :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EnginePropertyActivateCallback) -> m SignalHandlerId
- type EnginePropertyHideCallback = Text -> IO ()
- afterEnginePropertyHide :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EnginePropertyHideCallback) -> m SignalHandlerId
- onEnginePropertyHide :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EnginePropertyHideCallback) -> m SignalHandlerId
- type EnginePropertyShowCallback = Text -> IO ()
- afterEnginePropertyShow :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EnginePropertyShowCallback) -> m SignalHandlerId
- onEnginePropertyShow :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EnginePropertyShowCallback) -> m SignalHandlerId
- type EngineResetCallback = IO ()
- afterEngineReset :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineResetCallback) -> m SignalHandlerId
- onEngineReset :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineResetCallback) -> m SignalHandlerId
- type EngineSetCapabilitiesCallback = Word32 -> IO ()
- afterEngineSetCapabilities :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineSetCapabilitiesCallback) -> m SignalHandlerId
- onEngineSetCapabilities :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineSetCapabilitiesCallback) -> m SignalHandlerId
- type EngineSetContentTypeCallback = Word32 -> Word32 -> IO ()
- afterEngineSetContentType :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineSetContentTypeCallback) -> m SignalHandlerId
- onEngineSetContentType :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineSetContentTypeCallback) -> m SignalHandlerId
- type EngineSetCursorLocationCallback = Int32 -> Int32 -> Int32 -> Int32 -> IO ()
- afterEngineSetCursorLocation :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineSetCursorLocationCallback) -> m SignalHandlerId
- onEngineSetCursorLocation :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineSetCursorLocationCallback) -> m SignalHandlerId
- type EngineSetSurroundingTextCallback = Object -> Word32 -> Word32 -> IO ()
- afterEngineSetSurroundingText :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineSetSurroundingTextCallback) -> m SignalHandlerId
- onEngineSetSurroundingText :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineSetSurroundingTextCallback) -> m SignalHandlerId
Exported types
Memory-managed wrapper type.
Instances
Eq Engine Source # | |
GObject Engine Source # | |
Defined in GI.IBus.Objects.Engine | |
ManagedPtrNewtype Engine Source # | |
Defined in GI.IBus.Objects.Engine toManagedPtr :: Engine -> ManagedPtr Engine | |
TypedObject Engine Source # | |
Defined in GI.IBus.Objects.Engine | |
HasParentTypes Engine Source # | |
Defined in GI.IBus.Objects.Engine | |
IsGValue (Maybe Engine) Source # | Convert |
Defined in GI.IBus.Objects.Engine gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe Engine -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe Engine) | |
type ParentTypes Engine Source # | |
Defined in GI.IBus.Objects.Engine |
class (GObject o, IsDescendantOf Engine o) => IsEngine o Source #
Instances
(GObject o, IsDescendantOf Engine o) => IsEngine o Source # | |
Defined in GI.IBus.Objects.Engine |
Methods
Click to display all available methods, including inherited ones
Methods
bindProperty, bindPropertyFull, commitText, deleteSurroundingText, destroy, emitSignal, forceFloating, forwardKeyEvent, freezeNotify, getv, hideAuxiliaryText, hideLookupTable, hidePreeditText, isFloating, notify, notifyByPspec, ref, refSink, register, registerProperties, runDispose, showAuxiliaryText, showLookupTable, showPreeditText, stealData, stealQdata, thawNotify, unref, unregister, updateAuxiliaryText, updateLookupTable, updateLookupTableFast, updatePreeditText, updatePreeditTextWithMode, updateProperty, watchClosure.
Getters
getConnection, getContentType, getData, getName, getObjectPath, getProperty, getQdata, getSurroundingText.
Setters
commitText
:: (HasCallStack, MonadIO m, IsEngine a, IsText b) | |
=> a |
|
-> b |
|
-> m () |
Commit output of input method to IBus client.
(Note: The text object will be released, if it is floating. If caller want to keep the object, caller should make the object sink by g_object_ref_sink.)
deleteSurroundingText
engineDeleteSurroundingText Source #
:: (HasCallStack, MonadIO m, IsEngine a) | |
=> a |
|
-> Int32 |
|
-> Word32 |
|
-> m () |
Delete surrounding text.
forwardKeyEvent
engineForwardKeyEvent Source #
:: (HasCallStack, MonadIO m, IsEngine a) | |
=> a |
|
-> Word32 |
|
-> Word32 |
|
-> Word32 |
|
-> m () |
Forward the key event.
getContentType
Get content-type (primary purpose and hints) of the current input context.
See also: Engine::setContentType
getName
:: (HasCallStack, MonadIO m, IsEngine a) | |
=> a |
|
-> m Text | Returns: Name of |
Return the name of Engine
.
getSurroundingText
engineGetSurroundingText Source #
Get surrounding text.
It is also used to tell the input-context that the engine will
utilize surrounding-text. In that case, it must be called in
Engine::enable handler, with both text
and cursor
set to
Nothing
.
See also: Engine::setSurroundingText
hideAuxiliaryText
engineHideAuxiliaryText Source #
:: (HasCallStack, MonadIO m, IsEngine a) | |
=> a |
|
-> m () |
Hide the auxiliary bar.
hideLookupTable
engineHideLookupTable Source #
:: (HasCallStack, MonadIO m, IsEngine a) | |
=> a |
|
-> m () |
Hide the lookup table.
hidePreeditText
engineHidePreeditText Source #
:: (HasCallStack, MonadIO m, IsEngine a) | |
=> a |
|
-> m () |
Hide the pre-edit buffer.
new
:: (HasCallStack, MonadIO m, IsDBusConnection a) | |
=> Text |
|
-> Text |
|
-> a |
|
-> m Engine | Returns: A newly allocated IBusEngine. |
Create a new Engine
.
newWithType
:: (HasCallStack, MonadIO m, IsDBusConnection a) | |
=> GType |
|
-> Text |
|
-> Text |
|
-> a |
|
-> m Engine | Returns: A newly allocated IBusEngine. |
Create a new Engine
.
registerProperties
engineRegisterProperties Source #
:: (HasCallStack, MonadIO m, IsEngine a, IsPropList b) | |
=> a |
|
-> b |
|
-> m () |
Register and show properties in language bar.
(Note: The prop_list object will be released, if it is floating. If caller want to keep the object, caller should make the object sink by g_object_ref_sink.)
showAuxiliaryText
engineShowAuxiliaryText Source #
:: (HasCallStack, MonadIO m, IsEngine a) | |
=> a |
|
-> m () |
Show the auxiliary bar.
showLookupTable
engineShowLookupTable Source #
:: (HasCallStack, MonadIO m, IsEngine a) | |
=> a |
|
-> m () |
Show the lookup table.
showPreeditText
engineShowPreeditText Source #
:: (HasCallStack, MonadIO m, IsEngine a) | |
=> a |
|
-> m () |
Show the pre-edit buffer.
updateAuxiliaryText
engineUpdateAuxiliaryText Source #
:: (HasCallStack, MonadIO m, IsEngine a, IsText b) | |
=> a |
|
-> b |
|
-> Bool |
|
-> m () |
Update the auxiliary bar.
(Note: The text object will be released, if it is floating. If caller want to keep the object, caller should make the object sink by g_object_ref_sink.)
updateLookupTable
engineUpdateLookupTable Source #
:: (HasCallStack, MonadIO m, IsEngine a, IsLookupTable b) | |
=> a |
|
-> b |
|
-> Bool |
|
-> m () |
Update the lookup table.
(Note: The table object will be released, if it is floating. If caller want to keep the object, caller should make the object sink by g_object_ref_sink.)
updateLookupTableFast
engineUpdateLookupTableFast Source #
:: (HasCallStack, MonadIO m, IsEngine a, IsLookupTable b) | |
=> a |
|
-> b |
|
-> Bool |
|
-> m () |
Fast update for big lookup table.
If size of lookup table is not over table page size *4,
then it calls engineUpdateLookupTable
.
(Note: The table object will be released, if it is floating. If caller want to keep the object, caller should make the object sink by g_object_ref_sink.)
updatePreeditText
engineUpdatePreeditText Source #
:: (HasCallStack, MonadIO m, IsEngine a, IsText b) | |
=> a |
|
-> b |
|
-> Word32 |
|
-> Bool |
|
-> m () |
Update the pre-edit buffer.
(Note: The text object will be released, if it is floating. If caller want to keep the object, caller should make the object sink by g_object_ref_sink.)
updatePreeditTextWithMode
engineUpdatePreeditTextWithMode Source #
:: (HasCallStack, MonadIO m, IsEngine a, IsText b) | |
=> a |
|
-> b |
|
-> Word32 |
|
-> Bool |
|
-> PreeditFocusMode |
|
-> m () |
Update the pre-edit buffer with commit mode. Similar to
engineUpdatePreeditText
, this function allows users to specify
the behavior on focus out when the pre-edit buffer is visible.
If mode
is IBUS_ENGINE_PREEDIT_COMMIT, contents of the pre-edit buffer
will be committed and cleared.
If mode
is IBUS_ENGINE_PREEDIT_CLEAR, contents of the pre-edit buffer
will be cleared only.
(Note: The text object will be released, if it is floating. If caller want to keep the object, caller should make the object sink by g_object_ref_sink.)
updateProperty
:: (HasCallStack, MonadIO m, IsEngine a, IsProperty b) | |
=> a |
|
-> b |
|
-> m () |
Update the state displayed in language bar.
(Note: The prop object will be released, if it is floating. If caller want to keep the object, caller should make the object sink by g_object_ref_sink.)
Properties
activeSurroundingText
When this property is set to True
, "RequireSurroundingText" D-Bus
signal will be called by ibus-daemon on every focus-in/out event, with
no need for the engine to call engineGetSurroundingText
.
This property can only be set at construct time.
constructEngineActiveSurroundingText :: (IsEngine o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “active-surrounding-text
” property. This is rarely needed directly, but it is used by new
.
getEngineActiveSurroundingText :: (MonadIO m, IsEngine o) => o -> m Bool Source #
Get the value of the “active-surrounding-text
” property.
When overloading is enabled, this is equivalent to
get
engine #activeSurroundingText
engineName
Name of this IBusEngine.
constructEngineEngineName :: (IsEngine o, MonadIO m) => Text -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “engine-name
” property. This is rarely needed directly, but it is used by new
.
getEngineEngineName :: (MonadIO m, IsEngine o) => o -> m (Maybe Text) Source #
Get the value of the “engine-name
” property.
When overloading is enabled, this is equivalent to
get
engine #engineName
hasFocusId
Use Engine
::focus_in_id
()/focus_out_id()
class method insteads of
focus_in()
/focus_out()
class methods when this property is set to True
.
Otherwise, use Engine
::focus_in
()/focus_out class methods.
This property can only be set at construct time.
See also: IBusEnginefocusInId
constructEngineHasFocusId :: (IsEngine o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “has-focus-id
” property. This is rarely needed directly, but it is used by new
.
getEngineHasFocusId :: (MonadIO m, IsEngine o) => o -> m Bool Source #
Get the value of the “has-focus-id
” property.
When overloading is enabled, this is equivalent to
get
engine #hasFocusId
Signals
cancelHandWriting
type EngineCancelHandWritingCallback Source #
Emitted when a hand writing operation is cancelled. Implement the member function IBusEngineClasscancel_hand_writing in extended class to receive this signal.
<note><para>Argument userData
is ignored in this function.</para>
</note>
afterEngineCancelHandWriting :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineCancelHandWritingCallback) -> m SignalHandlerId Source #
Connect a signal handler for the cancelHandWriting signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
engine #cancelHandWriting 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.
onEngineCancelHandWriting :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineCancelHandWritingCallback) -> m SignalHandlerId Source #
Connect a signal handler for the cancelHandWriting signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
engine #cancelHandWriting callback
candidateClicked
type EngineCandidateClickedCallback Source #
= Word32 |
|
-> Word32 |
|
-> Word32 |
|
-> IO () |
Emitted when candidate on lookup table is clicked. Implement the member function IBusEngineClasscandidate_clicked in extended class to receive this signal.
<note><para>Argument userData
is ignored in this function.</para>
</note>
afterEngineCandidateClicked :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineCandidateClickedCallback) -> m SignalHandlerId Source #
Connect a signal handler for the candidateClicked signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
engine #candidateClicked 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.
onEngineCandidateClicked :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineCandidateClickedCallback) -> m SignalHandlerId Source #
Connect a signal handler for the candidateClicked signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
engine #candidateClicked callback
cursorDown
type EngineCursorDownCallback = IO () Source #
Emitted when the down cursor button is pressed. Implement the member function IBusEngineClasscursor_down in extended class to receive this signal.
<note><para>Argument userData
is ignored in this function.</para>
</note>
afterEngineCursorDown :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineCursorDownCallback) -> m SignalHandlerId Source #
Connect a signal handler for the cursorDown signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
engine #cursorDown 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.
onEngineCursorDown :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineCursorDownCallback) -> m SignalHandlerId Source #
Connect a signal handler for the cursorDown signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
engine #cursorDown callback
cursorUp
type EngineCursorUpCallback = IO () Source #
Emitted when the up cursor button is pressed. Implement the member function IBusEngineClasscursor_up in extended class to receive this signal.
<note><para>Argument userData
is ignored in this function.</para>
</note>
afterEngineCursorUp :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineCursorUpCallback) -> m SignalHandlerId Source #
Connect a signal handler for the cursorUp signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
engine #cursorUp 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.
onEngineCursorUp :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineCursorUpCallback) -> m SignalHandlerId Source #
Connect a signal handler for the cursorUp signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
engine #cursorUp callback
disable
type EngineDisableCallback = IO () Source #
Emitted when the IME is disabled. Implement the member function IBusEngineClassdisable in extended class to receive this signal.
See also: busSetGlobalEngine
.
<note><para>Argument userData
is ignored in this function.</para>
</note>
afterEngineDisable :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineDisableCallback) -> m SignalHandlerId Source #
Connect a signal handler for the disable signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
engine #disable 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.
onEngineDisable :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineDisableCallback) -> m SignalHandlerId Source #
Connect a signal handler for the disable signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
engine #disable callback
enable
type EngineEnableCallback = IO () Source #
Emitted when the IME is enabled. Implement the member function IBusEngineClassenable in extended class to receive this signal.
See also: busSetGlobalEngine
.
<note><para>Argument userData
is ignored in this function.</para>
</note>
afterEngineEnable :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineEnableCallback) -> m SignalHandlerId Source #
Connect a signal handler for the enable signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
engine #enable 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.
onEngineEnable :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineEnableCallback) -> m SignalHandlerId Source #
Connect a signal handler for the enable signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
engine #enable callback
focusIn
type EngineFocusInCallback = IO () Source #
Emitted when the client application get the focus. Implement the member function IBusEngineClassfocus_in in extended class to receive this signal.
See also: inputContextFocusIn
<note><para>Argument userData
is ignored in this function.</para>
</note>
afterEngineFocusIn :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineFocusInCallback) -> m SignalHandlerId Source #
Connect a signal handler for the focusIn signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
engine #focusIn 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.
onEngineFocusIn :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineFocusInCallback) -> m SignalHandlerId Source #
Connect a signal handler for the focusIn signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
engine #focusIn callback
focusInId
type EngineFocusInIdCallback Source #
Emitted when the client application get the focus.
Implement the member function IBusEngineClassfocus_in
in extended class to receive this signal.
objectPath
is a unique id by input context.
client
indicates a client type:
'fake': focus is on desktop background or other programs where no
input is possible
'xim': old X11 programs like xterm, emacs, ...
GTK3 programs in a Gnome Xorg session when GTK_IM_MODULE
is unset also use xim
'gtk-im:<client-name>': Gtk2 input module is used
'gtk3-im:<client-name>': Gtk3 input module is used
'gtk4-im:<client-name>': Gtk4 input module is used
In case of the Gtk input modules, the name of the
client is also shown after the “:”, for example
like 'gtk3-im:firefox', 'gtk4-im:gnome-text-editor', …
'gnome-shell': Entries handled by gnome-shell
(like the command line dialog opened with Alt+F2
or the search field when pressing the Super key.)
When GTK_IM_MODULE is unset in a Gnome Wayland session
all programs which would show 'gtk3-im' or 'gtk4-im'
with GTK_IM_MODULE=ibus then show 'gnome-shell'
instead.
'Qt': Qt4 programs like keepassx-2.0.3 …
'QIBusInputContext': Qt5 programs like keepassxc-2.7.1, anki-2.1.15
telegram-desktop-3.7.3,
You need to set Engine
::has-focus-id
property to True
when you
construct an Engine
to use this class method.
See also: inputContextFocusIn
<note><para>Argument userData
is ignored in this function.</para>
</note>
afterEngineFocusInId :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineFocusInIdCallback) -> m SignalHandlerId Source #
Connect a signal handler for the focusInId signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
engine #focusInId 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.
onEngineFocusInId :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineFocusInIdCallback) -> m SignalHandlerId Source #
Connect a signal handler for the focusInId signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
engine #focusInId callback
focusOut
type EngineFocusOutCallback = IO () Source #
Emitted when the client application lost the focus. Implement the member function IBusEngineClassfocus_out in extended class to receive this signal.
See also: inputContextFocusOut
<note><para>Argument userData
is ignored in this function.</para>
</note>
afterEngineFocusOut :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineFocusOutCallback) -> m SignalHandlerId Source #
Connect a signal handler for the focusOut signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
engine #focusOut 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.
onEngineFocusOut :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineFocusOutCallback) -> m SignalHandlerId Source #
Connect a signal handler for the focusOut signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
engine #focusOut callback
focusOutId
type EngineFocusOutIdCallback Source #
Emitted when the client application lost the focus.
Implement the member function IBusEngineClassfocus_out
in extended class to receive this signal.
objectPath
is a unique id by input context.
You need to set Engine
::has-focus-id
property to True
when you
construct an Engine
to use this class method.
See also: inputContextFocusOut
<note><para>Argument userData
is ignored in this function.</para>
</note>
afterEngineFocusOutId :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineFocusOutIdCallback) -> m SignalHandlerId Source #
Connect a signal handler for the focusOutId signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
engine #focusOutId 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.
onEngineFocusOutId :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineFocusOutIdCallback) -> m SignalHandlerId Source #
Connect a signal handler for the focusOutId signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
engine #focusOutId callback
pageDown
type EnginePageDownCallback = IO () Source #
Emitted when the page-down button is pressed. Implement the member function IBusEngineClasspage_down in extended class to receive this signal.
<note><para>Argument userData
is ignored in this function.</para>
</note>
afterEnginePageDown :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EnginePageDownCallback) -> m SignalHandlerId Source #
Connect a signal handler for the pageDown signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
engine #pageDown 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.
onEnginePageDown :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EnginePageDownCallback) -> m SignalHandlerId Source #
Connect a signal handler for the pageDown signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
engine #pageDown callback
pageUp
type EnginePageUpCallback = IO () Source #
Emitted when the page-up button is pressed. Implement the member function IBusEngineClasspage_up in extended class to receive this signal.
<note><para>Argument userData
is ignored in this function.</para>
</note>
afterEnginePageUp :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EnginePageUpCallback) -> m SignalHandlerId Source #
Connect a signal handler for the pageUp signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
engine #pageUp 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.
onEnginePageUp :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EnginePageUpCallback) -> m SignalHandlerId Source #
Connect a signal handler for the pageUp signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
engine #pageUp callback
processHandWritingEvent
type EngineProcessHandWritingEventCallback Source #
= Ptr () |
|
-> Word32 |
|
-> IO () |
Emitted when a hand writing operation is cancelled. Implement the member function IBusEngineClasscancel_hand_writing in extended class to receive this signal.
<note><para>Argument userData
is ignored in this function.</para>
</note>
afterEngineProcessHandWritingEvent :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineProcessHandWritingEventCallback) -> m SignalHandlerId Source #
Connect a signal handler for the processHandWritingEvent signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
engine #processHandWritingEvent 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.
onEngineProcessHandWritingEvent :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineProcessHandWritingEventCallback) -> m SignalHandlerId Source #
Connect a signal handler for the processHandWritingEvent signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
engine #processHandWritingEvent callback
processKeyEvent
type EngineProcessKeyEventCallback Source #
= Word32 |
|
-> Word32 |
|
-> Word32 |
|
-> IO Bool | Returns: <note><para>Argument |
Emitted when a key event is received.
Implement the member function IBusEngineClassprocess_key_event
in extended class to receive this signal.
Both the key symbol and keycode are passed to the member function.
See inputContextProcessKeyEvent
for further explanation of
key symbol, keycode and which to use.
afterEngineProcessKeyEvent :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineProcessKeyEventCallback) -> m SignalHandlerId Source #
Connect a signal handler for the processKeyEvent signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
engine #processKeyEvent 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.
onEngineProcessKeyEvent :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineProcessKeyEventCallback) -> m SignalHandlerId Source #
Connect a signal handler for the processKeyEvent signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
engine #processKeyEvent callback
propertyActivate
type EnginePropertyActivateCallback Source #
Emitted when a property is activated or change changed. Implement the member function IBusEngineClassproperty_activate in extended class to receive this signal.
<note><para>Argument userData
is ignored in this function.</para>
</note>
afterEnginePropertyActivate :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EnginePropertyActivateCallback) -> m SignalHandlerId Source #
Connect a signal handler for the propertyActivate signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
engine #propertyActivate 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.
onEnginePropertyActivate :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EnginePropertyActivateCallback) -> m SignalHandlerId Source #
Connect a signal handler for the propertyActivate signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
engine #propertyActivate callback
propertyHide
type EnginePropertyHideCallback Source #
Emitted when a property is hidden. Implement the member function IBusEngineClassproperty_hide in extended class to receive this signal.
<note><para>Argument userData
is ignored in this function.</para>
</note>
afterEnginePropertyHide :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EnginePropertyHideCallback) -> m SignalHandlerId Source #
Connect a signal handler for the propertyHide signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
engine #propertyHide 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.
onEnginePropertyHide :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EnginePropertyHideCallback) -> m SignalHandlerId Source #
Connect a signal handler for the propertyHide signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
engine #propertyHide callback
propertyShow
type EnginePropertyShowCallback Source #
Emitted when a property is shown. Implement the member function IBusEngineClassproperty_side in extended class to receive this signal.
<note><para>Argument userData
is ignored in this function.</para>
</note>
afterEnginePropertyShow :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EnginePropertyShowCallback) -> m SignalHandlerId Source #
Connect a signal handler for the propertyShow signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
engine #propertyShow 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.
onEnginePropertyShow :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EnginePropertyShowCallback) -> m SignalHandlerId Source #
Connect a signal handler for the propertyShow signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
engine #propertyShow callback
reset
type EngineResetCallback = IO () Source #
Emitted when the IME is reset. Implement the member function IBusEngineClassreset in extended class to receive this signal.
See also: inputContextReset
.
<note><para>Argument userData
is ignored in this function.</para>
</note>
afterEngineReset :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineResetCallback) -> m SignalHandlerId Source #
Connect a signal handler for the reset signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
engine #reset 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.
onEngineReset :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineResetCallback) -> m SignalHandlerId Source #
Connect a signal handler for the reset signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
engine #reset callback
setCapabilities
type EngineSetCapabilitiesCallback Source #
= Word32 |
|
-> IO () |
Emitted when the client application capabilities is set. Implement the member function IBusEngineClassset_capabilities in extended class to receive this signal.
See also: inputContextSetCapabilities
.
<note><para>Argument userData
is ignored in this function.</para>
</note>
afterEngineSetCapabilities :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineSetCapabilitiesCallback) -> m SignalHandlerId Source #
Connect a signal handler for the setCapabilities signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
engine #setCapabilities 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.
onEngineSetCapabilities :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineSetCapabilitiesCallback) -> m SignalHandlerId Source #
Connect a signal handler for the setCapabilities signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
engine #setCapabilities callback
setContentType
type EngineSetContentTypeCallback Source #
= Word32 |
|
-> Word32 |
|
-> IO () |
Emitted when the client application content-type (primary purpose and hints) is set. The engine could change the behavior according to the content-type. Implement the member function IBusEngineClassset_content_type in extended class to receive this signal.
For example, if the client application wants to restrict input
to numbers, this signal will be emitted with purpose
set to
IBUS_INPUT_PURPOSE_NUMBER
, so the engine can switch the input
mode to latin.
<note><para>Argument userData
is ignored in this
function.</para></note>
afterEngineSetContentType :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineSetContentTypeCallback) -> m SignalHandlerId Source #
Connect a signal handler for the setContentType signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
engine #setContentType 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.
onEngineSetContentType :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineSetContentTypeCallback) -> m SignalHandlerId Source #
Connect a signal handler for the setContentType signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
engine #setContentType callback
setCursorLocation
type EngineSetCursorLocationCallback Source #
= Int32 |
|
-> Int32 |
|
-> Int32 |
|
-> Int32 |
|
-> IO () |
Emitted when the location of IME is set. Implement the member function IBusEngineClassset_cursor_location in extended class to receive this signal.
See also: inputContextSetCursorLocation
.
<note><para>Argument userData
is ignored in this function.</para>
</note>
afterEngineSetCursorLocation :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineSetCursorLocationCallback) -> m SignalHandlerId Source #
Connect a signal handler for the setCursorLocation signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
engine #setCursorLocation 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.
onEngineSetCursorLocation :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineSetCursorLocationCallback) -> m SignalHandlerId Source #
Connect a signal handler for the setCursorLocation signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
engine #setCursorLocation callback
setSurroundingText
type EngineSetSurroundingTextCallback Source #
= Object |
|
-> Word32 |
|
-> Word32 |
|
-> IO () |
Emitted when a surrounding text is set. Implement the member function IBusEngineClassset_surrounding_text in extended class to receive this signal. If anchor_pos equals to cursor_pos, it means "there are no selection" or "does not support selection retrival".
<note><para>Argument userData
is ignored in this function.</para>
</note>
afterEngineSetSurroundingText :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineSetSurroundingTextCallback) -> m SignalHandlerId Source #
Connect a signal handler for the setSurroundingText signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
engine #setSurroundingText 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.
onEngineSetSurroundingText :: (IsEngine a, MonadIO m) => a -> ((?self :: a) => EngineSetSurroundingTextCallback) -> m SignalHandlerId Source #
Connect a signal handler for the setSurroundingText signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
engine #setSurroundingText callback