TextGrammarCheck::GrammalecteResultJob Class

Processes Grammalecte grammar check results. Author: Laurent Montel <montel@kde.org>. More...

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

Public Functions

GrammalecteResultJob(QObject *parent = nullptr)
virtual ~GrammalecteResultJob() override
QStringList arguments() const
bool canStart()
QString grammarlecteCliPath() const
QString pythonPath() const
void setArguments(const QStringList &arguments)
void setGrammarlecteCliPath(const QString &grammarlecteCliPath)
void setPythonPath(const QString &pythonPath)
void setText(const QString &text)
void start()
QString text() const

Signals

void error(TextGrammarCheck::GrammalecteResultJob::ErrorType type)
void finished(const QString &result)

Detailed Description

Member Function Documentation

[explicit] GrammalecteResultJob::GrammalecteResultJob(QObject *parent = nullptr)

Constructs a new GrammalecteResultJob.

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

Destroys the job.

QStringList GrammalecteResultJob::arguments() const

Returns the command-line arguments for Grammalecte.

See also setArguments().

bool GrammalecteResultJob::canStart()

Returns whether the job can be started.

[signal] void GrammalecteResultJob::error(TextGrammarCheck::GrammalecteResultJob::ErrorType type)

Emitted when an error occurs during grammar checking.

[signal] void GrammalecteResultJob::finished(const QString &result)

Emitted when the grammar checking is finished with the result.

QString GrammalecteResultJob::grammarlecteCliPath() const

Returns the path to the Grammalecte CLI.

See also setGrammarlecteCliPath().

QString GrammalecteResultJob::pythonPath() const

Returns the path to the Python interpreter.

See also setPythonPath().

void GrammalecteResultJob::setArguments(const QStringList &arguments)

Sets the command-line arguments for Grammalecte.

See also arguments().

void GrammalecteResultJob::setGrammarlecteCliPath(const QString &grammarlecteCliPath)

Sets the path to the Grammalecte CLI.

See also grammarlecteCliPath().

void GrammalecteResultJob::setPythonPath(const QString &pythonPath)

Sets the path to the Python interpreter.

See also pythonPath().

void GrammalecteResultJob::setText(const QString &text)

Sets the text to be checked.

See also text().

void GrammalecteResultJob::start()

Starts the grammar checking process.

QString GrammalecteResultJob::text() const

Returns the text to be checked.

See also setText().