diff options
Diffstat (limited to 'examples/widgets/doc/src')
52 files changed, 513 insertions, 39 deletions
diff --git a/examples/widgets/doc/src/addressbook.qdoc b/examples/widgets/doc/src/addressbook.qdoc index 65ed4b33bd..4712bf94ad 100644 --- a/examples/widgets/doc/src/addressbook.qdoc +++ b/examples/widgets/doc/src/addressbook.qdoc @@ -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. diff --git a/examples/widgets/doc/src/application.qdoc b/examples/widgets/doc/src/application.qdoc index bd0f8fd09f..e6c135e138 100644 --- a/examples/widgets/doc/src/application.qdoc +++ b/examples/widgets/doc/src/application.qdoc @@ -28,6 +28,7 @@ /*! \example mainwindows/application \title Application Example + \ingroup examples-mainwindow \brief The Application example shows how to implement a standard GUI application with menus, toolbars, and a status bar. The example diff --git a/examples/widgets/doc/src/basicgraphicslayouts.qdoc b/examples/widgets/doc/src/basicgraphicslayouts.qdoc index 36ce914018..70f92a838a 100644 --- a/examples/widgets/doc/src/basicgraphicslayouts.qdoc +++ b/examples/widgets/doc/src/basicgraphicslayouts.qdoc @@ -28,8 +28,10 @@ /*! \example graphicsview/basicgraphicslayouts \title Basic Graphics Layouts Example + \ingroup examples-graphicsview-layout + \brief Demonstrates how to create basic graphics layout - \brief The Basic Graphics Layouts example shows how to use the layout classes + The Basic Graphics Layouts example shows how to use the layout classes in QGraphicsView: QGraphicsLinearLayout and QGraphicsGridLayout. In addition to that it shows how to write your own custom layout item. diff --git a/examples/widgets/doc/src/basicsortfiltermodel.qdoc b/examples/widgets/doc/src/basicsortfiltermodel.qdoc index f9a3b94ba6..16f9fa61a2 100644 --- a/examples/widgets/doc/src/basicsortfiltermodel.qdoc +++ b/examples/widgets/doc/src/basicsortfiltermodel.qdoc @@ -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. diff --git a/examples/widgets/doc/src/blurpicker.qdoc b/examples/widgets/doc/src/blurpicker.qdoc index aa89ba3cd8..06426c2ab3 100644 --- a/examples/widgets/doc/src/blurpicker.qdoc +++ b/examples/widgets/doc/src/blurpicker.qdoc @@ -28,6 +28,8 @@ /*! \example effects/blurpicker \title Blur Picker Effect Example + \ingroup examples-graphicsview-graphicseffects + \brief Demonstrates how to apply graphical effects on items in the view \image blurpickereffect-example.png */ diff --git a/examples/widgets/doc/src/boxes.qdoc b/examples/widgets/doc/src/boxes.qdoc index 96238f1efd..6ad50fff9f 100644 --- a/examples/widgets/doc/src/boxes.qdoc +++ b/examples/widgets/doc/src/boxes.qdoc @@ -28,9 +28,8 @@ /*! \example graphicsview/boxes \title Boxes - - \brief This demo shows Qt's ability to combine advanced OpenGL rendering with the - the \l{Graphics View Framework}. + \ingroup examples-graphicsview + \brief Combines advanced OpenGL rendering with the Graphics View framework \image boxes-demo.png diff --git a/examples/widgets/doc/src/chart.qdoc b/examples/widgets/doc/src/chart.qdoc index d12ee58422..a3b54f5328 100644 --- a/examples/widgets/doc/src/chart.qdoc +++ b/examples/widgets/doc/src/chart.qdoc @@ -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 diff --git a/examples/widgets/doc/src/chip.qdoc b/examples/widgets/doc/src/chip.qdoc index aa31227e43..6fd15ac09c 100644 --- a/examples/widgets/doc/src/chip.qdoc +++ b/examples/widgets/doc/src/chip.qdoc @@ -28,9 +28,10 @@ /*! \example graphicsview/chip \title 40000 Chips + \ingroup examples-graphicsview + \brief Visualizes a huge graphic view scene with 40000 chip items - \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 + This examples demonstrates 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. diff --git a/examples/widgets/doc/src/classwizard.qdoc b/examples/widgets/doc/src/classwizard.qdoc index 038f9e19b2..b4224a182f 100644 --- a/examples/widgets/doc/src/classwizard.qdoc +++ b/examples/widgets/doc/src/classwizard.qdoc @@ -28,6 +28,7 @@ /*! \example dialogs/classwizard \title Class Wizard Example + \ingroup examples-dialogs \brief The License Wizard example shows how to implement linear wizards using QWizard. diff --git a/examples/widgets/doc/src/collidingmice-example.qdoc b/examples/widgets/doc/src/collidingmice-example.qdoc new file mode 100644 index 0000000000..b6187677b8 --- /dev/null +++ b/examples/widgets/doc/src/collidingmice-example.qdoc @@ -0,0 +1,273 @@ +/**************************************************************************** +** +** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies). +** Contact: http://www.qt-project.org/legal +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and Digia. For licensing terms and +** conditions see http://qt.digia.com/licensing. For further information +** use the contact form at http://qt.digia.com/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: http://www.gnu.org/copyleft/fdl.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \example graphicsview/collidingmice + \title Colliding Mice Example + \brief Demonstrates how to animate items on a graphics view + \ingroup examples-graphicsview + + The Colliding Mice example shows how to use the Graphics View + framework to implement animated items and detect collision between + items. + + \image collidingmice-example.png + + Graphics View provides the QGraphicsScene class for managing and + interacting with a large number of custom-made 2D graphical items + derived from the QGraphicsItem class, and a QGraphicsView widget + for visualizing the items, with support for zooming and rotation. + + The example consists of an item class and a main function: + the \c Mouse class represents the individual mice extending + QGraphicsItem, and the \c main() function provides the main + application window. + + We will first review the \c Mouse class to see how to animate + items and detect item collision, and then we will review the \c + main() function to see how to put the items into a scene and how to + implement the corresponding view. + + \section1 Mouse Class Definition + + The \c mouse class inherits from QGraphicsItem. The + QGraphicsItem class is the base class for all graphical items in + the Graphics View framework, and provides a light-weight + foundation for writing your own custom items. + + \snippet graphicsview/collidingmice/mouse.h 0 + + When writing a custom graphics item, you must implement + QGraphicsItem's two pure virtual public functions: \l + {QGraphicsItem::}{boundingRect()}, which returns an estimate of + the area painted by the item, and \l {QGraphicsItem::}{paint()}, + which implements the actual painting. In addition, we reimplement + the \l {QGraphicsItem::}{shape()} and \l {QGraphicsItem::}{advance()}. + We reimplement \l {QGraphicsItem::}{shape()} to return an accurate + shape of our mouse item; the default implementation simply returns + the item's bounding rectangle. We reimplement \l {QGraphicsItem::}{advance()} + to handle the animation so it all happens on one update. + + \section1 Mouse Class Definition + + When constructing a mouse item, we first ensure that all the item's + private variables are properly initialized: + + \snippet graphicsview/collidingmice/mouse.cpp 0 + + To calculate the various components of the mouse's color, we use + the global qrand() function which is a thread-safe version of the + standard C++ rand() function. + + Then we call the \l {QGraphicsItem::setRotation()}{setRotation()} function + inherited from QGraphicsItem. Items live in their own local + coordinate system. Their coordinates are usually centered around + (0, 0), and this is also the center for all transformations. By + calling the item's \l {QGraphicsItem::setRotation()}{setRotation()} function + we alter the direction in which the mouse will start moving. + + When the QGraphicsScene decides to advance the scene a frame it will + call QGraphicsItem::advance() on each of the items. This enables us to + animate our mouse using our reimplementation of the advance() function. + + \snippet graphicsview/collidingmice/mouse.cpp 4 + \snippet graphicsview/collidingmice/mouse.cpp 5 + \snippet graphicsview/collidingmice/mouse.cpp 6 + + First, we don't bother doing any advance if the step is 0 since we want to our advance in + the actual advance (advance() is called twice, once with step == 0 indicating that items + are about to advance and with step == 1 for the actual advance). We also ensure that the + mice stays within a circle with a radius of 150 pixels. + + Note the \l {QGraphicsItem::mapFromScene()}{mapFromScene()} + function provided by QGraphicsItem. This function maps a position + given in \e scene coordinates, to the item's coordinate system. + + \snippet graphicsview/collidingmice/mouse.cpp 7 + \snippet graphicsview/collidingmice/mouse.cpp 8 + \snippet graphicsview/collidingmice/mouse.cpp 9 + \codeline + \snippet graphicsview/collidingmice/mouse.cpp 10 + + Then we try to avoid colliding with other mice. + + \snippet graphicsview/collidingmice/mouse.cpp 11 + + Finally, we calculate the mouse's speed and its eye direction (for + use when painting the mouse), and set its new position. + + The position of an item describes its origin (local coordinate (0, + 0)) in the parent coordinates. The \l {QGraphicsItem::setPos()} + function sets the position of the item to the given position in + the parent's coordinate system. For items with no parent, the + given position is interpreted as scene coordinates. QGraphicsItem + also provides a \l {QGraphicsItem::}{mapToParent()} function to + map a position given in item coordinates, to the parent's + coordinate system. If the item has no parent, the position will be + mapped to the scene's coordinate system instead. + + Then it is time to provide an implementation for the pure virtual + functions inherited from QGraphicsItem. Let's first take a look at + the \l {QGraphicsItem::}{boundingRect()} function: + + \snippet graphicsview/collidingmice/mouse.cpp 1 + + The \l {QGraphicsItem::boundingRect()}{boundingRect()} function + defines the outer bounds of the item as a rectangle. Note that the + Graphics View framework uses the bounding rectangle to determine + whether the item requires redrawing, so all painting must be + restricted inside this rectangle. + + \snippet graphicsview/collidingmice/mouse.cpp 3 + + The Graphics View framework calls the \l + {QGraphicsItem::paint()}{paint()} function to paint the contents + of the item; the function paints the item in local coordinates. + + Note the painting of the ears: Whenever a mouse item collides with + other mice items its ears are filled with red; otherwise they are + filled with dark yellow. We use the + QGraphicsScene::collidingItems() function to check if there are + any colliding mice. The actual collision detection is handled by + the Graphics View framework using shape-shape intersection. All we + have to do is to ensure that the QGraphicsItem::shape() function + returns an accurate shape for our item: + + \snippet graphicsview/collidingmice/mouse.cpp 2 + + Because the complexity of arbitrary shape-shape intersection grows + with an order of magnitude when the shapes are complex, this + operation can be noticably time consuming. An alternative approach + is to reimplement the \l + {QGraphicsItem::collidesWithItem()}{collidesWithItem()} function + to provide your own custom item and shape collision algorithm. + + This completes the \c Mouse class implementation, it is now ready + for use. Let's take a look at the \c main() function to see how to + implement a scene for the mice and a view for displaying the + contents of the scene. + + \section1 The Main() Function + + In this example we have chosen to let the \c main() function + provide the main application window, creating the items and the + scene, putting the items into the scene and creating a + corresponding view. + + \snippet graphicsview/collidingmice/main.cpp 0 + + First, we create an application object and call the global + qsrand() function to specify the seed used to generate a new + random number sequence of pseudo random integers with the + previously mentioned qrand() function. + + Then it is time to create the scene: + + \snippet graphicsview/collidingmice/main.cpp 1 + + The QGraphicsScene class serves as a container for + QGraphicsItems. It also provides functionality that lets you + efficiently determine the location of items as well as determining + which items that are visible within an arbitrary area on the + scene. + + When creating a scene it is recommended to set the scene's + rectangle, i.e., the rectangle that defines the extent of the + scene. It is primarily used by QGraphicsView to determine the + view's default scrollable area, and by QGraphicsScene to manage + item indexing. If not explicitly set, the scene's default + rectangle will be the largest bounding rectangle of all the items + on the scene since the scene was created (i.e., the rectangle will + grow when items are added or moved in the scene, but it will never + shrink). + + \snippet graphicsview/collidingmice/main.cpp 2 + + The item index function is used to speed up item discovery. \l + {QGraphicsScene::NoIndex}{NoIndex} implies that item location is + of linear complexity, as all items on the scene are + searched. Adding, moving and removing items, however, is done in + constant time. This approach is ideal for dynamic scenes, where + many items are added, moved or removed continuously. The + alternative is \l {QGraphicsScene::BspTreeIndex}{BspTreeIndex} + which makes use of binary search resulting in item location + algorithms that are of an order closer to logarithmic complexity. + + \snippet graphicsview/collidingmice/main.cpp 3 + + Then we add the mice to the scene. + + \snippet graphicsview/collidingmice/main.cpp 4 + + To be able to view the scene we must also create a QGraphicsView + widget. The QGraphicsView class visualizes the contents of a scene + in a scrollable viewport. We also ensure that the contents is + rendered using antialiasing, and we create the cheese background + by setting the view's background brush. + + The image used for the background is stored as a binary file in + the application's executable using Qt's \l {The Qt Resource + System}{resource system}. The QPixmap constructor accepts both + file names that refer to actual files on disk and file names that + refer to the application's embedded resources. + + \snippet graphicsview/collidingmice/main.cpp 5 + + Then we set the cache mode; QGraphicsView can cache pre-rendered + content in a pixmap, which is then drawn onto the viewport. The + purpose of such caching is to speed up the total rendering time + for areas that are slow to render, e.g., texture, gradient and + alpha blended backgrounds. The \l + {QGraphicsView::CacheMode}{CacheMode} property holds which parts + of the view that are cached, and the \l + {QGraphicsView::CacheBackground}{CacheBackground} flag enables + caching of the view's background. + + By setting the \l {QGraphicsView::dragMode}{dragMode} property we + define what should happen when the user clicks on the scene + background and drags the mouse. The \l + {QGraphicsView::ScrollHandDrag}{ScrollHandDrag} flag makes the + cursor change into a pointing hand, and dragging the mouse around + will scroll the scrollbars. + + \snippet graphicsview/collidingmice/main.cpp 6 + + In the end, we set the application window's title and size before + we enter the main event loop using the QApplication::exec() + function. + + Finally, we create a QTimer and connect its timeout() signal to the + advance() slot of the scene. Every time the timer fires, the scene + will advance one frame. + + We then tell the timer to fire every 1000/33 millisecond. This will + give us a frame rate of 30 frames a second, which is fast enough for most + animations. Doing the animation with a single timer connect to advance the + scene ensures that all the mice are moved at one point and, more + importantly, only one update is sent to the screen after all the mice have + moved. +*/ diff --git a/examples/widgets/doc/src/coloreditorfactory.qdoc b/examples/widgets/doc/src/coloreditorfactory.qdoc index 377491939e..f34622f37e 100644 --- a/examples/widgets/doc/src/coloreditorfactory.qdoc +++ b/examples/widgets/doc/src/coloreditorfactory.qdoc @@ -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. diff --git a/examples/widgets/doc/src/combowidgetmapper.qdoc b/examples/widgets/doc/src/combowidgetmapper.qdoc index df0d893f64..187934a816 100644 --- a/examples/widgets/doc/src/combowidgetmapper.qdoc +++ b/examples/widgets/doc/src/combowidgetmapper.qdoc @@ -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. diff --git a/examples/widgets/doc/src/configdialog.qdoc b/examples/widgets/doc/src/configdialog.qdoc index 0fdbc5ddd0..18c14b79e3 100644 --- a/examples/widgets/doc/src/configdialog.qdoc +++ b/examples/widgets/doc/src/configdialog.qdoc @@ -28,6 +28,7 @@ /*! \example dialogs/configdialog \title Config Dialog Example + \ingroup examples-dialogs \brief The Config Dialog examples shows how a configuration dialog can be created by using an icon view with a stacked widget. diff --git a/examples/widgets/doc/src/customsortfiltermodel.qdoc b/examples/widgets/doc/src/customsortfiltermodel.qdoc index 2003dc767a..82f124606e 100644 --- a/examples/widgets/doc/src/customsortfiltermodel.qdoc +++ b/examples/widgets/doc/src/customsortfiltermodel.qdoc @@ -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. diff --git a/examples/widgets/doc/src/diagramscene.qdoc b/examples/widgets/doc/src/diagramscene.qdoc index 9b94ca2ab1..4ad74cfee9 100644 --- a/examples/widgets/doc/src/diagramscene.qdoc +++ b/examples/widgets/doc/src/diagramscene.qdoc @@ -28,8 +28,8 @@ /*! \example graphicsview/diagramscene \title Diagram Scene Example - - \brief This example shows use of Qt's graphics framework. + \ingroup examples-graphicsview + \brief Demonstrate how to use the Graphics View framework \image diagramscene.png diff --git a/examples/widgets/doc/src/dirview.qdoc b/examples/widgets/doc/src/dirview.qdoc index 8f860fd036..5deabcbb19 100644 --- a/examples/widgets/doc/src/dirview.qdoc +++ b/examples/widgets/doc/src/dirview.qdoc @@ -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. diff --git a/examples/widgets/doc/src/dockwidgets.qdoc b/examples/widgets/doc/src/dockwidgets.qdoc index 8f83c80417..88dc146c7e 100644 --- a/examples/widgets/doc/src/dockwidgets.qdoc +++ b/examples/widgets/doc/src/dockwidgets.qdoc @@ -28,6 +28,7 @@ /*! \example mainwindows/dockwidgets \title Dock Widgets Example + \ingroup examples-mainwindow \brief The Dock Widgets example shows how to add dock windows to an application. It also shows how to use Qt's rich text engine. diff --git a/examples/widgets/doc/src/dragdroprobot.qdoc b/examples/widgets/doc/src/dragdroprobot.qdoc index cc5e6bd07d..f58f3cfdf2 100644 --- a/examples/widgets/doc/src/dragdroprobot.qdoc +++ b/examples/widgets/doc/src/dragdroprobot.qdoc @@ -28,8 +28,10 @@ /*! \example graphicsview/dragdroprobot \title Drag and Drop Robot Example + \ingroup examples-graphicsview + \brief Demonstrates how to drag and drop items in a graphics view - \brief The Drag and Drop Robot example shows how to implement Drag and Drop in a + 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}. diff --git a/examples/widgets/doc/src/editabletreemodel.qdoc b/examples/widgets/doc/src/editabletreemodel.qdoc index fa72b77506..8c4c7cb89c 100644 --- a/examples/widgets/doc/src/editabletreemodel.qdoc +++ b/examples/widgets/doc/src/editabletreemodel.qdoc @@ -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. diff --git a/examples/widgets/doc/src/elasticnodes.qdoc b/examples/widgets/doc/src/elasticnodes.qdoc index 2c081613bc..bfca70d2f1 100644 --- a/examples/widgets/doc/src/elasticnodes.qdoc +++ b/examples/widgets/doc/src/elasticnodes.qdoc @@ -28,8 +28,10 @@ /*! \example graphicsview/elasticnodes \title Elastic Nodes Example + \ingroup examples-graphicsview + \brief Demonstrates how to interact with graphical items in a scene - \brief The Elastic Nodes example shows how to implement edges between nodes in a + 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 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; diff --git a/examples/widgets/doc/src/embeddeddialogs.qdoc b/examples/widgets/doc/src/embeddeddialogs.qdoc index 878bb9f54a..34e800d75a 100644 --- a/examples/widgets/doc/src/embeddeddialogs.qdoc +++ b/examples/widgets/doc/src/embeddeddialogs.qdoc @@ -28,8 +28,10 @@ /*! \example graphicsview/embeddeddialogs \title Embedded Dialogs + \ingroup examples-graphicsview-layout + \brief Demonstrates how to embed dialogs into a graphics view - \brief This example shows how to embed standard dialogs into + This example shows how to embed standard dialogs into Graphics View. It also shows how you can customize the proxy class and add window shadows. diff --git a/examples/widgets/doc/src/extension.qdoc b/examples/widgets/doc/src/extension.qdoc index 0ba1d0738e..423a829167 100644 --- a/examples/widgets/doc/src/extension.qdoc +++ b/examples/widgets/doc/src/extension.qdoc @@ -28,6 +28,7 @@ /*! \example dialogs/extension \title Extension Example + \ingroup examples-dialogs \brief The Extension example shows how to add an extension to a QDialog using the QAbstractButton::toggled() signal and the diff --git a/examples/widgets/doc/src/fademessage.qdoc b/examples/widgets/doc/src/fademessage.qdoc index e50f434e56..dcd429521d 100644 --- a/examples/widgets/doc/src/fademessage.qdoc +++ b/examples/widgets/doc/src/fademessage.qdoc @@ -28,8 +28,10 @@ /*! \example effects/fademessage \title Fade Message Effect Example + \ingroup examples-graphicsview-graphicseffects + \brief Demonstrates how to appliy effects on items in the view - \div { style="text-align: center"} + \div { style="text-align: left"} \inlineimage fademessageeffect-example.png \inlineimage fademessageeffect-example-faded.png \enddiv diff --git a/examples/widgets/doc/src/fetchmore.qdoc b/examples/widgets/doc/src/fetchmore.qdoc index 8e3ec973aa..2c9c5d5b3b 100644 --- a/examples/widgets/doc/src/fetchmore.qdoc +++ b/examples/widgets/doc/src/fetchmore.qdoc @@ -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. diff --git a/examples/widgets/doc/src/findfiles.qdoc b/examples/widgets/doc/src/findfiles.qdoc index 27d0cacade..61dbf05581 100644 --- a/examples/widgets/doc/src/findfiles.qdoc +++ b/examples/widgets/doc/src/findfiles.qdoc @@ -28,6 +28,7 @@ /*! \example dialogs/findfiles \title Find Files Example + \ingroup examples-dialogs \brief The Find Files example shows how to use QProgressDialog to provide feedback on the progress of a slow operation. The example also diff --git a/examples/widgets/doc/src/fridgemagnets.qdoc b/examples/widgets/doc/src/fridgemagnets.qdoc index b53c94f0bd..8e0732f7dd 100644 --- a/examples/widgets/doc/src/fridgemagnets.qdoc +++ b/examples/widgets/doc/src/fridgemagnets.qdoc @@ -176,7 +176,7 @@ handler, where drag and drop operations begin: \snippet draganddrop/fridgemagnets/dragwidget.cpp 13 - \snippet examples/draganddrop/fridgemagnets/dragwidget.cpp 14 + \snippet draganddrop/fridgemagnets/dragwidget.cpp 14 Mouse events occur when a mouse button is pressed or released inside a widget, or when the mouse cursor is moved. By diff --git a/examples/widgets/doc/src/frozencolumn.qdoc b/examples/widgets/doc/src/frozencolumn.qdoc index 69e45de6df..39fe04c7bf 100644 --- a/examples/widgets/doc/src/frozencolumn.qdoc +++ b/examples/widgets/doc/src/frozencolumn.qdoc @@ -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" diff --git a/examples/widgets/doc/src/graphicsview-anchorlayout.qdoc b/examples/widgets/doc/src/graphicsview-anchorlayout.qdoc new file mode 100644 index 0000000000..98c0958918 --- /dev/null +++ b/examples/widgets/doc/src/graphicsview-anchorlayout.qdoc @@ -0,0 +1,38 @@ +/**************************************************************************** +** +** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies). +** Contact: http://www.qt-project.org/legal +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and Digia. For licensing terms and +** conditions see http://qt.digia.com/licensing. For further information +** use the contact form at http://qt.digia.com/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: http://www.gnu.org/copyleft/fdl.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \example graphicsview/anchorlayout + \title Anchor Layout Example + \ingroup examples-graphicsview-layout + \brief Demonstrates anchor layout in a graphics view scene + + The Anchor Layout example demonstrates the use of the QGraphicsAnchorLayout + class. + + \image graphicsanchorlayout-example.png +*/ diff --git a/examples/widgets/doc/src/graphicsview-flowlayout.qdoc b/examples/widgets/doc/src/graphicsview-flowlayout.qdoc new file mode 100644 index 0000000000..52d97164c3 --- /dev/null +++ b/examples/widgets/doc/src/graphicsview-flowlayout.qdoc @@ -0,0 +1,40 @@ +/**************************************************************************** +** +** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies). +** Contact: http://www.qt-project.org/legal +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and Digia. For licensing terms and +** conditions see http://qt.digia.com/licensing. For further information +** use the contact form at http://qt.digia.com/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: http://www.gnu.org/copyleft/fdl.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \example graphicsview/flowlayout + \title Graphics View Flow Layout Example + \ingroup examples-graphicsview-layout + \brief Demonstrates flow layout on a graphics view scene. + + The Graphics View Flow Layout example shows the use of a flow layout + in a Graphics View widget. + + \image graphicsflowlayout-example.png + + See the \l{Flow Layout Example} for a corresponding widget-based example. +*/ diff --git a/examples/widgets/doc/src/graphicsview-simpleanchorlayout.qdoc b/examples/widgets/doc/src/graphicsview-simpleanchorlayout.qdoc new file mode 100644 index 0000000000..480c7c4e0c --- /dev/null +++ b/examples/widgets/doc/src/graphicsview-simpleanchorlayout.qdoc @@ -0,0 +1,38 @@ +/**************************************************************************** +** +** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies). +** Contact: http://www.qt-project.org/legal +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and Digia. For licensing terms and +** conditions see http://qt.digia.com/licensing. For further information +** use the contact form at http://qt.digia.com/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: http://www.gnu.org/copyleft/fdl.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \example graphicsview/simpleanchorlayout + \title Simple Anchor Layout Example + \ingroup examples-graphicsview-layout + \brief Demonstrates anchor layout on a graphics view scene + + The Simple Anchor Layout example shows the basic use of the + QGraphicsAnchorLayout class. + + \image graphicssimpleanchorlayout-example.png +*/ diff --git a/examples/widgets/doc/src/graphicsview-weatheranchorlayout.qdoc b/examples/widgets/doc/src/graphicsview-weatheranchorlayout.qdoc new file mode 100644 index 0000000000..88a5c60fb5 --- /dev/null +++ b/examples/widgets/doc/src/graphicsview-weatheranchorlayout.qdoc @@ -0,0 +1,38 @@ +/**************************************************************************** +** +** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies). +** Contact: http://www.qt-project.org/legal +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and Digia. For licensing terms and +** conditions see http://qt.digia.com/licensing. For further information +** use the contact form at http://qt.digia.com/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: http://www.gnu.org/copyleft/fdl.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \example graphicsview/weatheranchorlayout + \title Weather Anchor Layout Example + \ingroup examples-graphicsview-layout + \brief Demonstrates anchor layout on a graphics view scene + + The Weather Anchor Layout example shows more complex use of the + QGraphicsAnchorLayout class to create a real-world window layout. + + \image weatheranchorlayout-example.png +*/ diff --git a/examples/widgets/doc/src/interview.qdoc b/examples/widgets/doc/src/interview.qdoc index 788af64f64..6528bef7d4 100644 --- a/examples/widgets/doc/src/interview.qdoc +++ b/examples/widgets/doc/src/interview.qdoc @@ -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 diff --git a/examples/widgets/doc/src/itemviewspuzzle.qdoc b/examples/widgets/doc/src/itemviewspuzzle.qdoc index 68cbdc936d..2e37cd372c 100644 --- a/examples/widgets/doc/src/itemviewspuzzle.qdoc +++ b/examples/widgets/doc/src/itemviewspuzzle.qdoc @@ -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. diff --git a/examples/widgets/doc/src/licensewizard.qdoc b/examples/widgets/doc/src/licensewizard.qdoc index aee60e11fe..e45c162f29 100644 --- a/examples/widgets/doc/src/licensewizard.qdoc +++ b/examples/widgets/doc/src/licensewizard.qdoc @@ -28,6 +28,7 @@ /*! \example dialogs/licensewizard \title License Wizard Example + \ingroup examples-dialogs \brief The License Wizard example shows how to implement complex wizards in Qt. diff --git a/examples/widgets/doc/src/lighting.qdoc b/examples/widgets/doc/src/lighting.qdoc index e457d20ada..e519bacb91 100644 --- a/examples/widgets/doc/src/lighting.qdoc +++ b/examples/widgets/doc/src/lighting.qdoc @@ -28,6 +28,8 @@ /*! \example effects/lighting \title Lighting Effect Example + \ingroup examples-graphicsview-graphicseffects + \brief Demonstrates how to apply effects on items in the view \image lightingeffect-example.png */ diff --git a/examples/widgets/doc/src/mainwindow.qdoc b/examples/widgets/doc/src/mainwindow.qdoc index 313b8cbc10..a0a7a43ee0 100644 --- a/examples/widgets/doc/src/mainwindow.qdoc +++ b/examples/widgets/doc/src/mainwindow.qdoc @@ -28,6 +28,7 @@ /*! \example mainwindows/mainwindow \title Main Window + \ingroup examples-mainwindow \brief The Main Window example shows Qt's extensive support for tool bars, dock windows, menus, and other standard application features. diff --git a/examples/widgets/doc/src/mdi.qdoc b/examples/widgets/doc/src/mdi.qdoc index e6b5eef4b4..fc1835c727 100644 --- a/examples/widgets/doc/src/mdi.qdoc +++ b/examples/widgets/doc/src/mdi.qdoc @@ -28,6 +28,7 @@ /*! \example mainwindows/mdi \title MDI Example + \ingroup examples-mainwindow \brief The MDI example shows how to implement a Multiple Document Interface using Qt's QMdiArea class. diff --git a/examples/widgets/doc/src/menus.qdoc b/examples/widgets/doc/src/menus.qdoc index 3b0c6079ab..09a43a1a45 100644 --- a/examples/widgets/doc/src/menus.qdoc +++ b/examples/widgets/doc/src/menus.qdoc @@ -28,6 +28,7 @@ /*! \example mainwindows/menus \title Menus Example + \ingroup examples-mainwindow \brief The Menus example demonstrates how menus can be used in a main window application. diff --git a/examples/widgets/doc/src/padnavigator.qdoc b/examples/widgets/doc/src/padnavigator.qdoc index b063d6de59..7b5e54e5ff 100644 --- a/examples/widgets/doc/src/padnavigator.qdoc +++ b/examples/widgets/doc/src/padnavigator.qdoc @@ -28,8 +28,10 @@ /*! \example graphicsview/padnavigator \title Pad Navigator Example + \ingroup examples-graphicsview + \brief Demonstrates how to create animated user interface - \brief The Pad Navigator Example shows how you can use Graphics View together with + 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. diff --git a/examples/widgets/doc/src/pixelator.qdoc b/examples/widgets/doc/src/pixelator.qdoc index 9eddcd9f11..ebcee4e5f9 100644 --- a/examples/widgets/doc/src/pixelator.qdoc +++ b/examples/widgets/doc/src/pixelator.qdoc @@ -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. diff --git a/examples/widgets/doc/src/plugandpaint.qdoc b/examples/widgets/doc/src/plugandpaint.qdoc index 88433a5e2f..cf068e92c3 100644 --- a/examples/widgets/doc/src/plugandpaint.qdoc +++ b/examples/widgets/doc/src/plugandpaint.qdoc @@ -48,7 +48,7 @@ through plugins, we recommend that you start by reading this overview, which explains how to make an application use plugins. Afterward, you can read the - \l{plugandpaintplugins/basictools}{Basic Tools} and + \l{tools/plugandpaintplugins/basictools}{Basic Tools} and \l{plugandpaintplugins/extrafilters}{Extra Filters} overviews, which show how to implement static and dynamic plugins, respectively. @@ -287,7 +287,7 @@ \snippet tools/plugandpaint/main.cpp 0 The argument to Q_IMPORT_PLUGIN() is the plugin's name, as - specified with Q_EXPORT_PLUGIN2() in the \l{Exporting the + specified with Q_PLUGIN_METADATA() in the \l{Exporting the Plugin}{plugin}. In the \c .pro file, we need to specify the static library. @@ -324,7 +324,7 @@ \list 1 \li Declare a plugin class. \li Implement the interfaces provided by the plugin. - \li Export the plugin using the Q_EXPORT_PLUGIN2() macro. + \li Export the plugin using the Q_PLUGIN_METADATA() macro. \li Build the plugin using an adequate \c .pro file. \endlist @@ -346,6 +346,8 @@ interfaces. Without the \c Q_INTERFACES() macro, we couldn't use \l qobject_cast() in the \l{plugandpaint}{Plug & Paint} application to detect interfaces. + For an explanation for the \c Q_PLUGIN_METADATA() macro see + \l {Exporting the Plugin}. \snippet tools/plugandpaintplugins/basictools/basictoolsplugin.h 2 @@ -440,15 +442,20 @@ \section1 Exporting the Plugin - Whereas applications have a \c main() function as their entry - point, plugins need to contain exactly one occurrence of the - Q_EXPORT_PLUGIN2() macro to specify which class provides the - plugin: + To finally export your plugin you just have to add the + \c Q_PLUGIN_METADATA() macro right next to the \c Q_OBJECT() macro + into the header file of the plugin. + It must contain the plugins IID and optionally a filename pointing + to a json file containing the metadata for the plugin. + + \snippet tools/plugandpaintplugins/basictools/basictoolsplugin.h 4 - \snippet tools/plugandpaintplugins/basictools/basictoolsplugin.cpp 9 + Within this example the json file does not need to export any metadata, + so it just contains an empty json object. - This line may appear in any \c .cpp file that is part of the - plugin's source code. + \code + {} + \endcode \section1 The .pro File diff --git a/examples/widgets/doc/src/recentfiles.qdoc b/examples/widgets/doc/src/recentfiles.qdoc index 722e32f8cd..01a6975828 100644 --- a/examples/widgets/doc/src/recentfiles.qdoc +++ b/examples/widgets/doc/src/recentfiles.qdoc @@ -28,6 +28,7 @@ /*! \example mainwindows/recentfiles \title Recent Files Example + \ingroup examples-mainwindow \brief The Recent Files example shows how a standard File menu can be extended to show the most recent files loaded by a main window application. diff --git a/examples/widgets/doc/src/sdi.qdoc b/examples/widgets/doc/src/sdi.qdoc index 379f28dc08..b163930530 100644 --- a/examples/widgets/doc/src/sdi.qdoc +++ b/examples/widgets/doc/src/sdi.qdoc @@ -28,6 +28,7 @@ /*! \example mainwindows/sdi \title SDI Example + \ingroup examples-mainwindow \brief The SDI example shows how to create a Single Document Interface. It uses a number of top-level windows to display the contents of different text files. diff --git a/examples/widgets/doc/src/simpledommodel.qdoc b/examples/widgets/doc/src/simpledommodel.qdoc index 99df1e46ca..c48563f47c 100644 --- a/examples/widgets/doc/src/simpledommodel.qdoc +++ b/examples/widgets/doc/src/simpledommodel.qdoc @@ -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. diff --git a/examples/widgets/doc/src/simpletreemodel.qdoc b/examples/widgets/doc/src/simpletreemodel.qdoc index 2b8884d5ca..df23617d5d 100644 --- a/examples/widgets/doc/src/simpletreemodel.qdoc +++ b/examples/widgets/doc/src/simpletreemodel.qdoc @@ -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 diff --git a/examples/widgets/doc/src/simplewidgetmapper.qdoc b/examples/widgets/doc/src/simplewidgetmapper.qdoc index ca5e47e13c..3e827a4a41 100644 --- a/examples/widgets/doc/src/simplewidgetmapper.qdoc +++ b/examples/widgets/doc/src/simplewidgetmapper.qdoc @@ -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. diff --git a/examples/widgets/doc/src/spinboxdelegate.qdoc b/examples/widgets/doc/src/spinboxdelegate.qdoc index f2add32286..3941afa95a 100644 --- a/examples/widgets/doc/src/spinboxdelegate.qdoc +++ b/examples/widgets/doc/src/spinboxdelegate.qdoc @@ -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. diff --git a/examples/widgets/doc/src/spreadsheet.qdoc b/examples/widgets/doc/src/spreadsheet.qdoc index cd94e08cec..a869c7dbe7 100644 --- a/examples/widgets/doc/src/spreadsheet.qdoc +++ b/examples/widgets/doc/src/spreadsheet.qdoc @@ -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 diff --git a/examples/widgets/doc/src/standarddialogs.qdoc b/examples/widgets/doc/src/standarddialogs.qdoc index f9d9372a70..4b39ac64c5 100644 --- a/examples/widgets/doc/src/standarddialogs.qdoc +++ b/examples/widgets/doc/src/standarddialogs.qdoc @@ -28,6 +28,7 @@ /*! \example dialogs/standarddialogs \title Standard Dialogs Example + \ingroup examples-dialogs \brief The Standard Dialogs example shows the standard dialogs that are provided by Qt. diff --git a/examples/widgets/doc/src/stardelegate.qdoc b/examples/widgets/doc/src/stardelegate.qdoc index 38e4cdfe22..f3da875422 100644 --- a/examples/widgets/doc/src/stardelegate.qdoc +++ b/examples/widgets/doc/src/stardelegate.qdoc @@ -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/examples/widgets/doc/src/tabdialog.qdoc b/examples/widgets/doc/src/tabdialog.qdoc index e2ac57550f..b3e74389af 100644 --- a/examples/widgets/doc/src/tabdialog.qdoc +++ b/examples/widgets/doc/src/tabdialog.qdoc @@ -28,6 +28,7 @@ /*! \example dialogs/tabdialog \title Tab Dialog Example + \ingroup examples-dialogs \brief The Tab Dialog example shows how to construct a tab dialog using the QTabWidget class. diff --git a/examples/widgets/doc/src/trivialwizard.qdoc b/examples/widgets/doc/src/trivialwizard.qdoc index c67bb09c0d..4ccee9a625 100644 --- a/examples/widgets/doc/src/trivialwizard.qdoc +++ b/examples/widgets/doc/src/trivialwizard.qdoc @@ -28,6 +28,7 @@ /*! \example dialogs/trivialwizard \title Trivial Wizard Example + \ingroup examples-dialogs \brief The Trivial Wizard example illustrates how to create a linear three-page registration wizard using three instances of QWizardPage and one instance |