diff options
Diffstat (limited to 'src/quick/doc/src/appdevguide')
7 files changed, 32 insertions, 32 deletions
diff --git a/src/quick/doc/src/appdevguide/performance.qdoc b/src/quick/doc/src/appdevguide/performance.qdoc index 28217e06d6..9dcfc961ba 100644 --- a/src/quick/doc/src/appdevguide/performance.qdoc +++ b/src/quick/doc/src/appdevguide/performance.qdoc @@ -143,8 +143,8 @@ conversion. If you must expose a QVariantMap to QML, use a "var" property rather than a "variant" property. In general, "property var" should be considered to be superior to -"property variant" for every use-case in QtQuick 2.0 (note that "property variant" -is marked as obsolete in the QtQuick 2.0 documentation), as it allows a true JavaScript +"property variant" for every use-case in Qt Quick 2 (note that "property variant" +is marked as obsolete in the Qt Quick 2 documentation), as it allows a true JavaScript reference to be stored (which can reduce the number of conversions required in certain expressions). @@ -525,7 +525,7 @@ will have a negative impact on performance. \section2 Other JavaScript Objects Different JavaScript engines provide different optimizations. The JavaScript engine -which QtQuick 2 uses is optimized for object instantiation and property lookup, but +which \l {Qt Quick}{Qt Quick 2} uses is optimized for object instantiation and property lookup, but the optimizations which it provides relies on certain criteria. If your application does not meet the criteria, the JavaScript engine falls back to a "slow-path" mode with much worse performance. As such, always try to ensure you meet the following @@ -698,7 +698,7 @@ an application already uses one. \section3 Don't Use Dynamic Roles -The ListModel element in QtQuick 2.0 is much more performant than in QtQuick 1.0. The +The ListModel element in \c {QtQuick 2.0} is much more performant than in \c {QtQuick 1.0}. The performance improvements mainly come from assumptions about the type of roles within each element in a given model - if the type doesn't change, the caching performance improves dramatically. If the type can change dynamically from element to element, this optimization @@ -739,7 +739,7 @@ cause reduced frame rate when scrolling. \section1 Visual Effects -QtQuick 2 includes several features which allow developers and designers to create +\l {Qt Quick}{Qt Quick 2} includes several features which allow developers and designers to create exceptionally appealing user interfaces. Fluidity and dynamic transitions as well as visual effects can be used to great effect in an application, but some care must be taken when using some of the features in QML as they can have performance implications. @@ -759,7 +759,7 @@ thread (and therefore can cause frames to be skipped if they take too long to co \section2 Particles -The QtQuick 2.0 Particles module allows beautiful particle effects to be integrated +The \l {QtQuick.Particles 2}{Qt Quick 2.0 Particles} module allows beautiful particle effects to be integrated seamlessly into user interfaces. However every platform has different graphics hardware capabilities, and the Particles module is unable to limit parameters to what your hardware can gracefully support. The more particles you attempt to render (and the larger they are), @@ -834,7 +834,7 @@ See the upcoming section on Rendering for more information on active but invisib \section1 Rendering -The scene graph used for rendering in QtQuick 2.0 allows highly dynamic, animated user +The scene graph used for rendering in \c {QtQuick 2.0} allows highly dynamic, animated user interfaces to be rendered fluidly at 60 FPS. There are some things which can dramatically decrease rendering performance, however, and developers should be careful to avoid these pitfalls wherever possible. @@ -867,7 +867,7 @@ any animations or bindings evaluation since they are still active). The scene graph renderer is able to batch up certain operations to minimise the number of OpenGL state changes required. However, this optimization is only possible for the -built-in layout elements provided by QtQuick 2.0, and cannot be applied to manual layouts. +built-in layout elements provided by \c {QtQuick 2.0}, and cannot be applied to manual layouts. Therefore, application developers should use the Row, Column, Grid, GridView and ListView elements instead of manual layouts wherever possible. diff --git a/src/quick/doc/src/appdevguide/porting.qdoc b/src/quick/doc/src/appdevguide/porting.qdoc index 750a0e1242..c560a5cc08 100644 --- a/src/quick/doc/src/appdevguide/porting.qdoc +++ b/src/quick/doc/src/appdevguide/porting.qdoc @@ -49,7 +49,7 @@ There are very few changes in the QML language which affect the porting of exist \section1 QtQuick Module -The QtQuick module has been updated to version 2.0. All QML applications should update their import +The \c QtQuick module has been updated to version 2.0. All QML applications should update their import statements to use the new version: \qml @@ -77,12 +77,12 @@ into a \c QtQuick.LocalStorage singleton type. Any code that requires the local \e {QtQuick.LocalStorage} instead. See the \l {QtQuick.LocalStorage 2}{QtQuick.LocalStorage} documentation for examples. \li The \c LayoutItem type has been removed from the \c QtQuick module as it was specific to the -Graphics View framework backend used in QtQuick 1. +Graphics View framework backend used in \c {QtQuick 1}. \endlist \section2 Behavioral Changes -QtQuick 2.0 includes a number of behavioral changes and you should thoroughly test your applications after +\c {QtQuick 2.0} includes a number of behavioral changes and you should thoroughly test your applications after porting. These changes will not necessarily lead to run-time errors, but may break certain assumptions in your code. Below are the prominent changes to be aware of when porting your applications. @@ -96,7 +96,7 @@ Item opacity and visibility: \tt {(visible && opacity > 0.0)}. \li Previously, if an item was in a positioner (i.e. a \l Row, \l Column, \l Grid and \l Flow) and the item's \c opacity changed to 0, or its \c visible value became \c false, the positioner - would remove the item from its layout and collapse the space for that item. In QtQuick 2.0, this + would remove the item from its layout and collapse the space for that item. In \c {QtQuick 2.0}, this now only happens when an item's \c visible is \c false; the item opacity no longer affects whether the item is laid out. (This is consistent with the existing behavior of ListView and GridView). \endlist @@ -127,9 +127,9 @@ Other: \list \li The \c Qt.labs.particles module has been removed. It is replaced by the fully-fledged \l -QtQuick.particles module which is an enormous improvement on its predecessor. +QtQuick.Particles module which is an enormous improvement on its predecessor. \li The \c Qt.labs.shaders module has been removed as the \c ShaderEffectItem and \l -ShaderEffectSource types from this module have been moved into the \l QtQuick module. Note the \c +ShaderEffectSource types from this module have been moved into the \c QtQuick module. Note the \c ShaderEffectItem type has been renamed to \l ShaderEffect. \endlist @@ -139,11 +139,11 @@ ShaderEffectItem type has been renamed to \l ShaderEffect. In Qt 5, all QML applications are rendered with an OpenGL scenegraph architecture rather than the Graphics View framework used in Qt 4. Due to the scale of this architectural change, the C++ API has been extensively restructured and the \c QtDeclarative module has been deprecated in favour of two -new modules: \l {Qt QML}, which implements the QML engine and language infrastructure, and \l QtQuick, +new modules: \l {Qt QML}, which implements the QML engine and language infrastructure, and \l {Qt Quick}, which implements the visual canvas and scenegraph backend. All classes that were previously in the \c QtDeclarative module have been moved into the \l {Qt QML} -and \l QtQuick modules, and their class names have been changed to reflect their new module +and \l {Qt Quick} modules, and their class names have been changed to reflect their new module locations. The class name changes are as follows: \table @@ -176,8 +176,8 @@ locations. The class name changes are as follows: \endlist \endtable -To use the new \c QQml* and \c QtQuick* classes in Qt 5, link against the approprate module from -your qmake \c .pro file. For example the following will link against both the \l {Qt QML} and QtQuick +To use the new \c QQml* and \c QQuick* classes in Qt 5, link against the approprate module from +your qmake \c .pro file. For example the following will link against both the \l {Qt QML} and \l {Qt Quick} modules: \code @@ -191,7 +191,7 @@ Required header files can then be included: #include <QtQuick/QQuickView> \endcode -(The \c QtDeclarative module is still available to developers as the \l QtQuick1 module, as +(The \c QtDeclarative module is still available to developers as the \c {Qt Quick 1} module, as discussed in \l{Using the QtDeclarative module in Qt 5}{below}. However, it should not be used for new applications.) @@ -234,12 +234,12 @@ an overview of creating QML plugins in Qt 5. \section2 QtDeclarative module in Qt 5 -For the purposes of porting older applications, the \c QtDeclarative module is still available in Qt -5 but has been renamed to \c QtQuick1. Applications that required QtQuick 1 specific API (e.g. +For the purposes of porting older applications, the \c {QtDeclarative} module is still available in Qt +5 but has been renamed to \c {Qt Quick 1}. Applications that required Qt Quick 1 specific API (e.g. QDeclarativeView or QDeclarativeItem and the Graphics View integration) can use this module. Note -that new applications should use the new \l {Qt QML} and \l QtQuick modules instead. +that new applications should use the new \l {Qt QML} and \l {Qt Quick} modules instead. -To use the \c QtQuick1 module, add “quick1” module to your qmake \c .pro file: +To use the \c {Qt Quick 1} module, add "quick1" to your qmake \c .pro file: \code QT += quick1 diff --git a/src/quick/doc/src/appdevguide/usecases/animations.qdoc b/src/quick/doc/src/appdevguide/usecases/animations.qdoc index b237849caf..3249a632f5 100644 --- a/src/quick/doc/src/appdevguide/usecases/animations.qdoc +++ b/src/quick/doc/src/appdevguide/usecases/animations.qdoc @@ -29,7 +29,7 @@ \title Usecase - Animations In QML \brief Example of how to include animations in QML applications -QtQuick provides the ability to animate properties. Animating properties allows property values to move through +\l {Qt Quick} provides the ability to animate properties. Animating properties allows property values to move through intermediate values instead of immediately changing to the target value. To animate the position of an item, you can animate the properties that controle the item's position, x and y for example, so that the item's position changes each frame on the way to the target position. diff --git a/src/quick/doc/src/appdevguide/usecases/styling.qdoc b/src/quick/doc/src/appdevguide/usecases/styling.qdoc index 68b8d0302c..f8c7a94d30 100644 --- a/src/quick/doc/src/appdevguide/usecases/styling.qdoc +++ b/src/quick/doc/src/appdevguide/usecases/styling.qdoc @@ -29,8 +29,8 @@ \title Use Case - Style And Theme Support \brief Example of how to style user interface components in QML -The types provided in the QtQuick module are not complete user interface components on their own. A common use case is to -develop a set of custom styled user interface components out of the types in the QtQuick module. This is easily +The types provided in the \l {Qt Quick} module are not complete user interface components on their own. A common use case is to +develop a set of custom styled user interface components out of the types in the \l {Qt Quick} module. This is easily accomplished by creating your own reusable components. With the reusable components approach, you define your own type with the appearance you want to have in your diff --git a/src/quick/doc/src/appdevguide/usecases/text.qdoc b/src/quick/doc/src/appdevguide/usecases/text.qdoc index d0b8901170..94400ff9d8 100644 --- a/src/quick/doc/src/appdevguide/usecases/text.qdoc +++ b/src/quick/doc/src/appdevguide/usecases/text.qdoc @@ -28,7 +28,7 @@ \page qtquick-usecase-text.html \title Use Case - Displaying Text In QML \brief Example of how to display text in QML -To display text the Text type is provided by the QtQuick module. For related uses, the \l{TextInput} and +To display text the Text type is provided by the \l {Qt Quick} module. For related uses, the \l{TextInput} and \l{TextEdit} types provide editable text controls. For full HTML markup, see the \c{QtWebkit} module. \section1 Displaying and Formatting Text diff --git a/src/quick/doc/src/appdevguide/usecases/userinput.qdoc b/src/quick/doc/src/appdevguide/usecases/userinput.qdoc index 1e20f9d275..460f86add0 100644 --- a/src/quick/doc/src/appdevguide/usecases/userinput.qdoc +++ b/src/quick/doc/src/appdevguide/usecases/userinput.qdoc @@ -31,7 +31,7 @@ \section1 Supported Types of User Input -The \l QtQuick module provides support for the most common types of user input, +The \l {Qt Quick} module provides support for the most common types of user input, including mouse and touch events, text input and key-press events. Other modules provide support for other types of user input (for example, the \l QtSensors module provides support for shake-gestures in QML applications). @@ -65,7 +65,7 @@ to true on a single \l Item and do all your key handling there. \snippet qml/usecases/userinput-keys.qml 0 -For text input the \l QtQuick module provides several built-in types. +For text input the \l {Qt Quick} module provides several built-in types. In particular, the \l TextInput and \l TextEdit types allow for single-line entry and multi-line editing respectively. diff --git a/src/quick/doc/src/appdevguide/usecases/visual.qdoc b/src/quick/doc/src/appdevguide/usecases/visual.qdoc index a022b185fe..7e9e654b88 100644 --- a/src/quick/doc/src/appdevguide/usecases/visual.qdoc +++ b/src/quick/doc/src/appdevguide/usecases/visual.qdoc @@ -31,7 +31,7 @@ \section1 The Rectangle Type -For the most basic of visuals, QtQuick provides a \l Rectangle type to draw rectangles. These rectangles can be colored with a +For the most basic of visuals, \l {Qt Quick} provides a \l Rectangle type to draw rectangles. These rectangles can be colored with a color or a vertical gradient. The \l Rectangle type can also draw borders on the rectangle. For drawing custom shapes beyond rectangles, see the \l Canvas type or display @@ -42,7 +42,7 @@ a pre-rendered image using the \l Image type. \section1 The Image Type -QtQuick provides an \l Image type which may be used to display images. The +\l {Qt Quick} provides an \l Image type which may be used to display images. The \l Image type has a \l source property whose value can be a remote or local URL, or the URL of an image file embedded in a compiled resource file. @@ -58,7 +58,7 @@ For displaying video files and camera data, see the \l QtMultimedia module. \section1 Shared Visual Properties -All visual items provided by the QtQuick are based on the Item type, which provides a common set of attributes for +All visual items provided by \l {Qt Quick} are based on the Item type, which provides a common set of attributes for visual items, including opacity and transform attributes. \section2 Opacity and Visibility |