QGroundControl
Ground Control Station for MAVLink Drones
Loading...
Searching...
No Matches
SettingsManager Class Reference

Provides access to all app settings. More...

#include <SettingsManager.h>

+ Inheritance diagram for SettingsManager:
+ Collaboration diagram for SettingsManager:

Public Member Functions

 SettingsManager (QObject *parent=nullptr)
 
 ~SettingsManager ()
 
void init ()
 
void registerCustomSettingsGroup (const QString &accessorName, SettingsGroup *group)
 
ADSBVehicleManagerSettings * adsbVehicleManagerSettings () const
 
APMMavlinkStreamRateSettings * apmMavlinkStreamRateSettings () const
 
AppSettings * appSettings () const
 
AutoConnectSettings * autoConnectSettings () const
 
BatteryIndicatorSettings * batteryIndicatorSettings () const
 
MavlinkActionsSettings * mavlinkActionsSettings () const
 
FirmwareUpgradeSettings * firmwareUpgradeSettings () const
 
FlightMapSettings * flightMapSettings () const
 
FlightModeSettings * flightModeSettings () const
 
FlyViewSettings * flyViewSettings () const
 
GimbalControllerSettings * gimbalControllerSettings () const
 
MapsSettings * mapsSettings () const
 
OfflineMapsSettings * offlineMapsSettings () const
 
PlanViewSettings * planViewSettings () const
 
RemoteIDSettings * remoteIDSettings () const
 
RTKSettings * rtkSettings () const
 
UnitsSettings * unitsSettings () const
 
NTRIPSettings * ntripSettings () const
 
GPSCorrectionSettings * gpsCorrectionSettings () const
 
VideoSettings * videoSettings () const
 
MavlinkSettings * mavlinkSettings () const
 
JoystickManagerSettings * joystickManagerSettings () const
 
LogManagerSettings * logManagerSettings () const
 
LogViewerSettings * logViewerSettings () const
 
Viewer3DSettings * viewer3DSettings () const
 

Static Public Member Functions

static SettingsManager * instance ()
 
static void adjustSettingMetaData (const QString &settingsGroup, FactMetaData &metaData, bool &userVisible)
 

Detailed Description

Provides access to all app settings.

Definition at line 38 of file SettingsManager.h.

Constructor & Destructor Documentation

◆ SettingsManager()

SettingsManager::SettingsManager ( QObject *  parent = nullptr)

Definition at line 41 of file SettingsManager.cc.

◆ ~SettingsManager()

SettingsManager::~SettingsManager ( )

Definition at line 47 of file SettingsManager.cc.

Member Function Documentation

◆ adjustSettingMetaData()

void SettingsManager::adjustSettingMetaData ( const QString &  settingsGroup,
FactMetaData &  metaData,
bool &  userVisible 
)
static

Allows for overriding the meta data before the fact is created.

Parameters
settingsGroup- QSettings group which contains this item
metaData- MetaData for setting fact
userVisible- true: Setting should be visible in ui, false: Setting should not be shown in ui (default value will be used as value)

Definition at line 241 of file SettingsManager.cc.

References QGCCorePlugin::adjustSettingMetaData(), FactMetaData::createFromJsonObject(), QGCCorePlugin::instance(), instance(), FactMetaData::name(), QGC::runningUnitTests(), FactMetaData::setBitmaskInfo(), FactMetaData::setDecimalPlaces(), FactMetaData::setEnumInfo(), FactMetaData::setLongDescription(), FactMetaData::setRawDefaultValue(), FactMetaData::setRawMax(), FactMetaData::setRawMin(), FactMetaData::setShortDescription(), FactMetaData::type(), and FactMetaData::typeToString().

Referenced by Fact::Fact(), and SettingsFact::SettingsFact().

◆ adsbVehicleManagerSettings()

ADSBVehicleManagerSettings * SettingsManager::adsbVehicleManagerSettings ( ) const

Definition at line 119 of file SettingsManager.cc.

◆ apmMavlinkStreamRateSettings()

APMMavlinkStreamRateSettings * SettingsManager::apmMavlinkStreamRateSettings ( ) const

Definition at line 120 of file SettingsManager.cc.

Referenced by APMFirmwarePlugin::initializeStreamRates().

◆ appSettings()

◆ autoConnectSettings()

AutoConnectSettings * SettingsManager::autoConnectSettings ( ) const

Definition at line 122 of file SettingsManager.cc.

Referenced by LinkManager::init(), and UDPConfiguration::loadSettings().

◆ batteryIndicatorSettings()

BatteryIndicatorSettings * SettingsManager::batteryIndicatorSettings ( ) const

Definition at line 123 of file SettingsManager.cc.

◆ firmwareUpgradeSettings()

FirmwareUpgradeSettings * SettingsManager::firmwareUpgradeSettings ( ) const

Definition at line 125 of file SettingsManager.cc.

◆ flightMapSettings()

◆ flightModeSettings()

FlightModeSettings * SettingsManager::flightModeSettings ( ) const

Definition at line 127 of file SettingsManager.cc.

◆ flyViewSettings()

◆ gimbalControllerSettings()

GimbalControllerSettings * SettingsManager::gimbalControllerSettings ( ) const

◆ gpsCorrectionSettings()

GPSCorrectionSettings * SettingsManager::gpsCorrectionSettings ( ) const

Definition at line 138 of file SettingsManager.cc.

◆ init()

void SettingsManager::init ( )

◆ instance()

SettingsManager * SettingsManager::instance ( )
static

Definition at line 52 of file SettingsManager.cc.

Referenced by ComplexMissionItem::_savePresetJson(), RallyPointController::addPoint(), adjustSettingMetaData(), QGeoFileTileCacheQGC::cacheTile(), SimulatedCameraControl::capturesPhotos(), CityMapGeometry::CityMapGeometry(), CorridorScanComplexItem::CorridorScanComplexItem(), LinkManager::createMavlinkForwardingSupportLink(), VideoBackend::createSink(), LogModel::data(), OnboardLogController::download(), QGCCorePlugin::firstRunPromptsToShow(), QGCFileDialogController::fullFolderPathToShortMobilePath(), TerrainTileManager::getAltitudesForCoordinates(), QGeoFileTileCacheQGC::getMaxDiskCacheSetting(), UVCReceiver::getSourceId(), MAVLinkProtocol::getSystemId(), EsriMapProvider::getToken(), GimbalController::gimbalOnScreenControl(), GimbalController::gimbalPitchStart(), GimbalController::gimbalYawStart(), VideoManager::grabImage(), Vehicle::guidedModeGotoLocation(), QGCFileDialogController::importFromNativePicker(), LinkManager::init(), FollowMe::init(), GPSManager::init(), LogManager::init(), QGCApplication::init(), VideoManager::init(), APMFirmwarePlugin::initializeStreamRates(), APMFirmwarePlugin::initializeVehicle(), AndroidInterface::jniStoragePermissionsResult(), UDPConfiguration::loadSettings(), LogModel::multiData(), ScreenToolsController::normalFontFamily(), QmlUnitsConversion::QmlUnitsConversion(), RemoteIDManager::RemoteIDManager(), Vehicle::requestOperatorControl(), MissionFlightStatusCalculator::reset(), GPSManager::saveCurrentBasePosition(), Viewer3DManager::setDisplayMode(), QGCApplication::shutdown(), SimulatedCameraControl::SimulatedCameraControl(), QGCMapEngineManager::startDownload(), MAVLinkLogManager::startLogging(), VideoManager::startRecording(), Vehicle::stopTrackingFirmwareVehicleTypeChanges(), StructureScanComplexItem::StructureScanComplexItem(), APMFirmwarePlugin::supportedMissionCommands(), PX4FirmwarePlugin::supportedMissionCommands(), SurfaceModel::SurfaceModel(), SurveyComplexItem::SurveyComplexItem(), Vehicle::trackFirmwareVehicleTypeChanges(), QGCMapEngineManager::updateForCurrentView(), Vehicle::Vehicle(), Vehicle::Vehicle(), VehicleCameraControl::VehicleCameraControl(), Viewer3DManager::Viewer3DManager(), Viewer3DTerrainGeometry::Viewer3DTerrainGeometry(), and VTOLLandingComplexItem::VTOLLandingComplexItem().

◆ joystickManagerSettings()

JoystickManagerSettings * SettingsManager::joystickManagerSettings ( ) const

Definition at line 145 of file SettingsManager.cc.

◆ logManagerSettings()

LogManagerSettings * SettingsManager::logManagerSettings ( ) const

Definition at line 146 of file SettingsManager.cc.

Referenced by LogManager::init().

◆ logViewerSettings()

LogViewerSettings * SettingsManager::logViewerSettings ( ) const

Definition at line 147 of file SettingsManager.cc.

◆ mapsSettings()

MapsSettings * SettingsManager::mapsSettings ( ) const

Definition at line 130 of file SettingsManager.cc.

Referenced by QGeoFileTileCacheQGC::getMaxDiskCacheSetting().

◆ mavlinkActionsSettings()

MavlinkActionsSettings * SettingsManager::mavlinkActionsSettings ( ) const

Definition at line 124 of file SettingsManager.cc.

◆ mavlinkSettings()

MavlinkSettings * SettingsManager::mavlinkSettings ( ) const

Definition at line 144 of file SettingsManager.cc.

Referenced by MAVLinkProtocol::getSystemId(), and QGCApplication::init().

◆ ntripSettings()

NTRIPSettings * SettingsManager::ntripSettings ( ) const

Definition at line 136 of file SettingsManager.cc.

◆ offlineMapsSettings()

OfflineMapsSettings * SettingsManager::offlineMapsSettings ( ) const

Definition at line 131 of file SettingsManager.cc.

◆ planViewSettings()

PlanViewSettings * SettingsManager::planViewSettings ( ) const

Definition at line 132 of file SettingsManager.cc.

Referenced by VTOLLandingComplexItem::VTOLLandingComplexItem().

◆ registerCustomSettingsGroup()

void SettingsManager::registerCustomSettingsGroup ( const QString &  accessorName,
SettingsGroup *  group 
)

Registers a custom build settings group so QML can access it as QGroundControl.settingsManager.<accessorName>. Called from a QGCCorePlugin::registerCustomSettings override. The accessor name must be the camelCase form of the group's SettingsGroup.json stem plus "Settings" (e.g. Custom.SettingsGroup.json -> "customSettings") so the generated settings pages resolve to the same name. Takes ownership of the group; a rejected group is deleted.

Definition at line 91 of file SettingsManager.cc.

◆ remoteIDSettings()

RemoteIDSettings * SettingsManager::remoteIDSettings ( ) const

Definition at line 133 of file SettingsManager.cc.

Referenced by RemoteIDManager::RemoteIDManager().

◆ rtkSettings()

RTKSettings * SettingsManager::rtkSettings ( ) const

Definition at line 134 of file SettingsManager.cc.

Referenced by GPSManager::saveCurrentBasePosition().

◆ unitsSettings()

UnitsSettings * SettingsManager::unitsSettings ( ) const

Definition at line 135 of file SettingsManager.cc.

Referenced by QmlUnitsConversion::QmlUnitsConversion().

◆ videoSettings()

VideoSettings * SettingsManager::videoSettings ( ) const

◆ viewer3DSettings()

Viewer3DSettings * SettingsManager::viewer3DSettings ( ) const

The documentation for this class was generated from the following files: