Fix linking of itemviews and graphicsview examples
authorChristian Stenger <christian.stenger@digia.com>
Fri, 30 Nov 2012 15:31:06 +0000 (16:31 +0100)
committerThe Qt Project <gerrit-noreply@qt-project.org>
Tue, 4 Dec 2012 07:14:33 +0000 (08:14 +0100)
Change-Id: I6905cc6945e2eb396108f9fb16da042e576e3afb
Reviewed-by: Gunnar Sletta <gunnar.sletta@digia.com>
31 files changed:
examples/widgets/doc/images/itemviews-editabletreemodel.png [new file with mode: 0644]
examples/widgets/doc/src/addressbook.qdoc
examples/widgets/doc/src/basicgraphicslayouts.qdoc
examples/widgets/doc/src/basicsortfiltermodel.qdoc
examples/widgets/doc/src/boxes.qdoc
examples/widgets/doc/src/chart.qdoc
examples/widgets/doc/src/chip.qdoc
examples/widgets/doc/src/coloreditorfactory.qdoc
examples/widgets/doc/src/combowidgetmapper.qdoc
examples/widgets/doc/src/customsortfiltermodel.qdoc
examples/widgets/doc/src/diagramscene.qdoc
examples/widgets/doc/src/dirview.qdoc
examples/widgets/doc/src/dragdroprobot.qdoc
examples/widgets/doc/src/editabletreemodel.qdoc
examples/widgets/doc/src/elasticnodes.qdoc
examples/widgets/doc/src/embeddeddialogs.qdoc
examples/widgets/doc/src/fetchmore.qdoc
examples/widgets/doc/src/frozencolumn.qdoc
examples/widgets/doc/src/interview.qdoc
examples/widgets/doc/src/itemviewspuzzle.qdoc
examples/widgets/doc/src/padnavigator.qdoc
examples/widgets/doc/src/pixelator.qdoc
examples/widgets/doc/src/simpledommodel.qdoc
examples/widgets/doc/src/simpletreemodel.qdoc
examples/widgets/doc/src/simplewidgetmapper.qdoc
examples/widgets/doc/src/spinboxdelegate.qdoc
examples/widgets/doc/src/spreadsheet.qdoc
examples/widgets/doc/src/stardelegate.qdoc
src/widgets/doc/images/graphicsview-examples.png [new file with mode: 0644]
src/widgets/doc/images/itemviews-examples.png [new file with mode: 0644]
src/widgets/doc/src/qtwidgets-examples.qdoc

diff --git a/examples/widgets/doc/images/itemviews-editabletreemodel.png b/examples/widgets/doc/images/itemviews-editabletreemodel.png
new file mode 100644 (file)
index 0000000..a151ea8
Binary files /dev/null and b/examples/widgets/doc/images/itemviews-editabletreemodel.png differ
index 65ed4b3..4712bf9 100644 (file)
@@ -28,7 +28,7 @@
 /*!
     \example itemviews/addressbook
     \title Address Book Example
-
+    \ingroup examples-itemviews
     \brief The address book example shows how to use proxy models to display
     different views onto data from a single model.
 
index 36ce914..8689433 100644 (file)
@@ -28,6 +28,8 @@
 /*!
     \example graphicsview/basicgraphicslayouts
     \title Basic Graphics Layouts Example
+    \ingroup examples-graphicsview
+    \brief This example shows how to use some basic layouts.
 
     \brief The Basic Graphics Layouts example shows how to use the layout classes
     in QGraphicsView: QGraphicsLinearLayout and QGraphicsGridLayout.
index f9a3b94..16f9fa6 100644 (file)
@@ -28,7 +28,7 @@
 /*!
     \example itemviews/basicsortfiltermodel
     \title Basic Sort/Filter Model Example
-
+    \ingroup examples-itemviews
     \brief The Basic Sort/Filter Model example illustrates how to use
     QSortFilterProxyModel to perform basic sorting and filtering.
 
index 96238f1..b3ed1f6 100644 (file)
@@ -28,7 +28,7 @@
 /*!
     \example graphicsview/boxes
     \title Boxes
-
+    \ingroup examples-graphicsview
     \brief This demo shows Qt's ability to combine advanced OpenGL rendering with the
     the \l{Graphics View Framework}.
 
index d12ee58..a3b54f5 100644 (file)
@@ -28,7 +28,7 @@
 /*!
     \example itemviews/chart
     \title Chart Example
-
+    \ingroup examples-itemviews
     \brief The Chart example shows how to create a custom view for the model/view framework.
 
     \image chart-example.png
index aa31227..e3adb26 100644 (file)
 /*!
     \example graphicsview/chip
     \title 40000 Chips
-
+    \ingroup examples-graphicsview
     \brief This demo shows how to visualize a huge scene with 40000 chip items
-    using Graphics View. It also shows Graphics View's powerful navigation
+    using Graphics View.
+
+    It also shows Graphics View's powerful navigation
     and interaction features, allowing you to zoom and rotate each of four
     views independently, and you can select and move items around the scene.
 
index 3774919..f34622f 100644 (file)
@@ -28,7 +28,7 @@
 /*!
     \example itemviews/coloreditorfactory
     \title Color Editor Factory Example
-
+    \ingroup examples-itemviews
     \brief This example shows how to create an editor that can be used by
     a QItemDelegate.
 
index df0d893..187934a 100644 (file)
@@ -28,7 +28,7 @@
 /*!
     \example itemviews/combowidgetmapper
     \title Combo Widget Mapper Example
-
+    \ingroup examples-itemviews
     \brief The Combo Widget Mapper example shows how to use a custom delegate to
     map information from a model to specific widgets on a form.
 
index 2003dc7..82f1246 100644 (file)
@@ -28,7 +28,7 @@
 /*!
     \example itemviews/customsortfiltermodel
     \title Custom Sort/Filter Model Example
-
+    \ingroup examples-itemviews
     \brief The Custom Sort/Filter Model example illustrates how to subclass
     QSortFilterProxyModel to perform advanced sorting and filtering.
 
index 9b94ca2..55043df 100644 (file)
@@ -28,7 +28,7 @@
 /*!
     \example graphicsview/diagramscene
     \title Diagram Scene Example
-
+    \ingroup examples-graphicsview
     \brief This example shows use of Qt's graphics framework.
 
     \image diagramscene.png
index 8f860fd..5deabcb 100644 (file)
@@ -28,6 +28,8 @@
 /*!
     \example itemviews/dirview
     \title Dir View Example
+    \ingroup examples-itemviews
+    \brief This example demonstrates the usage of a tree view.
 
     \brief The Dir View example shows a tree view onto the local filing system. It uses the
     QDirModel class to provide file and directory information.
index cc5e6bd..8187cbf 100644 (file)
@@ -28,7 +28,7 @@
 /*!
     \example graphicsview/dragdroprobot
     \title Drag and Drop Robot Example
-
+    \ingroup examples-graphicsview
     \brief The Drag and Drop Robot example shows how to implement Drag and Drop in a
     QGraphicsItem subclass, as well as how to animate items using Qt's
     \l{Animation Framework}.
index fa72b77..8c4c7cb 100644 (file)
@@ -28,7 +28,7 @@
 /*!
     \example itemviews/editabletreemodel
     \title Editable Tree Model Example
-
+    \ingroup examples-itemviews
     \brief This example shows how to implement a simple item-based tree model that can
     be used with other classes the model/view framework.
 
index 2c08161..75ad496 100644 (file)
 /*!
     \example graphicsview/elasticnodes
     \title Elastic Nodes Example
-
+    \ingroup examples-graphicsview
     \brief The Elastic Nodes example shows how to implement edges between nodes in a
-    graph, with basic interaction. You can click to drag a node around, and
+    graph, with basic interaction.
+
+    You can click to drag a node around, and
     zoom in and out using the mouse wheel or the keyboard. Hitting the space
     bar will randomize the nodes. The example is also resolution independent;
     as you zoom in, the graphics remain crisp.
index 878bb9f..964150f 100644 (file)
 /*!
     \example graphicsview/embeddeddialogs
     \title Embedded Dialogs
-
+    \ingroup examples-graphicsview
     \brief This example shows how to embed standard dialogs into
-    Graphics View. It also shows how you can customize the
+    Graphics View.
+
+    It also shows how you can customize the
     proxy class and add window shadows.
 
     \image embeddeddialogs-demo.png
index 8e3ec97..2c9c5d5 100644 (file)
@@ -28,7 +28,7 @@
 /*!
     \example itemviews/fetchmore
     \title Fetch More Example
-
+    \ingroup examples-itemviews
     \brief The Fetch More example shows how two add items to an item view
     model on demand.
 
index 69e45de..39fe04c 100644 (file)
@@ -28,7 +28,7 @@
 /*!
     \example itemviews/frozencolumn
     \title Frozen Column Example
-
+    \ingroup examples-itemviews
     \brief This example demonstrates how to freeze a column within a QTableView.
 
     \image frozencolumn-example.png "Screenshot of the example"
index 788af64..6528bef 100644 (file)
@@ -28,6 +28,8 @@
 /*!
     \example itemviews/interview
     \title Interview
+    \ingroup examples-itemviews
+    \brief This example demonstrates the usage of the model/view framework.
 
     \brief The Interview example explores the flexibility and scalability of the
     model/view framework by presenting an infinitely deep data structure using a model
index 68cbdc9..2e37cd3 100644 (file)
@@ -28,7 +28,7 @@
 /*!
     \example itemviews/puzzle
     \title Item Views Puzzle Example
-
+    \ingroup examples-itemviews
     \brief The Puzzle example shows how to enable drag and drop with a custom model
     to allow items to be transferred between a view and another widget.
 
index b063d6d..90c7c00 100644 (file)
@@ -28,7 +28,7 @@
 /*!
     \example graphicsview/padnavigator
     \title Pad Navigator Example
-
+    \ingroup examples-graphicsview
     \brief The Pad Navigator Example shows how you can use Graphics View together with
     embedded widgets and Qt's \l{State Machine Framework} to create a simple
     but useful, dynamic, animated user interface.
index 9eddcd9..ebcee4e 100644 (file)
@@ -28,7 +28,7 @@
 /*!
     \example itemviews/pixelator
     \title Pixelator Example
-
+    \ingroup examples-itemviews
     \brief The Pixelator example shows how delegates can be used to customize the way that
     items are rendered in standard item views.
 
index 99df1e4..c48563f 100644 (file)
@@ -28,7 +28,7 @@
 /*!
     \example itemviews/simpledommodel
     \title Simple DOM Model Example
-
+    \ingroup examples-itemviews
     \brief The Simple DOM Model example shows how an existing class can be adapted for use with
     the model/view framework.
 
index 2b8884d..df23617 100644 (file)
@@ -28,6 +28,9 @@
 /*!
     \example itemviews/simpletreemodel
     \title Simple Tree Model Example
+    \ingroup examples-itemviews
+    \brief The Simple Tree Model example shows how to use a hierarchical model
+    with Qt's standard view classes.
 
     \brief The Simple Tree Model example shows how to create a basic, read-only
     hierarchical model to use with Qt's standard view classes. For a
index ca5e47e..3e827a4 100644 (file)
@@ -28,7 +28,7 @@
 /*!
     \example itemviews/simplewidgetmapper
     \title Simple Widget Mapper Example
-
+    \ingroup examples-itemviews
     \brief The Simple Widget Mapper example shows how to use a widget mapper to display
     data from a model in a collection of widgets.
 
index f2add32..3941afa 100644 (file)
@@ -28,7 +28,7 @@
 /*!
     \example itemviews/spinboxdelegate
     \title Spin Box Delegate Example
-
+    \ingroup examples-itemviews
     \brief The Spin Box Delegate example shows how to create an editor for a custom delegate in
     the model/view framework by reusing a standard Qt editor widget.
 
index cd94e08..a869c7d 100644 (file)
@@ -28,6 +28,8 @@
 /*!
     \example itemviews/spreadsheet
     \title Spreadsheet
+    \ingroup examples-itemviews
+    \brief The Spreadsheet example shows how to create a simple spreadsheet application.
 
     \brief The Spreadsheet example shows how a table view can be used to create a
     simple spreadsheet application. Custom delegates are used to render different
index 38e4cdf..f3da875 100644 (file)
@@ -28,7 +28,7 @@
 /*!
     \example itemviews/stardelegate
     \title Star Delegate Example
-
+    \ingroup examples-itemviews
     \brief The Star Delegate example shows how to create a delegate that
     can paint itself and that supports editing.
 
diff --git a/src/widgets/doc/images/graphicsview-examples.png b/src/widgets/doc/images/graphicsview-examples.png
new file mode 100644 (file)
index 0000000..8889424
Binary files /dev/null and b/src/widgets/doc/images/graphicsview-examples.png differ
diff --git a/src/widgets/doc/images/itemviews-examples.png b/src/widgets/doc/images/itemviews-examples.png
new file mode 100644 (file)
index 0000000..a151ea8
Binary files /dev/null and b/src/widgets/doc/images/itemviews-examples.png differ
index 07e1eb1..d0b04b0 100644 (file)
@@ -95,7 +95,6 @@
 
 */
 
-
 /*!
     \group examples-dialogs
     \ingroup all-examples
     interactions with users.
 */
 
+/*!
+    \ingroup all-examples
+    \title Itemview Examples
+    \brief Using the model/view framework.
+    \group examples-itemviews
+
+    \image itemviews-examples.png
+
+    Qt provides a lot of capabalities to display pre- and user-defined item models
+    in different ways.
+    The separation of functionality introduced by the model/view architecture gives
+    developers greater flexibility to customize the presentation of items.
+
+*/
+
+/*!
+    \ingroup all-examples
+    \title Graphicsview Examples
+    \brief Using the Graphics View framework.
+    \group examples-graphicsview
+
+    \image graphicsview-examples.png
+
+    Qt provides powerful graphics engine that supports easy visualization of items, with
+    support for rotation and zooming.
+    Additionally it provides an event propagation architecture for interaction.
+
+*/