TextGrammarCheck::GrammalecteGenerateConfigOptionJob Class

Generates configuration options for Grammalecte. Author: Laurent Montel <montel@kde.org>. More...

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

Public Functions

GrammalecteGenerateConfigOptionJob(QObject *parent = nullptr)
virtual ~GrammalecteGenerateConfigOptionJob() override
bool canStart() const
QString grammarlecteCliPath() const
QString pythonPath() const
void setGrammarlecteCliPath(const QString &grammarlecteCliPath)
void setPythonPath(const QString &pythonPath)
void start()

Signals

void error()
void finished(const QList<TextGrammarCheck::GrammalecteGenerateConfigOptionJob::Option> &result)

Detailed Description

Member Function Documentation

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

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

bool GrammalecteGenerateConfigOptionJob::canStart() const

Returns whether the job can be started.

[signal] void GrammalecteGenerateConfigOptionJob::error()

Emitted when an error occurs while fetching configuration options.

[signal] void GrammalecteGenerateConfigOptionJob::finished(const QList<TextGrammarCheck::GrammalecteGenerateConfigOptionJob::Option> &result)

Emitted when the configuration options have been successfully fetched.

QString GrammalecteGenerateConfigOptionJob::grammarlecteCliPath() const

Returns the path to the Grammalecte CLI.

See also setGrammarlecteCliPath().

QString GrammalecteGenerateConfigOptionJob::pythonPath() const

Returns the path to the Python interpreter.

See also setPythonPath().

void GrammalecteGenerateConfigOptionJob::setGrammarlecteCliPath(const QString &grammarlecteCliPath)

Sets the path to the Grammalecte CLI.

See also grammarlecteCliPath().

void GrammalecteGenerateConfigOptionJob::setPythonPath(const QString &pythonPath)

Sets the path to the Python interpreter.

See also pythonPath().

void GrammalecteGenerateConfigOptionJob::start()

Starts fetching the configuration options from Grammalecte.