aboutsummaryrefslogtreecommitdiffstats
path: root/src/imports/controls/doc/src
diff options
context:
space:
mode:
authorJ-P Nurmi <jpnurmi@theqtcompany.com>2016-04-13 15:22:21 +0200
committerJ-P Nurmi <jpnurmi@theqtcompany.com>2016-04-15 15:57:19 +0000
commitb51e520f5150f5a008296de1d223f4bd40758d42 (patch)
tree54d2196d5c1afb296c99eba959361af1dae13b66 /src/imports/controls/doc/src
parenteae24fccc57437170e2ba01b894fa24fe65292be (diff)
Material: add foreground and background attached properties
This has been a common request on the mailing lists and forums. Users want to customize the text color of various controls without having to replace whole delegates. This change makes it possible to specify both foreground (eg. Button text) and background (eg. ApplicationWindow, Page and Pane background) colors so that they propagate to children in the same way than accent, primary and theme do. Change-Id: Idae52650ed8620beeff7bf4c8263ffdc1f6ef728 Reviewed-by: Mitch Curtis <mitch.curtis@theqtcompany.com>
Diffstat (limited to 'src/imports/controls/doc/src')
-rw-r--r--src/imports/controls/doc/src/qtquickcontrols2-material.qdoc41
1 files changed, 37 insertions, 4 deletions
diff --git a/src/imports/controls/doc/src/qtquickcontrols2-material.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-material.qdoc
index 2491eb43..76714ae6 100644
--- a/src/imports/controls/doc/src/qtquickcontrols2-material.qdoc
+++ b/src/imports/controls/doc/src/qtquickcontrols2-material.qdoc
@@ -38,6 +38,8 @@
\list
\li \l {accent-attached-prop}{\b accent} : color
+ \li \l {background-attached-prop}{\b background} : color
+ \li \l {foreground-attached-prop}{\b foreground} : color
\li \l {primary-attached-prop}{\b primary} : color
\li \l {theme-attached-prop}{\b theme} : enumeration
\endlist
@@ -60,9 +62,13 @@
\section2 Customization
- The Material style allows customizing three attributes, \l {theme-attached-prop}{theme},
- \l {primary-attached-prop}{primary} and \l {accent-attached-prop}{accent}. The following
- example illustrates how to create a red \e stop button with light text:
+ The Material style allows customizing five attributes, \l {theme-attached-prop}{theme},
+ \l {primary-attached-prop}{primary}, \l {accent-attached-prop}{accent},
+ \l {foreground-attached-prop}{foreground}, and \l {background-attached-prop}{background}.
+
+ \image qtquickcontrols2-material-attributes.png
+
+ The following example illustrates how to create a red \e stop button with light text:
\table
\row
@@ -84,7 +90,7 @@
\image qtquickcontrols2-material-button.png
\endtable
- Both attributes can be specified for any window or item, and they automatically
+ All attributes can be specified for any window or item, and they automatically
propagate to children in the same manner as \l {Control::font}{fonts}. In the
following example, the window and all three radio buttons appear in the dark
theme using a purple accent color:
@@ -140,6 +146,15 @@
\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".
+ \row
+ \li \c QT_LABS_CONTROLS_MATERIAL_FOREGROUND
+ \li The value can be any \l {colorbasictypedocs}{color}, or one of the
+ \l {Pre-defined Colors}{pre-defined colors}.
+
+ \row
+ \li \c QT_LABS_CONTROLS_MATERIAL_BACKGROUND
+ \li The value can be any \l {colorbasictypedocs}{color}, or one of the
+ \l {Pre-defined Colors}{pre-defined colors}.
\endtable
\section2 Dependency
@@ -201,6 +216,24 @@
\endstyleproperty
+ \styleproperty {Material.background} {color} {background-attached-prop}
+ \target background-attached-prop
+ This attached property holds the background color of the theme. The property
+ can be attached to any window or item. The value is propagated to children.
+
+ The default value is theme-specific (light or dark).
+
+ \endstyleproperty
+
+ \styleproperty {Material.foreground} {color} {foreground-attached-prop}
+ \target foreground-attached-prop
+ This attached property holds the foreground color of the theme. The property
+ can be attached to any window or item. The value is propagated to children.
+
+ The default value is theme-specific (light or dark).
+
+ \endstyleproperty
+
\styleproperty {Material.primary} {color} {primary-attached-prop}
\target primary-attached-prop
This attached property holds the primary color of the theme. The property