path: root/src/imports/controls
diff options
authorMitch Curtis <mitch.curtis@qt.io>2019-02-11 16:44:20 +0100
committerMitch Curtis <mitch.curtis@qt.io>2019-02-25 13:06:47 +0000
commit951bfc041f1f43272f73d9cbc47100060c379c0c (patch)
tree7fb462fb1e26003bf3dad5fbe7d41cc638b6afb1 /src/imports/controls
parentfa641ab12340fa128668318a1fe7c6a01906f163 (diff)
Doc: restructure and fill in Imagine customization section
Change-Id: I1b34fe2df28c734395dc2a55340f2a7cb1629692 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'src/imports/controls')
1 files changed, 23 insertions, 6 deletions
diff --git a/src/imports/controls/doc/src/qtquickcontrols2-imagine.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-imagine.qdoc
index c7ad71cf..2a9f1c5d 100644
--- a/src/imports/controls/doc/src/qtquickcontrols2-imagine.qdoc
+++ b/src/imports/controls/doc/src/qtquickcontrols2-imagine.qdoc
@@ -2417,10 +2417,10 @@
The \l {https://developers.google.com/speed/webp/}{WebP} and GIF animated
image formats are supported by the Imagine style.
- \section2 Palette
\section2 Customization
+ \section3 Path
The Imagine style allows customizing the \l {imagine-path-attached-prop}{path}
that is used to do the image asset selection. The path can be specified for any
window or item, and it automatically propagates to children in the same manner as
@@ -2454,23 +2454,40 @@
In addition to specifying the path in QML, it is also possible to specify
- it via an environment variable or in a configuration file. Attributes
- specified in QML take precedence over all other methods.
+ it via an \l {imagine-customization-environment-variable}{environment variable}
+ or in a \l {imagine-customization-configuration-file}{configuration file}.
+ Attributes specified in QML take precedence over all other methods.
- \section3 Configuration File
+ \section4 Configuration File
+ \target imagine-customization-configuration-file
\include qquickimaginestyle.qdocinc conf
See \l {Qt Quick Controls 2 Configuration File} for more details about the
configuration file.
- \section3 Environment Variables
+ \section4 Environment Variables
+ \target imagine-customization-environment-variable
\include qquickimaginestyle.qdocinc env
See \l {Supported Environment Variables in Qt Quick Controls 2} for the full
list of supported environment variables.
+ \section3 Palette
+ The Imagine style supports palette customization via the \l {Control::}{palette}
+ property and the \l {Palette Configuration}{qtquickcontrols2.conf} file.
+ As with other styles, the exact \l {palette QML Basic Type}{palette roles}
+ that the Imagine style uses are style-dependent. However, as most of the visual
+ appearance of controls (for example: backgrounds) are managed through image assets,
+ only the roles that are typically used for text will have an effect.
+ \section3 Font
+ Custom fonts can be set via the \l {Control::}{font} property and the
+ \l {Font Configuration}{configuration} file.
\section2 Dependency
The Imagine style must be separately imported to gain access to the