openPilotLog/docs/man/man3/Settings.3

.TH "Settings" 3 "Tue Aug 9 2022" "openPilotLog" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Settings \- Thin wrapper for the QSettings class, simplifying reading and writing of settings\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <settings\&.h>\fP
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum class \fBMain\fP { \fBSetupComplete\fP, \fBStyle\fP, \fBFont\fP, \fBFontSize\fP, \fBUseSystemFont\fP, \fBLogbookView\fP, \fBDateFormat\fP }"
.br
.ti -1c
.RI "enum class \fBUserData\fP { \fBDisplaySelfAs\fP, \fBTailSortColumn\fP, \fBPilotSortColumn\fP, \fBFtlWarningThreshold\fP, \fBCurrWarningThreshold\fP, \fBShowToLgdCurrency\fP, \fBShowLicCurrency\fP, \fBShowTrCurrency\fP, \fBShowLckCurrency\fP, \fBShowMedCurrency\fP, \fBShowCustom1Currency\fP, \fBShowCustom2Currency\fP, \fBCustom1CurrencyName\fP, \fBCustom2CurrencyName\fP }"
.br
.ti -1c
.RI "enum class \fBFlightLogging\fP { \fBFunction\fP, \fBApproach\fP, \fBNightLoggingEnabled\fP, \fBLogIFR\fP, \fBFlightNumberPrefix\fP, \fBPilotFlying\fP, \fBNightAngle\fP }"
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "static void \fBsetup\fP ()"
.br
.RI "Should be called after QCoreApplication::set\&.\&.\&.Name have been called\&. "
.ti -1c
.RI "static void \fBresetToDefaults\fP ()"
.br
.RI "\fBSettings::resetToDefaults\fP (Re-)sets all settings to the default value\&. "
.ti -1c
.RI "static QVariant \fBread\fP (const Main key)"
.br
.ti -1c
.RI "static void \fBwrite\fP (const Main key, const QVariant &val)"
.br
.ti -1c
.RI "static QVariant \fBread\fP (const FlightLogging key)"
.br
.ti -1c
.RI "static void \fBwrite\fP (const UserData key, const QVariant &val)"
.br
.ti -1c
.RI "static QVariant \fBread\fP (const UserData key)"
.br
.ti -1c
.RI "static void \fBwrite\fP (const FlightLogging key, const QVariant &val)"
.br
.ti -1c
.RI "static QString \fBgroupOfKey\fP (const Main key)"
.br
.RI "Return string representation of group of key: 'ini_header/key'\&. "
.ti -1c
.RI "static QString \fBgroupOfKey\fP (const FlightLogging key)"
.br
.ti -1c
.RI "static QString \fBgroupOfKey\fP (const UserData key)"
.br
.ti -1c
.RI "static QString \fBstringOfKey\fP (const Main key)"
.br
.RI "Return string representation of key\&. "
.ti -1c
.RI "static QString \fBstringOfKey\fP (const FlightLogging key)"
.br
.ti -1c
.RI "static QString \fBstringOfKey\fP (const UserData key)"
.br
.ti -1c
.RI "static QSettings \fBsettings\fP ()"
.br
.ti -1c
.RI "static void \fBsync\fP ()"
.br
.in -1c
.SH "Detailed Description"
.PP 
Thin wrapper for the QSettings class, simplifying reading and writing of settings\&. 

.SH "Author"
.PP 
Generated automatically by Doxygen for openPilotLog from the source code\&.