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 <jerome.pasion@digia.com>
Reviewed-by: Paul Olav Tvete <paul.tvete@digia.com>
This commit is contained in:
Eskil Abrahamsen Blomfeldt 2012-12-06 11:50:33 +01:00 committed by The Qt Project
parent 0fc1b9d06e
commit ae8533e4ae
10 changed files with 166 additions and 3 deletions

View File

@ -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

View File

@ -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
*/

View File

@ -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.

View File

@ -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

View File

@ -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.
*/

View File

@ -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.
*/

View File

@ -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.
*/

View File

@ -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.
*/

View File

@ -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
*/

View File

@ -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}
*/
/*!