summaryrefslogtreecommitdiff
path: root/src/svg/doc/src/qtsvg-index.qdoc
blob: 6e1d35adb790c3419cc3575b6bd844828cb32ed4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
/****************************************************************************
**
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** 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 The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/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: https://www.gnu.org/licenses/fdl-1.3.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.

    \section1 Getting Started

    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 Module Evolution
    \l{Changes to Qt SVG} lists important changes in the module API
    and functionality that were done for the Qt 6 series of Qt.

    \section1 Licenses and Attributions

    Qt SVG is available under commercial licenses from \l{The Qt Company}.
    In addition, it is available under the
    \l{GNU Lesser General Public License, version 3}, or
    the \l{GNU General Public License, version 2}.
    See \l{Qt Licensing} for further details.

    Furthermore Qt SVG contains third party
    code under following permissive licenses:

    \generatelist{groupsbymodule attributions-qtsvg}

    \section1 Articles
    \list
    \li \l{Rendering SVG Files} contains information about how to
    render SVG files
    \endlist

    \section1 References
    \list
        \li \l{Qt SVG C++ Classes}
        \li \l{Qt SVG Widgets C++ Classes}
    \endlist

    Qt SVG comes with the following examples:

    \list
        \li \l{SVG Generator Example}
        \li \l{SVG Viewer Example}
    \endlist
*/