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
<!-- screenplaymanager.cpp -->
2020-01-30 15:47:04 +01:00
< title > ScreenPlayManager 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 >
2019-12-05 15:30:08 +01:00
< div class = "container-fullwidth nav" > < 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 > ScreenPlayManager< / 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" > ScreenPlayManager Class< / h1 >
2020-03-31 15:35:51 +02:00
< span class = "small-subtitle" > class < a href = "screenplay.html" > ScreenPlay< / a > ::ScreenPlayManager< / span >
2019-12-05 15:24:12 +01:00
<!-- $$$ScreenPlayManager - brief -->
2019-12-08 11:38:48 +01:00
< p > The ScreenPlayManager is used to manage multiple < a href = "screenplay-screenplaywallpaper.html" > ScreenPlayWallpaper< / a > and < a href = "screenplay-screenplaywidget.html" > ScreenPlayWidget< / a > . < a href = "#details" > More...< / a > < / p >
2019-12-05 15:24:12 +01:00
<!-- @@@ScreenPlayManager -->
< div class = "table" > < table class = "alignedsummary" >
< tr > < td class = "memItemLeft rightAlign topAlign" > Header:< / td > < td class = "memItemRight bottomAlign" > < span class = "preprocessor" > #include < ScreenPlayManager> < / span >
< / td > < / tr > < / table > < / div > < ul >
< li > < a href = "screenplay-screenplaymanager-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-screenplaymanager.html#ScreenPlayManager" > ScreenPlayManager< / a > < / b > (QObject *< i > parent< / i > = nullptr)< / td > < / tr >
2019-12-05 15:24:12 +01:00
< tr > < td class = "memItemLeft rightAlign topAlign" > int < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-screenplaymanager.html#activeWallpaperCounter-prop" > activeWallpaperCounter< / a > < / b > () const< / td > < / tr >
< tr > < td class = "memItemLeft rightAlign topAlign" > int < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-screenplaymanager.html#activeWidgetsCounter-prop" > activeWidgetsCounter< / a > < / b > () const< / td > < / tr >
< / table > < / div >
< a name = "public-slots" > < / a >
< h2 id = "public-slots" > Public Slots< / h2 >
< div class = "table" > < table class = "alignedsummary" >
2020-08-11 16:20:07 +02:00
< tr > < td class = "memItemLeft rightAlign topAlign" > void < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-screenplaymanager.html#closeAllWallpapers" > closeAllWallpapers< / a > < / b > ()< / td > < / tr >
< tr > < td class = "memItemLeft rightAlign topAlign" > void < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-screenplaymanager.html#closeAllWidgets" > closeAllWidgets< / a > < / b > ()< / 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-screenplaymanager.html#closeConnection" > closeConnection< / a > < / b > (const QString & < i > appID< / i > )< / td > < / tr >
< tr > < td class = "memItemLeft rightAlign topAlign" > bool < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-screenplaymanager.html#closeConntectionByType" > closeConntectionByType< / a > < / b > (const QStringList & < i > types< / 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-screenplaymanager.html#createWallpaper" > createWallpaper< / a > < / b > (const ScreenPlay::InstalledType::InstalledType < i > type< / i > , const ScreenPlay::FillMode::FillMode < i > fillMode< / i > , const QString & < i > absoluteStoragePath< / i > , const QString & < i > previewImage< / i > , const QString & < i > file< / i > , const QVector< int> & < i > monitorIndex< / i > , const float < i > volume< / i > , const float < i > playbackRate< / i > , const QJsonObject & < i > properties< / i > , const bool < i > saveToProfilesConfigFile< / i > )< / td > < / tr >
< tr > < td class = "memItemLeft rightAlign topAlign" > void < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-screenplaymanager.html#createWidget" > createWidget< / a > < / b > (const ScreenPlay::InstalledType::InstalledType < i > type< / i > , const QPoint & < i > position< / i > , const QString & < i > absoluteStoragePath< / i > , const QString & < i > previewImage< / i > , const QJsonObject & < i > properties< / i > , const bool < i > saveToProfilesConfigFile< / i > )< / td > < / tr >
< tr > < td class = "memItemLeft rightAlign topAlign" > ScreenPlay::ScreenPlayWallpaper *< / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-screenplaymanager.html#getWallpaperByAppID" > getWallpaperByAppID< / a > < / b > (const QString & < i > appID< / i > ) const< / td > < / tr >
< tr > < td class = "memItemLeft rightAlign topAlign" > void < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-screenplaymanager.html#newConnection" > newConnection< / a > < / b > ()< / 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-screenplaymanager.html#removeAllWallpapers" > removeAllWallpapers< / a > < / b > ()< / 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-screenplaymanager.html#removeAllWidgets" > removeAllWidgets< / a > < / b > ()< / 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-screenplaymanager.html#requestProjectSettingsAtMonitorIndex" > requestProjectSettingsAtMonitorIndex< / a > < / b > (const int < i > index< / 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-screenplaymanager.html#activeWallpaperCounter-prop" > setActiveWallpaperCounter< / a > < / b > (int < i > activeWallpaperCounter< / i > )< / td > < / tr >
< tr > < td class = "memItemLeft rightAlign topAlign" > void < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-screenplaymanager.html#activeWidgetsCounter-prop" > setActiveWidgetsCounter< / a > < / b > (int < i > activeWidgetsCounter< / 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-screenplaymanager.html#setAllWallpaperValue" > setAllWallpaperValue< / a > < / b > (const QString & < i > key< / i > , const QString & < i > value< / 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-screenplaymanager.html#setWallpaperValue" > setWallpaperValue< / a > < / b > (const QString & < i > appID< / i > , const QString & < i > key< / i > , const QString & < i > value< / 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-screenplaymanager.html#setWallpaperValueAtMonitorIndex" > setWallpaperValueAtMonitorIndex< / a > < / b > (const int < i > index< / i > , const QString & < i > key< / i > , const QString & < i > value< / 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-screenplaymanager.html#activeWallpaperCounter-prop" > activeWallpaperCounterChanged< / a > < / b > (int < i > activeWallpaperCounter< / i > )< / td > < / tr >
< tr > < td class = "memItemLeft rightAlign topAlign" > void < / td > < td class = "memItemRight bottomAlign" > < b > < a href = "screenplay-screenplaymanager.html#activeWidgetsCounter-prop" > activeWidgetsCounterChanged< / a > < / b > (int < i > activeWidgetsCounter< / i > )< / td > < / tr >
< / table > < / div >
< a name = "details" > < / a >
<!-- $$$ScreenPlayManager - description -->
< div class = "descr" >
< h2 id = "details" > Detailed Description< / h2 >
2019-12-08 11:38:48 +01:00
< p > Creates and (indirectly) destroys Wallpaper and Widgets via opening and closing QLocalPipe connectons of the ScreenPlaySDK. Also responsible to set the current active wallpaper to the monitorListModel.< / p >
2019-12-05 15:24:12 +01:00
< / div >
<!-- @@@ScreenPlayManager -->
2019-12-08 11:38:48 +01:00
< div class = "func" >
< h2 > Member Function Documentation< / h2 >
2020-08-11 16:20:07 +02:00
<!-- $$$ScreenPlayManager[overload1]$$$ScreenPlayManagerQObject* -->
< h3 class = "fn" id = "ScreenPlayManager" > < a name = "ScreenPlayManager" > < / a > ScreenPlayManager::< span class = "name" > ScreenPlayManager< / span > (< span class = "type" > QObject< / span > *< i > parent< / i > = nullptr)< / h3 >
2020-03-31 15:35:51 +02:00
< p > Constructor-.< / p >
2020-01-30 15:47:04 +01:00
<!-- @@@ScreenPlayManager -->
2020-08-11 16:20:07 +02:00
<!-- $$$closeAllWallpapers[overload1]$$$closeAllWallpapers -->
< h3 class = "fn" id = "closeAllWallpapers" > < a name = "closeAllWallpapers" > < / a > < code > [slot] < / code > < span class = "type" > void< / span > ScreenPlayManager::< span class = "name" > closeAllWallpapers< / span > ()< / h3 >
< p > Closes all wallpaper connection with the following type:< / p >
< ul >
< li > videoWallpaper< / li >
< li > qmlWallpaper< / li >
< li > htmlWallpaper< / li >
< li > godotWallpaper< / li >
< / ul >
<!-- @@@closeAllWallpapers -->
<!-- $$$closeAllWidgets[overload1]$$$closeAllWidgets -->
< h3 class = "fn" id = "closeAllWidgets" > < a name = "closeAllWidgets" > < / a > < code > [slot] < / code > < span class = "type" > void< / span > ScreenPlayManager::< span class = "name" > closeAllWidgets< / span > ()< / h3 >
< p > Closes all widgets connection with the following type:< / p >
< ul >
< li > qmlWidget< / li >
< li > htmlWidget< / li >
< li > standaloneWidget< / li >
< / ul >
<!-- @@@closeAllWidgets -->
2020-11-14 19:08:09 +01:00
<!-- $$$closeConnection[overload1]$$$closeConnectionconstQString& -->
< h3 class = "fn" id = "closeConnection" > < a name = "closeConnection" > < / a > < code > [slot] < / code > < span class = "type" > bool< / span > ScreenPlayManager::< span class = "name" > closeConnection< / span > (const < span class = "type" > QString< / span > & < i > appID< / i > )< / h3 >
< p > Closes a Wallpaper or Widget connection by the given < i > appID< / i > .< / p >
<!-- @@@closeConnection -->
2020-08-11 16:20:07 +02:00
<!-- $$$closeConntectionByType[overload1]$$$closeConntectionByTypeconstQStringList& -->
2020-11-14 19:08:09 +01:00
< h3 class = "fn" id = "closeConntectionByType" > < a name = "closeConntectionByType" > < / a > < code > [slot] < / code > < span class = "type" > bool< / span > ScreenPlayManager::< span class = "name" > closeConntectionByType< / span > (const < span class = "type" > QStringList< / span > & < i > types< / i > )< / h3 >
2020-08-11 16:20:07 +02:00
< p > Closes a connection by type. Used only by < a href = "screenplay-screenplaymanager.html#closeAllWidgets" > closeAllWidgets< / a > () and < a href = "screenplay-screenplaymanager.html#closeAllWallpapers" > closeAllWallpapers< / a > ()< / p >
<!-- @@@closeConntectionByType -->
<!-- $$$createWallpaper[overload1]$$$createWallpaperconstScreenPlay::InstalledType::InstalledTypeconstScreenPlay::FillMode::FillModeconstQString&constQString&constQString&constQVector<int>&constfloatconstfloatconstQJsonObject&constbool -->
< h3 class = "fn" id = "createWallpaper" > < a name = "createWallpaper" > < / a > < code > [slot] < / code > < span class = "type" > void< / span > ScreenPlayManager::< span class = "name" > createWallpaper< / span > (const < span class = "type" > ScreenPlay::InstalledType::InstalledType< / span > < i > type< / i > , const < span class = "type" > ScreenPlay::FillMode::FillMode< / span > < i > fillMode< / i > , const < span class = "type" > QString< / span > & < i > absoluteStoragePath< / i > , const < span class = "type" > QString< / span > & < i > previewImage< / i > , const < span class = "type" > QString< / span > & < i > file< / i > , const < span class = "type" > QVector< / span > < < span class = "type" > int< / span > > & < i > monitorIndex< / i > , const < span class = "type" > float< / span > < i > volume< / i > , const < span class = "type" > float< / span > < i > playbackRate< / i > , const < span class = "type" > QJsonObject< / span > & < i > properties< / i > , const < span class = "type" > bool< / span > < i > saveToProfilesConfigFile< / i > )< / h3 >
2019-12-08 11:38:48 +01:00
< p > Creates a wallpaper with a given < i > monitorIndex< / i > list, < i > a< / i > absoluteStoragePath folder, a < i > previewImage< / i > (relative path to the absoluteStoragePath), a default < i > volume< / i > , a < i > fillMode< / i > , a < i > type< / i > (htmlWallpaper, qmlWallpaper etc.), a < i > saveToProfilesConfigFile< / i > bool only set to flase if we call the method when using via the settings on startup to skip a unnecessary save.< / p >
<!-- @@@createWallpaper -->
2020-08-11 16:20:07 +02:00
<!-- $$$createWidget[overload1]$$$createWidgetconstScreenPlay::InstalledType::InstalledTypeconstQPoint&constQString&constQString&constQJsonObject&constbool -->
< h3 class = "fn" id = "createWidget" > < a name = "createWidget" > < / a > < code > [slot] < / code > < span class = "type" > void< / span > ScreenPlayManager::< span class = "name" > createWidget< / span > (const < span class = "type" > ScreenPlay::InstalledType::InstalledType< / span > < i > type< / i > , const < span class = "type" > QPoint< / span > & < i > position< / i > , const < span class = "type" > QString< / span > & < i > absoluteStoragePath< / i > , const < span class = "type" > QString< / span > & < i > previewImage< / i > , const < span class = "type" > QJsonObject< / span > & < i > properties< / i > , const < span class = "type" > bool< / span > < i > saveToProfilesConfigFile< / i > )< / h3 >
2019-12-08 11:38:48 +01:00
< p > Creates a < a href = "screenplay-screenplaywidget.html" > ScreenPlayWidget< / a > object via a < i > absoluteStoragePath< / i > and a < i > preview< / i > image (relative path).< / p >
<!-- @@@createWidget -->
<!-- $$$getWallpaperByAppID[overload1]$$$getWallpaperByAppIDconstQString& -->
2020-08-11 16:20:07 +02:00
< h3 class = "fn" id = "getWallpaperByAppID" > < a name = "getWallpaperByAppID" > < / a > < code > [slot] < / code > < span class = "type" > < a href = "screenplay-screenplaywallpaper.html" > ScreenPlay::ScreenPlayWallpaper< / a > < / span > *ScreenPlayManager::< span class = "name" > getWallpaperByAppID< / span > (const < span class = "type" > QString< / span > & < i > appID< / i > ) const< / h3 >
2020-01-30 15:47:04 +01:00
< p > Returns < code > a< / code > < a href = "screenplay-screenplaywallpaper.html" > ScreenPlayWallpaper< / a > if successful, otherwhise < code > std::nullopt< / code > .< / p >
2019-12-08 11:38:48 +01:00
<!-- @@@getWallpaperByAppID -->
2020-08-11 16:20:07 +02:00
<!-- $$$newConnection[overload1]$$$newConnection -->
< h3 class = "fn" id = "newConnection" > < a name = "newConnection" > < / a > < code > [slot] < / code > < span class = "type" > void< / span > ScreenPlayManager::< span class = "name" > newConnection< / span > ()< / h3 >
< p > Appends a new SDKConnection object shared_ptr to the m_clients list.< / p >
<!-- @@@newConnection -->
2019-12-08 11:38:48 +01:00
<!-- $$$removeAllWallpapers[overload1]$$$removeAllWallpapers -->
< h3 class = "fn" id = "removeAllWallpapers" > < a name = "removeAllWallpapers" > < / a > < code > [slot] < / code > < span class = "type" > void< / span > ScreenPlayManager::< span class = "name" > removeAllWallpapers< / span > ()< / h3 >
< p > Removes all wallpaper entries in the profiles.json. This method will likely be removed when using nlohmann/json in the future.< / p >
<!-- @@@removeAllWallpapers -->
2020-03-31 15:35:51 +02:00
<!-- $$$removeAllWidgets[overload1]$$$removeAllWidgets -->
< h3 class = "fn" id = "removeAllWidgets" > < a name = "removeAllWidgets" > < / a > < code > [slot] < / code > < span class = "type" > void< / span > ScreenPlayManager::< span class = "name" > removeAllWidgets< / span > ()< / h3 >
< p > Removes all widgets and resets the activeWidgetCounter to 0.< / p >
<!-- @@@removeAllWidgets -->
2020-08-11 16:20:07 +02:00
<!-- $$$requestProjectSettingsAtMonitorIndex[overload1]$$$requestProjectSettingsAtMonitorIndexconstint -->
< h3 class = "fn" id = "requestProjectSettingsAtMonitorIndex" > < a name = "requestProjectSettingsAtMonitorIndex" > < / a > < code > [slot] < / code > < span class = "type" > void< / span > ScreenPlayManager::< span class = "name" > requestProjectSettingsAtMonitorIndex< / span > (const < span class = "type" > int< / span > < i > index< / i > )< / h3 >
2019-12-08 11:38:48 +01:00
< p > Request a spesific json profile to display in the active wallpaper popup on the right.< / p >
2020-08-11 16:20:07 +02:00
<!-- @@@requestProjectSettingsAtMonitorIndex -->
2019-12-08 11:38:48 +01:00
<!-- $$$setAllWallpaperValue[overload1]$$$setAllWallpaperValueconstQString&constQString& -->
< h3 class = "fn" id = "setAllWallpaperValue" > < a name = "setAllWallpaperValue" > < / a > < code > [slot] < / code > < span class = "type" > void< / span > ScreenPlayManager::< span class = "name" > setAllWallpaperValue< / span > (const < span class = "type" > QString< / span > & < i > key< / i > , const < span class = "type" > QString< / span > & < i > value< / i > )< / h3 >
< p > Convenient function to set a < i > value< / i > at a given < i > index< / i > and < i > key< / i > for all wallaper. For exmaple used to mute all wallpaper.< / p >
<!-- @@@setAllWallpaperValue -->
2020-11-14 19:08:09 +01:00
<!-- $$$setWallpaperValue[overload1]$$$setWallpaperValueconstQString&constQString&constQString& -->
< h3 class = "fn" id = "setWallpaperValue" > < a name = "setWallpaperValue" > < / a > < code > [slot] < / code > < span class = "type" > void< / span > ScreenPlayManager::< span class = "name" > setWallpaperValue< / span > (const < span class = "type" > QString< / span > & < i > appID< / i > , const < span class = "type" > QString< / span > & < i > key< / i > , const < span class = "type" > QString< / span > & < i > value< / i > )< / h3 >
2020-08-11 16:20:07 +02:00
< p > Sets a given < i > value< / i > to a given < i > key< / i > . The < i > appID< / i > is used to identify the receiver socket.< / p >
2019-12-08 11:38:48 +01:00
<!-- @@@setWallpaperValue -->
2020-08-11 16:20:07 +02:00
<!-- $$$setWallpaperValueAtMonitorIndex[overload1]$$$setWallpaperValueAtMonitorIndexconstintconstQString&constQString& -->
< h3 class = "fn" id = "setWallpaperValueAtMonitorIndex" > < a name = "setWallpaperValueAtMonitorIndex" > < / a > < code > [slot] < / code > < span class = "type" > void< / span > ScreenPlayManager::< span class = "name" > setWallpaperValueAtMonitorIndex< / span > (const < span class = "type" > int< / span > < i > index< / i > , const < span class = "type" > QString< / span > & < i > key< / i > , const < span class = "type" > QString< / span > & < i > value< / i > )< / h3 >
< p > Set a wallpaper < i > value< / i > at a given < i > index< / i > and < i > key< / i > .< / p >
<!-- @@@setWallpaperValueAtMonitorIndex -->
2019-12-08 11:38:48 +01:00
< / div >
< 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/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 >
