TextGrammarCheck::GrammarResultWidget Class

Base widget for displaying grammar check results. Author: Laurent Montel <montel@kde.org>. More...

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

TextGrammarCheck::GrammalecteResultWidget and TextGrammarCheck::LanguageToolResultWidget

Public Functions

GrammarResultWidget(QWidget *parent = nullptr)
virtual ~GrammarResultWidget() override
void applyGrammarResult(const QList<TextGrammarCheck::GrammarError> &infos)
virtual void checkGrammar() = 0
void setText(const QString &str)

Signals

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

Protected Functions

virtual void addExtraWidget()

Detailed Description

Member Function Documentation

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

Constructs a new GrammarResultWidget.

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

Destroys the widget.

[virtual protected] void GrammarResultWidget::addExtraWidget()

Adds extra widgets to the result display. Can be overridden by subclasses.

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

Applies the grammar checking results to display the errors.

[signal] void GrammarResultWidget::checkAgain()

Emitted when the user wants to check the text again.

[pure virtual] void GrammarResultWidget::checkGrammar()

Checks the grammar of the text. This is implemented by subclasses.

[signal] void GrammarResultWidget::closeChecker()

Emitted when the user wants to close the checker.

[signal] void GrammarResultWidget::configure()

Emitted when the user wants to configure grammar checking settings.

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

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

void GrammarResultWidget::setText(const QString &str)

Sets the text to be checked.