QBrush Class

Home | All Classes | Main Classes | Annotated | Grouped Classes | Functions |

# QBrush Class Reference

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

`#include <qbrush.h>`

Inherits Qt.

List of all member functions.

## Public Members

- QBrush ()
- QBrush ( BrushStyle style )
- QBrush ( const QColor & color, BrushStyle style = SolidPattern )
- QBrush ( const QColor & color, const QPixmap & pixmap )
- QBrush ( const QBrush & b )
- ~QBrush ()
- QBrush & operator= ( const QBrush & b )
- BrushStyle style () const
- void setStyle ( BrushStyle s )
- const QColor & color () const
- void setColor ( const QColor & c )
- QPixmap * pixmap () const
- void setPixmap ( const QPixmap & pixmap )
- bool operator== ( const QBrush & b ) const
- bool operator!= ( const QBrush & b ) const

## Related Functions

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

## 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 NoBrush (depending on how you construct a brush). This style tells the painter to not fill shapes. The standard style for filling is 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( yellow );           // yellow solid pattern
            painter.begin( &anyPaintDevice );   // paint something
            painter.setBrush( brush );          // set the yellow brush
            painter.setPen( NoPen );            // do not draw outline
            painter.drawRect( 40,30, 200,100 ); // draw filled rectangle
            painter.setBrush( NoBrush );        // do not fill
            painter.setPen( black );            // set black pen, 0 pixel width
            painter.drawRect( 10,10, 30,20 );   // draw rectangle outline
            painter.end();                      // painting done

See the setStyle() function for a complete list of brush styles.

See also QPainter, QPainter::setBrush(), QPainter::setBrushOrigin(), Graphics Classes, Image Processing Classes, and Implicitly and Explicitly Shared Classes.

## Member Function Documentation

### QBrush::QBrush ()

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

### QBrush::QBrush ( BrushStyle style )

Constructs a black brush with the style style.

See also setStyle().

### QBrush::QBrush ( const QColor & color, BrushStyle style = 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 monochrome pixmaps, i.e. for QPixmap::depth() == 1.

Pixmap brushes are currently not supported when printing on X11.

See also setColor() and setPixmap().

### QBrush::QBrush ( const QBrush & b )

Constructs a brush that is a shallow copy of b.

### QBrush::~QBrush ()

Destroys the brush.

### const QColor & QBrush::color () const

Returns the brush color.

See also setColor().

### 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!=().

### QPixmap * QBrush::pixmap () const

Returns a pointer to the custom brush pattern, or 0 if no custom brush pattern has been set.

See also setPixmap().

Example: richtext/richtext.cpp.

### void QBrush::setColor ( const QColor & c )

Sets the brush color to c.

See also color() and setStyle().

Example: picture/picture.cpp.

### void QBrush::setPixmap ( const QPixmap & pixmap )

Sets the brush pixmap to pixmap. The style is set to CustomPattern.

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

Pixmap brushes are currently not supported when printing on X11.

See also pixmap() and color().

Example: richtext/richtext.cpp.

### void QBrush::setStyle ( BrushStyle s )

Sets the brush style to s.

The brush styles are:

Pattern | Meaning
--- | ---
NoBrush | will not fill shapes (default).
SolidPattern | solid (100%) fill pattern.
Dense1Pattern | 94% fill pattern.
Dense2Pattern | 88% fill pattern.
Dense3Pattern | 63% fill pattern.
Dense4Pattern | 50% fill pattern.
Dense5Pattern | 37% fill pattern.
Dense6Pattern | 12% fill pattern.
Dense7Pattern | 6% fill pattern.
HorPattern | horizontal lines pattern.
VerPattern | vertical lines pattern.
CrossPattern | crossing lines pattern.
BDiagPattern | diagonal lines (directed /) pattern.
FDiagPattern | diagonal lines (directed \) pattern.
DiagCrossPattern | diagonal crossing lines pattern.
CustomPattern | set when a pixmap pattern is being used.

On Windows, dense and custom patterns cannot be transparent.

See the Detailed Description for a picture of all the styles.

See also style().

### BrushStyle QBrush::style () const

Returns the brush style.

See also setStyle().

## Related Functions

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

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 )

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

See also Format of the QDataStream operators.

This file is part of the Qt toolkit. Copyright © 1995-2007 Trolltech. All Rights Reserved.