Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
QPanGesture Class Reference

The QPanGesture class describes a panning gesture made by the user.\inmodule QtWidgets. More...

#include <qgesture.h>

+ Inheritance diagram for QPanGesture:
+ Collaboration diagram for QPanGesture:

Public Member Functions

 QPanGesture (QObject *parent=nullptr)
 
 ~QPanGesture ()
 Destructor.
 
QPointF lastOffset () const
 
QPointF offset () const
 
QPointF delta () const
 
qreal acceleration () const
 
void setLastOffset (const QPointF &value)
 
void setOffset (const QPointF &value)
 
void setAcceleration (qreal value)
 
- Public Member Functions inherited from QGesture
 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< QStringbindableObjectName ()
 
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).
 
QThreadthread () 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 >
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 >
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 QObjectListchildren () 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< QByteArraydynamicPropertyNames () const
 
QBindingStoragebindingStorage ()
 
const QBindingStoragebindingStorage () const
 
QObjectparent () 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.
 

Properties

QPointF lastOffset
 the last offset recorded for this gesture
 
QPointF offset
 the total offset from the first input position to the current input position
 
QPointF delta
 the offset from the previous input position to the current input
 
qreal acceleration
 the acceleration in the motion of the touch point for this gesture
 
- Properties inherited from QGesture
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 QPanGestureRecognizer
 
class QWinNativePanGestureRecognizer
 

Additional Inherited Members

- Public Types inherited from QGesture
enum  GestureCancelPolicy { CancelNone = 0 , CancelAllInContext }
 This enum describes how accepting a gesture can cancel other gestures automatically. More...
 
- 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 Member Functions inherited from QGesture
 QGesture (QGesturePrivate &dd, QObject *parent)
 
- Protected Member Functions inherited from QObject
QObjectsender () 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)
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr
 

Detailed Description

The QPanGesture class describes a panning gesture made by the user.

\inmodule QtWidgets.

Since
4.6

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.

See also
QPinchGesture, QSwipeGesture

Definition at line 72 of file qgesture.h.

Constructor & Destructor Documentation

◆ QPanGesture()

QPanGesture::QPanGesture ( QObject * parent = nullptr)
explicit

Definition at line 264 of file qgesture.cpp.

References QGesture::gestureType, and Qt::PanGesture.

◆ ~QPanGesture()

QPanGesture::~QPanGesture ( )

Destructor.

Definition at line 273 of file qgesture.cpp.

Member Function Documentation

◆ acceleration()

qreal QPanGesture::acceleration ( ) const

Definition at line 293 of file qgesture.cpp.

◆ delta()

QPointF QPanGesture::delta ( ) const

Definition at line 287 of file qgesture.cpp.

References d.

◆ lastOffset()

QPointF QPanGesture::lastOffset ( ) const

Definition at line 277 of file qgesture.cpp.

◆ offset()

QPointF QPanGesture::offset ( ) const

Definition at line 282 of file qgesture.cpp.

◆ setAcceleration()

void QPanGesture::setAcceleration ( qreal value)

Definition at line 308 of file qgesture.cpp.

◆ setLastOffset()

void QPanGesture::setLastOffset ( const QPointF & value)

Definition at line 298 of file qgesture.cpp.

◆ setOffset()

void QPanGesture::setOffset ( const QPointF & value)

Definition at line 303 of file qgesture.cpp.

Friends And Related Symbol Documentation

◆ QPanGestureRecognizer

friend class QPanGestureRecognizer
friend

Definition at line 97 of file qgesture.h.

◆ QWinNativePanGestureRecognizer

friend class QWinNativePanGestureRecognizer
friend

Definition at line 98 of file qgesture.h.

Property Documentation

◆ acceleration

QPanGesture::acceleration
readwrite

the acceleration in the motion of the touch point for this gesture

Definition at line 80 of file qgesture.h.

Referenced by operator<<().

◆ delta

QPanGesture::delta
read

the offset from the previous input position to the current input

This is essentially the same as the difference between offset() and lastOffset().

Definition at line 79 of file qgesture.h.

Referenced by operator<<().

◆ lastOffset

QPanGesture::lastOffset
readwrite

the last offset recorded for this gesture

The last offset contains the change in position of the user's input as reported in the \l offset property when a previous gesture event was delivered for this gesture.

If no previous event was delivered with information about this gesture (i.e., this gesture object contains information about the first movement in the gesture) then this property contains a zero size.

Definition at line 77 of file qgesture.h.

Referenced by operator<<(), and QPanGestureRecognizer::reset().

◆ offset

QPanGesture::offset
readwrite

the total offset from the first input position to the current input position

The offset measures the total change in position of the user's input covered by the gesture on the input device.

Definition at line 78 of file qgesture.h.

Referenced by operator<<().


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