aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMitch Curtis <mitch.curtis@qt.io>2017-08-01 15:13:59 +0200
committerMitch Curtis <mitch.curtis@qt.io>2017-08-02 09:17:56 +0000
commit5f972843378d927d391a37b6957708eee4536766 (patch)
tree79b4db1d6bd21192d26dc212d6d0d946271cc6bf
parentedfda32b7c79baa3fbef4e5da6716f1789bc6260 (diff)
Improve "Qt Quick Controls 2 Configuration File" documentation
- Added sections to make it possible to link to them from other pages - Added section for the Imagine style - Improved wording Change-Id: I3e5e01a73d7411ee5e156f8f934d699ce57e00d4 Reviewed-by: Frederik Gladhorn <frederik.gladhorn@qt.io>
-rw-r--r--src/imports/controls/doc/src/qtquickcontrols2-configuration.qdoc25
1 files changed, 21 insertions, 4 deletions
diff --git a/src/imports/controls/doc/src/qtquickcontrols2-configuration.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-configuration.qdoc
index 358b09ce..23e52705 100644
--- a/src/imports/controls/doc/src/qtquickcontrols2-configuration.qdoc
+++ b/src/imports/controls/doc/src/qtquickcontrols2-configuration.qdoc
@@ -53,16 +53,29 @@
Primary=BlueGrey
\endcode
- \l {Material style} specific values that can be specified in a \c Material
- section of the configuration file:
+ \section1 Imagine Style Configuration
+
+ The following table lists values that can be used to configure the
+ \l {Imagine style} in an \c Imagine section of the configuration file:
+
+ \include qquickimaginestyle.qdocinc conf
+
+ \section1 Material Style Configuration
+
+ The following table lists values that can be used to configure the
+ \l {Material style} in a \c Material section of the configuration file:
\include qquickmaterialstyle.qdocinc conf
- \l {Universal style} specific values that can be specified in a \c Universal
- section of the configuration file:
+ \section1 Universal Style Configuration
+
+ The following table lists values that can be used to configure the
+ \l {Universal style} in a \c Universal section of the configuration file:
\include qquickuniversalstyle.qdocinc conf
+ \section1 Font Configuration
+
The default \l {Control::font}{font} can be specified in a \c Font sub-group
in each style's section in the configuration file. The \c Font sub-group can
be defined in two alternative ways:
@@ -110,6 +123,8 @@
Available values: \c StyleNormal, \c StyleItalic, \c StyleOblique.
\endtable
+ \section1 Palette Configuration
+
The default \l {Control::palette}{palette} can be specified in a \c Palette sub-group
in each style's section in the configuration file. The \c Palette sub-group can be
defined in two alternative ways:
@@ -193,6 +208,8 @@
\li A text color used for hyperlinks.
\endtable
+ \section1 Using the Configuration File in a Project
+
In order to make it possible for Qt Quick Controls 2 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: