summaryrefslogtreecommitdiff
path: root/src/svg/doc/src/svgrendering.qdoc
diff options
context:
space:
mode:
authorJerome Pasion <jerome.pasion@digia.com>2012-11-16 15:58:09 +0100
committerGeir Vattekar <geir.vattekar@digia.com>2012-11-16 18:24:53 +0100
commit9e53ba2cdf507d7f5da69f90a6ccea02312ecf0e (patch)
tree15e339abc48bd0cbee2aaf6563dc7a12aa00e52b /src/svg/doc/src/svgrendering.qdoc
parent1926279f503261ac8438caebde2f22ba09e5d80d (diff)
downloadqtsvg-9e53ba2cdf507d7f5da69f90a6ccea02312ecf0e.tar.gz
Doc: Adding documentation from qtdoc repository
-snippets -license information -overview Change-Id: I75ec50cfd4f1ef3d8753a3c14b34dc748adf9b54 Reviewed-by: Geir Vattekar <geir.vattekar@digia.com>
Diffstat (limited to 'src/svg/doc/src/svgrendering.qdoc')
-rw-r--r--src/svg/doc/src/svgrendering.qdoc78
1 files changed, 78 insertions, 0 deletions
diff --git a/src/svg/doc/src/svgrendering.qdoc b/src/svg/doc/src/svgrendering.qdoc
new file mode 100644
index 0000000..02e4e12
--- /dev/null
+++ b/src/svg/doc/src/svgrendering.qdoc
@@ -0,0 +1,78 @@
+/****************************************************************************
+**
+** 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$
+**
+****************************************************************************/
+
+/*!
+ \page svgrendering.html
+ \title Rendering SVG Files
+ \brief Rendering SVG files with the Qt SVG module
+
+ Qt SVG provides classes for rendering SVG files. To include the definitions
+ of the module's classes, use the following directive:
+
+ \snippet doc_src_qtsvg.cpp 0
+
+ To link against the module, add this line to your \l qmake \c
+ .pro file:
+
+ \snippet doc_src_qtsvg.pro 1
+
+ \section1 Rendering SVG files
+
+ Scalable Vector Graphics (SVG) is a language for describing two-dimensional
+ graphics and graphical applications in XML. SVG 1.1 is a W3C Recommendation
+ and forms the core of the current SVG developments in Qt. SVG 1.2 is the
+ specification currently being developed by the \l{SVG Working Group}, and it
+ is \l{http://www.w3.org/TR/SVG12/}{available in draft form}. The \l{Mobile
+ SVG Profiles} (SVG Basic and SVG Tiny) are aimed at resource-limited devices
+ and are part of the 3GPP platform for third generation mobile phones. You
+ can read more about SVG at \l{About SVG}.
+
+ Qt supports the \l{SVG 1.2 Tiny Static Features}{static features} of
+ \l{SVG 1.2 Tiny}. ECMA scripts and DOM manipulation are currently not
+ supported.
+
+ SVG drawings can be rendered onto any QPaintDevice subclass. This
+ approach gives developers the flexibility to experiment, in order
+ to find the best solution for each application.
+
+ The easiest way to render SVG files is to construct a QSvgWidget and
+ load an SVG file using one of the QSvgWidget::load() functions.
+
+ QSvgRenderer is the class responsible for rendering SVG files for
+ QSvgWidget, and it can be used directly to provide SVG support for
+ custom widgets.
+ To load an SVG file, construct a QSvgRenderer with a file name or the
+ contents of a file, or call QSvgRenderer::load() on an existing
+ renderer. If the SVG file has been loaded successfully the
+ QSvgRenderer::isValid() will return true.
+
+ Once you have loaded the SVG file successfully, you can render it
+ with the QSvgRenderer::render() function. Note that this scheme allows
+ you to render SVG files on all paint devices supported by Qt, including
+ QWidget, QGLWidget, and QImage. See the \l{SVG Viewer Example}{SVG Viewer}
+ example for more details.
+*/