The QGesture class represents a gesture, containing properties that describe the corresponding user input. More...

#include <qgesture.h>

Inheritance diagram for QGesture:

Collaboration diagram for QGesture:

Public Types
enum	GestureCancelPolicy { CancelNone = 0 , CancelAllInContext }
	This enum describes how accepting a gesture can cancel other gestures automatically. More...

Public Member Functions
	QGesture (QObject *parent=nullptr)

	~QGesture ()
	Destroys the gesture object.

Qt::GestureType	gestureType () const

Qt::GestureState	state () const

QPointF	hotSpot () const

void	setHotSpot (const QPointF &value)

bool	hasHotSpot () const

void	unsetHotSpot ()

void	setGestureCancelPolicy (GestureCancelPolicy policy)

GestureCancelPolicy	gestureCancelPolicy () const

Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)
	Constructs an object with parent object parent.

virtual	~QObject ()
	Destroys the object, deleting all its child objects.

virtual bool	event (QEvent *event)
	This virtual function receives events to an object and should return true if the event e was recognized and processed.

virtual bool	eventFilter (QObject watched, QEvent event)
	Filters events if this object has been installed as an event filter for the watched object.

QString	objectName () const

Q_WEAK_OVERLOAD void	setObjectName (const QString &name)
	Sets the object's name to name.

void	setObjectName (QAnyStringView name)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QBindable< QString >	bindableObjectName ()

bool	isWidgetType () const
	Returns `true` if the object is a widget; otherwise returns `false`.

bool	isWindowType () const
	Returns `true` if the object is a window; otherwise returns `false`.

bool	isQuickItemType () const
	Returns `true` if the object is a QQuickItem; otherwise returns `false`.

bool	signalsBlocked () const noexcept
	Returns `true` if signals are blocked; otherwise returns `false`.

bool	blockSignals (bool b) noexcept
	If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).

QThread *	thread () const
	Returns the thread in which the object lives.

bool	moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
	Changes the thread affinity for this object and its children and returns `true` on success.

int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
	This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.

int	startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)

void	killTimer (int id)
	Kills the timer with timer identifier, id.

void	killTimer (Qt::TimerId id)

template<typename T >
T	findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.

template<typename T >
QList< T >	findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.

template<typename T >
T	findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

template<typename T >
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

const QObjectList &	children () const
	Returns a list of child objects.

void	setParent (QObject *parent)
	Makes the object a child of parent.

void	installEventFilter (QObject *filterObj)
	Installs an event filter filterObj on this object.

void	removeEventFilter (QObject *obj)
	Removes an event filter object obj from this object.

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const

bool	disconnect (const char signal=nullptr, const QObject receiver=nullptr, const char *member=nullptr) const

bool	disconnect (const QObject receiver, const char member=nullptr) const

void	dumpObjectTree () const
	Dumps a tree of children to the debug output.

void	dumpObjectInfo () const
	Dumps information about signal connections, etc.

bool	setProperty (const char *name, const QVariant &value)
	Sets the value of the object's name property to value.

bool	setProperty (const char *name, QVariant &&value)

QVariant	property (const char *name) const
	Returns the value of the object's name property.

QList< QByteArray >	dynamicPropertyNames () const

QBindingStorage *	bindingStorage ()

const QBindingStorage *	bindingStorage () const

QObject *	parent () const
	Returns a pointer to the parent object.

bool	inherits (const char *classname) const
	Returns `true` if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns `false`.

Protected Member Functions
	QGesture (QGesturePrivate &dd, QObject *parent)

Protected Member Functions inherited from QObject
QObject *	sender () const
	Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.

int	senderSignalIndex () const

int	receivers (const char *signal) const
	Returns the number of receivers connected to the signal.

bool	isSignalConnected (const QMetaMethod &signal) const

virtual void	timerEvent (QTimerEvent *event)
	This event handler can be reimplemented in a subclass to receive timer events for the object.

virtual void	childEvent (QChildEvent *event)
	This event handler can be reimplemented in a subclass to receive child events.

virtual void	customEvent (QEvent *event)
	This event handler can be reimplemented in a subclass to receive custom events.

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

	QObject (QObjectPrivate &dd, QObject *parent=nullptr)

Properties
Qt::GestureState	state
	the current state of the gesture

Qt::GestureType	gestureType
	the type of the gesture

QGesture::GestureCancelPolicy	gestureCancelPolicy
	the policy for deciding what happens on accepting a gesture

QPointF	hotSpot
	The point that is used to find the receiver for the gesture event.

bool	hasHotSpot
	whether the gesture has a hot-spot

Properties inherited from QObject
QString	objectName
	the name of this object

Friends
class	QGestureEvent

class	QGestureRecognizer

class	QGestureManager

class	QGraphicsScenePrivate

Additional Inherited Members
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Signals inherited from QObject
void	destroyed (QObject *=nullptr)
	This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.

void	objectNameChanged (const QString &objectName, QPrivateSignal)
	This signal is emitted after the object's name has been changed.

Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)
	\threadsafe

static QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)

static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)
	\threadsafe

static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)

static bool	disconnect (const QMetaObject::Connection &)
	Disconnect a connection.

template<typename Func1 , typename Func2 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot)

template<typename Func1 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject receiver, void **zero)

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.

template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

The QGesture class represents a gesture, containing properties that describe the corresponding user input.

Since: 4.6

\inmodule QtWidgets

Gesture objects are not constructed directly by developers. They are created by the QGestureRecognizer object that is registered with the application; see QGestureRecognizer::registerRecognizer().

For an overview of gesture handling in Qt and information on using gestures in your applications, see the \l{Gestures in Widgets and Graphics View} document.

Definition at line 28 of file qgesture.h.

Member Enumeration Documentation

◆ GestureCancelPolicy

enum QGesture::GestureCancelPolicy

This enum describes how accepting a gesture can cancel other gestures automatically.

\value CancelNone On accepting this gesture no other gestures will be affected.

\value CancelAllInContext On accepting this gesture all gestures that are active in the context (respecting the Qt::GestureFlag that were specified when subscribed to the gesture) will be cancelled.

Enumerator
CancelNone
CancelAllInContext

Definition at line 53 of file qgesture.h.

Constructor & Destructor Documentation

◆ QGesture() [1/2]

QGesture::QGesture ( QObject * parent = nullptr )

explicit

◆ ~QGesture()

QGesture::~QGesture ( )

Destroys the gesture object.

Definition at line 92 of file qgesture.cpp.

◆ QGesture() [2/2]

QGesture::QGesture	(	QGesturePrivate &	dd,
		QObject *	parent )

protected

Definition at line 84 of file qgesture.cpp.

Member Function Documentation

◆ gestureCancelPolicy()

QGesture::GestureCancelPolicy QGesture::gestureCancelPolicy ( ) const

Definition at line 185 of file qgesture.cpp.

References d.

◆ gestureType()

Qt::GestureType QGesture::gestureType ( ) const

Definition at line 124 of file qgesture.cpp.

◆ hasHotSpot()

bool QGesture::hasHotSpot ( ) const

Definition at line 146 of file qgesture.cpp.

◆ hotSpot()

QPointF QGesture::hotSpot ( ) const

Definition at line 134 of file qgesture.cpp.

◆ setGestureCancelPolicy()

void QGesture::setGestureCancelPolicy ( GestureCancelPolicy policy )

Definition at line 179 of file qgesture.cpp.

References d, and policy.

Referenced by QGestureManager::recycle().

Here is the caller graph for this function:

◆ setHotSpot()

void QGesture::setHotSpot ( const QPointF & value )

Definition at line 139 of file qgesture.cpp.

References d.

◆ state()

Qt::GestureState QGesture::state ( ) const

Definition at line 129 of file qgesture.cpp.

◆ unsetHotSpot()

void QGesture::unsetHotSpot ( )

Definition at line 151 of file qgesture.cpp.

Friends And Related Symbol Documentation

◆ QGestureEvent

friend class QGestureEvent

friend

Definition at line 65 of file qgesture.h.

◆ QGestureManager

friend class QGestureManager

friend

Definition at line 67 of file qgesture.h.

◆ QGestureRecognizer

friend class QGestureRecognizer

friend

Definition at line 66 of file qgesture.h.

◆ QGraphicsScenePrivate

friend class QGraphicsScenePrivate

friend

Definition at line 68 of file qgesture.h.

Property Documentation

◆ gestureCancelPolicy

QGesture::gestureCancelPolicy

readwrite

the policy for deciding what happens on accepting a gesture

On accepting one gesture Qt can automatically cancel other gestures that belong to other targets. The policy is normally set to not cancel any other gestures and can be set to cancel all active gestures in the context. For example for all child widgets.

Definition at line 35 of file qgesture.h.

◆ gestureType

QGesture::gestureType

read

the type of the gesture

Definition at line 34 of file qgesture.h.

Referenced by QPanGesture::QPanGesture(), QPinchGesture::QPinchGesture(), QSwipeGesture::QSwipeGesture(), QTapAndHoldGesture::QTapAndHoldGesture(), QTapGesture::QTapGesture(), QGestureEvent::accept(), QGestureEvent::gesture(), QGraphicsScenePrivate::gestureEventHandler(), QGestureEvent::ignore(), QGestureEvent::isAccepted(), QApplication::notify(), operator<<(), and QGestureEvent::setAccepted().

◆ hasHotSpot

QGesture::hasHotSpot

read

whether the gesture has a hot-spot

Definition at line 38 of file qgesture.h.

Referenced by formatGestureHeader().

◆ hotSpot

QGesture::hotSpot

readwrite

The point that is used to find the receiver for the gesture event.

The hot-spot is a point in the global coordinate system, use QWidget::mapFromGlobal() or QGestureEvent::mapToGraphicsScene() to get a local hot-spot.

The hot-spot should be set by the gesture recognizer to allow gesture event delivery to a QGraphicsObject.

Definition at line 37 of file qgesture.h.

Referenced by formatGestureHeader().

◆ state

QGesture::state

read

the current state of the gesture

Definition at line 33 of file qgesture.h.

Referenced by QGestureEvent::activeGestures(), QGestureEvent::canceledGestures(), formatGestureHeader(), and QGestureRecognizer::reset().

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

qtbase/src/widgets/kernel/qgesture.h (05fc3aef53348fb58be6308076e000825b704e58)
qtbase/src/widgets/kernel/qgesture.cpp (05fc3aef53348fb58be6308076e000825b704e58)

Public Types

Public Member Functions

Protected Member Functions

Properties

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ GestureCancelPolicy

Constructor & Destructor Documentation

◆ QGesture() [1/2]

◆ ~QGesture()

◆ QGesture() [2/2]

Member Function Documentation

◆ gestureCancelPolicy()

◆ gestureType()

◆ hasHotSpot()

◆ hotSpot()

◆ setGestureCancelPolicy()

◆ setHotSpot()

◆ state()

◆ unsetHotSpot()

Friends And Related Symbol Documentation

◆ QGestureEvent

◆ QGestureManager

◆ QGestureRecognizer

◆ QGraphicsScenePrivate

Property Documentation

◆ gestureCancelPolicy

◆ gestureType

◆ hasHotSpot

◆ hotSpot

◆ state