diff options
author | J-P Nurmi <jpnurmi@digia.com> | 2014-09-24 17:27:35 +0200 |
---|---|---|
committer | J-P Nurmi <jpnurmi@digia.com> | 2014-09-30 17:46:01 +0200 |
commit | d22eb380efb72d6a2fc8d05d2d895ae1e17542f8 (patch) | |
tree | ce8d803b584c3ccf2f48839ff105ff2dafcd40fe /src/controls | |
parent | bd4af2d8c4312712ea48302c92e888cd767353db (diff) | |
download | qtquickcontrols-d22eb380efb72d6a2fc8d05d2d895ae1e17542f8.tar.gz |
Doc: add platform notes for Android
Task-number: QTBUG-40648
Change-Id: Ie986648f03cfbd2cbaeefccd5ced43865d816c64
Reviewed-by: Jake Petroules <jake.petroules@petroules.com>
Reviewed-by: Topi Reiniƶ <topi.reinio@digia.com>
Diffstat (limited to 'src/controls')
-rw-r--r-- | src/controls/doc/images/qtquickcontrols-android.png | bin | 0 -> 21393 bytes | |||
-rw-r--r-- | src/controls/doc/src/qtquickcontrols-index.qdoc | 1 | ||||
-rw-r--r-- | src/controls/doc/src/qtquickcontrols-platformnotes.qdoc | 69 |
3 files changed, 70 insertions, 0 deletions
diff --git a/src/controls/doc/images/qtquickcontrols-android.png b/src/controls/doc/images/qtquickcontrols-android.png Binary files differnew file mode 100644 index 00000000..8877c09c --- /dev/null +++ b/src/controls/doc/images/qtquickcontrols-android.png diff --git a/src/controls/doc/src/qtquickcontrols-index.qdoc b/src/controls/doc/src/qtquickcontrols-index.qdoc index 94a10066..0d24c06c 100644 --- a/src/controls/doc/src/qtquickcontrols-index.qdoc +++ b/src/controls/doc/src/qtquickcontrols-index.qdoc @@ -60,6 +60,7 @@ \li \l{Qt Quick} \li \l{Qt Quick Controls Overview} \li \l{Qt Quick Controls QML Types}{Qt Quick Controls QML Types} + \li \l{Qt Quick Controls Platform Notes} \li \l{Qt Quick Controls Examples} \li \l{Qt Quick Controls Styles} \li \l{Qt Quick Layouts} diff --git a/src/controls/doc/src/qtquickcontrols-platformnotes.qdoc b/src/controls/doc/src/qtquickcontrols-platformnotes.qdoc new file mode 100644 index 00000000..70f1a1bb --- /dev/null +++ b/src/controls/doc/src/qtquickcontrols-platformnotes.qdoc @@ -0,0 +1,69 @@ +/**************************************************************************** +** +** Copyright (C) 2014 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$ +** +****************************************************************************/ + +/*! + \page qtquickcontrols-platformnotes.html + \title Qt Quick Controls Platform Notes + \brief Platform specific notes for Qt Quick Controls. + + This page contains platform specific notes for creating applications + that use \l{Qt Quick Controls}. + + \section1 Android + + Qt 5.4 introduced a native Android style for Qt Quick Controls. + + \image qtquickcontrols-android.png + + \note The Android style requires Android 3.0 (API level 11) or later. + + No special actions are required to use the Android style. It is + automatically selected and deployed on Android. See \l{Getting Started + with Qt for Android} and \l{Deploying an Application on Android} for + more details on the Android essentials. + + \section2 Action Bar + + The \l{http://developer.android.com/guide/topics/ui/actionbar.html} + {Action Bar} is a special Android control that provides many key features + including various navigation modes, actions, an options menu, a back + button, and also displays the application icon and title. + + Unlike \l{Qt Widgets}, Qt Quick Controls do not use the native action + bar on Android. ToolBar and MenuBar are offered as a cross-platform + replacement. They are unified to a single "action bar" when assigned to + the appropriate ApplicationWindow properties. + + The advantage of a non-native ToolBar is that it can contain any child + items declared in QML. Just to name a few possibilities: + \list + \li ToolButton actions, + \li A TextField as a search field, + \li A ComboBox for navigation, and + \li A ProgressBar for displaying progress. + \endlist +*/ |