From 2e8419e43ce4d5be64bddf1b5b5f5ea9e28c55de Mon Sep 17 00:00:00 2001 From: David Boddie Date: Wed, 1 Sep 2010 12:32:07 +0200 Subject: Doc: More work on QML documentation and snippets. --- doc/src/images/qml-flow-snippet.png | Bin 10385 -> 11465 bytes doc/src/images/qml-flow-text1.png | Bin 0 -> 9647 bytes doc/src/images/qml-flow-text2.png | Bin 0 -> 10870 bytes doc/src/snippets/declarative/flow-diagram.qml | 75 +++++++++++++++++++++ doc/src/snippets/declarative/flow.qml | 4 +- doc/src/snippets/declarative/grid/grid-spacing.qml | 2 + .../graphicsitems/qdeclarativepositioners.cpp | 11 +-- 7 files changed, 86 insertions(+), 6 deletions(-) create mode 100644 doc/src/images/qml-flow-text1.png create mode 100644 doc/src/images/qml-flow-text2.png create mode 100644 doc/src/snippets/declarative/flow-diagram.qml diff --git a/doc/src/images/qml-flow-snippet.png b/doc/src/images/qml-flow-snippet.png index 1a2af4b..af873d1 100644 Binary files a/doc/src/images/qml-flow-snippet.png and b/doc/src/images/qml-flow-snippet.png differ diff --git a/doc/src/images/qml-flow-text1.png b/doc/src/images/qml-flow-text1.png new file mode 100644 index 0000000..99ce752 Binary files /dev/null and b/doc/src/images/qml-flow-text1.png differ diff --git a/doc/src/images/qml-flow-text2.png b/doc/src/images/qml-flow-text2.png new file mode 100644 index 0000000..844e0de Binary files /dev/null and b/doc/src/images/qml-flow-text2.png differ diff --git a/doc/src/snippets/declarative/flow-diagram.qml b/doc/src/snippets/declarative/flow-diagram.qml new file mode 100644 index 0000000..80506b9 --- /dev/null +++ b/doc/src/snippets/declarative/flow-diagram.qml @@ -0,0 +1,75 @@ +/**************************************************************************** +** +** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies). +** All rights reserved. +** Contact: Nokia Corporation (qt-info@nokia.com) +** +** This file is part of the QtDeclarative module of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:BSD$ +** 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 Nokia Corporation and its Subsidiary(-ies) 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 Qt 4.7 + +Rectangle { + color: "lightblue" + width: 300; height: 200 + +//! [flow item] + Flow { + anchors.fill: parent + anchors.margins: 4 + spacing: 10 + + Repeater { + id: repeater + model: { + var strings = ["Text", "items", "flowing", "inside", "a", + "Flow", "item"]; + strings; + } + + Rectangle { + color: "white" + width: textItem.width + 4 + height: textItem.height + 4 + Text { + id: textItem + anchors.horizontalCenter: parent.horizontalCenter + text: repeater.model[index] + font.pixelSize: 40 + } + } + } + } +//! [flow item] +} diff --git a/doc/src/snippets/declarative/flow.qml b/doc/src/snippets/declarative/flow.qml index c5fbc90..77db683 100644 --- a/doc/src/snippets/declarative/flow.qml +++ b/doc/src/snippets/declarative/flow.qml @@ -38,6 +38,7 @@ ** ****************************************************************************/ +//! [document] import Qt 4.7 Rectangle { @@ -53,10 +54,11 @@ Rectangle { Text { text: "Text"; font.pixelSize: 40 } Text { text: "items"; font.pixelSize: 40 } Text { text: "flowing"; font.pixelSize: 40 } - Text { text: "in"; font.pixelSize: 40 } + Text { text: "inside"; font.pixelSize: 40 } Text { text: "a"; font.pixelSize: 40 } Text { text: "Flow"; font.pixelSize: 40 } Text { text: "item"; font.pixelSize: 40 } } //! [flow item] } +//! [document] diff --git a/doc/src/snippets/declarative/grid/grid-spacing.qml b/doc/src/snippets/declarative/grid/grid-spacing.qml index 5099758..8715977 100644 --- a/doc/src/snippets/declarative/grid/grid-spacing.qml +++ b/doc/src/snippets/declarative/grid/grid-spacing.qml @@ -38,6 +38,7 @@ ** ****************************************************************************/ +//! [document] import Qt 4.7 Rectangle { @@ -56,3 +57,4 @@ Rectangle { Rectangle { color: "#6666aa"; width: 50; height: 50 } } } +//! [document] diff --git a/src/declarative/graphicsitems/qdeclarativepositioners.cpp b/src/declarative/graphicsitems/qdeclarativepositioners.cpp index b653282..149e822 100644 --- a/src/declarative/graphicsitems/qdeclarativepositioners.cpp +++ b/src/declarative/graphicsitems/qdeclarativepositioners.cpp @@ -649,13 +649,14 @@ void QDeclarativeRow::reportConflictingAnchors() The Grid item positions its child items so that they are aligned in a grid and are not overlapping. + The grid positioner calculates a grid of rectangular cells of sufficient + size to hold all items, placing the items in the cells, from left to right + and top to bottom. Each item is positioned in the top-left corner of its + cell with position (0, 0). + A Grid defaults to four columns, and as many rows as are necessary to fit all child items. The number of rows and columns can be constrained - by setting the \l rows and \l columns properties. The grid positioner - calculates a grid of rectangular cells of sufficient size to hold all - items, placing the items in the cells, from left to right and top to - bottom. Each item is positioned in the top-left corner of its cell - with position (0, 0). + by setting the \l rows and \l columns properties. Spacing can be added between child items by setting the \l spacing property. The amount of spacing applied will be the same in the -- cgit v0.12