QBrush Class Reference
^{[QtGui module]}

Detailed Description

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

A brush has a style and a color. One of the brush styles is a custom pattern, which is defined by a QPixmap.

The brush style defines the fill pattern. 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 brush color defines the color of the fill pattern. The QColor documentation lists the predefined colors.

Use the QPen class for specifying line/outline styles.

Example:

            QPainter painter;
            QBrush brush(Qt::yellow);           // yellow solid pattern
            painter.begin(&anyPaintDevice);   // paint something
            painter.setBrush(brush);          // set the yellow brush
            painter.setPen(Qt::NoPen);        // do not draw outline
            painter.drawRect(40,30, 200,100); // draw filled rectangle
            painter.setBrush(Qt::NoBrush);    // do not fill
            painter.setPen(Qt::black);            // set black pen, 0 pixel width
            painter.drawRect(10,10, 30,20);   // draw rectangle outline
            painter.end();                    // painting done

See the Qt::BrushStyle for a complete list of brush styles.

See also QPainter, QPainter::setBrush(), and QPainter::setBrushOrigin().

Member Function Documentation

QBrush::QBrush ()

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

QBrush::QBrush ( Qt::BrushStyle style )

Constructs a black brush with the style style.

See also setStyle().

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

Constructs a brush with the color color and the style style.

See also setColor() and setStyle().

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

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

The color will only have an effect for QBitmaps.

See also setColor() and setPixmap().

QBrush::QBrush ( const QPixmap & pixmap )

Constructs a brush with a black color and a pixmap set to pixmap.

QBrush::QBrush ( const QBrush & other )

Constructs a copy of other.

QBrush::QBrush ( const QGradient & gradient )

Constructs a brush based on the given gradient.

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

Constructs a brush with the color color and the style style.

See also setColor() and setStyle().

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

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

The color will only have an effect for QBitmaps.

See also setColor() and setPixmap().

QBrush::~QBrush ()

Destroys the brush.

const QColor & QBrush::color () const

Returns the brush color.

See also setColor().

const QGradient * QBrush::gradient () const

Returns the gradient describing this brush.

bool QBrush::isOpaque () const

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 an alpha channel and is not a QBitmap.
• The colors in the gradient() all have an alpha component that is 255.

void QBrush::setColor ( const QColor & c )

Sets the brush color to c.

See also color() and setStyle().

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

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

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

Sets the brush style to style.

See also style().

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.

See also texture(), pixmap(), and color().

Qt::BrushStyle QBrush::style () const

Returns the brush style.

See also setStyle().

QPixmap QBrush::texture () const

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

See also setTexture() and setPixmap().

QBrush::operator QVariant () const

Returns the brush as a QVariant

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

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

Two brushes are different if they have different styles, colors or pixmaps.

See also operator==().

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

Assigns b to this brush and returns a reference to this brush.

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

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

Two brushes are equal if they have equal styles, colors and pixmaps.

See also operator!=().

Related Non-Members

QDataStream & operator<< ( QDataStream & s, const QBrush & b )

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Writes the brush b to the stream s and returns a reference to the stream.

See also Format of the QDataStream operators.

QDataStream & operator>> ( QDataStream & s, QBrush & b )

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Reads the brush b from the stream s and returns a reference to the stream.

See also Format of the QDataStream operators.