AppSettings.h

Go to the documentation of this file.

#pragma once
 
#include <QtQmlIntegration/QtQmlIntegration>
 
#include "SettingsGroup.h"
 
class AppSettings : public SettingsGroup
{
    Q_OBJECT
    QML_ELEMENT
    QML_UNCREATABLE("")
public:
    AppSettings(QObject* parent = nullptr);
 
    DEFINE_SETTING_NAME_GROUP()
 
    DEFINE_SETTINGFACT(preferredFirmwareClass)
    DEFINE_SETTINGFACT(preferredVehicleClass)
    DEFINE_SETTINGFACT(offlineEditingFirmwareClass)
    DEFINE_SETTINGFACT(offlineEditingVehicleClass)
    DEFINE_SETTINGFACT(offlineEditingCruiseSpeed)
    DEFINE_SETTINGFACT(offlineEditingHoverSpeed)
    DEFINE_SETTINGFACT(offlineEditingAscentSpeed)
    DEFINE_SETTINGFACT(offlineEditingDescentSpeed)
    DEFINE_SETTINGFACT(batteryPercentRemainingAnnounce) // Important: This is only used to calculate battery swaps
    DEFINE_SETTINGFACT(defaultMissionItemAltitude)
    DEFINE_SETTINGFACT(audioMuted)
    DEFINE_SETTINGFACT(audioVolume)
    DEFINE_SETTINGFACT(virtualJoystick)
    DEFINE_SETTINGFACT(virtualJoystickAutoCenterThrottle)
    DEFINE_SETTINGFACT(virtualJoystickLeftHandedMode)
    DEFINE_SETTINGFACT(uiScalePercent)
    DEFINE_SETTINGFACT(indoorPalette)
    DEFINE_SETTINGFACT(savePath)
    DEFINE_SETTINGFACT(androidDontSaveToSDCard)
    DEFINE_SETTINGFACT(useChecklist)
    DEFINE_SETTINGFACT(enforceChecklist)
    DEFINE_SETTINGFACT(enableMultiVehiclePanel)
    DEFINE_SETTINGFACT(tiandituToken)
    DEFINE_SETTINGFACT(mapboxToken)
    DEFINE_SETTINGFACT(mapboxAccount)
    DEFINE_SETTINGFACT(mapboxStyle)
    DEFINE_SETTINGFACT(esriToken)
    DEFINE_SETTINGFACT(customURL)
    DEFINE_SETTINGFACT(vworldToken)
    DEFINE_SETTINGFACT(openaipToken)
    DEFINE_SETTINGFACT(gstDebugLevel)
    DEFINE_SETTINGFACT(followTarget)
    DEFINE_SETTINGFACT(qLocaleLanguage)
    DEFINE_SETTINGFACT(clearSettingsNextBoot)
    DEFINE_SETTINGFACT(disableAllPersistence)
    DEFINE_SETTINGFACT(firstRunPromptIdsShown)
    DEFINE_SETTINGFACT(favoriteParameters)
    DEFINE_SETTINGFACT(remoteLoggingEnabled)
    DEFINE_SETTINGFACT(remoteLoggingHost)
    DEFINE_SETTINGFACT(remoteLoggingPort)
    DEFINE_SETTINGFACT(remoteLoggingProtocol)
    DEFINE_SETTINGFACT(remoteLoggingVehicleId)
    DEFINE_SETTINGFACT(remoteLoggingTlsEnabled)
    DEFINE_SETTINGFACT(remoteLoggingTlsVerifyPeer)
    DEFINE_SETTINGFACT(remoteLoggingCompressionEnabled)
    DEFINE_SETTINGFACT(remoteLoggingCompressionLevel)
 
    // QSettings key for clearSettingsNextBoot. Accessed directly by QGCApplication
    // at startup before SettingsManager is initialized.
    static constexpr const char *clearSettingsNextBootKey = "clearSettingsNextBoot";
 
    Q_PROPERTY(QString missionSavePath          READ missionSavePath            NOTIFY savePathsChanged)
    Q_PROPERTY(QString parameterSavePath        READ parameterSavePath          NOTIFY savePathsChanged)
    Q_PROPERTY(QString telemetrySavePath        READ telemetrySavePath          NOTIFY savePathsChanged)
    Q_PROPERTY(QString logSavePath              READ logSavePath                NOTIFY savePathsChanged)
    Q_PROPERTY(QString videoSavePath            READ videoSavePath              NOTIFY savePathsChanged)
    Q_PROPERTY(QString photoSavePath            READ photoSavePath              NOTIFY savePathsChanged)
    Q_PROPERTY(QString crashSavePath            READ crashSavePath              NOTIFY savePathsChanged)
    Q_PROPERTY(QString mavlinkActionsSavePath   READ mavlinkActionsSavePath     NOTIFY savePathsChanged)
    Q_PROPERTY(QString settingsSavePath         READ settingsSavePath           NOTIFY savePathsChanged)
 
    Q_PROPERTY(QString planFileExtension        MEMBER planFileExtension        CONSTANT)
    Q_PROPERTY(QString waypointsFileExtension   MEMBER waypointsFileExtension   CONSTANT)
    Q_PROPERTY(QString parameterFileExtension   MEMBER parameterFileExtension   CONSTANT)
    Q_PROPERTY(QString telemetryFileExtension   MEMBER telemetryFileExtension   CONSTANT)
    Q_PROPERTY(QString kmlFileExtension         MEMBER kmlFileExtension         CONSTANT)
    Q_PROPERTY(QString shpFileExtension         MEMBER shpFileExtension         CONSTANT)
    Q_PROPERTY(QString logFileExtension         MEMBER logFileExtension         CONSTANT)
    Q_PROPERTY(QString tilesetFileExtension     MEMBER tilesetFileExtension     CONSTANT)
    Q_PROPERTY(QString settingsFileExtension    MEMBER settingsFileExtension    CONSTANT)
 
 
    QString missionSavePath       ();
    QString parameterSavePath     ();
    QString telemetrySavePath     ();
    QString logSavePath           ();
    QString videoSavePath         ();
    QString photoSavePath         ();
    QString crashSavePath         ();
    QString mavlinkActionsSavePath();
    QString settingsSavePath      ();
 
    // Helper methods for working with firstRunPromptIds QVariant settings string list
    static QList<int> firstRunPromptsIdsVariantToList   (const QVariant& firstRunPromptIds);
    static QVariant   firstRunPromptsIdsListToVariant   (const QList<int>& rgIds);
    Q_INVOKABLE void  firstRunPromptIdsMarkIdAsShown    (int id);
 
    // Application wide file extensions
    static constexpr const char* parameterFileExtension =   "params";
    static constexpr const char* planFileExtension =        "plan";
    static constexpr const char* waypointsFileExtension =   "waypoints";
    static constexpr const char* telemetryFileExtension =   "tlog";
    static constexpr const char* kmlFileExtension =         "kml";
    static constexpr const char* shpFileExtension =         "shp";
    static constexpr const char* logFileExtension =         "ulg";
    static constexpr const char* tilesetFileExtension =     "qgctiledb";
    static constexpr const char* settingsFileExtension =    "settings";
 
    // Child directories of savePath for specific file types
    static constexpr const char* parameterDirectory =       QT_TRANSLATE_NOOP("AppSettings", "Parameters");
    static constexpr const char* telemetryDirectory =       QT_TRANSLATE_NOOP("AppSettings", "Telemetry");
    static constexpr const char* missionDirectory =         QT_TRANSLATE_NOOP("AppSettings", "Missions");
    static constexpr const char* logDirectory =             QT_TRANSLATE_NOOP("AppSettings", "Logs");
    static constexpr const char* videoDirectory =           QT_TRANSLATE_NOOP("AppSettings", "Video");
    static constexpr const char* photoDirectory =           QT_TRANSLATE_NOOP("AppSettings", "Photo");
    static constexpr const char* crashDirectory =           QT_TRANSLATE_NOOP("AppSettings", "CrashLogs");
    static constexpr const char* mavlinkActionsDirectory =  QT_TRANSLATE_NOOP("AppSettings", "MavlinkActions");
    static constexpr const char* settingsDirectory =        QT_TRANSLATE_NOOP("AppSettings", "Settings");
 
signals:
    void savePathsChanged();
 
private slots:
    void _indoorPaletteChanged();
    void _checkSavePathDirectories();
    void _qLocaleLanguageChanged();
 
private:
    static QLocale::Language _qLocaleLanguageEarlyAccess(void);
 
    static QList<QLocale::Language> _rgReleaseLanguages;
    static QList<QLocale::Language> _rgPartialLanguages;
 
    QString _childSavePath(const char* directory);
 
    typedef struct {
        QLocale::Language   languageId;
        const char*         languageName;
    } LanguageInfo_t;
    static LanguageInfo_t _rgLanguageInfo[];
 
    friend class QGCApplication;
};