2019-12-05 15:24:12 +01:00
<!DOCTYPE html>
< html lang = "en" >
< head >
2020-03-31 15:35:51 +02:00
< meta charset = "utf-8" >
2019-12-05 15:24:12 +01:00
<!-- settings.cpp -->
2020-01-30 15:47:04 +01:00
< title > Settings Class | ScreenPlay< / title >
2019-12-05 15:24:12 +01:00
< link rel = "stylesheet" type = "text/css" href = "../css/style.css" / > < link rel = "stylesheet" type = "text/css" href = "../css/bootstrap.min.css" / >
< / head >
< body >
2020-11-22 12:24:43 +01:00
< div class = "container-fullwidth nav sticky-top" > < div class = "container navWrapper" > < a href = "../index.html" > < span class = "logo" > ScreenPlay Generated Docs < / span > < / a > < span class = "navHome" > < a href = "../index.html" > Home< / a > < / span > < / div > < / div > < div id = mainWrapper class = "wrapper container " >
2019-12-05 15:24:12 +01:00
< li > Settings< / li >
< div class = "sidebar" >
< div class = "toc" >
< h3 > < a name = "toc" > Contents< / a > < / h3 >
< ul >
< li class = "level1" > < a href = "#public-functions" > Public Functions< / a > < / li >
< li class = "level1" > < a href = "#public-slots" > Public Slots< / a > < / li >
< li class = "level1" > < a href = "#signals" > Signals< / a > < / li >
< li class = "level1" > < a href = "#details" > Detailed Description< / a > < / li >
< / ul >
< / div >
< div class = "sidebar-content" id = "sidebar-content" > < / div > < / div >
< h1 class = "title" > Settings Class< / h1 >
2021-05-13 13:05:05 +02:00
< span class = "small-subtitle" > class < a href = "screenplay-module.html" > ScreenPlay< / a > ::Settings< / span >
2019-12-05 15:24:12 +01:00
<!-- $$$Settings - brief -->
2019-12-08 11:38:48 +01:00
< p > Global settings class for reading and writing settings. < a href = "#details" > More...< / a > < / p >
2019-12-05 15:24:12 +01:00
<!-- @@@Settings -->
< div class = "table" > < table class = "alignedsummary" >
< tr > < td class = "memItemLeft rightAlign topAlign" > Header:< / td > < td class = "memItemRight bottomAlign" > < span class = "preprocessor" > #include < Settings> < / span >
< / td > < / tr > < / table > < / div > < ul >
< li > < a href = "screenplay-settings-members.html" > List of all members, including inherited members< / a > < / li >
< / ul >
< a name = "public-functions" > < / a >
< h2 id = "public-functions" > Public Functions< / h2 >
< div class = "table" > < table class = "alignedsummary" >
2020-08-11 16:20:07 +02:00
< tr > < td class = "memItemLeft rightAlign topAlign" > < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-settings.html#Settings" > Settings< / a > < / b > (const std::shared_ptr< GlobalVariables> & < i > globalVariables< / i > , QObject *< i > parent< / i > = nullptr)< / td > < / tr >
2019-12-05 15:24:12 +01:00
< tr > < td class = "memItemLeft rightAlign topAlign" > bool < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-settings.html#anonymousTelemetry-prop" > anonymousTelemetry< / a > < / b > () const< / td > < / tr >
< tr > < td class = "memItemLeft rightAlign topAlign" > bool < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-settings.html#autostart-prop" > autostart< / a > < / b > () const< / td > < / tr >
2020-03-31 15:35:51 +02:00
< tr > < td class = "memItemLeft rightAlign topAlign" > bool < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-settings.html#checkWallpaperVisible-prop" > checkWallpaperVisible< / a > < / b > () const< / td > < / tr >
2019-12-05 15:24:12 +01:00
< tr > < td class = "memItemLeft rightAlign topAlign" > QString < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-settings.html#decoder-prop" > decoder< / a > < / b > () const< / td > < / tr >
2020-11-14 19:08:09 +01:00
< tr > < td class = "memItemLeft rightAlign topAlign" > ScreenPlay::Settings::DesktopEnvironment < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-settings.html#desktopEnvironment-prop" > desktopEnvironment< / a > < / b > () const< / td > < / tr >
2020-03-31 15:35:51 +02:00
< tr > < td class = "memItemLeft rightAlign topAlign" > QString < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-settings.html#font-prop" > font< / a > < / b > () const< / td > < / tr >
2019-12-05 15:24:12 +01:00
< tr > < td class = "memItemLeft rightAlign topAlign" > QString < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-settings.html#gitBuildHash-prop" > gitBuildHash< / a > < / b > () const< / td > < / tr >
< tr > < td class = "memItemLeft rightAlign topAlign" > bool < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-settings.html#highPriorityStart-prop" > highPriorityStart< / a > < / b > () const< / td > < / tr >
2020-03-31 15:35:51 +02:00
< tr > < td class = "memItemLeft rightAlign topAlign" > ScreenPlay::Settings::Language < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-settings.html#language-prop" > language< / a > < / b > () const< / td > < / tr >
2019-12-05 15:24:12 +01:00
< tr > < td class = "memItemLeft rightAlign topAlign" > bool < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-settings.html#offlineMode-prop" > offlineMode< / a > < / b > () const< / td > < / tr >
2020-03-31 15:35:51 +02:00
< tr > < td class = "memItemLeft rightAlign topAlign" > void < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-settings.html#setupLanguage" > setupLanguage< / a > < / b > ()< / td > < / tr >
2019-12-05 15:24:12 +01:00
< tr > < td class = "memItemLeft rightAlign topAlign" > bool < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-settings.html#silentStart-prop" > silentStart< / a > < / b > () const< / td > < / tr >
2020-11-14 19:08:09 +01:00
< tr > < td class = "memItemLeft rightAlign topAlign" > bool < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-settings.html#steamVersion-prop" > steamVersion< / a > < / b > () const< / td > < / tr >
2020-08-11 16:20:07 +02:00
< tr > < td class = "memItemLeft rightAlign topAlign" > ScreenPlay::Settings::Theme < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-settings.html#theme-prop" > theme< / a > < / b > () const< / td > < / tr >
2021-05-13 13:05:05 +02:00
< tr > < td class = "memItemLeft rightAlign topAlign" > int < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-settings.html#videoFillMode-prop" > videoFillMode< / a > < / b > () const< / td > < / tr >
2019-12-05 15:24:12 +01:00
< / table > < / div >
< a name = "public-slots" > < / a >
< h2 id = "public-slots" > Public Slots< / h2 >
< div class = "table" > < table class = "alignedsummary" >
2020-03-31 15:35:51 +02:00
< tr > < td class = "memItemLeft rightAlign topAlign" > bool < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-settings.html#retranslateUI" > retranslateUI< / a > < / b > ()< / td > < / tr >
2019-12-05 15:24:12 +01:00
< tr > < td class = "memItemLeft rightAlign topAlign" > void < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-settings.html#anonymousTelemetry-prop" > setAnonymousTelemetry< / a > < / b > (bool < i > anonymousTelemetry< / i > )< / td > < / tr >
< tr > < td class = "memItemLeft rightAlign topAlign" > void < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-settings.html#autostart-prop" > setAutostart< / a > < / b > (bool < i > autostart< / i > )< / td > < / tr >
2020-03-31 15:35:51 +02:00
< tr > < td class = "memItemLeft rightAlign topAlign" > void < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-settings.html#checkWallpaperVisible-prop" > setCheckWallpaperVisible< / a > < / b > (bool < i > checkWallpaperVisible< / i > )< / td > < / tr >
2019-12-05 15:24:12 +01:00
< tr > < td class = "memItemLeft rightAlign topAlign" > void < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-settings.html#decoder-prop" > setDecoder< / a > < / b > (QString < i > decoder< / i > )< / td > < / tr >
2020-11-14 19:08:09 +01:00
< tr > < td class = "memItemLeft rightAlign topAlign" > void < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-settings.html#desktopEnvironment-prop" > setDesktopEnvironment< / a > < / b > (ScreenPlay::Settings::DesktopEnvironment < i > desktopEnvironment< / i > )< / td > < / tr >
2020-03-31 15:35:51 +02:00
< tr > < td class = "memItemLeft rightAlign topAlign" > void < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-settings.html#font-prop" > setFont< / a > < / b > (QString < i > font< / i > )< / td > < / tr >
2019-12-05 15:24:12 +01:00
< tr > < td class = "memItemLeft rightAlign topAlign" > void < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-settings.html#gitBuildHash-prop" > setGitBuildHash< / a > < / b > (QString < i > gitBuildHash< / i > )< / td > < / tr >
< tr > < td class = "memItemLeft rightAlign topAlign" > void < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-settings.html#highPriorityStart-prop" > setHighPriorityStart< / a > < / b > (bool < i > highPriorityStart< / i > )< / td > < / tr >
2020-03-31 15:35:51 +02:00
< tr > < td class = "memItemLeft rightAlign topAlign" > void < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-settings.html#language-prop" > setLanguage< / a > < / b > (ScreenPlay::Settings::Language < i > language< / i > )< / td > < / tr >
2019-12-05 15:24:12 +01:00
< tr > < td class = "memItemLeft rightAlign topAlign" > void < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-settings.html#offlineMode-prop" > setOfflineMode< / a > < / b > (bool < i > offlineMode< / i > )< / td > < / tr >
< tr > < td class = "memItemLeft rightAlign topAlign" > void < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-settings.html#silentStart-prop" > setSilentStart< / a > < / b > (bool < i > silentStart< / i > )< / td > < / tr >
2020-11-14 19:08:09 +01:00
< tr > < td class = "memItemLeft rightAlign topAlign" > void < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-settings.html#steamVersion-prop" > setSteamVersion< / a > < / b > (bool < i > steamVersion< / i > )< / td > < / tr >
2020-08-11 16:20:07 +02:00
< tr > < td class = "memItemLeft rightAlign topAlign" > void < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-settings.html#theme-prop" > setTheme< / a > < / b > (ScreenPlay::Settings::Theme < i > theme< / i > )< / td > < / tr >
2021-05-13 13:05:05 +02:00
< tr > < td class = "memItemLeft rightAlign topAlign" > void < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-settings.html#videoFillMode-prop" > setVideoFillMode< / a > < / b > (int < i > videoFillMode< / i > )< / td > < / tr >
2019-12-08 11:38:48 +01:00
< tr > < td class = "memItemLeft rightAlign topAlign" > void < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-settings.html#setupWidgetAndWindowPaths" > setupWidgetAndWindowPaths< / a > < / b > ()< / td > < / tr >
< tr > < td class = "memItemLeft rightAlign topAlign" > void < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-settings.html#writeJsonFileFromResource" > writeJsonFileFromResource< / a > < / b > (const QString & < i > filename< / i > )< / td > < / tr >
2019-12-05 15:24:12 +01:00
< / table > < / div >
< a name = "signals" > < / a >
< h2 id = "signals" > Signals< / h2 >
< div class = "table" > < table class = "alignedsummary" >
< tr > < td class = "memItemLeft rightAlign topAlign" > void < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-settings.html#anonymousTelemetry-prop" > anonymousTelemetryChanged< / a > < / b > (bool < i > anonymousTelemetry< / i > )< / td > < / tr >
< tr > < td class = "memItemLeft rightAlign topAlign" > void < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-settings.html#autostart-prop" > autostartChanged< / a > < / b > (bool < i > autostart< / i > )< / td > < / tr >
2020-03-31 15:35:51 +02:00
< tr > < td class = "memItemLeft rightAlign topAlign" > void < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-settings.html#checkWallpaperVisible-prop" > checkWallpaperVisibleChanged< / a > < / b > (bool < i > checkWallpaperVisible< / i > )< / td > < / tr >
2019-12-05 15:24:12 +01:00
< tr > < td class = "memItemLeft rightAlign topAlign" > void < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-settings.html#decoder-prop" > decoderChanged< / a > < / b > (QString < i > decoder< / i > )< / td > < / tr >
2020-11-14 19:08:09 +01:00
< tr > < td class = "memItemLeft rightAlign topAlign" > void < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-settings.html#desktopEnvironment-prop" > desktopEnvironmentChanged< / a > < / b > (ScreenPlay::Settings::DesktopEnvironment < i > desktopEnvironment< / i > )< / td > < / tr >
2020-03-31 15:35:51 +02:00
< tr > < td class = "memItemLeft rightAlign topAlign" > void < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-settings.html#font-prop" > fontChanged< / a > < / b > (QString < i > font< / i > )< / td > < / tr >
2019-12-05 15:24:12 +01:00
< tr > < td class = "memItemLeft rightAlign topAlign" > void < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-settings.html#gitBuildHash-prop" > gitBuildHashChanged< / a > < / b > (QString < i > gitBuildHash< / i > )< / td > < / tr >
< tr > < td class = "memItemLeft rightAlign topAlign" > void < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-settings.html#highPriorityStart-prop" > highPriorityStartChanged< / a > < / b > (bool < i > highPriorityStart< / i > )< / td > < / tr >
2020-03-31 15:35:51 +02:00
< tr > < td class = "memItemLeft rightAlign topAlign" > void < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-settings.html#language-prop" > languageChanged< / a > < / b > (ScreenPlay::Settings::Language < i > language< / i > )< / td > < / tr >
2019-12-05 15:24:12 +01:00
< tr > < td class = "memItemLeft rightAlign topAlign" > void < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-settings.html#offlineMode-prop" > offlineModeChanged< / a > < / b > (bool < i > offlineMode< / i > )< / td > < / tr >
< tr > < td class = "memItemLeft rightAlign topAlign" > void < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-settings.html#silentStart-prop" > silentStartChanged< / a > < / b > (bool < i > silentStart< / i > )< / td > < / tr >
2020-11-14 19:08:09 +01:00
< tr > < td class = "memItemLeft rightAlign topAlign" > void < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-settings.html#steamVersion-prop" > steamVersionChanged< / a > < / b > (bool < i > steamVersion< / i > )< / td > < / tr >
2020-08-11 16:20:07 +02:00
< tr > < td class = "memItemLeft rightAlign topAlign" > void < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-settings.html#theme-prop" > themeChanged< / a > < / b > (ScreenPlay::Settings::Theme < i > theme< / i > )< / td > < / tr >
2021-05-13 13:05:05 +02:00
< tr > < td class = "memItemLeft rightAlign topAlign" > void < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-settings.html#videoFillMode-prop" > videoFillModeChanged< / a > < / b > (int < i > videoFillMode< / i > )< / td > < / tr >
2019-12-05 15:24:12 +01:00
< / table > < / div >
< a name = "details" > < / a >
<!-- $$$Settings - description -->
< div class = "descr" >
< h2 id = "details" > Detailed Description< / h2 >
2019-12-08 11:38:48 +01:00
< p > Used for:< / p >
< ul >
2020-03-31 15:35:51 +02:00
< li > User configuration via AppData< b class = "redFont" > < code > \Local< / code > < / b > ScreenPlayScreenPlay< ul >
2019-12-08 11:38:48 +01:00
< li > profiles.json - saved wallpaper and widgets config< / li >
2021-05-13 13:05:05 +02:00
< li > Computer\HKEY_CURRENT_USER\Software\< a href = "screenplay-module.html" > ScreenPlay< / a > \< a href = "screenplay-module.html" > ScreenPlay< / a > - ScreenPlayContentPath for steam plugin< / li >
2019-12-08 11:38:48 +01:00
< / ul >
< / li >
< li > Communication via the SDK Connector< / li >
< / ul >
< p > Currently we save the regular settings (not the setup of the wallpaper and widgets) in two different locations. This can change in the future!< / p >
2019-12-05 15:24:12 +01:00
< / div >
<!-- @@@Settings -->
2019-12-08 11:38:48 +01:00
< div class = "func" >
< h2 > Member Function Documentation< / h2 >
2020-08-11 16:20:07 +02:00
<!-- $$$Settings[overload1]$$$Settingsconststd::shared_ptr<GlobalVariables>&QObject* -->
2020-11-22 12:24:43 +01:00
< h3 class = "fn" id = "Settings" > < a name = "Settings" > < / a > Settings::< span class = "name" > Settings< / span > (const < span class = "type" > std::shared_ptr< / span > < < span class = "type" > < a href = "screenplay-globalvariables.html" > GlobalVariables< / a > < / span > > & < i > globalVariables< / i > , < span class = "type" > QObject< / span > *< i > parent< / i > = nullptr)< / h3 >
2019-12-08 11:38:48 +01:00
< p > Constructor and sets up:< / p >
2021-05-13 13:05:05 +02:00
< ol class = "1" type = "1" > < li > Sets the git build hash via < a href = "screenplay-module.html" > ScreenPlay< / a > .pro c++ define< / li >
2019-12-08 11:38:48 +01:00
< li > Checks the langauge via settings or system and available ones and installes a translator.< / li >
2020-03-31 15:35:51 +02:00
< li > Checks the AbsoluteStoragePath.< / li >
2019-12-08 11:38:48 +01:00
< li > Checks regisitry for steam plugin settings< / li >
< li > Parses autostart, < a href = "screenplay-settings.html#anonymousTelemetry-prop" > anonymousTelemetry< / a > , < a href = "screenplay-settings.html#highPriorityStart-prop" > highPriorityStart< / a > < / li >
< li > Checks < a href = "screenplay-screenplaywallpaper.html" > ScreenPlayWallpaper< / a > and ScreenPlayWidgets executable paths.< / li >
< / ol >
< p > More errorchecking is needed here. For example when the proile or settings json cannot to parsed, use the default settings.< / p >
<!-- @@@Settings -->
2020-03-31 15:35:51 +02:00
<!-- $$$retranslateUI[overload1]$$$retranslateUI -->
< h3 class = "fn" id = "retranslateUI" > < a name = "retranslateUI" > < / a > < code > [slot] < / code > < span class = "type" > bool< / span > Settings::< span class = "name" > retranslateUI< / span > ()< / h3 >
< p > Check for supported langauges. If we use a langauge that not uses latin characters, we change the font. For example this happens for korean user. We ship google Noto Sans CJK KR Regular for this..< / p >
<!-- @@@retranslateUI -->
2019-12-08 11:38:48 +01:00
<!-- $$$setupWidgetAndWindowPaths[overload1]$$$setupWidgetAndWindowPaths -->
< h3 class = "fn" id = "setupWidgetAndWindowPaths" > < a name = "setupWidgetAndWindowPaths" > < / a > < code > [slot] < / code > < span class = "type" > void< / span > Settings::< span class = "name" > setupWidgetAndWindowPaths< / span > ()< / h3 >
< p > To have a better developer experience we check if we use a debug version. Then we assume That the paths are the default QtCreator paths and set the widgets and wallpaper executable paths accordingly.< / p >
<!-- @@@setupWidgetAndWindowPaths -->
<!-- $$$writeJsonFileFromResource[overload1]$$$writeJsonFileFromResourceconstQString& -->
< h3 class = "fn" id = "writeJsonFileFromResource" > < a name = "writeJsonFileFromResource" > < / a > < code > [slot] < / code > < span class = "type" > void< / span > Settings::< span class = "name" > writeJsonFileFromResource< / span > (const < span class = "type" > QString< / span > & < i > filename< / i > )< / h3 >
< p > Writes the default JsonFile from the resources and the given < i > filename< / i > . Currently we have two default json files:< / p >
< ul >
< li > profiles.json< / li >
< li > settings.json< / li >
< / ul >
<!-- @@@writeJsonFileFromResource -->
2020-03-31 15:35:51 +02:00
<!-- $$$setupLanguage[overload1]$$$setupLanguage -->
< h3 class = "fn" id = "setupLanguage" > < a name = "setupLanguage" > < / a > < span class = "type" > void< / span > Settings::< span class = "name" > setupLanguage< / span > ()< / h3 >
< p > Checks if there is already a saved language. If not we try to use the system langauge. If we do not support the system language we use english.< / p >
<!-- @@@setupLanguage -->
2019-12-08 11:38:48 +01:00
< / div >
2020-11-22 12:24:43 +01:00
< div id = license class = "footer center" > < p > This documentation is licensed under a < a rel = "license" href = "http://creativecommons.org/licenses/by/4.0/" > Creative Commons Attribution 4.0 International License< / a > .< / p > < / div > < script src = "../js/bootstrap.bundle.min.js" > < / script > < script src = "../js/mermaid.min.js" > < / script > < script > var config = { startOnLoad : true , flowchart : { useMaxWidth : true , htmlLabels : true } } ; mermaid . initialize ( config ) ; < / script > < / body >
2019-12-05 15:24:12 +01:00
< / html >
