From 066f18d1830c5820041c3b267db404be8bc68a32 Mon Sep 17 00:00:00 2001
From: Martin Jones <martin.jones@nokia.com>
Date: Tue, 5 May 2009 15:27:57 +1000
Subject: Content/ContentWrapper documentation.

---
 doc/src/declarative/pics/content.png      | Bin 0 -> 1978 bytes
 doc/src/snippets/declarative/GroupBox.qml |  18 ++++----
 doc/src/snippets/declarative/content.qml  |   7 ++--
 src/declarative/fx/qfxcontentwrapper.cpp  |  66 ++++++++++++++++--------------
 4 files changed, 49 insertions(+), 42 deletions(-)
 create mode 100644 doc/src/declarative/pics/content.png

diff --git a/doc/src/declarative/pics/content.png b/doc/src/declarative/pics/content.png
new file mode 100644
index 0000000..47a98ac
Binary files /dev/null and b/doc/src/declarative/pics/content.png differ
diff --git a/doc/src/snippets/declarative/GroupBox.qml b/doc/src/snippets/declarative/GroupBox.qml
index a8ff5be..fd8d60b 100644
--- a/doc/src/snippets/declarative/GroupBox.qml
+++ b/doc/src/snippets/declarative/GroupBox.qml
@@ -1,11 +1,13 @@
 ContentWrapper {
-    id: Container; width: parent.width
-    Rect {
-        width: parent.width; color: "white"; pen.width: 2; pen.color: "#adaeb0"; radius: 10
-        clip: false; height: contents.height
-        VerticalLayout {
-            id: layout; width: parent.width
-            Content {}
+    id: Container; width: parent.width; height: contents.height
+    children: [
+        Rect {
+            width: parent.width; height: contents.height
+            color: "white"; pen.width: 2; pen.color: "#adaeb0"; radius: 10
+            VerticalLayout {
+                id: layout; width: parent.width; margin: 5; spacing: 2
+                Content { }
+            }
         }
-    }
+    ]
 }
diff --git a/doc/src/snippets/declarative/content.qml b/doc/src/snippets/declarative/content.qml
index be04c6e..6f9e0d8 100644
--- a/doc/src/snippets/declarative/content.qml
+++ b/doc/src/snippets/declarative/content.qml
@@ -1,6 +1,7 @@
-GroupBox {
-    content: [
+Rect {
+    width: 200; height: 100; color: "lightgray"
+    GroupBox {
         Text { text: "First Item" }
         Text { text: "Second Item" }
-    ]
+    }
 }
diff --git a/src/declarative/fx/qfxcontentwrapper.cpp b/src/declarative/fx/qfxcontentwrapper.cpp
index 2b95ff6..c118569 100644
--- a/src/declarative/fx/qfxcontentwrapper.cpp
+++ b/src/declarative/fx/qfxcontentwrapper.cpp
@@ -46,6 +46,16 @@
 QT_BEGIN_NAMESPACE
 QML_DEFINE_TYPE(QFxContentWrapper,ContentWrapper);
 
+/*!
+    \qmlclass ContentWrapper QFxContentWrapper
+    \ingroup group_utility
+    \brief ContentWrapper provides a component which contains content.
+    \inherits Item
+
+    The ContentWrapper element is used to place content within a component.
+    See \l Content for usage.
+*/
+
 QFxContentWrapper::QFxContentWrapper(QFxItem *parent)
 : QFxItem(*(new QFxContentWrapperPrivate), parent)
 {
@@ -56,6 +66,14 @@ QFxContentWrapper::QFxContentWrapper(QFxContentWrapperPrivate &dd, QFxItem *pare
 {
 }
 
+/*!
+    \qmlproperty list<Item> QFxContentWrapper::content
+
+    Contains the list of elements to replace the \l Content
+    placeholder.
+
+    \sa Content
+*/
 QList<QFxItem *> *QFxContentWrapper::content()
 {
     Q_D(QFxContentWrapper);
@@ -101,38 +119,24 @@ QML_DEFINE_TYPE(QFxContent,Content);
 
     In some cases the content of a component is not defined by the component itself.
     For example, the items placed in a group box need to be specified external to
-    the where the group box component itself is defined.
+    group box component definition itself.
     In cases like these Content can be used to specify at what location in the component
-    the content should be placed. It is used in conjuntion with the content property of 
-    the component instance: any items listed as content will be placed in the location 
-    specified by Content.
-
-    Example:
-    \qml
-// GroupBox component definition
-Rect {
-    width: parent.width
-    color: "white"
-    pen.width: 2
-    pen.color: "#adaeb0"
-    radius: 10
-    clip: false
-    height: contents.height
-    VerticalLayout {
-        id: layout
-        width: parent.width
-        Content { } // content property will go here
-    }
-}
-
-// component use
-GroupBox {
-    content: Text {
-        text: "First Item"
-        ...
-    }
-}
-    \endqml
+    the content should be placed. It is used in conjuntion with the \e content property of
+    the ContentWrapper element: any items listed as content will be placed in the location
+    specified by Content.  The component containing the Content must be of type
+    ContentWrapper.
+
+    GroupBox component definition:
+    \quotefile doc/src/snippets/declarative/GroupBox.qml
+
+    \bold Note that in the above component definition ContentWrapper's \e children
+    property is specified explicitly since \e content is the default property.
+
+    Component use:
+    \table
+    \row \o \image content.png
+    \o \quotefile doc/src/snippets/declarative/content.qml
+    \endtable
 */
 
 QT_END_NAMESPACE
-- 
cgit v0.12