diff options
Diffstat (limited to 'src/quick/doc/src/concepts')
8 files changed, 44 insertions, 48 deletions
diff --git a/src/quick/doc/src/concepts/convenience/topic.qdoc b/src/quick/doc/src/concepts/convenience/topic.qdoc index 113b4952a6..1a6feeaa61 100644 --- a/src/quick/doc/src/concepts/convenience/topic.qdoc +++ b/src/quick/doc/src/concepts/convenience/topic.qdoc @@ -66,7 +66,7 @@ required (or when it becomes available). \section1 Dynamic Signal Connections QML supports dynamic signal connections through a signal's \c{connect()} -method. The QtQuick module provides the convenience \l Connections type which +method. The \l {Qt Quick} module provides the convenience \l Connections type which allows setting up a signal connection involving an object which isn't part of the static object hierarchy. It also allows the connection to be dynamically retargeted at runtime, which allows an application to process different signal diff --git a/src/quick/doc/src/concepts/effects/particles.qdoc b/src/quick/doc/src/concepts/effects/particles.qdoc index 708e8d2740..ec49c6df43 100644 --- a/src/quick/doc/src/concepts/effects/particles.qdoc +++ b/src/quick/doc/src/concepts/effects/particles.qdoc @@ -44,7 +44,6 @@ /*! \page qtquick-effects-particles.html - \inqmlmodule QtQuick.Particles 2.0 \title Using the Qt Quick Particle System Documentation for all Particle System types can be found on the \l{QtQuick.Particles 2}{QtQuick.Particles} module page. @@ -132,7 +131,6 @@ /*! \page qtquick-particles-performance.html - \inqmlmodule QtQuick 2.0 \title Particle System Performance Guide The performance of the particle system scales with the number of particles it is maintaining. After prototyping the desired diff --git a/src/quick/doc/src/concepts/effects/sprites.qdoc b/src/quick/doc/src/concepts/effects/sprites.qdoc index 7ee98a533b..805a423002 100644 --- a/src/quick/doc/src/concepts/effects/sprites.qdoc +++ b/src/quick/doc/src/concepts/effects/sprites.qdoc @@ -27,7 +27,6 @@ /*! \ingroup qtquick-images-sprites -\ingroup qml-features \page qtquick-effects-sprites.html \title Sprite Animations \brief Sprite-based animations with flexible transitioning @@ -36,7 +35,7 @@ \section1 Sprite Engine -The QtQuick sprite engine is a stochastic state machine combined with the ability +The \l {Qt Quick} sprite engine is a stochastic state machine combined with the ability to chop up images containing multiple frames of an animation. \section2 State Machine diff --git a/src/quick/doc/src/concepts/input/focus.qdoc b/src/quick/doc/src/concepts/input/focus.qdoc index 1c73c9b5ba..827f6d85c8 100644 --- a/src/quick/doc/src/concepts/input/focus.qdoc +++ b/src/quick/doc/src/concepts/input/focus.qdoc @@ -27,14 +27,13 @@ /*! \page qtquick-input-focus.html -\ingroup qml-features \title Keyboard Focus in Qt Quick \brief handling keyboard focus When a key is pressed or released, a key event is generated and delivered to the focused Qt Quick \l Item. To facilitate the construction of reusable components -and to address some of the cases unique to fluid user interfaces, the Qt Quick items add aged -\e scope based extension to Qt's traditional keyboard focus model. +and to address some of the cases unique to fluid user interfaces, the Qt Quick items add a +scope based extension to Qt's traditional keyboard focus model. \tableofcontents @@ -43,17 +42,16 @@ and to address some of the cases unique to fluid user interfaces, the Qt Quick i When the user presses or releases a key, the following occurs: \list 1 \li Qt receives the key action and generates a key event. -\li If the Qt widget containing the \l QQuickView has focus, the key event -is delivered to it. Otherwise, regular Qt key handling continues. -\li The key event is delivered by the scene to the QML \l Item with -\e {active focus}. If no Item has active focus, the key event is -\l {QEvent::ignore()}{ignored} and regular Qt key handling continues. -\li If the QML Item with active focus accepts the key event, propagation -stops. Otherwise the event is "bubbled up", by recursively passing it to each -Item's parent until either the event is accepted, or the root Item is reached. +\li If a \l QQuickWindow is the active window, the key event +is delivered to it. +\li The key event is delivered by the scene to the \l Item with +\e {active focus}. If no item has active focus, the key event is ignored. +\li If the \l QQuickItem with active focus accepts the key event, propagation +stops. Otherwise the event is send to the Item's parent until +the event is accepted, or the root item is reached. If the \c {Rectangle} type in the following example has active focus and the \c A key is pressed, -it will bubble up to its parent. However, pressing the \c B key will bubble up to the root +the event will not be propagated further. Pressing the \c B key the event will propagate to the root item and thus subsequently be ignored. \snippet qml/focus/rectangle.qml simple key event diff --git a/src/quick/doc/src/concepts/modelviewsdata/cppmodels.qdoc b/src/quick/doc/src/concepts/modelviewsdata/cppmodels.qdoc index 7b8d66f2a6..28bbbf1cca 100644 --- a/src/quick/doc/src/concepts/modelviewsdata/cppmodels.qdoc +++ b/src/quick/doc/src/concepts/modelviewsdata/cppmodels.qdoc @@ -28,7 +28,7 @@ /*! \page qtquick-modelviewsdata-cppmodels.html \title Using C++ Models with Qt Quick Views -\brief using QtQuick views with models defined in C++ +\brief using Qt Quick views with models defined in C++ \section1 Data Provided In A Custom C++ Model @@ -49,12 +49,12 @@ via the \e modelData role. Here is a ListView with a delegate that references its model item's value using the \c modelData role: -\snippet quick/models/stringlistmodel/view.qml 0 +\snippet models/stringlistmodel/view.qml 0 A Qt application can load this QML document and set the value of \c myModel to a QStringList: -\snippet quick/models/stringlistmodel/main.cpp 0 +\snippet models/stringlistmodel/main.cpp 0 The complete source code for this example is available in \l {quick/modelviews/stringlistmodel}{examples/quick/modelviews/stringlistmodel} @@ -74,11 +74,11 @@ The following application creates a \c DataObject class with Q_PROPERTY values that will be accessible as named roles when a QList<DataObject*> is exposed to QML: -\snippet quick/models/objectlistmodel/dataobject.h 0 +\snippet models/objectlistmodel/dataobject.h 0 \dots 4 -\snippet quick/models/objectlistmodel/dataobject.h 1 +\snippet models/objectlistmodel/dataobject.h 1 \codeline -\snippet quick/models/objectlistmodel/main.cpp 0 +\snippet models/objectlistmodel/main.cpp 0 \dots The QObject* is available as the \c modelData property. As a convenience, @@ -86,7 +86,7 @@ the properties of the object are also made available directly in the delegate's context. Here, \c view.qml references the \c DataModel properties in the ListView delegate: -\snippet quick/models/objectlistmodel/view.qml 0 +\snippet models/objectlistmodel/view.qml 0 Note the use of \c color property with qualifier. The properties of the object are not replicated in the \c model @@ -130,21 +130,21 @@ which exposes the \e type and \e sizes roles. It reimplements QAbstractItemModel::roleNames() to expose the role names, so that they can be accessed via QML: -\snippet quick/models/abstractitemmodel/model.h 0 +\snippet models/abstractitemmodel/model.h 0 \dots -\snippet quick/models/abstractitemmodel/model.h 1 +\snippet models/abstractitemmodel/model.h 1 \dots -\snippet quick/models/abstractitemmodel/model.h 2 +\snippet models/abstractitemmodel/model.h 2 \codeline -\snippet quick/models/abstractitemmodel/model.cpp 0 +\snippet models/abstractitemmodel/model.cpp 0 \codeline -\snippet quick/models/abstractitemmodel/main.cpp 0 +\snippet models/abstractitemmodel/main.cpp 0 \dots This model is displayed by a ListView delegate that accesses the \e type and \e size roles: -\snippet quick/models/abstractitemmodel/view.qml 0 +\snippet models/abstractitemmodel/view.qml 0 QML views are automatically updated when the model changes. Remember the model must follow the standard rules for model changes and notify the view when diff --git a/src/quick/doc/src/concepts/positioning/layouts.qdoc b/src/quick/doc/src/concepts/positioning/layouts.qdoc index 9165c2f6df..35be2f6235 100644 --- a/src/quick/doc/src/concepts/positioning/layouts.qdoc +++ b/src/quick/doc/src/concepts/positioning/layouts.qdoc @@ -28,10 +28,9 @@ /*! \ingroup qtquick-positioners \page qtquick-positioning-layouts.html -\ingroup qml-features -\title Item Layouts +\title Item Positioners -Positioner items are container items that manage the positions and sizes of +Positioner items are container items that manage the positions of items in a declarative user interface. Positioners behave in a similar way to the \l{Widgets and Layouts}{layout managers} used with standard Qt widgets, except that they are also containers in their own right. @@ -39,6 +38,10 @@ except that they are also containers in their own right. Positioners make it easier to work with many items when they need to be arranged in a regular layout. +\l{Qt Quick Layouts} can also be used to arrange Qt Quick items in a user interface. +They manage both the positions and the sizes of items on a declarative user interface, +and are well suited for resizable user interfaces. + \section1 Positioners A set of standard positioners are provided in the basic set of Qt Quick diff --git a/src/quick/doc/src/concepts/positioning/righttoleft.qdoc b/src/quick/doc/src/concepts/positioning/righttoleft.qdoc index 7052de3b49..bc67594960 100644 --- a/src/quick/doc/src/concepts/positioning/righttoleft.qdoc +++ b/src/quick/doc/src/concepts/positioning/righttoleft.qdoc @@ -27,7 +27,6 @@ /*! \page qtquick-positioning-righttoleft.html -\ingroup qml-features \title Right-to-left User Interfaces \brief switching text flow and layout \section1 Overview @@ -139,7 +138,7 @@ The painting of these icons can be mirrored with a dedicated \c mirror property \section1 Default layout direction -The \l {QML:Qt::application}{Qt.application.layoutDirection} property can be used to query the active layout direction of the +The \l {QtQml2::Qt::application}{Qt.application.layoutDirection} property can be used to query the active layout direction of the application. It is based on QApplication::layoutDirection(), which most commonly determines the layout direction from the active language translation file. diff --git a/src/quick/doc/src/concepts/positioning/topic.qdoc b/src/quick/doc/src/concepts/positioning/topic.qdoc index 25fc6eaab7..bae6a7f71b 100644 --- a/src/quick/doc/src/concepts/positioning/topic.qdoc +++ b/src/quick/doc/src/concepts/positioning/topic.qdoc @@ -34,7 +34,7 @@ Visual items in QML can be positioned in a variety of ways. The most important positioning-related concept is that of anchoring, a form of relative positioning where items can be anchored (or attached) to each other at certain boundaries. Other positioning concepts include absolute positioning, -positioning with coordinate bindings, and layouts. +positioning with coordinate bindings, positioners, and layouts. \section1 Manual Positioning @@ -134,21 +134,20 @@ positioning, whereas a "contaminated" anchor layout is one which uses both anchoring and bindings (either on position-related [x,y] properties or on dimension-related [width,height] properties) to determine the position. -\section1 Layouts - -Qt Quick also provides some built-in layout items. For many use cases, the -best layout to use is a simple grid, row, or column, and Qt Quick provides -items which will layout children in these formations in the most efficient -manner possible. +\section1 Positioners -There are many well-known layouts which work well in user-interfaces, such as -grids and lists, rows and columns. Qt Quick supports these sort of pre-defined -layouts, which can often be more performant to draw than anchor or -binding-based layouts. See the documentation on -\l{qtquick-positioning-layouts.html}{layout types} for more -information about utilizing pre-defined layouts. +Qt Quick also provides some built-in positioner items. For many use cases, the best +positioner to use is a simple grid, row, or column, and Qt Quick provides items which +will position children in these formations in the most efficient manner possible. +See the documentation on \l{qtquick-positioning-layouts.html}{item positioners types} +for more information about utilizing pre-defined positioners. +\section1 Layouts +From Qt 5.1, the module \l {Qt Quick Layouts} can also be used to arrange Qt Quick +items in a user interface. Unlike positioners, the types in Qt Quick Layouts manage +both the positions and sizes of items in a declarative interface. They are well +suited for resizable user interfaces. \section1 Right-To-Left Support |