diff options
author | Geir Vattekar <geir.vattekar@digia.com> | 2012-10-05 15:58:48 +0200 |
---|---|---|
committer | The Qt Project <gerrit-noreply@qt-project.org> | 2012-10-25 11:49:55 +0200 |
commit | 7eff63b41e4f5bc008877581abd87774c2907e08 (patch) | |
tree | 8017808be1a3ff879bcabc367687775051268bf4 | |
parent | 67a7cf1784c068104d69a032dcd0cebc984876f6 (diff) | |
download | qtsvg-7eff63b41e4f5bc008877581abd87774c2907e08.tar.gz |
Doc: Modularized Qt Svg documentation
Change-Id: I2b503ec04a0a4bf800f62c8d3dc2bf1675293add
Reviewed-by: Sergio Ahumada <sergio.ahumada@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
-rw-r--r-- | examples/embedded/embedded.pro | 2 | ||||
-rw-r--r-- | examples/examples.pro | 2 | ||||
-rw-r--r-- | examples/painting/painting.pro | 3 | ||||
-rw-r--r-- | examples/svg/embeddedsvgviewer/embeddedsvgviewer.cpp (renamed from examples/embedded/embeddedsvgviewer/embeddedsvgviewer.cpp) | 0 | ||||
-rw-r--r-- | examples/svg/embeddedsvgviewer/embeddedsvgviewer.h (renamed from examples/embedded/embeddedsvgviewer/embeddedsvgviewer.h) | 0 | ||||
-rw-r--r-- | examples/svg/embeddedsvgviewer/embeddedsvgviewer.pro (renamed from examples/embedded/embeddedsvgviewer/embeddedsvgviewer.pro) | 0 | ||||
-rw-r--r-- | examples/svg/embeddedsvgviewer/embeddedsvgviewer.qrc (renamed from examples/embedded/embeddedsvgviewer/embeddedsvgviewer.qrc) | 0 | ||||
-rw-r--r-- | examples/svg/embeddedsvgviewer/files/default.svg (renamed from examples/embedded/embeddedsvgviewer/files/default.svg) | 0 | ||||
-rw-r--r-- | examples/svg/embeddedsvgviewer/files/v-slider-handle.svg (renamed from examples/embedded/embeddedsvgviewer/files/v-slider-handle.svg) | 0 | ||||
-rw-r--r-- | examples/svg/embeddedsvgviewer/main.cpp (renamed from examples/embedded/embeddedsvgviewer/main.cpp) | 0 | ||||
-rw-r--r-- | examples/svg/embeddedsvgviewer/shapes.svg (renamed from examples/embedded/embeddedsvgviewer/shapes.svg) | 0 | ||||
-rw-r--r-- | examples/svg/embeddedsvgviewer/spheres.svg (renamed from examples/embedded/embeddedsvgviewer/spheres.svg) | 0 | ||||
-rw-r--r-- | examples/svg/svg.pro | 7 | ||||
-rw-r--r-- | examples/svg/svggenerator/displaywidget.cpp (renamed from examples/painting/svggenerator/displaywidget.cpp) | 0 | ||||
-rw-r--r-- | examples/svg/svggenerator/displaywidget.h (renamed from examples/painting/svggenerator/displaywidget.h) | 0 | ||||
-rw-r--r-- | examples/svg/svggenerator/doc/images/svggenerator-example.png (renamed from doc/src/images/svggenerator-example.png) | bin | 11625 -> 11625 bytes | |||
-rw-r--r-- | examples/svg/svggenerator/doc/src/svggenerator.qdoc (renamed from doc/src/examples/svggenerator.qdoc) | 14 | ||||
-rw-r--r-- | examples/svg/svggenerator/forms/window.ui (renamed from examples/painting/svggenerator/forms/window.ui) | 0 | ||||
-rw-r--r-- | examples/svg/svggenerator/main.cpp (renamed from examples/painting/svggenerator/main.cpp) | 0 | ||||
-rw-r--r-- | examples/svg/svggenerator/resources/shapes.dat (renamed from examples/painting/svggenerator/resources/shapes.dat) | bin | 2088 -> 2088 bytes | |||
-rw-r--r-- | examples/svg/svggenerator/svggenerator.desktop (renamed from examples/painting/svggenerator/svggenerator.desktop) | 0 | ||||
-rw-r--r-- | examples/svg/svggenerator/svggenerator.pro (renamed from examples/painting/svggenerator/svggenerator.pro) | 0 | ||||
-rw-r--r-- | examples/svg/svggenerator/svggenerator.qrc (renamed from examples/painting/svggenerator/svggenerator.qrc) | 0 | ||||
-rw-r--r-- | examples/svg/svggenerator/window.cpp (renamed from examples/painting/svggenerator/window.cpp) | 0 | ||||
-rw-r--r-- | examples/svg/svggenerator/window.h (renamed from examples/painting/svggenerator/window.h) | 0 | ||||
-rw-r--r-- | examples/svg/svgviewer/doc/images/svgviewer-example.png (renamed from doc/src/images/svgviewer-example.png) | bin | 48184 -> 48184 bytes | |||
-rw-r--r-- | examples/svg/svgviewer/doc/src/svgviewer.qdoc (renamed from doc/src/examples/svgviewer.qdoc) | 2 | ||||
-rw-r--r-- | examples/svg/svgviewer/files/bubbles.svg (renamed from examples/painting/svgviewer/files/bubbles.svg) | 0 | ||||
-rw-r--r-- | examples/svg/svgviewer/files/cubic.svg (renamed from examples/painting/svgviewer/files/cubic.svg) | 0 | ||||
-rw-r--r-- | examples/svg/svgviewer/files/spheres.svg (renamed from examples/painting/svgviewer/files/spheres.svg) | 0 | ||||
-rw-r--r-- | examples/svg/svgviewer/main.cpp (renamed from examples/painting/svgviewer/main.cpp) | 0 | ||||
-rw-r--r-- | examples/svg/svgviewer/mainwindow.cpp (renamed from examples/painting/svgviewer/mainwindow.cpp) | 0 | ||||
-rw-r--r-- | examples/svg/svgviewer/mainwindow.h (renamed from examples/painting/svgviewer/mainwindow.h) | 0 | ||||
-rw-r--r-- | examples/svg/svgviewer/svgview.cpp (renamed from examples/painting/svgviewer/svgview.cpp) | 0 | ||||
-rw-r--r-- | examples/svg/svgviewer/svgview.h (renamed from examples/painting/svgviewer/svgview.h) | 0 | ||||
-rw-r--r-- | examples/svg/svgviewer/svgviewer.desktop (renamed from examples/painting/svgviewer/svgviewer.desktop) | 0 | ||||
-rw-r--r-- | examples/svg/svgviewer/svgviewer.pro (renamed from examples/painting/svgviewer/svgviewer.pro) | 0 | ||||
-rw-r--r-- | examples/svg/svgviewer/svgviewer.qrc (renamed from examples/painting/svgviewer/svgviewer.qrc) | 0 | ||||
-rw-r--r-- | src/svg/doc/qtsvg.qdocconf | 50 | ||||
-rw-r--r-- | src/svg/doc/snippets/src_svg_qgraphicssvgitem.cpp (renamed from doc/src/snippets/code/src_svg_qgraphicssvgitem.cpp) | 0 | ||||
-rw-r--r-- | src/svg/doc/src/qtsvg-index.qdoc | 49 | ||||
-rw-r--r-- | src/svg/doc/src/qtsvg.qdoc | 41 | ||||
-rw-r--r-- | src/svg/qgraphicssvgitem.cpp | 5 | ||||
-rw-r--r-- | src/svg/qsvggenerator.cpp | 9 | ||||
-rw-r--r-- | src/svg/qsvgrenderer.cpp | 3 | ||||
-rw-r--r-- | src/svg/qsvgwidget.cpp | 3 |
46 files changed, 169 insertions, 21 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/doc/src/images/svggenerator-example.png b/examples/svg/svggenerator/doc/images/svggenerator-example.png Binary files differindex e7a8e53..e7a8e53 100644 --- a/doc/src/images/svggenerator-example.png +++ b/examples/svg/svggenerator/doc/images/svggenerator-example.png diff --git a/doc/src/examples/svggenerator.qdoc b/examples/svg/svggenerator/doc/src/svggenerator.qdoc index a2f49f6..f9ec684 100644 --- a/doc/src/examples/svggenerator.qdoc +++ b/examples/svg/svggenerator/doc/src/svggenerator.qdoc @@ -26,7 +26,7 @@ ****************************************************************************/ /*! - \example painting/svggenerator + \example svggenerator \title SVG Generator Example The SVG Generator example shows how to add SVG file export to applications. @@ -56,7 +56,7 @@ elements chosen by the user. These are defined using \c Shape and \c Background enums that are included within the class definition: - \snippet examples/painting/svggenerator/displaywidget.h DisplayWidget 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 @@ -67,7 +67,7 @@ We reimplement the QWidget::paintEvent() function to display the drawing on screen: - \snippet examples/painting/svggenerator/displaywidget.cpp paint event + \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 @@ -79,25 +79,25 @@ and on a QSvgGenerator object. We show how the painting is performed to demonstrate that there is nothing device-specific about the process: - \snippet examples/painting/svggenerator/displaywidget.cpp paint function + \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 examples/painting/svggenerator/window.h Window class definition + \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 \gui{Save As...} + 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 examples/painting/svggenerator/window.cpp save SVG + \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 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 Binary files differindex 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/doc/src/images/svgviewer-example.png b/examples/svg/svgviewer/doc/images/svgviewer-example.png Binary files differindex 14f1377..14f1377 100644 --- a/doc/src/images/svgviewer-example.png +++ b/examples/svg/svgviewer/doc/images/svgviewer-example.png diff --git a/doc/src/examples/svgviewer.qdoc b/examples/svg/svgviewer/doc/src/svgviewer.qdoc index ff83308..0b04792 100644 --- a/doc/src/examples/svgviewer.qdoc +++ b/examples/svg/svgviewer/doc/src/svgviewer.qdoc @@ -26,7 +26,7 @@ ****************************************************************************/ /*! - \example painting/svgviewer + \example svgviewer \title SVG Viewer Example The SVG Viewer example shows how to add SVG viewing support to applications. 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 diff --git a/src/svg/doc/qtsvg.qdocconf b/src/svg/doc/qtsvg.qdocconf new file mode 100644 index 0000000..99903a2 --- /dev/null +++ b/src/svg/doc/qtsvg.qdocconf @@ -0,0 +1,50 @@ +include(../../../doc/global/qt-html-templates-offline.qdocconf) +include(../../../doc/global/qt-module-defaults.qdocconf) + +project = QtSvg +description = Qt Svg Reference Documentation +url = http://qt-project.org/doc/qt-5.0/qtsvg-index.html +version = 5.0.0 + +qhp.projects = QtSvg + +qhp.QtSvg.file = qtsvg.qhp +qhp.QtSvg.namespace = org.qt-project.qtsvg.500 +qhp.QtSvg.virtualFolder = qdoc +qhp.QtSvg.indexTitle = Qt Svg Reference Documentation +qhp.QtSvg.indexRoot = + +qhp.QtSvg.filterAttributes = qtsvg 5.0.0 qtrefdoc +qhp.QtSvg.customFilters.Qt.name = QtSvg 5.0.0 +qhp.QtSvg.customFilters.Qt.filterAttributes = qtsvg 5.0.0 +qhp.QtSvg.subprojects = classes overviews examples +qhp.QtSvg.subprojects.classes.title = Classes +qhp.QtSvg.subprojects.classes.indexTitle = Qt Svg's Classes +qhp.QtSvg.subprojects.classes.selectors = class fake:headerfile +qhp.QtSvg.subprojects.classes.sortPages = true +qhp.QtSvg.subprojects.overviews.title = Overviews +qhp.QtSvg.subprojects.overviews.indexTitle = All Overviews and HOWTOs +qhp.QtSvg.subprojects.overviews.selectors = fake:page,group,module +qhp.QtSvg.subprojects.examples.title = Qt Svg Examples +qhp.QtSvg.subprojects.examples.indexTitle = Qt Svg Examples +qhp.QtSvg.subprojects.examples.selectors = fake:example + +depends += qtcore \ + qtwidgets \ + qtgui + +outputdir = ../../../doc/qtsvg +tagfile = ../../../doc/qtsvg/qtsvg.tags + +headerdirs += .. \ + ../../plugins/svg + +sourcedirs += .. \ + ../../plugins/svg + +exampledirs += ../../../examples/svg \ + snippets/ + + +imagedirs += images + diff --git a/doc/src/snippets/code/src_svg_qgraphicssvgitem.cpp b/src/svg/doc/snippets/src_svg_qgraphicssvgitem.cpp index af175cb..af175cb 100644 --- a/doc/src/snippets/code/src_svg_qgraphicssvgitem.cpp +++ b/src/svg/doc/snippets/src_svg_qgraphicssvgitem.cpp diff --git a/src/svg/doc/src/qtsvg-index.qdoc b/src/svg/doc/src/qtsvg-index.qdoc new file mode 100644 index 0000000..10b39be --- /dev/null +++ b/src/svg/doc/src/qtsvg-index.qdoc @@ -0,0 +1,49 @@ +/**************************************************************************** +** +** 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 Svg Module. +** +** $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$ +** +****************************************************************************/ + +/*! + \title Qt SVG + \page qtsvg-index.html + \brief Qt Svg provides functionality for handling SVG images. + + 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. + + \list + \li \l{Qt Svg C++ Classes} + \endlist + + Qt Svg comes with the following examples: + + \list + \li \l{SVG Generator Example} + \li \l{SVG Viewer Example} + \endlist +*/ + diff --git a/src/svg/doc/src/qtsvg.qdoc b/src/svg/doc/src/qtsvg.qdoc new file mode 100644 index 0000000..ffdc15e --- /dev/null +++ b/src/svg/doc/src/qtsvg.qdoc @@ -0,0 +1,41 @@ +/**************************************************************************** +** +** 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 Svg Module. +** +** $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$ +** +****************************************************************************/ + +/*! + \module QtSvg + \title Qt Svg C++ Classes + \ingroup modules + + \brief The Qt Svg module provides functionality for handling SVG images. + + 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. See the class descriptions for further details. + +*/ + diff --git a/src/svg/qgraphicssvgitem.cpp b/src/svg/qgraphicssvgitem.cpp index 4296af7..ec9bb17 100644 --- a/src/svg/qgraphicssvgitem.cpp +++ b/src/svg/qgraphicssvgitem.cpp @@ -100,6 +100,7 @@ public: /*! \class QGraphicsSvgItem + \inmodule QtSvg \ingroup graphicsview-api \brief The QGraphicsSvgItem class is a QGraphicsItem that can be used to render the contents of SVG files. @@ -122,7 +123,7 @@ public: elements. For example the following code renders only jokers from a SVG file containing a whole card deck: - \snippet doc/src/snippets/code/src_svg_qgraphicssvgitem.cpp 0 + \snippet src_svg_qgraphicssvgitem.cpp 0 Size of the item can be set via the \l{QRectF::setSize()} {setSize()} method of the \l{QGraphicsSvgItem::boundingRect()} @@ -133,7 +134,7 @@ public: mode to speedup the display of items. Caching can be disabled by passing QGraphicsItem::NoCache to the QGraphicsItem::setCacheMode() method. - \sa QSvgWidget, {QtSvg Module}, QGraphicsItem, QGraphicsView + \sa QSvgWidget, {Qt Svg C++ Classes}, QGraphicsItem, QGraphicsView */ /*! diff --git a/src/svg/qsvggenerator.cpp b/src/svg/qsvggenerator.cpp index ef35a21..47f760b 100644 --- a/src/svg/qsvggenerator.cpp +++ b/src/svg/qsvggenerator.cpp @@ -508,6 +508,7 @@ public: /*! \class QSvgGenerator \ingroup painting + \inmodule QtSvg \since 4.3 \brief The QSvgGenerator class provides a paint device that is used to create SVG drawings. \reentrant @@ -520,7 +521,7 @@ public: by setting the \l size property, and in some cases where the drawing will be included in another, the \l viewBox property also needs to be set. - \snippet examples/painting/svggenerator/window.cpp configure SVG generator + \snippet svggenerator/window.cpp configure SVG generator Other meta-data can be specified by setting the \a title, \a description and \a resolution properties. @@ -528,9 +529,9 @@ public: As with other QPaintDevice subclasses, a QPainter object is used to paint onto an instance of this class: - \snippet examples/painting/svggenerator/window.cpp begin painting + \snippet svggenerator/window.cpp begin painting \dots - \snippet examples/painting/svggenerator/window.cpp end painting + \snippet svggenerator/window.cpp end painting Painting is performed in the same way as for any other paint device. However, it is necessary to use the QPainter::begin() and \l{QPainter::}{end()} to @@ -539,7 +540,7 @@ public: The \l{SVG Generator Example} shows how the same painting commands can be used for painting a widget and writing an SVG file. - \sa QSvgRenderer, QSvgWidget, {About SVG} + \sa QSvgRenderer, QSvgWidget, {Qt Svg C++ Classes} */ /*! diff --git a/src/svg/qsvgrenderer.cpp b/src/svg/qsvgrenderer.cpp index 5e054dc..68a97bf 100644 --- a/src/svg/qsvgrenderer.cpp +++ b/src/svg/qsvgrenderer.cpp @@ -55,6 +55,7 @@ QT_BEGIN_NAMESPACE /*! \class QSvgRenderer + \inmodule QtSvg \ingroup painting \brief The QSvgRenderer class is used to draw the contents of SVG files onto paint devices. @@ -98,7 +99,7 @@ QT_BEGIN_NAMESPACE Finally, the QSvgRenderer class provides the repaintNeeded() signal which is emitted whenever the rendering of the document needs to be updated. - \sa QSvgWidget, {QtSvg Module}, {SVG Viewer Example}, QPicture + \sa QSvgWidget, {Qt Svg C++ Classes}, {SVG Viewer Example}, QPicture */ class QSvgRendererPrivate : public QObjectPrivate diff --git a/src/svg/qsvgwidget.cpp b/src/svg/qsvgwidget.cpp index 2050339..698d9d6 100644 --- a/src/svg/qsvgwidget.cpp +++ b/src/svg/qsvgwidget.cpp @@ -52,6 +52,7 @@ QT_BEGIN_NAMESPACE /*! \class QSvgWidget + \inmodule QtSvg \ingroup painting \brief The QSvgWidget class provides a widget that is used to display the contents of @@ -76,7 +77,7 @@ QT_BEGIN_NAMESPACE displays. If no data has been loaded, the widget provides the default QWidget size hint. Subclass this class and reimplement sizeHint() if you need to customize this behavior. - \sa QSvgRenderer, {QtSvg Module}, QPicture + \sa QSvgRenderer, {Qt Svg C++ Classes}, QPicture */ class QSvgWidgetPrivate : public QWidgetPrivate |