Doc: Modularized Qt Svg documentation

Change-Id: I2b503ec04a0a4bf800f62c8d3dc2bf1675293add
Reviewed-by: Sergio Ahumada <sergio.ahumada@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>

38 files changed, 177 insertions, 5 deletions

diff --git a/examples/embedded/embedded.pro b/examples/embedded/embedded.pro
index 911fd5a..09cbcd2 100644
--- a/examples/embedded/embedded.pro
+++ b/examples/embedded/embedded.pro
@@ -1,3 +1,3 @@
 TEMPLATE = subdirs
-!contains(QT_CONFIG, no-widgets): SUBDIRS += desktopservices embeddedsvgviewer fluidlauncher weatherinfo
+!contains(QT_CONFIG, no-widgets): SUBDIRS += desktopservices fluidlauncher weatherinfo
 QT+=widgets
diff --git a/examples/examples.pro b/examples/examples.pro
index d96fdb9..30b113c 100644
--- a/examples/examples.pro
+++ b/examples/examples.pro
@@ -1,5 +1,5 @@
 TEMPLATE = subdirs
-SUBDIRS += embedded richtext draganddrop painting network
+SUBDIRS += embedded richtext draganddrop network svg
 
 contains(QT_CONFIG,opengl):!contains(QT_CONFIG,opengles2):SUBDIRS += opengl
 QT+=widgets
diff --git a/examples/painting/painting.pro b/examples/painting/painting.pro
deleted file mode 100644
index 9b7e2cd..0000000
--- a/examples/painting/painting.pro
+++ /dev/null
@@ -1,3 +0,0 @@
-TEMPLATE = subdirs
-!contains(QT_CONFIG, no-widgets): SUBDIRS += svgviewer svggenerator
-QT+=widgets
diff --git a/examples/embedded/embeddedsvgviewer/embeddedsvgviewer.cpp b/examples/svg/embeddedsvgviewer/embeddedsvgviewer.cpp
index a10910e..a10910e 100644
--- a/examples/embedded/embeddedsvgviewer/embeddedsvgviewer.cpp
+++ b/examples/svg/embeddedsvgviewer/embeddedsvgviewer.cpp
diff --git a/examples/embedded/embeddedsvgviewer/embeddedsvgviewer.h b/examples/svg/embeddedsvgviewer/embeddedsvgviewer.h
index 18c5eaa..18c5eaa 100644
--- a/examples/embedded/embeddedsvgviewer/embeddedsvgviewer.h
+++ b/examples/svg/embeddedsvgviewer/embeddedsvgviewer.h
diff --git a/examples/embedded/embeddedsvgviewer/embeddedsvgviewer.pro b/examples/svg/embeddedsvgviewer/embeddedsvgviewer.pro
index c48a317..c48a317 100644
--- a/examples/embedded/embeddedsvgviewer/embeddedsvgviewer.pro
+++ b/examples/svg/embeddedsvgviewer/embeddedsvgviewer.pro
diff --git a/examples/embedded/embeddedsvgviewer/embeddedsvgviewer.qrc b/examples/svg/embeddedsvgviewer/embeddedsvgviewer.qrc
index bb02118..bb02118 100644
--- a/examples/embedded/embeddedsvgviewer/embeddedsvgviewer.qrc
+++ b/examples/svg/embeddedsvgviewer/embeddedsvgviewer.qrc
diff --git a/examples/embedded/embeddedsvgviewer/files/default.svg b/examples/svg/embeddedsvgviewer/files/default.svg
index c28a711..c28a711 100644
--- a/examples/embedded/embeddedsvgviewer/files/default.svg
+++ b/examples/svg/embeddedsvgviewer/files/default.svg
diff --git a/examples/embedded/embeddedsvgviewer/files/v-slider-handle.svg b/examples/svg/embeddedsvgviewer/files/v-slider-handle.svg
index 4ee87f8..4ee87f8 100644
--- a/examples/embedded/embeddedsvgviewer/files/v-slider-handle.svg
+++ b/examples/svg/embeddedsvgviewer/files/v-slider-handle.svg
diff --git a/examples/embedded/embeddedsvgviewer/main.cpp b/examples/svg/embeddedsvgviewer/main.cpp
index 287e2a5..287e2a5 100644
--- a/examples/embedded/embeddedsvgviewer/main.cpp
+++ b/examples/svg/embeddedsvgviewer/main.cpp
diff --git a/examples/embedded/embeddedsvgviewer/shapes.svg b/examples/svg/embeddedsvgviewer/shapes.svg
index c28a711..c28a711 100644
--- a/examples/embedded/embeddedsvgviewer/shapes.svg
+++ b/examples/svg/embeddedsvgviewer/shapes.svg
diff --git a/examples/embedded/embeddedsvgviewer/spheres.svg b/examples/svg/embeddedsvgviewer/spheres.svg
index e108777..e108777 100644
--- a/examples/embedded/embeddedsvgviewer/spheres.svg
+++ b/examples/svg/embeddedsvgviewer/spheres.svg
diff --git a/examples/svg/svg.pro b/examples/svg/svg.pro
new file mode 100644
index 0000000..1652275
--- /dev/null
+++ b/examples/svg/svg.pro
@@ -0,0 +1,7 @@
+TEMPLATE = subdirs
+
+!contains(QT_CONFIG, no-widgets): SUBDIRS += embeddedsvgviewer  svggenerator  svgviewer
+
+QT+=widgets
+
+
diff --git a/examples/painting/svggenerator/displaywidget.cpp b/examples/svg/svggenerator/displaywidget.cpp
index 4bb6459..4bb6459 100644
--- a/examples/painting/svggenerator/displaywidget.cpp
+++ b/examples/svg/svggenerator/displaywidget.cpp
diff --git a/examples/painting/svggenerator/displaywidget.h b/examples/svg/svggenerator/displaywidget.h
index eca7f5d..eca7f5d 100644
--- a/examples/painting/svggenerator/displaywidget.h
+++ b/examples/svg/svggenerator/displaywidget.h
diff --git a/examples/svg/svggenerator/doc/images/svggenerator-example.png b/examples/svg/svggenerator/doc/images/svggenerator-example.png
new file mode 100644
index 0000000..e7a8e53
--- /dev/null
+++ b/examples/svg/svggenerator/doc/images/svggenerator-example.png
diff --git a/examples/svg/svggenerator/doc/src/svggenerator.qdoc b/examples/svg/svggenerator/doc/src/svggenerator.qdoc
new file mode 100644
index 0000000..f9ec684
--- /dev/null
+++ b/examples/svg/svggenerator/doc/src/svggenerator.qdoc
@@ -0,0 +1,122 @@
+/****************************************************************************
+**
+** 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 svggenerator
+    \title SVG Generator Example
+
+    The SVG Generator example shows how to add SVG file export to applications.
+
+    \image svggenerator-example.png
+
+    Scalable Vector Graphics (SVG) is an XML-based language for describing
+    two-dimensional vector graphics. Qt provides classes for rendering and
+    generating SVG drawings. This example allows the user to create a simple
+    picture and save it to an SVG file.
+
+    The example consists of two classes: \c Window and \c DisplayWidget.
+
+    The \c Window class contains the application logic and constructs the user
+    interface from a Qt Designer UI file as described in the
+    \l{Using a Designer UI File in Your Application#The Multiple Inheritance Approach}{Qt Designer manual}.
+    It also contains the code to write an SVG file.
+
+    The \c DisplayWidget class performs all the work of painting a picture on
+    screen. Since we want the SVG to resemble this picture as closely as
+    possible, we make this code available to the \c Window class so that it can
+    be used to generate SVG files.
+
+    \section1 The DisplayWidget Class
+
+    The \c DisplayWidget class displays a drawing consisting of a selection of
+    elements chosen by the user. These are defined using \c Shape and
+    \c Background enums that are included within the class definition:
+
+    \snippet svggenerator/displaywidget.h DisplayWidget class definition
+
+    Much of this class is used to configure the appearance of the drawing. The
+    \c paintEvent() and \c paint() functions are most relevant to the purpose
+    of this example, so we will describe these here and leave the reader to
+    look at the source code for the example to see how shapes and colors are
+    handled.
+
+    We reimplement the QWidget::paintEvent() function to display the drawing
+    on screen:
+
+    \snippet svggenerator/displaywidget.cpp paint event
+
+    Here, we only construct a QPainter object, begin painting on the device
+    and set a render hint for improved output quality before calling the
+    \c paint() function to perform the painting itself. When this returns,
+    we close the painter and return.
+
+    The \c paint() function is designed to be used for different painting
+    tasks. In this example, we use it to draw on a \c DisplayWidget instance
+    and on a QSvgGenerator object. We show how the painting is performed to
+    demonstrate that there is nothing device-specific about the process:
+
+    \snippet svggenerator/displaywidget.cpp paint function
+
+    \section1 The Window Class
+
+    The \c Window class represents the example's window, containing the user
+    interface, which has been created using Qt Designer:
+
+    \snippet svggenerator/window.h Window class definition
+
+    As with the \c DisplayWidget class, we concentrate on the parts of the code
+    which are concerned with painting and SVG generation. In the \c Window
+    class, the \c saveSvg() function is called whenever the \b{Save As...}
+    button is clicked; this connection was defined in the \c{window.ui} file
+    using Qt Designer.
+
+    The start of the \c saveSvg() function performs the task of showing a file
+    dialog so that the user can specify a SVG file to save the drawing to.
+    
+    \snippet svggenerator/window.cpp save SVG
+
+    In the rest of the function, we set up the generator and configure it to
+    generate output with the appropriate dimensions and write to the
+    user-specified file. We paint on the QSvgGenerator object in the same way
+    that we paint on a widget, calling the \c DisplayWidget::paint() function
+    so that we use exactly the same code that we used to display the drawing.
+
+    The generation process itself begins with the call to the painter's
+    \l{QPainter::}{begin()} function and ends with call to its
+    \l{QPainter::}{end()} function. The QSvgGenerator paint device relies on
+    the explicit use of these functions to ensure that output is written to
+    the file.
+
+    \section1 Further Reading
+
+    The \l{SVG Viewer Example} shows how to display SVG drawings in an
+    application, and can be used to show the contents of SVG files created
+    by this example.
+
+    See the QtSvg module documentation for more information about SVG and Qt's
+    SVG classes.
+*/
diff --git a/examples/painting/svggenerator/forms/window.ui b/examples/svg/svggenerator/forms/window.ui
index bf11908..bf11908 100644
--- a/examples/painting/svggenerator/forms/window.ui
+++ b/examples/svg/svggenerator/forms/window.ui
diff --git a/examples/painting/svggenerator/main.cpp b/examples/svg/svggenerator/main.cpp
index a244f67..a244f67 100644
--- a/examples/painting/svggenerator/main.cpp
+++ b/examples/svg/svggenerator/main.cpp
diff --git a/examples/painting/svggenerator/resources/shapes.dat b/examples/svg/svggenerator/resources/shapes.dat
index d9b981e..d9b981e 100644
--- a/examples/painting/svggenerator/resources/shapes.dat
+++ b/examples/svg/svggenerator/resources/shapes.dat
diff --git a/examples/painting/svggenerator/svggenerator.desktop b/examples/svg/svggenerator/svggenerator.desktop
index 3ae32a4..3ae32a4 100644
--- a/examples/painting/svggenerator/svggenerator.desktop
+++ b/examples/svg/svggenerator/svggenerator.desktop
diff --git a/examples/painting/svggenerator/svggenerator.pro b/examples/svg/svggenerator/svggenerator.pro
index 4e62b22..4e62b22 100644
--- a/examples/painting/svggenerator/svggenerator.pro
+++ b/examples/svg/svggenerator/svggenerator.pro
diff --git a/examples/painting/svggenerator/svggenerator.qrc b/examples/svg/svggenerator/svggenerator.qrc
index 061d1f6..061d1f6 100644
--- a/examples/painting/svggenerator/svggenerator.qrc
+++ b/examples/svg/svggenerator/svggenerator.qrc
diff --git a/examples/painting/svggenerator/window.cpp b/examples/svg/svggenerator/window.cpp
index 36c281e..36c281e 100644
--- a/examples/painting/svggenerator/window.cpp
+++ b/examples/svg/svggenerator/window.cpp
diff --git a/examples/painting/svggenerator/window.h b/examples/svg/svggenerator/window.h
index 6dd55c1..6dd55c1 100644
--- a/examples/painting/svggenerator/window.h
+++ b/examples/svg/svggenerator/window.h
diff --git a/examples/svg/svgviewer/doc/images/svgviewer-example.png b/examples/svg/svgviewer/doc/images/svgviewer-example.png
new file mode 100644
index 0000000..14f1377
--- /dev/null
+++ b/examples/svg/svgviewer/doc/images/svgviewer-example.png
diff --git a/examples/svg/svgviewer/doc/src/svgviewer.qdoc b/examples/svg/svgviewer/doc/src/svgviewer.qdoc
new file mode 100644
index 0000000..0b04792
--- /dev/null
+++ b/examples/svg/svgviewer/doc/src/svgviewer.qdoc
@@ -0,0 +1,46 @@
+/****************************************************************************
+**
+** 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 svgviewer
+    \title SVG Viewer Example
+
+    The SVG Viewer example shows how to add SVG viewing support to applications.
+
+    \image svgviewer-example.png
+
+    Scalable Vector Graphics (SVG) is an XML-based language for describing two-dimensional
+    vector graphics. Qt provides classes for rendering and displaying SVG drawings in
+    widgets and on other paint devices. This example allows the user to load SVG files
+    and view them in a QGraphicsView using a QGraphicsSvgItem. Based on the selected
+    renderer the QGraphicsView uses either a QWidget or QGLWidget as its viewport. A
+    third render mode is also provided, where the QGraphicsView draws indirectly though
+    a QImage. This allows testing of drawing accuracy and performance for both the 
+    native, raster, and OpenGL paint engines.
+
+    See the QtSvg module documentation for more information about SVG and Qt's SVG classes.
+*/
diff --git a/examples/painting/svgviewer/files/bubbles.svg b/examples/svg/svgviewer/files/bubbles.svg
index 5173012..5173012 100644
--- a/examples/painting/svgviewer/files/bubbles.svg
+++ b/examples/svg/svgviewer/files/bubbles.svg
diff --git a/examples/painting/svgviewer/files/cubic.svg b/examples/svg/svgviewer/files/cubic.svg
index 492bb72..492bb72 100644
--- a/examples/painting/svgviewer/files/cubic.svg
+++ b/examples/svg/svgviewer/files/cubic.svg
diff --git a/examples/painting/svgviewer/files/spheres.svg b/examples/svg/svgviewer/files/spheres.svg
index b23164b..b23164b 100644
--- a/examples/painting/svgviewer/files/spheres.svg
+++ b/examples/svg/svgviewer/files/spheres.svg
diff --git a/examples/painting/svgviewer/main.cpp b/examples/svg/svgviewer/main.cpp
index c8376c5..c8376c5 100644
--- a/examples/painting/svgviewer/main.cpp
+++ b/examples/svg/svgviewer/main.cpp
diff --git a/examples/painting/svgviewer/mainwindow.cpp b/examples/svg/svgviewer/mainwindow.cpp
index 71723ee..71723ee 100644
--- a/examples/painting/svgviewer/mainwindow.cpp
+++ b/examples/svg/svgviewer/mainwindow.cpp
diff --git a/examples/painting/svgviewer/mainwindow.h b/examples/svg/svgviewer/mainwindow.h
index 09c4cea..09c4cea 100644
--- a/examples/painting/svgviewer/mainwindow.h
+++ b/examples/svg/svgviewer/mainwindow.h
diff --git a/examples/painting/svgviewer/svgview.cpp b/examples/svg/svgviewer/svgview.cpp
index 4c6f852..4c6f852 100644
--- a/examples/painting/svgviewer/svgview.cpp
+++ b/examples/svg/svgviewer/svgview.cpp
diff --git a/examples/painting/svgviewer/svgview.h b/examples/svg/svgviewer/svgview.h
index e2635a0..e2635a0 100644
--- a/examples/painting/svgviewer/svgview.h
+++ b/examples/svg/svgviewer/svgview.h
diff --git a/examples/painting/svgviewer/svgviewer.desktop b/examples/svg/svgviewer/svgviewer.desktop
index 477ef78..477ef78 100644
--- a/examples/painting/svgviewer/svgviewer.desktop
+++ b/examples/svg/svgviewer/svgviewer.desktop
diff --git a/examples/painting/svgviewer/svgviewer.pro b/examples/svg/svgviewer/svgviewer.pro
index 94daed9..94daed9 100644
--- a/examples/painting/svgviewer/svgviewer.pro
+++ b/examples/svg/svgviewer/svgviewer.pro
diff --git a/examples/painting/svgviewer/svgviewer.qrc b/examples/svg/svgviewer/svgviewer.qrc
index db611f5..db611f5 100644
--- a/examples/painting/svgviewer/svgviewer.qrc
+++ b/examples/svg/svgviewer/svgviewer.qrc