QAbstractTextDocumentLayout::PaintContext Class Reference
^{[QtGui module]}

Detailed Description

The QAbstractTextDocumentLayout::PaintContext class is a convenience class defining the parameters of a painter context.

A painter context is used when rendering custom layouts for QTextDocuments with the QAbstractTextDocumentLayout::draw() function, and is specified by a cursor position, a default text color, a clip rectangle and a collection of selections.

See also QAbstractTextDocumentLayout.

Member Variable Documentation

QRectF PaintContext::clip

This variable holds a hint to the layout avoiding that paragraphs, frames or text that are clearly outside the specified rectangle, are drawn.

Specifying a clip rectangle can speed up drawing of large documents significantly. Note that the clip rectangle is in document coordinates (i.e., not in viewport coordinates), and that it is not a substitute for a clip region set on the painter.

The default value is a null rectangle.

int PaintContext::cursorPosition

This variable holds the position within the document, where the cursor line should be drawn.

The default value is -1.

QPalette PaintContext::palette

This variable holds the default color that is used for the text, when no color is specified in the text.

The default value of this variable uses the application's default palette.

QVector<Selection> PaintContext::selections

This variable holds the collection of selections that will be rendered when passing this painter context to QAbstractTextDocumentLayout's draw() function.

The default value of this variable is an empty vector.