API reference - Class QTextDocumentWriter

_const_cast

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

codec

Signature: [const] QTextCodec ptr codec

Description: Method QTextCodec *QTextDocumentWriter::codec()

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

codec=

Signature: void codec= (QTextCodec ptr codec)

Description: Method void QTextDocumentWriter::setCodec(QTextCodec *codec)

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

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

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

Use of this method is deprecated. Use _destroy instead

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

Use of this method is deprecated. Use _destroyed? instead

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.

device

Signature: [const] QIODevice ptr device

Description: Method QIODevice *QTextDocumentWriter::device()

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

device=

Signature: void device= (QIODevice ptr device)

Description: Method void QTextDocumentWriter::setDevice(QIODevice *device)

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

fileName

Signature: [const] string fileName

Description: Method QString QTextDocumentWriter::fileName()

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

fileName=

Signature: void fileName= (string fileName)

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

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

format

Signature: [const] bytes format

Description: Method QByteArray QTextDocumentWriter::format()

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

format=

Signature: void format= (bytes format)

Description: Method void QTextDocumentWriter::setFormat(const QByteArray &format)

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

is_const_object?

Signature: [const] bool is_const_object?

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

Use of this method is deprecated. Use _is_const_object? instead

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

new

(1) Signature: [static] new QTextDocumentWriter new

Description: Constructor QTextDocumentWriter::QTextDocumentWriter()

This method creates an object of class QTextDocumentWriter.

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

(2) Signature: [static] new QTextDocumentWriter new (QIODevice ptr device, bytes format)

Description: Constructor QTextDocumentWriter::QTextDocumentWriter(QIODevice *device, const QByteArray &format)

This method creates an object of class QTextDocumentWriter.

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

(3) Signature: [static] new QTextDocumentWriter new (string fileName, bytes format = QByteArray())

Description: Constructor QTextDocumentWriter::QTextDocumentWriter(const QString &fileName, const QByteArray &format)

This method creates an object of class QTextDocumentWriter.

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

setCodec

Signature: void setCodec (QTextCodec ptr codec)

Description: Method void QTextDocumentWriter::setCodec(QTextCodec *codec)

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

setDevice

Signature: void setDevice (QIODevice ptr device)

Description: Method void QTextDocumentWriter::setDevice(QIODevice *device)

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

setFileName

Signature: void setFileName (string fileName)

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

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

setFormat

Signature: void setFormat (bytes format)

Description: Method void QTextDocumentWriter::setFormat(const QByteArray &format)

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

supportedDocumentFormats

Signature: [static] bytes[] supportedDocumentFormats

Description: Static method QList<QByteArray> QTextDocumentWriter::supportedDocumentFormats()

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

write

(1) Signature: bool write (const QTextDocument ptr document)

Description: Method bool QTextDocumentWriter::write(const QTextDocument *document)

(2) Signature: bool write (const QTextDocumentFragment fragment)

Description: Method bool QTextDocumentWriter::write(const QTextDocumentFragment &fragment)