diff options
author | Jerome Pasion <jerome.pasion@digia.com> | 2013-03-25 12:37:22 +0100 |
---|---|---|
committer | The Qt Project <gerrit-noreply@qt-project.org> | 2013-03-26 22:45:31 +0100 |
commit | 363385a549f33b2b0a34ac9cc8149376f456655c (patch) | |
tree | ff7da1b3cbae0f42666a3cc30d26e32781f6dbbd /src/quick/doc/src/concepts/statesanimations | |
parent | aaa8fd67a499b75f8ec3dc4eea2b53bbdeff11d2 (diff) |
Doc: Fixed some uses of terminolgies in qdoc files.
-"element" -> "type" or "object" (not in all cases where this change applies)
-some instances of QtQuick. It should be "Qt Quick".
-only in qdoc files. Examples and source code changes will be done later.
Task-number: QTBUG-30180
Change-Id: Ie587461a138e97606f761ad1e90909c91b479303
Reviewed-by: Alan Alpert <aalpert@blackberry.com>
Reviewed-by: Martin Smith <martin.smith@digia.com>
Diffstat (limited to 'src/quick/doc/src/concepts/statesanimations')
3 files changed, 35 insertions, 35 deletions
diff --git a/src/quick/doc/src/concepts/statesanimations/animations.qdoc b/src/quick/doc/src/concepts/statesanimations/animations.qdoc index 438804ce41..dcf1d49a72 100644 --- a/src/quick/doc/src/concepts/statesanimations/animations.qdoc +++ b/src/quick/doc/src/concepts/statesanimations/animations.qdoc @@ -31,7 +31,7 @@ \title Animation and Transitions in Qt Quick \brief the animation system in Qt Quick -\section1 Animation and Transitions Elements +\section1 Animation and Transitions Types \generatelist{related} \list \li \l {Transition} - Animates transitions during state changes @@ -45,7 +45,7 @@ \li \l {ScriptAction} - Runs scripts during an animation \endlist -Elements that animate properties based on data types +Types that animate properties based on data types \annotatedlist qtquick-animation-properties \list \li \l {PropertyAnimation} - Animates property changes @@ -57,11 +57,11 @@ Elements that animate properties based on data types \li \l {AnchorAnimation} - Animates anchor changes \endlist -Animations are created by applying animation elements to property -values. Animation elements will interpolate property values to create smooth +Animations are created by applying animation types to property +values. Animation types will interpolate property values to create smooth transitions. As well, state transitions may assign animations to state changes. -To create an animation, use an appropriate animation element for the type of +To create an animation, use an appropriate animation type for the type of the property that is to be animated, and apply the animation depending on the type of behavior that is required. @@ -79,8 +79,8 @@ animations provide timing controls and allows different interpolations through \snippet qml/animation.qml property animation -Specialized \l{qml-property-animation-elements}{property animation elements} -have more efficient implementations than the \l{PropertyAnimation} element. They +Specialized \l{qml-property-animation-types}{property animation types} +have more efficient implementations than the \l{PropertyAnimation} type. They are for setting animations to different QML types such as \c int, \c color, and rotations. Similarly, the \l{ParentAnimation} can animate parent changes. @@ -152,8 +152,8 @@ values. abrupt property changes; animations smooth transitions to produce visually appealing state changes. -The \l{Transition} element can contain -\l{qml-animation-elements}{animation elements} to interpolate property changes +The \l{Transition} type can contain +\l{qml-animation-types}{animation types} to interpolate property changes caused by state changes. To assign the transition to an object, bind it to the \c transitions property. @@ -176,8 +176,8 @@ that the transition applies to any state change. \section2 Default Animation as Behaviors Default property animations are set using \e {behavior animations}. Animations -declared in \l {Behavior} elements apply to the property and animates any -property value changes. However, Behavior elements have an +declared in \l {Behavior} types apply to the property and animates any +property value changes. However, Behavior types have an \c enabled property to purposely enable or disable the behavior animations. A ball component might have a behavior animation assigned to its \c x, \c y, and @@ -204,8 +204,8 @@ sequence or in parallel. A banner component may have several icons or slogans to display, one after the other. The \c opacity property could transform to \c 1.0 denoting an opaque -object. Using the \l{SequentialAnimation} element, the opacity animations will -play after the preceding animation finishes. The \l{ParallelAnimation} element +object. Using the \l{SequentialAnimation} type, the opacity animations will +play after the preceding animation finishes. The \l{ParallelAnimation} type will play the animations at the same time. \snippet qml/animation.qml sequential animation @@ -214,7 +214,7 @@ Once individual animations are placed into a SequentialAnimation or ParallelAnimation, they can no longer be started and stopped independently. The sequential or parallel animation must be started and stopped as a group. -The \l SequentialAnimation element is also useful for playing +The \l SequentialAnimation type is also useful for playing \l{qml-transition-animations}{transition animations} because animations are played in parallel inside transitions. @@ -227,9 +227,9 @@ demonstration of creating and combining multiple animations in QML. There are different methods to control animations. \section2 Animation Playback -All animation types inherit from the \l Animation element. It is not -possible to create \l Animation objects; instead, this element provides the -essential properties and methods for animation elements. Animation elements have +All animation types inherit from the \l Animation type. It is not +possible to create \l Animation objects; instead, this type provides the +essential properties and methods for animation types. Animation types have \c{start()}, \c{stop()}, \c{resume()}, \c{pause()}, \c {restart()}, and \c{complete()} -- all of these methods control the execution of animations. @@ -249,9 +249,9 @@ to a particular curve. For more information about the easing curves, visit the The \l{declarative/animation/easing}{easing example} visually demonstrates each of the different easing types. -\section2 Other Animation Elements +\section2 Other Animation Types -In addition, QML provides several other elements useful for animation: +In addition, QML provides several other types useful for animation: \list \li PauseAnimation: enables pauses during animations @@ -261,7 +261,7 @@ be used together with StateChangeScript to reused existing scripts without animating the property change \endlist -These are specialized animation elements that animate different property types +These are specialized animation types that animate different property types \list \li SmoothedAnimation: a specialized NumberAnimation that provides smooth changes in animation when the target value changes diff --git a/src/quick/doc/src/concepts/statesanimations/states.qdoc b/src/quick/doc/src/concepts/statesanimations/states.qdoc index 7ef05ac2ac..d9978d454e 100644 --- a/src/quick/doc/src/concepts/statesanimations/states.qdoc +++ b/src/quick/doc/src/concepts/statesanimations/states.qdoc @@ -42,10 +42,10 @@ will turn off. In the \c caution state, the yellow light is on while the other lights are turned off. In QML, \e states are a set of property configurations defined in a \l State -element. Different configurations could, for example: +type. Different configurations could, for example: \list -\li Show some UI elements and hide others +\li Show some UI components and hide others \li Present different available actions to the user \li Start, stop, or pause animations \li Execute some script required in the new state @@ -59,7 +59,7 @@ property. Each state within a component has a unique \c name, an empty string being the default. To change the current state of an item, set the \l {Item::}{state} property to the name of the state. -Non-Item objects may use states through the \l StateGroup element. +Non-Item objects may use states through the \l StateGroup type. \section1 Creating States @@ -70,21 +70,21 @@ A warning \c signal component may have two states, the \c NORMAL and the \c CRITICAL state. Suppose that in the \c NORMAL state, the \c color of the signal should be \c green and the warning \c flag is down. Meanwhile, in the \c CRITICAL state, the \c color should be \c red and the flag is \c up. We may -model the states using the \c State element and the color and flag -configurations with the \c PropertyChanges element. +model the states using the \c State type and the color and flag +configurations with the \c PropertyChanges type. \snippet qml/states.qml signal states -The \l PropertyChanges element will change the values of object properties. +The \l PropertyChanges type will change the values of object properties. Objects are referenced through their \l{qtqml-syntax-objectattributes.html#the-id-assignment}{id}. Objects outside the component are also referenced using the \c id property, exemplified by the property change to the external \c flag object. Further, the state may change by assigning the \c state property with the -appropriate signal state. A state switch could be in a \l MouseArea element, +appropriate signal state. A state switch could be in a \l MouseArea type, assigning a different state whenever the signal receives a mouse click. \snippet qml/states.qml switch states -The State element is not limited to performing modifications on property values. +The State type is not limited to performing modifications on property values. It can also: \list \li Run some script using \l StateChangeScript @@ -103,7 +103,7 @@ will load the default state. \section1 The \c when Property -For convenience, the \l State element has a \c when property that can bind to +For convenience, the \l State type has a \c when property that can bind to expressions to change the state whenever the bound expression evaluates to \c true. The \c when property will revert the state back to the \l {The Default State}{default state} when the expression evaluates to false. @@ -114,7 +114,7 @@ The \c bell component will change to the \c RINGING state whenever the \section1 Animating State Changes -State changes induce abrupt value changes. The \l Transition element allow +State changes induce abrupt value changes. The \l Transition type allow smoother changes during state changes. In transitions, animations and interpolation behaviors are definable. The \l{qtquick-statesanimations-animations.html} diff --git a/src/quick/doc/src/concepts/statesanimations/topic.qdoc b/src/quick/doc/src/concepts/statesanimations/topic.qdoc index bbcee5a7d2..cb154a0370 100644 --- a/src/quick/doc/src/concepts/statesanimations/topic.qdoc +++ b/src/quick/doc/src/concepts/statesanimations/topic.qdoc @@ -54,7 +54,7 @@ part of a selection group. Each of those states may have certain associated visual appearance (neutral, highlighted, expanded, and so forth). -Qt Quick provides a \c{State} element with properties which define its semantics +Qt Quick provides a \c{State} type with properties which define its semantics and can be used to trigger behavior or animations. See the documentation about \l{qtquick-statesanimations-states.html}{Qt Quick States} for more information. @@ -66,7 +66,7 @@ that item will change. A transition is an "edge" between two states. It may trigger other events to occur, as other parts of the application may have behavior which is triggered when a certain state is entered or left. -Qt Quick provides the \c{Transition} element which has properties which define +Qt Quick provides the \c{Transition} type which has properties which define what will occur when the application changes from one state to another. See the documentation on \l{qtquick-statesanimations-animations.html#transitions-during-state-changes} @@ -84,9 +84,9 @@ changed, it can be moved in an fluidly animated fashion so that the eye of the user can track the change. These types of animations are supported in Qt Quick through various animation -and transition elements. See the documentation on +and transition types. See the documentation on \l{qtquick-statesanimations-animations.html} -{Animations and Transitions In Qt Quick} for information about these elements +{Animations and Transitions In Qt Quick} for information about these types and how to use them. @@ -107,7 +107,7 @@ is an example of a QML object Please see the documentation about \l{qtquick-statesanimations-animations.html#default-animation-as-behaviors} {default property animations} for more information about using the \l Behavior -element to provide default property change animations. +type to provide default property change animations. It is important to note, that using default property animations (via the \l Behavior type) in combination with state-transition animations can sometimes |