1 /****************************************************************************
3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/
6 ** This file is part of the documentation of the Qt Toolkit.
8 ** $QT_BEGIN_LICENSE:FDL$
9 ** GNU Free Documentation License
10 ** Alternatively, this file may be used under the terms of the GNU Free
11 ** Documentation License version 1.3 as published by the Free Software
12 ** Foundation and appearing in the file included in the packaging of
16 ** Alternatively, this file may be used in accordance with the terms
17 ** and conditions contained in a signed written agreement between you
26 ****************************************************************************/
29 \page qdeclarativeelements.html
30 \inqmlmodule QtQuick 1
33 \brief A listing of standard QML elements.
35 These are the functionally grouped lists of QML elements as part of
38 Elements are declared with the their name and two curly braces. Elements may
39 be nested in elements, thereby creating a parent-child relationship between the
42 To see the QML elements listed by functional area, see the
43 \l{Groups Of Related QML Elements} page.
45 \section1 Basic QML Elements
47 \o \l {Item} - Basic item element inherited by QML elements
48 \o \l {Component} - Encapsulates QML elements during importing
49 \o \l {QML:QtObject} {QtObject} - Basic element containing only the \c {objectName} property
54 \o \l {Rectangle} - A rectangle element
55 \o \l {Image} - For incorporating bitmaps into a scene
56 \o \l {BorderImage} - Allows the use of images as borders
57 \o \l {AnimatedImage} - For playing animations stored in a series of frames
58 \o \l {Gradient} - For defining a color gradient
59 \o \l {GradientStop} - Used to define a color within a \l {Gradient}
60 \o \l {SystemPalette} - Provides access to the Qt palettes
63 \section1 Text Handling
65 \o \l {Text} - For inserting formatted text into a scene
66 \o \l {TextInput} - Captures user key input
67 \o \l {TextEdit} - Displays multiple lines of editable formatted text
68 \o \l {IntValidator} - Validates values as integers
69 \o \l {DoubleValidator} - Validates real values
70 \o \l {RegExpValidator} - Validator for string regular expressions
71 \o \l {FontLoader} - Loads fonts by name or URL
74 \section1 Mouse and Interaction Area
76 \o \l {MouseArea} - Sets up an area for mouse interaction
77 \o \l {Keys} - Provides components with attached properties to handle key input.
78 \o \l {FocusScope} - Element that mediate keyboard focus changes
79 \o \l {Flickable} - Provides a surface that can be "flicked"
80 \o \l {Flipable} - Provides a surface that produces "flipping" effects
81 \o \l {PinchArea} - Enables simple pinch gesture handling
84 \section1 Positioners and Repeater
86 \o \l {Column} - Arranges its children vertically
87 \o \l {Row} - Arranges its children horizontally
88 \o \l {Grid} - Positions its children in a grid
89 \o \l {Flow} - Positions its children with wrapping support
90 \o \l {Repeater} - Uses a model to create multiple components
93 \section1 Transformations
95 \o \l {Scale} - Assigns item scaling behaviors
96 \o \l {Rotation} - Assigns item rotation behaviors
97 \o \l {Translate} - Assigns item translation behaviors
102 \o \l {State} - Defines sets of configurations of objects and properties
103 \o \l {PropertyChanges} - Describes property changes within a state
104 \o \l {StateGroup} - Contains a set of states and state transitions
105 \o \l {StateChangeScript} - Allows script binding in a state
106 \o \l {ParentChange} - Re-parent an Item in a state change
107 \o \l {AnchorChanges} - Change the anchors of an item in a state
110 \section1 Animation and Transitions
112 \o \l {Transition} - Animates transitions during state changes
113 \o \l {SequentialAnimation} - Runs animations sequentially
114 \o \l {ParallelAnimation} - Runs animations in parallel
115 \o \l {Behavior} - Specifies a default animation for property changes
116 \o \l {PropertyAction} - Sets immediate property changes during animation
117 \o \l {PauseAnimation} - Introduces a pause in an animation
118 \o \l {SmoothedAnimation} - Allows a property to smoothly track a value
119 \o \l {SpringAnimation} - Allows a property to track a value in a spring-like motion
120 \o \l {ScriptAction} - Runs scripts during an animation
123 Elements that animate properties based on data types
125 \o \l {PropertyAnimation} - Animates property changes
126 \o \l {NumberAnimation} - Animates properties of type qreal
127 \o \l {Vector3dAnimation} - Animates properties of type QVector3d
128 \o \l {ColorAnimation} - Animates color changes
129 \o \l {RotationAnimation} - Animates rotations
130 \o \l {ParentAnimation} - Animates parent changes
131 \o \l {AnchorAnimation} - Animates anchor changes
134 \section1 Models and Data Handling
136 \o \l {ListModel} - Defines a list of data
137 \o \l {ListElement} - Defines a data item in a \l {ListModel}
138 \o \l {VisualItemModel} - Contains items that already defines its own visual delegate
139 \o \l {VisualDataModel} - Encapsulates a model and a delegate
140 \o \l {XmlListModel} - Specifies a model using XPath expressions
141 \o \l {XmlRole} - Specifies a role for an \l {XmlListModel}
142 \o \l {Binding} - Binds any value to any property
143 \o \l {Package} - Collection that enables sharing of items within different views
148 \o \l {ListView} - Provides a list visualization of a model
149 \o \l {GridView} - Provides a grid visualization of a model
150 \o \l {PathView} - Visualizes a model's contents along a path. See \l {Path Definition}{Path Elements} for more information.
153 \section1 Path Definition
155 \o \l {Path} - Defines a path used by \l {PathView}
156 \o \l {PathLine} - Defines a line in \l {Path}
157 \o \l {PathQuad} - Defines a quadratic Bezier curve in a \l {Path}
158 \o \l {PathCubic} - Defines a cubic Bezier curve in a \l {Path}
159 \o \l {PathAttribute} - Allows the setting of attributes along a \l {Path}
160 \o \l {PathPercent} - Modifies the item distribution along a \l {Path}
165 \o \l {Connections} - Explicitly connects signals and signal handlers
166 \o \l {Timer} - Provides timed triggers
167 \o \l {QML:Qt} {Qt} - The QML global Qt object provides useful enums and functions from Qt.
168 \o \l {WorkerScript} - Enables the use of threads in QML
169 \o \l {Loader} - Controls the loading of items or components
170 \o \l {LayoutItem} - Allows declarative UI elements inside Qt's Graphics View layouts
173 \section1 Graphical Effects
175 \o \l {Particles} - Generates and animates particles
176 \o \l {ParticleMotionLinear} - Adds linear motion behavior to \l {Particles}
177 \o \l {ParticleMotionGravity} - Adds gravitational motion to \l {Particles}
178 \o \l {ParticleMotionWander} - Adds varied motions to \l {Particles}
181 \section1 Add-On Elements
182 These elements are not included in the \c{QtQuick 1.0} module. Their respective QML bindings
183 should first be obtained and installed.
185 \o \l{WebView}{QtWebKit QML Module - WebView Element} - For displaying Web contents
186 \o \l{http://doc.qt.nokia.com/qtmobility-1.1.0/qml-plugins.html}{Mobility QML Plugins}
194 \title Groups Of Related QML Elements
196 \brief If you know what kind of QML element you want (Basic Visual,
197 Interaction, Animation, etc), look here.
199 This is a list of functional groups of QML elements.
201 \generatelist{related}
206 \group qml-basic-visual-elements
207 \title Basic QML Visual Elements
210 \brief Elements for constructing basic visual items.
212 \generatelist{related}
217 \group qml-basic-interaction-elements
218 \title Basic QML Interaction Elements
221 \brief Elements for handling basic interactions.
223 \generatelist{related}
228 \group qml-state-elements
229 \title QML State Elements
232 \brief Elements for handling state changes.
234 \generatelist{related}
239 \group qml-event-elements
240 \title QML Event Elements
243 \brief Elements for handling events.
245 \generatelist{related}
250 \group qml-animation-transition
251 \title QML Animation and Transition Elements
254 \brief Elements for handling animations and transitions.
256 \generatelist{related}
261 \group qml-working-with-data
262 \title Working With Data in QML
265 \brief Elements for working with data.
267 \generatelist{related}
272 \group qml-view-elements
273 \title QML View Elements
276 \brief Elements for handling views.
278 \generatelist{related}
283 \group qml-positioning-elements
284 \title QML Positioning Elements
287 \brief Elements for positioning items.
289 \generatelist{related}
294 \group qml-utility-elements
295 \title QML Utility Elements
298 \brief Elements for handling misc operations.
300 \generatelist{related}
305 \group qml-transform-elements
306 \title QML Transform Elements
309 \brief Elements for handling transformations.
311 \generatelist{related}
316 \group qml-particle-elements
317 \title QML Particle Elements
320 \brief Elements for handling particle effects.
322 \generatelist{related}