File indexing completed on 2024-04-28 15:34:18

 /*
  * SPDX-FileCopyrightText: 2020 Benjamin Port <benjamin.port@enioka.com>
  *
  * SPDX-License-Identifier: LGPL-2.1-or-later
  */
 #ifndef SONNET_SETTINGS_H
 #define SONNET_SETTINGS_H
 
 #include <QAbstractListModel>
 #include <QString>
 #include <QStringList>
 #include <QtCore/QObject>
 
 #include "sonnetcore_export.h"
 
 namespace Sonnet
 {
 class Loader;
 class SettingsPrivate;
 
 class SONNETCORE_EXPORT Settings : public QObject
 {
     Q_OBJECT
     /// This property holds whether Sonnet should skip checkign words starting with an uppercase letter.
     Q_PROPERTY(bool skipUppercase READ skipUppercase WRITE setSkipUppercase NOTIFY skipUppercaseChanged)
     /// This property holds whether Sonnet should autodetect language.
     Q_PROPERTY(bool autodetectLanguage READ autodetectLanguage WRITE setAutodetectLanguage NOTIFY autodetectLanguageChanged)
     /// This property holds whether Sonnet should run spellchecking checks in the background.
     Q_PROPERTY(bool backgroundCheckerEnabled READ backgroundCheckerEnabled WRITE setBackgroundCheckerEnabled NOTIFY backgroundCheckerEnabledChanged)
     /// This property holds whether Sonnet should be enabled by default.
     Q_PROPERTY(bool checkerEnabledByDefault READ checkerEnabledByDefault WRITE setCheckerEnabledByDefault NOTIFY checkerEnabledByDefaultChanged)
     /// This property holds whether Sonnet should skip checking compounds words.
     Q_PROPERTY(bool skipRunTogether READ skipRunTogether WRITE setSkipRunTogether NOTIFY skipRunTogetherChanged)
     /// This property holds the list of ignored words.
     Q_PROPERTY(QStringList currentIgnoreList READ currentIgnoreList WRITE setCurrentIgnoreList NOTIFY currentIgnoreListChanged)
     /// This property holds the list of preferred languages.
     Q_PROPERTY(QStringList preferredLanguages READ preferredLanguages WRITE setPreferredLanguages NOTIFY preferredLanguagesChanged)
     /// This property holds the default language for spell checking.
     Q_PROPERTY(QString defaultLanguage READ defaultLanguage WRITE setDefaultLanguage NOTIFY defaultLanguageChanged)
 
     /// This property holds a Qt Model containing all the preferred dictionaries
     /// with language description and theirs codes. This model makes the
     /// Qt::DisplayRole as well as the roles defined in \ref DictionaryRoles
     /// available.
     /// \since 5.88
     Q_PROPERTY(QAbstractListModel *dictionaryModel READ dictionaryModel CONSTANT)
 
     Q_PROPERTY(bool modified READ modified NOTIFY modifiedChanged)
 
 public:
     /// Roles for \ref dictionaryModel
     enum DictionaryRoles {
         LanguageCodeRole = Qt::UserRole + 1, //< Language code of the language. This uses "languageCode" as roleNames.
         PreferredRole, //< This role holds whether the language is one of the preferred languages. This uses "isPreferred" as roleNames.
         DefaultRole //< This role holds whether the language is the default language. This uses "isDefault" as roleNames.
     };
 
     explicit Settings(QObject *parent = nullptr);
     ~Settings() override;
 
     void setDefaultLanguage(const QString &lang);
     QString defaultLanguage() const;
 
     void setPreferredLanguages(const QStringList &lang);
     QStringList preferredLanguages() const;
 
     void setDefaultClient(const QString &client);
     QString defaultClient() const;
 
     void setSkipUppercase(bool);
     bool skipUppercase() const;
 
     void setAutodetectLanguage(bool);
     bool autodetectLanguage() const;
 
     void setSkipRunTogether(bool);
     bool skipRunTogether() const;
 
     void setBackgroundCheckerEnabled(bool);
     bool backgroundCheckerEnabled() const;
 
     void setCheckerEnabledByDefault(bool);
     bool checkerEnabledByDefault() const;
 
     void setCurrentIgnoreList(const QStringList &ignores);
     QStringList currentIgnoreList() const;
 
     QStringList clients() const;
     bool modified() const;
 
     QAbstractListModel *dictionaryModel();
 
     Q_INVOKABLE void save();
 
     static QStringList defaultIgnoreList();
     static bool defaultSkipUppercase();
     static bool defaultAutodetectLanguage();
     static bool defaultBackgroundCheckerEnabled();
     static bool defaultCheckerEnabledByDefault();
     static bool defauktSkipRunTogether();
     static QString defaultDefaultLanguage();
     static QStringList defaultPreferredLanguages();
 
 Q_SIGNALS:
     void skipUppercaseChanged();
     void autodetectLanguageChanged();
     void backgroundCheckerEnabledChanged();
     void defaultClientChanged();
     void defaultLanguageChanged();
     void preferredLanguagesChanged();
     void skipRunTogetherChanged();
     void checkerEnabledByDefaultChanged();
     void currentIgnoreListChanged();
     void modifiedChanged();
 
 private:
     friend class Loader;
     SettingsPrivate *const d;
 };
 }
 Q_DECLARE_METATYPE(QAbstractListModel *)
 
 #endif // SONNET_SETTINGS_H