diff options
| author | Mitch Curtis <mitch.curtis@qt.io> | 2018-01-22 12:34:13 +0100 |
|---|---|---|
| committer | Mitch Curtis <mitch.curtis@qt.io> | 2018-01-24 13:47:29 +0000 |
| commit | bad503ca690ab6f31958c049105b70e23b9406ea (patch) | |
| tree | 131b3bc196d1f775c5bab25620054fe2df939979 | |
| parent | 2a091c3c721861f2ab132dfdd4a07f194a543f9b (diff) | |
Doc: provide examples of setting Imagine path
Remove any ambiguity about how the paths might be specified.
Change-Id: I004e13349a54ded9a41586a8f5a564731a821585
Reviewed-by: J-P Nurmi <jpnurmi@qt.io>
| -rw-r--r-- | src/imports/controls/doc/src/includes/qquickimaginestyle.qdocinc | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/src/imports/controls/doc/src/includes/qquickimaginestyle.qdocinc b/src/imports/controls/doc/src/includes/qquickimaginestyle.qdocinc index 8acec2a8..f6fe5a97 100644 --- a/src/imports/controls/doc/src/includes/qquickimaginestyle.qdocinc +++ b/src/imports/controls/doc/src/includes/qquickimaginestyle.qdocinc @@ -8,6 +8,21 @@ \li Specifies the \l {imagine-path-attached-prop}{path} to the directory that contains the Imagine style assets. If not specified, the built-in assets are used. + For example, to specify a path to a directory stored in the + \l {The Qt Resource System}{resource system}: + + \badcode + [Imagine] + Path=:/imagine-assets + \endcode + + To specify a relative path to a local directory: + + \badcode + [Imagine] + Path=imagine-assets + \endcode + \note Due to a technical limitation, the path should not be named \e "imagine" if it is relative to the \c qtquickcontrols2.conf file. \endtable @@ -23,6 +38,19 @@ \li Specifies the path to the directory that contains the Imagine style assets. If not specified, the built-in assets are used. + For example, to specify a path to a directory stored in the + \l {The Qt Resource System}{resource system}: + + \badcode + QT_QUICK_CONTROLS_IMAGINE_PATH=:/imagine-assets + \endcode + + To specify a relative path to a local directory: + + \badcode + QT_QUICK_CONTROLS_IMAGINE_PATH=imagine-assets + \endcode + \note Due to a technical limitation, the path should not be named \e "imagine" if it is relative to the \c qtquickcontrols2.conf file. \endtable |