diff options
| author | Chris Adams <christopher.adams@nokia.com> | 2012-08-20 17:13:48 +1000 |
|---|---|---|
| committer | Qt by Nokia <qt-info@nokia.com> | 2012-08-27 08:13:24 +0200 |
| commit | e98a8b69cc0d900581942872b76ae81dc24931ee (patch) | |
| tree | 57a7fbae87a5936336e0d0a345a16adc4894de8d /src/qml/doc/src/syntax | |
| parent | 965588737321d10fd1fbca3f89b4c6257b7b5d47 (diff) | |
Move the Property Modifier Type documentation
Property Modifier Types are just another sort of QML object type, and
don't deserve explicit top-level documentation. This commit moves the
docs into the object types documentation, and adds documentation to the
syntax page about the "<PropertyModifierObject> on <propertyName>"
syntax.
Change-Id: Ia9b707739b562d2c8b75fa99b88795ba4d415cf7
Reviewed-by: Michael Brasser <michael.brasser@nokia.com>
Diffstat (limited to 'src/qml/doc/src/syntax')
| -rw-r--r-- | src/qml/doc/src/syntax/objectattributes.qdoc | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/src/qml/doc/src/syntax/objectattributes.qdoc b/src/qml/doc/src/syntax/objectattributes.qdoc index 894424cedd..314bd4512b 100644 --- a/src/qml/doc/src/syntax/objectattributes.qdoc +++ b/src/qml/doc/src/syntax/objectattributes.qdoc @@ -600,6 +600,34 @@ Item { \l {Property Aliases}{alias} property. +\section3 Property Modifier Objects + +Properties can have +\l{qtqml-cppintegration-definetypes.html#property-modifier-types} +{property value modifier objects} associated with them. +The syntax for declaring an instance of a property modifier type associated +with a particular property is as follows: + +\code +<PropertyModifierTypeName> on <propertyName> { + // attributes of the object instance +} +\endcode + +It is important to note that the above syntax is in fact an +\l{qtqml-syntax-basics.html#object-declarations}{object declaration} which +will instantiate an object which acts on a pre-existing property. + +Certain property modifier types may only be applicable to specific property +types, however this is not enforced by the language. For example, the +\c NumberAnimation type provided by \c QtQuick will only animate +numeric-type (such as \c int or \c real) properties. Attempting to use a +\c NumberAnimation with non-numeric property will not result in an error, +however the non-numeric property will not be animated. The behavior of a +property modifier type when associated with a particular property type is +defined by its implementation. + + \section2 Signal Attributes A signal is a notification from an object that some event has occurred: for |