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

#include <qbrush.h>

Public Types
using	DataPtr = std::unique_ptr< QBrushData, QBrushDataPointerDeleter >

Public Member Functions
	QBrush ()

	QBrush (Qt::BrushStyle bs)

	QBrush (const QColor &color, Qt::BrushStyle bs=Qt::SolidPattern)

	QBrush (Qt::GlobalColor color, Qt::BrushStyle bs=Qt::SolidPattern)

	QBrush (const QColor &color, const QPixmap &pixmap)

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

	QBrush (const QPixmap &pixmap)

	QBrush (const QImage &image)

	QBrush (const QBrush &brush)

	QBrush (const QGradient &gradient)

	~QBrush ()

QBrush &	operator= (const QBrush &brush)

void	swap (QBrush &other) noexcept

	operator QVariant () const

Qt::BrushStyle	style () const

void	setStyle (Qt::BrushStyle)

QTransform	transform () const

void	setTransform (const QTransform &)

QPixmap	texture () const

void	setTexture (const QPixmap &pixmap)

QImage	textureImage () const

void	setTextureImage (const QImage &image)

const QColor &	color () const

void	setColor (const QColor &color)

void	setColor (Qt::GlobalColor color)

const QGradient *	gradient () const

bool	isOpaque () const

bool	operator== (const QBrush &b) const

bool	operator!= (const QBrush &b) const

bool	isDetached () const

DataPtr &	data_ptr ()

Friends
class	QRasterPaintEngine

class	QRasterPaintEnginePrivate

struct	QSpanData

class	QPainter

bool Q_GUI_EXPORT	qHasPixmapTexture (const QBrush &brush)

Related Functions
(Note that these are not member functions.)
QDataStream &	operator<< (QDataStream &stream, const QBrush &brush)

QDataStream &	operator>> (QDataStream &stream, QBrush &brush)

Detailed Description

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

\inmodule QtGui

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.

Brush Styles

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.

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:

\list

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. \endlist

\table 100% \row

\inlineimage brush-outline.png Outlines

To specify the style and color of lines and outlines, use the QPainter's \l {QPen}{pen} combined with Qt::PenStyle and Qt::GlobalColor:

Note that, by default, QPainter renders the outline (using the currently set pen) when drawing shapes. Use \l {Qt::NoPen}{painter.setPen(Qt::NoPen)} to disable this behavior.

\endtable

For more information about painting in general, see the \l{Paint System}.

See also: Qt::BrushStyle, QPainter, QColor

Definition at line 65 of file qbrush.h.

Member Typedef Documentation

◆ DataPtr

QBrush::DataPtr

Definition at line 113 of file qbrush.h.

Constructor & Destructor Documentation

◆ QBrush() [1/10]

QBrush::QBrush ( )

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

Definition at line 426 of file qbrush.cpp.

◆ QBrush() [2/10]

QBrush::QBrush ( Qt::BrushStyle style )

Constructs a black brush with the given style.

See also: setStyle()

Definition at line 466 of file qbrush.cpp.

◆ QBrush() [3/10]

QBrush::QBrush	(	const QColor &	color,
		Qt::BrushStyle	style = `Qt::SolidPattern`
	)

Constructs a brush with the given color and style.

See also: setColor(), setStyle()

Definition at line 477 of file qbrush.cpp.

◆ QBrush() [4/10]

QBrush::QBrush	(	Qt::GlobalColor	color,
		Qt::BrushStyle	style = `Qt::SolidPattern`
	)

Constructs a brush with the given color and style.

See also: setColor(), setStyle()

Definition at line 494 of file qbrush.cpp.

◆ QBrush() [5/10]

QBrush::QBrush	(	const QColor &	color,
		const 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(), setTexture()

Definition at line 509 of file qbrush.cpp.

Here is the call graph for this function:

◆ QBrush() [6/10]

QBrush::QBrush	(	Qt::GlobalColor	color,
		const 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(), setTexture()

Definition at line 525 of file qbrush.cpp.

Here is the call graph for this function:

◆ QBrush() [7/10]

QBrush::QBrush ( const QPixmap & pixmap )

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()

Definition at line 440 of file qbrush.cpp.

Here is the call graph for this function:

◆ QBrush() [8/10]

QBrush::QBrush ( const QImage & image )

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()

Definition at line 454 of file qbrush.cpp.

Here is the call graph for this function:

◆ QBrush() [9/10]

QBrush::QBrush ( const QBrush & other )

Constructs a copy of other.

Definition at line 535 of file qbrush.cpp.

◆ QBrush() [10/10]

QBrush::QBrush ( const QGradient & gradient )

Constructs a brush based on the given gradient.

The brush style is set to the corresponding gradient style (either Qt::LinearGradientPattern, Qt::RadialGradientPattern or Qt::ConicalGradientPattern).

Definition at line 548 of file qbrush.cpp.

◆ ~QBrush()

QBrush::~QBrush ( )

Destroys the brush.

Definition at line 571 of file qbrush.cpp.

Member Function Documentation

◆ color()

const QColor & QBrush::color ( ) const

inline

Returns the brush color.

See also: setColor()

Definition at line 157 of file qbrush.h.

Here is the caller graph for this function:

◆ data_ptr()

DataPtr & QBrush::data_ptr ( )

inline

Definition at line 127 of file qbrush.h.

◆ gradient()

const QGradient * QBrush::gradient ( ) const

Returns the gradient describing this brush.

Definition at line 824 of file qbrush.cpp.

Here is the caller graph for this function:

◆ isDetached()

bool QBrush::isDetached ( ) const

inline

Definition at line 159 of file qbrush.h.

◆ isOpaque()

bool QBrush::isOpaque ( ) const

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

\list

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. \endlist

Definition at line 863 of file qbrush.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator QVariant()

QBrush::operator QVariant ( ) const

Returns the brush as a QVariant

Definition at line 669 of file qbrush.cpp.

Here is the call graph for this function:

◆ operator!=()

bool QBrush::operator!= ( const QBrush & brush ) const

inline

Returns true if the brush is different from the given brush; otherwise returns false.

Two brushes are different if they have different styles, colors or transforms or different pixmaps or gradients depending on the style.

See also: operator==()

Definition at line 111 of file qbrush.h.

Here is the call graph for this function:

◆ operator=()

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

Assigns the given brush to this brush and returns a reference to this brush.

Move-assigns other to this QBrush instance.

Since: 5.2

Definition at line 640 of file qbrush.cpp.

◆ operator==()

bool QBrush::operator== ( const QBrush & brush ) const

Returns true if the brush is equal to the given brush; otherwise returns false.

Two brushes are equal if they have equal styles, colors and transforms and equal pixmaps or gradients depending on the style.

See also: operator!=()

Definition at line 931 of file qbrush.cpp.

Here is the call graph for this function:

◆ setColor() [1/2]

void QBrush::setColor ( const 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()

Definition at line 720 of file qbrush.cpp.

Here is the caller graph for this function:

◆ setColor() [2/2]

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

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Sets the brush color to the given color.

Definition at line 130 of file qbrush.h.

Here is the call graph for this function:

◆ setStyle()

void QBrush::setStyle ( Qt::BrushStyle style )

Sets the brush style to style.

See also: style()

Definition at line 688 of file qbrush.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setTexture()

void QBrush::setTexture ( const 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 (\l {QBitmap}{QBitmaps}).

See also: texture()

Definition at line 761 of file qbrush.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setTextureImage()

void QBrush::setTextureImage ( const QImage & image )

Since: 4.2

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.

See also: textureImage(), setTexture()

Definition at line 809 of file qbrush.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setTransform()

void QBrush::setTransform ( const QTransform & matrix )

Since: 4.3

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.

See also: transform()

Definition at line 900 of file qbrush.cpp.

◆ style()

Qt::BrushStyle QBrush::style ( ) const

inline

Returns the brush style.

See also: setStyle()

Definition at line 156 of file qbrush.h.

Here is the caller graph for this function:

◆ swap()

void QBrush::swap ( QBrush & other )

inlinenoexcept

Since: 4.8

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

Definition at line 85 of file qbrush.h.

Here is the call graph for this function:

◆ texture()

QPixmap QBrush::texture ( ) const

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

See also: setTexture()

Definition at line 744 of file qbrush.cpp.

Here is the caller graph for this function:

◆ textureImage()

QImage QBrush::textureImage ( ) const

Since: 4.2

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.

See also: setTextureImage()

Definition at line 785 of file qbrush.cpp.

Here is the caller graph for this function:

◆ transform()

QTransform QBrush::transform ( ) const

inline

Since: 4.3

Returns the current transformation matrix for the brush.

See also: setTransform()

Definition at line 158 of file qbrush.h.

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ operator<<()

QDataStream & operator<<	(	QDataStream &	stream,
		const QBrush &	brush
	)

See also: {Serializing Qt Data Types}

Definition at line 1031 of file qbrush.cpp.

◆ operator>>()

QDataStream & operator>>	(	QDataStream &	stream,
		QBrush &	brush
	)

See also: {Serializing Qt Data Types}

Definition at line 1107 of file qbrush.cpp.

Here is the call graph for this function:

◆ qHasPixmapTexture

bool Q_GUI_EXPORT qHasPixmapTexture ( const QBrush & brush )

friend

Definition at line 235 of file qbrush.cpp.

◆ QPainter

friend class QPainter

friend

Definition at line 119 of file qbrush.h.

◆ QRasterPaintEngine

friend class QRasterPaintEngine

friend

Definition at line 116 of file qbrush.h.

◆ QRasterPaintEnginePrivate

friend class QRasterPaintEnginePrivate

friend

Definition at line 117 of file qbrush.h.

◆ QSpanData

friend struct QSpanData

friend

Definition at line 118 of file qbrush.h.

The documentation for this class was generated from the following files:

src/gui/painting/qbrush.h
src/gui/painting/qbrush.cpp

Public Types

Public Member Functions

Friends

Related Functions

Detailed Description

Member Typedef Documentation

◆ DataPtr

Constructor & Destructor Documentation

◆ QBrush() [1/10]

◆ QBrush() [2/10]

◆ QBrush() [3/10]

◆ QBrush() [4/10]

◆ QBrush() [5/10]

◆ QBrush() [6/10]

◆ QBrush() [7/10]

◆ QBrush() [8/10]

◆ QBrush() [9/10]

◆ QBrush() [10/10]

◆ ~QBrush()

Member Function Documentation

◆ color()

◆ data_ptr()

◆ gradient()

◆ isDetached()

◆ isOpaque()

◆ operator QVariant()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ setColor() [1/2]

◆ setColor() [2/2]

◆ setStyle()

◆ setTexture()

◆ setTextureImage()

◆ setTransform()

◆ style()

◆ swap()

◆ texture()

◆ textureImage()

◆ transform()

Friends And Related Function Documentation

◆ operator<<()

◆ operator>>()

◆ qHasPixmapTexture

◆ QPainter

◆ QRasterPaintEngine

◆ QRasterPaintEnginePrivate

◆ QSpanData