Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QQuickMultiPointTouchArea Class Reference

#include <qquickmultipointtoucharea_p.h>

+ Inheritance diagram for QQuickMultiPointTouchArea:
+ Collaboration diagram for QQuickMultiPointTouchArea:

Signals

void pressed (const QList< QObject * > &points)
 
void updated (const QList< QObject * > &points)
 
void released (const QList< QObject * > &points)
 
void canceled (const QList< QObject * > &points)
 
void gestureStarted (QQuickGrabGestureEvent *gesture)
 
void touchUpdated (const QList< QObject * > &points)
 
void minimumTouchPointsChanged ()
 
void maximumTouchPointsChanged ()
 
void mouseEnabledChanged ()
 
- Signals inherited from QQuickItem
void childrenRectChanged (const QRectF &)
 
void baselineOffsetChanged (qreal)
 
void stateChanged (const QString &)
 
void focusChanged (bool)
 
void activeFocusChanged (bool)
 
Q_REVISION(6, 7) void focusPolicyChanged(Qt Q_REVISION (2, 1) void activeFocusOnTabChanged(bool)
 
void parentChanged (QQuickItem *)
 
void transformOriginChanged (TransformOrigin)
 
void smoothChanged (bool)
 
void antialiasingChanged (bool)
 
void clipChanged (bool)
 
 Q_REVISION (2, 1) void windowChanged(QQuickWindow *window)
 
void childrenChanged ()
 
void opacityChanged ()
 
void enabledChanged ()
 
void visibleChanged ()
 
void visibleChildrenChanged ()
 
void rotationChanged ()
 
void scaleChanged ()
 
void xChanged ()
 
void yChanged ()
 
void widthChanged ()
 
void heightChanged ()
 
void zChanged ()
 
void implicitWidthChanged ()
 
void implicitHeightChanged ()
 
 Q_REVISION (2, 11) void containmentMaskChanged()
 
 Q_REVISION (6, 0) void paletteChanged()
 
 Q_REVISION (6, 0) void paletteCreated()
 
- 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

 QQuickMultiPointTouchArea (QQuickItem *parent=nullptr)
 \qmltype GestureEvent \nativetype QQuickGrabGestureEvent \inqmlmodule QtQuick
 
 ~QQuickMultiPointTouchArea ()
 
int minimumTouchPoints () const
 \qmlproperty int QtQuick::MultiPointTouchArea::minimumTouchPoints \qmlproperty int QtQuick::MultiPointTouchArea::maximumTouchPoints
 
void setMinimumTouchPoints (int num)
 
int maximumTouchPoints () const
 
void setMaximumTouchPoints (int num)
 
bool mouseEnabled () const
 
void setMouseEnabled (bool arg)
 \qmlproperty bool QtQuick::MultiPointTouchArea::mouseEnabled
 
QQmlListProperty< QQuickTouchPointtouchPoints ()
 
- Public Member Functions inherited from QQuickItem
 QQuickItem (QQuickItem *parent=nullptr)
 Constructs a QQuickItem with the given parent.
 
 ~QQuickItem () override
 Destroys the QQuickItem.
 
QQuickWindowwindow () const
 Returns the window in which this item is rendered.
 
QQuickItemparentItem () const
 
void setParentItem (QQuickItem *parent)
 
void stackBefore (const QQuickItem *)
 Moves the specified sibling item to the index before this item within the list of children.
 
void stackAfter (const QQuickItem *)
 Moves the specified sibling item to the index after this item within the list of children.
 
QRectF childrenRect ()
 \qmlpropertygroup QtQuick::Item::childrenRect \qmlproperty real QtQuick::Item::childrenRect.x \qmlproperty real QtQuick::Item::childrenRect.y \qmlproperty real QtQuick::Item::childrenRect.width \qmlproperty real QtQuick::Item::childrenRect.height \readonly
 
QList< QQuickItem * > childItems () const
 Returns the children of this item.
 
bool clip () const
 \qmlproperty bool QtQuick::Item::clip This property holds whether clipping is enabled.
 
void setClip (bool)
 
QString state () const
 \qmlproperty string QtQuick::Item::state
 
void setState (const QString &)
 
qreal baselineOffset () const
 \qmlproperty int QtQuick::Item::baselineOffset
 
void setBaselineOffset (qreal)
 
QQmlListProperty< QQuickTransformtransform ()
 
qreal x () const
 
qreal y () const
 
QPointF position () const
 
void setX (qreal)
 
void setY (qreal)
 
void setPosition (const QPointF &)
 
QBindable< qrealbindableX ()
 
QBindable< qrealbindableY ()
 
qreal width () const
 
void setWidth (qreal)
 
void resetWidth ()
 
void setImplicitWidth (qreal)
 
qreal implicitWidth () const
 Returns the width of the item that is implied by other properties that determine the content.
 
QBindable< qrealbindableWidth ()
 
qreal height () const
 
void setHeight (qreal)
 
void resetHeight ()
 
void setImplicitHeight (qreal)
 
qreal implicitHeight () const
 
QBindable< qrealbindableHeight ()
 
QSizeF size () const
 
void setSize (const QSizeF &size)
 
TransformOrigin transformOrigin () const
 
void setTransformOrigin (TransformOrigin)
 
QPointF transformOriginPoint () const
 
void setTransformOriginPoint (const QPointF &)
 
qreal z () const
 
void setZ (qreal)
 
qreal rotation () const
 
void setRotation (qreal)
 
qreal scale () const
 
void setScale (qreal)
 
qreal opacity () const
 
void setOpacity (qreal)
 
bool isVisible () const
 
void setVisible (bool)
 
bool isEnabled () const
 
void setEnabled (bool)
 
bool smooth () const
 
void setSmooth (bool)
 
bool activeFocusOnTab () const
 \qmlproperty bool QtQuick::Item::activeFocusOnTab
 
void setActiveFocusOnTab (bool)
 
bool antialiasing () const
 
void setAntialiasing (bool)
 
void resetAntialiasing ()
 
Flags flags () const
 Returns the item flags for this item.
 
void setFlag (Flag flag, bool enabled=true)
 Enables the specified flag for this item if enabled is true; if enabled is false, the flag is disabled.
 
void setFlags (Flags flags)
 Enables the specified flags for this item.
 
virtual QRectF boundingRect () const
 Returns the extents of the item in its own coordinate system: a rectangle from {0, 0} to \l width() and \l height().
 
virtual QRectF clipRect () const
 Returns the rectangular area within this item that is currently visible in \l viewportItem(), if there is a viewport and the \l ItemObservesViewport flag is set; otherwise, the extents of this item in its own coordinate system: a rectangle from {0, 0} to \l width() and \l height().
 
QQuickItemviewportItem () const
 If the \l ItemObservesViewport flag is set, returns the nearest parent with the \l ItemIsViewport flag.
 
bool hasActiveFocus () const
 
bool hasFocus () const
 
void setFocus (bool)
 
void setFocus (bool focus, Qt::FocusReason reason)
 
bool isFocusScope () const
 Returns true if this item is a focus scope, and false otherwise.
 
QQuickItemscopedFocusItem () const
 If this item is a focus scope, this returns the item in its focus chain that currently has focus.
 
Qt::FocusPolicy focusPolicy () const
 
void setFocusPolicy (Qt::FocusPolicy policy)
 Sets the focus policy of this item to policy.
 
bool isAncestorOf (const QQuickItem *child) const
 Returns true if this item is an ancestor of child (i.e., if this item is child's parent, or one of child's parent's ancestors).
 
Qt::MouseButtons acceptedMouseButtons () const
 Returns the mouse buttons accepted by this item.
 
void setAcceptedMouseButtons (Qt::MouseButtons buttons)
 Sets the mouse buttons accepted by this item to buttons.
 
bool acceptHoverEvents () const
 Returns whether hover events are accepted by this item.
 
void setAcceptHoverEvents (bool enabled)
 If enabled is true, this sets the item to accept hover events; otherwise, hover events are not accepted by this item.
 
bool acceptTouchEvents () const
 Returns whether touch events are accepted by this item.
 
void setAcceptTouchEvents (bool accept)
 If enabled is true, this sets the item to accept touch events; otherwise, touch events are not accepted by this item.
 
bool isUnderMouse () const
 
void grabMouse ()
 
void ungrabMouse ()
 
bool keepMouseGrab () const
 Returns whether mouse input should exclusively remain with this item.
 
void setKeepMouseGrab (bool)
 Sets whether the mouse input should remain exclusively with this item.
 
bool filtersChildMouseEvents () const
 Returns whether pointer events intended for this item's children should be filtered through this item.
 
void setFiltersChildMouseEvents (bool filter)
 Sets whether pointer events intended for this item's children should be filtered through this item.
 
void grabTouchPoints (const QList< int > &ids)
 
void ungrabTouchPoints ()
 
bool keepTouchGrab () const
 Returns whether the touch points grabbed by this item should exclusively remain with this item.
 
void setKeepTouchGrab (bool)
 Sets whether the touch points grabbed by this item should remain exclusively with this item.
 
 Q_REVISION (2, 4) Q_INVOKABLE bool grabToImage(const QJSValue &callback
 
QSharedPointer< QQuickItemGrabResultgrabToImage (const QSize &targetSize=QSize())
 Grabs the item into an in-memory image.
 
virtual Q_INVOKABLE bool contains (const QPointF &point) const
 \qmlmethod bool QtQuick::Item::contains(point point)
 
QObjectcontainmentMask () const
 
void setContainmentMask (QObject *mask)
 
QTransform itemTransform (QQuickItem *, bool *) const
 \qmlmethod point QtQuick::Item::mapFromItem(Item item, real x, real y) \qmlmethod point QtQuick::Item::mapFromItem(Item item, point p) \qmlmethod rect QtQuick::Item::mapFromItem(Item item, real x, real y, real width, real height) \qmlmethod rect QtQuick::Item::mapFromItem(Item item, rect r)
 
QPointF mapToScene (const QPointF &point) const
 Maps the given point in this item's coordinate system to the equivalent point within the scene's coordinate system, and returns the mapped coordinate.
 
QRectF mapRectToItem (const QQuickItem *item, const QRectF &rect) const
 Maps the given rect in this item's coordinate system to the equivalent rectangular area within item's coordinate system, and returns the mapped rectangle value.
 
QRectF mapRectToScene (const QRectF &rect) const
 Maps the given rect in this item's coordinate system to the equivalent rectangular area within the scene's coordinate system, and returns the mapped rectangle value.
 
QPointF mapFromScene (const QPointF &point) const
 Maps the given point in the scene's coordinate system to the equivalent point within this item's coordinate system, and returns the mapped coordinate.
 
QRectF mapRectFromItem (const QQuickItem *item, const QRectF &rect) const
 Maps the given rect in item's coordinate system to the equivalent rectangular area within this item's coordinate system, and returns the mapped rectangle value.
 
QRectF mapRectFromScene (const QRectF &rect) const
 Maps the given rect in the scene's coordinate system to the equivalent rectangular area within this item's coordinate system, and returns the mapped rectangle value.
 
void polish ()
 Schedules a polish event for this item.
 
Q_INVOKABLE QPointF mapFromItem (const QQuickItem *item, const QPointF &point) const
 Maps the given point in item's coordinate system to the equivalent point within this item's coordinate system, and returns the mapped coordinate.
 
Q_INVOKABLE QPointF mapFromItem (const QQuickItem *item, qreal x, qreal y)
 
Q_INVOKABLE QRectF mapFromItem (const QQuickItem *item, const QRectF &rect) const
 
Q_INVOKABLE QRectF mapFromItem (const QQuickItem *item, qreal x, qreal y, qreal width, qreal height) const
 
Q_INVOKABLE QPointF mapToItem (const QQuickItem *item, const QPointF &point) const
 Maps the given point in this item's coordinate system to the equivalent point within item's coordinate system, and returns the mapped coordinate.
 
Q_INVOKABLE QPointF mapToItem (const QQuickItem *item, qreal x, qreal y)
 
Q_INVOKABLE QRectF mapToItem (const QQuickItem *item, const QRectF &rect) const
 
Q_INVOKABLE QRectF mapToItem (const QQuickItem *item, qreal x, qreal y, qreal width, qreal height) const
 
 Q_REVISION (2, 7) Q_INVOKABLE QPointF mapFromGlobal(qreal x
 
 Q_REVISION (2, 7) Q_INVOKABLE QPointF mapFromGlobal(const QPointF &point) const
 
 Q_REVISION (2, 7) Q_INVOKABLE QPointF mapToGlobal(qreal x
 
 Q_REVISION (2, 7) Q_INVOKABLE QPointF mapToGlobal(const QPointF &point) const
 
Q_INVOKABLE void forceActiveFocus ()
 \qmlmethod point QtQuick::Item::mapToItem(Item item, real x, real y) \qmlmethod point QtQuick::Item::mapToItem(Item item, point p) \qmlmethod rect QtQuick::Item::mapToItem(Item item, real x, real y, real width, real height) \qmlmethod rect QtQuick::Item::mapToItem(Item item, rect r)
 
Q_INVOKABLE void forceActiveFocus (Qt::FocusReason reason)
 \qmlmethod QtQuick::Item::forceActiveFocus(Qt::FocusReason reason) This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Forces active focus on the item with the given reason.
 
 Q_REVISION (2, 1) Q_INVOKABLE QQuickItem *nextItemInFocusChain(bool forward
 
Q_INVOKABLE QQuickItemchildAt (qreal x, qreal y) const
 \qmlmethod QtQuick::Item::childAt(real x, real y)
 
 Q_REVISION (6, 3) Q_INVOKABLE void ensurePolished()
 
 Q_REVISION (6, 3) Q_INVOKABLE void dumpItemTree() const
 
virtual bool isTextureProvider () const
 Returns true if this item is a texture provider.
 
virtual QSGTextureProvidertextureProvider () const
 Returns the texture provider for an item.
 
- 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 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.
 
- Public Member Functions inherited from QQmlParserStatus
 QQmlParserStatus ()
 
virtual ~QQmlParserStatus ()
 

Static Public Member Functions

static void touchPoint_append (QQmlListProperty< QQuickTouchPoint > *list, QQuickTouchPoint *touch)
 
static qsizetype touchPoint_count (QQmlListProperty< QQuickTouchPoint > *list)
 
static QQuickTouchPointtouchPoint_at (QQmlListProperty< QQuickTouchPoint > *list, qsizetype index)
 
- 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 Types

enum class  RemapEventPoints { No , ToLocal }
 

Protected Member Functions

void touchEvent (QTouchEvent *) override
 This event handler can be reimplemented in a subclass to receive touch events for an item.
 
bool childMouseEventFilter (QQuickItem *receiver, QEvent *event) override
 Reimplement this method to filter the pointer events that are received by this item's children.
 
void mousePressEvent (QMouseEvent *event) override
 This event handler can be reimplemented in a subclass to receive mouse press events for an item.
 
void mouseReleaseEvent (QMouseEvent *event) override
 This event handler can be reimplemented in a subclass to receive mouse release events for an item.
 
void mouseMoveEvent (QMouseEvent *event) override
 This event handler can be reimplemented in a subclass to receive mouse move events for an item.
 
void mouseUngrabEvent () override
 This event handler can be reimplemented in a subclass to be notified when a mouse ungrab event has occurred on this item.
 
void touchUngrabEvent () override
 This event handler can be reimplemented in a subclass to be notified when a touch ungrab event has occurred on this item.
 
void addTouchPrototype (QQuickTouchPoint *prototype)
 
void addTouchPoint (const QEventPoint *p)
 
void addTouchPoint (const QMouseEvent *e)
 
void clearTouchLists ()
 
void updateTouchPoint (QQuickTouchPoint *, const QEventPoint *)
 
void updateTouchPoint (QQuickTouchPoint *dtp, const QMouseEvent *e)
 
void updateTouchData (QEvent *, RemapEventPoints remap=RemapEventPoints::No)
 
bool sendMouseEvent (QMouseEvent *event)
 
bool shouldFilter (QEvent *event)
 
void grabGesture (QPointingDevice *dev)
 
QSGNodeupdatePaintNode (QSGNode *, UpdatePaintNodeData *) override
 Called on the render thread when it is time to sync the state of the item with the scene graph.
 
- Protected Member Functions inherited from QQuickItem
bool event (QEvent *) override
 \reimp
 
bool isComponentComplete () const
 Returns true if construction of the QML component is complete; otherwise returns false.
 
virtual void itemChange (ItemChange, const ItemChangeData &)
 Called when change occurs for this item.
 
virtual void geometryChange (const QRectF &newGeometry, const QRectF &oldGeometry)
 
bool widthValid () const
 Returns whether the width property has been set explicitly.
 
bool heightValid () const
 Returns whether the height property has been set explicitly.
 
void setImplicitSize (qreal, qreal)
 
void classBegin () override
 \reimp Derived classes should call the base class method before adding their own action to perform at classBegin.
 
void componentComplete () override
 \reimp Derived classes should call the base class method before adding their own actions to perform at componentComplete.
 
virtual void keyPressEvent (QKeyEvent *event)
 This event handler can be reimplemented in a subclass to receive key press events for an item.
 
virtual void keyReleaseEvent (QKeyEvent *event)
 This event handler can be reimplemented in a subclass to receive key release events for an item.
 
virtual void focusInEvent (QFocusEvent *)
 This event handler can be reimplemented in a subclass to receive focus-in events for an item.
 
virtual void focusOutEvent (QFocusEvent *)
 This event handler can be reimplemented in a subclass to receive focus-out events for an item.
 
virtual void mouseDoubleClickEvent (QMouseEvent *event)
 This event handler can be reimplemented in a subclass to receive mouse double-click events for an item.
 
virtual void hoverEnterEvent (QHoverEvent *event)
 This event handler can be reimplemented in a subclass to receive hover-enter events for an item.
 
virtual void hoverMoveEvent (QHoverEvent *event)
 This event handler can be reimplemented in a subclass to receive hover-move events for an item.
 
virtual void hoverLeaveEvent (QHoverEvent *event)
 This event handler can be reimplemented in a subclass to receive hover-leave events for an item.
 
virtual void releaseResources ()
 This function is called when an item should release graphics resources which are not already managed by the nodes returned from QQuickItem::updatePaintNode().
 
virtual void updatePolish ()
 This function should perform any layout as required for this item.
 
 QQuickItem (QQuickItemPrivate &dd, QQuickItem *parent=nullptr)
 
- 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)
 

Properties

QQmlListProperty< QQuickTouchPointtouchPoints
 
int minimumTouchPoints
 
int maximumTouchPoints
 
bool mouseEnabled
 
- Properties inherited from QQuickItem
QQuickItemparent
 \qmlproperty Item QtQuick::Item::parent This property holds the visual parent of the item.
 
qreal x
 \qmlproperty real QtQuick::Item::x \qmlproperty real QtQuick::Item::y \qmlproperty real QtQuick::Item::width \qmlproperty real QtQuick::Item::height
 
qreal y
 Defines the item's y position relative to its parent.
 
qreal z
 \qmlproperty real QtQuick::Item::z
 
qreal width
 This property holds the width of this item.
 
qreal height
 This property holds the height of this item.
 
qreal opacity
 \qmlproperty real QtQuick::Item::opacity
 
bool enabled
 \qmlproperty bool QtQuick::Item::enabled
 
bool visible
 \qmlproperty bool QtQuick::Item::visible
 
Qt::FocusPolicy focusPolicy
 \qmlproperty enumeration QtQuick::Item::focusPolicy
 
qreal rotation
 \qmlproperty real QtQuick::Item::rotation This property holds the rotation of the item in degrees clockwise around its transformOrigin.
 
qreal scale
 \qmlproperty real QtQuick::Item::scale This property holds the scale factor for this item.
 
TransformOrigin transformOrigin
 \qmlproperty enumeration QtQuick::Item::transformOrigin This property holds the origin point around which scale and rotation transform.
 
QPointF transformOriginPoint
 
QQmlListProperty< QQuickTransformtransform
 \qmlproperty list<Transform> QtQuick::Item::transform This property holds the list of transformations to apply.
 
bool smooth
 \qmlproperty bool QtQuick::Item::smooth
 
bool antialiasing
 \qmlproperty bool QtQuick::Item::antialiasing
 
qreal implicitWidth
 
qreal implicitHeight
 
QObjectcontainmentMask
 \qmlproperty QObject* QtQuick::Item::containmentMask
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Additional Inherited Members

- Public Types inherited from QQuickItem
enum  Flag {
  ItemClipsChildrenToShape = 0x01 , ItemIsFocusScope = 0x04 , ItemHasContents = 0x08 , ItemAcceptsDrops = 0x10 ,
  ItemIsViewport = 0x20 , ItemObservesViewport = 0x40
}
 \qmltype Item \nativetype QQuickItem \inherits QtObject \inqmlmodule QtQuick More...
 
enum  ItemChange {
  ItemChildAddedChange , ItemChildRemovedChange , ItemSceneChange , ItemVisibleHasChanged ,
  ItemParentHasChanged , ItemOpacityHasChanged , ItemActiveFocusHasChanged , ItemRotationHasChanged ,
  ItemAntialiasingHasChanged , ItemDevicePixelRatioHasChanged , ItemEnabledHasChanged , ItemScaleHasChanged ,
  ItemTransformHasChanged
}
 Used in conjunction with QQuickItem::itemChange() to notify the item about certain types of changes. More...
 
enum  TransformOrigin {
  TopLeft , Top , TopRight , Left ,
  Center , Right , BottomLeft , Bottom ,
  BottomRight
}
 \variable QQuickItem::ItemChangeData::realValue The numeric value that has changed: \l {QQuickItem::opacity()}{opacity}, \l {QQuickItem::rotation()}{rotation}, or \l {QQuickItem::scale()}{scale}, or \l {QScreen::devicePixelRatio}{device pixel ratio}. More...
 
- Public Slots inherited from QQuickItem
void update ()
 Schedules a call to updatePaintNode() for this item.
 
- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 
- Public Attributes inherited from QQuickItem
const QSizetargetSize = QSize())
 
qreal y const
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr
 

Detailed Description

Definition at line 181 of file qquickmultipointtoucharea_p.h.

Member Enumeration Documentation

◆ RemapEventPoints

enum class QQuickMultiPointTouchArea::RemapEventPoints
strongprotected
Enumerator
No 
ToLocal 

Definition at line 261 of file qquickmultipointtoucharea_p.h.

Constructor & Destructor Documentation

◆ QQuickMultiPointTouchArea()

QQuickMultiPointTouchArea::QQuickMultiPointTouchArea ( QQuickItem * parent = nullptr)

\qmltype GestureEvent \nativetype QQuickGrabGestureEvent \inqmlmodule QtQuick

The parameter given with the gestureStarted signal.

The GestureEvent object has the current touch points, which you may choose to interpret as a gesture, and an invokable method to grab the involved points exclusively.

\qmlproperty real QtQuick::GestureEvent::dragThreshold

This property holds the system setting for the distance a finger must move before it is interpreted as a drag. It comes from QStyleHints::startDragDistance().

\qmlproperty list<TouchPoint> QtQuick::GestureEvent::touchPoints

This property holds the set of current touch points.

\qmlmethod QtQuick::GestureEvent::grab()

Acquires an exclusive grab of the mouse and all the \l touchPoints, and calls \l {QQuickItem::setKeepTouchGrab()}{setKeepTouchGrab()} and \l {QQuickItem::setKeepMouseGrab()}{setKeepMouseGrab()} so that any parent Item that \l {QQuickItem::filtersChildMouseEvents()}{filters} its children's events will not be allowed to take over the grabs.

\qmltype MultiPointTouchArea \nativetype QQuickMultiPointTouchArea \inqmlmodule QtQuick \inherits Item

Enables handling of multiple touch points.

A MultiPointTouchArea is an invisible item that is used to track multiple touch points.

The \l Item::enabled property is used to enable and disable touch handling. When disabled, the touch area becomes transparent to mouse and touch events.

By default, the mouse will be handled the same way as a single touch point, and items under the touch area will not receive mouse events because the touch area is handling them. But if the \l mouseEnabled property is set to false, it becomes transparent to mouse events so that another mouse-sensitive Item (such as a MouseArea) can be used to handle mouse interaction separately.

MultiPointTouchArea can be used in two ways:

\list

  • setting touchPoints to provide touch point objects with properties that can be bound to
  • using the onTouchUpdated or onPressed, onUpdated and onReleased handlers \endlist

While a MultiPointTouchArea can take exclusive ownership of certain touch points, it is also possible to have multiple MultiPointTouchAreas active at the same time, each operating on a different set of touch points.

See also
TouchPoint

\qmlsignal QtQuick::MultiPointTouchArea::pressed(list<TouchPoint> touchPoints)

This signal is emitted when new touch points are added. touchPoints is a list of these new points.

If minimumTouchPoints is set to a value greater than one, this signal will not be emitted until the minimum number of required touch points has been reached.

Note
If you use the touchPoints argument in your signal handler code, it's best to rename it in your formal parameter to avoid confusion with the touchPoints property (see \l{QML Coding Conventions}): \qml onPressed: (points) => console.log("pressed", points.length) \endqml

\qmlsignal QtQuick::MultiPointTouchArea::updated(list<TouchPoint> touchPoints)

This signal is emitted when existing touch points are updated. touchPoints is a list of these updated points.

Note
If you use the touchPoints argument in your signal handler code, it's best to rename it in your formal parameter to avoid confusion with the touchPoints property (see \l{QML Coding Conventions}): \qml onUpdated: (points) => console.log("updated", points.length) \endqml

\qmlsignal QtQuick::MultiPointTouchArea::released(list<TouchPoint> touchPoints)

This signal is emitted when existing touch points are removed. touchPoints is a list of these removed points.

Note
If you use the touchPoints argument in your signal handler code, it's best to rename it in your formal parameter to avoid confusion with the touchPoints property (see \l{QML Coding Conventions}): \qml onReleased: (points) => console.log("released", points.length) \endqml

\qmlsignal QtQuick::MultiPointTouchArea::canceled(list<TouchPoint> touchPoints)

This signal is emitted when new touch events have been canceled because another item stole the touch event handling.

This signal is for advanced use: it is useful when there is more than one MultiPointTouchArea that is handling input, or when there is a MultiPointTouchArea inside a \l Flickable. In the latter case, if you execute some logic in the onPressed signal handler and then start dragging, the \l Flickable may steal the touch handling from the MultiPointTouchArea. In these cases, to reset the logic when the MultiPointTouchArea has lost the touch handling to the \l Flickable, canceled should be handled in addition to \l released.

touchPoints is the list of canceled points.

Note
If you use the touchPoints argument in your signal handler code, it's best to rename it in your formal parameter to avoid confusion with the touchPoints property (see \l{QML Coding Conventions}): \qml onCanceled: (points) => console.log("canceled", points.length) \endqml

\qmlsignal QtQuick::MultiPointTouchArea::gestureStarted(GestureEvent gesture)

This signal is emitted when the global drag threshold has been reached.

This signal is typically used when a MultiPointTouchArea has been nested in a Flickable or another MultiPointTouchArea. When the threshold has been reached and the signal is handled, you can determine whether or not the touch area should grab the current touch points. By default they will not be grabbed; to grab them call gesture.grab(). If the gesture is not grabbed, the nesting Flickable, for example, would also have an opportunity to grab.

The gesture object also includes information on the current set of touchPoints and the dragThreshold.

\qmlsignal QtQuick::MultiPointTouchArea::touchUpdated(list<TouchPoint> touchPoints)

This signal is emitted when the touch points handled by the MultiPointTouchArea change. This includes adding new touch points, removing or canceling previous touch points, as well as updating current touch point data. touchPoints is the list of all current touch points.

\qmlproperty list<TouchPoint> QtQuick::MultiPointTouchArea::touchPoints

This property holds a set of user-defined touch point objects that can be bound to.

If mouseEnabled is true (the default) and the left mouse button is pressed while the mouse is over the touch area, the current mouse position will be one of these touch points.

In the following example, we have two small rectangles that follow our touch points.

import QtQuick
Rectangle {
width: 400; height: 400
MultiPointTouchArea {
anchors.fill: parent
touchPoints: [
TouchPoint { id: point1 },
TouchPoint { id: point2 }
]
}
Rectangle {
width: 30; height: 30
color: "green"
x: point1.x
y: point1.y
}
Rectangle {
width: 30; height: 30
color: "yellow"
x: point2.x
y: point2.y
}
}

By default this property holds an empty list.

See also
TouchPoint

Definition at line 430 of file qquickmultipointtoucharea.cpp.

◆ ~QQuickMultiPointTouchArea()

QQuickMultiPointTouchArea::~QQuickMultiPointTouchArea ( )

Definition at line 449 of file qquickmultipointtoucharea.cpp.

Member Function Documentation

◆ addTouchPoint() [1/2]

void QQuickMultiPointTouchArea::addTouchPoint ( const QEventPoint * p)
protected

Definition at line 708 of file qquickmultipointtoucharea.cpp.

◆ addTouchPoint() [2/2]

void QQuickMultiPointTouchArea::addTouchPoint ( const QMouseEvent * e)
protected

Definition at line 728 of file qquickmultipointtoucharea.cpp.

◆ addTouchPrototype()

void QQuickMultiPointTouchArea::addTouchPrototype ( QQuickTouchPoint * prototype)
protected

Definition at line 783 of file qquickmultipointtoucharea.cpp.

◆ canceled

void QQuickMultiPointTouchArea::canceled ( const QList< QObject * > & points)
signal

◆ childMouseEventFilter()

bool QQuickMultiPointTouchArea::childMouseEventFilter ( QQuickItem * item,
QEvent * event )
overrideprotectedvirtual

Reimplement this method to filter the pointer events that are received by this item's children.

This method will only be called if filtersChildMouseEvents() is true.

Return true if the specified event should not be passed on to the specified child item, and false otherwise. If you return true, you should also \l {QEvent::accept()}{accept} or \l {QEvent::ignore()}{ignore} the event, to signal if event propagation should stop or continue. The event will, however, always be sent to all childMouseEventFilters up the parent chain.

Note
Despite the name, this function filters all QPointerEvent instances during delivery to all children (typically mouse, touch, and tablet events). When overriding this function in a subclass, we suggest writing generic event-handling code using only the accessors found in QPointerEvent. Alternatively you can switch on event->type() and/or event->device()->type() to handle different event types in different ways.
Filtering is just one way to share responsibility in case of gestural ambiguity (for example on press, you don't know whether the user will tap or drag). Another way is to call QPointerEvent::addPassiveGrabber() on press, so as to non-exclusively monitor the progress of the QEventPoint. In either case, the item or pointer handler that is monitoring can steal the exclusive grab later on, when it becomes clear that the gesture fits the pattern that it is expecting.
See also
setFiltersChildMouseEvents()

Reimplemented from QQuickItem.

Definition at line 958 of file qquickmultipointtoucharea.cpp.

◆ clearTouchLists()

void QQuickMultiPointTouchArea::clearTouchLists ( )
protected

Definition at line 692 of file qquickmultipointtoucharea.cpp.

◆ gestureStarted

void QQuickMultiPointTouchArea::gestureStarted ( QQuickGrabGestureEvent * gesture)
signal

◆ grabGesture()

void QQuickMultiPointTouchArea::grabGesture ( QPointingDevice * dev)
protected

Definition at line 551 of file qquickmultipointtoucharea.cpp.

◆ maximumTouchPoints()

int QQuickMultiPointTouchArea::maximumTouchPoints ( ) const

Definition at line 489 of file qquickmultipointtoucharea.cpp.

◆ maximumTouchPointsChanged

void QQuickMultiPointTouchArea::maximumTouchPointsChanged ( )
signal

◆ minimumTouchPoints()

int QQuickMultiPointTouchArea::minimumTouchPoints ( ) const

\qmlproperty int QtQuick::MultiPointTouchArea::minimumTouchPoints \qmlproperty int QtQuick::MultiPointTouchArea::maximumTouchPoints

These properties hold the range of touch points to be handled by the touch area.

These are convenience that allow you to, for example, have nested MultiPointTouchAreas, one handling two finger touches, and another handling three finger touches.

By default, all touch points within the touch area are handled.

If mouseEnabled is true, the mouse acts as a touch point, so it is also subject to these constraints: for example if maximumTouchPoints is two, you can use the mouse as one touch point and a finger as another touch point for a total of two.

Definition at line 476 of file qquickmultipointtoucharea.cpp.

◆ minimumTouchPointsChanged

void QQuickMultiPointTouchArea::minimumTouchPointsChanged ( )
signal

◆ mouseEnabled()

bool QQuickMultiPointTouchArea::mouseEnabled ( ) const
inline

Definition at line 201 of file qquickmultipointtoucharea_p.h.

◆ mouseEnabledChanged

void QQuickMultiPointTouchArea::mouseEnabledChanged ( )
signal

◆ mouseMoveEvent()

void QQuickMultiPointTouchArea::mouseMoveEvent ( QMouseEvent * event)
overrideprotectedvirtual

This event handler can be reimplemented in a subclass to receive mouse move events for an item.

The event information is provided by the event parameter.

In order to receive mouse movement events, the preceding mouse press event must be accepted (by overriding \l mousePressEvent(), for example) and \l acceptedMouseButtons() must return the relevant mouse button.

\input item.qdocinc accepting-events

Reimplemented from QQuickItem.

Definition at line 843 of file qquickmultipointtoucharea.cpp.

◆ mousePressEvent()

void QQuickMultiPointTouchArea::mousePressEvent ( QMouseEvent * event)
overrideprotectedvirtual

This event handler can be reimplemented in a subclass to receive mouse press events for an item.

The event information is provided by the event parameter.

In order to receive mouse press events, \l acceptedMouseButtons() must return the relevant mouse button.

\input item.qdocinc accepting-events

Reimplemented from QQuickItem.

Definition at line 824 of file qquickmultipointtoucharea.cpp.

◆ mouseReleaseEvent()

void QQuickMultiPointTouchArea::mouseReleaseEvent ( QMouseEvent * event)
overrideprotectedvirtual

This event handler can be reimplemented in a subclass to receive mouse release events for an item.

The event information is provided by the event parameter.

In order to receive mouse release events, the preceding mouse press event must be accepted (by overriding \l mousePressEvent(), for example) and \l acceptedMouseButtons() must return the relevant mouse button.

\input item.qdocinc accepting-events

Reimplemented from QQuickItem.

Definition at line 857 of file qquickmultipointtoucharea.cpp.

◆ mouseUngrabEvent()

void QQuickMultiPointTouchArea::mouseUngrabEvent ( )
overrideprotectedvirtual

This event handler can be reimplemented in a subclass to be notified when a mouse ungrab event has occurred on this item.

Reimplemented from QQuickItem.

Definition at line 904 of file qquickmultipointtoucharea.cpp.

◆ pressed

void QQuickMultiPointTouchArea::pressed ( const QList< QObject * > & points)
signal

◆ released

void QQuickMultiPointTouchArea::released ( const QList< QObject * > & points)
signal

◆ sendMouseEvent()

bool QQuickMultiPointTouchArea::sendMouseEvent ( QMouseEvent * event)
protected

Definition at line 914 of file qquickmultipointtoucharea.cpp.

◆ setMaximumTouchPoints()

void QQuickMultiPointTouchArea::setMaximumTouchPoints ( int num)

Definition at line 494 of file qquickmultipointtoucharea.cpp.

◆ setMinimumTouchPoints()

void QQuickMultiPointTouchArea::setMinimumTouchPoints ( int num)

Definition at line 481 of file qquickmultipointtoucharea.cpp.

◆ setMouseEnabled()

void QQuickMultiPointTouchArea::setMouseEnabled ( bool arg)

\qmlproperty bool QtQuick::MultiPointTouchArea::mouseEnabled

This property controls whether the MultiPointTouchArea will handle mouse events too. If it is true (the default), the touch area will treat the mouse the same as a single touch point; if it is false, the touch area will ignore mouse events and allow them to "pass through" so that they can be handled by other items underneath.

Definition at line 511 of file qquickmultipointtoucharea.cpp.

◆ shouldFilter()

bool QQuickMultiPointTouchArea::shouldFilter ( QEvent * event)
protected

Definition at line 999 of file qquickmultipointtoucharea.cpp.

◆ touchEvent()

void QQuickMultiPointTouchArea::touchEvent ( QTouchEvent * event)
overrideprotectedvirtual

This event handler can be reimplemented in a subclass to receive touch events for an item.

The event information is provided by the event parameter.

\input item.qdocinc accepting-events

Reimplemented from QQuickItem.

Definition at line 521 of file qquickmultipointtoucharea.cpp.

◆ touchPoint_append()

static void QQuickMultiPointTouchArea::touchPoint_append ( QQmlListProperty< QQuickTouchPoint > * list,
QQuickTouchPoint * touch )
inlinestatic

Definition at line 208 of file qquickmultipointtoucharea_p.h.

◆ touchPoint_at()

static QQuickTouchPoint * QQuickMultiPointTouchArea::touchPoint_at ( QQmlListProperty< QQuickTouchPoint > * list,
qsizetype index )
inlinestatic

Definition at line 218 of file qquickmultipointtoucharea_p.h.

◆ touchPoint_count()

static qsizetype QQuickMultiPointTouchArea::touchPoint_count ( QQmlListProperty< QQuickTouchPoint > * list)
inlinestatic

Definition at line 213 of file qquickmultipointtoucharea_p.h.

◆ touchPoints()

QQmlListProperty< QQuickTouchPoint > QQuickMultiPointTouchArea::touchPoints ( )
inline

Definition at line 204 of file qquickmultipointtoucharea_p.h.

◆ touchUngrabEvent()

void QQuickMultiPointTouchArea::touchUngrabEvent ( )
overrideprotectedvirtual

This event handler can be reimplemented in a subclass to be notified when a touch ungrab event has occurred on this item.

Reimplemented from QQuickItem.

Definition at line 909 of file qquickmultipointtoucharea.cpp.

◆ touchUpdated

void QQuickMultiPointTouchArea::touchUpdated ( const QList< QObject * > & points)
signal

◆ updated

void QQuickMultiPointTouchArea::updated ( const QList< QObject * > & points)
signal

◆ updatePaintNode()

QSGNode * QQuickMultiPointTouchArea::updatePaintNode ( QSGNode * oldNode,
UpdatePaintNodeData * updatePaintNodeData )
overrideprotectedvirtual

Called on the render thread when it is time to sync the state of the item with the scene graph.

The function is called as a result of QQuickItem::update(), if the user has set the QQuickItem::ItemHasContents flag on the item.

The function should return the root of the scene graph subtree for this item. Most implementations will return a single QSGGeometryNode containing the visual representation of this item. oldNode is the node that was returned the last time the function was called. updatePaintNodeData provides a pointer to the QSGTransformNode associated with this QQuickItem.

QSGNode *MyItem::updatePaintNode(QSGNode *node, UpdatePaintNodeData *)
{
QSGSimpleRectNode *n = static_cast<QSGSimpleRectNode *>(node);
if (!n) {
n->setColor(Qt::red);
}
return n;
}
virtual QRectF boundingRect() const
Returns the extents of the item in its own coordinate system: a rectangle from {0,...
\group qtquick-scenegraph-nodes \title Qt Quick Scene Graph Node classes
Definition qsgnode.h:37
The QSGSimpleRectNode class is a convenience class for drawing solid filled rectangles using scenegra...
void setRect(const QRectF &rect)
Sets the rectangle of this rect node to rect.
@ red
Definition qnamespace.h:36
GLfloat n
[4]

The main thread is blocked while this function is executed so it is safe to read values from the QQuickItem instance and other objects in the main thread.

If no call to QQuickItem::updatePaintNode() result in actual scene graph changes, like QSGNode::markDirty() or adding and removing nodes, then the underlying implementation may decide to not render the scene again as the visual outcome is identical.

Warning
It is crucial that graphics operations and interaction with the scene graph happens exclusively on the render thread, primarily during the QQuickItem::updatePaintNode() call. The best rule of thumb is to only use classes with the "QSG" prefix inside the QQuickItem::updatePaintNode() function.
This function is called on the render thread. This means any QObjects or thread local storage that is created will have affinity to the render thread, so apply caution when doing anything other than rendering in this function. Similarly for signals, these will be emitted on the render thread and will thus often be delivered via queued connections.
Note
All classes with QSG prefix should be used solely on the scene graph's rendering thread. See \l {Scene Graph and Rendering} for more information.
See also
QSGMaterial, QSGGeometryNode, QSGGeometry, QSGFlatColorMaterial, QSGTextureMaterial, QSGNode::markDirty(), {Graphics Resource Handling}

Reimplemented from QQuickItem.

Definition at line 1038 of file qquickmultipointtoucharea.cpp.

◆ updateTouchData()

void QQuickMultiPointTouchArea::updateTouchData ( QEvent * event,
RemapEventPoints remap = RemapEventPoints::No )
protected

Definition at line 567 of file qquickmultipointtoucharea.cpp.

◆ updateTouchPoint() [1/2]

void QQuickMultiPointTouchArea::updateTouchPoint ( QQuickTouchPoint * dtp,
const QEventPoint * p )
protected

Definition at line 790 of file qquickmultipointtoucharea.cpp.

◆ updateTouchPoint() [2/2]

void QQuickMultiPointTouchArea::updateTouchPoint ( QQuickTouchPoint * dtp,
const QMouseEvent * e )
protected

Definition at line 811 of file qquickmultipointtoucharea.cpp.

Property Documentation

◆ maximumTouchPoints

int QQuickMultiPointTouchArea::maximumTouchPoints
readwrite

Definition at line 188 of file qquickmultipointtoucharea_p.h.

◆ minimumTouchPoints

int QQuickMultiPointTouchArea::minimumTouchPoints
readwrite

Definition at line 187 of file qquickmultipointtoucharea_p.h.

◆ mouseEnabled

bool QQuickMultiPointTouchArea::mouseEnabled
readwrite

Definition at line 189 of file qquickmultipointtoucharea_p.h.

◆ touchPoints

QQmlListProperty<QQuickTouchPoint> QQuickMultiPointTouchArea::touchPoints
read

Definition at line 186 of file qquickmultipointtoucharea_p.h.


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