From ae8533e4ae3ae2ca32a5dcfc4302d40ee0e2fb0f Mon Sep 17 00:00:00 2001 From: Eskil Abrahamsen Blomfeldt Date: Thu, 6 Dec 2012 11:50:33 +0100 Subject: doc: Fix Graphics View example docs Make the same layout of the new graphics view example documentation as we had before (except by using annotatedlist instead of hardcoding the links). I've also moved four examples from qtdoc to qtbase so that they can be included in this documentation. Change-Id: Ic2202ade119cadd98d036f1bd77e91dae49b5677 Reviewed-by: Jerome Pasion Reviewed-by: Paul Olav Tvete --- examples/widgets/doc/src/basicgraphicslayouts.qdoc | 2 +- examples/widgets/doc/src/blurpicker.qdoc | 2 ++ examples/widgets/doc/src/embeddeddialogs.qdoc | 2 +- examples/widgets/doc/src/fademessage.qdoc | 2 ++ .../widgets/doc/src/graphicsview-anchorlayout.qdoc | 36 ++++++++++++++++++++ .../widgets/doc/src/graphicsview-flowlayout.qdoc | 38 ++++++++++++++++++++++ .../doc/src/graphicsview-simpleanchorlayout.qdoc | 36 ++++++++++++++++++++ .../doc/src/graphicsview-weatheranchorlayout.qdoc | 36 ++++++++++++++++++++ examples/widgets/doc/src/lighting.qdoc | 2 ++ src/widgets/doc/src/qtwidgets-examples.qdoc | 13 +++++++- 10 files changed, 166 insertions(+), 3 deletions(-) create mode 100644 examples/widgets/doc/src/graphicsview-anchorlayout.qdoc create mode 100644 examples/widgets/doc/src/graphicsview-flowlayout.qdoc create mode 100644 examples/widgets/doc/src/graphicsview-simpleanchorlayout.qdoc create mode 100644 examples/widgets/doc/src/graphicsview-weatheranchorlayout.qdoc diff --git a/examples/widgets/doc/src/basicgraphicslayouts.qdoc b/examples/widgets/doc/src/basicgraphicslayouts.qdoc index 868943370c..2ff9a90680 100644 --- a/examples/widgets/doc/src/basicgraphicslayouts.qdoc +++ b/examples/widgets/doc/src/basicgraphicslayouts.qdoc @@ -28,7 +28,7 @@ /*! \example graphicsview/basicgraphicslayouts \title Basic Graphics Layouts Example - \ingroup examples-graphicsview + \ingroup examples-graphicsview-layout \brief This example shows how to use some basic layouts. \brief The Basic Graphics Layouts example shows how to use the layout classes diff --git a/examples/widgets/doc/src/blurpicker.qdoc b/examples/widgets/doc/src/blurpicker.qdoc index aa89ba3cd8..bacd7474e3 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 This example shows the use of QGraphicsBlurEffect. \image blurpickereffect-example.png */ diff --git a/examples/widgets/doc/src/embeddeddialogs.qdoc b/examples/widgets/doc/src/embeddeddialogs.qdoc index 964150ff0f..1dbb7dc83a 100644 --- a/examples/widgets/doc/src/embeddeddialogs.qdoc +++ b/examples/widgets/doc/src/embeddeddialogs.qdoc @@ -28,7 +28,7 @@ /*! \example graphicsview/embeddeddialogs \title Embedded Dialogs - \ingroup examples-graphicsview + \ingroup examples-graphicsview-layout \brief This example shows how to embed standard dialogs into Graphics View. diff --git a/examples/widgets/doc/src/fademessage.qdoc b/examples/widgets/doc/src/fademessage.qdoc index e50f434e56..335384d5bd 100644 --- a/examples/widgets/doc/src/fademessage.qdoc +++ b/examples/widgets/doc/src/fademessage.qdoc @@ -28,6 +28,8 @@ /*! \example effects/fademessage \title Fade Message Effect Example + \ingroup examples-graphicsview-graphicseffects + \brief This example shows the use of QGraphicsColorizeEffect. \div { style="text-align: center"} \inlineimage fademessageeffect-example.png diff --git a/examples/widgets/doc/src/graphicsview-anchorlayout.qdoc b/examples/widgets/doc/src/graphicsview-anchorlayout.qdoc new file mode 100644 index 0000000000..78aa1feb95 --- /dev/null +++ b/examples/widgets/doc/src/graphicsview-anchorlayout.qdoc @@ -0,0 +1,36 @@ +/**************************************************************************** +** +** 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 This example shows how to use QGraphicsAnchorLayout. + + The Anchor Layout example demonstrates the use of the QGraphicsAnchorLayout + class. +*/ diff --git a/examples/widgets/doc/src/graphicsview-flowlayout.qdoc b/examples/widgets/doc/src/graphicsview-flowlayout.qdoc new file mode 100644 index 0000000000..c754fa2d53 --- /dev/null +++ b/examples/widgets/doc/src/graphicsview-flowlayout.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/flowlayout + \title Graphics View Flow Layout Example + \ingroup examples-graphicsview-layout + \brief This example shows how to make a flow layout in Graphics View. + + The Graphics View Flow Layout example shows the use of a flow layout + in a Graphics View widget. + + 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..2ff804ab46 --- /dev/null +++ b/examples/widgets/doc/src/graphicsview-simpleanchorlayout.qdoc @@ -0,0 +1,36 @@ +/**************************************************************************** +** +** 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 This example shows how basic use of QGraphicsAnchorLayout. + + The Simple Anchor Layout example shows the basic use of the + QGraphicsAnchorLayout class. +*/ diff --git a/examples/widgets/doc/src/graphicsview-weatheranchorlayout.qdoc b/examples/widgets/doc/src/graphicsview-weatheranchorlayout.qdoc new file mode 100644 index 0000000000..8b7b9c498d --- /dev/null +++ b/examples/widgets/doc/src/graphicsview-weatheranchorlayout.qdoc @@ -0,0 +1,36 @@ +/**************************************************************************** +** +** 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 This example shows advanced use of QGraphicsAnchorLayout. + + The Weather Anchor Layout example shows more complex use of the + QGraphicsAnchorLayout class to create a real-world window layout. +*/ diff --git a/examples/widgets/doc/src/lighting.qdoc b/examples/widgets/doc/src/lighting.qdoc index e457d20ada..8277f0e5b8 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 This example shows the use of QGraphicsDropShadowEffect. \image lightingeffect-example.png */ diff --git a/src/widgets/doc/src/qtwidgets-examples.qdoc b/src/widgets/doc/src/qtwidgets-examples.qdoc index 4059414ad7..6d00a0b067 100644 --- a/src/widgets/doc/src/qtwidgets-examples.qdoc +++ b/src/widgets/doc/src/qtwidgets-examples.qdoc @@ -129,7 +129,7 @@ \ingroup all-examples \title Graphicsview Examples \brief Using the Graphics View framework. - \group examples-graphicsview + \page examples-graphicsview.html \image graphicsview-examples.png @@ -137,6 +137,17 @@ support for rotation and zooming. Additionally it provides an event propagation architecture for interaction. + These examples demonstrate the fundamental aspects of canvas programming with Qt. + + \annotatedlist{examples-graphicsview} + + These examples show the use of graphics widgets and layouts. + + \annotatedlist{examples-graphicsview-layout} + + Some examples demonstrate the use of graphics effects with canvas items. + + \annotatedlist{examples-graphicsview-graphicseffects} */ /*! -- cgit v1.2.3