Qt Reference Documentation

# QML Elements

These are the functionally grouped lists of QML elements as part of Qt Quick.

Elements are declared with the their name and two curly braces. Elements may be nested in elements, thereby creating a parent-child relationship between the two elements.

To see the QML elements listed by functional area, see the Groups Of Related QML Elements page.

## Basic QML Elements

- Item - Basic item element inherited by QML elements
- Component - Encapsulates QML elements during importing
- QtObject - Basic element containing only the `objectName` property

## Graphics

- Rectangle - A rectangle element
- Image - For incorporating bitmaps into a scene
- BorderImage - Allows the use of images as borders
- AnimatedImage - For playing animations stored in a series of frames
- Gradient - For defining a color gradient
- GradientStop - Used to define a color within a Gradient
- SystemPalette - Provides access to the Qt palettes

## Text Handling

- Text - For inserting formatted text into a scene
- TextInput - Captures user key input
- TextEdit - Displays multiple lines of editable formatted text
- IntValidator - Validates values as integers
- DoubleValidator - Validates real values
- RegExpValidator - Validator for string regular expressions
- FontLoader - Loads fonts by name or URL

## Mouse and Interaction Area

- MouseArea - Sets up an area for mouse interaction
- Keys - Provides components with attached properties to handle key input.
- FocusScope - Element that mediate keyboard focus changes
- Flickable - Provides a surface that can be "flicked"
- Flipable - Provides a surface that produces "flipping" effects
- PinchArea - Enables simple pinch gesture handling

## Positioners and Repeater

- Column - Arranges its children vertically
- Row - Arranges its children horizontally
- Grid - Positions its children in a grid
- Flow - Positions its children with wrapping support
- Repeater - Uses a model to create multiple components

## Transformations

- Scale - Assigns item scaling behaviors
- Rotation - Assigns item rotation behaviors
- Translate - Assigns item translation behaviors

## States

- State - Defines sets of configurations of objects and properties
- PropertyChanges - Describes property changes within a state
- StateGroup - Contains a set of states and state transitions
- StateChangeScript - Allows script binding in a state
- ParentChange - Re-parent an Item in a state change
- AnchorChanges - Change the anchors of an item in a state

## Animation and Transitions

- Transition - Animates transitions during state changes
- SequentialAnimation - Runs animations sequentially
- ParallelAnimation - Runs animations in parallel
- Behavior - Specifies a default animation for property changes
- PropertyAction - Sets immediate property changes during animation
- PauseAnimation - Introduces a pause in an animation
- SmoothedAnimation - Allows a property to smoothly track a value
- SpringAnimation - Allows a property to track a value in a spring-like motion
- ScriptAction - Runs scripts during an animation

Elements that animate properties based on data types

- PropertyAnimation - Animates property changes
- NumberAnimation - Animates properties of type qreal
- Vector3dAnimation - Animates properties of type QVector3d
- ColorAnimation - Animates color changes
- RotationAnimation - Animates rotations
- ParentAnimation - Animates parent changes
- AnchorAnimation - Animates anchor changes

## Models and Data Handling

- ListModel - Defines a list of data
- ListElement - Defines a data item in a ListModel
- VisualItemModel - Contains items that already defines its own visual delegate
- VisualDataModel - Encapsulates a model and a delegate
- XmlListModel - Specifies a model using XPath expressions
- XmlRole - Specifies a role for an XmlListModel
- Binding - Binds any value to any property
- Package - Collection that enables sharing of items within different views

## Views

- ListView - Provides a list visualization of a model
- GridView - Provides a grid visualization of a model
- PathView - Visualizes a model's contents along a path. See Path Elements for more information.

## Path Definition

- Path - Defines a path used by PathView
- PathLine - Defines a line in Path
- PathQuad - Defines a quadratic Bezier curve in a Path
- PathCubic - Defines a cubic Bezier curve in a Path
- PathAttribute - Allows the setting of attributes along a Path
- PathPercent - Modifies the item distribution along a Path

## Utility

- Connections - Explicitly connects signals and signal handlers
- Timer - Provides timed triggers
- Qt - The QML global Qt object provides useful enums and functions from Qt.
- WorkerScript - Enables the use of threads in QML
- Loader - Controls the loading of items or components
- LayoutItem - Allows declarative UI elements inside Qt's Graphics View layouts

## Graphical Effects

- Particles - Generates and animates particles
- ParticleMotionLinear - Adds linear motion behavior to Particles
- ParticleMotionGravity - Adds gravitational motion to Particles
- ParticleMotionWander - Adds varied motions to Particles
- ShaderEffectItem - Enables the use of OpenGL Shading Language together with QML
- ShaderEffectSource - Encapsulates QML item tree as a source item for ShaderEffectItem

## Add-On Elements

These elements are not included in the `QtQuick 1.0` module. Their respective QML bindings should first be obtained and installed.

- QtWebKit QML Module - WebView Element - For displaying Web contents
- Mobility QML Plugins
- Qt Quick Components