 |
Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
|
|
Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
|
The QSwipeGesture class describes a swipe gesture made by the user.\inmodule QtWidgets. More...
#include <qgesture.h>
Public Types | |
| enum | SwipeDirection { NoDirection , Left , Right , Up , Down } |
| This enum describes the possible directions for the gesture's motion along the horizontal and vertical axes. More... | |
| Public Types inherited from QGesture | |
| enum | GestureCancelPolicy { CancelNone = 0 , CancelAllInContext } |
| This enum describes how accepting a gesture can cancel other gestures automatically. More... | |
Public Member Functions | |
| QSwipeGesture (QObject *parent=nullptr) | |
| ~QSwipeGesture () | |
| Destructor. | |
| SwipeDirection | horizontalDirection () const |
| SwipeDirection | verticalDirection () const |
| qreal | swipeAngle () const |
| void | setSwipeAngle (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< 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 | isQmlObjectType () const |
| Returns whether the object has been created by the QML engine or ownership has been explicitly set via QJSEngine::setObjectOwnership(). | |
| 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. | |
Properties | |
| SwipeDirection | horizontalDirection |
| the horizontal direction of the gesture | |
| SwipeDirection | verticalDirection |
| the vertical direction of the gesture | |
| qreal | swipeAngle |
| the angle of the motion associated with the 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 | QSwipeGestureRecognizer |
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 Member Functions inherited from QGesture | |
| 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) | |
| 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) | |
The QSwipeGesture class describes a swipe gesture made by the user.
\inmodule QtWidgets.
{Demonstration of swipe gesture}
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 177 of file qgesture.h.
This enum describes the possible directions for the gesture's motion along the horizontal and vertical axes.
\value NoDirection The gesture had no motion associated with it on a particular axis. \value Left The gesture involved a horizontal motion to the left. \value Right The gesture involved a horizontal motion to the right. \value Up The gesture involved an upward vertical motion. \value Down The gesture involved a downward vertical motion.
| Enumerator | |
|---|---|
| NoDirection | |
| Left | |
| Right | |
| Up | |
| Down | |
Definition at line 188 of file qgesture.h.
|
explicit |
Definition at line 656 of file qgesture.cpp.
| QSwipeGesture::~QSwipeGesture | ( | ) |
Destructor.
Definition at line 665 of file qgesture.cpp.
| QSwipeGesture::SwipeDirection QSwipeGesture::horizontalDirection | ( | ) | const |
Definition at line 669 of file qgesture.cpp.
Definition at line 696 of file qgesture.cpp.
| qreal QSwipeGesture::swipeAngle | ( | ) | const |
Definition at line 691 of file qgesture.cpp.
| QSwipeGesture::SwipeDirection QSwipeGesture::verticalDirection | ( | ) | const |
Definition at line 680 of file qgesture.cpp.
|
friend |
Definition at line 200 of file qgesture.h.
|
read |
the horizontal direction of the gesture
If the gesture has a horizontal component, the horizontal direction is either Left or Right; otherwise, it is NoDirection.
Definition at line 182 of file qgesture.h.
|
readwrite |
the angle of the motion associated with the gesture
If the gesture has either a horizontal or vertical component, the swipe angle describes the angle between the direction of motion and the x-axis as defined using the standard widget \l{Coordinate System}{coordinate system}.
Definition at line 184 of file qgesture.h.
|
read |
the vertical direction of the gesture
If the gesture has a vertical component, the vertical direction is either Up or Down; otherwise, it is NoDirection.
Definition at line 183 of file qgesture.h.
1.14.0