KLayout 0.29.8 (2024-11-26 926dac96c) [master]

API reference - Class QSvgGenerator

Notation used in Ruby API documentation

Module: QtSvg

Description: Binding of QSvgGenerator

Class hierarchy: QSvgGenerator » QPaintDevice

Public constructors

new QSvgGeneratornewConstructor QSvgGenerator::QSvgGenerator()

Public methods

[const]QSvgGenerator ptr_const_castReturns a non-const reference to self.
void_createEnsures the C++ object is created
void_destroyExplicitly destroys the object
[const]bool_destroyed?Returns a value indicating whether the object was already destroyed
[const]bool_is_const_object?Returns a value indicating whether the reference is a const reference
void_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
[const]stringdescriptionMethod QString QSvgGenerator::description()
voiddescription=(string description)Method void QSvgGenerator::setDescription(const QString &description)
[const]stringfileNameMethod QString QSvgGenerator::fileName()
voidfileName=(string fileName)Method void QSvgGenerator::setFileName(const QString &fileName)
[const]QIODevice ptroutputDeviceMethod QIODevice *QSvgGenerator::outputDevice()
voidoutputDevice=(QIODevice ptr outputDevice)Method void QSvgGenerator::setOutputDevice(QIODevice *outputDevice)
[const]intresolutionMethod int QSvgGenerator::resolution()
voidresolution=(int dpi)Method void QSvgGenerator::setResolution(int dpi)
voidsetDescription(string description)Method void QSvgGenerator::setDescription(const QString &description)
voidsetFileName(string fileName)Method void QSvgGenerator::setFileName(const QString &fileName)
voidsetOutputDevice(QIODevice ptr outputDevice)Method void QSvgGenerator::setOutputDevice(QIODevice *outputDevice)
voidsetResolution(int dpi)Method void QSvgGenerator::setResolution(int dpi)
voidsetSize(const QSize size)Method void QSvgGenerator::setSize(const QSize &size)
voidsetTitle(string title)Method void QSvgGenerator::setTitle(const QString &title)
voidsetViewBox(const QRect viewBox)Method void QSvgGenerator::setViewBox(const QRect &viewBox)
voidsetViewBox(const QRectF viewBox)Method void QSvgGenerator::setViewBox(const QRectF &viewBox)
[const]QSizesizeMethod QSize QSvgGenerator::size()
voidsize=(const QSize size)Method void QSvgGenerator::setSize(const QSize &size)
[const]stringtitleMethod QString QSvgGenerator::title()
voidtitle=(string title)Method void QSvgGenerator::setTitle(const QString &title)
[const]QRectviewBoxMethod QRect QSvgGenerator::viewBox()
voidviewBox=(const QRect viewBox)Method void QSvgGenerator::setViewBox(const QRect &viewBox)
voidviewBox=(const QRectF viewBox)Method void QSvgGenerator::setViewBox(const QRectF &viewBox)
[const]QRectFviewBoxFMethod QRectF QSvgGenerator::viewBoxF()

Protected methods (static, non-static and constructors)

[const]voidinitPainter(QPainter ptr painter)Virtual method void QSvgGenerator::initPainter(QPainter *painter)
[const]intmetric(const QPaintDevice_PaintDeviceMetric metric)Virtual method int QSvgGenerator::metric(QPaintDevice::PaintDeviceMetric metric)
[const]QPaintEngine ptrpaintEngineVirtual method QPaintEngine *QSvgGenerator::paintEngine()
[const]QPaintDevice ptrredirected(QPoint ptr offset)Virtual method QPaintDevice *QSvgGenerator::redirected(QPoint *offset)
[const]QPainter ptrsharedPainterVirtual method QPainter *QSvgGenerator::sharedPainter()

Detailed description

_const_cast

Signature: [const] QSvgGenerator ptr _const_cast

Description: Returns a non-const reference to self.

Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.

This method has been introduced in version 0.29.6.

_create

Signature: void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

_destroy

Signature: void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

_destroyed?

Signature: [const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

_is_const_object?

Signature: [const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

_manage

Signature: void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

_unmanage

Signature: void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

description

Signature: [const] string description

Description: Method QString QSvgGenerator::description()

Python specific notes:
The object exposes a readable attribute 'description'. This is the getter.

description=

Signature: void description= (string description)

Description: Method void QSvgGenerator::setDescription(const QString &description)

Python specific notes:
The object exposes a writable attribute 'description'. This is the setter.

fileName

Signature: [const] string fileName

Description: Method QString QSvgGenerator::fileName()

Python specific notes:
The object exposes a readable attribute 'fileName'. This is the getter.

fileName=

Signature: void fileName= (string fileName)

Description: Method void QSvgGenerator::setFileName(const QString &fileName)

Python specific notes:
The object exposes a writable attribute 'fileName'. This is the setter.

initPainter

Signature: [const] void initPainter (QPainter ptr painter)

Description: Virtual method void QSvgGenerator::initPainter(QPainter *painter)

This method can be reimplemented in a derived class.

metric

Signature: [const] int metric (const QPaintDevice_PaintDeviceMetric metric)

Description: Virtual method int QSvgGenerator::metric(QPaintDevice::PaintDeviceMetric metric)

This method can be reimplemented in a derived class.

new

Signature: [static] new QSvgGenerator new

Description: Constructor QSvgGenerator::QSvgGenerator()

This method creates an object of class QSvgGenerator.

Python specific notes:
This method is the default initializer of the object.

outputDevice

Signature: [const] QIODevice ptr outputDevice

Description: Method QIODevice *QSvgGenerator::outputDevice()

Python specific notes:
The object exposes a readable attribute 'outputDevice'. This is the getter.

outputDevice=

Signature: void outputDevice= (QIODevice ptr outputDevice)

Description: Method void QSvgGenerator::setOutputDevice(QIODevice *outputDevice)

Python specific notes:
The object exposes a writable attribute 'outputDevice'. This is the setter.

paintEngine

Signature: [const] QPaintEngine ptr paintEngine

Description: Virtual method QPaintEngine *QSvgGenerator::paintEngine()

This method can be reimplemented in a derived class.

redirected

Signature: [const] QPaintDevice ptr redirected (QPoint ptr offset)

Description: Virtual method QPaintDevice *QSvgGenerator::redirected(QPoint *offset)

This method can be reimplemented in a derived class.

resolution

Signature: [const] int resolution

Description: Method int QSvgGenerator::resolution()

Python specific notes:
The object exposes a readable attribute 'resolution'. This is the getter.

resolution=

Signature: void resolution= (int dpi)

Description: Method void QSvgGenerator::setResolution(int dpi)

Python specific notes:
The object exposes a writable attribute 'resolution'. This is the setter.

setDescription

Signature: void setDescription (string description)

Description: Method void QSvgGenerator::setDescription(const QString &description)

Python specific notes:
The object exposes a writable attribute 'description'. This is the setter.

setFileName

Signature: void setFileName (string fileName)

Description: Method void QSvgGenerator::setFileName(const QString &fileName)

Python specific notes:
The object exposes a writable attribute 'fileName'. This is the setter.

setOutputDevice

Signature: void setOutputDevice (QIODevice ptr outputDevice)

Description: Method void QSvgGenerator::setOutputDevice(QIODevice *outputDevice)

Python specific notes:
The object exposes a writable attribute 'outputDevice'. This is the setter.

setResolution

Signature: void setResolution (int dpi)

Description: Method void QSvgGenerator::setResolution(int dpi)

Python specific notes:
The object exposes a writable attribute 'resolution'. This is the setter.

setSize

Signature: void setSize (const QSize size)

Description: Method void QSvgGenerator::setSize(const QSize &size)

Python specific notes:
The object exposes a writable attribute 'size'. This is the setter.

setTitle

Signature: void setTitle (string title)

Description: Method void QSvgGenerator::setTitle(const QString &title)

Python specific notes:
The object exposes a writable attribute 'title'. This is the setter.

setViewBox

(1) Signature: void setViewBox (const QRect viewBox)

Description: Method void QSvgGenerator::setViewBox(const QRect &viewBox)

Python specific notes:
The object exposes a writable attribute 'viewBox'. This is the setter.

(2) Signature: void setViewBox (const QRectF viewBox)

Description: Method void QSvgGenerator::setViewBox(const QRectF &viewBox)

Python specific notes:
The object exposes a writable attribute 'viewBox'. This is the setter.

sharedPainter

Signature: [const] QPainter ptr sharedPainter

Description: Virtual method QPainter *QSvgGenerator::sharedPainter()

This method can be reimplemented in a derived class.

size

Signature: [const] QSize size

Description: Method QSize QSvgGenerator::size()

Python specific notes:
The object exposes a readable attribute 'size'. This is the getter.

size=

Signature: void size= (const QSize size)

Description: Method void QSvgGenerator::setSize(const QSize &size)

Python specific notes:
The object exposes a writable attribute 'size'. This is the setter.

title

Signature: [const] string title

Description: Method QString QSvgGenerator::title()

Python specific notes:
The object exposes a readable attribute 'title'. This is the getter.

title=

Signature: void title= (string title)

Description: Method void QSvgGenerator::setTitle(const QString &title)

Python specific notes:
The object exposes a writable attribute 'title'. This is the setter.

viewBox

Signature: [const] QRect viewBox

Description: Method QRect QSvgGenerator::viewBox()

Python specific notes:
The object exposes a readable attribute 'viewBox'. This is the getter.

viewBox=

(1) Signature: void viewBox= (const QRect viewBox)

Description: Method void QSvgGenerator::setViewBox(const QRect &viewBox)

Python specific notes:
The object exposes a writable attribute 'viewBox'. This is the setter.

(2) Signature: void viewBox= (const QRectF viewBox)

Description: Method void QSvgGenerator::setViewBox(const QRectF &viewBox)

Python specific notes:
The object exposes a writable attribute 'viewBox'. This is the setter.

viewBoxF

Signature: [const] QRectF viewBoxF

Description: Method QRectF QSvgGenerator::viewBoxF()