From d3497470a848c958ffd69f45be0df3129bf2902d Mon Sep 17 00:00:00 2001 From: J-P Nurmi Date: Thu, 15 Oct 2015 14:41:10 +0200 Subject: Docs: Indicators group Change-Id: I092b50dd0f184523ec28e4145a4e6b1eab1c762a Reviewed-by: Mitch Curtis --- .../doc/images/qtlabscontrols-busyindicator.png | Bin 0 -> 2978 bytes .../doc/images/qtlabscontrols-pageindicator.png | Bin 0 -> 745 bytes .../doc/images/qtlabscontrols-scrollindicator.png | Bin 0 -> 400 bytes .../doc/src/qtlabscontrols-indicators.qdoc | 57 +++++++++++++++++++++ src/templates/qquickbusyindicator.cpp | 4 +- src/templates/qquickpageindicator.cpp | 15 ++---- src/templates/qquickprogressbar.cpp | 2 +- src/templates/qquickscrollbar.cpp | 1 - src/templates/qquickscrollindicator.cpp | 11 ++-- .../snippets/data/qtlabscontrols-busyindicator.qml | 5 ++ .../snippets/data/qtlabscontrols-pageindicator.qml | 17 ++++++ .../data/qtlabscontrols-scrollindicator.qml | 26 ++++++++++ 12 files changed, 118 insertions(+), 20 deletions(-) create mode 100644 src/imports/controls/doc/images/qtlabscontrols-busyindicator.png create mode 100644 src/imports/controls/doc/images/qtlabscontrols-pageindicator.png create mode 100644 src/imports/controls/doc/images/qtlabscontrols-scrollindicator.png create mode 100644 src/imports/controls/doc/src/qtlabscontrols-indicators.qdoc create mode 100644 tests/auto/snippets/data/qtlabscontrols-busyindicator.qml create mode 100644 tests/auto/snippets/data/qtlabscontrols-pageindicator.qml create mode 100644 tests/auto/snippets/data/qtlabscontrols-scrollindicator.qml diff --git a/src/imports/controls/doc/images/qtlabscontrols-busyindicator.png b/src/imports/controls/doc/images/qtlabscontrols-busyindicator.png new file mode 100644 index 00000000..12a8a4f8 Binary files /dev/null and b/src/imports/controls/doc/images/qtlabscontrols-busyindicator.png differ diff --git a/src/imports/controls/doc/images/qtlabscontrols-pageindicator.png b/src/imports/controls/doc/images/qtlabscontrols-pageindicator.png new file mode 100644 index 00000000..4bef41e6 Binary files /dev/null and b/src/imports/controls/doc/images/qtlabscontrols-pageindicator.png differ diff --git a/src/imports/controls/doc/images/qtlabscontrols-scrollindicator.png b/src/imports/controls/doc/images/qtlabscontrols-scrollindicator.png new file mode 100644 index 00000000..f1ab6107 Binary files /dev/null and b/src/imports/controls/doc/images/qtlabscontrols-scrollindicator.png differ diff --git a/src/imports/controls/doc/src/qtlabscontrols-indicators.qdoc b/src/imports/controls/doc/src/qtlabscontrols-indicators.qdoc new file mode 100644 index 00000000..d272f65b --- /dev/null +++ b/src/imports/controls/doc/src/qtlabscontrols-indicators.qdoc @@ -0,0 +1,57 @@ +/**************************************************************************** +** +** Copyright (C) 2015 The Qt Company Ltd. +** Contact: http://www.qt.io/licensing/ +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:FDL$ +** 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 http://www.qt.io/terms-conditions. For further +** information use the contact form at http://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: http://www.gnu.org/copyleft/fdl.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \page qtlabscontrols-indicators.html + \title Indicators + + \annotatedlist qtlabscontrols-indicators + + Qt Labs Controls offers a selection of indicator-like controls. Each type + of indicator has its own target use case. + + \section1 BusyIndicator + + \image qtlabscontrols-busyindicator.png + + \l {Qt.labs.controls::BusyIndicator}{BusyIndicator} should be used to + indicate activity. + + \section1 PageIndicator + + \image qtlabscontrols-pageindicator.png + + \l {Qt.labs.controls::PageIndicator}{PageIndicator} is used to indicate + the currently active page in a container of multiple pages. + + \section1 ScrollIndicator + + \image qtlabscontrols-scrollindicator.png + + \l {Qt.labs.controls::ScrollIndicator}{ScrollIndicator} indicates the + current scroll position in a \l Flickable. +*/ diff --git a/src/templates/qquickbusyindicator.cpp b/src/templates/qquickbusyindicator.cpp index 2c8f1f83..17dae838 100644 --- a/src/templates/qquickbusyindicator.cpp +++ b/src/templates/qquickbusyindicator.cpp @@ -44,7 +44,7 @@ QT_BEGIN_NAMESPACE \inherits Control \instantiates QQuickBusyIndicator \inqmlmodule Qt.labs.controls - \ingroup indicators + \ingroup qtlabscontrols-indicators \brief A busy indicator. \image qtlabscontrols-busyindicator.gif @@ -65,6 +65,8 @@ QT_BEGIN_NAMESPACE The default implementation uses this QML item as indicator: \snippet BusyIndicator.qml indicator + + \sa Indicators */ class QQuickBusyIndicatorPrivate : public QQuickControlPrivate diff --git a/src/templates/qquickpageindicator.cpp b/src/templates/qquickpageindicator.cpp index c3660cf4..90f75444 100644 --- a/src/templates/qquickpageindicator.cpp +++ b/src/templates/qquickpageindicator.cpp @@ -44,25 +44,18 @@ QT_BEGIN_NAMESPACE \inherits Control \instantiates QQuickPageIndicator \inqmlmodule Qt.labs.controls - \ingroup indicators + \ingroup qtlabscontrols-indicators \brief A page indicator control. PageIndicator is used to indicate the currently active page in a container of multiple pages. PageIndicator consists of delegate items that present pages. - ### TODO: screenshot + \image qtlabscontrols-pageindicator.png - \code - PageIndicator { - count: view.count - currentIndex: view.currentIndex - anchors.bottom: view.bottom - anchors.horizontalCenter: view.horizontalCenter - } - \endcode + \snippet qtlabscontrols-pageindicator.qml 1 - \sa SwipeView, {Customizing PageIndicator} + \sa SwipeView, {Customizing PageIndicator}, Indicators */ class QQuickPageIndicatorPrivate : public QQuickControlPrivate diff --git a/src/templates/qquickprogressbar.cpp b/src/templates/qquickprogressbar.cpp index a0dc2779..4113ba9a 100644 --- a/src/templates/qquickprogressbar.cpp +++ b/src/templates/qquickprogressbar.cpp @@ -44,7 +44,7 @@ QT_BEGIN_NAMESPACE \inherits Control \instantiates QQuickProgressBar \inqmlmodule Qt.labs.controls - \ingroup indicators + \ingroup qtlabscontrols-indicators \brief A progress bar control. ProgressBar indicates the progress of an operation. diff --git a/src/templates/qquickscrollbar.cpp b/src/templates/qquickscrollbar.cpp index 5211d95b..224e1bb4 100644 --- a/src/templates/qquickscrollbar.cpp +++ b/src/templates/qquickscrollbar.cpp @@ -47,7 +47,6 @@ QT_BEGIN_NAMESPACE \inherits Control \instantiates QQuickScrollBar \inqmlmodule Qt.labs.controls - \ingroup indicators \ingroup sliders \brief An interactive scroll bar control. diff --git a/src/templates/qquickscrollindicator.cpp b/src/templates/qquickscrollindicator.cpp index 23d1e480..89ddb602 100644 --- a/src/templates/qquickscrollindicator.cpp +++ b/src/templates/qquickscrollindicator.cpp @@ -47,19 +47,18 @@ QT_BEGIN_NAMESPACE \inherits Control \instantiates QQuickScrollIndicator \inqmlmodule Qt.labs.controls - \ingroup indicators + \ingroup qtlabscontrols-indicators \brief A non-interactive scroll indicator control. ScrollIndicator is a non-interactive indicator that indicates the current scroll position. A scroll indicator can be either \l vertical or \l horizontal, and can be attached to any \l Flickable, such as \l ListView and \l GridView. - ### TODO: screenshot + \image qtlabscontrols-scrollindicator.png \code - ListView { - model: 200 - delegate: Text { text: index } + Flickable { + // ... ScrollIndicator.vertical: ScrollIndicator { } } \endcode @@ -74,7 +73,7 @@ QT_BEGIN_NAMESPACE \li \l active \endlist - \sa ScrollBar, {Customizing ScrollIndicator} + \sa ScrollBar, {Customizing ScrollIndicator}, Indicators */ class QQuickScrollIndicatorPrivate : public QQuickControlPrivate diff --git a/tests/auto/snippets/data/qtlabscontrols-busyindicator.qml b/tests/auto/snippets/data/qtlabscontrols-busyindicator.qml new file mode 100644 index 00000000..3234d010 --- /dev/null +++ b/tests/auto/snippets/data/qtlabscontrols-busyindicator.qml @@ -0,0 +1,5 @@ +import QtQuick 2.0 +import Qt.labs.controls 1.0 + +BusyIndicator { +} diff --git a/tests/auto/snippets/data/qtlabscontrols-pageindicator.qml b/tests/auto/snippets/data/qtlabscontrols-pageindicator.qml new file mode 100644 index 00000000..18000654 --- /dev/null +++ b/tests/auto/snippets/data/qtlabscontrols-pageindicator.qml @@ -0,0 +1,17 @@ +import QtQuick 2.0 +import Qt.labs.controls 1.0 + +Rectangle { + width: 100 + height: 100 + border.color: Theme.frameColor + + //! [1] + PageIndicator { + count: 5 + currentIndex: 2 + anchors.horizontalCenter: parent.horizontalCenter + anchors.bottom: parent.bottom + } + //! [1] +} diff --git a/tests/auto/snippets/data/qtlabscontrols-scrollindicator.qml b/tests/auto/snippets/data/qtlabscontrols-scrollindicator.qml new file mode 100644 index 00000000..dff23c2a --- /dev/null +++ b/tests/auto/snippets/data/qtlabscontrols-scrollindicator.qml @@ -0,0 +1,26 @@ +import QtQuick 2.0 +import Qt.labs.controls 1.0 + +Rectangle { + width: 100 + height: 100 + border.color: Theme.frameColor + + ScrollIndicator { + size: 0.3 + position: 0.2 + active: true + orientation: Qt.Vertical + height: parent.height + anchors.right: parent.right + } + + ScrollIndicator { + size: 0.6 + position: 0.3 + active: true + orientation: Qt.Horizontal + width: parent.width + anchors.bottom: parent.bottom + } +} -- cgit v1.2.3