diff options
author | Jens Bache-Wiig <jens.bache-wiig@digia.com> | 2013-05-15 16:30:05 +0200 |
---|---|---|
committer | The Qt Project <gerrit-noreply@qt-project.org> | 2013-05-16 07:57:45 +0200 |
commit | bb7ba4d62d3084c5448b9012e4a618c02395b087 (patch) | |
tree | 38f81e2b2cb8234e403dc1487f12bcf51ff75fb1 | |
parent | caaeec4755f07c0b12afce7340324d049a3d1d3d (diff) | |
download | qtquickcontrols-bb7ba4d62d3084c5448b9012e4a618c02395b087.tar.gz |
Improve top-level index page for documentation
- Adds Menus to the front page so that we
can actually find essential types like Menu and Action.
- Added a basic example for Action
- I also added ExclusiveGroup to the Controls
category to make it accessible.
Change-Id: Ife980b786870d2bf07d709e024cb97396870e6c7
Reviewed-by: Gabriel de Dietrich <gabriel.dedietrich@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
-rw-r--r-- | src/controls/Menu.qml | 4 | ||||
-rw-r--r-- | src/controls/MenuBar.qml | 2 | ||||
-rw-r--r-- | src/controls/doc/src/indicators.qdoc | 31 | ||||
-rw-r--r-- | src/controls/doc/src/menus.qdoc | 2 | ||||
-rw-r--r-- | src/controls/doc/src/navigation.qdoc | 31 | ||||
-rw-r--r-- | src/controls/doc/src/qtquickcontrols-index.qdoc | 4 | ||||
-rw-r--r-- | src/controls/qquickaction.cpp | 14 | ||||
-rw-r--r-- | src/controls/qquickexclusivegroup.cpp | 1 |
8 files changed, 23 insertions, 66 deletions
diff --git a/src/controls/Menu.qml b/src/controls/Menu.qml index 7d872b23..8b6a35b9 100644 --- a/src/controls/Menu.qml +++ b/src/controls/Menu.qml @@ -106,7 +106,7 @@ MenuPrivate { /*! \internal \omit - Documented in qtmenu.cpp. + Documented in qqquickmenu.cpp. \endomit */ function addMenu(title) { @@ -115,7 +115,7 @@ MenuPrivate { /*! \internal \omit - Documented in qtmenu.cpp. + Documented in qquickmenu.cpp. \endomit */ function insertMenu(index, title) { diff --git a/src/controls/MenuBar.qml b/src/controls/MenuBar.qml index feb446ad..cee21396 100644 --- a/src/controls/MenuBar.qml +++ b/src/controls/MenuBar.qml @@ -47,7 +47,7 @@ import QtQuick.Controls.Private 1.0 \qmltype MenuBar \inqmlmodule QtQuick.Controls 1.0 \since QtQuick.Controls 1.0 - \ingroup menus + \ingroup applicationwindow \brief Provides a horizontal menu bar. \code diff --git a/src/controls/doc/src/indicators.qdoc b/src/controls/doc/src/indicators.qdoc deleted file mode 100644 index f31dec9e..00000000 --- a/src/controls/doc/src/indicators.qdoc +++ /dev/null @@ -1,31 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies). -** Contact: http://www.qt-project.org/legal -** -** 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 Digia. For licensing terms and -** conditions see http://qt.digia.com/licensing. For further information -** use the contact form at http://qt.digia.com/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$ -** -****************************************************************************/ - -/*! - \group indicators - \title Status Indicators -*/ diff --git a/src/controls/doc/src/menus.qdoc b/src/controls/doc/src/menus.qdoc index ae8554ea..75f5ba2c 100644 --- a/src/controls/doc/src/menus.qdoc +++ b/src/controls/doc/src/menus.qdoc @@ -27,5 +27,5 @@ /*! \group menus - \title Application Menus + \title Menus */ diff --git a/src/controls/doc/src/navigation.qdoc b/src/controls/doc/src/navigation.qdoc deleted file mode 100644 index b1bd8ef8..00000000 --- a/src/controls/doc/src/navigation.qdoc +++ /dev/null @@ -1,31 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies). -** Contact: http://www.qt-project.org/legal -** -** 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 Digia. For licensing terms and -** conditions see http://qt.digia.com/licensing. For further information -** use the contact form at http://qt.digia.com/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$ -** -****************************************************************************/ - -/*! - \group navigation - \title Application Navigation -*/ diff --git a/src/controls/doc/src/qtquickcontrols-index.qdoc b/src/controls/doc/src/qtquickcontrols-index.qdoc index c349d02d..e9e4f708 100644 --- a/src/controls/doc/src/qtquickcontrols-index.qdoc +++ b/src/controls/doc/src/qtquickcontrols-index.qdoc @@ -61,6 +61,10 @@ Controls are typically items that are used to present or receive input from the user. \annotatedlist controls + \section1 Menus + Types that can be used to build menus. + \annotatedlist menus + \section1 Related information \section2 Guides diff --git a/src/controls/qquickaction.cpp b/src/controls/qquickaction.cpp index dc1f7bb9..a597515f 100644 --- a/src/controls/qquickaction.cpp +++ b/src/controls/qquickaction.cpp @@ -53,6 +53,7 @@ QT_BEGIN_NAMESPACE /*! \qmltype Action \instantiates QQuickAction + \ingroup applicationwindow \inqmlmodule QtQuick.Controls 1.0 \brief Action provides an abstract user interface action that can be bound to items @@ -65,6 +66,19 @@ QT_BEGIN_NAMESPACE automatically be checked. QtQuick Controls supports actions in \l Button, \l ToolButton, and \l MenuItem. + + Example: + \qml + Action { + id: openAction + text: "&Open" + shortcut: "Ctrl+O" + iconSource: "images/document-open.png" + onTriggered: fileDialog.open() + tooltip: "Open an Image" + } + \endqml + */ /*! diff --git a/src/controls/qquickexclusivegroup.cpp b/src/controls/qquickexclusivegroup.cpp index e7ddb2d0..eecff416 100644 --- a/src/controls/qquickexclusivegroup.cpp +++ b/src/controls/qquickexclusivegroup.cpp @@ -66,6 +66,7 @@ static bool isChecked(const QObject *o) /*! \qmltype ExclusiveGroup \instantiates QQuickExclusiveGroup + \ingroup controls \inqmlmodule QtQuick.Controls 1.0 \brief ExclusiveGroup provides a way to declare several checkable controls as mutually exclusive. |