From 1ddffbee547a702fad0669393dcf8e739007fbf1 Mon Sep 17 00:00:00 2001
From: J-P Nurmi <jpnurmi@digia.com>
Date: Thu, 30 May 2013 16:47:03 +0200
Subject: [PATCH] Styles docs: fix the styleData -tables
Change-Id: I75fb45d3f6b7b93f5758bd1664f9ff674a492772
Reviewed-by: Jens Bache-Wiig <jens.bache-wiig@digia.com>
---
src/styles/Base/ButtonStyle.qml | 4 +--
src/styles/Base/CheckBoxStyle.qml | 16 ++++++++++--
src/styles/Base/ComboBoxStyle.qml | 4 +--
src/styles/Base/RadioButtonStyle.qml | 4 +--
src/styles/Base/ScrollViewStyle.qml | 38 ++++++++++++++--------------
src/styles/Base/TabViewStyle.qml | 15 ++++++-----
6 files changed, 47 insertions(+), 34 deletions(-)
diff --git a/src/styles/Base/ButtonStyle.qml b/src/styles/Base/ButtonStyle.qml
index fe37d1708..b1fabb866 100644
--- a/src/styles/Base/ButtonStyle.qml
+++ b/src/styles/Base/ButtonStyle.qml
@@ -96,7 +96,7 @@ Style {
properties of \c control, the following state properties are available:
\table
- \li readonly property bool styleData.hovered - The control is being hovered.
+ \row \li readonly property bool \b styleData.hovered \li The control is being hovered.
\endtable
*/
property Component background: Item {
@@ -139,7 +139,7 @@ Style {
properties of \c control, the following state properties are available:
\table
- \li readonly property bool styleData.hovered - The control is being hovered.
+ \row \li readonly property bool \b styleData.hovered \li The control is being hovered.
\endtable
*/
property Component label: Text {
diff --git a/src/styles/Base/CheckBoxStyle.qml b/src/styles/Base/CheckBoxStyle.qml
index 4311c6294..65b5450b2 100644
--- a/src/styles/Base/CheckBoxStyle.qml
+++ b/src/styles/Base/CheckBoxStyle.qml
@@ -83,7 +83,13 @@ Style {
SystemPalette.Active : SystemPalette.Disabled
}
- /*! The text label. */
+ /*! This defines the text label. In addition to the public
+ properties of \c control, the following state properties are available:
+
+ \table
+ \row \li readonly property bool \b styleData.hovered \li The control is being hovered.
+ \endtable
+ */
property Component label: Text {
text: control.text
color: __syspal.text
@@ -102,7 +108,13 @@ Style {
/*! The spacing between indicator and label. */
property int spacing: 4
- /*! The indicator button. */
+ /*! This defines the indicator button. In addition to the public
+ properties of \c control, the following state properties are available:
+
+ \table
+ \row \li readonly property bool \b styleData.hovered \li The control is being hovered.
+ \endtable
+ */
property Component indicator: Item {
implicitWidth: 18
implicitHeight: 18
diff --git a/src/styles/Base/ComboBoxStyle.qml b/src/styles/Base/ComboBoxStyle.qml
index 08382f159..982ce00ef 100644
--- a/src/styles/Base/ComboBoxStyle.qml
+++ b/src/styles/Base/ComboBoxStyle.qml
@@ -66,7 +66,7 @@ Style {
properties of \c control, the following state properties are available:
\table
- \li readonly property bool styleData.hovered - The control is being hovered.
+ \row \li readonly property bool \b styleData.hovered \li The control is being hovered.
\endtable
*/
property Component background: Item {
@@ -108,7 +108,7 @@ Style {
properties of \c control, the following state properties are available:
\table
- \li readonly property bool styleData.hovered - The control is being hovered.
+ \row \li readonly property bool \b styleData.hovered \li The control is being hovered.
\endtable
*/
property Component label: Item {
diff --git a/src/styles/Base/RadioButtonStyle.qml b/src/styles/Base/RadioButtonStyle.qml
index f8fdb6472..d87f57c7c 100644
--- a/src/styles/Base/RadioButtonStyle.qml
+++ b/src/styles/Base/RadioButtonStyle.qml
@@ -87,7 +87,7 @@ Style {
properties of \c control, the following state properties are available:
\table
- \li readonly property bool styleData.hovered - The control is being hovered.
+ \row \li readonly property bool \b styleData.hovered \li The control is being hovered.
\endtable
*/
property Component label: Text {
@@ -107,7 +107,7 @@ Style {
properties of \c control, the following state properties are available:
\table
- \li readonly property bool styleData.hovered - The control is being hovered.
+ \row \li readonly property bool \b styleData.hovered \li The control is being hovered.
\endtable
*/
property Component indicator: Rectangle {
diff --git a/src/styles/Base/ScrollViewStyle.qml b/src/styles/Base/ScrollViewStyle.qml
index fb65fe2cc..3d1f8d26d 100644
--- a/src/styles/Base/ScrollViewStyle.qml
+++ b/src/styles/Base/ScrollViewStyle.qml
@@ -97,10 +97,10 @@ Style {
You can access the following state properties:
- \list
- \li property bool styleData.hovered
- \li property bool styleData.horizontal
- \endlist
+ \table
+ \row \li property bool \b styleData.hovered
+ \row \li property bool \b styleData.horizontal
+ \endtable
*/
property Component scrollBarBackground: Item {
@@ -123,11 +123,11 @@ Style {
You can access the following state properties:
- \list
- \li property bool styleData.hovered
- \li property bool styleData.pressed
- \li property bool styleData.horizontal
- \endlist
+ \table
+ \row \li property bool \b styleData.hovered
+ \row \li property bool \b styleData.pressed
+ \row \li property bool \b styleData.horizontal
+ \endtable
*/
property Component handle: BorderImage{
@@ -144,11 +144,11 @@ Style {
You can access the following state properties:
- \list
- \li property bool styleData.hovered
- \li property bool styleData.pressed
- \li property bool styleData.horizontal
- \endlist
+ \table
+ \row \li property bool \b styleData.hovered
+ \row \li property bool \b styleData.pressed
+ \row \li property bool \b styleData.horizontal
+ \endtable
*/
property Component incrementControl: Rectangle {
implicitWidth: 16
@@ -181,11 +181,11 @@ Style {
You can access the following state properties:
- \list
- \li property bool styleData.hovered
- \li property bool styleData.pressed
- \li property bool styleData.horizontal
- \endlist
+ \table
+ \row \li property bool \b styleData.hovered
+ \row \li property bool \b styleData.pressed
+ \row \li property bool \b styleData.horizontal
+ \endtable
*/
property Component decrementControl: Rectangle {
implicitWidth: 16
diff --git a/src/styles/Base/TabViewStyle.qml b/src/styles/Base/TabViewStyle.qml
index 344412b63..a668f43b0 100644
--- a/src/styles/Base/TabViewStyle.qml
+++ b/src/styles/Base/TabViewStyle.qml
@@ -122,13 +122,14 @@ Style {
\c styleData property, with the following properties:
\table
- \li readonly property int styleData.index - This is the current tab index.
- \li readonly property bool styleData.selected - This is the active tab.
- \li readonly property string styleData.title - Tab title text.
- \li readonly property bool styleData.nextSelected - The next tab is selected.
- \li readonly property bool styleData.previousSelected - The previous tab is selected.
- \li readonly property bool styleData.hovered - The tab is being hovered.
- \li readonly property bool styleData.activeFocus - The tab button has keyboard focus.
+ \row \li readonly property int \b styleData.index \li This is the current tab index.
+ \row \li readonly property bool \b styleData.selected \li This is the active tab.
+ \row \li readonly property string \b styleData.title \li Tab title text.
+ \row \li readonly property bool \b styleData.nextSelected \li The next tab is selected.
+ \row \li readonly property bool \b styleData.previousSelected \li The previous tab is selected.
+ \row \li readonly property bool \b styleData.hovered \li The tab is being hovered.
+ \row \li readonly property bool \b styleData.activeFocus \li The tab button has keyboard focus.
+ \row \li readonly property bool \b styleData.availableWidth \li The available width for the tabs.
\endtable
*/
property Component tab: Item {
--
GitLab