TextCustomEditor::RichTextEditorWidget Class

The RichTextEditorWidget class Author: Laurent Montel <montel@kde.org>. More...

Header: #include <TextCustomEditor/RichTextEditorWidget>
CMake: find_package(KF6TextCustomEditor REQUIRED)
target_link_libraries(mytarget PRIVATE KF6::TextCustomEditor)

Public Functions

RichTextEditorWidget(QWidget *parent = nullptr)
RichTextEditorWidget(TextCustomEditor::RichTextEditor *customEditor, QWidget *parent = nullptr)
virtual ~RichTextEditorWidget() override
bool acceptRichText() const
void clear()
TextCustomEditor::RichTextEditor *editor() const
bool isEmpty() const
bool isReadOnly() const
void setAcceptRichText(bool b)
void setHtml(const QString &html)
void setPlainText(const QString &text)
void setReadOnly(bool readOnly)
void setSpellCheckingConfigFileName(const QString &_fileName)
QString toHtml() const
QString toPlainText() const

Public Slots

void slotFind()
void slotFindNext()
void slotReplace()

Detailed Description

Member Function Documentation

[explicit] RichTextEditorWidget::RichTextEditorWidget(QWidget *parent = nullptr)

Constructs a new RichTextEditorWidget.

[explicit] RichTextEditorWidget::RichTextEditorWidget(TextCustomEditor::RichTextEditor *customEditor, QWidget *parent = nullptr)

Constructs a new RichTextEditorWidget with a custom editor.

[override virtual noexcept] RichTextEditorWidget::~RichTextEditorWidget()

Destroys the widget.

bool RichTextEditorWidget::acceptRichText() const

Returns whether the editor accepts rich text formatting.

See also setAcceptRichText().

void RichTextEditorWidget::clear()

Clears all text from the editor.

TextCustomEditor::RichTextEditor *RichTextEditorWidget::editor() const

Returns the underlying RichTextEditor instance.

bool RichTextEditorWidget::isEmpty() const

Returns whether the editor is empty.

bool RichTextEditorWidget::isReadOnly() const

Returns whether the editor is read-only.

void RichTextEditorWidget::setAcceptRichText(bool b)

Sets whether the editor accepts rich text formatting.

See also acceptRichText().

void RichTextEditorWidget::setHtml(const QString &html)

Sets the HTML content of the editor.

void RichTextEditorWidget::setPlainText(const QString &text)

Sets the plain text content of the editor.

void RichTextEditorWidget::setReadOnly(bool readOnly)

Sets whether the editor is read-only.

See also isReadOnly().

void RichTextEditorWidget::setSpellCheckingConfigFileName(const QString &_fileName)

Sets the configuration file name for spell checking.

[slot] void RichTextEditorWidget::slotFind()

Opens the find bar to search for text.

[slot] void RichTextEditorWidget::slotFindNext()

Opens the find bar to search for text.

[slot] void RichTextEditorWidget::slotReplace()

Opens the find and replace bar.

QString RichTextEditorWidget::toHtml() const

Returns the HTML content of the editor.

QString RichTextEditorWidget::toPlainText() const

Returns the plain text content of the editor.