Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QSvgGenerator Class Reference

\inmodule QtSvg More...

#include <qsvggenerator.h>

Inheritance diagram for QSvgGenerator:
Collaboration diagram for QSvgGenerator:

Public Types

enum class  SvgVersion { SvgTiny12 , Svg11 }
Public Types inherited from QPaintDevice
enum  PaintDeviceMetric {
  PdmWidth = 1 , PdmHeight , PdmWidthMM , PdmHeightMM ,
  PdmNumColors , PdmDepth , PdmDpiX , PdmDpiY ,
  PdmPhysicalDpiX , PdmPhysicalDpiY , PdmDevicePixelRatio , PdmDevicePixelRatioScaled ,
  PdmDevicePixelRatioF_EncodedA , PdmDevicePixelRatioF_EncodedB
}

Public Member Functions

 QSvgGenerator ()
 Constructs a new generator using the SVG Tiny 1.2 profile.
 QSvgGenerator (SvgVersion version)
 ~QSvgGenerator ()
 Destroys the generator.
QString title () const
void setTitle (const QString &title)
QString description () const
void setDescription (const QString &description)
QSize size () const
void setSize (const QSize &size)
QRect viewBox () const
QRectF viewBoxF () const
void setViewBox (const QRect &viewBox)
void setViewBox (const QRectF &viewBox)
QString fileName () const
void setFileName (const QString &fileName)
QIODevice * outputDevice () const
void setOutputDevice (QIODevice *outputDevice)
void setResolution (int dpi)
int resolution () const
SvgVersion svgVersion () const
Public Member Functions inherited from QPaintDevice
virtual ~QPaintDevice ()
virtual int devType () const
bool paintingActive () const
int width () const
int height () const
int widthMM () const
int heightMM () const
int logicalDpiX () const
int logicalDpiY () const
int physicalDpiX () const
int physicalDpiY () const
qreal devicePixelRatio () const
qreal devicePixelRatioF () const
int colorCount () const
int depth () const

Protected Member Functions

QPaintEngine * paintEngine () const override
 Returns the paint engine used to render graphics to be converted to SVG format information.
int metric (QPaintDevice::PaintDeviceMetric metric) const override
 \reimp
Protected Member Functions inherited from QPaintDevice
 QPaintDevice () noexcept
virtual void initPainter (QPainter *painter) const
virtual QPaintDevice * redirected (QPoint *offset) const
virtual QPainter * sharedPainter () const
double getDecodedMetricF (PaintDeviceMetric metricA, PaintDeviceMetric metricB) const

Properties

QSize size
 the size of the generated SVG drawing
QRectF viewBox
 the viewBox of the generated SVG drawing
QString title
 the title of the generated SVG drawing
QString description
 the description of the generated SVG drawing
QString fileName
 the target filename for the generated SVG drawing
QIODevice * outputDevice
 the output device for the generated SVG drawing
int resolution
 the resolution of the generated output

Additional Inherited Members

Static Public Member Functions inherited from QPaintDevice
static qreal devicePixelRatioFScale ()
static int encodeMetricF (PaintDeviceMetric metric, double value)
Protected Attributes inherited from QPaintDevice
ushort painters

Detailed Description

\inmodule QtSvg

Since
4.3

The QSvgGenerator class provides a paint device that is used to create SVG drawings. \reentrant

This paint device represents a Scalable Vector Graphics (SVG) drawing. Like QPrinter, it is designed as a write-only device that generates output in a specific format.

To write an SVG file, you first need to configure the output by setting the \l fileName or \l outputDevice properties. It is usually necessary to specify the size of the drawing 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.

Other meta-data can be specified by setting the title, description and resolution properties.

As with other QPaintDevice subclasses, a QPainter object is used to paint onto an instance of this class:

\dots

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 explicitly begin and end painting on the device.

See also
QSvgRenderer, QSvgWidget, {Qt SVG C++ Classes}

Definition at line 22 of file qsvggenerator.h.

Member Enumeration Documentation

◆ SvgVersion

enum class QSvgGenerator::SvgVersion
strong
Since
6.5

This enumeration describes the version of the SVG output of the generator.

\value SvgTiny12 The generated document follows the SVG Tiny 1.2 specification. \value Svg11 The generated document follows the SVG 1.1 specification.

Enumerator
SvgTiny12 
Svg11 

Definition at line 35 of file qsvggenerator.h.

Constructor & Destructor Documentation

◆ QSvgGenerator() [1/2]

QSvgGenerator::QSvgGenerator ( )

Constructs a new generator using the SVG Tiny 1.2 profile.

Definition at line 606 of file qsvggenerator.cpp.

◆ QSvgGenerator() [2/2]

QSvgGenerator::QSvgGenerator ( SvgVersion version)
explicit
Since
6.5

Constructs a new generator that uses the SVG version version.

Definition at line 616 of file qsvggenerator.cpp.

◆ ~QSvgGenerator()

QSvgGenerator::~QSvgGenerator ( )

Destroys the generator.

Definition at line 628 of file qsvggenerator.cpp.

Member Function Documentation

◆ description()

QString QSvgGenerator::description ( ) const

Definition at line 662 of file qsvggenerator.cpp.

◆ fileName()

QString QSvgGenerator::fileName ( ) const

Definition at line 761 of file qsvggenerator.cpp.

◆ metric()

int QSvgGenerator::metric ( QPaintDevice::PaintDeviceMetric metric) const
overrideprotectedvirtual

\reimp

Reimplemented from QPaintDevice.

Definition at line 860 of file qsvggenerator.cpp.

◆ outputDevice()

QIODevice * QSvgGenerator::outputDevice ( ) const

Definition at line 795 of file qsvggenerator.cpp.

◆ paintEngine()

QPaintEngine * QSvgGenerator::paintEngine ( ) const
overrideprotectedvirtual

Returns the paint engine used to render graphics to be converted to SVG format information.

Implements QPaintDevice.

Definition at line 851 of file qsvggenerator.cpp.

◆ resolution()

int QSvgGenerator::resolution ( ) const

Definition at line 823 of file qsvggenerator.cpp.

◆ setDescription()

void QSvgGenerator::setDescription ( const QString & description)

Definition at line 669 of file qsvggenerator.cpp.

◆ setFileName()

void QSvgGenerator::setFileName ( const QString & fileName)

Definition at line 767 of file qsvggenerator.cpp.

◆ setOutputDevice()

void QSvgGenerator::setOutputDevice ( QIODevice * outputDevice)

Definition at line 801 of file qsvggenerator.cpp.

◆ setResolution()

void QSvgGenerator::setResolution ( int dpi)

Definition at line 829 of file qsvggenerator.cpp.

◆ setSize()

void QSvgGenerator::setSize ( const QSize & size)

Definition at line 696 of file qsvggenerator.cpp.

◆ setTitle()

void QSvgGenerator::setTitle ( const QString & title)

Definition at line 649 of file qsvggenerator.cpp.

◆ setViewBox() [1/2]

void QSvgGenerator::setViewBox ( const QRect & viewBox)

Definition at line 749 of file qsvggenerator.cpp.

◆ setViewBox() [2/2]

void QSvgGenerator::setViewBox ( const QRectF & viewBox)

Definition at line 739 of file qsvggenerator.cpp.

◆ size()

QSize QSvgGenerator::size ( ) const

Definition at line 690 of file qsvggenerator.cpp.

◆ svgVersion()

QSvgGenerator::SvgVersion QSvgGenerator::svgVersion ( ) const
Since
6.5

Returns the version of the SVG document that this generator is producing.

Definition at line 841 of file qsvggenerator.cpp.

◆ title()

QString QSvgGenerator::title ( ) const

Definition at line 642 of file qsvggenerator.cpp.

◆ viewBox()

QRect QSvgGenerator::viewBox ( ) const
Since
4.5

Returns viewBoxF().toRect().

See also
viewBoxF()

Definition at line 733 of file qsvggenerator.cpp.

◆ viewBoxF()

QRectF QSvgGenerator::viewBoxF ( ) const

Definition at line 720 of file qsvggenerator.cpp.

Property Documentation

◆ description

QString QSvgGenerator::description
readwrite

the description of the generated SVG drawing

Since
4.5
See also
title

Definition at line 30 of file qsvggenerator.h.

◆ fileName

QString QSvgGenerator::fileName
readwrite

the target filename for the generated SVG drawing

Since
4.5
See also
outputDevice

Definition at line 31 of file qsvggenerator.h.

◆ outputDevice

QIODevice* QSvgGenerator::outputDevice
readwrite

the output device for the generated SVG drawing

Since
4.5

If both output device and file name are specified, the output device will have precedence.

See also
fileName

Definition at line 32 of file qsvggenerator.h.

◆ resolution

int QSvgGenerator::resolution
readwrite

the resolution of the generated output

Since
4.5

The resolution is specified in dots per inch, and is used to calculate the physical size of an SVG drawing.

See also
size, viewBox

Definition at line 33 of file qsvggenerator.h.

◆ size

QSize QSvgGenerator::size
readwrite

the size of the generated SVG drawing

Since
4.5

By default this property is set to {QSize(-1, -1)}, which indicates that the generator should not output the width and height attributes of the <svg> element.

Note
It is not possible to change this property while a QPainter is active on the generator.
See also
viewBox, resolution

Definition at line 27 of file qsvggenerator.h.

◆ title

QString QSvgGenerator::title
readwrite

the title of the generated SVG drawing

Since
4.5
See also
description

Definition at line 29 of file qsvggenerator.h.

◆ viewBox

QRectF QSvgGenerator::viewBox
readwrite

the viewBox of the generated SVG drawing

Since
4.5

By default this property is set to {QRect(0, 0, -1, -1)}, which indicates that the generator should not output the viewBox attribute of the <svg> element.

Note
It is not possible to change this property while a QPainter is active on the generator.
See also
viewBox(), size, resolution

Definition at line 28 of file qsvggenerator.h.

The documentation for this class was generated from the following files: