diff options
author | J-P Nurmi <jpnurmi@qt.io> | 2016-09-09 13:40:20 +0200 |
---|---|---|
committer | J-P Nurmi <jpnurmi@qt.io> | 2016-09-13 06:50:29 +0000 |
commit | db018c5cc71f5f62bcce7df4f2bed76b2899884d (patch) | |
tree | 12cfe8412f2ca5594d1a8658056fb159590af10a /src | |
parent | cc7a28d79d2f6064068f659fcf7a249b18fe76a5 (diff) |
Doc: align "pre-defined colors" in the style docs
Original problem: the Universal.color() method docs was linking to the
pre-defined colors of the Material style. Present the list of Universal
style's pre-defined colors the same way it is done for the Material
style, and disambiguate the two.
Change-Id: I3f3df608e80ca5c24034e2d75398e3126cf32b2d
Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
Diffstat (limited to 'src')
-rw-r--r-- | src/imports/controls/doc/src/qtquickcontrols2-material.qdoc | 32 | ||||
-rw-r--r-- | src/imports/controls/doc/src/qtquickcontrols2-universal.qdoc | 38 |
2 files changed, 35 insertions, 35 deletions
diff --git a/src/imports/controls/doc/src/qtquickcontrols2-material.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-material.qdoc index a5ac25d2..a90581ec 100644 --- a/src/imports/controls/doc/src/qtquickcontrols2-material.qdoc +++ b/src/imports/controls/doc/src/qtquickcontrols2-material.qdoc @@ -151,22 +151,19 @@ \row \li \c QT_QUICK_CONTROLS_MATERIAL_ACCENT \li The value can be any \l {colorbasictypedocs}{color}, but it is recommended - to use one of the \l {Pre-defined Colors}{pre-defined colors}, for example - for example \c "Teal". + to use one of the \l {pre-defined Material colors}, for example \c "Teal". \row \li \c QT_QUICK_CONTROLS_MATERIAL_PRIMARY \li The value can be any \l {colorbasictypedocs}{color}, but it is recommended - to use one of the \l {Pre-defined Colors}{pre-defined colors}, for example - for example \c "BlueGrey". + to use one of the \l {pre-defined Material colors}, for example \c "BlueGrey". \row \li \c QT_QUICK_CONTROLS_MATERIAL_FOREGROUND \li The value can be any \l {colorbasictypedocs}{color}, or one of the - \l {Pre-defined Colors}{pre-defined colors}. - + \l {pre-defined Material colors}. \row \li \c QT_QUICK_CONTROLS_MATERIAL_BACKGROUND \li The value can be any \l {colorbasictypedocs}{color}, or one of the - \l {Pre-defined Colors}{pre-defined colors}. + \l {pre-defined Material colors}. \endtable \section2 Dependency @@ -184,7 +181,7 @@ style-specific tweaks can be applied without creating a hard dependency to a style. - \section2 Pre-defined Colors + \section2 Pre-defined Material Colors Even though primary and accent can be any \l {colorbasictypedocs}{color}, it is recommended to use one of the pre-defined colors that have been designed @@ -238,8 +235,8 @@ There are several different \l {https://material.google.com/style/color.html#color-color-palette}{shades} - of each \l {Pre-defined Colors}{pre-defined color} that can be passed to the - \l {material-color-attached-method}{Material.color()} function: + of each \l {Pre-defined Material Colors}{pre-defined color} that can be passed + to the \l {material-color-attached-method}{Material.color()} function: \value Material.Shade50 \value Material.Shade100 \value Material.Shade200 @@ -267,8 +264,8 @@ The default value is \c Material.Pink. \note Even though the accent can be any \l {colorbasictypedocs}{color}, it is - recommended to use one of the \l {pre-defined colors} that have been designed - to work well with the rest of the Material style palette. + recommended to use one of the \l {pre-defined Material colors} that have been + designed to work well with the rest of the Material style palette. \endstyleproperty @@ -308,8 +305,8 @@ The default value is \c Material.Indigo. \note Even though the primary can be any \l {colorbasictypedocs}{color}, it is - recommended to use one of the \l {pre-defined colors} that have been designed - to work well with the rest of the Material style palette. + recommended to use one of the \l {pre-defined Material colors} that have been + designed to work well with the rest of the Material style palette. \endstyleproperty @@ -328,9 +325,10 @@ \stylemethod2 {color} {color} {enumeration} {predefined} {enumeration} {shade} {material-color-attached-method} \target material-color-attached-method - This attached method returns the color value of the specified \l {pre-defined colors} - {pre-defined color} combined with the given \l {pre-defined colors}{shade}. - If omitted, the shade argument defaults to \c Material.Shade500. + This attached method returns the effective color value of the specified + \l {pre-defined Material colors}{pre-defined Material color} combined with + the given \l {pre-defined shades}{shade}. If omitted, the shade argument + defaults to \c Material.Shade500. \qml import QtQuick 2.0 diff --git a/src/imports/controls/doc/src/qtquickcontrols2-universal.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-universal.qdoc index da5e5687..02dc93c9 100644 --- a/src/imports/controls/doc/src/qtquickcontrols2-universal.qdoc +++ b/src/imports/controls/doc/src/qtquickcontrols2-universal.qdoc @@ -150,16 +150,15 @@ \row \li \c QT_QUICK_CONTROLS_UNIVERSAL_ACCENT \li The value can be any \l {colorbasictypedocs}{color}, but it is recommended - to use one of the pre-defined \l {universal-accent-attached-prop} {accents}, for - example \c "Violet". + to use one of the \l {pre-defined Universal colors}, for example \c "Violet". \row \li \c QT_QUICK_CONTROLS_UNIVERSAL_FOREGROUND \li The value can be any \l {colorbasictypedocs}{color}, or one of the - pre-defined \l {universal-accent-attached-prop}{accents}. + \l {pre-defined Universal colors}. \row \li \c QT_QUICK_CONTROLS_UNIVERSAL_BACKGROUND \li The value can be any \l {colorbasictypedocs}{color}, or one of the - pre-defined \l {universal-accent-attached-prop}{accents}. + \l {pre-defined Universal colors}. \endtable \section2 Dependency @@ -177,19 +176,9 @@ style-specific tweaks can be applied without creating a hard dependency to a style. - \b {See also} \l {Default Style}, \l {Material Style} - - \section1 Attached Property Documentation - - \styleproperty {Universal.accent} {color} {universal-accent-attached-prop} - \target universal-accent-attached-prop - This attached property holds the accent color of the theme. The property - can be attached to any window or item. The value is propagated to children. - - Even though the accent can be any \l {colorbasictypedocs}{color}, it is - recommended to use one of the pre-defined accents that have been designed - to work well with the rest of the Universal style palette: + \section2 Pre-defined Universal Colors + Available pre-defined colors: \value Universal.Lime \stylecolor {#A4C400} {} \value Universal.Green \stylecolor {#60A917} {} \value Universal.Emerald \stylecolor {#008A00} {} @@ -211,6 +200,19 @@ \value Universal.Mauve \stylecolor {#76608A} {} \value Universal.Taupe \stylecolor {#87794E} {} + \b {See also} \l {Default Style}, \l {Material Style} + + \section1 Attached Property Documentation + + \styleproperty {Universal.accent} {color} {universal-accent-attached-prop} + \target universal-accent-attached-prop + This attached property holds the accent color of the theme. The property + can be attached to any window or item. The value is propagated to children. + + \note Even though the accent can be any \l {colorbasictypedocs}{color}, it is + recommended to use one of the \l {pre-defined Universal colors} that have been + designed to work well with the rest of the Universal style palette. + \endstyleproperty \styleproperty {Universal.background} {color} {universal-background-attached-prop} @@ -244,8 +246,8 @@ \stylemethod {color} {color} {enumeration} {predefined} {color-attached-method} \target color-attached-method - This attached method returns the color value of the specified \l {pre-defined colors} - {pre-defined color}. + This attached method returns the effective color value of the specified + \l {pre-defined Universal colors}{pre-defined Universal color}. \qml import QtQuick 2.0 |