Class: QgsRichTextEditor¶

A widget for editing rich text documents, with support for user controlled formatting of text and insertion of hyperlinks and images.

QgsRichTextEditor provides a reusable widget for allowing users to edit rich text documents, and retrieving and setting the documents via HTML formatted strings.

Added in version 3.20.

Class Hierarchy¶

Base classes¶

QWidget
QObject
QPaintDevice

Enums

Mode

Widget modes.

Methods

`clearSource`	Clears the current text from the widget.
`document`	Returns a reference to the QTextDocument shown in the widget.
`mode`	Returns the widget's mode, which defines which formatting options are exposed in the widget.
`setMode`	Sets the widget's mode, which defines which formatting options are exposed in the widget.
`setText`	Sets the text to show in the widget.
`setTextCursor`	Sets the current text cursor.
`textCursor`	Returns a reference to the text cursor.
`textEdit`	Returns the widget's QTextEditor control.
`toHtml`	Returns the widget's content as a HTML string.
`toPlainText`	Returns the widget's content as a plain text string.

Signals

textChanged

Emitted when the text contents are changed.

class qgis.gui.QgsRichTextEditor[source]¶

Bases: QWidget

__init__(parent: QWidget | None = None)

Constructor for QgsRichTextEditor, with the specified parent widget.

Parameters:: parent (Optional[QWidget] = None)

class Mode(*values)¶

Bases: IntEnum

Widget modes.

Added in version 3.40.

QTextDocument: Default mode, exposes the Qt supported HTML/CSS subset
QgsTextRenderer: QGIS text renderer mode, exposes the HTML/CSS subset supported by the QgsTextRenderer class
PlainText: Plain text mode