GI.IBus.Objects.Keymap

An IBusKeymap defines the mapping between keyboard scancodes and keyboard symbols such as numbers, alphabets, and punctuation marks.

Some input methods assume certain keyboard layout (such as Chewing and Wubi requires an US-QWERTY layout), and expect key symbols to be arranged in that order. These input methods should new an IBusKeymap instance and define the keyboard layout. Then keymapLookupKeysym can convert scancodes back to the key symbols.

see_also: Component, EngineDesc

Exported types

newtype Keymap

Memory-managed wrapper type.

Constructors

Keymap (ManagedPtr Keymap)

Instances

Eq Keymap

Defined in GI.IBus.Objects.Keymap

Methods

(==) :: Keymap -> Keymap -> Bool

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

GObject Keymap

Defined in GI.IBus.Objects.Keymap

ManagedPtrNewtype Keymap

Defined in GI.IBus.Objects.Keymap

Methods

toManagedPtr :: Keymap -> ManagedPtr Keymap

TypedObject Keymap

Defined in GI.IBus.Objects.Keymap

Methods

glibType :: IO GType

HasParentTypes Keymap

Defined in GI.IBus.Objects.Keymap

IsGValue (Maybe Keymap)

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

Defined in GI.IBus.Objects.Keymap

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes Keymap

Defined in GI.IBus.Objects.Keymap

type ParentTypes Keymap = '[Object, Object]

class (GObject o, IsDescendantOf Keymap o) => IsKeymap o

Type class for types which can be safely cast to Keymap, for instance with toKeymap.

Instances

(GObject o, IsDescendantOf Keymap o) => IsKeymap o

Defined in GI.IBus.Objects.Keymap

toKeymap :: (MonadIO m, IsKeymap o) => o -> m Keymap

Cast to Keymap, 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, destroy, forceFloating, freezeNotify, getv, isFloating, lookupKeysym, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getData, getProperty, getQdata.

Setters

setData, setDataFull, setProperty.

get

keymapGet

Arguments

:: (HasCallStack, MonadIO m)

=> Text

name: The keymap file to be loaded, such as 'us', 'jp'.

-> m Keymap

Returns: An Keymap associated with the giving name; or Nothing if failed.

Get an IBusKeymap associated with the giving name.

This function loads the keymap file specified in name in the IBUS_DATA_DIR/keymaps directory.

lookupKeysym

keymapLookupKeysym

Arguments

:: (HasCallStack, MonadIO m, IsKeymap a)

=> a

keymap: An IBusKeymap.

-> Word16

keycode: A scancode to be converted.

-> Word32

state: Modifier flags(such as Ctrl, Shift).

-> m Word32

Returns: Corresponding keysym.

Converts the scancode to keysym, given the keymap.

new

keymapNew

Arguments

:: (HasCallStack, MonadIO m)

=> Text

name: The keymap file to be loaded, such as 'us', 'jp'.

-> m Keymap

Returns: An Keymap associated with the giving name; or Nothing if failed.

Deprecated: This function has been deprecated and shouldnot be used in newly written code. Please use keymapGet.

Get an Keymap associated with the giving name.

This function loads the keymap file specified in name in the IBUS_DATA_DIR/keymaps directory.