TextGrammarCheck::GrammarResultTextEdit Class

Text editor for displaying and handling grammar check results. Author: Laurent Montel <montel@kde.org>. More...

Header: #include <TextGrammarCheck/GrammarResultTextEdit>
CMake: find_package(KF6TextGrammarCheck REQUIRED)
target_link_libraries(mytarget PRIVATE KF6::TextGrammarCheck)

Public Functions

GrammarResultTextEdit(QWidget *parent = nullptr)
virtual ~GrammarResultTextEdit() override
void applyGrammarResult(const QList<TextGrammarCheck::GrammarError> &infos)

Signals

void checkAgain()
void closeChecker()
void configure()
void replaceText(const TextGrammarCheck::GrammarAction &act)

Reimplemented Protected Functions

virtual void contextMenuEvent(QContextMenuEvent *event) override
virtual bool event(QEvent *ev) override
virtual void paintEvent(QPaintEvent *event) override

Detailed Description

Member Function Documentation

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

Constructs a new GrammarResultTextEdit.

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

Destroys the text editor.

void GrammarResultTextEdit::applyGrammarResult(const QList<TextGrammarCheck::GrammarError> &infos)

Applies the grammar checking results to display the errors.

[signal] void GrammarResultTextEdit::checkAgain()

Emitted when the user wants to check the text again.

[signal] void GrammarResultTextEdit::closeChecker()

Emitted when the user wants to close the checker.

[signal] void GrammarResultTextEdit::configure()

Emitted when the user wants to configure grammar checking settings.

[override virtual protected] void GrammarResultTextEdit::contextMenuEvent(QContextMenuEvent *event)

Handles context menu events to display correction suggestions.

[override virtual protected] bool GrammarResultTextEdit::event(QEvent *ev)

Handles events such as hovering over errors.

[override virtual protected] void GrammarResultTextEdit::paintEvent(QPaintEvent *event)

Paints the widget and highlights grammar errors.

[signal] void GrammarResultTextEdit::replaceText(const TextGrammarCheck::GrammarAction &act)

Emitted when the user wants to replace text with a suggestion.