Doc.

15 files changed, 105 insertions, 20 deletions

diff --git a/src/declarative/graphicsitems/qmlgraphicsflickable.cpp b/src/declarative/graphicsitems/qmlgraphicsflickable.cpp
index 8895977..19c5abc 100644
--- a/src/declarative/graphicsitems/qmlgraphicsflickable.cpp
+++ b/src/declarative/graphicsitems/qmlgraphicsflickable.cpp
@@ -344,7 +344,7 @@ void QmlGraphicsFlickablePrivate::updateBeginningEnd()
 QML_DEFINE_TYPE(Qt,4,6,(QT_VERSION&0x00ff00)>>8,Flickable,QmlGraphicsFlickable)
 
 /*!
-    \qmlclass Flickable QFxFlickable
+    \qmlclass Flickable QmlGraphicsFlickable
     \brief The Flickable item provides a surface that can be "flicked".
     \inherits Item
 
diff --git a/src/declarative/graphicsitems/qmlgraphicsfocuspanel.cpp b/src/declarative/graphicsitems/qmlgraphicsfocuspanel.cpp
index d3ee184..a19e355 100644
--- a/src/declarative/graphicsitems/qmlgraphicsfocuspanel.cpp
+++ b/src/declarative/graphicsitems/qmlgraphicsfocuspanel.cpp
@@ -48,7 +48,7 @@ QT_BEGIN_NAMESPACE
 QML_DEFINE_TYPE(Qt,4,6,(QT_VERSION&0x00ff00)>>8,FocusPanel,QmlGraphicsFocusPanel)
 
 /*!
-   \qmlclass FocusPanel QFxFocusPanel
+   \qmlclass FocusPanel QmlGraphicsFocusPanel
    \brief The FocusPanel item explicitly creates a focus panel.
    \inherits Item
 
diff --git a/src/declarative/graphicsitems/qmlgraphicsfocusscope.cpp b/src/declarative/graphicsitems/qmlgraphicsfocusscope.cpp
index cd30b2b..f03e3f1 100644
--- a/src/declarative/graphicsitems/qmlgraphicsfocusscope.cpp
+++ b/src/declarative/graphicsitems/qmlgraphicsfocusscope.cpp
@@ -46,7 +46,7 @@ QT_BEGIN_NAMESPACE
 QML_DEFINE_TYPE(Qt,4,6,(QT_VERSION&0x00ff00)>>8,FocusScope,QmlGraphicsFocusScope)
 
 /*!
-    \qmlclass FocusScope QFxFocusScope
+    \qmlclass FocusScope QmlGraphicsFocusScope
     \brief The FocusScope object explicitly creates a focus scope.
     \inherits Item
 
diff --git a/src/declarative/graphicsitems/qmlgraphicsgridview.cpp b/src/declarative/graphicsitems/qmlgraphicsgridview.cpp
index cadd650..1ee4511 100644
--- a/src/declarative/graphicsitems/qmlgraphicsgridview.cpp
+++ b/src/declarative/graphicsitems/qmlgraphicsgridview.cpp
@@ -658,7 +658,7 @@ void QmlGraphicsGridViewPrivate::updateCurrent(int modelIndex)
 //----------------------------------------------------------------------------
 
 /*!
-    \qmlclass GridView QFxGridView
+    \qmlclass GridView QmlGraphicsGridView
     \inherits Flickable
     \brief The GridView item provides a grid view of items provided by a model.
 
diff --git a/src/declarative/graphicsitems/qmlgraphicslistview.cpp b/src/declarative/graphicsitems/qmlgraphicslistview.cpp
index cf399f9..a393cb1 100644
--- a/src/declarative/graphicsitems/qmlgraphicslistview.cpp
+++ b/src/declarative/graphicsitems/qmlgraphicslistview.cpp
@@ -954,7 +954,7 @@ void QmlGraphicsListViewPrivate::flickY(qreal velocity)
 //----------------------------------------------------------------------------
 
 /*!
-    \qmlclass ListView QFxListView
+    \qmlclass ListView QmlGraphicsListView
     \inherits Flickable
     \brief The ListView item provides a list view of items provided by a model.
 
diff --git a/src/declarative/graphicsitems/qmlgraphicsloader.cpp b/src/declarative/graphicsitems/qmlgraphicsloader.cpp
index 65753d8..4d463ab 100644
--- a/src/declarative/graphicsitems/qmlgraphicsloader.cpp
+++ b/src/declarative/graphicsitems/qmlgraphicsloader.cpp
@@ -56,7 +56,7 @@ QmlGraphicsLoaderPrivate::~QmlGraphicsLoaderPrivate()
 QML_DEFINE_TYPE(Qt,4,6,(QT_VERSION&0x00ff00)>>8,Loader,QmlGraphicsLoader)
 
 /*!
-    \qmlclass Loader QFxLoader
+    \qmlclass Loader QmlGraphicsLoader
     \inherits Item
 
     \brief The Loader item allows dynamically loading an Item-based
diff --git a/src/declarative/graphicsitems/qmlgraphicsmouseregion.cpp b/src/declarative/graphicsitems/qmlgraphicsmouseregion.cpp
index 75e31b8..1a57062 100644
--- a/src/declarative/graphicsitems/qmlgraphicsmouseregion.cpp
+++ b/src/declarative/graphicsitems/qmlgraphicsmouseregion.cpp
@@ -120,7 +120,7 @@ void QmlGraphicsDrag::setYmax(qreal m)
 }
 
 /*!
-    \qmlclass MouseRegion QFxMouseRegion
+    \qmlclass MouseRegion QmlGraphicsMouseRegion
     \brief The MouseRegion item enables simple mouse handling.
     \inherits Item
 
diff --git a/src/declarative/graphicsitems/qmlgraphicspath.cpp b/src/declarative/graphicsitems/qmlgraphicspath.cpp
index c0e6caf..ed0dfaa 100644
--- a/src/declarative/graphicsitems/qmlgraphicspath.cpp
+++ b/src/declarative/graphicsitems/qmlgraphicspath.cpp
@@ -57,7 +57,7 @@ QML_DEFINE_TYPE(Qt,4,6,(QT_VERSION&0x00ff00)>>8,PathQuad,QmlGraphicsPathQuad)
 QML_DEFINE_TYPE(Qt,4,6,(QT_VERSION&0x00ff00)>>8,PathCubic,QmlGraphicsPathCubic)
 
 /*!
-    \qmlclass PathElement QFxPathElement
+    \qmlclass PathElement QmlGraphicsPathElement
     \brief PathElement is the base path type.
 
     This type is the base for all path types.  It cannot
@@ -464,7 +464,7 @@ void QmlGraphicsCurve::setY(qreal y)
 /****************************************************************************/
 
 /*!
-    \qmlclass PathAttribute QFxPathAttribute
+    \qmlclass PathAttribute QmlGraphicsPathAttribute
     \brief The PathAttribute allows setting an attribute at a given position in a Path.
 
     The PathAttribute object allows attibutes consisting of a name and
@@ -543,7 +543,7 @@ void QmlGraphicsPathAttribute::setValue(qreal value)
 /****************************************************************************/
 
 /*!
-    \qmlclass PathLine QFxPathLine
+    \qmlclass PathLine QmlGraphicsPathLine
     \brief The PathLine defines a straight line.
 
     The example below creates a path consisting of a straight line from
@@ -583,7 +583,7 @@ void QmlGraphicsPathLine::addToPath(QPainterPath &path)
 /****************************************************************************/
 
 /*!
-    \qmlclass PathQuad QFxPathQuad
+    \qmlclass PathQuad QmlGraphicsPathQuad
     \brief The PathQuad defines a quadratic Bezier curve with a control point.
 
     The following QML produces the path shown below:
@@ -667,7 +667,7 @@ void QmlGraphicsPathQuad::addToPath(QPainterPath &path)
 /****************************************************************************/
 
 /*!
-   \qmlclass PathCubic QFxPathCubic
+   \qmlclass PathCubic QmlGraphicsPathCubic
    \brief The PathCubic defines a cubic Bezier curve with two control points.
 
     The following QML produces the path shown below:
@@ -777,7 +777,7 @@ void QmlGraphicsPathCubic::addToPath(QPainterPath &path)
 /****************************************************************************/
 
 /*!
-    \qmlclass PathPercent QFxPathPercent
+    \qmlclass PathPercent QmlGraphicsPathPercent
     \brief The PathPercent manipulates the way a path is interpreted.
 
     The examples below show the normal distrubution of items along a path
diff --git a/src/declarative/graphicsitems/qmlgraphicspathview.cpp b/src/declarative/graphicsitems/qmlgraphicspathview.cpp
index 52d2fa9..d2a9be1 100644
--- a/src/declarative/graphicsitems/qmlgraphicspathview.cpp
+++ b/src/declarative/graphicsitems/qmlgraphicspathview.cpp
@@ -97,7 +97,7 @@ private:
 */
 
 /*!
-    \qmlclass PathView QFxPathView
+    \qmlclass PathView QmlGraphicsPathView
     \brief The PathView element lays out model-provided items on a path.
     \inherits Item
 
diff --git a/src/declarative/graphicsitems/qmlgraphicspositioners.cpp b/src/declarative/graphicsitems/qmlgraphicspositioners.cpp
index 35b0833..f599025 100644
--- a/src/declarative/graphicsitems/qmlgraphicspositioners.cpp
+++ b/src/declarative/graphicsitems/qmlgraphicspositioners.cpp
@@ -333,7 +333,7 @@ void QmlGraphicsBasePositioner::applyRemove(const QList<QPair<QString, QVariant>
 
 QML_DEFINE_TYPE(Qt,4,6,(QT_VERSION&0x00ff00)>>8,Column,QmlGraphicsColumn)
 /*!
-  \qmlclass Column QFxColumn
+  \qmlclass Column QmlGraphicsColumn
   \brief The Column item lines up its children vertically.
   \inherits Item
 
@@ -524,7 +524,7 @@ void QmlGraphicsColumn::doPositioning()
 
 QML_DEFINE_TYPE(Qt,4,6,(QT_VERSION&0x00ff00)>>8,Row,QmlGraphicsRow)
 /*!
-  \qmlclass Row QFxRow
+  \qmlclass Row QmlGraphicsRow
   \brief The Row item lines up its children horizontally.
   \inherits Item
 
diff --git a/src/declarative/graphicsitems/qmlgraphicsrepeater.cpp b/src/declarative/graphicsitems/qmlgraphicsrepeater.cpp
index ba860e9..646374f 100644
--- a/src/declarative/graphicsitems/qmlgraphicsrepeater.cpp
+++ b/src/declarative/graphicsitems/qmlgraphicsrepeater.cpp
@@ -59,7 +59,7 @@ QmlGraphicsRepeaterPrivate::~QmlGraphicsRepeaterPrivate()
 QML_DEFINE_TYPE(Qt,4,6,(QT_VERSION&0x00ff00)>>8,Repeater,QmlGraphicsRepeater)
 
 /*!
-    \qmlclass Repeater QFxRepeater
+    \qmlclass Repeater QmlGraphicsRepeater
     \inherits Item
 
     \brief The Repeater item allows you to repeat a component based on a model.
diff --git a/src/declarative/graphicsitems/qmlgraphicstextedit.cpp b/src/declarative/graphicsitems/qmlgraphicstextedit.cpp
index 0c81dca..13df329 100644
--- a/src/declarative/graphicsitems/qmlgraphicstextedit.cpp
+++ b/src/declarative/graphicsitems/qmlgraphicstextedit.cpp
@@ -56,7 +56,7 @@ QT_BEGIN_NAMESPACE
 QML_DEFINE_TYPE(Qt,4,6,(QT_VERSION&0x00ff00)>>8,TextEdit,QmlGraphicsTextEdit)
 
 /*!
-    \qmlclass TextEdit QFxTextEdit
+    \qmlclass TextEdit QmlGraphicsTextEdit
     \brief The TextEdit item allows you to add editable formatted text to a scene.
 
     It can display both plain and rich text. For example:
diff --git a/src/declarative/graphicsitems/qmlgraphicstextinput.cpp b/src/declarative/graphicsitems/qmlgraphicstextinput.cpp
index 44ccda1..9a4f627 100644
--- a/src/declarative/graphicsitems/qmlgraphicstextinput.cpp
+++ b/src/declarative/graphicsitems/qmlgraphicstextinput.cpp
@@ -54,7 +54,7 @@ QML_DEFINE_NOCREATE_TYPE(QValidator);
 QML_DEFINE_TYPE(Qt,4,6,(QT_VERSION&0x00ff00)>>8,QIntValidator,QIntValidator);
 
 /*!
-    \qmlclass TextInput QFxTextInput
+    \qmlclass TextInput QmlGraphicsTextInput
     The TextInput item allows you to add an editable line of text to a scene.
 
     TextInput can only display a single line of text, and can only display
diff --git a/src/declarative/graphicsitems/qmlgraphicswebview.cpp b/src/declarative/graphicsitems/qmlgraphicswebview.cpp
index c6ab4c7..d1da0f2 100644
--- a/src/declarative/graphicsitems/qmlgraphicswebview.cpp
+++ b/src/declarative/graphicsitems/qmlgraphicswebview.cpp
@@ -208,7 +208,7 @@ public:
 };
 
 /*!
-    \qmlclass WebView QFxWebView
+    \qmlclass WebView QmlGraphicsWebView
     \brief The WebView item allows you to add web content to a canvas.
     \inherits Item
 
diff --git a/src/declarative/util/qmlstategroup.cpp b/src/declarative/util/qmlstategroup.cpp
index f518ea5..2eb9dca 100644
--- a/src/declarative/util/qmlstategroup.cpp
+++ b/src/declarative/util/qmlstategroup.cpp
@@ -84,6 +84,34 @@ public:
     void updateAutoState();
 };
 
+/*!
+   \qmlclass StateGroup QmlStateGroup
+   \brief The StateGroup element provides state support for non-Item elements.
+
+   Item (and all dervied elements) provides built in support for states and transitions
+   via its state, states and transitions properties. StateGroup provides an easy way to
+   use this support in other (non-Item-derived) elements.
+
+   \qml
+   MyCustomObject {
+       StateGroup {
+           id: myStateGroup
+           states: State {
+               name: "state1"
+               ...
+           }
+           transitions: Transition {
+               ...
+           }
+       }
+
+       onSomethingHappened: myStateGroup.state = "state1";
+   }
+   \endqml
+
+   \sa {qmlstate}{States} and {state-transitions}{Transitions}
+*/
+
 QmlStateGroup::QmlStateGroup(QObject *parent)
     : QObject(*(new QmlStateGroupPrivate(this)), parent)
 {
@@ -99,18 +127,75 @@ QList<QmlState *> QmlStateGroup::states() const
     return d->states;
 }
 
+/*!
+  \qmlproperty list<State> StateGroup::states
+  This property holds a list of states defined by the state group.
+
+  \qml
+  StateGroup {
+    states: [
+      State { ... },
+      State { ... }
+      ...
+    ]
+  }
+  \endqml
+
+  \sa {qmlstate}{States}
+*/
 QmlList<QmlState *>* QmlStateGroup::statesProperty()
 {
     Q_D(QmlStateGroup);
     return &(d->states);
 }
 
+/*!
+  \qmlproperty list<Transition> StateGroup::transitions
+  This property holds a list of transitions defined by the state group.
+
+  \qml
+  StateGroup {
+    transitions: [
+      Transition { ... },
+      Transition { ... }
+      ...
+    ]
+  }
+  \endqml
+
+  \sa {state-transitions}{Transitions}
+*/
 QmlList<QmlTransition *>* QmlStateGroup::transitionsProperty()
 {
     Q_D(QmlStateGroup);
     return &(d->transitions);
 }
 
+/*!
+  \qmlproperty string StateGroup::state
+
+  This property holds the name of the current state of the state group.
+
+  This property is often used in scripts to change between states. For
+  example:
+
+  \qml
+    Script {
+        function toggle() {
+            if (button.state == 'On')
+                button.state = 'Off';
+            else
+                button.state = 'On';
+        }
+    }
+  \endqml
+
+  If the state group is in its base state (i.e. no explicit state has been
+  set), \c state will be a blank string. Likewise, you can return a
+  state group to its base state by setting its current state to \c ''.
+
+  \sa {qmlstates}{States}
+*/
 QString QmlStateGroup::state() const
 {
     Q_D(const QmlStateGroup);