aboutsummaryrefslogtreecommitdiffstats
path: root/src/templates
diff options
context:
space:
mode:
authorJ-P Nurmi <jpnurmi@theqtcompany.com>2016-02-06 23:32:48 +0100
committerJ-P Nurmi <jpnurmi@theqtcompany.com>2016-02-06 22:38:53 +0000
commit43dc9a28aaae9f3b867a07719b415dfb8b26eaeb (patch)
tree66b76e3a4b61dc38c937b580b746250aff3cb1a2 /src/templates
parent15579da15891a3d16ee9f4cd3cf64e6c723920d2 (diff)
Docs: add missing \readonly tags
Change-Id: I314514bca07f9b23ac821d68ba8f3ce05341f1d9 Reviewed-by: J-P Nurmi <jpnurmi@theqtcompany.com>
Diffstat (limited to 'src/templates')
-rw-r--r--src/templates/qquickapplicationwindow.cpp7
-rw-r--r--src/templates/qquickcombobox.cpp1
-rw-r--r--src/templates/qquickcontrol.cpp3
-rw-r--r--src/templates/qquickdial.cpp4
-rw-r--r--src/templates/qquickslider.cpp1
-rw-r--r--src/templates/qquickstackview.cpp3
-rw-r--r--src/templates/qquickswipeview.cpp3
-rw-r--r--src/templates/qquickswitch.cpp2
-rw-r--r--src/templates/qquicktumbler.cpp2
9 files changed, 25 insertions, 1 deletions
diff --git a/src/templates/qquickapplicationwindow.cpp b/src/templates/qquickapplicationwindow.cpp
index 0903dcd5..b7a71a9f 100644
--- a/src/templates/qquickapplicationwindow.cpp
+++ b/src/templates/qquickapplicationwindow.cpp
@@ -324,6 +324,7 @@ QQuickItem *QQuickApplicationWindow::contentItem() const
/*!
\qmlproperty Control Qt.labs.controls::ApplicationWindow::activeFocusControl
+ \readonly
This property holds the control that currently has active focus, or \c null if there is
no control with active focus.
@@ -531,6 +532,7 @@ QQuickApplicationWindowAttached::QQuickApplicationWindowAttached(QObject *parent
/*!
\qmlattachedproperty ApplicationWindow Qt.labs.controls::ApplicationWindow::window
+ \readonly
This attached property holds the application window. The property can be attached
to any item. The value is \c null if the item is not in an ApplicationWindow.
@@ -543,6 +545,7 @@ QQuickApplicationWindow *QQuickApplicationWindowAttached::window() const
/*!
\qmlattachedproperty Item Qt.labs.controls::ApplicationWindow::contentItem
+ \readonly
This attached property holds the window content item. The property can be attached
to any item. The value is \c null if the item is not in an ApplicationWindow.
@@ -555,6 +558,7 @@ QQuickItem *QQuickApplicationWindowAttached::contentItem() const
/*!
\qmlattachedproperty Control Qt.labs.controls::ApplicationWindow::activeFocusControl
+ \readonly
This attached property holds the control that currently has active focus, or \c null
if there is no control with active focus. The property can be attached to any item.
@@ -571,6 +575,7 @@ QQuickItem *QQuickApplicationWindowAttached::activeFocusControl() const
/*!
\qmlattachedproperty Item Qt.labs.controls::ApplicationWindow::header
+ \readonly
This attached property holds the window header item. The property can be attached
to any item. The value is \c null if the item is not in an ApplicationWindow, or
@@ -584,6 +589,7 @@ QQuickItem *QQuickApplicationWindowAttached::header() const
/*!
\qmlattachedproperty Item Qt.labs.controls::ApplicationWindow::footer
+ \readonly
This attached property holds the window footer item. The property can be attached
to any item. The value is \c null if the item is not in an ApplicationWindow, or
@@ -597,6 +603,7 @@ QQuickItem *QQuickApplicationWindowAttached::footer() const
/*!
\qmlattachedproperty Item Qt.labs.controls::ApplicationWindow::overlay
+ \readonly
This attached property holds the window overlay item. The property can be attached
to any item. The value is \c null if the item is not in an ApplicationWindow.
diff --git a/src/templates/qquickcombobox.cpp b/src/templates/qquickcombobox.cpp
index dfb01e83..229201c5 100644
--- a/src/templates/qquickcombobox.cpp
+++ b/src/templates/qquickcombobox.cpp
@@ -447,6 +447,7 @@ void QQuickComboBox::setPressed(bool pressed)
}
/*!
+ \readonly
\qmlproperty int Qt.labs.controls::ComboBox::highlightedIndex
This property holds the index of the highlighted item in the combo box popup list.
diff --git a/src/templates/qquickcontrol.cpp b/src/templates/qquickcontrol.cpp
index 6bedfe3f..6f7045bd 100644
--- a/src/templates/qquickcontrol.cpp
+++ b/src/templates/qquickcontrol.cpp
@@ -418,6 +418,7 @@ void QQuickControl::resetFont()
/*!
\qmlproperty real Qt.labs.controls::Control::availableWidth
+ \readonly
This property holds the width available after deducting horizontal padding.
@@ -430,6 +431,7 @@ qreal QQuickControl::availableWidth() const
/*!
\qmlproperty real Qt.labs.controls::Control::availableHeight
+ \readonly
This property holds the height available after deducting vertical padding.
@@ -715,6 +717,7 @@ bool QQuickControl::isMirrored() const
/*!
\qmlproperty enumeration Qt.labs.controls::Control::focusReason
+ \readonly
This property holds the reason of the last focus change.
diff --git a/src/templates/qquickdial.cpp b/src/templates/qquickdial.cpp
index 830decb0..8d6e655a 100644
--- a/src/templates/qquickdial.cpp
+++ b/src/templates/qquickdial.cpp
@@ -254,6 +254,7 @@ void QQuickDial::setValue(qreal value)
/*!
\qmlproperty real Qt.labs.controls::Dial::position
+ \readonly
This property holds the logical position of the handle.
@@ -271,7 +272,8 @@ qreal QQuickDial::position() const
}
/*!
- \qmlproperty real Qt.labs.controls::Dial::angle \readonly
+ \qmlproperty real Qt.labs.controls::Dial::angle
+ \readonly
This property holds the angle of the handle.
diff --git a/src/templates/qquickslider.cpp b/src/templates/qquickslider.cpp
index e59b46e6..b62b8280 100644
--- a/src/templates/qquickslider.cpp
+++ b/src/templates/qquickslider.cpp
@@ -247,6 +247,7 @@ void QQuickSlider::setValue(qreal value)
/*!
\qmlproperty real Qt.labs.controls::Slider::position
+ \readonly
This property holds the logical position of the handle.
diff --git a/src/templates/qquickstackview.cpp b/src/templates/qquickstackview.cpp
index d5e2aee3..87cbfe31 100644
--- a/src/templates/qquickstackview.cpp
+++ b/src/templates/qquickstackview.cpp
@@ -931,6 +931,7 @@ QQuickStackAttached::~QQuickStackAttached()
/*!
\qmlattachedproperty int Qt.labs.controls::StackView::index
+ \readonly
This attached property holds the stack index of the item it's
attached to, or \c -1 if the item is not in a stack.
@@ -943,6 +944,7 @@ int QQuickStackAttached::index() const
/*!
\qmlattachedproperty StackView Qt.labs.controls::StackView::view
+ \readonly
This attached property holds the stack view of the item it's
attached to, or \c null if the item is not in a stack.
@@ -955,6 +957,7 @@ QQuickStackView *QQuickStackAttached::view() const
/*!
\qmlattachedproperty enumeration Qt.labs.controls::StackView::status
+ \readonly
This attached property holds the stack status of the item it's
attached to, or \c StackView.Inactive if the item is not in a stack.
diff --git a/src/templates/qquickswipeview.cpp b/src/templates/qquickswipeview.cpp
index f78d0120..117e3c20 100644
--- a/src/templates/qquickswipeview.cpp
+++ b/src/templates/qquickswipeview.cpp
@@ -133,6 +133,7 @@ void QQuickSwipeView::itemAdded(int, QQuickItem *item)
/*!
\qmlattachedproperty int Qt.labs.controls::SwipeView::index
+ \readonly
This attached property holds the index of each child item in the SwipeView.
@@ -141,6 +142,7 @@ void QQuickSwipeView::itemAdded(int, QQuickItem *item)
/*!
\qmlattachedproperty bool Qt.labs.controls::SwipeView::isCurrentItem
+ \readonly
This attached property is \c true if this child is the current item.
@@ -149,6 +151,7 @@ void QQuickSwipeView::itemAdded(int, QQuickItem *item)
/*!
\qmlattachedproperty SwipeView Qt.labs.controls::SwipeView::view
+ \readonly
This attached property holds the view that manages this child item.
diff --git a/src/templates/qquickswitch.cpp b/src/templates/qquickswitch.cpp
index f5c1a605..05422d8d 100644
--- a/src/templates/qquickswitch.cpp
+++ b/src/templates/qquickswitch.cpp
@@ -167,6 +167,7 @@ QQuickSwitch::QQuickSwitch(QQuickItem *parent) :
/*!
\qmlproperty real Qt.labs.controls::Switch::position
+ \readonly
This property holds the logical position of the thumb indicator.
@@ -196,6 +197,7 @@ void QQuickSwitch::setPosition(qreal position)
/*!
\qmlproperty real Qt.labs.controls::Switch::visualPosition
+ \readonly
This property holds the visual position of the thumb indicator.
diff --git a/src/templates/qquicktumbler.cpp b/src/templates/qquicktumbler.cpp
index 3818910a..c5b3f676 100644
--- a/src/templates/qquicktumbler.cpp
+++ b/src/templates/qquicktumbler.cpp
@@ -219,6 +219,7 @@ void QQuickTumbler::setModel(const QVariant &model)
/*!
\qmlproperty int Qt.labs.controls::Tumbler::count
+ \readonly
This property holds the number of items in the model.
*/
@@ -247,6 +248,7 @@ void QQuickTumbler::setCurrentIndex(int currentIndex)
/*!
\qmlproperty Item Qt.labs.controls::Tumbler::currentItem
+ \readonly
This property holds the item at the current index.
*/