doc/src/qtquick1/elements.qdoc

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the documentation of the Qt Toolkit.
   7 **
   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
  13 ** this file.
  14 **
  15 ** Other Usage
  16 ** Alternatively, this file may be used in accordance with the terms
  17 ** and conditions contained in a signed written agreement between you
  18 ** and Nokia.
  19 **
  20 **
  21 **
  22 **
  23 **
  24 ** $QT_END_LICENSE$
  25 **
  26 ****************************************************************************/
  27
  28 /*!
  29   \page qdeclarativeelements.html
  30 \inqmlmodule QtQuick 1
  31   \target elements
  32   \title QML Elements
  33   \brief A listing of standard QML elements.
  34
  35 These are the functionally grouped lists of QML elements as part of
  36 \l{Qt Quick}.
  37
  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
  40 two elements.
  41
  42 To see the QML elements listed by functional area, see the
  43 \l{Groups Of Related QML Elements} page.
  44
  45 \section1 Basic QML Elements
  46 \list
  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
  50 \endlist
  51
  52 \section1 Graphics
  53 \list
  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
  61 \endlist
  62
  63 \section1 Text Handling
  64 \list
  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
  72 \endlist
  73
  74 \section1 Mouse and Interaction Area
  75 \list
  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
  82 \endlist
  83
  84 \section1 Positioners and Repeater
  85 \list
  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
  91 \endlist
  92
  93 \section1 Transformations
  94 \list
  95 \o \l {Scale} - Assigns item scaling behaviors
  96 \o \l {Rotation} - Assigns item rotation behaviors
  97 \o \l {Translate} - Assigns item translation behaviors
  98 \endlist
  99
 100 \section1 States
 101 \list
 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
 108 \endlist
 109
 110 \section1 Animation and Transitions
 111 \list
 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
 121 \endlist
 122
 123 Elements that animate properties based on data types
 124 \list
 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
 132 \endlist
 133
 134 \section1 Models and Data Handling
 135 \list
 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
 144 \endlist
 145
 146 \section1 Views
 147 \list
 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.
 151 \endlist
 152
 153 \section1 Path Definition
 154 \list
 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}
 161 \endlist
 162
 163 \section1 Utility
 164 \list
 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
 171 \endlist
 172
 173 \section1 Graphical Effects
 174 \list
 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}
 179 \endlist
 180
 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.
 184 \list
 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}
 187 \endlist
 188
 189 */
 190
 191
 192 /*!
 193     \group qml-groups
 194     \title Groups Of Related QML Elements
 195
 196     \brief If you know what kind of QML element you want (Basic Visual,
 197     Interaction, Animation, etc), look here.
 198
 199     This is a list of functional groups of QML elements.
 200
 201     \generatelist{related}
 202
 203 */
 204
 205 /*!
 206     \group qml-basic-visual-elements
 207     \title Basic QML Visual Elements
 208     \ingroup qml-groups
 209
 210     \brief Elements for constructing basic visual items.
 211
 212     \generatelist{related}
 213
 214 */
 215
 216 /*!
 217     \group qml-basic-interaction-elements
 218     \title Basic QML Interaction Elements
 219     \ingroup qml-groups
 220
 221     \brief Elements for handling basic interactions.
 222
 223     \generatelist{related}
 224
 225 */
 226
 227 /*!
 228     \group qml-state-elements
 229     \title QML State Elements
 230     \ingroup qml-groups
 231
 232     \brief Elements for handling state changes.
 233
 234     \generatelist{related}
 235
 236 */
 237
 238 /*!
 239     \group qml-event-elements
 240     \title QML Event Elements
 241     \ingroup qml-groups
 242
 243     \brief Elements for handling events.
 244
 245     \generatelist{related}
 246
 247 */
 248
 249 /*!
 250     \group qml-animation-transition
 251     \title QML Animation and Transition Elements
 252     \ingroup qml-groups
 253
 254     \brief Elements for handling animations and transitions.
 255
 256     \generatelist{related}
 257
 258 */
 259
 260 /*!
 261     \group qml-working-with-data
 262     \title Working With Data in QML
 263     \ingroup qml-groups
 264
 265     \brief Elements for working with data.
 266
 267     \generatelist{related}
 268
 269 */
 270
 271 /*!
 272     \group qml-view-elements
 273     \title QML View Elements
 274     \ingroup qml-groups
 275
 276     \brief Elements for handling views.
 277
 278     \generatelist{related}
 279
 280 */
 281
 282 /*!
 283     \group qml-positioning-elements
 284     \title QML Positioning Elements
 285     \ingroup qml-groups
 286
 287     \brief Elements for positioning items.
 288
 289     \generatelist{related}
 290
 291 */
 292
 293 /*!
 294     \group qml-utility-elements
 295     \title QML Utility Elements
 296     \ingroup qml-groups
 297
 298     \brief Elements for handling misc operations.
 299
 300     \generatelist{related}
 301
 302 */
 303
 304 /*!
 305     \group qml-transform-elements
 306     \title QML Transform Elements
 307     \ingroup qml-groups
 308
 309     \brief Elements for handling transformations.
 310
 311     \generatelist{related}
 312
 313 */
 314
 315 /*!
 316     \group qml-particle-elements
 317     \title QML Particle Elements
 318     \ingroup qml-groups
 319
 320     \brief Elements for handling particle effects.
 321
 322     \generatelist{related}
 323
 324 */