KeyEvent

Since: BlackBerry 10.1.0

#include <bb/cascades/KeyEvent>

An event indicating that a key has been pressed or released.

The event provides the key that generated the event and press/release information ( keycap, key, pressed, duration properties). It also provides information about modifiers that were pressed along with the key ( altPressed, shiftPressed, ctrlPressed properties).


Overview

Inheritance

QEvent
bb::cascades::Event
bb::cascades::KeyEvent

Public Types Index

Only has inherited public types

enum Type

None 0, Timer 1, MouseButtonPress 2, MouseButtonRelease 3, MouseButtonDblClick 4, MouseMove 5, KeyPress 6, KeyRelease 7, FocusIn 8, FocusOut 9, Enter 10, Leave 11, Paint 12, Move 13, Resize 14, Create 15, Destroy 16, Show 17, Hide 18, Close 19, Quit 20, ParentChange 21, ParentAboutToChange 131, ThreadChange 22, WindowActivate 24, WindowDeactivate 25, ShowToParent 26, HideToParent 27, Wheel 31, WindowTitleChange 33, WindowIconChange 34, ApplicationWindowIconChange 35, ApplicationFontChange 36, ApplicationLayoutDirectionChange 37, ApplicationPaletteChange 38, PaletteChange 39, Clipboard 40, Speech 42, MetaCall 43, SockAct 50, WinEventAct 132, DeferredDelete 52, DragEnter 60, DragMove 61, DragLeave 62, Drop 63, DragResponse 64, ChildAdded 68, ChildPolished 69, ChildRemoved 71, ShowWindowRequest 73, PolishRequest 74, Polish 75, LayoutRequest 76, UpdateRequest 77, UpdateLater 78, EmbeddingControl 79, ActivateControl 80, DeactivateControl 81, ContextMenu 82, InputMethod 83, AccessibilityPrepare 86, TabletMove 87, LocaleChange 88, LanguageChange 89, LayoutDirectionChange 90, Style 91, TabletPress 92, TabletRelease 93, OkRequest 94, HelpRequest 95, IconDrag 96, FontChange 97, EnabledChange 98, ActivationChange 99, StyleChange 100, IconTextChange 101, ModifiedChange 102, MouseTrackingChange 109, WindowBlocked 103, WindowUnblocked 104, WindowStateChange 105, ToolTip 110, WhatsThis 111, StatusTip 112, ActionChanged 113, ActionAdded 114, ActionRemoved 115, FileOpen 116, Shortcut 117, ShortcutOverride 51, WhatsThisClicked 118, ToolBarChange 120, ApplicationActivate 121, ApplicationActivated ApplicationActivate, ApplicationDeactivate 122, ApplicationDeactivated ApplicationDeactivate, QueryWhatsThis 123, EnterWhatsThisMode 124, LeaveWhatsThisMode 125, ZOrderChange 126, HoverEnter 127, HoverLeave 128, HoverMove 129, AccessibilityHelp 119, AccessibilityDescription 130, AcceptDropsChange 152, MenubarUpdated 153, ZeroTimerEvent 154, GraphicsSceneMouseMove 155, GraphicsSceneMousePress 156, GraphicsSceneMouseRelease 157, GraphicsSceneMouseDoubleClick 158, GraphicsSceneContextMenu 159, GraphicsSceneHoverEnter 160, GraphicsSceneHoverMove 161, GraphicsSceneHoverLeave 162, GraphicsSceneHelp 163, GraphicsSceneDragEnter 164, GraphicsSceneDragMove 165, GraphicsSceneDragLeave 166, GraphicsSceneDrop 167, GraphicsSceneWheel 168, KeyboardLayoutChange 169, DynamicPropertyChange 170, TabletEnterProximity 171, TabletLeaveProximity 172, NonClientAreaMouseMove 173, NonClientAreaMouseButtonPress 174, NonClientAreaMouseButtonRelease 175, NonClientAreaMouseButtonDblClick 176, MacSizeChange 177, ContentsRectChange 178, MacGLWindowChange 179, FutureCallOut 180, GraphicsSceneResize 181, GraphicsSceneMove 182, CursorChange 183, ToolTipChange 184, NetworkReplyUpdated 185, GrabMouse 186, UngrabMouse 187, GrabKeyboard 188, UngrabKeyboard 189, MacGLClearDrawable 191, StateMachineSignal 192, StateMachineWrapped 193, TouchBegin 194, TouchUpdate 195, TouchEnd 196, NativeGesture 197, RequestSoftwareInputPanel 199, CloseSoftwareInputPanel 200, UpdateSoftKeys 201, WinIdChange 203, Gesture 198, GestureOverride 202, PlatformPanel 212, User 1000, MaxUser 65535

Properties Index

boolaltPressed [read-only]
boolctrlPressed [read-only]
intduration [read-only]
intkey [read-only]
intkeycap [read-only]
boolpressed [read-only]
boolshiftPressed [read-only]
QStringunicode [read-only]
bb::cascades::PropagationPhase::TypepropagationPhase [read-only]Inherited
QTimetimestamp [read-only]Inherited

Protected Attributes Index

Only has inherited protected attributes

QEventPrivate *dInherited
ushorttInherited

Public Functions Index

KeyEvent (int key, bool isPressed, bool isAltPressed, bool isShiftPressed, bool isCtrlPressed)
KeyEvent (int keycap, int key, bool isPressed, bool isAltPressed, bool isShiftPressed, bool isCtrlPressed)
KeyEvent (int keycap, int key, bool isPressed, bool isAltPressed, bool isShiftPressed, bool isCtrlPressed, int duration)
virtual ~KeyEvent ()
intduration () const
boolisAltPressed () const
boolisCtrlPressed () const
boolisPressed () const
boolisShiftPressed () const
intkey () const
intkeycap () const
Q_INVOKABLE QStringtoUnicode (bb::cascades::KeyModifier::Types modifiers) const
QStringunicode () const
voidaccept ()Inherited
voidignore ()Inherited
boolisAccepted () const Inherited
bb::cascades::PropagationPhase::TypepropagationPhase () const Inherited
QEvent (Type type)Inherited
voidsetAccepted (bool accepted)Inherited
boolspontaneous () const Inherited
QTimetimestamp () const Inherited
virtual Q_INVOKABLE QStringtoDebugString () const Inherited
Typetype () const Inherited

Static Public Functions Index

Only has inherited static public functions

intregisterEventType (int hint=-1)Inherited

Public Types

(Only has inherited public types)

Type Inherited

None 0
Timer 1
MouseButtonPress 2
MouseButtonRelease 3
MouseButtonDblClick 4
MouseMove 5
KeyPress 6
KeyRelease 7
FocusIn 8
FocusOut 9
Enter 10
Leave 11
Paint 12
Move 13
Resize 14
Create 15
Destroy 16
Show 17
Hide 18
Close 19
Quit 20
ParentChange 21
ParentAboutToChange 131
ThreadChange 22
WindowActivate 24
WindowDeactivate 25
ShowToParent 26
HideToParent 27
Wheel 31
WindowTitleChange 33
WindowIconChange 34
ApplicationWindowIconChange 35
ApplicationFontChange 36
ApplicationLayoutDirectionChange 37
ApplicationPaletteChange 38
PaletteChange 39
Clipboard 40
Speech 42
MetaCall 43
SockAct 50
WinEventAct 132
DeferredDelete 52
DragEnter 60
DragMove 61
DragLeave 62
Drop 63
DragResponse 64
ChildAdded 68
ChildPolished 69
ChildRemoved 71
ShowWindowRequest 73
PolishRequest 74
Polish 75
LayoutRequest 76
UpdateRequest 77
UpdateLater 78
EmbeddingControl 79
ActivateControl 80
DeactivateControl 81
ContextMenu 82
InputMethod 83
AccessibilityPrepare 86
TabletMove 87
LocaleChange 88
LanguageChange 89
LayoutDirectionChange 90
Style 91
TabletPress 92
TabletRelease 93
OkRequest 94
HelpRequest 95
IconDrag 96
FontChange 97
EnabledChange 98
ActivationChange 99
StyleChange 100
IconTextChange 101
ModifiedChange 102
MouseTrackingChange 109
WindowBlocked 103
WindowUnblocked 104
WindowStateChange 105
ToolTip 110
WhatsThis 111
StatusTip 112
ActionChanged 113
ActionAdded 114
ActionRemoved 115
FileOpen 116
Shortcut 117
ShortcutOverride 51
WhatsThisClicked 118
ToolBarChange 120
ApplicationActivate 121
ApplicationActivated ApplicationActivate
ApplicationDeactivate 122
ApplicationDeactivated ApplicationDeactivate
QueryWhatsThis 123
EnterWhatsThisMode 124
LeaveWhatsThisMode 125
ZOrderChange 126
HoverEnter 127
HoverLeave 128
HoverMove 129
AccessibilityHelp 119
AccessibilityDescription 130
AcceptDropsChange 152
MenubarUpdated 153
ZeroTimerEvent 154
GraphicsSceneMouseMove 155
GraphicsSceneMousePress 156
GraphicsSceneMouseRelease 157
GraphicsSceneMouseDoubleClick 158
GraphicsSceneContextMenu 159
GraphicsSceneHoverEnter 160
GraphicsSceneHoverMove 161
GraphicsSceneHoverLeave 162
GraphicsSceneHelp 163
GraphicsSceneDragEnter 164
GraphicsSceneDragMove 165
GraphicsSceneDragLeave 166
GraphicsSceneDrop 167
GraphicsSceneWheel 168
KeyboardLayoutChange 169
DynamicPropertyChange 170
TabletEnterProximity 171
TabletLeaveProximity 172
NonClientAreaMouseMove 173
NonClientAreaMouseButtonPress 174
NonClientAreaMouseButtonRelease 175
NonClientAreaMouseButtonDblClick 176
MacSizeChange 177
ContentsRectChange 178
MacGLWindowChange 179
FutureCallOut 180
GraphicsSceneResize 181
GraphicsSceneMove 182
CursorChange 183
ToolTipChange 184
NetworkReplyUpdated 185
GrabMouse 186
UngrabMouse 187
GrabKeyboard 188
UngrabKeyboard 189
MacGLClearDrawable 191
StateMachineSignal 192
StateMachineWrapped 193
TouchBegin 194
TouchUpdate 195
TouchEnd 196
NativeGesture 197
RequestSoftwareInputPanel 199
CloseSoftwareInputPanel 200
UpdateSoftKeys 201
WinIdChange 203
Gesture 198
GestureOverride 202
PlatformPanel 212
User 1000
MaxUser 65535

Properties

bool altPressed[read-only]

A Boolean expression indicating whether the Alt modifier key was pressed while the key was pressed.

Since:

BlackBerry 10.1.0

bool ctrlPressed[read-only]

A Boolean expression indicating whether the Control modifier key was pressed while the key was pressed.

Since:

BlackBerry 10.1.0

int duration[read-only]

The length of time in milliseconds that the key has been held down.

Since:

BlackBerry 10.2.0

int key[read-only]

An integer corresponding to the unicode of the key being pressed.

Since:

BlackBerry 10.1.0

int keycap[read-only]

A static code corresponding to each physical key on the keyboard.

Since:

BlackBerry 10.1.0

bool pressed[read-only]

A Boolean expression indicating whether the key was pressed or released.

Since:

BlackBerry 10.1.0

bool shiftPressed[read-only]

A Boolean expression indicating whether the Shift modifier key was pressed while the key was pressed.

Since:

BlackBerry 10.1.0

QString unicode[read-only]

The unicode character of the key pressed to generate the event.

Since:

BlackBerry 10.2.0

bb::cascades::PropagationPhase::Type propagationPhaseInherited[read-only]

The propagation phase the event was received in.

Since:

BlackBerry 10.0.0

QTime timestampInherited[read-only]

Timestamp taken when the event was emitted.

Since:

BlackBerry 10.0.0

Protected Attributes

(Only has inherited protected attributes)

QEventPrivate * d ()Inherited

ushort t ()Inherited

Public Functions

KeyEvent (
  • intkey,
  • boolisPressed,
  • boolisAltPressed,
  • boolisShiftPressed,
  • boolisCtrlPressed )

Constructs a key event.

Parameters
key

The key pressed to generate the event.

isPressed

true if the user is pressing the key, false if the user is releasing the key.

isAltPressed

true if the alt modifier key was pressed during the event, false otherwise.

isShiftPressed

true if the shift modifier key was pressed during the event, false otherwise.

isCtrlPressed

true if the ctrl modifier key was pressed during the event, false otherwise.

Deprecated

Use KeyEvent(int keycap, int key, bool isPressed, bool isAltPressed, bool isShiftPressed, bool isCtrlPressed, int duration) instead.

Since:

BlackBerry 10.1.0

KeyEvent (
  • intkeycap,
  • intkey,
  • boolisPressed,
  • boolisAltPressed,
  • boolisShiftPressed,
  • boolisCtrlPressed )

Constructs a key event.

Parameters
keycap

The keycap value for the key pressed to generate the event.

key

The key pressed to generate the event.

isPressed

true if the user is pressing the key, false if the user is releasing the key.

isAltPressed

true if the alt modifier key was pressed during the event, false otherwise.

isShiftPressed

true if the shift modifier key was pressed during the event, false otherwise.

isCtrlPressed

true if the ctrl modifier key was pressed during the event, false otherwise.

Deprecated

Use KeyEvent(int keycap, int key, bool isPressed, bool isAltPressed, bool isShiftPressed, bool isCtrlPressed, int duration) instead.

Since:

BlackBerry 10.1.0

KeyEvent (
  • intkeycap,
  • intkey,
  • boolisPressed,
  • boolisAltPressed,
  • boolisShiftPressed,
  • boolisCtrlPressed,
  • intduration )

Constructs a key event.

Parameters
keycap

The keycap value for the key pressed to generate the event.

key

The key pressed to generate the event.

isPressed

true if the user is pressing the key, false if the user is releasing the key.

isAltPressed

true if the alt modifier key was pressed during the event, false otherwise.

isShiftPressed

true if the shift modifier key was pressed during the event, false otherwise.

isCtrlPressed

true if the ctrl modifier key was pressed during the event, false otherwise.

duration

the length of time in milliseconds that the key has been held down.

Since:

BlackBerry 10.2.0

virtual~KeyEvent ()

Destructor.

Since:

BlackBerry 10.1.0

int duration ()

Retrieves the length of time in milliseconds that the key has been held in a pressed state.

Return:

The length of time in milliseconds that the key has been held in a pressed state.

bool isAltPressed ()

Retrieves the alt modifier key state during the event.

Return:

true if the alt modifier key was pressed during the event, and false otherwise.

Since:

BlackBerry 10.1.0

bool isCtrlPressed ()

Retrieves the ctrl modifier key state during the event.

Return:

true if the ctrl modifier key was pressed during the event, and false otherwise.

Since:

BlackBerry 10.1.0

bool isPressed ()

Retrieves the press/release state of the key event.

Return:

true if the user pressed the key, and false if the user released the key.

Since:

BlackBerry 10.1.0

bool isShiftPressed ()

Retrieves the shift modifier key state during the event.

Return:

true if the shift modifier key was pressed during the event, and false otherwise.

Since:

BlackBerry 10.1.0

int key ()

Retrieves the key pressed to generate the event which reflects the modifiers pressed and keypad variant.

Return:

The key pressed to generate the event.

Since:

BlackBerry 10.1.0

int keycap ()

Retrieves the keycap value for the key pressed to generate the event.

Return:

The keycap value for the key pressed to generate the event. It is a static code for each key on the keyboard.

Since:

BlackBerry 10.1.0

Q_INVOKABLE QString toUnicode (
  • bb::cascades::KeyModifier::Typesmodifiers)

Converts keycap value to unicode symbol based on passed modifiers.

For example applying 'Shift' modifier to keycap 'a' gives 'A', applying 'Alt' modifier to keycap 'a' gives '#' symbol. Conversion keycap 'a' to 'azerty' keyboard layout returns 'q' and so on.

Parameters
modifiers

The modifiers need be applied to capcode.

Return:

The unicode symbol based on keycap value with applied modifier.

Since:

BlackBerry 10.2.0

QString unicode ()

Retrieves the unicode value of the key pressed to generate the event.

Return:

The unicode value of the key pressed to generate the event.

void accept ()Inherited

void ignore ()Inherited

bool isAccepted ()Inherited

bb::cascades::PropagationPhase::Type propagationPhase ()Inherited

Retrieves the propagation phase that this event was sent in.

Return:

The propagation phase.

Since:

BlackBerry 10.0.0

QEvent (
  • Typetype)
Inherited

void setAccepted (
  • boolaccepted)
Inherited

bool spontaneous ()Inherited

QTime timestamp ()Inherited

Retrieves a timestamp taken when the event was emitted.

Return:

The time when the event was emitted.

Since:

BlackBerry 10.0.0

virtual Q_INVOKABLE QString toDebugString ()Inherited

Retrieves a string representation of the event.

Return:

A string representing the event.

Since:

BlackBerry 10.0.0

Type type ()Inherited

Static Public Functions

(Only has inherited static public functions)

int registerEventType (
  • inthint)
Inherited

Last modified: 2014-09-30



Got questions about leaving a comment? Get answers from our Disqus FAQ.

comments powered by Disqus