QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
|
A widget for editing rich text documents, with support for user controlled formatting of text and insertion of hyperlinks and images. More...
#include <qgsrichtexteditor.h>
Public Types | |
enum class | Mode { QTextDocument , QgsTextRenderer , PlainText } |
Widget modes. More... | |
Public Slots | |
void | clearSource () |
Clears the current text from the widget. | |
void | setText (const QString &text) |
Sets the text to show in the widget. | |
Signals | |
void | textChanged () |
Emitted when the text contents are changed. | |
Public Member Functions | |
QgsRichTextEditor (QWidget *parent=nullptr) | |
Constructor for QgsRichTextEditor, with the specified parent widget. | |
QTextDocument * | document () |
Returns a reference to the QTextDocument shown in the widget. | |
Mode | mode () const |
Returns the widget's mode, which defines which formatting options are exposed in the widget. | |
void | setMode (Mode mode) |
Sets the widget's mode, which defines which formatting options are exposed in the widget. | |
void | setTextCursor (const QTextCursor &cursor) |
Sets the current text cursor. | |
QTextCursor | textCursor () const |
Returns a reference to the text cursor. | |
QTextEdit * | textEdit () |
Returns the widget's QTextEditor control. | |
QString | toHtml () const |
Returns the widget's content as a HTML string. | |
QString | toPlainText () const |
Returns the widget's content as a plain text string. | |
Protected Member Functions | |
void | focusInEvent (QFocusEvent *event) override |
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.
Definition at line 58 of file qgsrichtexteditor.h.
|
strong |
Widget modes.
Enumerator | |
---|---|
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. |
Definition at line 68 of file qgsrichtexteditor.h.
QgsRichTextEditor::QgsRichTextEditor | ( | QWidget * | parent = nullptr | ) |
Constructor for QgsRichTextEditor, with the specified parent widget.
Definition at line 53 of file qgsrichtexteditor.cpp.
|
slot |
Clears the current text from the widget.
Definition at line 354 of file qgsrichtexteditor.cpp.
|
inline |
Returns a reference to the QTextDocument shown in the widget.
Definition at line 123 of file qgsrichtexteditor.h.
|
overrideprotected |
Definition at line 397 of file qgsrichtexteditor.cpp.
|
inline |
Returns the widget's mode, which defines which formatting options are exposed in the widget.
Definition at line 88 of file qgsrichtexteditor.h.
void QgsRichTextEditor::setMode | ( | Mode | mode | ) |
Sets the widget's mode, which defines which formatting options are exposed in the widget.
Definition at line 143 of file qgsrichtexteditor.cpp.
|
slot |
Sets the text to show in the widget.
The text can either be a plain text string or a HTML document.
Definition at line 754 of file qgsrichtexteditor.cpp.
|
inline |
Sets the current text cursor.
Definition at line 137 of file qgsrichtexteditor.h.
|
signal |
Emitted when the text contents are changed.
|
inline |
Returns a reference to the text cursor.
Definition at line 130 of file qgsrichtexteditor.h.
|
inline |
Returns the widget's QTextEditor control.
Definition at line 118 of file qgsrichtexteditor.h.
QString QgsRichTextEditor::toHtml | ( | ) | const |
Returns the widget's content as a HTML string.
Definition at line 302 of file qgsrichtexteditor.cpp.
QString QgsRichTextEditor::toPlainText | ( | ) | const |
Returns the widget's content as a plain text string.
Definition at line 284 of file qgsrichtexteditor.cpp.