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
QQuickPinch Class Reference

#include <qquickpincharea_p.h>

+ Inheritance diagram for QQuickPinch:
+ Collaboration diagram for QQuickPinch:

Public Types

enum  Axis {
  NoDrag =0x00 , XAxis =0x01 , YAxis =0x02 , XAndYAxis =0x03 ,
  XandYAxis =XAndYAxis
}
 

Signals

void targetChanged ()
 
void minimumScaleChanged ()
 
void maximumScaleChanged ()
 
void minimumRotationChanged ()
 
void maximumRotationChanged ()
 
void dragAxisChanged ()
 
void minimumXChanged ()
 
void maximumXChanged ()
 
void minimumYChanged ()
 
void maximumYChanged ()
 
void activeChanged ()
 
- 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.
 

Public Member Functions

 QQuickPinch ()
 \qmltype PinchEvent \instantiates QQuickPinchEvent \inqmlmodule QtQuick
 
QQuickItemtarget () const
 
void setTarget (QQuickItem *target)
 
void resetTarget ()
 
qreal minimumScale () const
 
void setMinimumScale (qreal s)
 
qreal maximumScale () const
 
void setMaximumScale (qreal s)
 
qreal minimumRotation () const
 
void setMinimumRotation (qreal r)
 
qreal maximumRotation () const
 
void setMaximumRotation (qreal r)
 
Axis axis () const
 
void setAxis (Axis a)
 
qreal xmin () const
 
void setXmin (qreal x)
 
qreal xmax () const
 
void setXmax (qreal x)
 
qreal ymin () const
 
void setYmin (qreal y)
 
qreal ymax () const
 
void setYmax (qreal y)
 
bool active () const
 
void setActive (bool a)
 
- 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

QQuickItemtarget
 
qreal minimumScale
 
qreal maximumScale
 
qreal minimumRotation
 
qreal maximumRotation
 
Axis dragAxis
 
qreal minimumX
 
qreal maximumX
 
qreal minimumY
 
qreal maximumY
 
bool active
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Additional Inherited Members

- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 
- 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 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

Definition at line 24 of file qquickpincharea_p.h.

Member Enumeration Documentation

◆ Axis

Enumerator
NoDrag 
XAxis 
YAxis 
XAndYAxis 
XandYAxis 

Definition at line 89 of file qquickpincharea_p.h.

Constructor & Destructor Documentation

◆ QQuickPinch()

QT_BEGIN_NAMESPACE QQuickPinch::QQuickPinch ( )

\qmltype PinchEvent \instantiates QQuickPinchEvent \inqmlmodule QtQuick

For specifying information about a pinch event.

{The PinchEvent type was added in QtQuick 1.1}

The center, startCenter, previousCenter properties provide the center position between the two touch points.

The scale and previousScale properties provide the scale factor.

The angle, previousAngle and rotation properties provide the angle between the two points and the amount of rotation.

The point1, point2, startPoint1, startPoint2 properties provide the positions of the touch points.

The accepted property may be set to false in the onPinchStarted handler if the gesture should not be handled.

See also
PinchArea

\qmlproperty QPointF QtQuick::PinchEvent::center \qmlproperty QPointF QtQuick::PinchEvent::startCenter \qmlproperty QPointF QtQuick::PinchEvent::previousCenter

These properties hold the position of the center point between the two touch points.

\list

  • center is the current center point
  • previousCenter is the center point of the previous event.
  • startCenter is the center point when the gesture began \endlist

\qmlproperty real QtQuick::PinchEvent::scale \qmlproperty real QtQuick::PinchEvent::previousScale

These properties hold the scale factor determined by the change in distance between the two touch points.

\list

  • scale is the current scale factor.
  • previousScale is the scale factor of the previous event. \endlist

When a pinch gesture is started, the scale is 1.0.

\qmlproperty real QtQuick::PinchEvent::angle \qmlproperty real QtQuick::PinchEvent::previousAngle \qmlproperty real QtQuick::PinchEvent::rotation

These properties hold the angle between the two touch points.

\list

  • angle is the current angle between the two points in the range -180 to 180.
  • previousAngle is the angle of the previous event.
  • rotation is the total rotation since the pinch gesture started. \endlist

When a pinch gesture is started, the rotation is 0.0.

\qmlproperty QPointF QtQuick::PinchEvent::point1 \qmlproperty QPointF QtQuick::PinchEvent::startPoint1 \qmlproperty QPointF QtQuick::PinchEvent::point2 \qmlproperty QPointF QtQuick::PinchEvent::startPoint2

These properties provide the actual touch points generating the pinch.

\list

  • point1 and point2 hold the current positions of the points.
  • startPoint1 and startPoint2 hold the positions of the points when the second point was touched. \endlist

\qmlproperty bool QtQuick::PinchEvent::accepted

Setting this property to false in the PinchArea::onPinchStarted handler will result in no further pinch events being generated, and the gesture ignored.

\qmlproperty int QtQuick::PinchEvent::pointCount

Holds the number of points currently touched. The PinchArea will not react until two touch points have initited a gesture, but will remain active until all touch points have been released.

Definition at line 119 of file qquickpincharea.cpp.

Member Function Documentation

◆ active()

bool QQuickPinch::active ( ) const
inline

Definition at line 128 of file qquickpincharea_p.h.

References m_active.

◆ activeChanged

void QQuickPinch::activeChanged ( )
signal

◆ axis()

Axis QQuickPinch::axis ( ) const
inline

Definition at line 91 of file qquickpincharea_p.h.

◆ dragAxisChanged

void QQuickPinch::dragAxisChanged ( )
signal

◆ maximumRotation()

qreal QQuickPinch::maximumRotation ( ) const
inline

Definition at line 81 of file qquickpincharea_p.h.

◆ maximumRotationChanged

void QQuickPinch::maximumRotationChanged ( )
signal

◆ maximumScale()

qreal QQuickPinch::maximumScale ( ) const
inline

Definition at line 66 of file qquickpincharea_p.h.

◆ maximumScaleChanged

void QQuickPinch::maximumScaleChanged ( )
signal

◆ maximumXChanged

void QQuickPinch::maximumXChanged ( )
signal

◆ maximumYChanged

void QQuickPinch::maximumYChanged ( )
signal

◆ minimumRotation()

qreal QQuickPinch::minimumRotation ( ) const
inline

Definition at line 74 of file qquickpincharea_p.h.

◆ minimumRotationChanged

void QQuickPinch::minimumRotationChanged ( )
signal

◆ minimumScale()

qreal QQuickPinch::minimumScale ( ) const
inline

Definition at line 59 of file qquickpincharea_p.h.

◆ minimumScaleChanged

void QQuickPinch::minimumScaleChanged ( )
signal

◆ minimumXChanged

void QQuickPinch::minimumXChanged ( )
signal

◆ minimumYChanged

void QQuickPinch::minimumYChanged ( )
signal

◆ resetTarget()

void QQuickPinch::resetTarget ( )
inline

Definition at line 52 of file qquickpincharea_p.h.

References Q_EMIT.

◆ setActive()

void QQuickPinch::setActive ( bool a)
inline

Definition at line 129 of file qquickpincharea_p.h.

References m_active, and Q_EMIT.

◆ setAxis()

void QQuickPinch::setAxis ( Axis a)
inline

Definition at line 92 of file qquickpincharea_p.h.

References Q_EMIT.

◆ setMaximumRotation()

void QQuickPinch::setMaximumRotation ( qreal r)
inline

Definition at line 82 of file qquickpincharea_p.h.

References Q_EMIT.

◆ setMaximumScale()

void QQuickPinch::setMaximumScale ( qreal s)
inline

Definition at line 67 of file qquickpincharea_p.h.

References Q_EMIT.

◆ setMinimumRotation()

void QQuickPinch::setMinimumRotation ( qreal r)
inline

Definition at line 75 of file qquickpincharea_p.h.

References Q_EMIT.

◆ setMinimumScale()

void QQuickPinch::setMinimumScale ( qreal s)
inline

Definition at line 60 of file qquickpincharea_p.h.

References Q_EMIT.

◆ setTarget()

void QQuickPinch::setTarget ( QQuickItem * target)
inline

Definition at line 46 of file qquickpincharea_p.h.

References Q_EMIT.

◆ setXmax()

void QQuickPinch::setXmax ( qreal x)
inline

Definition at line 107 of file qquickpincharea_p.h.

References Q_EMIT.

◆ setXmin()

void QQuickPinch::setXmin ( qreal x)
inline

Definition at line 100 of file qquickpincharea_p.h.

References Q_EMIT.

◆ setYmax()

void QQuickPinch::setYmax ( qreal y)
inline

Definition at line 121 of file qquickpincharea_p.h.

References Q_EMIT.

◆ setYmin()

void QQuickPinch::setYmin ( qreal y)
inline

Definition at line 114 of file qquickpincharea_p.h.

References Q_EMIT.

◆ target()

QQuickItem * QQuickPinch::target ( ) const
inline

Definition at line 45 of file qquickpincharea_p.h.

◆ targetChanged

void QQuickPinch::targetChanged ( )
signal

◆ xmax()

qreal QQuickPinch::xmax ( ) const
inline

Definition at line 106 of file qquickpincharea_p.h.

◆ xmin()

qreal QQuickPinch::xmin ( ) const
inline

Definition at line 99 of file qquickpincharea_p.h.

◆ ymax()

qreal QQuickPinch::ymax ( ) const
inline

Definition at line 120 of file qquickpincharea_p.h.

◆ ymin()

qreal QQuickPinch::ymin ( ) const
inline

Definition at line 113 of file qquickpincharea_p.h.

Property Documentation

◆ active

bool QQuickPinch::active
read

Definition at line 38 of file qquickpincharea_p.h.

◆ dragAxis

Axis QQuickPinch::dragAxis
readwrite

Definition at line 33 of file qquickpincharea_p.h.

◆ maximumRotation

qreal QQuickPinch::maximumRotation
readwrite

Definition at line 32 of file qquickpincharea_p.h.

◆ maximumScale

qreal QQuickPinch::maximumScale
readwrite

Definition at line 30 of file qquickpincharea_p.h.

◆ maximumX

qreal QQuickPinch::maximumX
readwrite

Definition at line 35 of file qquickpincharea_p.h.

◆ maximumY

qreal QQuickPinch::maximumY
readwrite

Definition at line 37 of file qquickpincharea_p.h.

◆ minimumRotation

qreal QQuickPinch::minimumRotation
readwrite

Definition at line 31 of file qquickpincharea_p.h.

◆ minimumScale

qreal QQuickPinch::minimumScale
readwrite

Definition at line 29 of file qquickpincharea_p.h.

◆ minimumX

qreal QQuickPinch::minimumX
readwrite

Definition at line 34 of file qquickpincharea_p.h.

◆ minimumY

qreal QQuickPinch::minimumY
readwrite

Definition at line 36 of file qquickpincharea_p.h.

◆ target

QQuickItem * QQuickPinch::target
readwrite

Definition at line 28 of file qquickpincharea_p.h.

Referenced by QQuickPinchArea::event().


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