KLayout 0.29.8 (2024-10-28 63dd591e5) [master]

API reference - Class QBitmap

Notation used in Ruby API documentation

Module: QtGui

Description: Binding of QBitmap

Class hierarchy: QBitmap » QPixmap » QPaintDevice

Public constructors

new QBitmapnewConstructor QBitmap::QBitmap()
new QBitmapnew(const QPixmap arg1)Constructor QBitmap::QBitmap(const QPixmap &)
new QBitmapnew(int w,
int h)
Constructor QBitmap::QBitmap(int w, int h)
new QBitmapnew(const QSize arg1)Constructor QBitmap::QBitmap(const QSize &)
new QBitmapnew(string fileName,
string format = nullptr)
Constructor QBitmap::QBitmap(const QString &fileName, const char *format)
new QBitmapnew(const QBitmap other)Constructor QBitmap::QBitmap(const QBitmap &other)

Public methods

void_assign(const QBitmap other)Assigns another object to self
[const]QBitmap ptr_const_castReturns a non-const reference to self.
void_createEnsures the C++ object is created
void_destroyExplicitly destroys the object
[const]bool_destroyed?Returns a value indicating whether the object was already destroyed
[const]new QBitmap ptr_dupCreates a copy of self
[const]bool_is_const_object?Returns a value indicating whether the reference is a const reference
void_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
QBitmapassign(const QBitmap other)Method QBitmap &QBitmap::operator=(const QBitmap &other)
QBitmapassign(const QPixmap arg1)Method QBitmap &QBitmap::operator=(const QPixmap &)
voidclearMethod void QBitmap::clear()
[const]new QBitmap ptrdupCreates a copy of self
[const]QPaintEngine ptrpaintEngineVirtual method QPaintEngine *QBitmap::paintEngine()
voidswap(QBitmap other)Method void QBitmap::swap(QBitmap &other)
[const]QBitmaptransformed(const QMatrix arg1)Method QBitmap QBitmap::transformed(const QMatrix &)
[const]QBitmaptransformed(const QTransform matrix)Method QBitmap QBitmap::transformed(const QTransform &matrix)

Public static methods and constants

QBitmapfromData(const QSize size,
string bits,
const QImage_Format monoFormat = QImage::Format_MonoLSB)
Static method QBitmap QBitmap::fromData(const QSize &size, const unsigned char *bits, QImage::Format monoFormat)
QBitmapfromImage(const QImage image,
Qt_QFlags_ImageConversionFlag flags = Qt::AutoColor)
Static method QBitmap QBitmap::fromImage(const QImage &image, QFlags<Qt::ImageConversionFlag> flags)

Protected methods (static, non-static and constructors)

[static]QPixmapfromImageInPlace(QImage image,
Qt_QFlags_ImageConversionFlag flags = Qt::AutoColor)
Method QPixmap QBitmap::fromImageInPlace(QImage &image, QFlags<Qt::ImageConversionFlag> flags)
[const]voidinitPainter(QPainter ptr painter)Virtual method void QBitmap::initPainter(QPainter *painter)
[const]intmetric(const QPaintDevice_PaintDeviceMetric arg1)Virtual method int QBitmap::metric(QPaintDevice::PaintDeviceMetric)
[const]QPaintDevice ptrredirected(QPoint ptr offset)Virtual method QPaintDevice *QBitmap::redirected(QPoint *offset)
[const]QPainter ptrsharedPainterVirtual method QPainter *QBitmap::sharedPainter()

Deprecated methods (protected, public, static, non-static and constructors)

voidcreateUse of this method is deprecated. Use _create instead
voiddestroyUse of this method is deprecated. Use _destroy instead
[const]booldestroyed?Use of this method is deprecated. Use _destroyed? instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead

Detailed description

_assign

Signature: void _assign (const QBitmap other)

Description: Assigns another object to self

_const_cast

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

_dup

Signature: [const] new QBitmap ptr _dup

Description: Creates a copy of self

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

assign

(1) Signature: QBitmap assign (const QBitmap other)

Description: Method QBitmap &QBitmap::operator=(const QBitmap &other)

(2) Signature: QBitmap assign (const QPixmap arg1)

Description: Method QBitmap &QBitmap::operator=(const QPixmap &)

clear

Signature: void clear

Description: Method void QBitmap::clear()

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.

dup

Signature: [const] new QBitmap ptr dup

Description: Creates a copy of self

Python specific notes:
This method also implements '__copy__' and '__deepcopy__'.

fromData

Signature: [static] QBitmap fromData (const QSize size, string bits, const QImage_Format monoFormat = QImage::Format_MonoLSB)

Description: Static method QBitmap QBitmap::fromData(const QSize &size, const unsigned char *bits, QImage::Format monoFormat)

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

fromImage

Signature: [static] QBitmap fromImage (const QImage image, Qt_QFlags_ImageConversionFlag flags = Qt::AutoColor)

Description: Static method QBitmap QBitmap::fromImage(const QImage &image, QFlags<Qt::ImageConversionFlag> flags)

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

fromImageInPlace

Signature: [static] QPixmap fromImageInPlace (QImage image, Qt_QFlags_ImageConversionFlag flags = Qt::AutoColor)

Description: Method QPixmap QBitmap::fromImageInPlace(QImage &image, QFlags<Qt::ImageConversionFlag> flags)

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

initPainter

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

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

This method can be reimplemented in a derived class.

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.

metric

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

Description: Virtual method int QBitmap::metric(QPaintDevice::PaintDeviceMetric)

This method can be reimplemented in a derived class.

new

(1) Signature: [static] new QBitmap new

Description: Constructor QBitmap::QBitmap()

This method creates an object of class QBitmap.

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

(2) Signature: [static] new QBitmap new (const QPixmap arg1)

Description: Constructor QBitmap::QBitmap(const QPixmap &)

This method creates an object of class QBitmap.

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

(3) Signature: [static] new QBitmap new (int w, int h)

Description: Constructor QBitmap::QBitmap(int w, int h)

This method creates an object of class QBitmap.

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

(4) Signature: [static] new QBitmap new (const QSize arg1)

Description: Constructor QBitmap::QBitmap(const QSize &)

This method creates an object of class QBitmap.

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

(5) Signature: [static] new QBitmap new (string fileName, string format = nullptr)

Description: Constructor QBitmap::QBitmap(const QString &fileName, const char *format)

This method creates an object of class QBitmap.

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

(6) Signature: [static] new QBitmap new (const QBitmap other)

Description: Constructor QBitmap::QBitmap(const QBitmap &other)

This method creates an object of class QBitmap.

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

paintEngine

Signature: [const] QPaintEngine ptr paintEngine

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

This method can be reimplemented in a derived class.

redirected

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

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

This method can be reimplemented in a derived class.

sharedPainter

Signature: [const] QPainter ptr sharedPainter

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

This method can be reimplemented in a derived class.

swap

Signature: void swap (QBitmap other)

Description: Method void QBitmap::swap(QBitmap &other)

transformed

(1) Signature: [const] QBitmap transformed (const QMatrix arg1)

Description: Method QBitmap QBitmap::transformed(const QMatrix &)

(2) Signature: [const] QBitmap transformed (const QTransform matrix)

Description: Method QBitmap QBitmap::transformed(const QTransform &matrix)