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>

- List of all members, including inherited members

### Public Functions

- QBrush ()
- QBrush ( Qt::BrushStyle style )
- QBrush ( const QColor & color, Qt::BrushStyle style = Qt::SolidPattern )
- QBrush ( const QColor & color, const QPixmap & pixmap )
- QBrush ( const QPixmap & pixmap )
- QBrush ( const QBrush & b )
- QBrush ( const QPoint & p1, const QColor & col1, const QPoint & p2, const QColor & col2 )
- QBrush ( Qt::GlobalColor color, Qt::BrushStyle style = Qt::SolidPattern )
- QBrush ( Qt::GlobalColor color, const QPixmap & pixmap )
- ~QBrush ()
- const QColor & color () const
- QColor gradientColor () const
- QPoint gradientStart () const
- QPoint gradientStop () const
- QPixmap * pixmap () const
- void setColor ( const QColor & c )
- void setColor ( Qt::GlobalColor c )
- void setPixmap ( const QPixmap & pixmap )
- void setStyle ( Qt::BrushStyle s )
- Qt::BrushStyle style () const
- operator const QColor & () const
- operator const QPixmap * () const
- bool operator!= ( const QBrush & b ) const
- QBrush & operator= ( const QBrush & b )
- bool operator== ( const QBrush & b ) const

### Related Non-Members

- 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 `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(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(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(), and QPainter::setBrushOrigin().

## Member Function Documentation

### QBrush::QBrush ()

Constructs a default black brush with the style `Qt::NoBrush` (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 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 QPixmap & pixmap )

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

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

Constructs a brush that is a shallow copy of b.

### QBrush::QBrush ( const QPoint & p1, const QColor & col1, const QPoint & p2, const QColor & col2 )

Creates a linear gradient brush. The brush will interpolate between the color col1 in the point p1 to the color col2 in the point p2. The areas outside the interpolation area is filled with the color for that corresponding side.

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

Destroys the brush.

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

Returns the brush color.

See also setColor().

### QColor QBrush::gradientColor () const

Returns the gradient's secondary color.

See also gradientStart() and gradientStop().

### QPoint QBrush::gradientStart () const

Returns the gradient's starting color.

See also gradientStop() and gradientColor().

### QPoint QBrush::gradientStop () const

Returns the gradient's ending color.

See also gradientStart() and gradientColor().

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

### 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::setPixmap ( const QPixmap & pixmap )

Sets the brush pixmap to pixmap. The style is set to `Qt::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().

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

Sets the brush style to s.

The brush styles are:

Pattern | Meaning
--- | ---
Qt::NoBrush | will not fill shapes (default).
Qt::SolidPattern | solid (100%) fill pattern.
Qt::Dense1Pattern | 94% fill pattern.
Qt::Dense2Pattern | 88% fill pattern.
Qt::Dense3Pattern | 63% fill pattern.
Qt::Dense4Pattern | 50% fill pattern.
Qt::Dense5Pattern | 37% fill pattern.
Qt::Dense6Pattern | 12% fill pattern.
Qt::Dense7Pattern | 6% fill pattern.
Qt::HorPattern | horizontal lines pattern.
Qt::VerPattern | vertical lines pattern.
Qt::CrossPattern | crossing lines pattern.
Qt::BDiagPattern | diagonal lines (directed /) pattern.
Qt::FDiagPattern | diagonal lines (directed ) pattern.
Qt::DiagCrossPattern | diagonal crossing lines pattern.
Qt::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().

### Qt::BrushStyle QBrush::style () const

Returns the brush style.

See also setStyle().

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

Returns the brush's color.

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

Returns the brush's pixmap.

### 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.