GI.Gdk.Structs.KeymapKey

A KeymapKey is a hardware key that can be mapped to a keyval.

Exported types

newtype KeymapKey

Memory-managed wrapper type.

Constructors

KeymapKey (ManagedPtr KeymapKey)

Instances

WrappedPtr KeymapKey

Defined in GI.Gdk.Structs.KeymapKey

Methods

wrappedPtrCalloc :: IO (Ptr KeymapKey)

wrappedPtrCopy :: KeymapKey -> IO KeymapKey

wrappedPtrFree :: Maybe (GDestroyNotify KeymapKey)

tag ~ AttrSet => Constructible KeymapKey tag

Defined in GI.Gdk.Structs.KeymapKey

Methods

new :: MonadIO m => (ManagedPtr KeymapKey -> KeymapKey) -> [AttrOp KeymapKey tag] -> m KeymapKey

newZeroKeymapKey :: MonadIO m => m KeymapKey

Construct a KeymapKey struct initialized to zero.

noKeymapKey :: Maybe KeymapKey

A convenience alias for Nothing :: Maybe KeymapKey.

Properties

group

indicates movement in a horizontal direction. Usually groups are used for two different languages. In group 0, a key might have two English characters, and in group 1 it might have two Hebrew characters. The Hebrew characters will be printed on the key next to the English characters.

getKeymapKeyGroup :: MonadIO m => KeymapKey -> m Int32

Get the value of the “group” field. When overloading is enabled, this is equivalent to

get keymapKey #group

setKeymapKeyGroup :: MonadIO m => KeymapKey -> Int32 -> m ()

Set the value of the “group” field. When overloading is enabled, this is equivalent to

set keymapKey [ #group := value ]

keycode

the hardware keycode. This is an identifying number for a physical key.

getKeymapKeyKeycode :: MonadIO m => KeymapKey -> m Word32

Get the value of the “keycode” field. When overloading is enabled, this is equivalent to

get keymapKey #keycode

setKeymapKeyKeycode :: MonadIO m => KeymapKey -> Word32 -> m ()

Set the value of the “keycode” field. When overloading is enabled, this is equivalent to

set keymapKey [ #keycode := value ]

level

indicates which symbol on the key will be used, in a vertical direction. So on a standard US keyboard, the key with the number “1” on it also has the exclamation point ("!") character on it. The level indicates whether to use the “1” or the “!” symbol. The letter keys are considered to have a lowercase letter at level 0, and an uppercase letter at level 1, though only the uppercase letter is printed.

getKeymapKeyLevel :: MonadIO m => KeymapKey -> m Int32

Get the value of the “level” field. When overloading is enabled, this is equivalent to

get keymapKey #level

setKeymapKeyLevel :: MonadIO m => KeymapKey -> Int32 -> m ()

Set the value of the “level” field. When overloading is enabled, this is equivalent to

set keymapKey [ #level := value ]