TouchEvent

Since: BlackBerry 10.0.0

#include <bb/cascades/TouchEvent>

Touch events are emitted when the user touches the screen.

The touch event class holds information about a touch, such as the touch coordinates and the type of touch.

To listen to touch events received on a control, connect a slot to one of the touch signals exposed in the visual node base class.


Overview

Inheritance

QEvent
bb::cascades::Event
bb::cascades::TouchEvent

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

floatlocalX [read-only]
floatlocalY [read-only]
bb::cascades::VisualNodetarget [read-only]
bb::cascades::TouchType::TypetouchType [read-only]
floatwindowX [read-only]
floatwindowY [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

TouchEvent (TouchType::Type touchType, float screenX, float screenY, float windowX, float windowY, float localX, float localY, VisualNode *target)
virtual ~TouchEvent ()
Q_INVOKABLE boolisCancel () const
Q_INVOKABLE boolisDown () const
Q_INVOKABLE boolisMove () const
Q_INVOKABLE boolisUp () const
floatlocalX () const
floatlocalY () const
floatscreenX () const
floatscreenY () const
bb::cascades::VisualNode *target () const
virtual Q_INVOKABLE QStringtoDebugString () const
bb::cascades::TouchType::TypetouchType () const
floatwindowX () const
floatwindowY () 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
Typetype () const Inherited

Static Public Functions Index

QEvent::Typetype ()
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

float localX[read-only]

x coordinate of the touch relative to the visual node where the touch signal is emitted.

Since:

BlackBerry 10.0.0

float localY[read-only]

y coordinate of the touch relative to the visual node where the touch signal is emitted.

Since:

BlackBerry 10.0.0

bb::cascades::VisualNode target[read-only]

The touch target of this event.

Since:

BlackBerry 10.0.0

bb::cascades::TouchType::Type touchType[read-only]

The touch type of the event.

Since:

BlackBerry 10.0.0

float windowX[read-only]

x coordinate of the touch relative to the window.

Since:

BlackBerry 10.0.0

float windowY[read-only]

y coordinate of the touch relative to the window.

Since:

BlackBerry 10.0.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

TouchEvent (
  • TouchType::TypetouchType,
  • floatscreenX,
  • floatscreenY,
  • floatwindowX,
  • floatwindowY,
  • floatlocalX,
  • floatlocalY,
  • VisualNode *target )

Constructs a touch event.

Parameters
touchType

- The type of touch.

screenX

- Touch x coordinate relative to the screen.

screenY

- Touch x coordinate relative to the screen.

windowX

- Touch x coordinate relative to the window.

windowY

- Touch x coordinate relative to the window.

localX

- Touch x coordinate relative to the node that emitts the touch signal.

localY

- Touch x coordinate relative to the node that emitts the touch signal.

target

- The touch target of this event.

Return:

A touch event.

Since:

BlackBerry 10.0.0

virtual~TouchEvent ()

Destructor.

Since:

BlackBerry 10.0.0

Q_INVOKABLE bool isCancel ()

Convenience function for checking if the touch type returned from touchType() is TouchType::Cancel.

Return:

true if the touch type is TouchType::Cancel.

Since:

BlackBerry 10.0.0

Q_INVOKABLE bool isDown ()

Convenience function for checking if the touch type returned from touchType() is TouchType::Down.

Return:

true if the touch type is TouchType::Down.

Since:

BlackBerry 10.0.0

Q_INVOKABLE bool isMove ()

Convenience function for checking if the touch type returned from touchType() is TouchType::Move.

Return:

true if the touch type is TouchType::Move.

Since:

BlackBerry 10.0.0

Q_INVOKABLE bool isUp ()

Convenience function for checking if the touch type returned from touchType() is TouchType::Up.

Return:

true if the touch type is TouchType::Up.

Since:

BlackBerry 10.0.0

float localX ()

Retrieves the x coordinate of the touch relative to the node that emitts the touch signal.

Return:

The x coordinate of the touch.

Since:

BlackBerry 10.0.0

float localY ()

Retrieves the x coordinate of the touch relative to the node that emitts the touch signal.

Return:

The y coordinate of the touch.

Since:

BlackBerry 10.0.0

float screenX ()

Retrieves the x coordinate of the touch relative to the screen.

Return:

The x coordinate of the touch.

Since:

BlackBerry 10.0.0

float screenY ()

Retrieves the x coordinate of the touch relative to the screen.

Return:

The y coordinate of the touch.

Since:

BlackBerry 10.0.0

bb::cascades::VisualNode * target ()

Retrieves the touch target of this event.

Return:

The touch target.

Since:

BlackBerry 10.0.0

virtual Q_INVOKABLE QString toDebugString ()

Retrieves a string representation of the touch event.

Return:

A string representing the touch event.

Since:

BlackBerry 10.0.0

bb::cascades::TouchType::Type touchType ()

Retrieves the touch type of the event.

Return:

The touch type.

Since:

BlackBerry 10.0.0

float windowX ()

Retrieves the x coordinate of the touch relative to the window.

Return:

The x coordinate of the touch.

Since:

BlackBerry 10.0.0

float windowY ()

Retrieves the x coordinate of the touch relative to the window.

Return:

The y coordinate of the touch.

Since:

BlackBerry 10.0.0

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

Type type ()Inherited

Static Public Functions

QEvent::Type type ()

Retrieves the touch event type.

Return:

The touch event type.

Since:

BlackBerry 10.0.0

int registerEventType (
  • inthint)
Inherited

Last modified: 2014-03-13

comments powered by Disqus