API reference - Class QPdfWriter

_const_cast

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

asConstQObject

Signature: [const] const QObject ptr asConstQObject

Description: Delivers the base class interface QObject of QPdfWriter

Class QPdfWriter is derived from multiple base classes. This method delivers the QObject base class aspect.

Use this version if you have a const reference.

asConstQPagedPaintDevice

Signature: [const] const QPagedPaintDevice ptr asConstQPagedPaintDevice

Description: Delivers the base class interface QPagedPaintDevice of QPdfWriter

Class QPdfWriter is derived from multiple base classes. This method delivers the QPagedPaintDevice base class aspect.

Use this version if you have a const reference.

asQObject

Signature: QObject ptr asQObject

Description: Delivers the base class interface QObject of QPdfWriter

Class QPdfWriter is derived from multiple base classes. This method delivers the QObject base class aspect.

asQPagedPaintDevice

Signature: QPagedPaintDevice ptr asQPagedPaintDevice

Description: Delivers the base class interface QPagedPaintDevice of QPdfWriter

Class QPdfWriter is derived from multiple base classes. This method delivers the QPagedPaintDevice base class aspect.

childEvent

Signature: void childEvent (QChildEvent ptr event)

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

This method can be reimplemented in a derived class.

creator

Signature: [const] string creator

Description: Method QString QPdfWriter::creator()

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

creator=

Signature: void creator= (string creator)

Description: Method void QPdfWriter::setCreator(const QString &creator)

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

customEvent

Signature: void customEvent (QEvent ptr event)

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

This method can be reimplemented in a derived class.

destroyed

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

Description: Signal declaration for QPdfWriter::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.

devicePageLayout

(1) Signature: [const] QPageLayout devicePageLayout

Description: Method QPageLayout QPdfWriter::devicePageLayout()

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

(2) Signature: QPageLayout devicePageLayout

Description: Method QPageLayout &QPdfWriter::devicePageLayout()

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

disconnectNotify

Signature: void disconnectNotify (const QMetaMethod signal)

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

This method can be reimplemented in a derived class.

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = nullptr)

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

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

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

Call this method to emit this signal.

event

Signature: bool event (QEvent ptr event)

Description: Virtual method bool QPdfWriter::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 QPdfWriter::eventFilter(QObject *watched, QEvent *event)

This method can be reimplemented in a derived class.

initPainter

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

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

This method can be reimplemented in a derived class.

isSignalConnected

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

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

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

metric

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

Description: Virtual method int QPdfWriter::metric(QPaintDevice::PaintDeviceMetric id)

This method can be reimplemented in a derived class.

new

(1) Signature: [static] new QPdfWriter new (string filename)

Description: Constructor QPdfWriter::QPdfWriter(const QString &filename)

This method creates an object of class QPdfWriter.

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

(2) Signature: [static] new QPdfWriter new (QIODevice ptr device)

Description: Constructor QPdfWriter::QPdfWriter(QIODevice *device)

This method creates an object of class QPdfWriter.

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

newPage

Signature: bool newPage

Description: Virtual method bool QPdfWriter::newPage()

This method can be reimplemented in a derived class.

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

Description: Signal declaration for QPdfWriter::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.

pageSize=

Signature: void pageSize= (const QPagedPaintDevice_PageSize size)

Description: Method void QPdfWriter::setPageSize(QPagedPaintDevice::PageSize size)

This is a reimplementation of QPagedPaintDevice::setPageSize

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

paintEngine

Signature: [const] QPaintEngine ptr paintEngine

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

This method can be reimplemented in a derived class.

pdfVersion

Signature: [const] QPagedPaintDevice_PdfVersion pdfVersion

Description: Method QPagedPaintDevice::PdfVersion QPdfWriter::pdfVersion()

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

pdfVersion=

Signature: void pdfVersion= (const QPagedPaintDevice_PdfVersion version)

Description: Method void QPdfWriter::setPdfVersion(QPagedPaintDevice::PdfVersion version)

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

receivers

Signature: [const] int receivers (string signal)

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

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

redirected

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

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

This method can be reimplemented in a derived class.

resolution

Signature: [const] int resolution

Description: Method int QPdfWriter::resolution()

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

resolution=

Signature: void resolution= (int resolution)

Description: Method void QPdfWriter::setResolution(int resolution)

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

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QPdfWriter::sender()

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

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QPdfWriter::senderSignalIndex()

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

setCreator

Signature: void setCreator (string creator)

Description: Method void QPdfWriter::setCreator(const QString &creator)

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

setMargins

Signature: void setMargins (const QPagedPaintDevice_Margins m)

Description: Virtual method void QPdfWriter::setMargins(const QPagedPaintDevice::Margins &m)

This method can be reimplemented in a derived class.

setPageSize

Signature: void setPageSize (const QPagedPaintDevice_PageSize size)

Description: Virtual method void QPdfWriter::setPageSize(QPagedPaintDevice::PageSize size)

This method can be reimplemented in a derived class.

setPageSizeMM

Signature: void setPageSizeMM (const QSizeF size)

Description: Virtual method void QPdfWriter::setPageSizeMM(const QSizeF &size)

This method can be reimplemented in a derived class.

setPdfVersion

Signature: void setPdfVersion (const QPagedPaintDevice_PdfVersion version)

Description: Method void QPdfWriter::setPdfVersion(QPagedPaintDevice::PdfVersion version)

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

setResolution

Signature: void setResolution (int resolution)

Description: Method void QPdfWriter::setResolution(int resolution)

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

setTitle

Signature: void setTitle (string title)

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

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

sharedPainter

Signature: [const] QPainter ptr sharedPainter

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

This method can be reimplemented in a derived class.

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

timerEvent

Signature: void timerEvent (QTimerEvent ptr event)

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

This method can be reimplemented in a derived class.

title

Signature: [const] string title

Description: Method QString QPdfWriter::title()

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

title=

Signature: void title= (string title)

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

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

tr

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

Description: Static method QString QPdfWriter::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 QPdfWriter::trUtf8(const char *s, const char *c, int n)

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