summaryrefslogtreecommitdiffstats
path: root/src/declarative
diff options
context:
space:
mode:
authorBea Lam <bea.lam@nokia.com>2009-11-25 01:33:49 (GMT)
committerBea Lam <bea.lam@nokia.com>2009-11-25 01:33:49 (GMT)
commit5271a2f1a1bbc7eae45824d3aa860d53e3879b79 (patch)
tree8819cf23c7512dd433998653adfbd6fabffb3008 /src/declarative
parentb45102dfd37112a754dd54f3e53ca6fce08f24cc (diff)
downloadQt-5271a2f1a1bbc7eae45824d3aa860d53e3879b79.zip
Qt-5271a2f1a1bbc7eae45824d3aa860d53e3879b79.tar.gz
Qt-5271a2f1a1bbc7eae45824d3aa860d53e3879b79.tar.bz2
Doc improvements
Diffstat (limited to 'src/declarative')
-rw-r--r--src/declarative/graphicsitems/qmlgraphicseffects.cpp27
-rw-r--r--src/declarative/graphicsitems/qmlgraphicstextedit.cpp2
-rw-r--r--src/declarative/util/qmlpropertychanges.cpp37
-rw-r--r--src/declarative/util/qmltimer.cpp25
4 files changed, 54 insertions, 37 deletions
diff --git a/src/declarative/graphicsitems/qmlgraphicseffects.cpp b/src/declarative/graphicsitems/qmlgraphicseffects.cpp
index 2f0aae7..0523fd5 100644
--- a/src/declarative/graphicsitems/qmlgraphicseffects.cpp
+++ b/src/declarative/graphicsitems/qmlgraphicseffects.cpp
@@ -51,10 +51,10 @@ QML_DEFINE_TYPE(Qt,4,6,Blur,QGraphicsBlurEffect)
\qmlclass Blur QGraphicsBlurEffect
\brief The Blur object provides a blur effect.
- A blur effect blurs the source item. This effect is useful for reducing details,
- such as when the source loses focus and you want to draw attention to other
- elements. The level of detail can be modified using the blurRadius property.
- Use blurHint to choose the quality or performance blur hints.
+ A blur effect blurs the source item. This effect is useful for reducing details;
+ for example, when the a source loses focus and attention should be drawn to other
+ elements. Use blurRadius to control the level of detail and blurHint to control
+ the quality of the blur.
By default, the blur radius is 5 pixels.
@@ -64,21 +64,22 @@ QML_DEFINE_TYPE(Qt,4,6,Blur,QGraphicsBlurEffect)
/*!
\qmlproperty real Blur::blurRadius
- blurRadius controls how blurry an item will appear.
- Using a smaller radius results in a sharper appearance, whereas a bigger
- radius results in a more blurred appearance.
+ This controls how blurry an item will appear.
- By default, the blur radius is 5 pixels.
+ A smaller radius produces a sharper appearance, and a larger radius produces
+ a more blurred appearance.
+
+ The default radius is 5 pixels.
*/
/*!
\qmlproperty enumeration Blur::blurHint
- Use the Qt.PerformanceHint hint to say that you want a faster blur,
- and the Qt.QualityHint hint to say that you prefer a higher quality blur.
-
- When animating the blur radius it's recommended to use Qt.PerformanceHint.
+ Use Qt.PerformanceHint to specify a faster blur or Qt.QualityHint hint
+ to specify a higher quality blur.
+
+ If the blur radius is animated, it is recommended you use Qt.PerformanceHint.
- By default, the blur hint is Qt.PerformanceHint.
+ The default hint is Qt.PerformanceHint.
*/
QML_DECLARE_TYPE(QGraphicsColorizeEffect)
diff --git a/src/declarative/graphicsitems/qmlgraphicstextedit.cpp b/src/declarative/graphicsitems/qmlgraphicstextedit.cpp
index 2588f7d..bec2ff8 100644
--- a/src/declarative/graphicsitems/qmlgraphicstextedit.cpp
+++ b/src/declarative/graphicsitems/qmlgraphicstextedit.cpp
@@ -563,7 +563,7 @@ QString QmlGraphicsTextEdit::selectedText() const
\qmlproperty bool TextEdit::focusOnPress
Whether the TextEdit should gain focus on a mouse press. By default this is
- set to false;
+ set to false.
*/
bool QmlGraphicsTextEdit::focusOnPress() const
{
diff --git a/src/declarative/util/qmlpropertychanges.cpp b/src/declarative/util/qmlpropertychanges.cpp
index 6a393ee..9ca6db8 100644
--- a/src/declarative/util/qmlpropertychanges.cpp
+++ b/src/declarative/util/qmlpropertychanges.cpp
@@ -56,19 +56,32 @@ QT_BEGIN_NAMESPACE
\qmlclass PropertyChanges QmlPropertyChanges
\brief The PropertyChanges element describes new property values for a state.
- PropertyChanges changes the properties of an item. It allows you to specify the property
- names and values for a state similar to how you normally would specify them for the
- actual item:
+ PropertyChanges provides a state change that modifies the properties of an item.
- \code
- PropertyChanges {
- target: myRect
- x: 52
- y: 300
- width: 48
- }
- \endcode
+ Here is a property change that modifies the text and color of a Text element
+ when it is clicked:
+
+ \qml
+ Text {
+ id: myText
+ width: 100; height: 100
+ text: "Hello"
+ color: "blue"
+
+ states: State {
+ name: "myState"
+
+ PropertyChanges {
+ target: myText
+ text: "Goodbye"
+ color: "red"
+ }
+ }
+ MouseRegion { anchors.fill: parent; onClicked: myText.state = 'myState' }
+ }
+ \endqml
+
State-specific script for signal handlers can also be specified:
\qml
@@ -92,7 +105,7 @@ QT_BEGIN_NAMESPACE
/*!
\qmlproperty Object PropertyChanges::target
- This property holds the object that the properties to change belong to
+ This property holds the object which contains the properties to be changed.
*/
class QmlReplaceSignalHandler : public ActionEvent
diff --git a/src/declarative/util/qmltimer.cpp b/src/declarative/util/qmltimer.cpp
index 0be62f4..6ac4e32 100644
--- a/src/declarative/util/qmltimer.cpp
+++ b/src/declarative/util/qmltimer.cpp
@@ -72,6 +72,9 @@ public:
A timer can be used to trigger an action either once, or repeatedly
at a given interval.
+ Here is a timer that shows the current date and time, and updates
+ the text every 500 milliseconds:
+
\qml
Timer {
interval: 500; running: true; repeat: true
@@ -101,7 +104,7 @@ QmlTimer::QmlTimer(QObject *parent)
/*!
\qmlproperty int Timer::interval
- Sets the \a interval in milliseconds between triggering.
+ Sets the \a interval between triggers, in milliseconds.
The default interval is 1000 milliseconds.
*/
@@ -124,7 +127,7 @@ int QmlTimer::interval() const
\qmlproperty bool Timer::running
If set to true, starts the timer; otherwise stops the timer.
- For a non-repeating timer, \a running will be set to false after the
+ For a non-repeating timer, \a running is set to false after the
timer has been triggered.
\a running defaults to false.
@@ -150,7 +153,7 @@ void QmlTimer::setRunning(bool running)
/*!
\qmlproperty bool Timer::repeat
- If \a repeat is true the timer will be triggered repeatedly at the
+ If \a repeat is true the timer is triggered repeatedly at the
specified interval; otherwise, the timer will trigger once at the
specified interval and then stop (i.e. running will be set to false).
@@ -176,15 +179,15 @@ void QmlTimer::setRepeating(bool repeating)
/*!
\qmlproperty bool Timer::triggeredOnStart
- When the Timer is started the first trigger is normally after the specified
- interval has elapsed. It is sometimes desireable to trigger immediately
- when the timer is started, for example to establish an initial
+ When a timer is started, the first trigger is usually after the specified
+ interval has elapsed. It is sometimes desirable to trigger immediately
+ when the timer is started; for example, to establish an initial
state.
- If \a triggeredOnStart is true, the timer will be triggered immediately
- when started, and subsequently at the specified interval. Note that for
- a Timer with \e repeat set to false, this will result in the timer being
- triggered twice; once on start, and again at the interval.
+ If \a triggeredOnStart is true, the timer is triggered immediately
+ when started, and subsequently at the specified interval. Note that if
+ \e repeat is set to false, the timer is triggered twice; once on start,
+ and again at the interval.
\a triggeredOnStart defaults to false.
@@ -219,7 +222,7 @@ void QmlTimer::start()
/*!
\qmlmethod Timer::stop()
- \brief stops the timer.
+ \brief Stops the timer.
If the timer is not running, calling this method has no effect. The
\c running property will be false following a call to \c stop().