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

API reference - Class QBrush

Notation used in Ruby API documentation

Module: QtGui

Description: Binding of QBrush

Public constructors

new QBrushnewConstructor QBrush::QBrush()
new QBrushnew(const Qt_BrushStyle bs)Constructor QBrush::QBrush(Qt::BrushStyle bs)
new QBrushnew(const QColor color,
const Qt_BrushStyle bs = Qt::SolidPattern)
Constructor QBrush::QBrush(const QColor &color, Qt::BrushStyle bs)
new QBrushnew(const Qt_GlobalColor color,
const Qt_BrushStyle bs = Qt::SolidPattern)
Constructor QBrush::QBrush(Qt::GlobalColor color, Qt::BrushStyle bs)
new QBrushnew(const QColor color,
const QPixmap pixmap)
Constructor QBrush::QBrush(const QColor &color, const QPixmap &pixmap)
new QBrushnew(const Qt_GlobalColor color,
const QPixmap pixmap)
Constructor QBrush::QBrush(Qt::GlobalColor color, const QPixmap &pixmap)
new QBrushnew(const QPixmap pixmap)Constructor QBrush::QBrush(const QPixmap &pixmap)
new QBrushnew(const QImage image)Constructor QBrush::QBrush(const QImage &image)
new QBrushnew(const QBrush brush)Constructor QBrush::QBrush(const QBrush &brush)
new QBrushnew(const QGradient gradient)Constructor QBrush::QBrush(const QGradient &gradient)

Public methods

[const]bool!=(const QBrush b)Method bool QBrush::operator!=(const QBrush &b)
[const]bool==(const QBrush b)Method bool QBrush::operator==(const QBrush &b)
void_assign(const QBrush other)Assigns another object to self
[const]QBrush 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]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.
QBrushassign(const QBrush brush)Method QBrush &QBrush::operator=(const QBrush &brush)
[const]QColorcolorMethod const QColor &QBrush::color()
voidcolor=(const QColor color)Method void QBrush::setColor(const QColor &color)
voidcolor=(const Qt_GlobalColor color)Method void QBrush::setColor(Qt::GlobalColor color)
[const]new QBrush ptrdupCreates a copy of self
[const]const QGradient ptrgradientMethod const QGradient *QBrush::gradient()
[const]boolisDetached?Method bool QBrush::isDetached()
[const]boolisOpaque?Method bool QBrush::isOpaque()
[const]QMatrixmatrixMethod const QMatrix &QBrush::matrix()
voidmatrix=(const QMatrix mat)Method void QBrush::setMatrix(const QMatrix &mat)
voidsetColor(const QColor color)Method void QBrush::setColor(const QColor &color)
voidsetColor(const Qt_GlobalColor color)Method void QBrush::setColor(Qt::GlobalColor color)
voidsetMatrix(const QMatrix mat)Method void QBrush::setMatrix(const QMatrix &mat)
voidsetStyle(const Qt_BrushStyle arg1)Method void QBrush::setStyle(Qt::BrushStyle)
voidsetTexture(const QPixmap pixmap)Method void QBrush::setTexture(const QPixmap &pixmap)
voidsetTextureImage(const QImage image)Method void QBrush::setTextureImage(const QImage &image)
voidsetTransform(const QTransform arg1)Method void QBrush::setTransform(const QTransform &)
[const]Qt_BrushStylestyleMethod Qt::BrushStyle QBrush::style()
voidstyle=(const Qt_BrushStyle arg1)Method void QBrush::setStyle(Qt::BrushStyle)
[const]QPixmaptextureMethod QPixmap QBrush::texture()
voidtexture=(const QPixmap pixmap)Method void QBrush::setTexture(const QPixmap &pixmap)
[const]QImagetextureImageMethod QImage QBrush::textureImage()
voidtextureImage=(const QImage image)Method void QBrush::setTextureImage(const QImage &image)
[const]QTransformtransformMethod QTransform QBrush::transform()
voidtransform=(const QTransform arg1)Method void QBrush::setTransform(const QTransform &)

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

!=

Signature: [const] bool != (const QBrush b)

Description: Method bool QBrush::operator!=(const QBrush &b)

==

Signature: [const] bool == (const QBrush b)

Description: Method bool QBrush::operator==(const QBrush &b)

_assign

Signature: void _assign (const QBrush other)

Description: Assigns another object to self

_const_cast

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

assign

Signature: QBrush assign (const QBrush brush)

Description: Method QBrush &QBrush::operator=(const QBrush &brush)

color

Signature: [const] QColor color

Description: Method const QColor &QBrush::color()

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

color=

(1) Signature: void color= (const QColor color)

Description: Method void QBrush::setColor(const QColor &color)

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

(2) Signature: void color= (const Qt_GlobalColor color)

Description: Method void QBrush::setColor(Qt::GlobalColor color)

Python specific notes:
The object exposes a writable attribute 'color'. 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.

dup

Signature: [const] new QBrush ptr dup

Description: Creates a copy of self

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

gradient

Signature: [const] const QGradient ptr gradient

Description: Method const QGradient *QBrush::gradient()

isDetached?

Signature: [const] bool isDetached?

Description: Method bool QBrush::isDetached()

isOpaque?

Signature: [const] bool isOpaque?

Description: Method bool QBrush::isOpaque()

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.

matrix

Signature: [const] QMatrix matrix

Description: Method const QMatrix &QBrush::matrix()

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

matrix=

Signature: void matrix= (const QMatrix mat)

Description: Method void QBrush::setMatrix(const QMatrix &mat)

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

new

(1) Signature: [static] new QBrush new

Description: Constructor QBrush::QBrush()

This method creates an object of class QBrush.

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

(2) Signature: [static] new QBrush new (const Qt_BrushStyle bs)

Description: Constructor QBrush::QBrush(Qt::BrushStyle bs)

This method creates an object of class QBrush.

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

(3) Signature: [static] new QBrush new (const QColor color, const Qt_BrushStyle bs = Qt::SolidPattern)

Description: Constructor QBrush::QBrush(const QColor &color, Qt::BrushStyle bs)

This method creates an object of class QBrush.

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

(4) Signature: [static] new QBrush new (const Qt_GlobalColor color, const Qt_BrushStyle bs = Qt::SolidPattern)

Description: Constructor QBrush::QBrush(Qt::GlobalColor color, Qt::BrushStyle bs)

This method creates an object of class QBrush.

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

(5) Signature: [static] new QBrush new (const QColor color, const QPixmap pixmap)

Description: Constructor QBrush::QBrush(const QColor &color, const QPixmap &pixmap)

This method creates an object of class QBrush.

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

(6) Signature: [static] new QBrush new (const Qt_GlobalColor color, const QPixmap pixmap)

Description: Constructor QBrush::QBrush(Qt::GlobalColor color, const QPixmap &pixmap)

This method creates an object of class QBrush.

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

(7) Signature: [static] new QBrush new (const QPixmap pixmap)

Description: Constructor QBrush::QBrush(const QPixmap &pixmap)

This method creates an object of class QBrush.

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

(8) Signature: [static] new QBrush new (const QImage image)

Description: Constructor QBrush::QBrush(const QImage &image)

This method creates an object of class QBrush.

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

(9) Signature: [static] new QBrush new (const QBrush brush)

Description: Constructor QBrush::QBrush(const QBrush &brush)

This method creates an object of class QBrush.

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

(10) Signature: [static] new QBrush new (const QGradient gradient)

Description: Constructor QBrush::QBrush(const QGradient &gradient)

This method creates an object of class QBrush.

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

setColor

(1) Signature: void setColor (const QColor color)

Description: Method void QBrush::setColor(const QColor &color)

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

(2) Signature: void setColor (const Qt_GlobalColor color)

Description: Method void QBrush::setColor(Qt::GlobalColor color)

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

setMatrix

Signature: void setMatrix (const QMatrix mat)

Description: Method void QBrush::setMatrix(const QMatrix &mat)

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

setStyle

Signature: void setStyle (const Qt_BrushStyle arg1)

Description: Method void QBrush::setStyle(Qt::BrushStyle)

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

setTexture

Signature: void setTexture (const QPixmap pixmap)

Description: Method void QBrush::setTexture(const QPixmap &pixmap)

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

setTextureImage

Signature: void setTextureImage (const QImage image)

Description: Method void QBrush::setTextureImage(const QImage &image)

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

setTransform

Signature: void setTransform (const QTransform arg1)

Description: Method void QBrush::setTransform(const QTransform &)

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

style

Signature: [const] Qt_BrushStyle style

Description: Method Qt::BrushStyle QBrush::style()

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

style=

Signature: void style= (const Qt_BrushStyle arg1)

Description: Method void QBrush::setStyle(Qt::BrushStyle)

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

texture

Signature: [const] QPixmap texture

Description: Method QPixmap QBrush::texture()

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

texture=

Signature: void texture= (const QPixmap pixmap)

Description: Method void QBrush::setTexture(const QPixmap &pixmap)

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

textureImage

Signature: [const] QImage textureImage

Description: Method QImage QBrush::textureImage()

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

textureImage=

Signature: void textureImage= (const QImage image)

Description: Method void QBrush::setTextureImage(const QImage &image)

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

transform

Signature: [const] QTransform transform

Description: Method QTransform QBrush::transform()

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

transform=

Signature: void transform= (const QTransform arg1)

Description: Method void QBrush::setTransform(const QTransform &)

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