diff options
author | Jerome Pasion <jerome.pasion@nokia.com> | 2011-02-21 16:39:56 (GMT) |
---|---|---|
committer | Jerome Pasion <jerome.pasion@nokia.com> | 2011-02-21 16:39:56 (GMT) |
commit | 1d054b71a4a97d197f345e100e1dc9ed8712199a (patch) | |
tree | b2385d4b056b4bea002965319d1eda8d9b7a9589 /doc/src/declarative | |
parent | 8cc0e2327eaffb14c135f229d49386f61f1e1cae (diff) | |
parent | d8b3a29279ff71a6415074872ec97dad6622c03d (diff) | |
download | Qt-1d054b71a4a97d197f345e100e1dc9ed8712199a.zip Qt-1d054b71a4a97d197f345e100e1dc9ed8712199a.tar.gz Qt-1d054b71a4a97d197f345e100e1dc9ed8712199a.tar.bz2 |
Merge branch '4.7' of scm.dev.nokia.troll.no:qt/qt-doc-team into 4.7
Conflicts:
doc/src/index.qdoc
doc/src/mainpage.qdoc
Diffstat (limited to 'doc/src/declarative')
-rw-r--r-- | doc/src/declarative/animation.qdoc | 2 | ||||
-rw-r--r-- | doc/src/declarative/basicelements.qdoc | 2 | ||||
-rw-r--r-- | doc/src/declarative/basictypes.qdoc | 2 | ||||
-rw-r--r-- | doc/src/declarative/dynamicobjects.qdoc | 12 | ||||
-rw-r--r-- | doc/src/declarative/elements.qdoc | 4 | ||||
-rw-r--r-- | doc/src/declarative/example-slideswitch.qdoc | 2 | ||||
-rw-r--r-- | doc/src/declarative/extending-tutorial.qdoc | 6 | ||||
-rw-r--r-- | doc/src/declarative/extending.qdoc | 6 | ||||
-rw-r--r-- | doc/src/declarative/javascriptblocks.qdoc | 3 | ||||
-rw-r--r-- | doc/src/declarative/mouseevents.qdoc | 5 | ||||
-rw-r--r-- | doc/src/declarative/propertybinding.qdoc | 25 | ||||
-rw-r--r-- | doc/src/declarative/qdeclarativestates.qdoc | 2 | ||||
-rw-r--r-- | doc/src/declarative/qmlevents.qdoc | 11 | ||||
-rw-r--r-- | doc/src/declarative/qmlreusablecomponents.qdoc | 6 | ||||
-rw-r--r-- | doc/src/declarative/qmlviews.qdoc | 13 | ||||
-rw-r--r-- | doc/src/declarative/qtquick-intro.qdoc | 2 | ||||
-rw-r--r-- | doc/src/declarative/tutorial.qdoc | 2 |
17 files changed, 50 insertions, 55 deletions
diff --git a/doc/src/declarative/animation.qdoc b/doc/src/declarative/animation.qdoc index 7247e73..129fa34 100644 --- a/doc/src/declarative/animation.qdoc +++ b/doc/src/declarative/animation.qdoc @@ -155,7 +155,7 @@ 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 +play after the preceding animation finishes. The \l{ParallelAnimation} element will play the animations at the same time. \snippet doc/src/snippets/declarative/animation.qml sequential animation diff --git a/doc/src/declarative/basicelements.qdoc b/doc/src/declarative/basicelements.qdoc index c0df307..0146591 100644 --- a/doc/src/declarative/basicelements.qdoc +++ b/doc/src/declarative/basicelements.qdoc @@ -51,7 +51,7 @@ This is a list of some of the elements readily available for users. \o \l {MouseArea} \endlist -For a complete list of QML elements, please visit the \l {QML Elements} page. +For a complete list of QML elements, please visit the \l {QML Elements} page. \section1 Properties and Qt Declarative Module diff --git a/doc/src/declarative/basictypes.qdoc b/doc/src/declarative/basictypes.qdoc index 453af08..1d9e28c 100644 --- a/doc/src/declarative/basictypes.qdoc +++ b/doc/src/declarative/basictypes.qdoc @@ -402,7 +402,7 @@ \c child1, \c child2 and \c child3 will be added to the children list in the order in which they appear. - List \l {Adding Properties}{properties} can be created as a + List \l {Property Binding}{properties} can be created as a \c variant type, or as a \c list<Type> type, where \c Type is the type of the object in the list: diff --git a/doc/src/declarative/dynamicobjects.qdoc b/doc/src/declarative/dynamicobjects.qdoc index a8339e0..7c10760 100644 --- a/doc/src/declarative/dynamicobjects.qdoc +++ b/doc/src/declarative/dynamicobjects.qdoc @@ -59,7 +59,7 @@ creating an item from a string of QML is useful when the item QML itself is gene at runtime. -\section2 Creating a Component dynamically +\section2 Creating a Component Dynamically To dynamically load a component defined in a QML file, call the \l {QML:Qt::createComponent()}{Qt.createComponent()} function on the \l{QML Global Object}. @@ -112,11 +112,13 @@ Notice in both instances, \l {Component::createObject()}{createObject()} is call When using files with relative paths, the path should be relative to the file where \l {QML:Qt::createComponent()}{Qt.createComponent()} is executed. -To connect signals to (or receive signals from) dynamically created objects, use the signal -\c connect() method. See \l {Connecting signals to methods and other signals} for more information. +To connect signals to (or receive signals from) dynamically created objects, +use the signal \c connect() method. See +\l{QML Signal and Handler Event System#Connecting Signals to Methods and Signals} +{Connecting Signals to Methods and Signals} for more information. -\section2 Creating an object from a string of QML +\section2 Creating an Object from a String of QML If the QML is not defined until runtime, you can create a QML item from a string of QML using the \l{QML:Qt::createQmlObject()}{Qt.createQmlObject()} function, as in the following example: @@ -208,6 +210,4 @@ can similarly be destroyed using \c destroy(): \snippet doc/src/snippets/declarative/createQmlObject.qml 0 \snippet doc/src/snippets/declarative/createQmlObject.qml destroy - */ - diff --git a/doc/src/declarative/elements.qdoc b/doc/src/declarative/elements.qdoc index c087f17..ff8e201 100644 --- a/doc/src/declarative/elements.qdoc +++ b/doc/src/declarative/elements.qdoc @@ -55,7 +55,7 @@ To see the QML elements listed by functional area, see the \o \l {BorderImage} - Allows the use of images as borders \o \l {AnimatedImage} - For playing animations stored in a series of frames \o \l {Gradient} - For defining a color gradient -\o \l {GradientStop} - Used to define a color within a \l {Gradient} +\o \l {GradientStop} - Used to define a color within a \l {Gradient} \o \l {SystemPalette} - Provides access to the Qt palettes \endlist @@ -75,7 +75,7 @@ To see the QML elements listed by functional area, see the \o \l {MouseArea} - Sets up an area for mouse interaction \o \l {Keys} - Provides components with attached properties to handle key input. \o \l {FocusScope} - Element that mediate keyboard focus changes -\o \l {Flickable} - Provides a surface that can be "flicked" +\o \l {Flickable} - Provides a surface that can be "flicked" \o \l {Flipable} - Provides a surface that produces "flipping" effects \o \l {GestureArea} - Enables simple gesture handling \endlist diff --git a/doc/src/declarative/example-slideswitch.qdoc b/doc/src/declarative/example-slideswitch.qdoc index 54ee2c7..482a292 100644 --- a/doc/src/declarative/example-slideswitch.qdoc +++ b/doc/src/declarative/example-slideswitch.qdoc @@ -121,7 +121,7 @@ For more information on scripts see \l{Integrating JavaScript}. At this point, when the switch toggles between the two states the knob will instantly change its \c x position between 1 and 78. In order for the the knob to move smoothly we add a transition that will animate the \c x property with an easing curve for a duration of 200ms. -For more information on transitions see \l{qdeclarativeanimation.html#transitions}{QML Transitions}. +For more information on transitions see \l{QML Animation and Transitions}. \section1 Usage The switch can be used in a QML file, like this: diff --git a/doc/src/declarative/extending-tutorial.qdoc b/doc/src/declarative/extending-tutorial.qdoc index 09a8ad9..0ddc430 100644 --- a/doc/src/declarative/extending-tutorial.qdoc +++ b/doc/src/declarative/extending-tutorial.qdoc @@ -27,7 +27,7 @@ /*! \page qml-extending-tutorial-index.html -\title Tutorial: Writing QML extensions with C++ +\title Tutorial: Writing QML Extensions with C++ The Qt Declarative module provides a set of APIs for extending QML through C++ extensions. You can write extensions to add your own QML types, extend existing @@ -45,7 +45,7 @@ Tutorial chapters: \list 1 \o \l{declarative/tutorials/extending/chapter1-basics}{Creating a New Type} \o \l{declarative/tutorials/extending/chapter2-methods}{Connecting to C++ Methods and Signals} -\o \l{declarative/tutorials/extending/chapter3-bindings}{Adding Property Bindings} +\o \l{declarative/tutorials/extending/chapter3-bindings}{Property Binding} \o \l{declarative/tutorials/extending/chapter4-customPropertyTypes}{Using Custom Property Types} \o \l{declarative/tutorials/extending/chapter5-listproperties}{Using List Property Types} \o \l{declarative/tutorials/extending/chapter6-plugins}{Writing an Extension Plugin} @@ -286,7 +286,7 @@ int-type property to store an identifier for each chart: \endcode We can also use various other property types. QML has built-in support for the types -listed in the \l{Adding Properties} documentation, which includes the following: +listed in the \l{QML Basic Types} documentation, which includes the following: \list \o bool, unsigned int, int, float, double, qreal diff --git a/doc/src/declarative/extending.qdoc b/doc/src/declarative/extending.qdoc index 0cbdd11..0f69bdb 100644 --- a/doc/src/declarative/extending.qdoc +++ b/doc/src/declarative/extending.qdoc @@ -86,7 +86,7 @@ Types can be registered by libraries, application code, or by plugins Once registered, all \l {Qt's Property System}{properties} of the supported types are available in QML. QML has intrinsic support for -properties of the types listed in the \l{Adding Properties} +properties of the types listed in the \l{QML Basic Types} document, which includes the following: \list @@ -481,7 +481,7 @@ but different parameters cannot be distinguished. Signal parameters become accessible by name to the assigned script. An unnamed parameter cannot be accessed, so care should be taken to name all the signal parameters in the C++ class declaration. The intrinsic types -listed in \l {Adding Types}, as well registered object types are permitted as +listed in \l{Adding Types}, as well registered object types are permitted as signal parameter types. Using other types is not an error, but the parameter value will not be accessible from script. @@ -705,6 +705,4 @@ public: } }; \endcode - */ - diff --git a/doc/src/declarative/javascriptblocks.qdoc b/doc/src/declarative/javascriptblocks.qdoc index 65877f9..7ef7f9a 100644 --- a/doc/src/declarative/javascriptblocks.qdoc +++ b/doc/src/declarative/javascriptblocks.qdoc @@ -224,7 +224,8 @@ in \c script.js: The \c jsFunction() will now be called whenever MouseArea's \c clicked signal is emitted. -See \l {Connecting signals to methods and other signals} for more information. +See \l{QML Signal and Handler Event System#Connecting Signals to Methods and Signals} +{Connecting Signals to Methods and Signals} for more information. \section1 QML JavaScript Restrictions diff --git a/doc/src/declarative/mouseevents.qdoc b/doc/src/declarative/mouseevents.qdoc index 533f64b..ade6760 100644 --- a/doc/src/declarative/mouseevents.qdoc +++ b/doc/src/declarative/mouseevents.qdoc @@ -64,9 +64,9 @@ definable. The MouseArea element provides \l{QML Signal and Handler Event System}{signals and handlers} to detect different mouse events. The \l MouseArea element documentation describes these -gestures in greater detail. +gestures in greater detail: -\list Mouse Gestures +\list \o canceled \o clicked \o doubleClicked @@ -117,5 +117,4 @@ such as double clicking. To facilitate the classification of mouse clicks, the MouseEvent object has an \c accepted property to disable the event propagation. To learn more about QML's event system, please read the \l {QML Signal and Handler Event System} document. - */ diff --git a/doc/src/declarative/propertybinding.qdoc b/doc/src/declarative/propertybinding.qdoc index 22d14a8..afbbe4f 100644 --- a/doc/src/declarative/propertybinding.qdoc +++ b/doc/src/declarative/propertybinding.qdoc @@ -40,9 +40,8 @@ In QML, properties serve many purposes but their main function is to bind to values. Values may be a \l{QML Basic Types}{basic type}, or other QML elements. The syntax for properties is: -\qml - [default] property <type> <name>[: defaultValue] -\endqml + +\tt{[default] property <type> <name>[: defaultValue]} Elements already possess useful properties but, to create custom properties, precede the property name with the keyword \c property. @@ -58,6 +57,7 @@ property names must begin with a lowercase letter. names. \section1 Property Binding + Property binding is a declarative way of specifying the value of a property. Binding allows a property's value to be expressed as an JavaScript expression that defines the value relative to other property values or data accessible in the application. The property value is @@ -87,7 +87,7 @@ binding is created using the colon "\c {:}". The property binding causes the width of the \c Rectangle to update whenever the \c {parent}'s width changes. -Assigning a property value (using the equals sign "\c {=}") does not create a +Assigning a property value (using the equals sign "\c {=}") does not create a property binding. \snippet doc/src/snippets/declarative/properties.qml property assignment @@ -102,13 +102,15 @@ There is no way to create a property binding directly from imperative JavaScript although it is possible to use the \l {Using the Binding Element}{Binding} element. \section1 Types of Properties + Properties may bind to different types, but they are are \e type-safe. That is, properties only allow you to assign a value that matches the property type. For example, if a property is a real, and if you try to assign a string to it you will get an error. -\qml - property real volume: "four" //generates an error -\endqml + +\badcode +property real volume: "four" //generates an error +\endcode Certain properties bind to more complex types such as other elements and objects. @@ -150,7 +152,7 @@ The code snippet has a \l Gradient element that attempts to print its parent's \c width value. However, the \c Gradient element is bound to the \c gradient property, not the \c children property of the \c Rectangle. As a result, the \c Gradient does not have the \c Rectangle as its parent. Printing the value -of \c{parent.width} generates an error. Printing the \c Rectangle object's +of \c{parent.width} generates an error. Printing the \c Rectangle object's first child's \c name will print \c {childrectangle} because the second \c Rectangle is bound to the \c children property. @@ -224,9 +226,8 @@ the property, a property alias connects the newly declared property, called the in a read or write operations on the aliased property, respectively. A property alias declaration is similar to an ordinary property definition: -\code - [default] property alias <name>: <alias reference> -\endcode + +\tt{[default] property alias <name>: <alias reference>} As the aliasing property has the same type as the aliased property, an explicit type is omitted, and the special \c alias keyword is before the property name. @@ -319,6 +320,4 @@ The \l PropertyChanges element is for setting property bindings within a \snippet doc/src/snippets/declarative/properties.qml PropertyChanges element The rectangle's \c color property will bind to the \c warning component's \c color property when its \c state is set to the \c WARNING state. - */ - diff --git a/doc/src/declarative/qdeclarativestates.qdoc b/doc/src/declarative/qdeclarativestates.qdoc index b1a97d7..655b647 100644 --- a/doc/src/declarative/qdeclarativestates.qdoc +++ b/doc/src/declarative/qdeclarativestates.qdoc @@ -123,7 +123,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 Transitions element allow +State changes induce abrupt value changes. The \l Transition element allow smoother changes during state changes. In transitions, animations and interpolation behaviors are definable. The \l {QML Animation and Transitions}{Animation and Transitions} article has more diff --git a/doc/src/declarative/qmlevents.qdoc b/doc/src/declarative/qmlevents.qdoc index 7dfb1f9..566f71c 100644 --- a/doc/src/declarative/qmlevents.qdoc +++ b/doc/src/declarative/qmlevents.qdoc @@ -47,9 +47,7 @@ has been clicked within the area. The syntax for defining a new signal is: -\qml -signal <name>[([<type> <parameter name>[, ...]])] -\endqml +\tt{signal <name>[([<type> <parameter name>[, ...]])]} Attempting to declare two signals or methods with the same name in the same type block generates an error. However, a new signal may reuse the name of an existing signal on the type. (This should be done with caution, as the existing signal may be hidden and become inaccessible.) @@ -119,10 +117,11 @@ output: Because QML uses Qt, a signal defined in C++ also works as a QML signal. The signal may be emitted in QML code or called as a method. In addition, the QML runtime automatically creates signal handlers for the C++ signals. For more -signal control, the \c connect() method and the \l Connect element may connect a -C++ to another signal or method. +signal control, the \c connect() method and the \l Connections element may connect +a C++ signal to another signal or method. -For complete information on how to call C++ functions in QML, read the \l {Extending QML - Signal Support Example}. +For complete information on how to call C++ functions in QML, read the +\l{Extending QML - Signal Support Example}. */ diff --git a/doc/src/declarative/qmlreusablecomponents.qdoc b/doc/src/declarative/qmlreusablecomponents.qdoc index e6c3ec9..ee360eb 100644 --- a/doc/src/declarative/qmlreusablecomponents.qdoc +++ b/doc/src/declarative/qmlreusablecomponents.qdoc @@ -29,7 +29,7 @@ \page qmlreusablecomponents.html \ingroup qml-features \previouspage {QML Signal and Handler Event System}{Signal and Handler Event System} -\nextpage {QML States}{States} +\nextpage {QML States}{States} \contentspage QML Features \title Importing Reusable Components @@ -89,7 +89,7 @@ however, be in an imported path. A consequence of inline components is that initialization may be deferred or delayed. A component may be created during a MouseArea event or by using a \l Loader element. The component can create an object, which is addressable in a -similar way as an \l {qml-id-propert}{id property}. Thus, the created object may +similar way as an \l {qml-id-property}{id property}. Thus, the created object may have its bindings set and read like a normal QML object. \snippet doc/src/snippets/declarative/reusablecomponents/component.qml define inline component \snippet doc/src/snippets/declarative/reusablecomponents/component.qml create inline component @@ -103,7 +103,7 @@ Specifically, there are \l{attached-properties}{attached properties} and \l{attached-signalhandlers}{attached signal handlers} for setting properties during the lifetime of a component. -The \c{Component.onCompleted} attached signal handler is called when the +The \c{Component.onCompleted} attached signal handler is called when the component completes initialization. It is useful for executing any commands after component initialization. Similarly, the \c{Component.onDestruction} signal handler executes when the component finishes destruction. diff --git a/doc/src/declarative/qmlviews.qdoc b/doc/src/declarative/qmlviews.qdoc index 8b2ca96..4071d5d 100644 --- a/doc/src/declarative/qmlviews.qdoc +++ b/doc/src/declarative/qmlviews.qdoc @@ -44,7 +44,7 @@ graphical elements: \o \l{ListView} arranges items in a horizontal or vertical list \o \l{GridView} arranges items in a grid within the available space \o \l{PathView} arranges items on a path -\o \l{WebView}{WebView} - available from the \l {QtWebKit QML Module}. +\o \l{WebView}{WebView} - available from the \l {QtWebKit QML Module}. \endlist Unlike other views, \l WebView is not a fully-featured view item, and needs to be combined with a \l Flickable item to create a view that performs like @@ -103,12 +103,11 @@ the person belongs. \snippet doc/src/snippets/declarative/listview-sections.qml delegate The ListView element has the \c section -\l{qml-attached-properties}{attached property} that can combine adjacent -and related elements into a section. The section's \c property property is for -selecting which list element property to use as sections. The \c criteria -can dictate how the section names are displayed and the \c delegate is similar -to the views' \l {qml-view-delegate}{delegate} property. +\l{Property Binding#Attached Properties}{attached property} that can combine +adjacent and related elements into a section. The section's \c property +property is for selecting which list element property to use as sections. +The \c criteria can dictate how the section names are displayed and the +\c delegate is similar to the views' \l {qml-view-delegate}{delegate} property. \snippet doc/src/snippets/declarative/listview-sections.qml section \image listview-section.png - */ diff --git a/doc/src/declarative/qtquick-intro.qdoc b/doc/src/declarative/qtquick-intro.qdoc index 1bbae8f..02b2c44 100644 --- a/doc/src/declarative/qtquick-intro.qdoc +++ b/doc/src/declarative/qtquick-intro.qdoc @@ -109,7 +109,7 @@ system. \section1 Where to Go from Here -The \l {Qt Quick} page has links to various Qt Quick topics such as QML +The \l {Qt Quick} page has links to various Qt Quick topics such as QML features, addons, and tools. The \l {QML Examples and Demos} page has a gallery of QML applications. diff --git a/doc/src/declarative/tutorial.qdoc b/doc/src/declarative/tutorial.qdoc index 1ee5e61..dc08ba0 100644 --- a/doc/src/declarative/tutorial.qdoc +++ b/doc/src/declarative/tutorial.qdoc @@ -144,7 +144,7 @@ An \l Item is the most basic visual element in QML and is often used as a contai We declare a \c cellColor property. This property is accessible from \e outside our component, this allows us to instantiate the cells with different colors. -This property is just an alias to an existing property - the color of the rectangle that compose the cell (see \l{Adding Properties}). +This property is just an alias to an existing property - the color of the rectangle that compose the cell (see \l{Property Binding}). \snippet examples/declarative/tutorials/helloworld/Cell.qml 5 |