aboutsummaryrefslogtreecommitdiffstats
path: root/src/quick/doc/src/qmltypereference.qdoc
diff options
context:
space:
mode:
authorAlan Alpert <alan.alpert@nokia.com>2012-07-23 14:20:32 +1000
committerQt by Nokia <qt-info@nokia.com>2012-07-23 08:57:53 +0200
commit98cbb910a2fe1a7b7e39ea937c9d45a2a8f5a96e (patch)
treead89197c52f4b9e5477bb24b3c3ee75894442ea4 /src/quick/doc/src/qmltypereference.qdoc
parent231e73b400fdc7eae84cb8beaf246617dcf8557e (diff)
Fixup types page
No longer double referencing items No longer referencing SpriteGoal (in .Particles module) No longer referencing FolderListModel (in labs module) Moved some types and categories around Fixed some heading capitalization General rewording of several parts Change-Id: Ie36eb0c17ce6602c6ae15bceedaebebeaeeeaaab Reviewed-by: Bea Lam <bea.lam@nokia.com>
Diffstat (limited to 'src/quick/doc/src/qmltypereference.qdoc')
-rw-r--r--src/quick/doc/src/qmltypereference.qdoc70
1 files changed, 35 insertions, 35 deletions
diff --git a/src/quick/doc/src/qmltypereference.qdoc b/src/quick/doc/src/qmltypereference.qdoc
index a9ea971825..e58626b85a 100644
--- a/src/quick/doc/src/qmltypereference.qdoc
+++ b/src/quick/doc/src/qmltypereference.qdoc
@@ -32,9 +32,9 @@
This page contains links to documentation for every QML type provided by the
Qt Quick module, organized according to category and purpose. All of the types
-are based on the basic QML language object types: \l{QML::QtObject} and
-\l{QML::Component}. Both of those basic types are available from the QtQuick
-import.
+are based on the basic \l{Item} type, which itself derives from \l{QML::QtObject}.
+Basic QML types such as \l{QML::QtObject} and \l{QML::Component} are also available
+when you import QtQuick.
\section1 Visual Types
@@ -45,34 +45,46 @@ import.
\li \l {BorderImage} - Allows the use of images as borders
\li \l {AnimatedImage} - For playing animations stored as an animated GIF
\li \l {AnimatedSprite} - For playing animations stored as a series of frames
+\li \l {SpriteSequence} - For playing and transitioning between multiple animations stored as a series of frames
\li \l {Text} - For inserting formatted text into a scene
-\li \l {TextInput} - Captures user key input
-\li \l {TextEdit} - Displays multiple lines of editable formatted text
-\li \l {Canvas} - Provides a 2D canvas type similar to the HTML5 canvas
\li \l {Window} - Provides a top-level window
\endlist
-Visual object utility types
+Visual Item Utility
\list
\li \l {Accessible} - Attached property to make components accessible
\li \l {Gradient} - For defining a color gradient
\li \l {GradientStop} - Used to define a color within a \l {Gradient}
\li \l {SystemPalette} - Provides access to the Qt palettes
\li \l {Screen} - Provides information about the screen on which an \l {Item} is displayed
-\li \l {Sprite} - Specifies sprite animations
-\li \l {SpriteSequence} - For playing and transitioning between multiple animations stored as a series of frames
-\li \l {SpriteGoal} - For changing the state of a Sprite
+\li \l {Sprite} - Specifies sprite animations for other Items to display
+\li \l {FontLoader} - Loads fonts by name or URL
\endlist
-\section1 User Input Types
+Visual Item Generation
+
+\list
+\li \l {Repeater} - Uses a model to create multiple Item instances
+\li \l {Loader} - Eases on-demand loading of Items
+\endlist
+
+Visual Item Transformations
+\list
+\li \l {Transform} - Allows specification of advanced transformations on Items
+\li \l {Scale} - Assigns item scaling behaviors
+\li \l {Rotation} - Assigns item rotation behaviors
+\li \l {Translate} - Assigns item translation behaviors
+\endlist
+
+
+\section1 User Input
\list
\li \l {MouseArea} - Sets up an area for mouse interaction
\li \l {Keys} - Provides components with attached properties to handle key input.
\li \l {KeyNavigation} - Supports key navigation by arrow keys
-\li \l {FocusScope} - Element that mediate keyboard focus changes
+\li \l {FocusScope} - Mediates keyboard focus changes
\li \l {Flickable} - Provides a surface that can be "flicked"
-\li \l {Flipable} - Provides a surface that produces "flipping" effects
\li \l {PinchArea} - Enables simple pinch gesture handling
\li \l {MultiPointTouchArea} - Enables handling of multiple touch points
\li \l {Drag} - For specifying drag and drop events for visual items
@@ -81,15 +93,15 @@ Visual object utility types
\li \l {TextEdit} - Displays multiple lines of editable formatted text
\endlist
-Text input utility types
+Text Input Utility
+
\list
\li \l {IntValidator} - Validates values as integers
\li \l {DoubleValidator} - Validates real values
\li \l {RegExpValidator} - Validator for string regular expressions
-\li \l {FontLoader} - Loads fonts by name or URL
\endlist
-User input events
+User Input Events
\list
\li \l {TouchPoint} - Describes a touch point in a MultiPointTouchArea
\li \l {PinchEvent} - Specifies information about a pinch event
@@ -102,13 +114,11 @@ User input events
\section1 Positioning
\list
-\li \l {Positioner} - Provides information about where an Item exists within a layout
+\li \l {Positioner} - Attached property which provides information about where an Item has been positioned
\li \l {Column} - Arranges its children vertically
\li \l {Row} - Arranges its children horizontally
\li \l {Grid} - Positions its children in a grid
\li \l {Flow} - Positions its children with wrapping support
-\li \l {Repeater} - Uses a model to create multiple components
-\li \l {qtquick-concepts-positioning-anchors.html}{Anchor} - Allows visual items to be anchored together
\li \l {LayoutMirroring} - Attached property used to mirror layout behavior
\endlist
@@ -122,9 +132,9 @@ States
\li \l {StateChangeScript} - Allows script binding in a state
\li \l {ParentChange} - Re-parent an Item in a state change
\li \l {AnchorChanges} - Change the anchors of an item in a state
+\endlist
Transitions and Animations
-\endlist
\list
\li \l {Transition} - Animates transitions during state changes
\li \l {ViewTransition} - Specifies items under transition in a view
@@ -138,7 +148,7 @@ Transitions and Animations
\li \l {ScriptAction} - Runs scripts during an animation
\endlist
-Elements that animate properties based on data types
+Type-specific Animations
\list
\li \l {PropertyAnimation} - Animates property changes
\li \l {NumberAnimation} - Animates properties of type qreal
@@ -150,7 +160,7 @@ Elements that animate properties based on data types
\li \l {PathAnimation} - Animates position along a path
\endlist
-Elements that provide lower-level animation control
+Lower-level Animation Types
\list
\li \l {PathInterpolator} - Allows manual animation along a path
\li \l {AnimationController} - Allows manual control of animation progress
@@ -169,14 +179,6 @@ Animation paths
\li \l {PathPercent} - Modifies the item distribution along a \l {Path}
\endlist
-Visual object transformations
-\list
-\li \l {Transform} - Allows specification of advanced transformations on Items
-\li \l {Scale} - Assigns item scaling behaviors
-\li \l {Rotation} - Assigns item rotation behaviors
-\li \l {Translate} - Assigns item translation behaviors
-\endlist
-
\section1 Model/View Types And Data Storage And Access
Models And Model Data
@@ -188,8 +190,6 @@ Models And Model Data
\li \l {VisualDataGroup} -Encapsulates a filtered set of visual data items
\li \l {XmlListModel} - Specifies a model using XPath expressions
\li \l {XmlRole} - Specifies a role for an \l {XmlListModel}
-\li \l {FolderListModel} - Provides a model of the contents of a file system folder
-\li \l {Repeater} - Provides a simple model to create multiple visual objects
\endlist
Views
@@ -205,19 +205,19 @@ Data Storage
\li \l {LocalStorage} - Module API providing simplified SQL access
\endlist
-\section1 Particles and Graphical Effects
+\section1 Graphical Effects
\list
+\li \l {Flipable} - Provides a surface that produces "flipping" effects
\li \l {ShaderEffect} - Allows GLSL shaders to be used as graphical effects
\li \l {ShaderEffectSource} - Usable as a texture in ShaderEffect
-\li \l {GridMesh} - Generates a gird mesh of vertices for use by ShaderEffect
+\li \l {GridMesh} - Generates a grid mesh of vertices for use by ShaderEffect
\li The \l{QtQuick.Particles 2} module provides a set of Particle System types for QtQuick 2
\endlist
\section1 Convenience Types
\list
-\li \l {Loader} - Eases on-demand loading of items or components
\li \l {Connections} - Explicitly connects signals and signal handlers
\li \l {Binding} - Binds any value to any property
\li \l {Timer} - Provides timed triggers