Settings, added TSettingTrait::humanReadable and used copydoc, T159 related

This commit is contained in:
Klaus Basan
2017-09-22 01:17:04 +02:00
committed by Mathew Sutcliffe
parent 88a1c9f5d4
commit 7cdfe8c914
15 changed files with 116 additions and 24 deletions

View File

@@ -63,6 +63,9 @@ namespace BlackGui
{
//! \copydoc BlackCore::TSettingTrait::key
static const char *key() { return "atcstations"; }
//! \copydoc BlackCore::TSettingTrait::humanReadable
static const QString &humanReadable() { static const QString name("ATC stations"); return name; }
};
} // ns
} // ns

View File

@@ -125,8 +125,11 @@ namespace BlackGui
//! (of the parent object using this setting). If the object name is not set, it will not work correctly
struct TDockWidget : public BlackMisc::TSettingTrait<CDockWidgetSettings>
{
//! Key in data cache https://dev.vatsim-germany.org/issues/776
static const char *key() { return "guidockwidget/%Application%/%OwnerName%"; }
//! \copydoc BlackCore::TSettingTrait::key
static const char *key() { return "guidockwidget/%Application%/%OwnerName%"; } // Key in data cache https://dev.vatsim-germany.org/issues/776
//! \copydoc BlackCore::TSettingTrait::humanReadable
static const QString &humanReadable() { static const QString name("Dockable widgets"); return name; }
};
} // ns
} // ns

View File

@@ -78,25 +78,34 @@ namespace BlackGui
{
//! \copydoc BlackCore::TSettingTrait::key
static const char *key() { return "guigeneral"; }
//! \copydoc BlackCore::TSettingTrait::humanReadable
static const QString &humanReadable() { static const QString name("General GUI"); return name; }
};
//! Settings for last manual entries of own aircraft mode
struct TOwnAircraftModel : public BlackMisc::TSettingTrait<BlackMisc::Simulation::CAircraftModel>
{
//! Key in data cache
//! \copydoc BlackCore::TSettingTrait::key
static const char *key() { return "guinownaircraftmodel"; }
//! \copydoc BlackCore::TSettingTrait::humanReadable
static const QString &humanReadable() { static const QString name("Own aircraft"); return name; }
};
//! Settings for last manual entries of own aircraft mode
struct TBackgroundConsolidation : public BlackMisc::TSettingTrait<int>
{
//! Key in data cache
//! \copydoc BlackCore::TSettingTrait::key
static const char *key() { return "backgroundconsolidation"; }
//! Validator function.
//! \copydoc BlackCore::TSettingTrait::humanReadable
static const QString &humanReadable() { static const QString name("Background consolidation"); return name; }
//! \copydoc BlackCore::TSettingTrait::isValid
static bool isValid(const int &valueInSeconds) { return valueInSeconds == -1 || (valueInSeconds >= minSecs() && valueInSeconds <= maxSecs()); }
//! Default, not consolidating
//! \copydoc BlackCore::TSettingTrait::defaultValue
static const int &defaultValue() { static const int i = 240; return i; }
//! Minimum

View File

@@ -101,8 +101,11 @@ namespace BlackGui
//! Trait for settings for navigator
struct TNavigator : public BlackMisc::TSettingTrait<CNavigatorSettings>
{
//! Key in data cache
//! \copydoc BlackCore::TSettingTrait::key
static const char *key() { return "guinavigator"; }
//! \copydoc BlackCore::TSettingTrait::humanReadable
static const QString &humanReadable() { static const QString name("Navigator"); return name; }
};
} // ns
} // ns

View File

@@ -122,6 +122,9 @@ namespace BlackGui
{
//! \copydoc BlackCore::TSettingTrait::key
static const char *key() { return "textmessages"; }
//! \copydoc BlackCore::TSettingTrait::humanReadable
static const QString &humanReadable() { static const QString name("Text message"); return name; }
};
} // ns
} // ns

View File

@@ -22,11 +22,14 @@ namespace BlackGui
//! Trait for directory settings
struct TUpdateNotificationSettings : public BlackMisc::TSettingTrait<bool>
{
//! Key in data cache
//! \copydoc BlackCore::TSettingTrait::key
static const char *key() { return "guiupdatenotification/%Application%"; }
//! Default, not consolidating
//! \copydoc BlackCore::TSettingTrait::defaultValue
static const bool &defaultValue() { static const bool d = true; return d; }
//! \copydoc BlackCore::TSettingTrait::humanReadable
static const QString &humanReadable() { static const QString name("Update notification"); return name; }
};
} // ns
} // ns

View File

@@ -24,13 +24,16 @@ namespace BlackGui
//! Trait for directory settings
struct TViewDirectorySettings : public BlackMisc::TSettingTrait<QString>
{
//! Key in data cache
//! \copydoc BlackCore::TSettingTrait::key
static const char *key() { return "guiviewdirectory/%Application%"; }
//! Validator function.
//! \copydoc BlackCore::TSettingTrait::humanReadable
static const QString &humanReadable() { static const QString name("View directory"); return name; }
//! \copydoc BlackCore::TSettingTrait::isValid
static bool isValid(const QString &directory) { Q_UNUSED(directory); return true; }
//! Default, not consolidating
//! \copydoc BlackCore::TSettingTrait::defaultValue
static const QString &defaultValue() { return BlackMisc::CDirectoryUtils::documentationDirectory(); }
};
} // ns

View File

@@ -100,10 +100,13 @@ namespace BlackGui
//! Trait for settings about update rates
struct TViewUpdateSettings : public BlackMisc::TSettingTrait<CViewUpdateSettings>
{
//! Key in data cache
//! \copydoc BlackCore::TSettingTrait::key
static const char *key() { return "guiviewupdate"; }
//! Validator function.
//! \copydoc BlackCore::TSettingTrait::humanReadable
static const QString &humanReadable() { static const QString name("View update"); return name; }
//! \copydoc BlackCore::TSettingTrait::isValid
static bool isValid(const CViewUpdateSettings &settings) { return settings.isValid(); }
};
} // ns