GI.Atk.Structs.KeyEventStruct

Encapsulates information about a key event.

Exported types

newtype KeyEventStruct

Memory-managed wrapper type.

Constructors

KeyEventStruct (ManagedPtr KeyEventStruct)

Instances

WrappedPtr KeyEventStruct

Defined in GI.Atk.Structs.KeyEventStruct

Methods

wrappedPtrCalloc :: IO (Ptr KeyEventStruct)

wrappedPtrCopy :: KeyEventStruct -> IO KeyEventStruct

wrappedPtrFree :: Maybe (FunPtr (Ptr KeyEventStruct -> IO ()))

tag ~ AttrSet => Constructible KeyEventStruct tag

Defined in GI.Atk.Structs.KeyEventStruct

Methods

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

newZeroKeyEventStruct :: MonadIO m => m KeyEventStruct

Construct a KeyEventStruct struct initialized to zero.

noKeyEventStruct :: Maybe KeyEventStruct

A convenience alias for Nothing :: Maybe KeyEventStruct.

Properties

keycode

The raw hardware code that generated the key event. This field is raraly useful.

getKeyEventStructKeycode :: MonadIO m => KeyEventStruct -> m Word16

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

get keyEventStruct #keycode

setKeyEventStructKeycode :: MonadIO m => KeyEventStruct -> Word16 -> m ()

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

set keyEventStruct [ #keycode := value ]

keyval

A guint representing a keysym value corresponding to those used by GDK and X11: see /usr/X11/include/keysymdef.h.

getKeyEventStructKeyval :: MonadIO m => KeyEventStruct -> m Word32

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

get keyEventStruct #keyval

setKeyEventStructKeyval :: MonadIO m => KeyEventStruct -> Word32 -> m ()

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

set keyEventStruct [ #keyval := value ]

length

The length of member string.

getKeyEventStructLength :: MonadIO m => KeyEventStruct -> m Int32

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

get keyEventStruct #length

setKeyEventStructLength :: MonadIO m => KeyEventStruct -> Int32 -> m ()

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

set keyEventStruct [ #length := value ]

state

A bitmask representing the state of the modifier keys immediately after the event takes place. The meaning of the bits is currently defined to match the bitmask used by GDK in GdkEventType.state, see http://developer.gnome.org/doc/API/2.0/gdk/gdk-Event-Structures.htmlGdkEventKey

getKeyEventStructState :: MonadIO m => KeyEventStruct -> m Word32

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

get keyEventStruct #state

setKeyEventStructState :: MonadIO m => KeyEventStruct -> Word32 -> m ()

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

set keyEventStruct [ #state := value ]

string

A string containing one of the following: either a string approximating the text that would result from this keypress, if the key is a control or graphic character, or a symbolic name for this keypress. Alphanumeric and printable keys will have the symbolic key name in this string member, for instance "A". "0", "semicolon", "aacute". Keypad keys have the prefix "KP".

clearKeyEventStructString :: MonadIO m => KeyEventStruct -> m ()

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

clear #string

getKeyEventStructString :: MonadIO m => KeyEventStruct -> m (Maybe Text)

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

get keyEventStruct #string

setKeyEventStructString :: MonadIO m => KeyEventStruct -> CString -> m ()

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

set keyEventStruct [ #string := value ]

timestamp

A timestamp in milliseconds indicating when the event occurred. These timestamps are relative to a starting point which should be considered arbitrary, and only used to compare the dispatch times of events to one another.

getKeyEventStructTimestamp :: MonadIO m => KeyEventStruct -> m Word32

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

get keyEventStruct #timestamp

setKeyEventStructTimestamp :: MonadIO m => KeyEventStruct -> Word32 -> m ()

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

set keyEventStruct [ #timestamp := value ]

type

An AtkKeyEventType, generally one of ATK_KEY_EVENT_PRESS or ATK_KEY_EVENT_RELEASE

getKeyEventStructType :: MonadIO m => KeyEventStruct -> m Int32

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

get keyEventStruct #type

setKeyEventStructType :: MonadIO m => KeyEventStruct -> Int32 -> m ()

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

set keyEventStruct [ #type := value ]