TextGrammarCheck::LanguageToolManager Class
Manager for LanguageTool grammar checking service. Author: Laurent Montel <montel@kde.org>. More...
| Header: | #include <TextGrammarCheck/LanguageToolManager> |
| CMake: | find_package(KF6TextGrammarCheck REQUIRED)target_link_libraries(mytarget PRIVATE KF6::TextGrammarCheck) |
| Inherits: | QObject |
Public Functions
| LanguageToolManager(QObject *parent = nullptr) | |
| virtual | ~LanguageToolManager() override |
| bool | allowToGetListOfLanguages() const |
| QColor | grammarColorForError(const QString &error) |
| QString | language() const |
| QString | languageToolCheckPath() const |
| QString | languageToolLanguagesPath() const |
| QString | languageToolPath() const |
| void | loadSettings() |
| QNetworkAccessManager * | networkAccessManager() const |
| void | saveSettings() |
| void | setLanguage(const QString &language) |
| void | setLanguageToolPath(const QString &path) |
| void | setUseLocalInstance(bool useLocalInstance) |
| bool | useLocalInstance() const |
Static Public Members
| QString | convertToLanguagePath(const QString &path) |
| TextGrammarCheck::LanguageToolManager * | self() |
Detailed Description
Member Function Documentation
[explicit] LanguageToolManager::LanguageToolManager(QObject *parent = nullptr)
Constructs a new LanguageToolManager.
[override virtual noexcept] LanguageToolManager::~LanguageToolManager()
Destroys the manager.
bool LanguageToolManager::allowToGetListOfLanguages() const
Returns whether we are allowed to fetch the list of available languages.
[static] QString LanguageToolManager::convertToLanguagePath(const QString &path)
Converts a path to the appropriate language path format.
QColor LanguageToolManager::grammarColorForError(const QString &error)
Returns the color to use for highlighting the specified error type.
QString LanguageToolManager::language() const
Returns the currently selected language for grammar checking.
See also setLanguage().
QString LanguageToolManager::languageToolCheckPath() const
Returns the path to the grammar check endpoint.
QString LanguageToolManager::languageToolLanguagesPath() const
Returns the path to the languages list endpoint.
QString LanguageToolManager::languageToolPath() const
Returns the path to the LanguageTool installation.
See also setLanguageToolPath().
void LanguageToolManager::loadSettings()
Loads settings from the configuration.
QNetworkAccessManager *LanguageToolManager::networkAccessManager() const
Returns the network access manager used for remote requests.
void LanguageToolManager::saveSettings()
Saves settings to the configuration.
[static] TextGrammarCheck::LanguageToolManager *LanguageToolManager::self()
Returns the global instance of LanguageToolManager.
void LanguageToolManager::setLanguage(const QString &language)
Sets the language for grammar checking.
See also language().
void LanguageToolManager::setLanguageToolPath(const QString &path)
Sets the path to the LanguageTool installation.
See also languageToolPath().
void LanguageToolManager::setUseLocalInstance(bool useLocalInstance)
Sets whether to use a local LanguageTool instance.
See also useLocalInstance().
bool LanguageToolManager::useLocalInstance() const
Returns whether to use a local LanguageTool instance.
See also setUseLocalInstance().