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

API reference - Class QImageWriter

Notation used in Ruby API documentation

Description: Binding of QImageWriter

• Public constructors
• Public methods
• Public static methods and constants
• Detailed description

Public constructors

Public methods

Public static methods and constants

Detailed description

[static] QImageWriter_ImageWriterError DeviceError

Description: Enum constant QImageWriter::DeviceError

[static] QImageWriter_ImageWriterError UnknownError

Description: Enum constant QImageWriter::UnknownError

[static] QImageWriter_ImageWriterError UnsupportedFormatError

Description: Enum constant QImageWriter::UnsupportedFormatError

[const] bool canWrite

Description: Method bool QImageWriter::canWrite()

[const] int compression

Description: Method int QImageWriter::compression()

void compression=(int compression)

Description: Method void QImageWriter::setCompression(int compression)

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.

[const] string description

Description: Method QString QImageWriter::description()

void description=(string description)

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

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 *QImageWriter::device()

void device=(QIODevice ptr device)

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

[const] QImageWriter_ImageWriterError error

Description: Method QImageWriter::ImageWriterError QImageWriter::error()

[const] string errorString

Description: Method QString QImageWriter::errorString()

[const] string fileName

Description: Method QString QImageWriter::fileName()

void fileName=(string fileName)

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

[const] string format

Description: Method QByteArray QImageWriter::format()

void format=(string format)

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

[const] float gamma

Description: Method float QImageWriter::gamma()

void gamma=(float gamma)

Description: Method void QImageWriter::setGamma(float gamma)

[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 QImageWriter new

Description: Constructor QImageWriter::QImageWriter()

This method creates an object of class QImageWriter.

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

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

This method creates an object of class QImageWriter.

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

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

This method creates an object of class QImageWriter.

[const] int quality

Description: Method int QImageWriter::quality()

void quality=(int quality)

Description: Method void QImageWriter::setQuality(int quality)

void setCompression(int compression)

Description: Method void QImageWriter::setCompression(int compression)

void setDescription(string description)

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

void setDevice(QIODevice ptr device)

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

void setFileName(string fileName)

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

void setFormat(string format)

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

void setGamma(float gamma)

Description: Method void QImageWriter::setGamma(float gamma)

void setQuality(int quality)

Description: Method void QImageWriter::setQuality(int quality)

void setText(string key,string text)

Description: Method void QImageWriter::setText(const QString &key, const QString &text)

[static] string[] supportedImageFormats

Description: Static method QList<QByteArray> QImageWriter::supportedImageFormats()

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

[const] bool supportsOption(const QImageIOHandler_ImageOption option)

Description: Method bool QImageWriter::supportsOption(QImageIOHandler::ImageOption option)

bool write(const QImage image)

Description: Method bool QImageWriter::write(const QImage &image)