/*!
\qmlclass FolderListModel QQuickFolderListModel
- \ingroup qml-working-with-data
+ \ingroup qtquick-models
\brief The FolderListModel provides a model of the contents of a file system folder.
FolderListModel provides access to information about the contents of a folder
/*!
\qmlclass SignalSpy SignalSpy
\brief Enables introspection of signal emission
+ \ingroup qtquick-utility
\since 4.8
\ingroup qtest::qml
/*!
\qmlclass TestCase TestCase
\brief Represents a unit test case
+ \ingroup qtquick-utility
\since 4.8
\ingroup qtest::qml
/*!
\qmlclass XmlRole QQuickXmlListModelRole
\inqmlmodule QtQuick 2
- \ingroup qml-working-with-data
\brief For specifying a role to an XmlListModel
+ \ingroup qtquick-models
\sa {QtQml}
*/
/*!
\qmlclass XmlListModel QQuickXmlListModel
\inqmlmodule QtQuick 2
- \ingroup qml-working-with-data
\brief For specifying a read-only model using XPath expressions
+ \ingroup qtquick-models
To use this element, you will need to import the module with the following line:
\inqmlmodule QtQuick.Particles 2
\inherits Affector
\brief For altering particle ages
+ \ingroup qtquick-particles
The Age affector allows you to alter where the particle is in its lifecycle. Common uses
are to expire particles prematurely, possibly giving them time to animate out.
/*!
\qmlclass AngleDirection QQuickAngleDirection
\inqmlmodule QtQuick.Particles 2
+ \ingroup qtquick-particles
\inherits Direction
\brief For specifying a direction that varies in angle
\inqmlmodule QtQuick.Particles 2
\inherits Direction
\brief For specifying a direction made of other directions
+ \ingroup qtquick-particles
The CumulativeDirection element will act as a direction that sums the directions within it.
*/
\inqmlmodule QtQuick.Particles 2
\inherits ParticlePainter
\brief For specifying shaders to paint particles
+ \ingroup qtquick-particles
*/
\qmlclass Direction QQuickDirection
\inqmlmodule QtQuick.Particles 2
\brief For specifying a vector space
+ \ingroup qtquick-particles
+
*/
/*!
\qmlclass EllipseShape QQuickEllipseExtruder
\inqmlmodule QtQuick.Particles 2
+ \ingroup qtquick-particles
\inherits Shape
\brief Represents an ellipse to other particle system elements
/*!
\qmlclass Friction QQuickFrictionAffector
\inqmlmodule QtQuick.Particles 2
+ \ingroup qtquick-particles
\inherits Affector
\brief For applying friction proportional to the particle's current speed
/*!
\qmlclass Gravity QQuickGravityAffector
\inqmlmodule QtQuick.Particles 2
+ \ingroup qtquick-particles
\inherits Affector
\brief For applying accleration in an angle
/*!
\qmlclass GroupGoal QQuickGroupGoalAffector
\inqmlmodule QtQuick.Particles 2
+ \ingroup qtquick-particles
\inherits Affector
\brief For changing the state of a group of a particle
\inqmlmodule QtQuick.Particles 2
\inherits ParticlePainter
\brief For visualizing logical particles using an image
+ \ingroup qtquick-particles
This element renders a logical particle as an image. The image can be
\list
\inqmlmodule QtQuick.Particles 2
\inherits ParticlePainter
\brief For specifying a delegate to paint particles
+ \ingroup qtquick-particles
*/
\inqmlmodule QtQuick.Particles 2
\inherits Shape
\brief Represents a line for affectors and emitters
+ \ingroup qtquick-particles
*/
\inqmlmodule QtQuick.Particles 2
\inherits Shape
\brief For representing an image as a shape to affectors and emitters
+ \ingroup qtquick-particles
*/
/*!
\inqmlmodule QtQuick.Particles 2
\brief Applies alterations to the attributes of logical particles at any
point in their lifetime
+ \ingroup qtquick-particles
The base Affector does not alter any attributes, but can be used to emit a signal
when a particle meets certain conditions.
\qmlclass Emitter QQuickParticleEmitter
\inqmlmodule QtQuick.Particles 2
\brief Emits logical particles
+ \ingroup qtquick-particles
This element emits logical particles into the ParticleSystem, with the
given starting attributes.
\qmlclass Shape QQuickParticleExtruder
\inqmlmodule QtQuick.Particles 2
\brief For specifying an area for affectors and emitters
+ \ingroup qtquick-particles
The base class is just a rectangle.
*/
\qmlclass ParticleGroup QQuickParticleGroup
\inqmlmodule QtQuick.Particles 2
\brief For setting attributes on a logical particle group
+ \ingroup qtquick-particles
This element allows you to set timed transitions on particle groups.
\inqmlmodule QtQuick.Particles 2
\inherits ParticlePainter
\brief For specifying how to paint particles
+ \ingroup qtquick-particles
The default implementation paints nothing. See the subclasses if you want to
paint something visible.
\qmlclass ParticleSystem QQuickParticleSystem
\inqmlmodule QtQuick.Particles 2
\brief A system which includes particle painter, emitter, and affector types
+ \ingroup qtquick-particles
*/
/*!
\qmlclass Attractor QQuickAttractorAffector
\inqmlmodule QtQuick.Particles 2
+ \ingroup qtquick-particles
\inherits Affector
\brief For attracting particles towards a specific point
/*!
\qmlclass PointDirection QQuickPointDirection
\inqmlmodule QtQuick.Particles 2
+ \ingroup qtquick-particles
\inherits Direction
\brief For specifying a direction that varies in x and y components
\qmlclass RectangleShape QQuickRectangleExtruder
\inqmlmodule QtQuick.Particles 2
\brief For specifying an area for affectors and emitter
+ \ingroup qtquick-particles
Just a rectangle.
*/
/*!
\qmlclass SpriteGoal QQuickSpriteGoalAffector
\inqmlmodule QtQuick.Particles 2
+ \ingroup qtquick-images-sprites
\inherits Affector
\brief For changing the the state of a sprite particle
/*!
\qmlclass TargetDirection QQuickTargetDirection
\inqmlmodule QtQuick.Particles 2
+ \ingroup qtquick-particles
\inherits Direction
\brief For specifying a direction towards the target point
\inqmlmodule QtQuick.Particles 2
\inherits QQuickParticleEmitter
\brief Emits logical particles from other logical particles
+ \ingroup qtquick-particles
This element emits logical particles into the ParticleSystem, with the
starting positions based on those of other logical particles.
/*!
\qmlclass Turbulence QQuickTurbulenceAffector
\inqmlmodule QtQuick.Particles 2
+ \ingroup qtquick-particles
\inherits Affector
\brief Provides fluid-like forces from a noise image
\qmlclass Particle
\inqmlmodule QtQuick.Particles 2
\brief Represents particles manipulated by emitters and affectors
+ \ingroup qtquick-particles
Particle elements are always managed internally by the ParticleSystem and cannot be created in QML.
However, sometimes they are exposed via signals so as to allow arbitrary changes to the particle state
/*!
\qmlclass Wander QQuickWanderAffector
\inqmlmodule QtQuick.Particles 2
+ \ingroup qtquick-particles
\inherits Affector
\brief For applying random particle trajectory
/*!
\qmlclass ListModel QQuickListModel
\inqmlmodule QtQuick 2
- \ingroup qml-working-with-data
\brief Defines a free-form list data source
+ \ingroup qtquick-models
The ListModel is a simple container of ListElement definitions, each containing data roles.
The contents can be defined dynamically, or explicitly in QML.
/*!
\qmlclass ListElement QQuickListElement
\inqmlmodule QtQuick 2
- \ingroup qml-working-with-data
\brief Defines a data item in a ListModel
+ \ingroup qtquick-models
List elements are defined inside ListModel definitions, and represent items in a
list that will be displayed using ListView or \l Repeater items.
#add particles sources
headerdirs += ../../particles
sourcedirs += ../../particles
+
+#add imports directory because of dependencies
+headerdirs += ../../imports
+sourcedirs += ../../imports
+
--- /dev/null
+/****************************************************************************
+**
+** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** GNU Free Documentation License
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms
+** and conditions contained in a signed written agreement between you
+** and Nokia.
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+\group qtquick-animation-define
****************************************************************************/
/*!
-\page qtquick-animation.html
+\group qtquick-animation-define
\title Animation and Transitions
\brief the animation system in Qt Quick
\section1 Animation and Transitions Elements
+\generatelist{related}
\list
\li \l {Transition} - Animates transitions during state changes
\li \l {SequentialAnimation} - Runs animations sequentially
\endlist
Elements that animate properties based on data types
+\annotatedlist qtquick-property-animation
+
\list
\li \l {PropertyAnimation} - Animates property changes
\li \l {NumberAnimation} - Animates properties of type qreal
\endqml
*/
+
+/*!
+\group qtquick-animation-properties
+\title Qt Quick Property Animation
+\brief Animate property changes
+
+\generatelist{related}
+*/
+
+/*!
+\group qtquick-animation-control
+\title Qt Quick Animation Controls
+\brief Control animation sequences
+
+\generatelist{related}
+*/
+
+/*!
+\group qtquick-animation-modifiers
+\title Qt Quick Animation Modifiers
+\brief Modify animation sequences
+
+\generatelist{related}
+*/
****************************************************************************/
/*!
-\page qtquick-canvaspainting.html
+\group qtquick-canvas
\ingroup qml-features
-\title Painting with Canvas API
-\brief custom graphics with the Canvas API
+\title Canvas API
+\brief Custom graphics with the Canvas API
-\section1 Canvas Element
-
-\list
- \li \l{Canvas}
- \li \l{Context2D}
-\endlist
+\section1 Related Types
+\generatelist{related}
The Canvas and Context2D elements implement the \l{HTML Canvas API 2D Context}
and allows applications to have custom painting routines.
--- /dev/null
+/****************************************************************************
+**
+** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** GNU Free Documentation License
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms
+** and conditions contained in a signed written agreement between you
+** and Nokia.
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+\group qtquick-containers
+\title Qt Quick Containers
+\brief Specialized views for handling input and animations
+
+\generatelist{related}
+*/
--- /dev/null
+/****************************************************************************
+**
+** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** GNU Free Documentation License
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms
+** and conditions contained in a signed written agreement between you
+** and Nokia.
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+\group qtquick-images
+\ingroup qml-features
+\title Qt Quick Images
+\brief Displaying images in a QML scene
+
+\section1 Related Types
+
+\generatelist{related}
+
+
+*/
--- /dev/null
+/****************************************************************************
+**
+** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** GNU Free Documentation License
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms
+** and conditions contained in a signed written agreement between you
+** and Nokia.
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+\group qtquick-interaction
+\title Qt Quick Keys and Focus
+\brief Handling mouse input and interaction
+
+\section1 Related Types
+\generatelist{related}
+*/
--- /dev/null
+/****************************************************************************
+**
+** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** GNU Free Documentation License
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms
+** and conditions contained in a signed written agreement between you
+** and Nokia.
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+\group qtquick-item-graphics
+\title Qt Quick Item Graphics
+\brief Graphics applied onto visual types
+
+\section1 Related Types
+\generatelist{related}
+*/
--- /dev/null
+/****************************************************************************
+**
+** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** GNU Free Documentation License
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms
+** and conditions contained in a signed written agreement between you
+** and Nokia.
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+\group qtquick-models
+\title Qt Quick Models
+\brief Structuring data for display.
+
+\section1 Related Types
+\generatelist{related}
+*/
Views are containers for collections of items. They are feature-rich and can be
customizable to meet style or behavior requirements.
- \keyword qml-view-elements
+ \keyword qtquick-views
A set of standard views are provided in the basic set of Qt Quick
graphical elements:
--- /dev/null
+/****************************************************************************
+**
+** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** GNU Free Documentation License
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms
+** and conditions contained in a signed written agreement between you
+** and Nokia.
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+\group qtquick-particles
+\title Qt Quick Particle Types
+\brief Types for creating particle effects
+
+\section1 Related Types
+\generatelist{related}
+*/
--- /dev/null
+/****************************************************************************
+**
+** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** GNU Free Documentation License
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms
+** and conditions contained in a signed written agreement between you
+** and Nokia.
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+\group qtquick-paths
+\title Qt Quick Paths
+\brief Drawing and setting paths
+
+\section1 Related Types
+\generatelist{related}
+*/
****************************************************************************/
/*!
-\page qtquick-positioners.html
+\group qtquick-positioners
\ingroup qml-features
\title Item Layouts
A set of standard positioners are provided in the basic set of Qt Quick
graphical elements:
-\list
-\li \l{#Column}{Column} arranges its children in a column
-\li \l{#Row}{Row} arranges its children in a row
-\li \l{#Grid}{Grid} arranges its children in a grid
-\li \l{#Flow}{Flow} arranges its children like words on a page
-\endlist
+\generatelist{related}
\section2 Column
--- /dev/null
+/****************************************************************************
+**
+** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** GNU Free Documentation License
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms
+** and conditions contained in a signed written agreement between you
+** and Nokia.
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+\page qtquick-types.html
+\title Qt Quick Types
+\brief A listing of standard types in Qt Quick
+
+
+
+These are the functionally grouped lists of Qt Quick types as part of
+\l{Qt Quick}. You can also browse the module pages for \l{QtQuick 2} and \l{QtQuick.Particles 2}
+
+\section1 Qt Quick Submodules
+
+ \section2 Particle Effects
+
+ The \l{QtQuick.Particles 2} module provides a set of Particle System types
+ for QtQuick 2. The \l{Using the Qt Quick Particle System} article describes
+ the particle system.
+
+ \section2 Local Storage
+ The \l{Local Storage}{SQL Local Storage} submodule contains a
+ JavaScript interface for an SQLite database.
+
+ \section2 XmlListModel
+
+ The \l{QtQuick.XmlListModel 2.0} submodule contains contains the
+ \l{XmlListModel} type, for using remote XML data as a model.
+
+\section1 Visual Types
+ These types are described in the \l{qtquick-visual-types}{Visual Types}
+ overview.
+ \annotatedlist qtquick-visual-types
+
+\section1 Images
+ These types are described in the
+ \l{qtquick-images}{Images} overview.
+ \annotatedlist qtquick-images
+
+\section2 Sprites
+ These types are described in the
+ \l{qtquick-images-sprites}{Sprite Animations} overview.
+ \annotatedlist qtquick-images-sprites
+
+\section1 Item Graphics
+ These types are described in the \l{qtquick-item-graphics}{Item Graphics}
+ overview.
+ \annotatedlist qtquick-item-graphics
+
+\section1 Shader Effects
+
+ These types are described in the \l{qtquick-shaders}{Shader Effects}
+ overview.
+ \annotatedlist qtquick-shaders
+
+\section1 Canvas API
+
+ These types are described in the \l{qtquick-canvas}{Canvas API} overview.
+ \annotatedlist qtquick-canvas
+\section1 Text Handling
+ These types are described in the
+ \l{Qt Quick Text Handling and Validators}{Text Handling and Validators}
+ overview.
+ \annotatedlist qtquick-text
+
+\section2 Validators
+ These types are described in the
+ \l{Qt Quick Text Handling and Validators}{Text Handling and Validators}
+ overview.
+ \annotatedlist qtquick-text-validator
+
+\section1 User Interaction
+
+ These types are described in the
+ \l{qtquick-interaction}{Interaction}Â overview.
+ \annotatedlist qtquick-interaction
+
+\section1 Transformations
+
+ These types are described in the \l{qtquick-transformations}{Transformation Types} overview.
+ \annotatedlist qtquick-transformations
+
+\section1 States
+
+ These types are described in the \l{qtquick-states}{States}
+ overview.
+ \annotatedlist qtquick-states
+
+\section1 Animation and Transitions
+ These types are described in the
+ \l{qtquick-animation-define}{Animation and Transitions}Â overview.
+ \annotatedlist qtquick-animation-define
+
+ \section2 Property Animation
+
+ These types animate property changes and are described in the
+ \l{qtquick-animation-define}{Animation and Transitions}Â overview.
+ \annotatedlist qtquick-animation-properties
+
+ \section2 Animation Controls
+
+ These types provide lower-level animation control. These types are
+ described in the
+ \l{qtquick-animation-define}{Animation and Transitions}Â overview.
+ \annotatedlist qtquick-animation-control
+
+ \section2 Animation Modifiers
+
+ These types provide specialized changes during the animation. These
+ types are described in the
+ \l{qtquick-animation-define}{Animation and Transitions}Â overview.
+ \annotatedlist qtquick-animation-modifiers
+
+\section1 Models
+ These types are described in the \l{qtquick-models}{Qt Quick Models}
+ overview. The \l{Models and Views} overview has information about displaying
+ data with views and delegates.
+ \annotatedlist qtquick-models
+
+\section1 Views, Positioners, and Specialized Containers
+
+ \section2 Views
+ These types are described in the \l{qtquick-views}{Views} overview.
+ The \l{Models and Views} overview has information about displaying data with
+ models and delegates.
+ \annotatedlist qtquick-views
+
+ \section2 Containers
+ These types are described in the \l{qtquick-containters}{Containers}
+ overview.
+ \annotatedlist qtquick-containers
+
+ \section1 Positioners
+ These types are described in the \l{qtquick-positioners}{Positioners}
+ overview.
+ \annotatedlist qtquick-positioners
+
+\section1 Paths
+
+ These types are described in the \l{qtquick-paths}{Paths} overview.
+ \annotatedlist qtquick-paths
+
+\section1 Utility
+
+ These types are described in the \l{qtquick-utility}{Object Utilities}
+ overview.
+ \annotatedlist qtquick-utility
+
+*/
**
****************************************************************************/
/*!
-\page qtquick-shaders.html
-\title Shader Effects in QML
-\brief applying OpenGL vertex and fragment shaders to QML Rectangles
+\group qtquick-shaders
+\title Qt Quick Shader Effects
+\brief For applying OpenGL vertex and fragment shaders to rectangles
-\code
-NOTE: This article is a work in progress.
-\endcode
+\section1 Related Types
+\generatelist{related}
\section1 Shaders
Describe Shaders and where it could be used in UIs or applications
****************************************************************************/
/*!
-\page qtquick-spriteengine.html
+\group qtquick-images-sprites
\ingroup qml-features
\title Sprite Animations
\brief Sprite-based animations with flexible transitioning
+\section1 Related Types
+
+\generatelist{related}
+
\section1 Sprite Engine
The QtQuick sprite engine is a stochastic state machine combined with the ability
http://www.imagemagick.org/script/montage.php
-\section2 Elements Using the Sprite Engine
+\section2 QML Types Using the Sprite Engine
Sprites for the sprite engine can be defined using the \l Sprite element. This element includes the input parameters
as well as the length of the animation and weighted transitions to other animations. It is purely a data class, and
****************************************************************************/
/*!
-\page qtquick-states.html
+\group qtquick-states
\title Qt Quick States
\brief Creating and setting states
-\target qmlstates
-\section1 States Elements
-\list
-\li \l State
-\li \l PropertyChanges
-\li \l StateGroup
-\li \l StateChangeScript
-\li \l ParentChange
-\li \l AnchorChanges
-\endlist
+\section1 Related Types
+\generatelist{related}
-Many user interface designs are \e state driven; interfaces have configurations
+Many user interface designs are \e{state driven}; interfaces have configurations
that differ depending on the current state. For example, a traffic signal will
configure its flags or lights depending on its state. While in the signal's
\c stop state, a red light will turn on while the yellow and the green lights
--- /dev/null
+/****************************************************************************
+**
+** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** GNU Free Documentation License
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms
+** and conditions contained in a signed written agreement between you
+** and Nokia.
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+\group qtquick-text
+\title Qt Quick Text Handling and Validators
+\brief Text display, input, and validation
+
+\section1 Text Visual Types
+
+Qt Quick provides several types to display text onto the screen. The \l Text
+type will display formatted text onto the screen, the \l TextEdit type
+will place a multiline line edit onto the screen, and the \l TextInput will
+place a single editable line field onto the screen.
+
+\generatelist{related}
+
+To learn more about their specific features and properties, visit their
+respective documentation.
+
+\section1 Validating Input Text
+
+The \e validator types enforce the type and format of
+\l TextInput objects.
+
+\annotatedlist qtquick-text-validator
+
+\snippet doc/snippets/qml/texthandling.qml int validator
+The validator types bind to \c {TextInput}'s \c validator property.
+
+\snippet doc/snippets/qml/texthandling.qml regexp validator
+The regular expression in the snippet will only allow the inputted text to be
+\c {fruit basket}.
+
+Note that QML parses JavaScript regular expressions, while Qt's
+\l {QRegExp} class' regular expressions are based on Perl regular expressions.
+
+*/
+
+/*!
+\group qtquick-text-validator
+\title Qt Quick Text Validators
+\brief Types that validate text input
+
+The \l{Qt Quick Text Handling and Validators} page has information about
+validating user text input.
+*/
--- /dev/null
+/****************************************************************************
+**
+** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** GNU Free Documentation License
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms
+** and conditions contained in a signed written agreement between you
+** and Nokia.
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+\group qtquick-transformations
+\title Qt Quick Transformation Types
+\brief Types for applying transformations to visual types
+
+\section1 Related Types
+\generatelist{related}
+*/
\section1 Graphics and Special Effects
\list
\li \l{Basic Elements}{Basic Elements}
- \li \l{Painting with Canvas API}
+ \li \l{qtquick-canvas}{Painting with Canvas API}
\li \l{Using the Qt Quick Particle System}{Particle Effects}
- \li \l{Shader Effects in QML}{Shader Effects}
+ \li \l{qtquick-shaders}{Shader Effects}
\endlist
\section1 Anchoring and Layouts
--- /dev/null
+/****************************************************************************
+**
+** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** GNU Free Documentation License
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms
+** and conditions contained in a signed written agreement between you
+** and Nokia.
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+\group qtquick-utility
+\title Qt Quick Object Utilities
+\brief Types for managing objects
+
+\section1 Related Types
+\generatelist{related}
+*/
--- /dev/null
+/****************************************************************************
+**
+** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** GNU Free Documentation License
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms
+** and conditions contained in a signed written agreement between you
+** and Nokia.
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+\group qtquick-views
+\title Qt Quick Views
+\brief Presenting data in a view
+
+\section1 Related Types
+\generatelist{related}
+*/
--- /dev/null
+/****************************************************************************
+**
+** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** GNU Free Documentation License
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms
+** and conditions contained in a signed written agreement between you
+** and Nokia.
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+\group qtquick-visual-types
+\title Qt Quick Visual Types
+\brief Visible items in a scene
+
+\section1 Related Types
+\generatelist{related}
+*/
\qmlclass Canvas QQuickCanvasItem
\inqmlmodule QtQuick 2
\since QtQuick 2.0
- \brief For specifying a 2D canvas element which enables drawing via Javascript
\inherits Item
- \ingroup qml-basic-visual-elements
+ \ingroup qtquick-canvas
+ \brief For specifying a 2D canvas element which enables drawing via Javascript
The Canvas item allows drawing of straight and curved lines, simple and
complex shapes, graphs, and referenced graphic images. It can also add
/*!
\qmlclass Context2D QQuickContext2D
\inqmlmodule QtQuick 2
+ \ingroup qtquick-canvas
\since QtQuick 2.0
\brief Provides 2D context for shapes on a Canvas item
\qmlclass TextMetrics
\inqmlmodule QtQuick 2
\since QtQuick 2.0
+ \ingroup qtquick-canvas
\brief Provides a Context2D TextMetrics interface
The TextMetrics object can be created by QtQuick2::Context2D::measureText method.
/*!
\qmlclass CanvasImageData
\inqmlmodule QtQuick 2
+ \ingroup qtquick-canvas
\brief Contains image pixel data in RGBA order
The \a QtQuick2::CanvasImageData object holds the image pixel data.
/*!
\qmlclass CanvasPixelArray
\inqmlmodule QtQuick 2
+ \ingroup qtquick-canvas
\brief Provides ordered and indexed access to the components of each pixel in image data
The CanvasPixelArray object provides ordered, indexed access to the color components of each pixel of the image data.
\qmlclass CanvasGradient
\inqmlmodule QtQuick 2
\since QtQuick 2.0
+ \ingroup qtquick-canvas
\brief Provides an opaque CanvasGradient interface
*/
\brief Enables accessibility of QML items
\inqmlmodule QtQuick 2
- \ingroup qml-basic-interaction-elements
+ \ingroup qtquick-utility
\ingroup accessibility
This class is part of \l {Accessibility for Qt Quick Applications}.
\qmlclass AnimatedImage QQuickAnimatedImage
\inqmlmodule QtQuick 2
\inherits Image
- \ingroup basic-visual-elements
\brief Plays animations stored as a series of images
+ \ingroup qtquick-images
The AnimatedImage element extends the features of the \l Image element, providing
a way to play animations stored as images containing a series of frames,
\qmlclass AnimatedSprite QQuickAnimatedSprite
\inqmlmodule QtQuick 2
\inherits Item
+ \ingroup qtquick-images-sprites
\brief Draws a sprite animation
AnimatedSprite provides rendering and control over animations which are provided
\inqmlmodule QtQuick 2
\brief For specifying an image that can be used as a border
\inherits Item
- \ingroup qml-basic-visual-elements
+ \ingroup qtquick-item-graphics
The BorderImage element is used to create borders out of images by scaling or tiling
parts of each image.
/*!
\qmlclass Window QQuickCanvas
\inqmlmodule QtQuick.Window 2
+ \ingroup qtquick-visual-types
\brief Creates a new top-level window
The Window object creates a new top-level window for a QtQuick scene. It automatically sets up the
/*!
\qmlclass Drag QQuickDrag
\inqmlmodule QtQuick 2
+ \ingroup qtquick-interaction
\brief For specifying drag and drop events for moved Items
Using the Drag attached property any Item can made a source of drag and drop
/*!
\qmlclass DropArea QQuickDropArea
\inqmlmodule QtQuick 2
+ \ingroup qtquick-interaction
\brief For specifying drag and drop handling in an area
A DropArea is an invisible item which receives events when other items are
/*!
\qmlclass DragEvent QQuickDragEvent
\inqmlmodule QtQuick 2
+ \ingroup qtquick-interaction
\brief Provides information about a drag event
The position of the drag event can be obtained from the \l x and \l y
/*!
\qmlclass KeyEvent QQuickKeyEvent
\inqmlmodule QtQuick 2
- \ingroup qml-event-elements
+ \ingroup qtquick-interaction
\brief Provides information about a key event
/*!
\qmlclass MouseEvent QQuickMouseEvent
\inqmlmodule QtQuick 2
- \ingroup qml-event-elements
+ \ingroup qtquick-interaction
\brief Provides information about a mouse event
/*!
\qmlclass WheelEvent QQuickWheelEvent
\inqmlmodule QtQuick 2
- \ingroup qml-event-elements
+ \ingroup qtquick-interaction
\brief Provides information about a mouse wheel event
/*!
\qmlclass Flickable QQuickFlickable
\inqmlmodule QtQuick 2
- \ingroup qml-basic-interaction-elements
+ \ingroup qtquick-interaction
+ \ingroup qtquick-containers
\brief For specifying a surface that can be "flicked"
\inherits Item
/*!
\qmlclass Flipable QQuickFlipable
\inqmlmodule QtQuick 2
- \ingroup qml-basic-interaction-elements
- \brief For specifying a surface that can be flipped
\inherits Item
+ \ingroup qtquick-containers
+ \brief For specifying a surface that can be flipped
Flipable is an item that can be visibly "flipped" between its front and
back sides, like a card. It is used together with \l Rotation, \l State
/*!
\qmlclass FocusScope QQuickFocusScope
\inqmlmodule QtQuick 2
- \ingroup qml-basic-interaction-elements
+ \ingroup qtquick-interaction
\brief Explicitly creates a focus scope
\inherits Item
/*!
\qmlclass GridView QQuickGridView
\inqmlmodule QtQuick 2
- \ingroup qml-view-elements
+ \ingroup qtquick-views
\inherits Flickable
\brief For specifying a grid view of items provided by a model
/*!
\qmlclass Image QQuickImage
\inqmlmodule QtQuick 2
- \ingroup qml-basic-visual-elements
- \brief Displays an image in a declarative user interface
+ \ingroup qtquick-images
\inherits Item
+ \brief Displays an image in a declarative user interface
The Image element is used to display images in a declarative user interface.
/*!
\qmlclass Transform QQuickTransform
\inqmlmodule QtQuick 2
- \ingroup qml-transform-elements
+ \ingroup qtquick-transformations
\brief For specifying advanced transformations on Items
The Transform element is a base type which cannot be instantiated directly.
/*!
\qmlclass Translate QQuickTranslate
\inqmlmodule QtQuick 2
- \ingroup qml-transform-elements
+ \ingroup qtquick-transformations
\brief Provides a way to move an Item without changing its x or y properties
The Translate object provides independent control over position in addition to the Item's x and y properties.
/*!
\qmlclass Scale QQuickScale
\inqmlmodule QtQuick 2
- \ingroup qml-transform-elements
+ \ingroup qtquick-transformations
\brief Provides a way to scale an Item
The Scale element gives more control over scaling than using \l Item's \l{Item::scale}{scale} property. Specifically,
/*!
\qmlclass Rotation QQuickRotation
\inqmlmodule QtQuick 2
- \ingroup qml-transform-elements
+ \ingroup qtquick-transformations
\brief Provides a way to rotate an Item
The Rotation object gives more control over rotation than using \l Item's \l{Item::rotation}{rotation} property.
/*!
\qmlclass KeyNavigation QQuickKeyNavigationAttached
\inqmlmodule QtQuick 2
- \ingroup qml-basic-interaction-elements
+ \ingroup qtquick-interaction
\brief Supports key navigation by arrow keys
Key-based user interfaces commonly allow the use of arrow keys to navigate between
/*!
\qmlclass Keys QQuickKeysAttached
\inqmlmodule QtQuick 2
- \ingroup qml-basic-interaction-elements
+ \ingroup qtquick-interaction
\brief Provides key handling to Items
All visual primitives support key handling via the Keys
/*!
\qmlclass LayoutMirroring QQuickLayoutMirroringAttached
\inqmlmodule QtQuick 2
+ \ingroup qtquick-utility
\ingroup qml-utility-elements
\brief Property used to mirror layout behavior
\qmlclass Item QQuickItem
\inherits QtObject
\inqmlmodule QtQuick 2
- \ingroup qml-basic-visual-elements
+ \ingroup qtquick-visual-types
\brief A basic visual QML type
All visual items in Qt Quick inherit from Item. Although Item
/*!
\qmlclass ParentAnimation QQuickParentAnimation
\inqmlmodule QtQuick 2
- \ingroup qml-animation-transition
+ \ingroup qtquick-animation-properties
\since QtQuick 2.0
\inherits Animation
\brief Animates changes in parent values
/*!
\qmlclass AnchorAnimation QQuickAnchorAnimation
\inqmlmodule QtQuick 2
- \ingroup qml-animation-transition
+ \ingroup qtquick-animation-properties
\inherits Animation
\brief Animates changes in anchor values
/*!
\qmlclass ViewTransition QQuickViewTransitionAttached
\inqmlmodule QtQuick 2
- \ingroup qml-view-elements
+ \ingroup qtquick-animation-properties
\brief Specifies items under transition in a view
With ListView and GridView, it is possible to specify transitions that should be applied whenever
/*!
\qmlclass ListView QQuickListView
\inqmlmodule QtQuick 2
- \ingroup qml-view-elements
+ \ingroup qtquick-views
\inherits Flickable
\brief Provides a list view of items provided by a model
/*!
\qmlclass Loader QQuickLoader
\inqmlmodule QtQuick 2
- \ingroup qml-utility-elements
+ \ingroup qtquick-utility
\inherits Item
\brief Allows dynamical loading of an item-based subtree from a URL or Component
/*!
\qmlclass MouseArea QQuickMouseArea
\inqmlmodule QtQuick 2
- \ingroup qml-basic-interaction-elements
+ \ingroup qtquick-interaction
\brief Enables simple mouse handling
\inherits Item
/*!
\qmlclass TouchPoint QQuickTouchPoint
\inqmlmodule QtQuick 2
- \ingroup qml-event-elements
+ \ingroup qtquick-interaction
\brief Describes a touch point in a MultiPointTouchArea
The TouchPoint element contains information about a touch point, such as the current
/*!
\qmlclass MultiPointTouchArea QQuickMultiPointTouchArea
\inqmlmodule QtQuick 2
- \brief Enables handling of multiple touch points
\inherits Item
+ \ingroup qtquick-interaction
+ \brief Enables handling of multiple touch points
+
A MultiPointTouchArea is an invisible item that is used to track multiple touch points.
/*!
\qmlclass PathView QQuickPathView
\inqmlmodule QtQuick 2
- \ingroup qml-view-elements
- \brief Lays out model-provided items on a path
+ \ingroup qtquick-paths
+ \ingroup qtquick-views
\inherits Item
+ \brief Lays out model-provided items on a path
A PathView displays data from models created from built-in QML elements like ListModel
and XmlListModel, or custom model classes defined in C++ that inherit from
/*!
\qmlclass PinchEvent QQuickPinchEvent
\inqmlmodule QtQuick 2
- \ingroup qml-event-elements
+ \ingroup qtquick-interaction
\brief For specifying information about a pinch event
\b {The PinchEvent element was added in QtQuick 1.1}
/*!
\qmlclass PinchArea QQuickPinchArea
\inqmlmodule QtQuick 2
- \brief Enables simple pinch gesture handling
+ \ingroup qtquick-interaction
\inherits Item
+ \brief Enables simple pinch gesture handling
\b {The PinchArea element was added in QtQuick 1.1}
/*!
\qmlclass Positioner QQuickPositionerAttached
\inqmlmodule QtQuick 2
- \ingroup qml-positioning-elements
+ \ingroup qtquick-positioners
\brief Provides attached properties that contain details on where an item exists in a positioner
Positioner is an attached property that is attached to the top-level child item within a
/*!
\qmlclass Column QQuickColumn
\inqmlmodule QtQuick 2
- \ingroup qml-positioning-elements
- \brief Positions its children in a column
\inherits Item
+ \ingroup qtquick-positioners
+ \brief Positions its children in a column
Column is an element that positions its child items along a single column.
It can be used as a convenient way to vertically position a series of items without
/*!
\qmlclass Row QQuickRow
\inqmlmodule QtQuick 2
- \ingroup qml-positioning-elements
- \brief Positions its children in a row
\inherits Item
+ \ingroup qtquick-positioners
+ \brief Positions its children in a row
Row is an element that positions its child items along a single row.
It can be used as a convenient way to horizontally position a series of items without
/*!
\qmlclass Grid QQuickGrid
\inqmlmodule QtQuick 2
- \ingroup qml-positioning-elements
- \brief Positions its children in grid formation
\inherits Item
+ \ingroup qtquick-positioners
+ \brief Positions its children in grid formation
Grid is an element that positions its child items in grid formation.
/*!
\qmlclass Flow QQuickFlow
\inqmlmodule QtQuick 2
- \ingroup qml-positioning-elements
- \brief Positions its children side by side, wrapping as necessary
\inherits Item
+ \ingroup qtquick-positioners
+ \brief Positions its children side by side, wrapping as necessary
The Flow item positions its child items like words on a page, wrapping them
to create rows or columns of items.
/*!
\qmlclass GradientStop QQuickGradientStop
\inqmlmodule QtQuick 2
- \ingroup qml-basic-visual-elements
+ \ingroup qtquick-item-graphics
\brief Defines the color at a position in a Gradient
\sa Gradient
/*!
\qmlclass Gradient QQuickGradient
\inqmlmodule QtQuick 2
- \ingroup qml-basic-visual-elements
+ \ingroup qtquick-item-graphics
\brief Defines a gradient fill
A gradient is defined by two or more colors, which will be blended seamlessly.
/*!
\qmlclass Rectangle QQuickRectangle
\inqmlmodule QtQuick 2
- \ingroup qml-basic-visual-elements
- \brief Describes a filled rectangle with an optional border
\inherits Item
+ \ingroup qtquick-visual-types
+ \brief Describes a filled rectangle with an optional border
Rectangle items are used to fill areas with solid color or gradients, and are
often used to hold other items.
/*!
\qmlclass Repeater QQuickRepeater
\inqmlmodule QtQuick 2
- \ingroup qml-utility-elements
+ \ingroup qtquick-models
\inherits Item
\brief Specifies how to repeately create an Item-based component using a model
/*!
\qmlclass Screen QQuickScreenAttached
\inqmlmodule QtQuick.Window 2
+ \ingroup qtquick-utility
\brief The Screen attached object provides information about the Screen an Item is displayed on.
The Screen attached object is only valid inside Item or Item derived elements, after component completion.
/*!
\qmlclass ShaderEffect QQuickShaderEffect
\inqmlmodule QtQuick 2
- \ingroup qml-basic-visual-elements
- \brief Applies custom shaders to a rectangle
\inherits Item
+ \ingroup qtquick-shaders
+ \brief Applies custom shaders to a rectangle
The ShaderEffect element applies a custom OpenGL
\l{vertexShader}{vertex} and \l{fragmentShader}{fragment} shader to a
/*!
\qmlclass GridMesh QQuickGridMesh
\inqmlmodule QtQuick 2
- \ingroup qml-utility-elements
+ \ingroup qtquick-shaders
\brief Defines a mesh with vertices arranged in a grid
GridMesh defines a rectangular mesh consisting of vertices arranged in an
/*!
\qmlclass ShaderEffectSource QQuickShaderEffectSource
\since 5.0
- \ingroup qml-basic-visual-elements
- \brief Renders a QML element into a texture and displays it
\inherits Item
+ \ingroup qtquick-shaders
+ \brief Renders a QML element into a texture and displays it
The ShaderEffectSource element renders \l sourceItem into a texture and
displays it in the scene. \l sourceItem is drawn into the texture as though
/*!
\qmlclass Sprite QQuickSprite
\inqmlmodule QtQuick 2
+ \ingroup qtquick-images-sprites
\brief Specifies sprite animations
QQuickSprite renders sprites of one or more frames and animates them. The sprites
/*!
\qmlclass SpriteSequence QQuickSpriteSequence
\inqmlmodule QtQuick 2
+ \ingroup qtquick-images-sprites
\inherits Item
\brief Draws a sprite animation
/*!
\qmlclass ParentChange QQuickParentChange
\inqmlmodule QtQuick 2
- \ingroup qml-state-elements
+ \ingroup qtquick-states
\brief Specifies how to reparent an Item in a state change
ParentChange reparents an item while preserving its visual appearance (position, size,
/*!
\qmlclass AnchorChanges QQuickAnchorChanges
\inqmlmodule QtQuick 2
- \ingroup qml-state-elements
+ \ingroup qtquick-states
\brief Specifies how to change the anchors of an item in a state
The AnchorChanges element is used to modify the anchors of an item in a \l State.
/*!
\qmlclass Text QQuickText
\inqmlmodule QtQuick 2
- \ingroup qml-basic-visual-elements
- \brief Specifies how to add formatted text to a scene
+ \ingroup qtquick-text
\inherits Item
+ \brief Specifies how to add formatted text to a scene
Text items can display both plain and rich text. For example, red text with
a specific font and size can be defined like this:
/*!
\qmlclass TextEdit QQuickTextEdit
\inqmlmodule QtQuick 2
- \ingroup qml-basic-visual-elements
- \brief Displays multiple lines of editable formatted text
+ \ingroup qtquick-text
\inherits Item
+ \brief Displays multiple lines of editable formatted text
The TextEdit item displays a block of editable, formatted text.
/*!
\qmlclass TextInput QQuickTextInput
\inqmlmodule QtQuick 2
- \ingroup qml-basic-visual-elements
+ \ingroup qtquick-text
\inherits Item
\brief Displays an editable line of text
/*!
\qmlclass IntValidator QIntValidator
\inqmlmodule QtQuick 2
- \ingroup qml-basic-visual-elements
+ \ingroup qtquick-text-validator
\brief Defines a validator for integer values
This element provides a validator for integer values.
/*!
\qmlclass DoubleValidator QDoubleValidator
\inqmlmodule QtQuick 2
- \ingroup qml-basic-visual-elements
+ \ingroup qtquick-text-validator
\brief Defines a validator for non-integer numbers
This element provides a validator for non-integer numbers.
/*!
\qmlclass RegExpValidator QRegExpValidator
\inqmlmodule QtQuick 2
- \ingroup qml-basic-visual-elements
+ \ingroup qtquick-text-validator
\brief Provides a string validator
This element provides a validator, which counts as valid any string which
/*!
\qmlclass VisualDataModel QQuickVisualDataModel
\inqmlmodule QtQuick 2
- \ingroup qml-working-with-data
+ \ingroup qtquick-models
\brief Encapsulates a model and delegate
A VisualDataModel encapsulates a model and the delegate that will
/*!
\qmlclass VisualDataGroup QQuickVisualDataGroup
\inqmlmodule QtQuick 2
- \ingroup qml-working-with-data
+ \ingroup qtquick-models
\brief Encapsulates a filtered set of visual data items
*/
/*!
\qmlclass VisualItemModel QQuickVisualItemModel
\inqmlmodule QtQuick 2
- \ingroup qml-working-with-data
+ \ingroup qtquick-models
\brief Defines items to be used added to a view
A VisualItemModel contains the visual items to be used in a view.
/*!
\qmlclass Animation QQuickAbstractAnimation
\inqmlmodule QtQuick 2
- \ingroup qml-animation-transition
+ \ingroup qtquick-animation-properties
\brief Is the base of all QML animations
The Animation element cannot be used directly in a QML file. It exists
/*!
\qmlclass PauseAnimation QQuickPauseAnimation
\inqmlmodule QtQuick 2
- \ingroup qml-animation-transition
+ \ingroup qtquick-animation-modifiers
\inherits Animation
\brief Provides a pause for an animation
/*!
\qmlclass ColorAnimation QQuickColorAnimation
\inqmlmodule QtQuick 2
- \ingroup qml-animation-transition
+ \ingroup qtquick-animation-properties
\inherits PropertyAnimation
\brief Animates changes in color values
/*!
\qmlclass ScriptAction QQuickScriptAction
\inqmlmodule QtQuick 2
- \ingroup qml-animation-transition
+ \ingroup qtquick-animation-modifiers
\inherits Animation
\brief Defines scripts to be run during an animation
/*!
\qmlclass PropertyAction QQuickPropertyAction
\inqmlmodule QtQuick 2
- \ingroup qml-animation-transition
+ \ingroup qtquick-animation-modifiers
\inherits Animation
\brief Specifies immediate property changes during animation
/*!
\qmlclass NumberAnimation QQuickNumberAnimation
\inqmlmodule QtQuick 2
- \ingroup qml-animation-transition
+ \ingroup qtquick-animation-properties
\inherits PropertyAnimation
\brief Animates changes in qreal-type values
/*!
\qmlclass Vector3dAnimation QQuickVector3dAnimation
\inqmlmodule QtQuick 2
- \ingroup qml-animation-transition
+ \ingroup qtquick-animation-properties
\inherits PropertyAnimation
\brief Animates changes in QVector3d values
/*!
\qmlclass RotationAnimation QQuickRotationAnimation
\inqmlmodule QtQuick 2
- \ingroup qml-animation-transition
+ \ingroup qtquick-animation-properties
\inherits PropertyAnimation
\brief Animates changes in rotation values
/*!
\qmlclass SequentialAnimation QQuickSequentialAnimation
\inqmlmodule QtQuick 2
- \ingroup qml-animation-transition
+ \ingroup qtquick-animation-define
\inherits Animation
\brief Allows animations to be run sequentially
/*!
\qmlclass ParallelAnimation QQuickParallelAnimation
\inqmlmodule QtQuick 2
- \ingroup qml-animation-transition
+ \ingroup qtquick-animation-define
\inherits Animation
\brief Enables animations to be run in parallel
/*!
\qmlclass PropertyAnimation QQuickPropertyAnimation
\inqmlmodule QtQuick 2
- \ingroup qml-animation-transition
+ \ingroup qtquick-animation-properties
\inherits Animation
\brief Animates changes in property values
/*!
\qmlclass AnimationController QQuickAnimationController
\inqmlmodule QtQuick 2
- \ingroup qml-animation-transition
+ \ingroup qtquick-animation-control
\brief Enables manual control of animations
Normally animations are driven by an internal timer, but the AnimationController
/*!
\qmlclass Behavior QQuickBehavior
\inqmlmodule QtQuick 2
- \ingroup qml-animation-transition
+ \ingroup qtquick-animation-define
\brief Defines a default animation for a property change
A Behavior defines the default animation to be applied whenever a
/*!
\qmlclass Binding QQuickBind
\inqmlmodule QtQuick 2
- \ingroup qml-working-with-data
+ \ingroup qtquick-utility
\brief Enables the arbitrary creation of property bindings
\section1 Binding to an inaccessible property
/*!
\qmlclass Connections QQuickConnections
\inqmlmodule QtQuick 2
- \ingroup qml-utility-elements
+ \ingroup qtquick-utility
\brief Describes generalized connections to signals
A Connections object creates a connection to a QML signal.
}
\endqml
- However, it is not possible to connect to a signal in this way in some
+ However, it is not possible to connect to a signal in this way in some
cases, such as when:
\list
/*!
\qmlclass FontLoader QQuickFontLoader
\inqmlmodule QtQuick 2
- \ingroup qml-utility-elements
+ \ingroup qtquick-utility
\brief Allows fonts to be loaded by name or URL
- The FontLoader element is used to load fonts by name or URL.
-
- The \l status indicates when the font has been loaded, which is useful
+ The FontLoader element is used to load fonts by name or URL.
+
+ The \l status indicates when the font has been loaded, which is useful
for fonts loaded from remote sources.
For example:
\qml
import QtQuick 2.0
- Column {
+ Column {
FontLoader { id: fixedFont; name: "Courier" }
FontLoader { id: webFont; source: "http://www.mysite.com/myfont.ttf" }
/*!
\qmlclass Package QQuickPackage
\inqmlmodule QtQuick 2
- \ingroup qml-working-with-data
+ \ingroup qtquick-views
\brief Specifies a collection of named items
The Package class is used in conjunction with
attached.remove(parent());
}
-QString QQuickPackageAttached::name() const
-{
- return _name;
+QString QQuickPackageAttached::name() const
+{
+ return _name;
}
-void QQuickPackageAttached::setName(const QString &n)
-{
- _name = n;
+void QQuickPackageAttached::setName(const QString &n)
+{
+ _name = n;
}
QQuickPackage::QQuickPackage(QObject *parent)
QQmlListProperty<QObject> QQuickPackage::data()
{
Q_D(QQuickPackage);
- return QQmlListProperty<QObject>(this, &d->dataList, QQuickPackagePrivate::data_append,
- QQuickPackagePrivate::data_count,
- QQuickPackagePrivate::data_at,
+ return QQmlListProperty<QObject>(this, &d->dataList, QQuickPackagePrivate::data_append,
+ QQuickPackagePrivate::data_count,
+ QQuickPackagePrivate::data_at,
QQuickPackagePrivate::data_clear);
}
/*!
\qmlclass PathElement QQuickPathElement
\inqmlmodule QtQuick 2
- \ingroup qml-view-elements
+ \ingroup qtquick-paths
\brief PathElement is the base path type
This type is the base for all path types. It cannot
/*!
\qmlclass Path QQuickPath
\inqmlmodule QtQuick 2
- \ingroup qml-view-elements
+ \ingroup qtquick-paths
\brief Defines a path for use by \l PathView
A Path is composed of one or more path segments - PathLine, PathQuad,
/*!
\qmlclass PathAttribute QQuickPathAttribute
\inqmlmodule QtQuick 2
- \ingroup qml-view-elements
+ \ingroup qtquick-paths
\brief Specifies how to set an attribute at a given position in a Path
The PathAttribute object allows attributes consisting of a name and
/*!
\qmlclass PathLine QQuickPathLine
\inqmlmodule QtQuick 2
- \ingroup qml-view-elements
+ \ingroup qtquick-paths
\brief Defines a straight line
The example below creates a path consisting of a straight line from
/*!
\qmlclass PathQuad QQuickPathQuad
\inqmlmodule QtQuick 2
- \ingroup qml-view-elements
+ \ingroup qtquick-paths
\brief Defines a quadratic Bezier curve with a control point
The following QML produces the path shown below:
/****************************************************************************/
/*!
- \qmlclass PathCubic QQuickPathCubic
+ \qmlclass PathCubic QQuickPathCubic
\inqmlmodule QtQuick 2
- \ingroup qml-view-elements
- \brief Defines a cubic Bezier curve with two control points
+ \ingroup qtquick-paths
+ \brief Defines a cubic Bezier curve with two control points
The following QML produces the path shown below:
\table
/*!
\qmlclass PathCurve QQuickPathCurve
\inqmlmodule QtQuick 2
- \ingroup qml-view-elements
+ \ingroup qtquick-paths
\brief Defines a point on a Catmull-Rom curve
PathCurve provides an easy way to specify a curve passing directly through a set of points.
/*!
\qmlclass PathArc QQuickPathArc
\inqmlmodule QtQuick 2
- \ingroup qml-view-elements
+ \ingroup qtquick-paths
\brief Defines an arc with the given radius
PathArc provides a simple way of specifying an arc that ends at a given position
/*!
\qmlclass PathSvg QQuickPathSvg
\inqmlmodule QtQuick 2
- \ingroup qml-view-elements
+ \ingroup qtquick-paths
\brief Defines a path using an SVG path data string
The following QML produces the path shown below:
/*!
\qmlclass PathPercent QQuickPathPercent
\inqmlmodule QtQuick 2
- \ingroup qml-view-elements
+ \ingroup qtquick-paths
\brief Manipulates the way a path is interpreted
PathPercent allows you to manipulate the spacing between items on a
/*!
\qmlclass PathInterpolator QQuickPathInterpolator
\inqmlmodule QtQuick 2
+ \ingroup qtquick-animation-control
\brief Specifies how to manually animate along a path
PathInterpolator provides \c x, \c y, and \c angle information for a particular \c progress
/*!
\qmlclass PropertyChanges QQuickPropertyChanges
\inqmlmodule QtQuick 2
- \ingroup qml-state-elements
+ \ingroup qtquick-states
\brief Describes new property bindings or values for a state
PropertyChanges is used to define the property values or bindings in a
/*!
\qmlclass SmoothedAnimation QQuickSmoothedAnimation
\inqmlmodule QtQuick 2
- \ingroup qml-animation-transition
+ \ingroup qtquick-animation-properties
\inherits NumberAnimation
\brief Allows a property to smoothly track a value
/*!
\qmlclass SpringAnimation QQuickSpringAnimation
\inqmlmodule QtQuick 2
- \ingroup qml-animation-transition
+ \ingroup qtquick-animation-properties
\inherits NumberAnimation
\brief Allows a property to track a value in a spring-like motion
QQuickAction::QQuickAction(QObject *target, const QString &propertyName,
const QVariant &value)
-: restore(true), actionDone(false), reverseEvent(false), deletableToBinding(false),
+: restore(true), actionDone(false), reverseEvent(false), deletableToBinding(false),
property(target, propertyName, qmlEngine(target)), toValue(value),
fromBinding(0), event(0),
specifiedObject(target), specifiedProperty(propertyName)
/*!
\qmlclass State QQuickState
\inqmlmodule QtQuick 2
- \ingroup qml-state-elements
+ \ingroup qtquick-states
\brief Defines configurations of objects and properties
A \e state is a set of batched changes from the default configuration.
}
if (!found) {
QVariant cur = d->revertList.at(ii).property().read();
- QQmlAbstractBinding *delBinding =
+ QQmlAbstractBinding *delBinding =
QQmlPropertyPrivate::setBinding(d->revertList.at(ii).property(), 0);
if (delBinding)
delBinding->destroy();
qWarning() << " QQuickAction event:" << action.event->type();
else
qWarning() << " QQuickAction:" << action.property.object()
- << action.property.name() << "From:" << action.fromValue
+ << action.property.name() << "From:" << action.fromValue
<< "To:" << action.toValue;
}
}
/*!
\qmlclass StateChangeScript QQuickStateChangeScript
\inqmlmodule QtQuick 2
- \ingroup qml-state-elements
+ \ingroup qtquick-states
\brief Specifies how to run a script in a state
A StateChangeScript is run upon entering a state. You can optionally use
/*!
\qmlclass StateGroup QQuickStateGroup
\inqmlmodule QtQuick 2
- \ingroup qml-state-elements
+ \ingroup qtquick-states
\brief Provides built-in state support for non-Item elements
Item (and all derived elements) provides built in support for states and transitions
if (state->isWhenKnown()) {
if (state->isNamed()) {
if (state->when() && state->when()->evaluate().toBool()) {
- if (stateChangeDebug())
- qWarning() << "Setting auto state due to:"
+ if (stateChangeDebug())
+ qWarning() << "Setting auto state due to:"
<< state->when()->expression();
if (currentState != state->name()) {
q->setState(state->name());
for (int ii = 0; ii < 2; ++ii)
{
if (ii && (!t->reversible() ||
- (t->fromState() == QLatin1String("*") &&
+ (t->fromState() == QLatin1String("*") &&
t->toState() == QLatin1String("*"))))
break;
QStringList fromState;
return highest;
}
-void QQuickStateGroupPrivate::setCurrentStateInternal(const QString &state,
+void QQuickStateGroupPrivate::setCurrentStateInternal(const QString &state,
bool ignoreTrans)
{
Q_Q(QQuickStateGroup);
if (stateChangeDebug()) {
qWarning() << this << "Changing state. From" << currentState << ". To" << state;
if (transition)
- qWarning() << " using transition" << transition->fromState()
+ qWarning() << " using transition" << transition->fromState()
<< transition->toState();
}
/*!
\qmlclass SystemPalette QQuickSystemPalette
\inqmlmodule QtQuick 2
- \ingroup qml-utility-elements
+ \ingroup qtquick-utility
\brief Provides access to the Qt palettes
The SystemPalette element provides access to the Qt application
- palettes. This provides information about the standard colors used
+ palettes. This provides information about the standard colors used
for application windows, buttons and other features. These colors
are grouped into three \e {color groups}: \c Active, \c Inactive,
and \c Disabled. See the QPalette documentation for details about
/*!
\qmlclass Timer QQuickTimer
\inqmlmodule QtQuick 2
- \ingroup qml-utility-elements
+ \ingroup qtquick-utility
\brief Triggers a handler at a specified interval
A Timer can be used to trigger an action either once, or repeatedly
/*!
\qmlclass Transition QQuickTransition
\inqmlmodule QtQuick 2
- \ingroup qml-animation-transition
+ \ingroup qtquick-animation-define
\brief Defines animated transitions that occur on state changes
A Transition defines the animations to be applied when a \l State change occurs.
projects / platform / upstream / qtdeclarative.git / commitdiff