diff options
author | Mitch Curtis <mitch.curtis@qt.io> | 2018-01-19 06:28:15 +0100 |
---|---|---|
committer | Mitch Curtis <mitch.curtis@qt.io> | 2018-01-19 07:36:49 +0000 |
commit | ffda6894cc80909f900447d4de24bcc0effd467b (patch) | |
tree | e4f9607fc4aabaadc512caeaeca75ca1bf938a0c | |
parent | b2056dabff3d3e1f949b21020ca05fce92ad70b4 (diff) |
Explain the benefits of customizing a control vs creating a style
Mention that customizing a control is nice because you don't need to
start from scratch with a template.
Add a third requirement for "Definition of a Style" that mentions that
the top level item must be a template, and why.
Change-Id: I4db4ec8311baed46fb45271d107204808ba42592
Reviewed-by: J-P Nurmi <jpnurmi@qt.io>
-rw-r--r-- | src/imports/controls/doc/src/qtquickcontrols2-customize.qdoc | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/src/imports/controls/doc/src/qtquickcontrols2-customize.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-customize.qdoc index a4a9fb44..b645633b 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}. |