diff options
author | Mitch Curtis <mitch.curtis@qt.io> | 2020-11-09 18:49:09 +0100 |
---|---|---|
committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2021-01-05 15:29:12 +0000 |
commit | 5a7483f42f611f5af748955965b3ee7e76a72a34 (patch) | |
tree | f5e055224d7b1bc9cb6ba1e5c3e790a5c6208fd8 /src | |
parent | bd2129e3f2adf9c6b3dd77e4f382cf9db13dcd7d (diff) |
Doc: mention that Item's childrenRect property is local to the item
As opposed to being local to the item's parent.
Change-Id: Idcf2cdbedcac24a6890ce761c3f2a23f2c7a8dc4
Reviewed-by: Laszlo Agocs <laszlo.agocs@qt.io>
(cherry picked from commit a0769549cdb81c7104b60c2a67dfa62e8c42c224)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
Diffstat (limited to 'src')
-rw-r--r-- | src/quick/doc/snippets/qml/item/childrenRect.qml | 68 | ||||
-rw-r--r-- | src/quick/items/qquickitem.cpp | 8 |
2 files changed, 76 insertions, 0 deletions
diff --git a/src/quick/doc/snippets/qml/item/childrenRect.qml b/src/quick/doc/snippets/qml/item/childrenRect.qml new file mode 100644 index 0000000000..769633dc2a --- /dev/null +++ b/src/quick/doc/snippets/qml/item/childrenRect.qml @@ -0,0 +1,68 @@ +/**************************************************************************** +** +** Copyright (C) 2020 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:BSD$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** BSD License Usage +** Alternatively, you may use this file under the terms of the BSD license +** as follows: +** +** "Redistribution and use in source and binary forms, with or without +** modification, are permitted provided that the following conditions are +** met: +** * Redistributions of source code must retain the above copyright +** notice, this list of conditions and the following disclaimer. +** * Redistributions in binary form must reproduce the above copyright +** notice, this list of conditions and the following disclaimer in +** the documentation and/or other materials provided with the +** distribution. +** * Neither the name of The Qt Company Ltd nor the names of its +** contributors may be used to endorse or promote products derived +** from this software without specific prior written permission. +** +** +** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +import QtQuick 2.0 + +//! [local] +Item { + x: 50 + y: 100 + + // prints: QRectF(-10, -20, 30, 40) + Component.onCompleted: print(childrenRect) + + Item { + x: -10 + y: -20 + width: 30 + height: 40 + } +} +//! [local] diff --git a/src/quick/items/qquickitem.cpp b/src/quick/items/qquickitem.cpp index b5f58c7712..38e83e08ff 100644 --- a/src/quick/items/qquickitem.cpp +++ b/src/quick/items/qquickitem.cpp @@ -3673,6 +3673,10 @@ QQmlListProperty<QObject> QQuickItemPrivate::data() This property is useful if you need to access the collective geometry of an item's children in order to correctly size the item. + + The geometry that is returned is local to the item. For example: + + \snippet qml/item/childrenRect.qml local */ /*! \property QQuickItem::childrenRect @@ -3682,6 +3686,10 @@ QQmlListProperty<QObject> QQuickItemPrivate::data() This property is useful if you need to access the collective geometry of an item's children in order to correctly size the item. + + The geometry that is returned is local to the item. For example: + + \snippet qml/item/childrenRect.qml local */ QRectF QQuickItem::childrenRect() { |