aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJ-P Nurmi <jpnurmi@qt.io>2016-05-27 08:55:38 +0200
committerJ-P Nurmi <jpnurmi@qt.io>2016-05-27 07:50:34 +0000
commit5964d0b279717dfe42df9e4f6ef9189b9164e5ab (patch)
treeec67e14dfb42dfbc66f400a3cc280efd7e23572c
parentc22fcea7ad4f0459f8de03f5e319558ff59d4473 (diff)
Doc: Material.color() and Universal.color()
Change-Id: I01bc1ec6ae769f8b6c9856b70a5305dfb361f1bc Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
-rw-r--r--src/imports/controls/doc/qtquickcontrols2.qdocconf8
-rw-r--r--src/imports/controls/doc/src/qtquickcontrols2-material.qdoc24
-rw-r--r--src/imports/controls/doc/src/qtquickcontrols2-universal.qdoc24
3 files changed, 56 insertions, 0 deletions
diff --git a/src/imports/controls/doc/qtquickcontrols2.qdocconf b/src/imports/controls/doc/qtquickcontrols2.qdocconf
index 4bde8fb3..3408f152 100644
--- a/src/imports/controls/doc/qtquickcontrols2.qdocconf
+++ b/src/imports/controls/doc/qtquickcontrols2.qdocconf
@@ -71,6 +71,14 @@ macro.styleimport.HTML = "<table class=\"alignedsummary\"><tbody><tr><td class=\
macro.styleproperty.HTML = "<div class=\"qmlproto\"><table class=\"qmlname\"><tbody><tr valign=\"top\" class=\"odd\" id=\"\3\"><td class=\"tblQmlPropNode\"><p><span class=\"name\">\1</span> : <span class=\"type\">\2</span></p></td></tr></tbody></table></div>"
macro.endstyleproperty = "\\br"
+# \stylemethod {returntype} {methodname} {argtype} {argname} {html-target-id}
+# \target html-target-id
+# This property holds ...
+# (empty line)
+# \endstylemethod
+macro.stylemethod.HTML = "<div class=\"qmlproto\"><table class=\"qmlname\"><tbody><tr valign=\"top\" class=\"odd\" id=\"\5\"><td class=\"tblQmlFuncNode\"><p><span class=\"type\">\1</span> <span class=\"name\">\2</span>(<span class="type">\3</span> <i>\4</i>)</p></td></tr></tbody></table></div>"
+macro.endstylemethod = "\\br"
+
# \stylecolor {#6A00FF} {(default)}
macro.stylecolor.HTML = "<div style=\"padding:10px;color:#fff;background:\1;\">\1 \2</div>"
diff --git a/src/imports/controls/doc/src/qtquickcontrols2-material.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-material.qdoc
index 45e0e9ce..62a4cbff 100644
--- a/src/imports/controls/doc/src/qtquickcontrols2-material.qdoc
+++ b/src/imports/controls/doc/src/qtquickcontrols2-material.qdoc
@@ -44,6 +44,12 @@
\li \l {theme-attached-prop}{\b theme} : enumeration
\endlist
+ \section1 Attached Methods
+
+ \list
+ \li color \l {color-attached-method}{\b color}(enumeration predefined)
+ \endlist
+
\section1 Detailed Description
\target detailed-desc-material
@@ -257,6 +263,24 @@
\endstyleproperty
+ \section1 Attached Method Documentation
+
+ \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}.
+
+ \qml
+ import QtQuick 2.0
+ import QtQuick.Controls.Material 2.0
+
+ Rectangle {
+ color: Material.color(Material.Red)
+ }
+ \endqml
+
+ \endstylemethod
+
\section1 Related Information
\list
diff --git a/src/imports/controls/doc/src/qtquickcontrols2-universal.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-universal.qdoc
index efb70a6e..34ab7ebe 100644
--- a/src/imports/controls/doc/src/qtquickcontrols2-universal.qdoc
+++ b/src/imports/controls/doc/src/qtquickcontrols2-universal.qdoc
@@ -43,6 +43,12 @@
\li \l {theme-attached-prop}{\b theme} : enumeration
\endlist
+ \section1 Attached Methods
+
+ \list
+ \li color \l {color-attached-method}{\b color}(enumeration predefined)
+ \endlist
+
\section1 Detailed Description
\target detailed-desc-universal
@@ -220,6 +226,24 @@
\endstyleproperty
+ \section1 Attached Method Documentation
+
+ \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}.
+
+ \qml
+ import QtQuick 2.0
+ import QtQuick.Controls.Universal 2.0
+
+ Rectangle {
+ color: Universal.color(Universal.Red)
+ }
+ \endqml
+
+ \endstylemethod
+
\section1 Related Information
\list