|  | Home · All Classes · Modules

# QBrush Class Reference
[QtGui module]

The QBrush class defines the fill pattern of shapes drawn by QPainter. More...

### Methods

- __init__ (self)
- __init__ (self, Qt.BrushStyle bs)
- __init__ (self, QColor color, Qt.BrushStyle style = Qt.SolidPattern)
- __init__ (self, QColor color, QPixmap pixmap)
- __init__ (self, QPixmap pixmap)
- __init__ (self, QImage image)
- __init__ (self, QGradient gradient)
- __init__ (self, QBrush brush)
- __init__ (self, QVariant variant)
- QColor color (self)
- QGradient gradient (self)
- bool isOpaque (self)
- QMatrix matrix (self)
- setColor (self, QColor color)
- setColor (self, Qt.GlobalColor acolor)
- setMatrix (self, QMatrix mat)
- setStyle (self, Qt.BrushStyle)
- setTexture (self, QPixmap pixmap)
- setTextureImage (self, QImage image)
- setTransform (self, QTransform)
- Qt.BrushStyle style (self)
- swap (self, QBrush other)
- QPixmap texture (self)
- QImage textureImage (self)
- QTransform transform (self)

### Special Methods

- bool __eq__ (self, QBrush b)
- bool __ne__ (self, QBrush b)

## Detailed Description

A QColor or a QGradient may be used whenever a QBrush is expected.

The QBrush class defines the fill pattern of shapes drawn by QPainter.

A brush has a style, a color, a gradient and a texture.

The brush style() defines the fill pattern using the Qt.BrushStyle enum. The default brush style is Qt.NoBrush (depending on how you construct a brush). This style tells the painter to not fill shapes. The standard style for filling is Qt.SolidPattern. The style can be set when the brush is created using the appropriate constructor, and in addition the setStyle() function provides means for altering the style once the brush is constructed.

The brush color() defines the color of the fill pattern. The color can either be one of Qt's predefined colors, Qt.GlobalColor, or any other custom QColor. The currently set color can be retrieved and altered using the color() and setColor() functions, respectively.

The gradient() defines the gradient fill used when the current style is either Qt.LinearGradientPattern, Qt.RadialGradientPattern or Qt.ConicalGradientPattern. Gradient brushes are created by giving a QGradient as a constructor argument when creating the QBrush. Qt provides three different gradients: QLinearGradient, QConicalGradient, and QRadialGradient - all of which inherit QGradient.

         QRadialGradient gradient(50, 50, 50, 50, 50);
         gradient.setColorAt(0, QColor.fromRgbF(0, 1, 0, 1));
         gradient.setColorAt(1, QColor.fromRgbF(0, 0, 0, 0));

         QBrush brush(gradient);

The texture() defines the pixmap used when the current style is Qt.TexturePattern. You can create a brush with a texture by providing the pixmap when the brush is created or by using setTexture().

Note that applying setTexture() makes style() == Qt.TexturePattern, regardless of previous style settings. Also, calling setColor() will not make a difference if the style is a gradient. The same is the case if the style is Qt.TexturePattern style unless the current texture is a QBitmap.

The isOpaque() function returns true if the brush is fully opaque otherwise false. A brush is considered opaque if:

- The alpha component of the color() is 255.
- Its texture() does not have an alpha channel and is not a QBitmap.
- The colors in the gradient() all have an alpha component that is 255.

| To specify the style and color of lines and outlines, use the QPainter's pen combined with Qt.PenStyle and Qt.GlobalColor:
     QPainter painter(this);

     painter.setBrush(Qt.cyan);
     painter.setPen(Qt.darkCyan);
     painter.drawRect(0, 0, 100,100);

     painter.setBrush(Qt.NoBrush);
     painter.setPen(Qt.darkGreen);
     painter.drawRect(40, 40, 100, 100);
Note that, by default, QPainter renders the outline (using the currently set pen) when drawing shapes. Use `painter.setPen(Qt.NoPen)` to disable this behavior.

For more information about painting in general, see the Paint System.

## Method Documentation

### QBrush.__init__ (self)

Constructs a default black brush with the style Qt.NoBrush (i.e. this brush will not fill shapes).

### QBrush.__init__ (self, Qt.BrushStyle bs)

Constructs a black brush with the given style.

See also setStyle().

### QBrush.__init__ (self, QColor color, Qt.BrushStyle style = Qt.SolidPattern)

Constructs a brush with the given color and style.

See also setColor() and setStyle().

### QBrush.__init__ (self, QColor color, QPixmap pixmap)

Constructs a brush with the given color and style.

See also setColor() and setStyle().

### QBrush.__init__ (self, QPixmap pixmap)

Constructs a brush with the given color and the custom pattern stored in pixmap.

The style is set to Qt.TexturePattern. The color will only have an effect for QBitmaps.

See also setColor() and setPixmap().

### QBrush.__init__ (self, QImage image)

Constructs a brush with the given color and the custom pattern stored in pixmap.

The style is set to Qt.TexturePattern. The color will only have an effect for QBitmaps.

See also setColor() and setPixmap().

### QBrush.__init__ (self, QGradient gradient)

Constructs a brush with a black color and a texture set to the given pixmap. The style is set to Qt.TexturePattern.

See also setTexture().

### QBrush.__init__ (self, QBrush brush)

Constructs a brush with a black color and a texture set to the given image. The style is set to Qt.TexturePattern.

See also setTextureImage().

### QBrush.__init__ (self, QVariant variant)

Constructs a copy of other.

### QColor QBrush.color (self)

Returns the brush color.

See also setColor().

### QGradient QBrush.gradient (self)

Returns the gradient describing this brush.

### bool QBrush.isOpaque (self)

Returns true if the brush is fully opaque otherwise false. A brush is considered opaque if:

- The alpha component of the color() is 255.
- Its texture() does not have an alpha channel and is not a QBitmap.
- The colors in the gradient() all have an alpha component that is 255.
- It is an extended radial gradient.

### QMatrix QBrush.matrix (self)

Returns the current transformation matrix for the brush.

This function was introduced in Qt 4.2.

See also setMatrix().

### QBrush.setColor (self, QColor color)

Sets the brush color to the given color.

Note that calling setColor() will not make a difference if the style is a gradient. The same is the case if the style is Qt.TexturePattern style unless the current texture is a QBitmap.

See also color().

### QBrush.setColor (self, Qt.GlobalColor acolor)

This is an overloaded function.

Sets the brush color to the given color.

### QBrush.setMatrix (self, QMatrix mat)

Sets matrix as an explicit transformation matrix on the current brush. The brush transformation matrix is merged with QPainter transformation matrix to produce the final result.

This function was introduced in Qt 4.2.

See also matrix().

### QBrush.setStyle (self, Qt.BrushStyle)

Sets the brush style to style.

See also style().

### QBrush.setTexture (self, QPixmap pixmap)

Sets the brush pixmap to pixmap. The style is set to Qt.TexturePattern.

The current brush color will only have an effect for monochrome pixmaps, i.e. for QPixmap.depth() == 1 (QBitmaps).

See also texture().

### QBrush.setTextureImage (self, QImage image)

Sets the brush image to image. The style is set to Qt.TexturePattern.

Note the current brush color will not have any affect on monochrome images, as opposed to calling setTexture() with a QBitmap. If you want to change the color of monochrome image brushes, either convert the image to QBitmap with `QBitmap.fromImage()` and set the resulting QBitmap as a texture, or change the entries in the color table for the image.

This function was introduced in Qt 4.2.

See also textureImage() and setTexture().

### QBrush.setTransform (self, QTransform)

Sets matrix as an explicit transformation matrix on the current brush. The brush transformation matrix is merged with QPainter transformation matrix to produce the final result.

This function was introduced in Qt 4.3.

See also transform().

### Qt.BrushStyle QBrush.style (self)

Returns the brush style.

See also setStyle().

### QBrush.swap (self, QBrush other)

Swaps brush other with this brush. This operation is very fast and never fails.

This function was introduced in Qt 4.8.

### QPixmap QBrush.texture (self)

Returns the custom brush pattern, or a null pixmap if no custom brush pattern has been set.

See also setTexture().

### QImage QBrush.textureImage (self)

Returns the custom brush pattern, or a null image if no custom brush pattern has been set.

If the texture was set as a QPixmap it will be converted to a QImage.

This function was introduced in Qt 4.2.

See also setTextureImage().

### QTransform QBrush.transform (self)

Returns the current transformation matrix for the brush.

This function was introduced in Qt 4.3.

See also setTransform().

### bool QBrush.__eq__ (self, QBrush b)

### bool QBrush.__ne__ (self, QBrush b)