GI.WebKit2.Objects.InputMethodContext

No description available in the introspection data.

Exported types

newtype InputMethodContext

Memory-managed wrapper type.

Constructors

InputMethodContext (ManagedPtr InputMethodContext)

Instances

Eq InputMethodContext

Defined in GI.WebKit2.Objects.InputMethodContext

Methods

(==) :: InputMethodContext -> InputMethodContext -> Bool

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

GObject InputMethodContext

Defined in GI.WebKit2.Objects.InputMethodContext

ManagedPtrNewtype InputMethodContext

Defined in GI.WebKit2.Objects.InputMethodContext

Methods

toManagedPtr :: InputMethodContext -> ManagedPtr InputMethodContext

TypedObject InputMethodContext

Defined in GI.WebKit2.Objects.InputMethodContext

Methods

glibType :: IO GType

IsGValue InputMethodContext

Convert InputMethodContext to and from GValue with toGValue and fromGValue.

Defined in GI.WebKit2.Objects.InputMethodContext

Methods

toGValue :: InputMethodContext -> IO GValue

fromGValue :: GValue -> IO InputMethodContext

HasParentTypes InputMethodContext

Defined in GI.WebKit2.Objects.InputMethodContext

type ParentTypes InputMethodContext

Defined in GI.WebKit2.Objects.InputMethodContext

type ParentTypes InputMethodContext = '[Object]

class (GObject o, IsDescendantOf InputMethodContext o) => IsInputMethodContext o

Type class for types which can be safely cast to InputMethodContext, for instance with toInputMethodContext.

Instances

(GObject o, IsDescendantOf InputMethodContext o) => IsInputMethodContext o

Defined in GI.WebKit2.Objects.InputMethodContext

toInputMethodContext :: (MonadIO m, IsInputMethodContext o) => o -> m InputMethodContext

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

Methods

Overloaded methods

filterKeyEvent

inputMethodContextFilterKeyEvent

Arguments

:: (HasCallStack, MonadIO m, IsInputMethodContext a)

=> a

context: a InputMethodContext

-> EventKey

keyEvent: the key event to filter

-> m Bool

Returns: True if the key event was handled, or False otherwise

Allow keyEvent to be handled by the input method. If True is returned, then no further processing should be done for the key event.

Since: 2.28

getInputHints

inputMethodContextGetInputHints

Arguments

:: (HasCallStack, MonadIO m, IsInputMethodContext a)

=> a

context: a InputMethodContext

-> m [InputHints]

Returns: the InputHints of the input associated with context

Get the value of the InputMethodContext:input-hints property.

Since: 2.28

getInputPurpose

inputMethodContextGetInputPurpose

Arguments

:: (HasCallStack, MonadIO m, IsInputMethodContext a)

=> a

context: a InputMethodContext

-> m InputPurpose

Returns: the InputPurpose of the input associated with context

Get the value of the InputMethodContext:input-purpose property.

Since: 2.28

getPreedit

inputMethodContextGetPreedit

Arguments

:: (HasCallStack, MonadIO m, IsInputMethodContext a)

=> a

context: a InputMethodContext

-> m (Maybe Text, [InputMethodUnderline], Word32)

Get the current preedit string for the context, and a list of WebKitInputMethodUnderline to apply to the string. The string will be displayed inserted at cursorOffset.

Since: 2.28

notifyCursorArea

inputMethodContextNotifyCursorArea

Arguments

:: (HasCallStack, MonadIO m, IsInputMethodContext a)

=> a

context: a InputMethodContext

-> Int32

x: the x coordinate of cursor location

-> Int32

y: the y coordinate of cursor location

-> Int32

width: the width of cursor area

-> Int32

height: the height of cursor area

-> m ()

Notify context that cursor area changed in input associated.

Since: 2.28

notifyFocusIn

inputMethodContextNotifyFocusIn

Arguments

:: (HasCallStack, MonadIO m, IsInputMethodContext a)

=> a

context: a InputMethodContext

-> m ()

Notify context that input associated has gained focus.

Since: 2.28

notifyFocusOut

inputMethodContextNotifyFocusOut

Arguments

:: (HasCallStack, MonadIO m, IsInputMethodContext a)

=> a

context: a InputMethodContext

-> m ()

Notify context that input associated has lost focus.

Since: 2.28

notifySurrounding

inputMethodContextNotifySurrounding

Arguments

:: (HasCallStack, MonadIO m, IsInputMethodContext a)

=> a

context: a InputMethodContext

-> Text

text: text surrounding the insertion point

-> Int32

length: the length of text, or -1 if text is nul-terminated

-> Word32

cursorIndex: the byte index of the insertion cursor within text.

-> Word32

selectionIndex: the byte index of the selection cursor within text.

-> m ()

Notify context that the context surrounding the cursor has changed. If there's no selection selectionIndex is the same as cursorIndex.

Since: 2.28

reset

inputMethodContextReset

Arguments

:: (HasCallStack, MonadIO m, IsInputMethodContext a)

=> a

context: a InputMethodContext

-> m ()

Reset the context. This will typically cause the input to clear the preedit state.

Since: 2.28

setEnablePreedit

inputMethodContextSetEnablePreedit

Arguments

:: (HasCallStack, MonadIO m, IsInputMethodContext a)

=> a

context: a InputMethodContext

-> Bool

enabled: whether to enable preedit

-> m ()

Set whether context should enable preedit to display feedback.

Since: 2.28

setInputHints

inputMethodContextSetInputHints :: (HasCallStack, MonadIO m, IsInputMethodContext a) => a -> [InputHints] -> m ()

No description available in the introspection data.

setInputPurpose

inputMethodContextSetInputPurpose

Arguments

:: (HasCallStack, MonadIO m, IsInputMethodContext a)

=> a

context: a InputMethodContext

-> InputPurpose

purpose: a InputPurpose

-> m ()

Set the value of the InputMethodContext:input-purpose property.

Since: 2.28

Properties

inputHints

No description available in the introspection data.

constructInputMethodContextInputHints :: (IsInputMethodContext o, MonadIO m) => [InputHints] -> m (GValueConstruct o)

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

getInputMethodContextInputHints :: (MonadIO m, IsInputMethodContext o) => o -> m [InputHints]

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

get inputMethodContext #inputHints

setInputMethodContextInputHints :: (MonadIO m, IsInputMethodContext o) => o -> [InputHints] -> m ()

Set the value of the “input-hints” property. When overloading is enabled, this is equivalent to

set inputMethodContext [ #inputHints := value ]

inputPurpose

No description available in the introspection data.

constructInputMethodContextInputPurpose :: (IsInputMethodContext o, MonadIO m) => InputPurpose -> m (GValueConstruct o)

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

getInputMethodContextInputPurpose :: (MonadIO m, IsInputMethodContext o) => o -> m InputPurpose

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

get inputMethodContext #inputPurpose

setInputMethodContextInputPurpose :: (MonadIO m, IsInputMethodContext o) => o -> InputPurpose -> m ()

Set the value of the “input-purpose” property. When overloading is enabled, this is equivalent to

set inputMethodContext [ #inputPurpose := value ]

Signals

committed

type C_InputMethodContextCommittedCallback = Ptr () -> CString -> Ptr () -> IO ()

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

type InputMethodContextCommittedCallback

Arguments

 = Text

text: the string result

-> IO ()

Emitted when a complete input sequence has been entered by the user. This can be a single character immediately after a key press or the final result of preediting.

Since: 2.28

afterInputMethodContextCommitted :: (IsInputMethodContext a, MonadIO m) => a -> InputMethodContextCommittedCallback -> m SignalHandlerId

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

after inputMethodContext #committed callback

genClosure_InputMethodContextCommitted :: MonadIO m => InputMethodContextCommittedCallback -> m (GClosure C_InputMethodContextCommittedCallback)

Wrap the callback into a GClosure.

mk_InputMethodContextCommittedCallback :: C_InputMethodContextCommittedCallback -> IO (FunPtr C_InputMethodContextCommittedCallback)

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

noInputMethodContextCommittedCallback :: Maybe InputMethodContextCommittedCallback

A convenience synonym for Nothing :: Maybe InputMethodContextCommittedCallback.

onInputMethodContextCommitted :: (IsInputMethodContext a, MonadIO m) => a -> InputMethodContextCommittedCallback -> m SignalHandlerId

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

on inputMethodContext #committed callback

wrap_InputMethodContextCommittedCallback :: InputMethodContextCommittedCallback -> C_InputMethodContextCommittedCallback

Wrap a InputMethodContextCommittedCallback into a C_InputMethodContextCommittedCallback.

deleteSurrounding

type C_InputMethodContextDeleteSurroundingCallback = Ptr () -> Int32 -> Word32 -> Ptr () -> IO ()

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

type InputMethodContextDeleteSurroundingCallback

Arguments

 = Int32

offset: the character offset from the cursor position of the text to be deleted.

-> Word32

nChars: the number of characters to be deleted

-> IO ()

Emitted when the input method wants to delete the context surrounding the cursor. If offset is a negative value, it means a position before the cursor.

Since: 2.28

afterInputMethodContextDeleteSurrounding :: (IsInputMethodContext a, MonadIO m) => a -> InputMethodContextDeleteSurroundingCallback -> m SignalHandlerId

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

after inputMethodContext #deleteSurrounding callback

genClosure_InputMethodContextDeleteSurrounding :: MonadIO m => InputMethodContextDeleteSurroundingCallback -> m (GClosure C_InputMethodContextDeleteSurroundingCallback)

Wrap the callback into a GClosure.

mk_InputMethodContextDeleteSurroundingCallback :: C_InputMethodContextDeleteSurroundingCallback -> IO (FunPtr C_InputMethodContextDeleteSurroundingCallback)

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

noInputMethodContextDeleteSurroundingCallback :: Maybe InputMethodContextDeleteSurroundingCallback

A convenience synonym for Nothing :: Maybe InputMethodContextDeleteSurroundingCallback.

onInputMethodContextDeleteSurrounding :: (IsInputMethodContext a, MonadIO m) => a -> InputMethodContextDeleteSurroundingCallback -> m SignalHandlerId

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

on inputMethodContext #deleteSurrounding callback

wrap_InputMethodContextDeleteSurroundingCallback :: InputMethodContextDeleteSurroundingCallback -> C_InputMethodContextDeleteSurroundingCallback

Wrap a InputMethodContextDeleteSurroundingCallback into a C_InputMethodContextDeleteSurroundingCallback.

preeditChanged

type C_InputMethodContextPreeditChangedCallback = Ptr () -> Ptr () -> IO ()

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

type InputMethodContextPreeditChangedCallback = IO ()

Emitted whenever the preedit sequence currently being entered has changed. It is also emitted at the end of a preedit sequence, in which case inputMethodContextGetPreedit returns the empty string.

Since: 2.28

afterInputMethodContextPreeditChanged :: (IsInputMethodContext a, MonadIO m) => a -> InputMethodContextPreeditChangedCallback -> m SignalHandlerId

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

after inputMethodContext #preeditChanged callback

genClosure_InputMethodContextPreeditChanged :: MonadIO m => InputMethodContextPreeditChangedCallback -> m (GClosure C_InputMethodContextPreeditChangedCallback)

Wrap the callback into a GClosure.

mk_InputMethodContextPreeditChangedCallback :: C_InputMethodContextPreeditChangedCallback -> IO (FunPtr C_InputMethodContextPreeditChangedCallback)

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

noInputMethodContextPreeditChangedCallback :: Maybe InputMethodContextPreeditChangedCallback

A convenience synonym for Nothing :: Maybe InputMethodContextPreeditChangedCallback.

onInputMethodContextPreeditChanged :: (IsInputMethodContext a, MonadIO m) => a -> InputMethodContextPreeditChangedCallback -> m SignalHandlerId

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

on inputMethodContext #preeditChanged callback

wrap_InputMethodContextPreeditChangedCallback :: InputMethodContextPreeditChangedCallback -> C_InputMethodContextPreeditChangedCallback

Wrap a InputMethodContextPreeditChangedCallback into a C_InputMethodContextPreeditChangedCallback.

preeditFinished

type C_InputMethodContextPreeditFinishedCallback = Ptr () -> Ptr () -> IO ()

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

type InputMethodContextPreeditFinishedCallback = IO ()

Emitted when a preediting sequence has been completed or canceled.

Since: 2.28

afterInputMethodContextPreeditFinished :: (IsInputMethodContext a, MonadIO m) => a -> InputMethodContextPreeditFinishedCallback -> m SignalHandlerId

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

after inputMethodContext #preeditFinished callback

genClosure_InputMethodContextPreeditFinished :: MonadIO m => InputMethodContextPreeditFinishedCallback -> m (GClosure C_InputMethodContextPreeditFinishedCallback)

Wrap the callback into a GClosure.

mk_InputMethodContextPreeditFinishedCallback :: C_InputMethodContextPreeditFinishedCallback -> IO (FunPtr C_InputMethodContextPreeditFinishedCallback)

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

noInputMethodContextPreeditFinishedCallback :: Maybe InputMethodContextPreeditFinishedCallback

A convenience synonym for Nothing :: Maybe InputMethodContextPreeditFinishedCallback.

onInputMethodContextPreeditFinished :: (IsInputMethodContext a, MonadIO m) => a -> InputMethodContextPreeditFinishedCallback -> m SignalHandlerId

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

on inputMethodContext #preeditFinished callback

wrap_InputMethodContextPreeditFinishedCallback :: InputMethodContextPreeditFinishedCallback -> C_InputMethodContextPreeditFinishedCallback

Wrap a InputMethodContextPreeditFinishedCallback into a C_InputMethodContextPreeditFinishedCallback.

preeditStarted

type C_InputMethodContextPreeditStartedCallback = Ptr () -> Ptr () -> IO ()

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

type InputMethodContextPreeditStartedCallback = IO ()

Emitted when a new preediting sequence starts.

Since: 2.28

afterInputMethodContextPreeditStarted :: (IsInputMethodContext a, MonadIO m) => a -> InputMethodContextPreeditStartedCallback -> m SignalHandlerId

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

after inputMethodContext #preeditStarted callback

genClosure_InputMethodContextPreeditStarted :: MonadIO m => InputMethodContextPreeditStartedCallback -> m (GClosure C_InputMethodContextPreeditStartedCallback)

Wrap the callback into a GClosure.

mk_InputMethodContextPreeditStartedCallback :: C_InputMethodContextPreeditStartedCallback -> IO (FunPtr C_InputMethodContextPreeditStartedCallback)

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

noInputMethodContextPreeditStartedCallback :: Maybe InputMethodContextPreeditStartedCallback

A convenience synonym for Nothing :: Maybe InputMethodContextPreeditStartedCallback.

onInputMethodContextPreeditStarted :: (IsInputMethodContext a, MonadIO m) => a -> InputMethodContextPreeditStartedCallback -> m SignalHandlerId

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

on inputMethodContext #preeditStarted callback

wrap_InputMethodContextPreeditStartedCallback :: InputMethodContextPreeditStartedCallback -> C_InputMethodContextPreeditStartedCallback

Wrap a InputMethodContextPreeditStartedCallback into a C_InputMethodContextPreeditStartedCallback.