Gdk.Event.Key_Event

Description

An event related to a key-based device.

Gdk_Key_Event

type Gdk_Key_Event is new Gdk_Event with null record;

Get_Consumed_Modifiers

function Get_Consumed_Modifiers
   (Self : Gdk.Event.Gdk_Event) return Gdk.Enums.Gdk_Modifier_Type

Extracts the consumed modifiers from a key event.

Parameters

Self

Return Value

the consumed modifiers or Event

Get_Keycode

function Get_Keycode (Self : Gdk.Event.Gdk_Event) return Guint

Extracts the keycode from a key event.

Parameters

Self

Return Value

the keycode of Event

Get_Keyval

function Get_Keyval (Self : Gdk.Event.Gdk_Event) return Guint

Extracts the keyval from a key event.

Parameters

Self

Return Value

the keyval of Event

Get_Layout

function Get_Layout (Self : Gdk.Event.Gdk_Event) return Guint

Extracts the layout from a key event.

Parameters

Self

Return Value

the layout of Event

Get_Level

function Get_Level (Self : Gdk.Event.Gdk_Event) return Guint

Extracts the shift level from a key event.

Parameters

Self

Return Value

the shift level of Event

Get_Match

function Get_Match
   (Self      : Gdk.Event.Gdk_Event;
    Keyval    : out Guint;
    Modifiers : out Gdk.Enums.Gdk_Modifier_Type) return Boolean

Gets a keyval and modifier combination that will match the event. See [methodGdk.KeyEvent.matches].

Parameters

Self

Keyval

return location for a keyval

Modifiers

return location for modifiers

Return Value

True on success

Get_Type

function Get_Type return Glib.GType

Return Value

Is_Modifier

function Is_Modifier (Self : Gdk.Event.Gdk_Event) return Boolean

Extracts whether the key event is for a modifier key.

Parameters

Self

Return Value

True if the Event is for a modifier key

Matches

function Matches
   (Self      : Gdk.Event.Gdk_Event;
    Keyval    : Guint;
    Modifiers : Gdk.Enums.Gdk_Modifier_Type)
    return Gdk.Key_Match.Gdk_Key_Match

Matches a key event against a keyval and modifiers. This is typically used to trigger keyboard shortcuts such as Ctrl-C. Partial matches are possible where the combination matches if the currently active group is ignored. Note that we ignore Caps Lock for matching.

Parameters

Self

Keyval

the keyval to match

Modifiers

the modifiers to match

Return Value

a GdkKeyMatch value describing whether Event matches