KLayout Manual: Main Index » Class Index » API reference - Class QTextDocumentWriter

API reference - Class QTextDocumentWriter

Description: Binding of QTextDocumentWriter

Public constructors
Public methods
Public static methods and constants
Detailed description

Public constructors

new QTextDocumentWriter	new		Constructor QTextDocumentWriter::QTextDocumentWriter()
new QTextDocumentWriter	new	(QIODevice ptr device, string format)	Constructor QTextDocumentWriter::QTextDocumentWriter(QIODevice *device, const QByteArray &format)
new QTextDocumentWriter	new	(string fileName, string format = QByteArray())	Constructor QTextDocumentWriter::QTextDocumentWriter(const QString &fileName, const QByteArray &format)

Public methods

[const]	QTextCodec ptr	codec		Method QTextCodec *QTextDocumentWriter::codec()
	void	codec=	(QTextCodec ptr codec)	Method void QTextDocumentWriter::setCodec(QTextCodec *codec)
	void	create		Ensures the C++ object is created
	void	destroy		Explicitly destroy the object
[const]	bool	destroyed?		Returns a value indicating whether the object was already destroyed
[const]	QIODevice ptr	device		Method QIODevice *QTextDocumentWriter::device()
	void	device=	(QIODevice ptr device)	Method void QTextDocumentWriter::setDevice(QIODevice *device)
[const]	string	fileName		Method QString QTextDocumentWriter::fileName()
	void	fileName=	(string fileName)	Method void QTextDocumentWriter::setFileName(const QString &fileName)
[const]	string	format		Method QByteArray QTextDocumentWriter::format()
	void	format=	(string format)	Method void QTextDocumentWriter::setFormat(const QByteArray &format)
[const]	bool	is_const_object?		Returns a value indicating whether the reference is a const reference
	void	setCodec	(QTextCodec ptr codec)	Method void QTextDocumentWriter::setCodec(QTextCodec *codec)
	void	setDevice	(QIODevice ptr device)	Method void QTextDocumentWriter::setDevice(QIODevice *device)
	void	setFileName	(string fileName)	Method void QTextDocumentWriter::setFileName(const QString &fileName)
	void	setFormat	(string format)	Method void QTextDocumentWriter::setFormat(const QByteArray &format)
	bool	write	(const QTextDocument ptr document)	Method bool QTextDocumentWriter::write(const QTextDocument *document)
	bool	write	(const QTextDocumentFragment fragment)	Method bool QTextDocumentWriter::write(const QTextDocumentFragment &fragment)

Public static methods and constants

string[]

supportedDocumentFormats

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

Detailed description

[const] QTextCodec ptr codec

Description: Method QTextCodec *QTextDocumentWriter::codec()

void codec=(QTextCodec ptr codec)

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

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.

void destroy

Description: Explicitly destroy the object

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

[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.

[const] QIODevice ptr device

Description: Method QIODevice *QTextDocumentWriter::device()

void device=(QIODevice ptr device)

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

[const] string fileName

Description: Method QString QTextDocumentWriter::fileName()

void fileName=(string fileName)

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

[const] string format

Description: Method QByteArray QTextDocumentWriter::format()

void format=(string format)

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

[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.

[static] new QTextDocumentWriter new

Description: Constructor QTextDocumentWriter::QTextDocumentWriter()

This method creates an object of class QTextDocumentWriter.

[static] new QTextDocumentWriter new(QIODevice ptr device,string format)

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

This method creates an object of class QTextDocumentWriter.

[static] new QTextDocumentWriter new(string fileName,string format = QByteArray())

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

This method creates an object of class QTextDocumentWriter.

void setCodec(QTextCodec ptr codec)

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

void setDevice(QIODevice ptr device)

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

void setFileName(string fileName)

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

void setFormat(string format)

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

[static] string[] supportedDocumentFormats

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

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

bool write(const QTextDocument ptr document)

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

bool write(const QTextDocumentFragment fragment)

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