PinchEvent

Since: BlackBerry 10.0.0

#include <bb/cascades/PinchEvent>

Pinch events are emitted when the user performs a pinch gesture.

The pinch event class holds information about a pinch gesture, such as the mid point of the gesture, the pinch ratio and the rotation.

For events of this class, AbstractGestureEvent::x/y represents the coordinates of the finger that first touched the screen, equivalent to touchPointX(0).

To listen to pinch events received on a control, add a PinchHandler gesture handler to the control.

See also:

PinchHandler


Overview

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

floatdistance [read-only]
floatmidPointX [read-only]
floatmidPointY [read-only]
floatpinchRatio [read-only]
floatrotation [read-only]
bb::cascades::PropagationPhase::TypepropagationPhase [read-only]Inherited
QTimetimestamp [read-only]Inherited
floatx [read-only]Inherited
floaty [read-only]Inherited

Protected Attributes Index

Only has inherited protected attributes

QEventPrivate *dInherited
ushorttInherited

Public Functions Index

PinchEvent (float midPointX, float midPointY, float pinchRatio, float rotation, float distance)
virtual ~PinchEvent ()
floatdistance () const
floatmidPointX () const
floatmidPointY () const
floatpinchRatio () const
floatrotation () const
virtual Q_INVOKABLE QStringtoDebugString () const
Q_INVOKABLE floattouchPointX (int pointIndex) const
Q_INVOKABLE floattouchPointY (int pointIndex) 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
floatx () const Inherited
floaty () 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 distance[read-only]

The distance (in pixels) between the touch points.

Since:

BlackBerry 10.0.0

float midPointX[read-only]

The x coordinate of midpoint in local coordinate system.

Since:

BlackBerry 10.0.0

float midPointY[read-only]

The y coordinate of midpoint in local coordinate system.

Since:

BlackBerry 10.0.0

float pinchRatio[read-only]

The ratio between the initial pinch distance and the current pinch distance.

The pinch ratio is filtered to achieve a smoother gesture.

Since:

BlackBerry 10.0.0

float rotation[read-only]

The rotation (in degrees, clockwise) relative to the start positions of the fingers.

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

float xInherited[read-only]

The x coordinate of the event, in local coordinate system.

Since:

BlackBerry 10.0.0

float yInherited[read-only]

The y coordinate of the event, in local coordinate system.

The meaning of this can vary between specialized classes. For more information, see gestures that make use of more than one touch point.

Since:

BlackBerry 10.0.0

Protected Attributes

(Only has inherited protected attributes)

QEventPrivate * d ()Inherited

ushort t ()Inherited

Public Functions

PinchEvent (
  • floatmidPointX,
  • floatmidPointY,
  • floatpinchRatio,
  • floatrotation,
  • floatdistance )

Constructs a pinch event.

Parameters
midPointX

The x coordinate of midpoint in local coordinate system.

midPointY

The x coordinate of midpoint in local coordinate system.

pinchRatio

The ratio between the initial pinch distance and the current pinch distance.

rotation

The rotation (in degrees, clockwise) relative to the start positions of the fingers.

distance

The distance (in pixels) between the touch points.

Return:

A pinch event.

Since:

BlackBerry 10.0.0

virtual~PinchEvent ()

Destructor.

Since:

BlackBerry 10.0.0

float distance ()

Retrieves the current distance (in pixels) between the touch points.

The distance is filtered to achieve a smoother gesture.

Return:

The distance between the touch points.

Since:

BlackBerry 10.0.0

float midPointX ()

Retrieves the x coordinate of the midpoint in local coordinate system.

Return:

The X coordinate of midpoint.

Since:

BlackBerry 10.0.0

float midPointY ()

Retrieves the x coordinate of the midpoint in local coordinate system.

Return:

The y coordinate of midpoint.

Since:

BlackBerry 10.0.0

float pinchRatio ()

Retrieves the pinch ratio.

The pinch ratio is filtered to achieve a smoother gesture.

Return:

The pinch ratio.

Since:

BlackBerry 10.0.0

float rotation ()

Retrieves the current pinch rotation.

The rotation is expressed in degrees, clockwise, relative to the start positions of the fingers.

Return:

The pinch rotation.

Since:

BlackBerry 10.0.0

virtual Q_INVOKABLE QString toDebugString ()

Retrieves a string representation of the pinch event.

Return:

A string representing the pinch event.

Since:

BlackBerry 10.0.0

Q_INVOKABLE float touchPointX (
  • intpointIndex)

Retrieves the x coordinate (in local coordinate system) for the touch point indicated by pointIndex.

A pinch event will always contain two touch points, and they are indexed in the order they hit the screen. If touchPoint is out-of-range, 0.0 is returned.

Parameters
pointIndex

The index of the touch point to retrieve the x coordinate from.

Return:

The local x coordinate of touch point indicated by pointIndex, or 0.0 if pointIndex is out-of-range.

Since:

BlackBerry 10.0.0

Q_INVOKABLE float touchPointY (
  • intpointIndex)

Retrieves the x coordinate (in local coordinate system) for the touch point indicated by pointIndex.

A pinch event will always contain two touch points, and they are indexed in the order they hit the screen. If touchPoint is out-of-range, 0.0 is returned.

Parameters
pointIndex

The index of the touch point to retrieve the x coordinate from.

Return:

The local x coordinate of touch point indicated by pointIndex, or 0.0 if pointIndex is out-of-range.

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

float x ()Inherited

Retrieves the x coordinate of the event, in local coordinate system.

Return:

X coordinate of the event.

Since:

BlackBerry 10.0.0

float y ()Inherited

Retrieves the x coordinate of the event, in local coordinate system.

Return:

Y coordinate of the event.

Since:

BlackBerry 10.0.0

Static Public Functions

QEvent::Type type ()

Retrieves the pinch event type.

Return:

The pinch event type.

Since:

BlackBerry 10.0.0

int registerEventType (
  • inthint)
Inherited

Last modified: 2014-09-29



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

comments powered by Disqus