Home · All Classes · Modules

QStylePainter Class Reference
^{[QtGui module]}

The QStylePainter class is a convenience class for drawing QStyle elements inside a widget. More...

Inherits QPainter.

Methods

• __init__ (self)
• __init__ (self, QWidget w)
• __init__ (self, QPaintDevice pd, QWidget w)
• bool begin (self, QWidget w)
• bool begin (self, QPaintDevice pd, QWidget w)
• drawComplexControl (self, QStyle.ComplexControl cc, QStyleOptionComplex opt)
• drawControl (self, QStyle.ControlElement ce, QStyleOption opt)
• drawItemPixmap (self, QRect r, int flags, QPixmap pixmap)
• drawItemText (self, QRect rect, int flags, QPalette pal, bool enabled, QString text, QPalette.ColorRole textRole = QPalette.NoRole)
• drawPrimitive (self, QStyle.PrimitiveElement pe, QStyleOption opt)
• QStyle style (self)

The QStylePainter class is a convenience class for drawing QStyle elements inside a widget.

QStylePainter extends QPainter with a set of high-level draw...() functions implemented on top of QStyle's API. The advantage of using QStylePainter is that the parameter lists get considerably shorter. Whereas a QStyle object must be able to draw on any widget using any painter (because the application normally has one QStyle object shared by all widget), a QStylePainter is initialized with a widget, eliminating the need to specify the QWidget, the QPainter, and the QStyle for every function call.

Example using QStyle directly:

 void MyWidget.paintEvent(QPaintEvent * /* event */)
 {
     QPainter painter(this);

     QStyleOptionFocusRect option;
     option.initFrom(this);
     option.backgroundColor = palette().color(QPalette.Background);

     style()->drawPrimitive(QStyle.PE_FrameFocusRect, &option, &painter, this);
 }

Example using QStylePainter:

 void MyWidget.paintEvent(QPaintEvent * /* event */)
 {
     QStylePainter painter(this);

     QStyleOptionFocusRect option;
     option.initFrom(this);
     option.backgroundColor = palette().color(QPalette.Background);

     painter.drawPrimitive(QStyle.PE_FrameFocusRect, option);
 }

Method Documentation

QStylePainter.__init__ (self)

Constructs a QStylePainter.

QStylePainter.__init__ (self, QWidget w)

Construct a QStylePainter using widget widget for its paint device.

QStylePainter.__init__ (self, QPaintDevice pd, QWidget w)

Construct a QStylePainter using pd for its paint device, and attributes from widget.

bool QStylePainter.begin (self, QWidget w)

Begin painting operations on the specified widget. Returns true if the painter is ready to use; otherwise returns false.

This is automatically called by the constructor that takes a QWidget.

bool QStylePainter.begin (self, QPaintDevice pd, QWidget w)

This is an overloaded function.

Begin painting operations on paint device pd as if it was widget.

This is automatically called by the constructor that takes a QPaintDevice and a QWidget.

QStylePainter.drawComplexControl (self, QStyle.ComplexControl cc, QStyleOptionComplex opt)

Use the widget's style to draw a complex control cc specified by the QStyleOptionComplex option.

See also QStyle.drawComplexControl().

QStylePainter.drawControl (self, QStyle.ControlElement ce, QStyleOption opt)

Use the widget's style to draw a control element ce specified by QStyleOption option.

See also QStyle.drawControl().

QStylePainter.drawItemPixmap (self, QRect r, int flags, QPixmap pixmap)

Draws the pixmap in rectangle rect. The pixmap is aligned according to flags.

See also QStyle.drawItemPixmap() and Qt.Alignment.

QStylePainter.drawItemText (self, QRect rect, int flags, QPalette pal, bool enabled, QString text, QPalette.ColorRole textRole = QPalette.NoRole)

Draws the text in rectangle rect and palette pal. The text is aligned and wrapped according to flags.

The pen color is specified with textRole. The enabled bool indicates whether or not the item is enabled; when reimplementing this bool should influence how the item is drawn.

See also QStyle.drawItemText() and Qt.Alignment.

QStylePainter.drawPrimitive (self, QStyle.PrimitiveElement pe, QStyleOption opt)

Use the widget's style to draw a primitive element pe specified by QStyleOption option.

See also QStyle.drawPrimitive().

QStyle QStylePainter.style (self)

Return the current style used by the QStylePainter.