Add documentation/links for incubateObject
authorMartin Jones <martin.jones@nokia.com>
Tue, 8 May 2012 01:41:28 +0000 (11:41 +1000)
committerQt by Nokia <qt-info@nokia.com>
Tue, 8 May 2012 22:56:16 +0000 (00:56 +0200)
Change-Id: I0ba05f513c6e11451b49848eb69e4b579e75f9a4
Reviewed-by: Alan Alpert <alan.alpert@nokia.com>
doc/src/qml/dynamicobjects.qdoc
src/qml/qml/qqmlcomponent.cpp
src/quick/items/qquickloader.cpp

index 2886d5b..55f131e 100644 (file)
@@ -118,6 +118,9 @@ use the signal \c connect() method. See
 \l{QML Signal and Handler Event System#Connecting Signals to Methods and Signals}
 {Connecting Signals to Methods and Signals} for more information.
 
+It is also possible to instantiate components without blocking via the
+\l {Component::incubateObject()}{incubateObject()} function.
+
 
 \section2 Creating an Object from a String of QML
 
@@ -149,7 +152,8 @@ The actual creation context depends on how an item is created:
 \li If \l{QML:Qt::createQmlObject()}{Qt.createQmlObject()}
    if called, the creation context is the context of the parent item passed to this method
 \li If a \c {Component{}} item is defined and \l {Component::createObject()}{createObject()}
-   is called on that item, the creation context is the context in which the \c Component is defined
+    or \l {Component::incubateObject()}{incubateObject()} is called on that item,
+    the creation context is the context in which the \c Component is defined
 \endlist
 
 Also, note that while dynamically created objects may be used the same as other objects, they
index e5c498a..e904188 100644 (file)
@@ -1075,6 +1075,8 @@ static void QQmlComponent_setQmlParent(QObject *me, QObject *parent)
 
     Dynamically created instances can be deleted with the \c destroy() method.
     See \l {Dynamic Object Management in QML} for more information.
+
+    \sa incubateObject()
 */
 void QQmlComponent::createObject(QQmlV8Function *args)
 {
@@ -1137,7 +1139,7 @@ void QQmlComponent::createObject(QQmlV8Function *args)
 }
 
 /*!
-    \qmlmethod object Component::incubateObject(Item parent, object properties, enum mode)
+    \qmlmethod object Component::incubateObject(Item parent, object properties, enumeration mode)
 
     Creates an incubator for instance of this component.  Incubators allow new component 
     instances to be instantiated asynchronously and not cause freezes in the UI.
@@ -1185,6 +1187,11 @@ void QQmlComponent::createObject(QQmlV8Function *args)
             print ("Object", incubator.object, "is ready immediately!");
         }
     \endjs
+
+    Dynamically created instances can be deleted with the \c destroy() method.
+    See \l {Dynamic Object Management in QML} for more information.
+
+    \sa createObject()
 */
 
 void QQmlComponent::incubateObject(QQmlV8Function *args)
index 864e03b..54e4260 100644 (file)
@@ -161,7 +161,10 @@ qreal QQuickLoaderPrivate::getImplicitHeight() const
     \brief The Loader item allows dynamically loading an Item-based
     subtree from a URL or Component.
 
-    Loader is used to dynamically load visual QML components. It can load a
+    Loader is used to dynamically load visual QML components.  For loading non-visual
+    components, see \l {Dynamic Object Management in QML}.
+
+    Loader can load a
     QML file (using the \l source property) or a \l Component object (using
     the \l sourceComponent property). It is useful for delaying the creation
     of a component until it is required: for example, when a component should