aboutsummaryrefslogtreecommitdiffstats
path: root/src/imports/controls/doc/src
diff options
context:
space:
mode:
authorJ-P Nurmi <jpnurmi@theqtcompany.com>2016-03-22 21:46:26 +0100
committerJ-P Nurmi <jpnurmi@theqtcompany.com>2016-03-24 10:01:53 +0000
commit5f9cbe0253e27c3e559ab3dc0310775aba8a0621 (patch)
tree4b3a37486ddbd7203b2a2c40043e53db8622f9c6 /src/imports/controls/doc/src
parentddd88c154ec9f58e28014cb80f792ba0d2dcb619 (diff)
Add support for specifying theme, accent & primary via env
Environment values take presedence over the default values requested in qtquickcontrols.conf, the same way than style name. Change-Id: I4641317bdce320c33a89f3614f3c782883c9c843 Reviewed-by: Mitch Curtis <mitch.curtis@theqtcompany.com>
Diffstat (limited to 'src/imports/controls/doc/src')
-rw-r--r--src/imports/controls/doc/src/qtquickcontrols2-material.qdoc26
-rw-r--r--src/imports/controls/doc/src/qtquickcontrols2-styles.qdoc1
-rw-r--r--src/imports/controls/doc/src/qtquickcontrols2-universal.qdoc21
3 files changed, 48 insertions, 0 deletions
diff --git a/src/imports/controls/doc/src/qtquickcontrols2-material.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-material.qdoc
index fb1ad081..ad807262 100644
--- a/src/imports/controls/doc/src/qtquickcontrols2-material.qdoc
+++ b/src/imports/controls/doc/src/qtquickcontrols2-material.qdoc
@@ -116,6 +116,32 @@
\image qtquickcontrols-material-dark.png
\endtable
+ In addition to specifying the attributes in QML, it is also possible to
+ specify them via environment variables or in a \l {qtlabscontrols-conf}
+ {configuration file}.
+
+ \section3 Environment Variables
+
+ \table
+ \header
+ \li Variable
+ \li Description
+ \row
+ \li \c QT_LABS_CONTROLS_MATERIAL_THEME
+ \li The value can be one of the available \l {theme-attached-prop}{themes},
+ for example \c "Dark".
+ \row
+ \li \c QT_LABS_CONTROLS_MATERIAL_ACCENT
+ \li The value can be any \l {colorbasictypedocs}{color}, but it is recommended
+ to use one of the \l {Pre-defined Colors}{pre-defined colors}, for example
+ for example \c "Teal".
+ \row
+ \li \c QT_LABS_CONTROLS_MATERIAL_PRIMARY
+ \li The value can be any \l {colorbasictypedocs}{color}, but it is recommended
+ to use one of the \l {Pre-defined Colors}{pre-defined colors}, for example
+ for example \c "BlueGrey".
+ \endtable
+
\section2 Dependency
The Material style must be separately imported to gain access to the
diff --git a/src/imports/controls/doc/src/qtquickcontrols2-styles.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-styles.qdoc
index 166edd45..a4f036e6 100644
--- a/src/imports/controls/doc/src/qtquickcontrols2-styles.qdoc
+++ b/src/imports/controls/doc/src/qtquickcontrols2-styles.qdoc
@@ -92,6 +92,7 @@
\endcode
\section2 Configuration file
+ \target qtlabscontrols-conf
Qt Labs Controls support a special configuration file, \c :/qtquickcontrols.conf,
that is built into an application's resources.
diff --git a/src/imports/controls/doc/src/qtquickcontrols2-universal.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-universal.qdoc
index 3943440d..78065ebd 100644
--- a/src/imports/controls/doc/src/qtquickcontrols2-universal.qdoc
+++ b/src/imports/controls/doc/src/qtquickcontrols2-universal.qdoc
@@ -116,6 +116,27 @@
\image qtquickcontrols-universal-dark.png
\endtable
+ In addition to specifying the attributes in QML, it is also possible to
+ specify them via environment variables or in a \l {qtlabscontrols-conf}
+ {configuration file}.
+
+ \section3 Environment Variables
+
+ \table
+ \header
+ \li Variable
+ \li Description
+ \row
+ \li \c QT_LABS_CONTROLS_UNIVERSAL_THEME
+ \li The value can be one of the available \l {theme-attached-prop}{themes},
+ for example \c "Dark".
+ \row
+ \li \c QT_LABS_CONTROLS_UNIVERSAL_ACCENT
+ \li The value can be any \l {colorbasictypedocs}{color}, but it is recommended
+ to use one of the pre-defined \l {accent-attached-prop} {accents}, for
+ example \c "Violet".
+ \endtable
+
\section2 Dependency
The Universal style must be separately imported to gain access to the