aboutsummaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
Diffstat (limited to 'src')
-rw-r--r--src/imports/controls/doc/images/qtlabscontrols-default.pngbin0 -> 19608 bytes
-rw-r--r--src/imports/controls/doc/src/qtlabscontrols-default.qdoc53
-rw-r--r--src/imports/controls/doc/src/qtlabscontrols-index.qdoc8
-rw-r--r--src/imports/controls/doc/src/qtlabscontrols-material.qdoc22
-rw-r--r--src/imports/controls/doc/src/qtlabscontrols-styles.qdoc119
-rw-r--r--src/imports/controls/doc/src/qtlabscontrols-universal.qdoc22
6 files changed, 189 insertions, 35 deletions
diff --git a/src/imports/controls/doc/images/qtlabscontrols-default.png b/src/imports/controls/doc/images/qtlabscontrols-default.png
new file mode 100644
index 00000000..144ceacb
--- /dev/null
+++ b/src/imports/controls/doc/images/qtlabscontrols-default.png
Binary files differ
diff --git a/src/imports/controls/doc/src/qtlabscontrols-default.qdoc b/src/imports/controls/doc/src/qtlabscontrols-default.qdoc
new file mode 100644
index 00000000..c885c161
--- /dev/null
+++ b/src/imports/controls/doc/src/qtlabscontrols-default.qdoc
@@ -0,0 +1,53 @@
+/****************************************************************************
+**
+** 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-default.html
+ \title Default Style
+
+ The Default style is a basic all-round style.
+
+ The Default style a simple and light-weight style that offers the maximum
+ performance for Qt Labs Controls. It is built with a minimal amount of Qt
+ Quick primitives, and keeps animations and transitions to the minimum.
+
+ \image qtlabscontrols-default.png
+
+ The style is selected by default when running Qt Labs Controls applications.
+ It is built into the module's resources, so by default it is shipped with
+ any application that depends on the Qt Labs Controls module
+
+ \note The Default style is used as a fallback for other styles. If a style
+ does not implement a certain control, the Default style implementation of
+ that control is selected.
+
+ \section1 Related Information
+
+ \list
+ \li \l{Styling Qt Labs Controls}
+ \endlist
+*/
diff --git a/src/imports/controls/doc/src/qtlabscontrols-index.qdoc b/src/imports/controls/doc/src/qtlabscontrols-index.qdoc
index 16352a9a..f0a1f4cd 100644
--- a/src/imports/controls/doc/src/qtlabscontrols-index.qdoc
+++ b/src/imports/controls/doc/src/qtlabscontrols-index.qdoc
@@ -82,9 +82,12 @@
available to the context of the current QML engine. See QQmlContext for
more information.
- \section2 Deploying Qt Labs Controls
+ \section1 Important Concepts in Qt Labs Controls
- TODO
+ \list
+ \li \l{Styling Qt Labs Controls}
+ \li \l{Differences between Qt Quick Controls}
+ \endlist
\section1 Related Information
@@ -92,7 +95,6 @@
\li \l{Qt Quick}
\li \l{Qt Quick Layouts}
\li \l{Qt Labs Calendar}
- \li \l{Differences between Qt Quick Controls}
\li \l{Qt Labs Controls QML Types}{Qt Labs Controls QML Types}
\endlist
*/
diff --git a/src/imports/controls/doc/src/qtlabscontrols-material.qdoc b/src/imports/controls/doc/src/qtlabscontrols-material.qdoc
index 9e88afdb..c963cb28 100644
--- a/src/imports/controls/doc/src/qtlabscontrols-material.qdoc
+++ b/src/imports/controls/doc/src/qtlabscontrols-material.qdoc
@@ -57,22 +57,6 @@
may occur due to differences in available system fonts and font rendering
engines.
- \section2 Usage
-
- In order to run an application with the Material style, either pass
- a \c -style command line argument, or set the \c QT_LABS_CONTROLS_STYLE
- environment variable.
-
- \code
- ./app -style material
- \endcode
-
- or
-
- \code
- QT_LABS_CONTROLS_STYLE=material ./app
- \endcode
-
\section2 Customization
The Material style allows customizing two attributes, \l {theme-attached-prop}{theme}
@@ -179,4 +163,10 @@
\value Material.Dark Dark theme
\endstyleproperty
+
+ \section1 Related Information
+
+ \list
+ \li \l{Styling Qt Labs Controls}
+ \endlist
*/
diff --git a/src/imports/controls/doc/src/qtlabscontrols-styles.qdoc b/src/imports/controls/doc/src/qtlabscontrols-styles.qdoc
new file mode 100644
index 00000000..858a9105
--- /dev/null
+++ b/src/imports/controls/doc/src/qtlabscontrols-styles.qdoc
@@ -0,0 +1,119 @@
+/****************************************************************************
+**
+** 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-styles.html
+ \title Styling Qt Labs Controls
+
+ Qt Labs Controls comes with a selection of styles. The \l {Default Style}
+ {Default} style is a simple and light-weight all-round style that offers
+ the maximum performance for Qt Labs Controls. The more advanced
+ \l {Universal Style}{Universal} and \l {Material Style}{Material} styles
+ offer an appealing design, but require more system resources.
+
+ \section1 Usage
+
+ In order to run an application with a specific style, either pass a command
+ line argument, or set an environment variable. Alternatively, the preferred
+ style and style-specific attributes can be specified in a configuration file.
+
+ \section2 Command line argument
+
+ Passing a \c -style command line argument is the convenient way to test different
+ styles. It takes precedence over the other methods listed below. The following
+ example runs a Qt Labs Controls application with the Material style:
+
+ \code
+ ./app -style material
+ \endcode
+
+ \section2 Environment variable
+
+ Setting the \c QT_LABS_CONTROLS_STYLE environment variable can be used to set
+ a system-wide style preference. It takes precedence over the configuration file
+ mentioned below. The following example runs a Qt Labs Controls application with
+ the Universal style:
+
+ \code
+ QT_LABS_CONTROLS_STYLE=universal ./app
+ \endcode
+
+ \section2 Configuration file
+
+ Qt Labs Controls support a special configuration file, \c :/qtlabscontrols.conf,
+ that is built into an application's resources.
+
+ The configuration file can specify the preferred style (may be overridden by either
+ of the methods described earlier) and certain style-specific attributes. The following
+ example specifies that the preferred style is the Material style. Furthermore, when the
+ application is run with the Material style, its theme is light and the accent color is
+ brown. However, if the application is run with the Universal style instead, the theme
+ is dark and the accent color is red.
+
+ \code
+ [Controls]
+ Style=Material
+
+ [Universal]
+ Theme=Dark
+ Accent=Red
+
+ [Material]
+ Theme=Light
+ Accent=Brown
+ \endcode
+
+ In order to make it possible for Qt Labs Controls to find the configuration file,
+ it must be built into application's resources using the \l {The Qt Resource System}.
+ Here's an example \c .qrc file:
+
+ \code
+ <!DOCTYPE RCC><RCC version="1.0">
+ <qresource prefix="/">
+ <file>qtlabscontrols.conf</file>
+ </qresource>
+ </RCC>
+ \endcode
+
+ \note Qt Labs Controls uses a file selector to load the configuration file. It
+ is possible to provide a different configuration file for different platforms and
+ locales. See \l QFileSelector documentation for more details.
+
+ Finally, the \c .qrc file must be listed in the application's \c .pro file so that
+ the build system knows about it. For example:
+
+ \code
+ RESOURCES = application.qrc
+ \endcode
+
+ \section1 Related Information
+ \list
+ \li \l {Default Style}
+ \li \l {Material Style}
+ \li \l {Universal Style}
+ \endlist
+*/
diff --git a/src/imports/controls/doc/src/qtlabscontrols-universal.qdoc b/src/imports/controls/doc/src/qtlabscontrols-universal.qdoc
index 80e32e92..bc6538bf 100644
--- a/src/imports/controls/doc/src/qtlabscontrols-universal.qdoc
+++ b/src/imports/controls/doc/src/qtlabscontrols-universal.qdoc
@@ -58,22 +58,6 @@
may occur due to differences in available system fonts and font rendering
engines.
- \section2 Usage
-
- In order to run an application with the Universal style, either pass
- a \c -style command line argument, or set the \c QT_LABS_CONTROLS_STYLE
- environment variable.
-
- \code
- ./app -style universal
- \endcode
-
- or
-
- \code
- QT_LABS_CONTROLS_STYLE=universal ./app
- \endcode
-
\section2 Customization
The Universal style allows customizing two attributes, \l {theme-attached-prop}{theme}
@@ -181,4 +165,10 @@
\value Universal.Dark Dark theme
\endstyleproperty
+
+ \section1 Related Information
+
+ \list
+ \li \l{Styling Qt Labs Controls}
+ \endlist
*/