diff options
author | J-P Nurmi <jpnurmi@gmail.com> | 2018-01-31 19:38:45 +0200 |
---|---|---|
committer | J-P Nurmi <jpnurmi@gmail.com> | 2018-01-31 19:39:19 +0200 |
commit | a73307c58cde0a4503a43be94f3892745f68500e (patch) | |
tree | 0d9aab78fa7e6c320a225dd1c69ff80ac8baaa2f /src/imports/controls/doc | |
parent | 3323ca8e627db560665edb667e52d52233c05601 (diff) | |
parent | 5d27e14e4ca49263d9c3309b5e93d4cb386063cc (diff) |
Merge remote-tracking branch 'origin/5.10' into 5.11
Change-Id: I7c0333dbf959124f6cf5be7837a305b65c08d290
Diffstat (limited to 'src/imports/controls/doc')
3 files changed, 40 insertions, 1 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 diff --git a/src/imports/controls/doc/src/qtquickcontrols2-customize.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-customize.qdoc index eed9ff94..3ab07ae2 100644 --- a/src/imports/controls/doc/src/qtquickcontrols2-customize.qdoc +++ b/src/imports/controls/doc/src/qtquickcontrols2-customize.qdoc @@ -122,6 +122,9 @@ their actual counterparts in the Qt Quick Controls 2 module. You can repeat this process for any control that you wish to add. + An added benefit of these three methods is that it's not necessary to + implement the template from scratch. + \section1 Creating a Custom Style There are several ways to go about creating your own styles. Below, we'll @@ -130,12 +133,19 @@ \section2 Definition of a Style In Qt Quick Controls 2, a style is essentially an interchangeable set of - QML files within a single directory. There are two requirements for a style + QML files within a single directory. There are three requirements for a style to be \l {Using Styles in Qt Quick Controls 2}{usable}: \list \li At least one QML file whose name matches a control (for example, \c Button.qml) must exist. + \li Each QML file must contain the relevant type from the \l {Qt Quick Templates 2} + {QtQuick.Templates} import as the root item. For example, + Button.qml must contain a Button template as its root item. + + If we instead used the corresponding type from the \l {Qt Quick Controls 2} + {QtQuick.Controls} import as we did in the previous section, it would not work: + the control we were defining would try to derive from itself. \li The files must be in a directory in the filesystem or in the \l {The Qt Resource System}{resource system}. diff --git a/src/imports/controls/doc/src/qtquickcontrols2-styles.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-styles.qdoc index 21eca464..a1a74ec9 100644 --- a/src/imports/controls/doc/src/qtquickcontrols2-styles.qdoc +++ b/src/imports/controls/doc/src/qtquickcontrols2-styles.qdoc @@ -137,6 +137,7 @@ \li \l {Imagine Style} \li \l {Material Style} \li \l {Universal Style} + \li \l {Customizing Qt Quick Controls 2} \li \l {Using File Selectors with Qt Quick Controls 2} \li \l {Deploying Qt Quick Controls 2 Applications} \li \l {Qt Quick Controls 2 Configuration File} |