Commit bb7ba4d6 authored by Jens Bache-Wiig's avatar Jens Bache-Wiig Committed by The Qt Project
Browse files

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: default avatarGabriel de Dietrich <gabriel.dedietrich@digia.com>
Reviewed-by: default avatarJerome Pasion <jerome.pasion@digia.com>
parent caaeec47
6.2 5.10 5.11 5.12 5.12.1 5.12.10 5.12.11 5.12.12 5.12.2 5.12.3 5.12.4 5.12.5 5.12.6 5.12.7 5.12.8 5.12.9 5.13 5.13.0 5.13.1 5.13.2 5.14 5.14.0 5.14.1 5.14.2 5.15 5.15.0 5.15.1 5.15.2 5.3 5.4 5.5 5.6 5.7 5.8 5.9 5.9.8 dev old/5.1 old/5.2 wip/calendar wip/tizen v5.15.0-alpha1 v5.14.1 v5.14.0 v5.14.0-rc2 v5.14.0-rc1 v5.14.0-beta3 v5.14.0-beta2 v5.14.0-beta1 v5.14.0-alpha1 v5.13.2 v5.13.1 v5.13.0 v5.13.0-rc3 v5.13.0-rc2 v5.13.0-rc1 v5.13.0-beta4 v5.13.0-beta3 v5.13.0-beta2 v5.13.0-beta1 v5.13.0-alpha1 v5.12.7 v5.12.6 v5.12.5 v5.12.4 v5.12.3 v5.12.2 v5.12.1 v5.12.0 v5.12.0-rc2 v5.12.0-rc1 v5.12.0-beta4 v5.12.0-beta3 v5.12.0-beta2 v5.12.0-beta1 v5.12.0-alpha1 v5.11.3 v5.11.2 v5.11.1 v5.11.0 v5.11.0-rc2 v5.11.0-rc1 v5.11.0-beta4 v5.11.0-beta3 v5.11.0-beta2 v5.11.0-beta1 v5.11.0-alpha1 v5.10.1 v5.10.0 v5.10.0-rc3 v5.10.0-rc2 v5.10.0-rc1 v5.10.0-beta4 v5.10.0-beta3 v5.10.0-beta2 v5.10.0-beta1 v5.10.0-alpha1 v5.9.9 v5.9.8 v5.9.7 v5.9.6 v5.9.5 v5.9.4 v5.9.3 v5.9.2 v5.9.1 v5.9.0 v5.9.0-rc2 v5.9.0-rc1 v5.9.0-beta4 v5.9.0-beta3 v5.9.0-beta2 v5.9.0-beta1 v5.9.0-alpha1 v5.8.0 v5.8.0-rc1 v5.8.0-beta1 v5.8.0-alpha1 v5.7.1 v5.7.0 v5.7.0-rc1 v5.7.0-beta1 v5.7.0-alpha1 v5.6.3 v5.6.2 v5.6.1 v5.6.1-1 v5.6.0 v5.6.0-rc1 v5.6.0-beta1 v5.6.0-alpha1 v5.5.1 v5.5.0 v5.5.0-rc1 v5.5.0-beta1 v5.5.0-alpha1 v5.4.2 v5.4.1 v5.4.0 v5.4.0-rc1 v5.4.0-beta1 v5.4.0-alpha1 v5.3.2 v5.3.1 v5.3.0 v5.3.0-rc1 v5.3.0-beta1 v5.3.0-alpha1 v5.2.1 v5.2.0 v5.2.0-rc1 v5.2.0-beta1 v5.2.0-alpha1 v5.1.1 v5.1.0 v5.1.0-rc2 v5.1.0-rc1
No related merge requests found
Showing with 23 additions and 66 deletions
...@@ -106,7 +106,7 @@ MenuPrivate { ...@@ -106,7 +106,7 @@ MenuPrivate {
/*! \internal /*! \internal
\omit \omit
Documented in qtmenu.cpp. Documented in qqquickmenu.cpp.
\endomit \endomit
*/ */
function addMenu(title) { function addMenu(title) {
...@@ -115,7 +115,7 @@ MenuPrivate { ...@@ -115,7 +115,7 @@ MenuPrivate {
/*! \internal /*! \internal
\omit \omit
Documented in qtmenu.cpp. Documented in qquickmenu.cpp.
\endomit \endomit
*/ */
function insertMenu(index, title) { function insertMenu(index, title) {
......
...@@ -47,7 +47,7 @@ import QtQuick.Controls.Private 1.0 ...@@ -47,7 +47,7 @@ import QtQuick.Controls.Private 1.0
\qmltype MenuBar \qmltype MenuBar
\inqmlmodule QtQuick.Controls 1.0 \inqmlmodule QtQuick.Controls 1.0
\since QtQuick.Controls 1.0 \since QtQuick.Controls 1.0
\ingroup menus \ingroup applicationwindow
\brief Provides a horizontal menu bar. \brief Provides a horizontal menu bar.
\code \code
......
/****************************************************************************
**
** 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
*/
...@@ -27,5 +27,5 @@ ...@@ -27,5 +27,5 @@
/*! /*!
\group menus \group menus
\title Application Menus \title Menus
*/ */
/****************************************************************************
**
** 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
*/
...@@ -61,6 +61,10 @@ ...@@ -61,6 +61,10 @@
Controls are typically items that are used to present or receive input from the user. Controls are typically items that are used to present or receive input from the user.
\annotatedlist controls \annotatedlist controls
\section1 Menus
Types that can be used to build menus.
\annotatedlist menus
\section1 Related information \section1 Related information
\section2 Guides \section2 Guides
......
...@@ -53,6 +53,7 @@ QT_BEGIN_NAMESPACE ...@@ -53,6 +53,7 @@ QT_BEGIN_NAMESPACE
/*! /*!
\qmltype Action \qmltype Action
\instantiates QQuickAction \instantiates QQuickAction
\ingroup applicationwindow
\inqmlmodule QtQuick.Controls 1.0 \inqmlmodule QtQuick.Controls 1.0
\brief Action provides an abstract user interface action that can be bound to items \brief Action provides an abstract user interface action that can be bound to items
...@@ -65,6 +66,19 @@ QT_BEGIN_NAMESPACE ...@@ -65,6 +66,19 @@ QT_BEGIN_NAMESPACE
automatically be checked. automatically be checked.
QtQuick Controls supports actions in \l Button, \l ToolButton, and \l MenuItem. 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
*/ */
/*! /*!
......
...@@ -66,6 +66,7 @@ static bool isChecked(const QObject *o) ...@@ -66,6 +66,7 @@ static bool isChecked(const QObject *o)
/*! /*!
\qmltype ExclusiveGroup \qmltype ExclusiveGroup
\instantiates QQuickExclusiveGroup \instantiates QQuickExclusiveGroup
\ingroup controls
\inqmlmodule QtQuick.Controls 1.0 \inqmlmodule QtQuick.Controls 1.0
\brief ExclusiveGroup provides a way to declare several checkable controls as mutually exclusive. \brief ExclusiveGroup provides a way to declare several checkable controls as mutually exclusive.
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment