aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--src/imports/controls/doc/images/qtlabscontrols-applicationwindow-wireframe.pngbin0 -> 5283 bytes
-rw-r--r--src/imports/controls/doc/images/qtlabscontrols-frame.pngbin0 -> 5301 bytes
-rw-r--r--src/imports/controls/doc/images/qtlabscontrols-groupbox.pngbin0 -> 7669 bytes
-rw-r--r--src/imports/controls/doc/images/qtlabscontrols-toolbar.pngbin0 -> 4073 bytes
-rw-r--r--src/imports/controls/doc/src/qtlabscontrols-containers.qdoc87
-rw-r--r--src/templates/qquickapplicationwindow.cpp6
-rw-r--r--src/templates/qquickcontainer.cpp3
-rw-r--r--src/templates/qquickframe.cpp17
-rw-r--r--src/templates/qquickgroupbox.cpp20
-rw-r--r--src/templates/qquickstackview.cpp3
-rw-r--r--src/templates/qquickswipeview.cpp3
-rw-r--r--src/templates/qquicktabbar.cpp3
-rw-r--r--src/templates/qquicktoolbar.cpp8
-rw-r--r--tests/auto/snippets/data/qtlabscontrols-frame.qml14
-rw-r--r--tests/auto/snippets/data/qtlabscontrols-groupbox.qml15
-rw-r--r--tests/auto/snippets/data/qtlabscontrols-toolbar.qml18
16 files changed, 161 insertions, 36 deletions
diff --git a/src/imports/controls/doc/images/qtlabscontrols-applicationwindow-wireframe.png b/src/imports/controls/doc/images/qtlabscontrols-applicationwindow-wireframe.png
new file mode 100644
index 00000000..d45ae400
--- /dev/null
+++ b/src/imports/controls/doc/images/qtlabscontrols-applicationwindow-wireframe.png
Binary files differ
diff --git a/src/imports/controls/doc/images/qtlabscontrols-frame.png b/src/imports/controls/doc/images/qtlabscontrols-frame.png
new file mode 100644
index 00000000..b844781c
--- /dev/null
+++ b/src/imports/controls/doc/images/qtlabscontrols-frame.png
Binary files differ
diff --git a/src/imports/controls/doc/images/qtlabscontrols-groupbox.png b/src/imports/controls/doc/images/qtlabscontrols-groupbox.png
new file mode 100644
index 00000000..511f2ffd
--- /dev/null
+++ b/src/imports/controls/doc/images/qtlabscontrols-groupbox.png
Binary files differ
diff --git a/src/imports/controls/doc/images/qtlabscontrols-toolbar.png b/src/imports/controls/doc/images/qtlabscontrols-toolbar.png
new file mode 100644
index 00000000..ee535b1a
--- /dev/null
+++ b/src/imports/controls/doc/images/qtlabscontrols-toolbar.png
Binary files differ
diff --git a/src/imports/controls/doc/src/qtlabscontrols-containers.qdoc b/src/imports/controls/doc/src/qtlabscontrols-containers.qdoc
new file mode 100644
index 00000000..30fa618f
--- /dev/null
+++ b/src/imports/controls/doc/src/qtlabscontrols-containers.qdoc
@@ -0,0 +1,87 @@
+/****************************************************************************
+**
+** 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-containers.html
+ \title Containers
+
+ Qt Labs Controls offers a selection of container-like controls.
+
+ \annotatedlist qtlabscontrols-containers
+
+ Each type of container can be used to group a set of controls together.
+ The following sections offer guidelines for choosing the appropriate type
+ of container, depending on the use case.
+
+ \section1 ApplicationWindow
+
+ \image qtlabscontrols-applicationwindow-wireframe.png
+
+ \l {Qt.labs.controls::ApplicationWindow}{ApplicationWindow} contains
+ optional header and footer items.
+
+ \section1 Frame
+
+ \image qtlabscontrols-frame.png
+
+ \l {Qt.labs.controls::Frame}{Frame} is used to layout a logical group of
+ controls together, within a visual frame.
+
+ \section1 GroupBox
+
+ \image qtlabscontrols-groupbox.png
+
+ \l {Qt.labs.controls::GroupBox}{GroupBox} is used to layout a logical
+ group of controls together, within a titled visual frame.
+
+ \section1 StackView
+
+ \image qtlabscontrols-stackview-wireframe.png
+
+ \l {Qt.labs.controls::StackView}{StackView} organizes content pages into
+ a stack.
+
+ \section1 SwipeView
+
+ \image qtlabscontrols-swipeview-wireframe.png
+
+ \l {Qt.labs.controls::SwipeView}{SwipeView} organizes content pages into
+ a swipable strip.
+
+ \section1 TabBar
+
+ \image qtlabscontrols-tabbar-wireframe.png
+
+ \l {Qt.labs.controls::TabBar}{TabBar} organizes content pages into tabs.
+
+ \section1 ToolBar
+
+ \image qtlabscontrols-toolbar.png
+
+ \l {Qt.labs.controls::ToolBar}{ToolBar} is a container of application-wide
+ and context-sensitive actions and controls.
+*/
diff --git a/src/templates/qquickapplicationwindow.cpp b/src/templates/qquickapplicationwindow.cpp
index cb56bddf..b668d0e1 100644
--- a/src/templates/qquickapplicationwindow.cpp
+++ b/src/templates/qquickapplicationwindow.cpp
@@ -46,13 +46,17 @@ QT_BEGIN_NAMESPACE
\inherits Window
\instantiates QQuickApplicationWindow
\inqmlmodule Qt.labs.controls
- \ingroup application
+ \ingroup qtlabscontrols-containers
\brief Provides a top-level application window.
ApplicationWindow is a \l Window which makes it convenient to add
a \l header and \l footer item to the window.
+ \image qtlabscontrols-applicationwindow-wireframe.png
+
\note By default, an ApplicationWindow is not visible.
+
+ \sa Containers
*/
class QQuickApplicationWindowPrivate : public QQuickItemChangeListener
diff --git a/src/templates/qquickcontainer.cpp b/src/templates/qquickcontainer.cpp
index f4653027..aeba8ecd 100644
--- a/src/templates/qquickcontainer.cpp
+++ b/src/templates/qquickcontainer.cpp
@@ -44,9 +44,12 @@ QT_BEGIN_NAMESPACE
\inherits Control
\instantiates QQuickContainer
\inqmlmodule Qt.labs.controls
+ \ingroup qtlabscontrols-containers
\brief A container control base type.
Container is the base type of container-like user interface controls.
+
+ \sa Containers
*/
QQuickContainerPrivate::QQuickContainerPrivate() : contentModel(Q_NULLPTR), currentIndex(-1)
diff --git a/src/templates/qquickframe.cpp b/src/templates/qquickframe.cpp
index 7dafa8c5..04837b79 100644
--- a/src/templates/qquickframe.cpp
+++ b/src/templates/qquickframe.cpp
@@ -44,7 +44,7 @@ QT_BEGIN_NAMESPACE
\inherits Control
\instantiates QQuickFrame
\inqmlmodule Qt.labs.controls
- \ingroup containers
+ \ingroup qtlabscontrols-containers
\brief A frame control.
Frame is used to layout a logical group of controls together, within a
@@ -56,20 +56,11 @@ QT_BEGIN_NAMESPACE
implicit size of its contained item. This makes it particularly suitable
for use together with layouts.
- ### TODO: screenshot
+ \image qtlabscontrols-frame.png
- \code
- Frame {
- ColumnLayout {
- anchors.fill: parent
- CheckBox { text: qsTr("E-mail") }
- CheckBox { text: qsTr("Calendar") }
- CheckBox { text: qsTr("Contacts") }
- }
- }
- \endcode
+ \snippet qtlabscontrols-frame.qml 1
- \sa {Customizing Frame}
+ \sa {Customizing Frame}, Containers
*/
QQuickFramePrivate::QQuickFramePrivate() : contentWidth(0), contentHeight(0), frame(Q_NULLPTR)
diff --git a/src/templates/qquickgroupbox.cpp b/src/templates/qquickgroupbox.cpp
index 30cede12..21f81b15 100644
--- a/src/templates/qquickgroupbox.cpp
+++ b/src/templates/qquickgroupbox.cpp
@@ -44,7 +44,7 @@ QT_BEGIN_NAMESPACE
\inherits Frame
\instantiates QQuickGroupBox
\inqmlmodule Qt.labs.controls
- \ingroup containers
+ \ingroup qtlabscontrols-containers
\brief A group box control.
GroupBox is used to layout a logical group of controls together, within
@@ -56,21 +56,11 @@ QT_BEGIN_NAMESPACE
implicit size of its contained item. This makes it particularly suitable
for use together with layouts.
- ### TODO: screenshot
-
- \code
- GroupBox {
- title: qsTr("Synchronize")
- ColumnLayout {
- anchors.fill: parent
- CheckBox { text: qsTr("E-mail") }
- CheckBox { text: qsTr("Calendar") }
- CheckBox { text: qsTr("Contacts") }
- }
- }
- \endcode
+ \image qtlabscontrols-groupbox.png
- \sa {Customizing GroupBox}
+ \snippet qtlabscontrols-groupbox.qml 1
+
+ \sa {Customizing GroupBox}, Containers
*/
class QQuickGroupBoxPrivate : public QQuickFramePrivate
diff --git a/src/templates/qquickstackview.cpp b/src/templates/qquickstackview.cpp
index 8fbff8f7..19ca9916 100644
--- a/src/templates/qquickstackview.cpp
+++ b/src/templates/qquickstackview.cpp
@@ -49,6 +49,7 @@ QT_BEGIN_NAMESPACE
\instantiates QQuickStackView
\inqmlmodule Qt.labs.controls
\ingroup qtlabscontrols-navigation
+ \ingroup qtlabscontrols-containers
\brief Provides a stack-based navigation model.
\image qtlabscontrols-stackview-wireframe.png
@@ -256,7 +257,7 @@ QT_BEGIN_NAMESPACE
}
\endqml
- \sa {Customizing StackView}, Navigation
+ \sa {Customizing StackView}, Navigation, Containers
*/
QQuickStackView::QQuickStackView(QQuickItem *parent) :
diff --git a/src/templates/qquickswipeview.cpp b/src/templates/qquickswipeview.cpp
index bbe51f52..ec949a03 100644
--- a/src/templates/qquickswipeview.cpp
+++ b/src/templates/qquickswipeview.cpp
@@ -46,6 +46,7 @@ QT_BEGIN_NAMESPACE
\instantiates QQuickSwipeView
\inqmlmodule Qt.labs.controls
\ingroup qtlabscontrols-navigation
+ \ingroup qtlabscontrols-containers
\brief A swipe view control.
SwipeView provides a swipe-based navigation model.
@@ -66,7 +67,7 @@ QT_BEGIN_NAMESPACE
\l {Container::moveItem()}{move}, and \l {Container::removeItem()}{remove}
pages dynamically at run time.
- \sa TabBar, PageIndicator, {Customizing SwipeView}, Navigation
+ \sa TabBar, PageIndicator, {Customizing SwipeView}, Navigation, Containers
*/
class QQuickSwipeViewPrivate : public QQuickContainerPrivate
diff --git a/src/templates/qquicktabbar.cpp b/src/templates/qquicktabbar.cpp
index 5eaf9f83..f859ae3c 100644
--- a/src/templates/qquicktabbar.cpp
+++ b/src/templates/qquicktabbar.cpp
@@ -46,6 +46,7 @@ QT_BEGIN_NAMESPACE
\instantiates QQuickTabBar
\inqmlmodule Qt.labs.controls
\ingroup qtlabscontrols-navigation
+ \ingroup qtlabscontrols-containers
\brief A tab bar control.
TabBar provides a tab-based navigation model.
@@ -58,7 +59,7 @@ QT_BEGIN_NAMESPACE
\snippet qtlabscontrols-tabbar.qml 1
- \sa TabButton, {Customizing TabBar}, Navigation
+ \sa TabButton, {Customizing TabBar}, Navigation, Containers
*/
class QQuickTabBarPrivate : public QQuickContainerPrivate
diff --git a/src/templates/qquicktoolbar.cpp b/src/templates/qquicktoolbar.cpp
index 256a6856..a1c06317 100644
--- a/src/templates/qquicktoolbar.cpp
+++ b/src/templates/qquicktoolbar.cpp
@@ -43,7 +43,7 @@ QT_BEGIN_NAMESPACE
\inherits Frame
\instantiates QQuickToolBar
\inqmlmodule Qt.labs.controls
- \ingroup containers
+ \ingroup qtlabscontrols-containers
\brief A tool bar control.
ToolBar is a container of application-wide and context sensitive
@@ -57,7 +57,7 @@ QT_BEGIN_NAMESPACE
implicit size of its contained item. This makes it particularly suitable
for use together with layouts.
- ### TODO: screenshot
+ \image qtlabscontrols-toolbar.png
\code
ApplicationWindow {
@@ -67,7 +67,7 @@ QT_BEGIN_NAMESPACE
RowLayout {
anchors.fill: parent
ToolButton {
- text: qsTr("< %1").arg(Qt.application.name)
+ text: qsTr("\u25C0 %1").arg(Qt.application.name)
enabled: stack.depth > 1
onClicked: stack.pop()
}
@@ -86,7 +86,7 @@ QT_BEGIN_NAMESPACE
}
\endcode
- \sa ApplicationWindow, ToolButton, {Customizing ToolBar}
+ \sa ApplicationWindow, ToolButton, {Customizing ToolBar}, Containers
*/
QQuickToolBar::QQuickToolBar(QQuickItem *parent) :
diff --git a/tests/auto/snippets/data/qtlabscontrols-frame.qml b/tests/auto/snippets/data/qtlabscontrols-frame.qml
new file mode 100644
index 00000000..123f391c
--- /dev/null
+++ b/tests/auto/snippets/data/qtlabscontrols-frame.qml
@@ -0,0 +1,14 @@
+import QtQuick 2.0
+import QtQuick.Layouts 1.0
+import Qt.labs.controls 1.0
+
+//! [1]
+Frame {
+ ColumnLayout {
+ anchors.fill: parent
+ CheckBox { text: qsTr("E-mail") }
+ CheckBox { text: qsTr("Calendar") }
+ CheckBox { text: qsTr("Contacts") }
+ }
+}
+//! [1]
diff --git a/tests/auto/snippets/data/qtlabscontrols-groupbox.qml b/tests/auto/snippets/data/qtlabscontrols-groupbox.qml
new file mode 100644
index 00000000..e62dafd1
--- /dev/null
+++ b/tests/auto/snippets/data/qtlabscontrols-groupbox.qml
@@ -0,0 +1,15 @@
+import QtQuick 2.0
+import QtQuick.Layouts 1.0
+import Qt.labs.controls 1.0
+
+//! [1]
+GroupBox {
+ title: qsTr("Synchronize")
+ ColumnLayout {
+ anchors.fill: parent
+ CheckBox { text: qsTr("E-mail") }
+ CheckBox { text: qsTr("Calendar") }
+ CheckBox { text: qsTr("Contacts") }
+ }
+}
+//! [1]
diff --git a/tests/auto/snippets/data/qtlabscontrols-toolbar.qml b/tests/auto/snippets/data/qtlabscontrols-toolbar.qml
new file mode 100644
index 00000000..305321d3
--- /dev/null
+++ b/tests/auto/snippets/data/qtlabscontrols-toolbar.qml
@@ -0,0 +1,18 @@
+import QtQuick 2.0
+import QtQuick.Layouts 1.0
+import Qt.labs.controls 1.0
+
+ToolBar {
+ RowLayout {
+ anchors.fill: parent
+ ToolButton {
+ text: qsTr("\u25C0 Qt")
+ onClicked: stack.pop()
+ }
+ Item { Layout.fillWidth: true }
+ Switch {
+ checked: true
+ text: qsTr("Notifications")
+ }
+ }
+}