PaintContext¶
- PyQt5.QtGui.QAbstractTextDocumentLayout.PaintContext
Description¶
The PaintContext class is a convenience class defining the parameters used when painting a document’s layout.
A paint context is used when rendering custom layouts for QTextDocuments with the draw() function. It is specified by a cursor position, default text color, clip rectangle and a collection of selections.
See also
Attributes¶
- clip: QRectF
This variable holds a hint to the layout specifying the area around paragraphs, frames or text require painting..
Everything outside of this rectangle does not need to be painted.
Specifying a clip rectangle can speed up drawing of large documents significantly. Note that the clip rectangle is in document coordinates (not in viewport coordinates). It is not a substitute for a clip region set on the painter but merely a hint.
The default value is a null rectangle indicating everything needs to be painted.
- cursorPosition: int
This variable holds the position within the document, where the cursor line should be drawn..
The default value is -1.
- palette: QPalette
This variable holds the default color that is used for the text, when no color is specified..
The default value is the application’s default palette.
- selections: Iterable[Selection]
This variable holds the collection of selections that will be rendered when passing this paint context to QAbstractTextDocumentLayout’s draw() function..
The default value is an empty vector indicating no selection.
