From bc0a1df9c18b0186a64c0c0b50670cc0d3542809 Mon Sep 17 00:00:00 2001 From: Mitch Curtis Date: Fri, 6 Jul 2018 12:36:44 +0200 Subject: Item, QQuickItem: document which properties are used in map functions Change-Id: Idf3aecf88319a2967ca51985003be32c7e7ef42a Reviewed-by: Laszlo Agocs --- src/quick/doc/src/includes/item.qdocinc | 6 ++++++ src/quick/items/qquickitem.cpp | 28 ++++++++++++++++++++++++++++ 2 files changed, 34 insertions(+) create mode 100644 src/quick/doc/src/includes/item.qdocinc (limited to 'src/quick') diff --git a/src/quick/doc/src/includes/item.qdocinc b/src/quick/doc/src/includes/item.qdocinc new file mode 100644 index 0000000000..12472cb928 --- /dev/null +++ b/src/quick/doc/src/includes/item.qdocinc @@ -0,0 +1,6 @@ +//! [mapping] + +The following properties of the item are used in the mapping: +\l x, \l y, \l scale, \l rotation, \l transformOrigin, and \l [QML]{Item::}{transform}. + +//! [mapping] diff --git a/src/quick/items/qquickitem.cpp b/src/quick/items/qquickitem.cpp index aed673d595..29b0ed10e6 100644 --- a/src/quick/items/qquickitem.cpp +++ b/src/quick/items/qquickitem.cpp @@ -4409,6 +4409,8 @@ void QQuickItem::polish() item's coordinate system, to this item's coordinate system, and returns a \l point or \l rect matching the mapped coordinate. + \input item.qdocinc mapping + If \a item is a \c null value, this maps the point or rect from the coordinate system of the root QML view. */ @@ -4497,6 +4499,8 @@ QTransform QQuickItem::itemTransform(QQuickItem *other, bool *ok) const item's coordinate system, to \a item's coordinate system, and returns a \l point or \l rect matching the mapped coordinate. + \input item.qdocinc mapping + If \a item is a \c null value, this maps the point or rect to the coordinate system of the root QML view. */ @@ -4566,6 +4570,8 @@ void QQuickItem::mapToItem(QQmlV4Function *args) const Maps the point (\a x, \a y), which is in the global coordinate system, to the item's coordinate system, and returns a \l point matching the mapped coordinate. + + \input item.qdocinc mapping */ /*! \internal @@ -4601,6 +4607,8 @@ void QQuickItem::mapFromGlobal(QQmlV4Function *args) const Maps the point (\a x, \a y), which is in this item's coordinate system, to the global coordinate system, and returns a \l point matching the mapped coordinate. + + \input item.qdocinc mapping */ /*! \internal @@ -7690,6 +7698,8 @@ void QQuickItem::setContainmentMask(QObject *mask) point within \a item's coordinate system, and returns the mapped coordinate. + \input item.qdocinc mapping + If \a item is 0, this maps \a point to the coordinate system of the scene. @@ -7708,6 +7718,8 @@ QPointF QQuickItem::mapToItem(const QQuickItem *item, const QPointF &point) cons point within the scene's coordinate system, and returns the mapped coordinate. + \input item.qdocinc mapping + \sa {Concepts - Visual Coordinates in Qt Quick} */ QPointF QQuickItem::mapToScene(const QPointF &point) const @@ -7721,6 +7733,8 @@ QPointF QQuickItem::mapToScene(const QPointF &point) const point within global screen coordinate system, and returns the mapped coordinate. + \input item.qdocinc mapping + For example, this may be helpful to add a popup to a Qt Quick component. \note Window positioning is done by the window manager and this value is @@ -7742,6 +7756,8 @@ QPointF QQuickItem::mapToGlobal(const QPointF &point) const rectangular area within \a item's coordinate system, and returns the mapped rectangle value. + \input item.qdocinc mapping + If \a item is 0, this maps \a rect to the coordinate system of the scene. @@ -7761,6 +7777,8 @@ QRectF QQuickItem::mapRectToItem(const QQuickItem *item, const QRectF &rect) con rectangular area within the scene's coordinate system, and returns the mapped rectangle value. + \input item.qdocinc mapping + \sa {Concepts - Visual Coordinates in Qt Quick} */ QRectF QQuickItem::mapRectToScene(const QRectF &rect) const @@ -7774,6 +7792,8 @@ QRectF QQuickItem::mapRectToScene(const QRectF &rect) const point within this item's coordinate system, and returns the mapped coordinate. + \input item.qdocinc mapping + If \a item is 0, this maps \a point from the coordinate system of the scene. @@ -7790,6 +7810,8 @@ QPointF QQuickItem::mapFromItem(const QQuickItem *item, const QPointF &point) co point within this item's coordinate system, and returns the mapped coordinate. + \input item.qdocinc mapping + \sa {Concepts - Visual Coordinates in Qt Quick} */ QPointF QQuickItem::mapFromScene(const QPointF &point) const @@ -7803,6 +7825,8 @@ QPointF QQuickItem::mapFromScene(const QPointF &point) const equivalent point within this item's coordinate system, and returns the mapped coordinate. + \input item.qdocinc mapping + For example, this may be helpful to add a popup to a Qt Quick component. \note Window positioning is done by the window manager and this value is @@ -7824,6 +7848,8 @@ QPointF QQuickItem::mapFromGlobal(const QPointF &point) const rectangular area within this item's coordinate system, and returns the mapped rectangle value. + \input item.qdocinc mapping + If \a item is 0, this maps \a rect from the coordinate system of the scene. @@ -7842,6 +7868,8 @@ QRectF QQuickItem::mapRectFromItem(const QQuickItem *item, const QRectF &rect) c rectangular area within this item's coordinate system, and returns the mapped rectangle value. + \input item.qdocinc mapping + \sa {Concepts - Visual Coordinates in Qt Quick} */ QRectF QQuickItem::mapRectFromScene(const QRectF &rect) const -- cgit v1.2.3