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
<!-- screenplaywallpaper.cpp -->
2020-01-30 15:47:04 +01:00
< title > ScreenPlayWallpaper 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 > ScreenPlayWallpaper< / 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" > ScreenPlayWallpaper Class< / h1 >
2020-03-31 15:35:51 +02:00
< span class = "small-subtitle" > class < a href = "screenplay.html" > ScreenPlay< / a > ::ScreenPlayWallpaper< / span >
2019-12-05 15:24:12 +01:00
<!-- $$$ScreenPlayWallpaper - brief -->
2019-12-08 11:38:48 +01:00
< p > A Single Object to manage a Wallpaper. < a href = "#details" > More...< / a > < / p >
2019-12-05 15:24:12 +01:00
<!-- @@@ScreenPlayWallpaper -->
< div class = "table" > < table class = "alignedsummary" >
< tr > < td class = "memItemLeft rightAlign topAlign" > Header:< / td > < td class = "memItemRight bottomAlign" > < span class = "preprocessor" > #include < ScreenPlayWallpaper> < / span >
< / td > < / tr > < / table > < / div > < ul >
< li > < a href = "screenplay-screenplaywallpaper-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-screenplaywallpaper.html#ScreenPlayWallpaper-1" > ScreenPlayWallpaper< / a > < / b > (const QVector< int> & < i > screenNumber< / i > , const std::shared_ptr< GlobalVariables> & < i > globalVariables< / i > , const QString & < i > appID< / i > , const QString & < i > absolutePath< / i > , const QString & < i > previewImage< / i > , const QString & < i > file< / i > , const float < i > volume< / i > , const float < i > playbackRate< / i > , const FillMode::FillMode < i > fillMode< / i > , const InstalledType::InstalledType < i > type< / i > , const QJsonObject & < i > properties< / i > , const bool < i > checkWallpaperVisible< / i > , QObject *< i > parent< / i > = nullptr)< / 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-screenplaywallpaper.html#absolutePath-prop" > absolutePath< / a > < / b > () const< / td > < / tr >
< tr > < td class = "memItemLeft rightAlign topAlign" > QString < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-screenplaywallpaper.html#appID-prop" > appID< / a > < / b > () const< / td > < / tr >
< tr > < td class = "memItemLeft rightAlign topAlign" > QString < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-screenplaywallpaper.html#file-prop" > file< / a > < / b > () const< / td > < / tr >
2020-08-11 16:20:07 +02:00
< tr > < td class = "memItemLeft rightAlign topAlign" > FillMode::FillMode < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-screenplaywallpaper.html#fillMode-prop" > fillMode< / a > < / b > () const< / td > < / tr >
2020-11-22 12:24:43 +01:00
< tr > < td class = "memItemLeft rightAlign topAlign" > QJsonObject < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-screenplaywallpaper.html#getActiveSettingsJson" > getActiveSettingsJson< / a > < / b > ()< / td > < / tr >
2020-08-11 16:20:07 +02:00
< tr > < td class = "memItemLeft rightAlign topAlign" > bool < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-screenplaywallpaper.html#isLooping-prop" > isLooping< / a > < / b > () const< / td > < / tr >
< tr > < td class = "memItemLeft rightAlign topAlign" > float < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-screenplaywallpaper.html#playbackRate-prop" > playbackRate< / 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-screenplaywallpaper.html#previewImage-prop" > previewImage< / a > < / b > () const< / td > < / tr >
2020-11-22 12:24:43 +01:00
< tr > < td class = "memItemLeft rightAlign topAlign" > void < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-screenplaywallpaper.html#replace" > replace< / a > < / b > (const QString & < i > absolutePath< / i > , const QString & < i > previewImage< / i > , const QString & < i > file< / i > , const float < i > volume< / i > , const FillMode::FillMode < i > fillMode< / i > , const InstalledType::InstalledType < i > type< / i > , const bool < i > checkWallpaperVisible< / i > )< / td > < / tr >
2019-12-05 15:24:12 +01:00
< tr > < td class = "memItemLeft rightAlign topAlign" > QVector< int> < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-screenplaywallpaper.html#screenNumber-prop" > screenNumber< / a > < / b > () const< / td > < / tr >
2020-11-22 12:24:43 +01:00
< tr > < td class = "memItemLeft rightAlign topAlign" > void < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-screenplaywallpaper.html#setSDKConnection" > setSDKConnection< / a > < / b > (const std::shared_ptr< SDKConnection> & < i > connection< / i > )< / td > < / tr >
2020-08-11 16:20:07 +02:00
< tr > < td class = "memItemLeft rightAlign topAlign" > InstalledType::InstalledType < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-screenplaywallpaper.html#type-prop" > type< / a > < / b > () const< / td > < / tr >
< tr > < td class = "memItemLeft rightAlign topAlign" > float < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-screenplaywallpaper.html#volume-prop" > volume< / 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" > void < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-screenplaywallpaper.html#processError" > processError< / a > < / b > (QProcess::ProcessError < i > error< / i > )< / td > < / tr >
< tr > < td class = "memItemLeft rightAlign topAlign" > void < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-screenplaywallpaper.html#processExit" > processExit< / a > < / b > (int < i > exitCode< / i > , QProcess::ExitStatus < i > exitStatus< / 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-screenplaywallpaper.html#absolutePath-prop" > setAbsolutePath< / a > < / b > (QString < i > absolutePath< / i > )< / td > < / tr >
< tr > < td class = "memItemLeft rightAlign topAlign" > void < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-screenplaywallpaper.html#appID-prop" > setAppID< / a > < / b > (QString < i > appID< / i > )< / td > < / tr >
< tr > < td class = "memItemLeft rightAlign topAlign" > void < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-screenplaywallpaper.html#file-prop" > setFile< / a > < / b > (QString < i > file< / 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-screenplaywallpaper.html#fillMode-prop" > setFillMode< / a > < / b > (FillMode::FillMode < i > fillMode< / i > )< / td > < / tr >
< tr > < td class = "memItemLeft rightAlign topAlign" > void < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-screenplaywallpaper.html#isLooping-prop" > setIsLooping< / a > < / b > (bool < i > isLooping< / i > )< / td > < / tr >
< tr > < td class = "memItemLeft rightAlign topAlign" > void < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-screenplaywallpaper.html#playbackRate-prop" > setPlaybackRate< / a > < / b > (float < i > playbackRate< / 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-screenplaywallpaper.html#previewImage-prop" > setPreviewImage< / a > < / b > (QString < i > previewImage< / i > )< / td > < / tr >
< tr > < td class = "memItemLeft rightAlign topAlign" > void < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-screenplaywallpaper.html#screenNumber-prop" > setScreenNumber< / a > < / b > (QVector< int> < i > screenNumber< / 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-screenplaywallpaper.html#type-prop" > setType< / a > < / b > (InstalledType::InstalledType < i > type< / i > )< / td > < / tr >
< tr > < td class = "memItemLeft rightAlign topAlign" > void < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-screenplaywallpaper.html#volume-prop" > setVolume< / a > < / b > (float < i > volume< / i > )< / td > < / tr >
2020-12-26 21:14:42 +01:00
< tr > < td class = "memItemLeft rightAlign topAlign" > void < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-screenplaywallpaper.html#setWallpaperValue" > setWallpaperValue< / a > < / b > (const QString & < i > key< / i > , const QString & < i > value< / i > , const bool < i > save< / i > = false)< / 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-screenplaywallpaper.html#absolutePath-prop" > absolutePathChanged< / a > < / b > (QString < i > absolutePath< / i > )< / td > < / tr >
< tr > < td class = "memItemLeft rightAlign topAlign" > void < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-screenplaywallpaper.html#appID-prop" > appIDChanged< / a > < / b > (QString < i > appID< / i > )< / td > < / tr >
< tr > < td class = "memItemLeft rightAlign topAlign" > void < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-screenplaywallpaper.html#file-prop" > fileChanged< / a > < / b > (QString < i > file< / 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-screenplaywallpaper.html#fillMode-prop" > fillModeChanged< / a > < / b > (FillMode::FillMode < i > fillMode< / i > )< / td > < / tr >
< tr > < td class = "memItemLeft rightAlign topAlign" > void < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-screenplaywallpaper.html#isLooping-prop" > isLoopingChanged< / a > < / b > (bool < i > isLooping< / i > )< / td > < / tr >
< tr > < td class = "memItemLeft rightAlign topAlign" > void < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-screenplaywallpaper.html#playbackRate-prop" > playbackRateChanged< / a > < / b > (float < i > playbackRate< / 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-screenplaywallpaper.html#previewImage-prop" > previewImageChanged< / a > < / b > (QString < i > previewImage< / i > )< / td > < / tr >
< tr > < td class = "memItemLeft rightAlign topAlign" > void < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-screenplaywallpaper.html#screenNumber-prop" > screenNumberChanged< / a > < / b > (QVector< int> < i > screenNumber< / 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-screenplaywallpaper.html#type-prop" > typeChanged< / a > < / b > (InstalledType::InstalledType < i > type< / i > )< / td > < / tr >
< tr > < td class = "memItemLeft rightAlign topAlign" > void < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-screenplaywallpaper.html#volume-prop" > volumeChanged< / a > < / b > (float < i > volume< / i > )< / td > < / tr >
2019-12-05 15:24:12 +01:00
< / table > < / div >
< a name = "details" > < / a >
<!-- $$$ScreenPlayWallpaper - description -->
< div class = "descr" >
< h2 id = "details" > Detailed Description< / h2 >
2019-12-08 11:38:48 +01:00
< p > This class is only for managing the QProcess to an extern ScreenPlayWallpaper!< / p >
2019-12-05 15:24:12 +01:00
< / div >
<!-- @@@ScreenPlayWallpaper -->
2019-12-08 11:38:48 +01:00
< div class = "func" >
< h2 > Member Function Documentation< / h2 >
2020-08-11 16:20:07 +02:00
<!-- $$$ScreenPlayWallpaper$$$ScreenPlayWallpaperconstQVector<int>&conststd::shared_ptr<GlobalVariables>&constQString&constQString&constQString&constQString&constfloatconstfloatconstFillMode::FillModeconstInstalledType::InstalledTypeconstQJsonObject&constboolQObject* -->
2020-11-22 12:24:43 +01:00
< h3 class = "fn" id = "ScreenPlayWallpaper-1" > < a name = "ScreenPlayWallpaper-1" > < / a > ScreenPlayWallpaper::< span class = "name" > ScreenPlayWallpaper< / span > (const < span class = "type" > QVector< / span > < < span class = "type" > int< / span > > & < i > screenNumber< / i > , const < span class = "type" > std::shared_ptr< / span > < < span class = "type" > < a href = "screenplay-globalvariables.html" > GlobalVariables< / a > < / span > > & < i > globalVariables< / i > , const < span class = "type" > QString< / span > & < i > appID< / i > , const < span class = "type" > QString< / span > & < i > absolutePath< / i > , const < span class = "type" > QString< / span > & < i > previewImage< / i > , const < span class = "type" > QString< / span > & < i > file< / i > , const < span class = "type" > float< / span > < i > volume< / i > , const < span class = "type" > float< / span > < i > playbackRate< / i > , const < span class = "type" > FillMode::FillMode< / span > < i > fillMode< / i > , const < span class = "type" > InstalledType::InstalledType< / span > < i > type< / i > , const < span class = "type" > QJsonObject< / span > & < i > properties< / i > , const < span class = "type" > bool< / span > < i > checkWallpaperVisible< / i > , < span class = "type" > QObject< / span > *< i > parent< / i > = nullptr)< / h3 >
2020-12-26 21:14:42 +01:00
< p > Constructor for ScreenPlayWallpaper.< / p >
2019-12-08 11:38:48 +01:00
<!-- @@@ScreenPlayWallpaper -->
2020-03-31 15:35:51 +02:00
<!-- $$$processError[overload1]$$$processErrorQProcess::ProcessError -->
< h3 class = "fn" id = "processError" > < a name = "processError" > < / a > < code > [slot] < / code > < span class = "type" > void< / span > ScreenPlayWallpaper::< span class = "name" > processError< / span > (< span class = "type" > QProcess::ProcessError< / span > < i > error< / i > )< / h3 >
< p > Prints the exit code error.< / p >
<!-- @@@processError -->
<!-- $$$processExit[overload1]$$$processExitintQProcess::ExitStatus -->
< h3 class = "fn" id = "processExit" > < a name = "processExit" > < / a > < code > [slot] < / code > < span class = "type" > void< / span > ScreenPlayWallpaper::< span class = "name" > processExit< / span > (< span class = "type" > int< / span > < i > exitCode< / i > , < span class = "type" > QProcess::ExitStatus< / span > < i > exitStatus< / i > )< / h3 >
< p > Prints the exit code if != 0.< / p >
<!-- @@@processExit -->
2020-12-26 21:14:42 +01:00
<!-- $$$setWallpaperValue[overload1]$$$setWallpaperValueconstQString&constQString&constbool -->
< h3 class = "fn" id = "setWallpaperValue" > < a name = "setWallpaperValue" > < / a > < code > [slot] < / code > < span class = "type" > void< / span > ScreenPlayWallpaper::< span class = "name" > setWallpaperValue< / span > (const < span class = "type" > QString< / span > & < i > key< / i > , const < span class = "type" > QString< / span > & < i > value< / i > , const < span class = "type" > bool< / span > < i > save< / i > = false)< / h3 >
< p > Sets a wallpaper value. We directly set the property if it is either volume, < a href = "screenplay-screenplaywallpaper.html#playbackRate-prop" > playbackRate< / a > or < a href = "screenplay-screenplaywallpaper.html#fillMode-prop" > fillMode< / a > . Otherwise it is a simple key, value json pair.< / p >
<!-- @@@setWallpaperValue -->
2020-11-22 12:24:43 +01:00
<!-- $$$getActiveSettingsJson[overload1]$$$getActiveSettingsJson -->
< h3 class = "fn" id = "getActiveSettingsJson" > < a name = "getActiveSettingsJson" > < / a > < span class = "type" > QJsonObject< / span > ScreenPlayWallpaper::< span class = "name" > getActiveSettingsJson< / span > ()< / h3 >
2020-12-26 21:14:42 +01:00
< p > Loads the project.json that contains all settings to display the wallpaper.< / p >
2020-11-22 12:24:43 +01:00
<!-- @@@getActiveSettingsJson -->
<!-- $$$replace[overload1]$$$replaceconstQString&constQString&constQString&constfloatconstFillMode::FillModeconstInstalledType::InstalledTypeconstbool -->
< h3 class = "fn" id = "replace" > < a name = "replace" > < / a > < span class = "type" > void< / span > ScreenPlayWallpaper::< span class = "name" > replace< / span > (const < span class = "type" > QString< / span > & < i > absolutePath< / i > , const < span class = "type" > QString< / span > & < i > previewImage< / i > , const < span class = "type" > QString< / span > & < i > file< / i > , const < span class = "type" > float< / span > < i > volume< / i > , const < span class = "type" > FillMode::FillMode< / span > < i > fillMode< / i > , const < span class = "type" > InstalledType::InstalledType< / span > < i > type< / i > , const < span class = "type" > bool< / span > < i > checkWallpaperVisible< / i > )< / h3 >
2020-12-26 21:14:42 +01:00
< p > Replaces the current wallpaper with the given one.< / p >
2020-11-22 12:24:43 +01:00
<!-- @@@replace -->
<!-- $$$setSDKConnection[overload1]$$$setSDKConnectionconststd::shared_ptr<SDKConnection>& -->
< h3 class = "fn" id = "setSDKConnection" > < a name = "setSDKConnection" > < / a > < span class = "type" > void< / span > ScreenPlayWallpaper::< span class = "name" > setSDKConnection< / span > (const < span class = "type" > std::shared_ptr< / span > < < span class = "type" > < a href = "screenplay-sdkconnection.html" > SDKConnection< / a > < / span > > & < i > connection< / i > )< / h3 >
2020-12-26 21:14:42 +01:00
< p > Connects to < a href = "screenplay.html" > ScreenPlay< / a > . Start a alive ping check for every 16 seconds.< / p >
2020-11-22 12:24:43 +01:00
<!-- @@@setSDKConnection -->
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 >
