The QGestureEvent class provides the description of triggered gestures. More...

#include <qgesture.h>

Inheritance diagram for QGestureEvent:

Collaboration diagram for QGestureEvent:

Public Member Functions
	QGestureEvent (const QList< QGesture * > &gestures)
	Creates new QGestureEvent containing a list of gestures.
	~QGestureEvent ()
	Destroys QGestureEvent.
QList< QGesture * >	gestures () const
	Returns all gestures that are delivered in the event.
QGesture *	gesture (Qt::GestureType type) const
	Returns a gesture object by type.
QList< QGesture * >	activeGestures () const
	Returns a list of active (not canceled) gestures.
QList< QGesture * >	canceledGestures () const
	Returns a list of canceled gestures.
void	setAccepted (QGesture *, bool)
	Sets the accept flag of the given gesture object to the specified value.
void	accept (QGesture *)
	Sets the accept flag of the given gesture object, the equivalent of calling \l{QGestureEvent::setAccepted()}{setAccepted(gesture, true)}.
void	ignore (QGesture *)
	Clears the accept flag parameter of the given gesture object, the equivalent of calling \l{QGestureEvent::setAccepted()}{setAccepted(gesture, false)}.
bool	isAccepted (QGesture *) const
	Returns `true` if the gesture is accepted; otherwise returns `false`.
void	setAccepted (Qt::GestureType, bool)
	Sets the accept flag of the given gestureType object to the specified value.
void	accept (Qt::GestureType)
	Sets the accept flag of the given gestureType, the equivalent of calling \l{QGestureEvent::setAccepted()}{setAccepted(gestureType, true)}.
void	ignore (Qt::GestureType)
	Clears the accept flag parameter of the given gestureType, the equivalent of calling \l{QGestureEvent::setAccepted()}{setAccepted(gesture, false)}.
bool	isAccepted (Qt::GestureType) const
	Returns `true` if the gesture of type gestureType is accepted; otherwise returns `false`.
void	setWidget (QWidget *widget)
QWidget *	widget () const
	Returns the widget on which the event occurred.
virtual void	setAccepted (bool accepted)
bool	isAccepted () const
void	accept ()
	Sets the accept flag of the event object, the equivalent of calling setAccepted(true).
void	ignore ()
	Clears the accept flag parameter of the event object, the equivalent of calling setAccepted(false).
Public Member Functions inherited from QEvent
	QEvent (Type type)
	Constructs an event object of type type.
virtual	~QEvent ()
	Destroys the event.
Type	type () const
	Returns the event type.
bool	spontaneous () const
	Returns `true` if the event originated outside the application (a system event); otherwise returns `false`.
bool	isAccepted () const
void	accept ()
	Sets the accept flag of the event object, the equivalent of calling setAccepted(true).
void	ignore ()
	Clears the accept flag parameter of the event object, the equivalent of calling setAccepted(false).
bool	isInputEvent () const noexcept
bool	isPointerEvent () const noexcept
bool	isSinglePointEvent () const noexcept
virtual QEvent *	clone () const
	Creates and returns an identical copy of this event.

Friends
class	QApplication
class	QGestureManager

Additional Inherited Members
Public Types inherited from QEvent
enum	Type { None = 0 , Timer = 1 , MouseButtonPress = 2 , MouseButtonRelease = 3 , MouseButtonDblClick = 4 , MouseMove = 5 , KeyPress = 6 , KeyRelease = 7 , FocusIn = 8 , FocusOut = 9 , FocusAboutToChange = 23 , 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 , 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 , ReadOnlyChange = 106 , 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 , AcceptDropsChange = 152 , 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 , GraphicsSceneLeave = 220 , 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 , StateMachineSignal = 192 , StateMachineWrapped = 193 , TouchBegin = 194 , TouchUpdate = 195 , TouchEnd = 196 , NativeGesture = 197 , RequestSoftwareInputPanel = 199 , CloseSoftwareInputPanel = 200 , WinIdChange = 203 , Gesture = 198 , GestureOverride = 202 , ScrollPrepare = 204 , Scroll = 205 , Expose = 206 , InputMethodQuery = 207 , OrientationChange = 208 , TouchCancel = 209 , ThemeChange = 210 , SockClose = 211 , PlatformPanel = 212 , StyleAnimationUpdate = 213 , ApplicationStateChange = 214 , WindowChangeInternal = 215 , ScreenChangeInternal = 216 , PlatformSurface = 217 , Pointer = 218 , TabletTrackingChange = 219 , WindowAboutToChangeInternal = 221 , DevicePixelRatioChange = 222 , ChildWindowAdded = 223 , ChildWindowRemoved = 224 , ParentWindowAboutToChange = 225 , ParentWindowChange = 226 , SafeAreaMarginsChange = 227 , User = 1000 , MaxUser = 65535 }
	This enum type defines the valid event types in Qt. More...
Static Public Member Functions inherited from QEvent
static int	registerEventType (int hint=-1) noexcept
Protected Member Functions inherited from QEvent
	QT_DEFINE_TAG_STRUCT (InputEventTag)
	QEvent (Type type, InputEventTag)
	QT_DEFINE_TAG_STRUCT (PointerEventTag)
	QEvent (Type type, PointerEventTag)
	QT_DEFINE_TAG_STRUCT (SinglePointEventTag)
	QEvent (Type type, SinglePointEventTag)
Protected Attributes inherited from QEvent
quint16	t

Detailed Description

The QGestureEvent class provides the description of triggered gestures.

Since: 4.6

\inmodule QtWidgets

The QGestureEvent class contains a list of gestures, which can be obtained using the gestures() function.

The gestures are either active or canceled. A list of those that are currently being executed can be obtained using the activeGestures() function. A list of those which were previously active and have been canceled can be accessed using the canceledGestures() function. A gesture might be canceled if the current window loses focus, for example, or because of a timeout, or for other reasons.

If the event handler does not accept the event by calling the generic QEvent::accept() function, all individual QGesture object that were not accepted and in the Qt::GestureStarted state will be propagated up the parent widget chain until a widget accepts them individually, by calling QGestureEvent::accept() for each of them, or an event filter consumes the event.

Definition at line 244 of file qgesture.h.

Constructor & Destructor Documentation

◆ QGestureEvent()

QGestureEvent::QGestureEvent ( const QList< QGesture * > & gestures )

explicit

Creates new QGestureEvent containing a list of gestures.

Definition at line 853 of file qgesture.cpp.

◆ ~QGestureEvent()

QGestureEvent::~QGestureEvent ( )

Destroys QGestureEvent.

Definition at line 862 of file qgesture.cpp.

Member Function Documentation

◆ accept() [1/3]

void QEvent::accept ( )

inline

Sets the accept flag of the event object, the equivalent of calling setAccepted(true).

Setting the accept parameter indicates that the event receiver wants the event. Unwanted events might be propagated to the parent widget.

See also: ignore()

Definition at line 316 of file qcoreevent.h.

◆ accept() [2/3]

void QGestureEvent::accept ( QGesture * gesture )

Sets the accept flag of the given gesture object, the equivalent of calling \l{QGestureEvent::setAccepted()}{setAccepted(gesture, true)}.

Setting the accept flag indicates that the event receiver wants the gesture. Unwanted gestures may be propagated to the parent widget.

See also: QGestureEvent::ignore()

Definition at line 939 of file qgesture.cpp.

◆ accept() [3/3]

void QGestureEvent::accept ( Qt::GestureType gestureType )

Sets the accept flag of the given gestureType, the equivalent of calling \l{QGestureEvent::setAccepted()}{setAccepted(gestureType, true)}.

Setting the accept flag indicates that the event receiver wants the gesture. Unwanted gestures may be propagated to the parent widget.

See also: QGestureEvent::ignore()

Definition at line 998 of file qgesture.cpp.

◆ activeGestures()

QList< QGesture * > QGestureEvent::activeGestures ( ) const

Returns a list of active (not canceled) gestures.

Definition at line 888 of file qgesture.cpp.

◆ canceledGestures()

QList< QGesture * > QGestureEvent::canceledGestures ( ) const

Returns a list of canceled gestures.

Definition at line 901 of file qgesture.cpp.

◆ gesture()

QGesture * QGestureEvent::gesture ( Qt::GestureType type ) const

Returns a gesture object by type.

Definition at line 877 of file qgesture.cpp.

◆ gestures()

QList< QGesture * > QGestureEvent::gestures ( ) const

Returns all gestures that are delivered in the event.

Definition at line 869 of file qgesture.cpp.

◆ ignore() [1/3]

void QEvent::ignore ( )

inline

Clears the accept flag parameter of the event object, the equivalent of calling setAccepted(false).

Clearing the accept parameter indicates that the event receiver does not want the event. Unwanted events might be propagated to the parent widget.

See also: accept()

Definition at line 317 of file qcoreevent.h.

◆ ignore() [2/3]

void QGestureEvent::ignore ( QGesture * gesture )

Clears the accept flag parameter of the given gesture object, the equivalent of calling \l{QGestureEvent::setAccepted()}{setAccepted(gesture, false)}.

Clearing the accept flag indicates that the event receiver does not want the gesture. Unwanted gestures may be propagated to the parent widget.

See also: QGestureEvent::accept()

Definition at line 954 of file qgesture.cpp.

◆ ignore() [3/3]

void QGestureEvent::ignore ( Qt::GestureType gestureType )

Clears the accept flag parameter of the given gestureType, the equivalent of calling \l{QGestureEvent::setAccepted()}{setAccepted(gesture, false)}.

Clearing the accept flag indicates that the event receiver does not want the gesture. Unwanted gestures may be propagated to the parent widget.

See also: QGestureEvent::accept()

Definition at line 1012 of file qgesture.cpp.

◆ isAccepted() [1/3]

bool QEvent::isAccepted ( ) const

inline

Definition at line 314 of file qcoreevent.h.

◆ isAccepted() [2/3]

bool QGestureEvent::isAccepted ( QGesture * gesture ) const

Returns true if the gesture is accepted; otherwise returns false.

Definition at line 963 of file qgesture.cpp.

◆ isAccepted() [3/3]

bool QGestureEvent::isAccepted ( Qt::GestureType gestureType ) const

Returns true if the gesture of type gestureType is accepted; otherwise returns false.

Definition at line 1021 of file qgesture.cpp.

◆ setAccepted() [1/3]

virtual void QEvent::setAccepted ( bool accepted )

inlinevirtual

Reimplemented from QEvent.

Definition at line 313 of file qcoreevent.h.

◆ setAccepted() [2/3]

void QGestureEvent::setAccepted	(	QGesture *	gesture,
		bool	value )

Sets the accept flag of the given gesture object to the specified value.

Setting the accept flag indicates that the event receiver wants the gesture. Unwanted gestures may be propagated to the parent widget.

By default, gestures in events of type QEvent::Gesture are accepted, and gestures in QEvent::GestureOverride events are ignored.

For convenience, the accept flag can also be set with \l{QGestureEvent::accept()}{accept(gesture)}, and cleared with \l{QGestureEvent::ignore()}{ignore(gesture)}.

Definition at line 924 of file qgesture.cpp.

◆ setAccepted() [3/3]

void QGestureEvent::setAccepted	(	Qt::GestureType	gestureType,
		bool	value )

Sets the accept flag of the given gestureType object to the specified value.

Setting the accept flag indicates that the event receiver wants to receive gestures of the specified type, gestureType. Unwanted gestures may be propagated to the parent widget.

By default, gestures in events of type QEvent::Gesture are accepted, and gestures in QEvent::GestureOverride events are ignored.

For convenience, the accept flag can also be set with \l{QGestureEvent::accept()}{accept(gestureType)}, and cleared with \l{QGestureEvent::ignore()}{ignore(gestureType)}.

Definition at line 983 of file qgesture.cpp.

◆ setWidget()

void QGestureEvent::setWidget ( QWidget * widget )

Sets the widget for this event to the widget specified.

Definition at line 1031 of file qgesture.cpp.

◆ widget()

QWidget * QGestureEvent::widget ( ) const

Returns the widget on which the event occurred.

Definition at line 1039 of file qgesture.cpp.

◆ QApplication

friend class QApplication

friend

Definition at line 284 of file qgesture.h.

◆ QGestureManager

friend class QGestureManager

friend

Definition at line 285 of file qgesture.h.

The documentation for this class was generated from the following files:

qtbase/src/widgets/kernel/qgesture.h (8825bcdbdab5f37b185261d7ba06260dc8e9930d)
qtbase/src/widgets/kernel/qgesture.cpp (87806f5cad6e4ce75a899598c15c126995682562)

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QGestureEvent()

◆ ~QGestureEvent()

Member Function Documentation

◆ accept() [1/3]

◆ accept() [2/3]

◆ accept() [3/3]

◆ activeGestures()

◆ canceledGestures()

◆ gesture()

◆ gestures()

◆ ignore() [1/3]

◆ ignore() [2/3]

◆ ignore() [3/3]

◆ isAccepted() [1/3]

◆ isAccepted() [2/3]

◆ isAccepted() [3/3]

◆ setAccepted() [1/3]

◆ setAccepted() [2/3]

◆ setAccepted() [3/3]

◆ setWidget()

◆ widget()

Friends And Related Symbol Documentation

◆ QApplication

◆ QGestureManager