diff options
| -rw-r--r-- | src/quick/doc/src/cppextensionpoints.qdoc | 6 | ||||
| -rw-r--r-- | src/quick/doc/src/qmltypereference.qdoc | 27 | ||||
| -rw-r--r-- | src/quick/doc/src/qtquick.qdoc | 60 |
3 files changed, 47 insertions, 46 deletions
diff --git a/src/quick/doc/src/cppextensionpoints.qdoc b/src/quick/doc/src/cppextensionpoints.qdoc index 7fa7ee7aca..db003b2427 100644 --- a/src/quick/doc/src/cppextensionpoints.qdoc +++ b/src/quick/doc/src/cppextensionpoints.qdoc @@ -41,7 +41,7 @@ QQuickItem-derived types which can be rendered by Qt Quick. It also provides several scene graph-related classes which allow developers to define their own rendering primitives. - +\target user-defined-qquickitem-derived-types \section1 User-Defined QQuickItem-Derived Types While the Qt Quick module already provides a rich library of visual item types @@ -51,7 +51,7 @@ way to do this is to subclass QQuickItem, which is the base type for all visual types in the Qt Quick module. See the QQuickItem documentation for more details. - +\target scene-graph-related-classes \section1 Scene Graph-Related Classes Qt Quick 2 makes use of a dedicated scene graph based on OpenGL ES 2.0 or OpenGL 2.0 @@ -66,7 +66,7 @@ enable custom nodes to be created in C++. See the \l {Qt Quick Scene Graph} documentation for details. - +\target pixmap-and-threaded-image-support \section1 Pixmap and Threaded Image Support While the QML engine allows QML application to load images from filesystem or diff --git a/src/quick/doc/src/qmltypereference.qdoc b/src/quick/doc/src/qmltypereference.qdoc index fce7c05e00..3c35575b8a 100644 --- a/src/quick/doc/src/qmltypereference.qdoc +++ b/src/quick/doc/src/qmltypereference.qdoc @@ -36,6 +36,7 @@ interfaces and applications with QML. This page lists every QML type provided by this module, organized according to category and purpose. +\target importing-qtquick \section1 Importing Qt Quick The types provided by the \l {Qt Quick} module are only available in a QML document @@ -71,7 +72,7 @@ information about the concepts which are central to \c QtQuick. \li \l{Qt Quick Layouts QML Types}{Layouts} - contains types that are used to arrange items in the user interface \endlist - +\target basic-types \section1 Basic Types There are a number of basic types that are @@ -80,7 +81,7 @@ There are a number of basic types that are In addition, the \c QtQuick module provides the following basic types: \annotatedlist qtquickbasictypes - +\target object-types \section1 Object Types All of the object types provided by \c QtQuick are based on the \l{Item} type, @@ -88,7 +89,7 @@ which itself derives from \l{QtQml::QtObject}{QtObject}. \l{qtqml-typereference {QML object types} provided by the Qt QML module (such as \l{QtQml::QtObject}{QtObject} and \l{QtQml::Component}{Component}) are also available when you import \c QtQuick. - +\target visual-types \section2 Visual Types \list @@ -129,7 +130,7 @@ Visual Item Transformations \li \l {Translate} - Assigns item translation behaviors \endlist - +\target user-input \section2 User Input \list @@ -163,7 +164,7 @@ User Input Events \li \l {KeyEvent} - Provides information about a key press event \li \l {DragEvent} -Provides information about a drag event \endlist - +\target positioning \section2 Positioning \list @@ -174,7 +175,7 @@ User Input Events \li \l {Flow} - Positions its children with wrapping support \li \l {LayoutMirroring} - Attached property used to mirror layout behavior \endlist - +\target states-transitions-and-animations \section2 States, Transitions and Animations States @@ -231,7 +232,7 @@ Animation paths \li \l {PathAttribute} - Allows the setting of attributes along a \l {Path} \li \l {PathPercent} - Modifies the item distribution along a \l {Path} \endlist - +\target model-view-types-and-data-storage-and-access \section2 Model/View Types And Data Storage And Access QML Lists and Models @@ -268,9 +269,10 @@ Views Data Storage \list -\li \l {QtQuick.LocalStorage 2} - Singleton type providing simplified SQL access +\li \l {Qt Quick Local Storage QML Types}{QtQuick.LocalStorage 2} - Singleton +type providing simplified SQL access \endlist - +\target graphical-effects \section2 Graphical Effects \list @@ -278,9 +280,10 @@ Data Storage \li \l {ShaderEffect} - Allows GLSL shaders to be used as graphical effects \li \l {ShaderEffectSource} - Usable as a texture in ShaderEffect \li \l {GridMesh} - Generates a grid mesh of vertices for use by ShaderEffect -\li The \l{QtQuick.Particles 2} module provides a set of Particle System types for Qt Quick 2 +\li The \l{Qt Quick Particles QML Types}{QtQuick.Particles 2} module provides a +set of Particle System types for Qt Quick 2 \endlist - +\target convenience-types \section2 Convenience Types \list @@ -289,7 +292,7 @@ Data Storage \li \l {Timer} - Provides timed triggers \li \l {WorkerScript} - Enables the use of threads in a Qt Quick application \endlist - +\target canvas-similar-to-html5-canvas \section2 Canvas (similar to HTML5 canvas) \list diff --git a/src/quick/doc/src/qtquick.qdoc b/src/quick/doc/src/qtquick.qdoc index 088e62d81a..0c5a721863 100644 --- a/src/quick/doc/src/qtquick.qdoc +++ b/src/quick/doc/src/qtquick.qdoc @@ -61,20 +61,18 @@ and visual effects can be supplemented through specialised components for particle and shader effects. \list -\li \l{qtquick-visualcanvas-topic.html}{The Visual Canvas} -\li \l{qtquick-input-topic.html}{User Input} -\li \l{qtquick-positioning-topic.html}{Positioning} -\li \l{qtquick-statesanimations-topic.html}{States, Transitions And Animations} -\li \l{qtquick-modelviewsdata-topic.html}{Data - Models, Views and Data Storage} -\li \l{qtquick-effects-topic.html}{Particles And Graphical Effects} -\li \l{qtquick-convenience-topic.html}{Convenience Types} +\li \l{Important Concepts In Qt Quick - The Visual Canvas}{The Visual Canvas} +\li \l{Important Concepts In Qt Quick - User Input}{User Input} +\li \l{Important Concepts In Qt Quick - Positioning}{Positioning} +\li \l{Important Concepts in Qt Quick - States, Transitions and Animations}{States, Transitions And Animations} +\li \l{Important Concepts In Qt Quick - Data - Models, Views and Data Storage}{Data - Models, Views and Data Storage} +\li \l{Important Concepts In Qt Quick - Graphical Effects}{Particles And Graphical Effects} +\li \l{Important Concepts In Qt Quick - Convenience Types}{Convenience Types} \endlist When using the \c QtQuick module, you will need to know how to write QML -applications using the QML language. In particular, you should have a grasp -of the \l{qtquick-quickstart-basics.html}{QML Basics} and -\l{qtquick-quickstart-essentials.html}{QML Essentials} from the -\l{QML Applications}. +applications using the QML language. In particular, QML Basics and QML +Essentials from the \l{QML Applications} page. To find out more about using the QML language, see the \l{Qt QML} module documentation. @@ -82,28 +80,28 @@ To find out more about using the QML language, see the \l{Qt QML} module documen \section1 Qt Quick Module Documentation \list - \li \l{qtquick-qmltypereference.html}{Qt Quick QML Types} + \li \l{Qt Quick QML Types} \list - \li \l{qtquick-qmltypereference.html#importing-qtquick}{Importing QtQuick} - \li \l{qtquick-qmltypereference.html#basic-types}{Basic Types} - \li \l{qtquick-qmltypereference.html#object-types}{Object Types} + \li \l{importing-qtquick}{Importing QtQuick} + \li \l{basic-types}{Basic Types} + \li \l{object-types}{Object Types} \list - \li \l{qtquick-qmltypereference.html#visual-types}{Visual Types} - \li \l{qtquick-qmltypereference.html#user-input}{User Input} - \li \l{qtquick-qmltypereference.html#positioning}{Positioning} - \li \l{qtquick-qmltypereference.html#states-transitions-and-animations}{States, Transitions And Animations} - \li \l{qtquick-qmltypereference.html#model-view-types-and-data-storage-and-access}{Model/View Types And Data Storage And Access} - \li \l{qtquick-qmltypereference.html#graphical-effects}{Graphical Effects} - \li \l{qtquick-qmltypereference.html#convenience-types}{Convenience Types} - \li \l{qtquick-qmltypereference.html#canvas-similar-to-html5-canvas}{Canvas (similar to HTML5 Canvas)} + \li \l{visual-types}{Visual Types} + \li \l{user-input}{User Input} + \li \l{positioning}{Positioning} + \li \l{states-transitions-and-animations}{States, Transitions And Animations} + \li \l{model-view-types-and-data-storage-and-access}{Model/View Types And Data Storage And Access} + \li \l{graphical-effects}{Graphical Effects} + \li \l{convenience-types}{Convenience Types} + \li \l{canvas-similar-to-html5-canvas}{Canvas (similar to HTML5 Canvas)} \endlist \endlist - \li \l{qtquick-cppextensionpoints.html}{C++ Extension Points} + \li \l{C++ Extension Points Provided By Qt Quick}{C++ Extension Points} \list - \li \l{qtquick-cppextensionpoints.html#user-defined-qquickitem-derived-types}{Creating User-Defined QQuickItem-Derived Types} - \li \l{qtquick-cppextensionpoints.html#scene-graph-related-classes}{Scene Graph-Related Classes} - \li \l{qtquick-cppextensionpoints.html#pixmap-and-threaded-image-support}{Pixmap and Threaded Image Support} + \li \l{user-defined-qquickitem-derived-types}{Creating User-Defined QQuickItem-Derived Types} + \li \l{scene-graph-related-classes}{Scene Graph-Related Classes} + \li \l{pixmap-and-threaded-image-support}{Pixmap and Threaded Image Support} \endlist \endlist @@ -117,13 +115,13 @@ Additional Qt Quick information: \li \l{Qt Quick QML Types} - a list of QML types provided by the \c{QtQuick} import \list - \li \l{QtQuick.XmlListModel 2}{XML List Model} - contains types + \li \l{Qt Quick XmlListModel QML Types}{XML List Model} - contains types for creating models from XML data - \li \l{QtQuick.LocalStorage 2}{Local Storage} - a submodule + \li \l{Qt Quick Local Storage QML Types}{Local Storage} - a submodule containing a JavaScript interface for an SQLite database - \li \l{QtQuick.Particles 2}{Particles} - provides a particle + \li \l{Qt Quick Particles QML Types}{Particles} - provides a particle system for Qt Quick - \li \l{QtQuick.Window 2}{Window} - contains types for creating + \li \l{Qt Quick Window QML Types}{Window} - contains types for creating top-level windows and accessing screen information \li \l{Qt Quick Dialogs}{Dialogs} - contains types for creating and interacting with system dialogs |