API reference - Class QSvgRenderer

_const_cast

Signature: [const] QSvgRenderer 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.

animated

Signature: [const] bool animated

Description: Method bool QSvgRenderer::animated()

animationDuration

Signature: [const] int animationDuration

Description: Method int QSvgRenderer::animationDuration()

boundsOnElement

Signature: [const] QRectF boundsOnElement (string id)

Description: Method QRectF QSvgRenderer::boundsOnElement(const QString &id)

childEvent

Signature: void childEvent (QChildEvent ptr event)

Description: Virtual method void QSvgRenderer::childEvent(QChildEvent *event)

This method can be reimplemented in a derived class.

currentFrame

Signature: [const] int currentFrame

Description: Method int QSvgRenderer::currentFrame()

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

currentFrame=

Signature: void currentFrame= (int arg1)

Description: Method void QSvgRenderer::setCurrentFrame(int)

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

customEvent

Signature: void customEvent (QEvent ptr event)

Description: Virtual method void QSvgRenderer::customEvent(QEvent *event)

This method can be reimplemented in a derived class.

defaultSize

Signature: [const] QSize defaultSize

Description: Method QSize QSvgRenderer::defaultSize()

destroyed

Signature: [signal] void destroyed (QObject ptr arg1)

Description: Signal declaration for QSvgRenderer::destroyed(QObject *)

You can bind a procedure to this signal.

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

disconnectNotify

Signature: void disconnectNotify (const QMetaMethod signal)

Description: Virtual method void QSvgRenderer::disconnectNotify(const QMetaMethod &signal)

This method can be reimplemented in a derived class.

elementExists

Signature: [const] bool elementExists (string id)

Description: Method bool QSvgRenderer::elementExists(const QString &id)

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = nullptr)

Description: Emitter for signal void QSvgRenderer::destroyed(QObject *)

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

Description: Emitter for signal void QSvgRenderer::objectNameChanged(const QString &objectName)

Call this method to emit this signal.

emit_repaintNeeded

Signature: void emit_repaintNeeded

Description: Emitter for signal void QSvgRenderer::repaintNeeded()

Call this method to emit this signal.

event

Signature: bool event (QEvent ptr event)

Description: Virtual method bool QSvgRenderer::event(QEvent *event)

This method can be reimplemented in a derived class.

eventFilter

Signature: bool eventFilter (QObject ptr watched, QEvent ptr event)

Description: Virtual method bool QSvgRenderer::eventFilter(QObject *watched, QEvent *event)

This method can be reimplemented in a derived class.

framesPerSecond

Signature: [const] int framesPerSecond

Description: Method int QSvgRenderer::framesPerSecond()

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

framesPerSecond=

Signature: void framesPerSecond= (int num)

Description: Method void QSvgRenderer::setFramesPerSecond(int num)

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

isSignalConnected

Signature: [const] bool isSignalConnected (const QMetaMethod signal)

Description: Method bool QSvgRenderer::isSignalConnected(const QMetaMethod &signal)

This method is protected and can only be called from inside a derived class.

isValid?

Signature: [const] bool isValid?

Description: Method bool QSvgRenderer::isValid()

load

(1) Signature: bool load (string filename)

Description: Method bool QSvgRenderer::load(const QString &filename)

(2) Signature: bool load (bytes contents)

Description: Method bool QSvgRenderer::load(const QByteArray &contents)

(3) Signature: bool load (QXmlStreamReader ptr contents)

Description: Method bool QSvgRenderer::load(QXmlStreamReader *contents)

matrixForElement

Signature: [const] QMatrix matrixForElement (string id)

Description: Method QMatrix QSvgRenderer::matrixForElement(const QString &id)

new

(1) Signature: [static] new QSvgRenderer new (QObject ptr parent = nullptr)

Description: Constructor QSvgRenderer::QSvgRenderer(QObject *parent)

This method creates an object of class QSvgRenderer.

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

(2) Signature: [static] new QSvgRenderer new (string filename, QObject ptr parent = nullptr)

Description: Constructor QSvgRenderer::QSvgRenderer(const QString &filename, QObject *parent)

This method creates an object of class QSvgRenderer.

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

(3) Signature: [static] new QSvgRenderer new (bytes contents, QObject ptr parent = nullptr)

Description: Constructor QSvgRenderer::QSvgRenderer(const QByteArray &contents, QObject *parent)

This method creates an object of class QSvgRenderer.

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

(4) Signature: [static] new QSvgRenderer new (QXmlStreamReader ptr contents, QObject ptr parent = nullptr)

Description: Constructor QSvgRenderer::QSvgRenderer(QXmlStreamReader *contents, QObject *parent)

This method creates an object of class QSvgRenderer.

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

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

Description: Signal declaration for QSvgRenderer::objectNameChanged(const QString &objectName)

You can bind a procedure to this signal.

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

receivers

Signature: [const] int receivers (string signal)

Description: Method int QSvgRenderer::receivers(const char *signal)

This method is protected and can only be called from inside a derived class.

render

(1) Signature: void render (QPainter ptr p)

Description: Method void QSvgRenderer::render(QPainter *p)

(2) Signature: void render (QPainter ptr p, const QRectF bounds)

Description: Method void QSvgRenderer::render(QPainter *p, const QRectF &bounds)

(3) Signature: void render (QPainter ptr p, string elementId, const QRectF bounds = QRectF())

Description: Method void QSvgRenderer::render(QPainter *p, const QString &elementId, const QRectF &bounds)

repaintNeeded

Signature: [signal] void repaintNeeded

Description: Signal declaration for QSvgRenderer::repaintNeeded()

You can bind a procedure to this signal.

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

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QSvgRenderer::sender()

This method is protected and can only be called from inside a derived class.

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QSvgRenderer::senderSignalIndex()

This method is protected and can only be called from inside a derived class.

setCurrentFrame

Signature: void setCurrentFrame (int arg1)

Description: Method void QSvgRenderer::setCurrentFrame(int)

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

setFramesPerSecond

Signature: void setFramesPerSecond (int num)

Description: Method void QSvgRenderer::setFramesPerSecond(int num)

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

setViewBox

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

Description: Method void QSvgRenderer::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 QSvgRenderer::setViewBox(const QRectF &viewbox)

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

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

timerEvent

Signature: void timerEvent (QTimerEvent ptr event)

Description: Virtual method void QSvgRenderer::timerEvent(QTimerEvent *event)

This method can be reimplemented in a derived class.

tr

Signature: [static] string tr (string s, string c = nullptr, int n = -1)

Description: Static method QString QSvgRenderer::tr(const char *s, const char *c, int n)

This method is static and can be called without an instance.

trUtf8

Signature: [static] string trUtf8 (string s, string c = nullptr, int n = -1)

Description: Static method QString QSvgRenderer::trUtf8(const char *s, const char *c, int n)

This method is static and can be called without an instance.

viewBox

Signature: [const] QRect viewBox

Description: Method QRect QSvgRenderer::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 QSvgRenderer::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 QSvgRenderer::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 QSvgRenderer::viewBoxF()