1
0
mirror of https://gitlab.com/kelteseth/ScreenPlay.git synced 2024-07-08 05:48:09 +02:00

Add ScreenPlayUtil and ScreenPlayShader to developer docs

Update to qdoc Qt 6.1
Add module for every project
This commit is contained in:
Elias Steurer 2021-05-13 13:05:05 +02:00
parent 7b8a4aacda
commit e8fbe8e565
79 changed files with 2112 additions and 434 deletions

View File

@ -1,11 +1,11 @@
# Run:
# C:\Qt\6.0.0\msvc2019_64\bin\qdoc.exe config.qdocconf
# C:\Qt\6.1.0\msvc2019_64\bin\qdoc.exe config.qdocconf
# in this directory. You can shift + right click in this explorer
# window and select "Open PowerShell Window here" for this.
include(C:\Qt\6.0.0\msvc2019_64\doc\global\qt-cpp-defines.qdocconf)
include(C:\Qt\6.0.0\msvc2019_64\doc\global\compat.qdocconf)
include(C:\Qt\6.0.0\msvc2019_64\doc\global\fileextensions.qdocconf)
include(C:\Qt\6.1.0\msvc2019_64\doc\global\qt-cpp-defines.qdocconf)
include(C:\Qt\6.1.0\msvc2019_64\doc\global\compat.qdocconf)
include(C:\Qt\6.1.0\msvc2019_64\doc\global\fileextensions.qdocconf)
descripton = ScreenPlay is an open source cross plattform app for displaying Wallpaper, Widgets and AppDrawer.
language = Cpp
@ -20,36 +20,45 @@ sourcedirs += ../ScreenPlayWallpaper/src/
sourcedirs += ../ScreenPlayWallpaper/
sourcedirs += ../ScreenPlayWidget/src/
sourcedirs += ../ScreenPlayWidget/
sourcedirs += ../ScreenPlayShader/
sourcedirs += ../ScreenPlayUtil/
sourcedirs += ../ScreenPlayUtil/src/
# Header
headerdirs += ../ScreenPlay/src/
headerdirs += ../ScreenPlay/
headerdirs += ../ScreenPlaySDK/
headerdirs += ../ScreenPlaySDK/inc/
headerdirs += ../ScreenPlaySysInfo/
headerdirs += ../ScreenPlayWallpaper/src/
headerdirs += ../ScreenPlayWallpaper/
headerdirs += ../ScreenPlayWidget/src/
headerdirs += ../ScreenPlayWidget/
headerdirs += ../ScreenPlayShader/
headerdirs += ../ScreenPlayUtil/inc/
# Include
includepaths += ../ScreenPlay/src/
includepaths += ../ScreenPlay/
includepaths += ../ScreenPlaySDK/
includepaths += ../ScreenPlaySDK/src/
includepaths += ../ScreenPlaySysInfo/
includepaths += ../ScreenPlayWallpaper/src/
includepaths += ../ScreenPlayWallpaper/
includepaths += ../ScreenPlayWidget/src/
includepaths += ../ScreenPlayWidget/
includepaths += ../ScreenPlayShader/
includepaths += ../ScreenPlayUtil/
# qt
includepaths += C:/Qt/6.0.0/msvc2019_64/include/
includepaths += C:/Qt/6.0.0/msvc2019_64/include/QtCore/
includepaths += C:/Qt/6.0.0/msvc2019_64/include/QtGui/
includepaths += C:/Qt/6.0.0/msvc2019_64/include/QtQml/
includepaths += C:/Qt/6.0.0/msvc2019_64/include/QtWebEngine/
includepaths += C:/Qt/6.0.0/msvc2019_64/include/QtNetwork/
includepaths += C:/Qt/6.0.0/msvc2019_64/include/QtQuick/
includepaths += C:/Qt/6.0.0/msvc2019_64/include/QtQuickControls2/
includepaths += C:/Qt/6.1.0/msvc2019_64/include/
includepaths += C:/Qt/6.1.0/msvc2019_64/include/QtCore/
includepaths += C:/Qt/6.1.0/msvc2019_64/include/QtGui/
includepaths += C:/Qt/6.1.0/msvc2019_64/include/QtQml/
includepaths += C:/Qt/6.1.0/msvc2019_64/include/QtWebEngine/
includepaths += C:/Qt/6.1.0/msvc2019_64/include/QtNetwork/
includepaths += C:/Qt/6.1.0/msvc2019_64/include/QtQuick/
includepaths += C:/Qt/6.1.0/msvc2019_64/include/QtQuickControls2/

View File

@ -16,12 +16,17 @@ h2 {
}
a {
color:#41cd52 !important;
color:#ff6e42 !important;
text-decoration: none !important;
}
img {
box-shadow: 0 1px 3px rgba(0,0,0,0.12), 0 1px 2px rgba(0,0,0,0.24);
}
.table > :not(caption) > * > * {
border-color: #ececec;
}
p {
color: #546E7A;
}

View File

@ -0,0 +1,89 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<!-- basewindow.cpp -->
<title>List of All Members for BaseWindow | ScreenPlay</title>
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
</head>
<body>
<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 ">
<li>BaseWindow</li>
<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">List of All Members for BaseWindow</h1>
<p>This is the complete list of members for <a href="basewindow.html">BaseWindow</a>, including inherited members.</p>
<div class="table"><table class="propsummary">
<tr><td class="topAlign"><ul>
<li class="fn"><span class="name"><b><a href="basewindow.html#OSVersion-prop">OSVersionChanged</a></b></span>(QString)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#activeScreensList-prop">activeScreensListChanged</a></b></span>(QVector&lt;int&gt;)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#appID-prop">appIDChanged</a></b></span>(QString)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#basePath-prop">basePathChanged</a></b></span>(QString)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#canFade-prop">canFadeChanged</a></b></span>(bool)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#checkWallpaperVisible-prop">checkWallpaperVisibleChanged</a></b></span>(bool)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#contentBasePath-prop">contentBasePathChanged</a></b></span>(const QString &amp;)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#currentTime-prop">currentTimeChanged</a></b></span>(float)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#debugMode-prop">debugModeChanged</a></b></span>(bool)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#fillMode-prop">fillModeChanged</a></b></span>(QString)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#fullContentPath-prop">fullContentPathChanged</a></b></span>(QString)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#getApplicationPath">getApplicationPath</a></b></span>() : QString</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#height-prop">heightChanged</a></b></span>(int)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#isPlaying-prop">isPlayingChanged</a></b></span>(bool)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#loadFromFile">loadFromFile</a></b></span>(const QString &amp;) : QString</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#loops-prop">loopsChanged</a></b></span>(bool)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#messageReceived">messageReceived</a></b></span>(QString, QString)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#muted-prop">mutedChanged</a></b></span>(bool)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#playbackRate-prop">playbackRateChanged</a></b></span>(float)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#replaceWallpaper">replaceWallpaper</a></b></span>(const QString, const QString, const float, const QString, const QString, const bool)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#sdk-prop">sdkChanged</a></b></span>(int *)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#activeScreensList-prop">setActiveScreensList</a></b></span>(QVector&lt;int&gt;)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#appID-prop">setAppID</a></b></span>(QString)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#basePath-prop">setBasePath</a></b></span>(QString)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#canFade-prop">setCanFade</a></b></span>(bool)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#checkWallpaperVisible-prop">setCheckWallpaperVisible</a></b></span>(bool)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#contentBasePath-prop">setContentBasePath</a></b></span>(const QString &amp;)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#currentTime-prop">setCurrentTime</a></b></span>(float)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#debugMode-prop">setDebugMode</a></b></span>(bool)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#fillMode-prop">setFillMode</a></b></span>(QString)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#fullContentPath-prop">setFullContentPath</a></b></span>(QString)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#height-prop">setHeight</a></b></span>(int)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#isPlaying-prop">setIsPlaying</a></b></span>(bool)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#loops-prop">setLoops</a></b></span>(bool)</li>
</ul></td><td class="topAlign"><ul>
<li class="fn"><span class="name"><b><a href="basewindow.html#muted-prop">setMuted</a></b></span>(bool)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#OSVersion-prop">setOSVersion</a></b></span>(QString)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#playbackRate-prop">setPlaybackRate</a></b></span>(float)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#sdk-prop">setSdk</a></b></span>(int *)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#type-prop">setType</a></b></span>(int)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#visualsPaused-prop">setVisualsPaused</a></b></span>(bool)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#volume-prop">setVolume</a></b></span>(float)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#width-prop">setWidth</a></b></span>(int)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#type-prop">typeChanged</a></b></span>(int)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#visualsPaused-prop">visualsPausedChanged</a></b></span>(bool)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#volume-prop">volumeChanged</a></b></span>(float)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#width-prop">widthChanged</a></b></span>(int)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#OSVersion-prop">OSVersion</a></b></span>() const : QString</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#activeScreensList-prop">activeScreensList</a></b></span>() const : QVector&lt;int&gt;</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#appID-prop">appID</a></b></span>() const : QString</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#basePath-prop">basePath</a></b></span>() const : QString</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#canFade-prop">canFade</a></b></span>() const : bool</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#checkWallpaperVisible-prop">checkWallpaperVisible</a></b></span>() const : bool</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#contentBasePath-prop">contentBasePath</a></b></span>() const : const QString &amp;</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#currentTime-prop">currentTime</a></b></span>() const : float</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#debugMode-prop">debugMode</a></b></span>() const : bool</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#fillMode-prop">fillMode</a></b></span>() const : QString</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#fullContentPath-prop">fullContentPath</a></b></span>() const : QString</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#height-prop">height</a></b></span>() const : int</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#isPlaying-prop">isPlaying</a></b></span>() const : bool</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#loops-prop">loops</a></b></span>() const : bool</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#muted-prop">muted</a></b></span>() const : bool</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#playbackRate-prop">playbackRate</a></b></span>() const : float</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#sdk-prop">sdk</a></b></span>() const : int *</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#type-prop">type</a></b></span>() const : int</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#visualsPaused-prop">visualsPaused</a></b></span>() const : bool</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#volume-prop">volume</a></b></span>() const : float</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#width-prop">width</a></b></span>() const : int</li>
</ul>
</td></tr>
</table></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/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>
</html>

138
Docs/html/basewindow.html Normal file
View File

@ -0,0 +1,138 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<!-- basewindow.cpp -->
<title>BaseWindow Class | ScreenPlay</title>
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
</head>
<body>
<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 ">
<li>BaseWindow</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">BaseWindow Class</h1>
<!-- $$$BaseWindow-brief -->
<p>. <a href="#details">More...</a></p>
<!-- @@@BaseWindow -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include &lt;BaseWindow&gt;</span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherited By:</td><td class="memItemRight bottomAlign"> <p><a href="winwindow.html">WinWindow</a></p>
</td></tr></table></div><ul>
<li><a href="basewindow-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">
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#OSVersion-prop">OSVersion</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QVector&lt;int&gt; </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#activeScreensList-prop">activeScreensList</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#appID-prop">appID</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#basePath-prop">basePath</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#canFade-prop">canFade</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#checkWallpaperVisible-prop">checkWallpaperVisible</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QString &amp;</td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#contentBasePath-prop">contentBasePath</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> float </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#currentTime-prop">currentTime</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#debugMode-prop">debugMode</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#fillMode-prop">fillMode</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#fullContentPath-prop">fullContentPath</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#height-prop">height</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#isPlaying-prop">isPlaying</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#loops-prop">loops</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#muted-prop">muted</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> float </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#playbackRate-prop">playbackRate</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int *</td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#sdk-prop">sdk</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#type-prop">type</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#visualsPaused-prop">visualsPaused</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> float </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#volume-prop">volume</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#width-prop">width</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">
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#getApplicationPath">getApplicationPath</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#loadFromFile">loadFromFile</a></b>(const QString &amp;<i>filename</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#messageReceived">messageReceived</a></b>(QString <i>key</i>, QString <i>value</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#replaceWallpaper">replaceWallpaper</a></b>(const QString <i>absolutePath</i>, const QString <i>file</i>, const float <i>volume</i>, const QString <i>fillMode</i>, const QString <i>type</i>, const bool <i>checkWallpaperVisible</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#activeScreensList-prop">setActiveScreensList</a></b>(QVector&lt;int&gt; <i>activeScreensList</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="basewindow.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="basewindow.html#basePath-prop">setBasePath</a></b>(QString <i>basePath</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#canFade-prop">setCanFade</a></b>(bool <i>canFade</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#checkWallpaperVisible-prop">setCheckWallpaperVisible</a></b>(bool <i>checkWallpaperVisible</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#contentBasePath-prop">setContentBasePath</a></b>(const QString &amp;<i>contentBasePath</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#currentTime-prop">setCurrentTime</a></b>(float <i>currentTime</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#debugMode-prop">setDebugMode</a></b>(bool <i>debugMode</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#fillMode-prop">setFillMode</a></b>(QString <i>fillMode</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#fullContentPath-prop">setFullContentPath</a></b>(QString <i>fullContentPath</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#height-prop">setHeight</a></b>(int <i>height</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#isPlaying-prop">setIsPlaying</a></b>(bool <i>isPlaying</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#loops-prop">setLoops</a></b>(bool <i>loops</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#muted-prop">setMuted</a></b>(bool <i>muted</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#OSVersion-prop">setOSVersion</a></b>(QString <i>OSVersion</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#playbackRate-prop">setPlaybackRate</a></b>(float <i>playbackRate</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#sdk-prop">setSdk</a></b>(int *<i>sdk</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#type-prop">setType</a></b>(int <i>type</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#visualsPaused-prop">setVisualsPaused</a></b>(bool <i>visualsPaused</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#volume-prop">setVolume</a></b>(float <i>volume</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#width-prop">setWidth</a></b>(int <i>width</i>)</td></tr>
</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="basewindow.html#OSVersion-prop">OSVersionChanged</a></b>(QString <i>OSVersion</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#activeScreensList-prop">activeScreensListChanged</a></b>(QVector&lt;int&gt; <i>activeScreensList</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="basewindow.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="basewindow.html#basePath-prop">basePathChanged</a></b>(QString <i>basePath</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#canFade-prop">canFadeChanged</a></b>(bool <i>canFade</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#checkWallpaperVisible-prop">checkWallpaperVisibleChanged</a></b>(bool <i>checkWallpaperVisible</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#contentBasePath-prop">contentBasePathChanged</a></b>(const QString &amp;)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#currentTime-prop">currentTimeChanged</a></b>(float <i>currentTime</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#debugMode-prop">debugModeChanged</a></b>(bool <i>debugMode</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#fillMode-prop">fillModeChanged</a></b>(QString <i>fillMode</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#fullContentPath-prop">fullContentPathChanged</a></b>(QString <i>fullContentPath</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#height-prop">heightChanged</a></b>(int <i>height</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#isPlaying-prop">isPlayingChanged</a></b>(bool <i>isPlaying</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#loops-prop">loopsChanged</a></b>(bool <i>loops</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#muted-prop">mutedChanged</a></b>(bool <i>muted</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#playbackRate-prop">playbackRateChanged</a></b>(float <i>playbackRate</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#sdk-prop">sdkChanged</a></b>(int *<i>sdk</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#type-prop">typeChanged</a></b>(int <i>type</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#visualsPaused-prop">visualsPausedChanged</a></b>(bool <i>visualsPaused</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#volume-prop">volumeChanged</a></b>(float <i>volume</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="basewindow.html#width-prop">widthChanged</a></b>(int <i>width</i>)</td></tr>
</table></div>
<a name="details"></a>
<!-- $$$BaseWindow-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
</div>
<!-- @@@BaseWindow -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$getApplicationPath[overload1]$$$getApplicationPath -->
<h3 class="fn" id="getApplicationPath"><a name="getApplicationPath"></a><code>[slot] </code><span class="type">QString</span> BaseWindow::<span class="name">getApplicationPath</span>()</h3>
<p>This public slot is for QML usage.</p>
<!-- @@@getApplicationPath -->
<!-- $$$loadFromFile[overload1]$$$loadFromFileconstQString& -->
<h3 class="fn" id="loadFromFile"><a name="loadFromFile"></a><code>[slot] </code><span class="type">QString</span> BaseWindow::<span class="name">loadFromFile</span>(const <span class="type">QString</span> &amp;<i>filename</i>)</h3>
<p>Used for loading shader. Loading shader relative to the qml file will be available in Qt 6</p>
<!-- @@@loadFromFile -->
<!-- $$$messageReceived[overload1]$$$messageReceivedQStringQString -->
<h3 class="fn" id="messageReceived"><a name="messageReceived"></a><code>[virtual slot] </code><span class="type">void</span> BaseWindow::<span class="name">messageReceived</span>(<span class="type">QString</span> <i>key</i>, <span class="type">QString</span> <i>value</i>)</h3>
<p>messageReceived.</p>
<!-- @@@messageReceived -->
<!-- $$$replaceWallpaper[overload1]$$$replaceWallpaperconstQStringconstQStringconstfloatconstQStringconstQStringconstbool -->
<h3 class="fn" id="replaceWallpaper"><a name="replaceWallpaper"></a><code>[virtual slot] </code><span class="type">void</span> BaseWindow::<span class="name">replaceWallpaper</span>(const <span class="type">QString</span> <i>absolutePath</i>, const <span class="type">QString</span> <i>file</i>, const <span class="type">float</span> <i>volume</i>, const <span class="type">QString</span> <i>fillMode</i>, const <span class="type">QString</span> <i>type</i>, const <span class="type">bool</span> <i>checkWallpaperVisible</i>)</h3>
<p>replaceWallpaper.</p>
<!-- @@@replaceWallpaper -->
</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/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>
</html>

View File

@ -0,0 +1,23 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<!-- cpu.cpp -->
<title>List of All Members for CPU | ScreenPlay</title>
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
</head>
<body>
<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 ">
<li>CPU</li>
<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">List of All Members for CPU</h1>
<p>This is the complete list of members for <a href="cpu.html">CPU</a>, including inherited members.</p>
<ul>
<li class="fn"><span class="name"><b><a href="cpu.html#tickRate-prop">setTickRate</a></b></span>(int)</li>
<li class="fn"><span class="name"><b><a href="cpu.html#tickRate-prop">tickRateChanged</a></b></span>(int)</li>
<li class="fn"><span class="name"><b><a href="cpu.html#usage-prop">usageChanged</a></b></span>(float)</li>
<li class="fn"><span class="name"><b><a href="cpu.html#tickRate-prop">tickRate</a></b></span>() const : int</li>
<li class="fn"><span class="name"><b><a href="cpu.html#usage-prop">usage</a></b></span>() const : float</li>
</ul>
<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>
</html>

56
Docs/html/cpu.html Normal file
View File

@ -0,0 +1,56 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<!-- cpu.cpp -->
<title>CPU Class | ScreenPlay</title>
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
</head>
<body>
<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 ">
<li>CPU</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">CPU Class</h1>
<!-- $$$CPU-brief -->
<p>. <a href="#details">More...</a></p>
<!-- @@@CPU -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include &lt;CPU&gt;</span>
</td></tr></table></div><ul>
<li><a href="cpu-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">
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="cpu.html#tickRate-prop">tickRate</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> float </td><td class="memItemRight bottomAlign"><b><a href="cpu.html#usage-prop">usage</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">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="cpu.html#tickRate-prop">setTickRate</a></b>(int <i>tickRate</i>)</td></tr>
</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="cpu.html#tickRate-prop">tickRateChanged</a></b>(int <i>tickRate</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="cpu.html#usage-prop">usageChanged</a></b>(float <i>usage</i>)</td></tr>
</table></div>
<a name="details"></a>
<!-- $$$CPU-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
</div>
<!-- @@@CPU -->
<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>
</html>

View File

@ -0,0 +1,33 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<!-- gpu.cpp -->
<title>List of All Members for GPU | ScreenPlay</title>
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
</head>
<body>
<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 ">
<li>GPU</li>
<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">List of All Members for GPU</h1>
<p>This is the complete list of members for <a href="gpu.html">GPU</a>, including inherited members.</p>
<ul>
<li class="fn"><span class="name"><b><a href="gpu.html#cacheSize-prop">cacheSizeChanged</a></b></span>(int)</li>
<li class="fn"><span class="name"><b><a href="gpu.html#maxFrequency-prop">maxFrequencyChanged</a></b></span>(int)</li>
<li class="fn"><span class="name"><b><a href="gpu.html#name-prop">nameChanged</a></b></span>(const QString &amp;)</li>
<li class="fn"><span class="name"><b><a href="gpu.html#ramSize-prop">ramSizeChanged</a></b></span>(int)</li>
<li class="fn"><span class="name"><b><a href="gpu.html#cacheSize-prop">setCacheSize</a></b></span>(int)</li>
<li class="fn"><span class="name"><b><a href="gpu.html#maxFrequency-prop">setMaxFrequency</a></b></span>(int)</li>
<li class="fn"><span class="name"><b><a href="gpu.html#name-prop">setName</a></b></span>(const QString &amp;)</li>
<li class="fn"><span class="name"><b><a href="gpu.html#ramSize-prop">setRamSize</a></b></span>(int)</li>
<li class="fn"><span class="name"><b><a href="gpu.html#vendor-prop">setVendor</a></b></span>(const QString &amp;)</li>
<li class="fn"><span class="name"><b><a href="gpu.html#vendor-prop">vendorChanged</a></b></span>(const QString &amp;)</li>
<li class="fn"><span class="name"><b><a href="gpu.html#cacheSize-prop">cacheSize</a></b></span>() const : int</li>
<li class="fn"><span class="name"><b><a href="gpu.html#maxFrequency-prop">maxFrequency</a></b></span>() const : int</li>
<li class="fn"><span class="name"><b><a href="gpu.html#name-prop">name</a></b></span>() const : const QString &amp;</li>
<li class="fn"><span class="name"><b><a href="gpu.html#ramSize-prop">ramSize</a></b></span>() const : int</li>
<li class="fn"><span class="name"><b><a href="gpu.html#vendor-prop">vendor</a></b></span>() const : const QString &amp;</li>
</ul>
<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>
</html>

66
Docs/html/gpu.html Normal file
View File

@ -0,0 +1,66 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<!-- gpu.cpp -->
<title>GPU Class | ScreenPlay</title>
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
</head>
<body>
<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 ">
<li>GPU</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">GPU Class</h1>
<!-- $$$GPU-brief -->
<p>. <a href="#details">More...</a></p>
<!-- @@@GPU -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include &lt;GPU&gt;</span>
</td></tr></table></div><ul>
<li><a href="gpu-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">
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="gpu.html#cacheSize-prop">cacheSize</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="gpu.html#maxFrequency-prop">maxFrequency</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QString &amp;</td><td class="memItemRight bottomAlign"><b><a href="gpu.html#name-prop">name</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="gpu.html#ramSize-prop">ramSize</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QString &amp;</td><td class="memItemRight bottomAlign"><b><a href="gpu.html#vendor-prop">vendor</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">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="gpu.html#cacheSize-prop">setCacheSize</a></b>(int <i>cacheSize</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="gpu.html#maxFrequency-prop">setMaxFrequency</a></b>(int <i>maxFrequency</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="gpu.html#name-prop">setName</a></b>(const QString &amp;<i>name</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="gpu.html#ramSize-prop">setRamSize</a></b>(int <i>ramSize</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="gpu.html#vendor-prop">setVendor</a></b>(const QString &amp;<i>vendor</i>)</td></tr>
</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="gpu.html#cacheSize-prop">cacheSizeChanged</a></b>(int <i>cacheSize</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="gpu.html#maxFrequency-prop">maxFrequencyChanged</a></b>(int <i>maxFrequency</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="gpu.html#name-prop">nameChanged</a></b>(const QString &amp;<i>name</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="gpu.html#ramSize-prop">ramSizeChanged</a></b>(int <i>ramSize</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="gpu.html#vendor-prop">vendorChanged</a></b>(const QString &amp;<i>vendor</i>)</td></tr>
</table></div>
<a name="details"></a>
<!-- $$$GPU-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
</div>
<!-- @@@GPU -->
<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>
</html>

View File

@ -0,0 +1,32 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<!-- ram.cpp -->
<title>List of All Members for RAM | ScreenPlay</title>
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
</head>
<body>
<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 ">
<li>RAM</li>
<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">List of All Members for RAM</h1>
<p>This is the complete list of members for <a href="ram.html">RAM</a>, including inherited members.</p>
<ul>
<li class="fn"><span class="name"><b><a href="ram.html#long-prop">totalPagingMemoryChanged</a></b></span>(unsigned long long)</li>
<li class="fn"><span class="name"><b><a href="ram.html#long-prop">totalPhysicalMemoryChanged</a></b></span>(unsigned long long)</li>
<li class="fn"><span class="name"><b><a href="ram.html#long-prop">totalVirtualMemoryChanged</a></b></span>(unsigned long long)</li>
<li class="fn"><span class="name"><b><a href="ram.html#usage-prop">usageChanged</a></b></span>(float)</li>
<li class="fn"><span class="name"><b><a href="ram.html#long-prop">usedPagingMemoryChanged</a></b></span>(unsigned long long)</li>
<li class="fn"><span class="name"><b><a href="ram.html#long-prop">usedPhysicalMemoryChanged</a></b></span>(unsigned long long)</li>
<li class="fn"><span class="name"><b><a href="ram.html#long-prop">usedVirtualMemoryChanged</a></b></span>(unsigned long long)</li>
<li class="fn"><span class="name"><b><a href="ram.html#long-prop">totalPagingMemory</a></b></span>() const : unsigned long long</li>
<li class="fn"><span class="name"><b><a href="ram.html#long-prop">totalPhysicalMemory</a></b></span>() const : unsigned long long</li>
<li class="fn"><span class="name"><b><a href="ram.html#long-prop">totalVirtualMemory</a></b></span>() const : unsigned long long</li>
<li class="fn"><span class="name"><b><a href="ram.html#usage-prop">usage</a></b></span>() const : float</li>
<li class="fn"><span class="name"><b><a href="ram.html#long-prop">usedPagingMemory</a></b></span>() const : unsigned long long</li>
<li class="fn"><span class="name"><b><a href="ram.html#long-prop">usedPhysicalMemory</a></b></span>() const : unsigned long long</li>
<li class="fn"><span class="name"><b><a href="ram.html#long-prop">usedVirtualMemory</a></b></span>() const : unsigned long long</li>
</ul>
<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>
</html>

60
Docs/html/ram.html Normal file
View File

@ -0,0 +1,60 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<!-- ram.cpp -->
<title>RAM Class | ScreenPlay</title>
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
</head>
<body>
<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 ">
<li>RAM</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="#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">RAM Class</h1>
<!-- $$$RAM-brief -->
<p>. <a href="#details">More...</a></p>
<!-- @@@RAM -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include &lt;RAM&gt;</span>
</td></tr></table></div><ul>
<li><a href="ram-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">
<tr><td class="memItemLeft rightAlign topAlign"> unsigned long long </td><td class="memItemRight bottomAlign"><b><a href="ram.html#long-prop">totalPagingMemory</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> unsigned long long </td><td class="memItemRight bottomAlign"><b><a href="ram.html#long-prop">totalPhysicalMemory</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> unsigned long long </td><td class="memItemRight bottomAlign"><b><a href="ram.html#long-prop">totalVirtualMemory</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> float </td><td class="memItemRight bottomAlign"><b><a href="ram.html#usage-prop">usage</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> unsigned long long </td><td class="memItemRight bottomAlign"><b><a href="ram.html#long-prop">usedPagingMemory</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> unsigned long long </td><td class="memItemRight bottomAlign"><b><a href="ram.html#long-prop">usedPhysicalMemory</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> unsigned long long </td><td class="memItemRight bottomAlign"><b><a href="ram.html#long-prop">usedVirtualMemory</a></b>() const</td></tr>
</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="ram.html#long-prop">totalPagingMemoryChanged</a></b>(unsigned long long <i>totalPagingMemory</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="ram.html#long-prop">totalPhysicalMemoryChanged</a></b>(unsigned long long <i>totalPhysicalMemory</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="ram.html#long-prop">totalVirtualMemoryChanged</a></b>(unsigned long long <i>totalVirtualMemory</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="ram.html#usage-prop">usageChanged</a></b>(float <i>usage</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="ram.html#long-prop">usedPagingMemoryChanged</a></b>(unsigned long long <i>usedPagingMemory</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="ram.html#long-prop">usedPhysicalMemoryChanged</a></b>(unsigned long long <i>usedPhysicalMemory</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="ram.html#long-prop">usedVirtualMemoryChanged</a></b>(unsigned long long <i>usedVirtualMemory</i>)</td></tr>
</table></div>
<a name="details"></a>
<!-- $$$RAM-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
</div>
<!-- @@@RAM -->
<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>
</html>

View File

@ -21,9 +21,9 @@
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">App Class</h1>
<span class="small-subtitle">class <a href="screenplay.html">ScreenPlay</a>::App</span>
<span class="small-subtitle">class <a href="screenplay-module.html">ScreenPlay</a>::App</span>
<!-- $$$App-brief -->
<p>The App class contains all members for <a href="screenplay.html">ScreenPlay</a>. <a href="#details">More...</a></p>
<p>The App class contains all members for <a href="screenplay-module.html">ScreenPlay</a>. <a href="#details">More...</a></p>
<!-- @@@App -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include &lt;App&gt;</span>
@ -111,19 +111,19 @@
<h2>Member Function Documentation</h2>
<!-- $$$App[overload1]$$$App -->
<h3 class="fn" id="App"><a name="App"></a>App::<span class="name">App</span>()</h3>
<p>Constructor creates and holds all classes used by <a href="screenplay.html">ScreenPlay</a> via unique_ptr or shared_ptr.</p>
<p>Constructor creates and holds all classes used by <a href="screenplay-module.html">ScreenPlay</a> via unique_ptr or shared_ptr.</p>
<!-- @@@App -->
<!-- $$$exit[overload1]$$$exit -->
<h3 class="fn" id="exit"><a name="exit"></a><code>[slot] </code><span class="type">void</span> App::<span class="name">exit</span>()</h3>
<p>Tries to send the telemetry quit event before we call quit ourself.</p>
<p>Calls QApplication quit() and can be used to do additional tasks before exiting.</p>
<!-- @@@exit -->
<!-- $$$loadSteamPlugin[overload1]$$$loadSteamPlugin -->
<h3 class="fn" id="loadSteamPlugin"><a name="loadSteamPlugin"></a><code>[slot] </code><span class="type">bool</span> App::<span class="name">loadSteamPlugin</span>()</h3>
<p>Loads the Steam plugin when needed. This enables to start <a href="screenplay.html">ScreenPlay</a> via OS autostart without waiting for Steam first.</p>
<p>Loads the Steam plugin when needed. This enables to start <a href="screenplay-module.html">ScreenPlay</a> via OS autostart without waiting for Steam first.</p>
<!-- @@@loadSteamPlugin -->
<!-- $$$init[overload1]$$$init -->
<h3 class="fn" id="init"><a name="init"></a><span class="type">void</span> App::<span class="name">init</span>()</h3>
<p>Used for initialization after the constructor. The sole purpose is to check if another <a href="screenplay.html">ScreenPlay</a> instance is running and then quit early. This is also because we cannot call QApplication::quit(); in the SDKConnector before the app.exec(); ( the Qt main event loop ) has started.</p>
<p>Used for initialization after the constructor. The sole purpose is to check if another <a href="screenplay-module.html">ScreenPlay</a> instance is running and then quit early. This is also because we cannot call QApplication::quit(); in the SDKConnector before the app.exec(); ( the Qt main event loop ) has started.</p>
<!-- @@@init -->
</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/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>

View File

@ -17,7 +17,7 @@
<li class="fn"><span class="name"><b><a href="screenplay-create.html#Create">Create</a></b></span>(const std::shared_ptr&lt;GlobalVariables&gt; &amp;, QObject *)</li>
<li class="fn"><span class="name"><b><a href="screenplay-create.html#abortAndCleanup">abortAndCleanup</a></b></span>()</li>
<li class="fn"><span class="name"><b><a href="screenplay-create.html#ffmpegOutput-prop">appendFfmpegOutput</a></b></span>(QString)</li>
<li class="fn"><span class="name"><b><a href="screenplay-create.html#createWallpaperStart">createWallpaperStart</a></b></span>(QString, Create::VideoCodec)</li>
<li class="fn"><span class="name"><b><a href="screenplay-create.html#createWallpaperStart">createWallpaperStart</a></b></span>(QString, Create::VideoCodec, const int)</li>
<li class="fn"><span class="name"><b><a href="screenplay-create.html#ffmpegOutput-prop">ffmpegOutputChanged</a></b></span>(QString)</li>
<li class="fn"><span class="name"><b><a href="screenplay-create.html#progress-prop">progressChanged</a></b></span>(float)</li>
<li class="fn"><span class="name"><b><a href="screenplay-create.html#saveWallpaper">saveWallpaper</a></b></span>(QString, QString, QString, QString, QString, ScreenPlay::Create::VideoCodec, QVector&lt;QString&gt;)</li>

View File

@ -21,7 +21,7 @@
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">Create Class</h1>
<span class="small-subtitle">class <a href="screenplay.html">ScreenPlay</a>::Create</span>
<span class="small-subtitle">class <a href="screenplay-module.html">ScreenPlay</a>::Create</span>
<!-- $$$Create-brief -->
<p>Baseclass for creating wallapers, widgets and the corresponding wizards. <a href="#details">More...</a></p>
<!-- @@@Create -->
@ -44,7 +44,7 @@
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-create.html#abortAndCleanup">abortAndCleanup</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-create.html#ffmpegOutput-prop">appendFfmpegOutput</a></b>(QString <i>ffmpegOutput</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-create.html#createWallpaperStart">createWallpaperStart</a></b>(QString <i>videoPath</i>, Create::VideoCodec <i>codec</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-create.html#createWallpaperStart">createWallpaperStart</a></b>(QString <i>videoPath</i>, Create::VideoCodec <i>codec</i>, const int <i>quality</i> = 50)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-create.html#saveWallpaper">saveWallpaper</a></b>(QString <i>title</i>, QString <i>description</i>, QString <i>filePath</i>, QString <i>previewImagePath</i>, QString <i>youtube</i>, ScreenPlay::Create::VideoCodec <i>codec</i>, QVector&lt;QString&gt; <i>tags</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-create.html#progress-prop">setProgress</a></b>(float <i>progress</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-create.html#workingDir-prop">setWorkingDir</a></b>(const QString &amp;<i>workingDir</i>)</td></tr>
@ -77,8 +77,8 @@
<h3 class="fn" id="abortAndCleanup"><a name="abortAndCleanup"></a><code>[slot] </code><span class="type">void</span> Create::<span class="name">abortAndCleanup</span>()</h3>
<p>This method is called when the user manually aborts the wallpaper import.</p>
<!-- @@@abortAndCleanup -->
<!-- $$$createWallpaperStart[overload1]$$$createWallpaperStartQStringCreate::VideoCodec -->
<h3 class="fn" id="createWallpaperStart"><a name="createWallpaperStart"></a><code>[slot] </code><span class="type">void</span> Create::<span class="name">createWallpaperStart</span>(<span class="type">QString</span> <i>videoPath</i>, <span class="type">Create::VideoCodec</span> <i>codec</i>)</h3>
<!-- $$$createWallpaperStart[overload1]$$$createWallpaperStartQStringCreate::VideoCodecconstint -->
<h3 class="fn" id="createWallpaperStart"><a name="createWallpaperStart"></a><code>[slot] </code><span class="type">void</span> Create::<span class="name">createWallpaperStart</span>(<span class="type">QString</span> <i>videoPath</i>, <span class="type">Create::VideoCodec</span> <i>codec</i>, const <span class="type">int</span> <i>quality</i> = 50)</h3>
<p>Starts the process.</p>
<!-- @@@createWallpaperStart -->
<!-- $$$saveWallpaper[overload1]$$$saveWallpaperQStringQStringQStringQStringQStringScreenPlay::Create::VideoCodecQVector<QString> -->

View File

@ -13,13 +13,13 @@
<h1 class="title">List of All Members for CreateImportVideo</h1>
<p>This is the complete list of members for <a href="screenplay-createimportvideo.html">ScreenPlay::CreateImportVideo</a>, including inherited members.</p>
<ul>
<li class="fn"><span class="name"><b><a href="screenplay-createimportvideo.html#CreateImportVideo-2">CreateImportVideo</a></b></span>(const QString &amp;, const QString &amp;, const QStringList &amp;, QObject *)</li>
<li class="fn"><span class="name"><b><a href="screenplay-createimportvideo.html#CreateImportVideo-2">CreateImportVideo</a></b></span>(const QString &amp;, const QString &amp;, const QString &amp;, const int, QObject *)</li>
<li class="fn"><span class="name"><b><a href="screenplay-createimportvideo.html#CreateImportVideo-1">CreateImportVideo</a></b></span>(QObject *)</li>
<li class="fn"><span class="name"><b><a href="screenplay-createimportvideo.html#createWallpaperGifPreview">createWallpaperGifPreview</a></b></span>() : bool</li>
<li class="fn"><span class="name"><b><a href="screenplay-createimportvideo.html#createWallpaperImagePreview">createWallpaperImagePreview</a></b></span>() : bool</li>
<li class="fn"><span class="name"><b><a href="screenplay-createimportvideo.html#createWallpaperImageThumbnailPreview">createWallpaperImageThumbnailPreview</a></b></span>() : bool</li>
<li class="fn"><span class="name"><b><a href="screenplay-createimportvideo.html#createWallpaperInfo">createWallpaperInfo</a></b></span>() : bool</li>
<li class="fn"><span class="name"><b><a href="screenplay-createimportvideo.html#createWallpaperVideo">createWallpaperVideo</a></b></span>(const QString &amp;) : bool</li>
<li class="fn"><span class="name"><b><a href="screenplay-createimportvideo.html#createWallpaperVideo">createWallpaperVideo</a></b></span>() : bool</li>
<li class="fn"><span class="name"><b><a href="screenplay-createimportvideo.html#createWallpaperVideoPreview">createWallpaperVideoPreview</a></b></span>() : bool</li>
<li class="fn"><span class="name"><b><a href="screenplay-createimportvideo.html#extractWallpaperAudio">extractWallpaperAudio</a></b></span>() : bool</li>
<li class="fn"><span class="name"><b><a href="screenplay-createimportvideo.html#process">process</a></b></span>()</li>

View File

@ -21,7 +21,7 @@
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">CreateImportVideo Class</h1>
<span class="small-subtitle">class <a href="screenplay.html">ScreenPlay</a>::CreateImportVideo</span>
<span class="small-subtitle">class <a href="screenplay-module.html">ScreenPlay</a>::CreateImportVideo</span>
<!-- $$$CreateImportVideo-brief -->
<p>This class imports (copies) and creates wallaper previews. <a href="#details">More...</a></p>
<!-- @@@CreateImportVideo -->
@ -33,7 +33,7 @@
<a name="public-functions"></a>
<h2 id="public-functions">Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="screenplay-createimportvideo.html#CreateImportVideo-2">CreateImportVideo</a></b>(const QString &amp;<i>videoPath</i>, const QString &amp;<i>exportPath</i>, const QStringList &amp;<i>codecs</i>, QObject *<i>parent</i> = nullptr)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="screenplay-createimportvideo.html#CreateImportVideo-2">CreateImportVideo</a></b>(const QString &amp;<i>videoPath</i>, const QString &amp;<i>exportPath</i>, const QString &amp;<i>codec</i>, const int <i>quality</i>, QObject *<i>parent</i> = nullptr)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="screenplay-createimportvideo.html#CreateImportVideo-1">CreateImportVideo</a></b>(QObject *<i>parent</i> = nullptr)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> float </td><td class="memItemRight bottomAlign"><b><a href="screenplay-createimportvideo.html#progress-prop">progress</a></b>() const</td></tr>
</table></div>
@ -44,7 +44,7 @@
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="screenplay-createimportvideo.html#createWallpaperImagePreview">createWallpaperImagePreview</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="screenplay-createimportvideo.html#createWallpaperImageThumbnailPreview">createWallpaperImageThumbnailPreview</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="screenplay-createimportvideo.html#createWallpaperInfo">createWallpaperInfo</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="screenplay-createimportvideo.html#createWallpaperVideo">createWallpaperVideo</a></b>(const QString &amp;<i>codec</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="screenplay-createimportvideo.html#createWallpaperVideo">createWallpaperVideo</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="screenplay-createimportvideo.html#createWallpaperVideoPreview">createWallpaperVideoPreview</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="screenplay-createimportvideo.html#extractWallpaperAudio">extractWallpaperAudio</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-createimportvideo.html#process">process</a></b>()</td></tr>
@ -64,8 +64,8 @@
<!-- @@@CreateImportVideo -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$CreateImportVideo$$$CreateImportVideoconstQString&constQString&constQStringList&QObject* -->
<h3 class="fn" id="CreateImportVideo-2"><a name="CreateImportVideo-2"></a>CreateImportVideo::<span class="name">CreateImportVideo</span>(const <span class="type">QString</span> &amp;<i>videoPath</i>, const <span class="type">QString</span> &amp;<i>exportPath</i>, const <span class="type">QStringList</span> &amp;<i>codecs</i>, <span class="type">QObject</span> *<i>parent</i> = nullptr)</h3>
<!-- $$$CreateImportVideo$$$CreateImportVideoconstQString&constQString&constQString&constintQObject* -->
<h3 class="fn" id="CreateImportVideo-2"><a name="CreateImportVideo-2"></a>CreateImportVideo::<span class="name">CreateImportVideo</span>(const <span class="type">QString</span> &amp;<i>videoPath</i>, const <span class="type">QString</span> &amp;<i>exportPath</i>, const <span class="type">QString</span> &amp;<i>codec</i>, const <span class="type">int</span> <i>quality</i>, <span class="type">QObject</span> *<i>parent</i> = nullptr)</h3>
<p>Creates a CreateImportVideo object to be used in a different thread. A <i>videoPath</i> and a <i>exportPath</i> are needed for convertion.</p>
<!-- @@@CreateImportVideo -->
<!-- $$$CreateImportVideo$$$CreateImportVideoQObject* -->
@ -100,7 +100,7 @@ args<span class="operator">.</span>append(m_exportPath <span class="operator">+<
<!-- @@@createWallpaperImageThumbnailPreview -->
<!-- $$$createWallpaperInfo[overload1]$$$createWallpaperInfo -->
<h3 class="fn" id="createWallpaperInfo"><a name="createWallpaperInfo"></a><code>[slot] </code><span class="type">bool</span> CreateImportVideo::<span class="name">createWallpaperInfo</span>()</h3>
<p>Starts ffprobe and tries to parse the resulting json. Returns <code>false</code> if :</p>
<p>Starts ffprobe and tries to parse the resulting json. If the video is a container that not contains the video length like webm or mkv we need to count the frames ourself. We then call analyzeWebmReadFrames or analyzeVideo to parse the output. Returns <code>false</code> if :</p>
<ul>
<li>Parsing the output json of ffprobe fails.</li>
<li>Has no video.</li>
@ -108,8 +108,8 @@ args<span class="operator">.</span>append(m_exportPath <span class="operator">+<
<li>Is a wrong file format or generally broken.</li>
</ul>
<!-- @@@createWallpaperInfo -->
<!-- $$$createWallpaperVideo[overload1]$$$createWallpaperVideoconstQString& -->
<h3 class="fn" id="createWallpaperVideo"><a name="createWallpaperVideo"></a><code>[slot] </code><span class="type">bool</span> CreateImportVideo::<span class="name">createWallpaperVideo</span>(const <span class="type">QString</span> &amp;<i>codec</i>)</h3>
<!-- $$$createWallpaperVideo[overload1]$$$createWallpaperVideo -->
<h3 class="fn" id="createWallpaperVideo"><a name="createWallpaperVideo"></a><code>[slot] </code><span class="type">bool</span> CreateImportVideo::<span class="name">createWallpaperVideo</span>()</h3>
<p>Starts ffmpeg and tries to covert the given video to a webm video.</p>
<pre class="cpp"><span class="comment">//[...]</span>
args<span class="operator">.</span>append(<span class="string">&quot;-c:v&quot;</span>);

View File

@ -21,7 +21,7 @@
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">GlobalVariables Class</h1>
<span class="small-subtitle">class <a href="screenplay.html">ScreenPlay</a>::GlobalVariables</span>
<span class="small-subtitle">class <a href="screenplay-module.html">ScreenPlay</a>::GlobalVariables</span>
<!-- $$$GlobalVariables-brief -->
<p>Contains all variables that are globally needed. <a href="#details">More...</a></p>
<!-- @@@GlobalVariables -->

View File

@ -15,8 +15,8 @@
<ul>
<li class="fn"><span class="name"><b><a href="screenplay-installedlistfilter.html#InstalledListFilter">InstalledListFilter</a></b></span>(const std::shared_ptr&lt;InstalledListModel&gt; &amp;)</li>
<li class="fn"><span class="name"><b><a href="screenplay-installedlistfilter.html#resetFilter">resetFilter</a></b></span>()</li>
<li class="fn"><span class="name"><b><a href="screenplay-installedlistfilter.html#setSortOrder">setSortOrder</a></b></span>(const Qt::SortOrder)</li>
<li class="fn"><span class="name"><b><a href="screenplay-installedlistfilter.html#sortByName">sortByName</a></b></span>(const QString &amp;)</li>
<li class="fn"><span class="name"><b><a href="screenplay-installedlistfilter.html#sortBySearchType">sortBySearchType</a></b></span>(const ScreenPlay::SearchType::SearchType)</li>
</ul>
<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>
</html>

View File

@ -20,7 +20,7 @@
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">InstalledListFilter Class</h1>
<span class="small-subtitle">class <a href="screenplay.html">ScreenPlay</a>::InstalledListFilter</span>
<span class="small-subtitle">class <a href="screenplay-module.html">ScreenPlay</a>::InstalledListFilter</span>
<!-- $$$InstalledListFilter-brief -->
<p>Proxy between Installed List Model and QML view to filter items. <a href="#details">More...</a></p>
<!-- @@@InstalledListFilter -->
@ -38,8 +38,8 @@
<h2 id="public-slots">Public Slots</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-installedlistfilter.html#resetFilter">resetFilter</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-installedlistfilter.html#setSortOrder">setSortOrder</a></b>(const Qt::SortOrder <i>sortOrder</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-installedlistfilter.html#sortByName">sortByName</a></b>(const QString &amp;<i>name</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-installedlistfilter.html#sortBySearchType">sortBySearchType</a></b>(const ScreenPlay::SearchType::SearchType <i>searchType</i>)</td></tr>
</table></div>
<a name="details"></a>
<!-- $$$InstalledListFilter-description -->
@ -58,14 +58,14 @@
<h3 class="fn" id="resetFilter"><a name="resetFilter"></a><code>[slot] </code><span class="type">void</span> InstalledListFilter::<span class="name">resetFilter</span>()</h3>
<p>Resets the filter and sorts by title.</p>
<!-- @@@resetFilter -->
<!-- $$$setSortOrder[overload1]$$$setSortOrderconstQt::SortOrder -->
<h3 class="fn" id="setSortOrder"><a name="setSortOrder"></a><code>[slot] </code><span class="type">void</span> InstalledListFilter::<span class="name">setSortOrder</span>(const <span class="type">Qt::SortOrder</span> <i>sortOrder</i>)</h3>
<p>sets the sort order by date.</p>
<!-- @@@setSortOrder -->
<!-- $$$sortByName[overload1]$$$sortByNameconstQString& -->
<h3 class="fn" id="sortByName"><a name="sortByName"></a><code>[slot] </code><span class="type">void</span> InstalledListFilter::<span class="name">sortByName</span>(const <span class="type">QString</span> &amp;<i>name</i>)</h3>
<p>Invoked when the user uses the quicksearch at the top right of the installed page. Uses the <i>name</i> to sort by name. This name is saved in the project.json title.</p>
<!-- @@@sortByName -->
<!-- $$$sortBySearchType[overload1]$$$sortBySearchTypeconstScreenPlay::SearchType::SearchType -->
<h3 class="fn" id="sortBySearchType"><a name="sortBySearchType"></a><code>[slot] </code><span class="type">void</span> InstalledListFilter::<span class="name">sortBySearchType</span>(const <span class="type">ScreenPlay::SearchType::SearchType</span> <i>searchType</i>)</h3>
<p>.</p>
<!-- @@@sortBySearchType -->
</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/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>
</html>

View File

@ -14,7 +14,7 @@
<p>This is the complete list of members for <a href="screenplay-installedlistmodel.html">ScreenPlay::InstalledListModel</a>, including inherited members.</p>
<ul>
<li class="fn"><span class="name"><b><a href="screenplay-installedlistmodel.html#InstalledListModel">InstalledListModel</a></b></span>(const std::shared_ptr&lt;GlobalVariables&gt; &amp;, QObject *)</li>
<li class="fn"><span class="name"><b><a href="screenplay-installedlistmodel.html#append">append</a></b></span>(const QJsonObject &amp;, const QString &amp;)</li>
<li class="fn"><span class="name"><b><a href="screenplay-installedlistmodel.html#append">append</a></b></span>(const QJsonObject &amp;, const QString &amp;, const QDateTime &amp;)</li>
<li class="fn"><span class="name"><b><a href="screenplay-installedlistmodel.html#count-prop">countChanged</a></b></span>(int)</li>
<li class="fn"><span class="name"><b><a href="screenplay-installedlistmodel.html#deinstallItemAt">deinstallItemAt</a></b></span>(const int) : bool</li>
<li class="fn"><span class="name"><b><a href="screenplay-installedlistmodel.html#get">get</a></b></span>(const QString &amp;) const : QVariantMap</li>

View File

@ -22,7 +22,7 @@
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">InstalledListModel Class</h1>
<span class="small-subtitle">class <a href="screenplay.html">ScreenPlay</a>::InstalledListModel</span>
<span class="small-subtitle">class <a href="screenplay-module.html">ScreenPlay</a>::InstalledListModel</span>
<!-- $$$InstalledListModel-brief -->
<p>Lists all installed wallpapers, widgets etc. from a given Path. <a href="#details">More...</a></p>
<!-- @@@InstalledListModel -->
@ -47,7 +47,7 @@
<a name="public-slots"></a>
<h2 id="public-slots">Public Slots</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-installedlistmodel.html#append">append</a></b>(const QJsonObject &amp;<i>obj</i>, const QString &amp;<i>folderName</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-installedlistmodel.html#append">append</a></b>(const QJsonObject &amp;<i>obj</i>, const QString &amp;<i>folderName</i>, const QDateTime &amp;<i>lastModified</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="screenplay-installedlistmodel.html#deinstallItemAt">deinstallItemAt</a></b>(const int <i>index</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QVariantMap </td><td class="memItemRight bottomAlign"><b><a href="screenplay-installedlistmodel.html#get">get</a></b>(const QString &amp;<i>folderId</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-installedlistmodel.html#init">init</a></b>()</td></tr>
@ -73,13 +73,13 @@
<h3 class="fn" id="InstalledListModel"><a name="InstalledListModel"></a>InstalledListModel::<span class="name">InstalledListModel</span>(const <span class="type">std::shared_ptr</span>&lt;<span class="type"><a href="screenplay-globalvariables.html">GlobalVariables</a></span>&gt; &amp;<i>globalVariables</i>, <span class="type">QObject</span> *<i>parent</i> = nullptr)</h3>
<p>Constructor.</p>
<!-- @@@InstalledListModel -->
<!-- $$$append[overload1]$$$appendconstQJsonObject&constQString& -->
<h3 class="fn" id="append"><a name="append"></a><code>[slot] </code><span class="type">void</span> InstalledListModel::<span class="name">append</span>(const <span class="type">QJsonObject</span> &amp;<i>obj</i>, const <span class="type">QString</span> &amp;<i>folderName</i>)</h3>
<p>.</p>
<!-- $$$append[overload1]$$$appendconstQJsonObject&constQString&constQDateTime& -->
<h3 class="fn" id="append"><a name="append"></a><code>[slot] </code><span class="type">void</span> InstalledListModel::<span class="name">append</span>(const <span class="type">QJsonObject</span> &amp;<i>obj</i>, const <span class="type">QString</span> &amp;<i>folderName</i>, const <span class="type">QDateTime</span> &amp;<i>lastModified</i>)</h3>
<p>Append an ProjectFile to the list.</p>
<!-- @@@append -->
<!-- $$$deinstallItemAt[overload1]$$$deinstallItemAtconstint -->
<h3 class="fn" id="deinstallItemAt"><a name="deinstallItemAt"></a><code>[slot] </code><span class="type">bool</span> InstalledListModel::<span class="name">deinstallItemAt</span>(const <span class="type">int</span> <i>index</i>)</h3>
<p>.</p>
<p>Deleted the item from the local storage and removes it from the installed list.</p>
<!-- @@@deinstallItemAt -->
<!-- $$$get[overload1]$$$getconstQString& -->
<h3 class="fn" id="get"><a name="get"></a><code>[slot] </code><span class="type">QVariantMap</span> InstalledListModel::<span class="name">get</span>(const <span class="type">QString</span> &amp;<i>folderId</i>) const</h3>
@ -91,7 +91,7 @@
<!-- @@@init -->
<!-- $$$loadInstalledContent[overload1]$$$loadInstalledContent -->
<h3 class="fn" id="loadInstalledContent"><a name="loadInstalledContent"></a><code>[slot] </code><span class="type">void</span> InstalledListModel::<span class="name">loadInstalledContent</span>()</h3>
<p>.</p>
<p>Loads all installed content. Skips projects.json without a &quot;type&quot; field.</p>
<!-- @@@loadInstalledContent -->
<!-- $$$reset[overload1]$$$reset -->
<h3 class="fn" id="reset"><a name="reset"></a><code>[slot] </code><span class="type">void</span> InstalledListModel::<span class="name">reset</span>()</h3>

View File

@ -0,0 +1,58 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<!-- app.cpp -->
<title>ScreenPlay</title>
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
</head>
<body>
<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 ">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#namespaces">Namespaces</a></li>
<li class="level1"><a href="#classes">Classes</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">ScreenPlay</h1>
<span class="subtitle"></span>
<!-- $$$ScreenPlay-brief -->
<p>Module for ScreenPlay. <a href="#details">More...</a></p>
<!-- @@@ScreenPlay -->
<a name="namespaces"></a>
<h2 id="namespaces">Namespaces</h2>
<div class="table"><table class="annotated">
<tr class="odd topAlign"><td class="tblName"><p><a href="screenplay.html">ScreenPlay</a></p></td><td class="tblDescr"><p>Namespace for ScreenPlay</p></td></tr>
</table></div>
<a name="classes"></a>
<h2 id="classes">Classes</h2>
<div class="table"><table class="annotated">
<tr class="odd topAlign"><td class="tblName"><p><a href="screenplay-app.html">ScreenPlay::App</a></p></td><td class="tblDescr"><p>Contains all members for ScreenPlay</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="screenplay-create.html">ScreenPlay::Create</a></p></td><td class="tblDescr"><p>Baseclass for creating wallapers, widgets and the corresponding wizards</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="screenplay-createimportvideo.html">ScreenPlay::CreateImportVideo</a></p></td><td class="tblDescr"><p>This class imports (copies) and creates wallaper previews</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="screenplay-globalvariables.html">ScreenPlay::GlobalVariables</a></p></td><td class="tblDescr"><p>Contains all variables that are globally needed</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="screenplay-installedlistfilter.html">ScreenPlay::InstalledListFilter</a></p></td><td class="tblDescr"><p>Proxy between Installed List Model and QML view to filter items</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="screenplay-installedlistmodel.html">ScreenPlay::InstalledListModel</a></p></td><td class="tblDescr"><p>Lists all installed wallpapers, widgets etc. from a given Path</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="screenplay-monitorlistmodel.html">ScreenPlay::MonitorListModel</a></p></td><td class="tblDescr"><p>MonitorListModel</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="screenplay-profilelistmodel.html">ScreenPlay::ProfileListModel</a></p></td><td class="tblDescr"><p>Used to save all active wallpapers and widgets position and configurations after a restart</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="screenplay-projectsettingslistmodel.html">ScreenPlay::ProjectSettingsListModel</a></p></td><td class="tblDescr"><p>Used for the dynamic loading of the properties json object inside a project.json</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="screenplay-sdkconnection.html">ScreenPlay::SDKConnection</a></p></td><td class="tblDescr"><p>Contains all connections to Wallpaper and Widgets</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="screenplay-screenplaymanager.html">ScreenPlay::ScreenPlayManager</a></p></td><td class="tblDescr"><p>Used to manage multiple ScreenPlayWallpaper and ScreenPlayWidget</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="screenplay-screenplaywallpaper.html">ScreenPlay::ScreenPlayWallpaper</a></p></td><td class="tblDescr"><p>A Single Object to manage a Wallpaper</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="screenplay-screenplaywidget.html">ScreenPlay::ScreenPlayWidget</a></p></td><td class="tblDescr"><p>A Single Object to manage a Widget</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="screenplay-settings.html">ScreenPlay::Settings</a></p></td><td class="tblDescr"><p>Global settings class for reading and writing settings</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="screenplay-util.html">ScreenPlay::Util</a></p></td><td class="tblDescr"><p>Easy to use global object to use when certain functionality is not available in QML</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="screenplay-wizards.html">ScreenPlay::Wizards</a></p></td><td class="tblDescr"><p>Baseclass for all wizards. Mostly for copying and creating project files</p></td></tr>
</table></div>
<!-- $$$ScreenPlay-description -->
<a name="details"></a>
<div class="descr">
<h2 id="details">Detailed Description</h2>
</div>
<!-- @@@ScreenPlay -->
<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>
</html>

View File

@ -22,7 +22,7 @@
<li class="fn"><span class="name"><b><a href="screenplay-monitorlistmodel.html#getAppIDByMonitorIndex">getAppIDByMonitorIndex</a></b></span>(const int) const : std::optional&lt;QString&gt;</li>
<li class="fn"><span class="name"><b><a href="screenplay-monitorlistmodel.html#roleNames">roleNames</a></b></span>() const : QHash&lt;int, QByteArray&gt;</li>
<li class="fn"><span class="name"><b><a href="screenplay-monitorlistmodel.html#rowCount">rowCount</a></b></span>(const QModelIndex &amp;) const : int</li>
<li class="fn"><span class="name"><b><a href="screenplay-monitorlistmodel.html#setWallpaperActiveMonitor">setWallpaperActiveMonitor</a></b></span>(const std::shared_ptr&lt;ScreenPlayWallpaper&gt; &amp;, const QVector&lt;int&gt;)</li>
<li class="fn"><span class="name"><b><a href="screenplay-monitorlistmodel.html#setWallpaperMonitor">setWallpaperMonitor</a></b></span>(const std::shared_ptr&lt;ScreenPlayWallpaper&gt; &amp;, const QVector&lt;int&gt;)</li>
</ul>
<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>
</html>

View File

@ -21,7 +21,7 @@
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">MonitorListModel Class</h1>
<span class="small-subtitle">class <a href="screenplay.html">ScreenPlay</a>::MonitorListModel</span>
<span class="small-subtitle">class <a href="screenplay-module.html">ScreenPlay</a>::MonitorListModel</span>
<!-- $$$MonitorListModel-brief -->
<p>MonitorListModel. <a href="#details">More...</a></p>
<!-- @@@MonitorListModel -->
@ -35,7 +35,7 @@
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="screenplay-monitorlistmodel.html#MonitorListModel">MonitorListModel</a></b>(QObject *<i>parent</i> = nullptr)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> std::optional&lt;QString&gt; </td><td class="memItemRight bottomAlign"><b><a href="screenplay-monitorlistmodel.html#getAppIDByMonitorIndex">getAppIDByMonitorIndex</a></b>(const int <i>index</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-monitorlistmodel.html#setWallpaperActiveMonitor">setWallpaperActiveMonitor</a></b>(const std::shared_ptr&lt;ScreenPlayWallpaper&gt; &amp;<i>wallpaper</i>, const QVector&lt;int&gt; <i>monitors</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-monitorlistmodel.html#setWallpaperMonitor">setWallpaperMonitor</a></b>(const std::shared_ptr&lt;ScreenPlayWallpaper&gt; &amp;<i>wallpaper</i>, const QVector&lt;int&gt; <i>monitors</i>)</td></tr>
</table></div>
<a name="reimplemented-public-functions"></a>
<h2 id="reimplemented-public-functions">Reimplemented Public Functions</h2>
@ -103,10 +103,10 @@
<h3 class="fn" id="rowCount"><a name="rowCount"></a><code>[override virtual] </code><span class="type">int</span> MonitorListModel::<span class="name">rowCount</span>(const <span class="type">QModelIndex</span> &amp;<i>parent</i> = QModelIndex()) const</h3>
<p>Returns the amount of active monitors.</p>
<!-- @@@rowCount -->
<!-- $$$setWallpaperActiveMonitor[overload1]$$$setWallpaperActiveMonitorconststd::shared_ptr<ScreenPlayWallpaper>&constQVector<int> -->
<h3 class="fn" id="setWallpaperActiveMonitor"><a name="setWallpaperActiveMonitor"></a><span class="type">void</span> MonitorListModel::<span class="name">setWallpaperActiveMonitor</span>(const <span class="type">std::shared_ptr</span>&lt;<span class="type"><a href="screenplay-screenplaywallpaper.html">ScreenPlayWallpaper</a></span>&gt; &amp;<i>wallpaper</i>, const <span class="type">QVector</span>&lt;<span class="type">int</span>&gt; <i>monitors</i>)</h3>
<p>Sets the previewImage and appID for a list item.</p>
<!-- @@@setWallpaperActiveMonitor -->
<!-- $$$setWallpaperMonitor[overload1]$$$setWallpaperMonitorconststd::shared_ptr<ScreenPlayWallpaper>&constQVector<int> -->
<h3 class="fn" id="setWallpaperMonitor"><a name="setWallpaperMonitor"></a><span class="type">void</span> MonitorListModel::<span class="name">setWallpaperMonitor</span>(const <span class="type">std::shared_ptr</span>&lt;<span class="type"><a href="screenplay-screenplaywallpaper.html">ScreenPlayWallpaper</a></span>&gt; &amp;<i>wallpaper</i>, const <span class="type">QVector</span>&lt;<span class="type">int</span>&gt; <i>monitors</i>)</h3>
<p>Sets a shared_ptr to the monitor list. This should be used to set and remove the shared_ptr.</p>
<!-- @@@setWallpaperMonitor -->
</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/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>
</html>

View File

@ -20,7 +20,7 @@
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">ProfileListModel Class</h1>
<span class="small-subtitle">class <a href="screenplay.html">ScreenPlay</a>::ProfileListModel</span>
<span class="small-subtitle">class <a href="screenplay-module.html">ScreenPlay</a>::ProfileListModel</span>
<!-- $$$ProfileListModel-brief -->
<p>Used to save all active wallpapers and widgets position and configurations after a restart. <a href="#details">More...</a></p>
<!-- @@@ProfileListModel -->

View File

@ -17,7 +17,6 @@
<li class="fn"><span class="name"><b><a href="screenplay-projectsettingslistmodel.html#append">append</a></b></span>(const ScreenPlay::SettingsItem &amp;&amp;)</li>
<li class="fn"><span class="name"><b><a href="screenplay-projectsettingslistmodel.html#data">data</a></b></span>(const QModelIndex &amp;, int) const : QVariant</li>
<li class="fn"><span class="name"><b><a href="screenplay-projectsettingslistmodel.html#getActiveSettingsJson">getActiveSettingsJson</a></b></span>() : QJsonObject</li>
<li class="fn"><span class="name"><b><a href="screenplay-projectsettingslistmodel.html#init">init</a></b></span>(const InstalledType::InstalledType &amp;, const QJsonObject &amp;)</li>
<li class="fn"><span class="name"><b><a href="screenplay-projectsettingslistmodel.html#roleNames">roleNames</a></b></span>() const : QHash&lt;int, QByteArray&gt;</li>
<li class="fn"><span class="name"><b><a href="screenplay-projectsettingslistmodel.html#rowCount">rowCount</a></b></span>(const QModelIndex &amp;) const : int</li>
</ul>

View File

@ -21,7 +21,7 @@
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">ProjectSettingsListModel Class</h1>
<span class="small-subtitle">class <a href="screenplay.html">ScreenPlay</a>::ProjectSettingsListModel</span>
<span class="small-subtitle">class <a href="screenplay-module.html">ScreenPlay</a>::ProjectSettingsListModel</span>
<!-- $$$ProjectSettingsListModel-brief -->
<p>ProjectSettingsListModel used for the dynamic loading of the properties json object inside a project.json. <a href="#details">More...</a></p>
<!-- @@@ProjectSettingsListModel -->
@ -35,7 +35,6 @@
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-projectsettingslistmodel.html#append">append</a></b>(const ScreenPlay::SettingsItem &amp;&amp;<i>item</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QJsonObject </td><td class="memItemRight bottomAlign"><b><a href="screenplay-projectsettingslistmodel.html#getActiveSettingsJson">getActiveSettingsJson</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-projectsettingslistmodel.html#init">init</a></b>(const InstalledType::InstalledType &amp;<i>type</i>, const QJsonObject &amp;<i>properties</i>)</td></tr>
</table></div>
<a name="reimplemented-public-functions"></a>
<h2 id="reimplemented-public-functions">Reimplemented Public Functions</h2>
@ -95,11 +94,6 @@
<h3 class="fn" id="getActiveSettingsJson"><a name="getActiveSettingsJson"></a><span class="type">QJsonObject</span> ProjectSettingsListModel::<span class="name">getActiveSettingsJson</span>()</h3>
<p>ProjectSettingsListModel::getActiveSettingsJson</p>
<!-- @@@getActiveSettingsJson -->
<!-- $$$init[overload1]$$$initconstInstalledType::InstalledType&constQJsonObject& -->
<h3 class="fn" id="init"><a name="init"></a><span class="type">void</span> ProjectSettingsListModel::<span class="name">init</span>(const <span class="type">InstalledType::InstalledType</span> &amp;<i>type</i>, const <span class="type">QJsonObject</span> &amp;<i>properties</i>)</h3>
<p>Constructor when loading properties from settings.json We need to _flatten_ the json to make it work with a flat list model! See</p>
<p><b>See also </b><a href="screenplay-projectsettingslistmodel.html#getActiveSettingsJson">getActiveSettingsJson</a>, to</a>, make</a>, the</a>, flat</a>, list</a>, to</a>, a</a>, hierarchical</a>, json</a>, and object</a>.</p>
<!-- @@@init -->
<!-- $$$roleNames[overload1]$$$roleNames -->
<h3 class="fn" id="roleNames"><a name="roleNames"></a><code>[override virtual] </code><span class="type">QHash</span>&lt;<span class="type">int</span>, <span class="type">QByteArray</span>&gt; ProjectSettingsListModel::<span class="name">roleNames</span>() const</h3>
<p>.</p>

View File

@ -17,27 +17,20 @@
<li class="fn"><span class="name"><b><a href="screenplay-screenplaymanager.html#ScreenPlayManager">ScreenPlayManager</a></b></span>(QObject *)</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaymanager.html#activeWallpaperCounter-prop">activeWallpaperCounterChanged</a></b></span>(int)</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaymanager.html#activeWidgetsCounter-prop">activeWidgetsCounterChanged</a></b></span>(int)</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaymanager.html#closeAllWallpapers">closeAllWallpapers</a></b></span>()</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaymanager.html#closeAllWidgets">closeAllWidgets</a></b></span>()</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaymanager.html#closeConnection">closeConnection</a></b></span>(const QString &amp;) : bool</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaymanager.html#closeConntectionByType">closeConntectionByType</a></b></span>(const QStringList &amp;) : bool</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaymanager.html#createWallpaper">createWallpaper</a></b></span>(const ScreenPlay::InstalledType::InstalledType, const ScreenPlay::FillMode::FillMode, const QString &amp;, const QString &amp;, const QString &amp;, const QVector&lt;int&gt; &amp;, const float, const float, const QJsonObject &amp;, const bool)</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaymanager.html#createWidget">createWidget</a></b></span>(const ScreenPlay::InstalledType::InstalledType, const QPoint &amp;, const QString &amp;, const QString &amp;, const QJsonObject &amp;, const bool)</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaymanager.html#getWallpaperByAppID">getWallpaperByAppID</a></b></span>(const QString &amp;) const : ScreenPlay::ScreenPlayWallpaper *</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaymanager.html#newConnection">newConnection</a></b></span>()</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaymanager.html#removeAllWallpapers">removeAllWallpapers</a></b></span>()</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaymanager.html#removeAllWallpapers">removeAllWallpapers</a></b></span>() : bool</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaymanager.html#removeAllWidgets">removeAllWidgets</a></b></span>() : bool</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaymanager.html#requestProjectSettingsAtMonitorIndex">requestProjectSettingsAtMonitorIndex</a></b></span>(const int) : bool</li>
</ul></td><td class="topAlign"><ul>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaymanager.html#removeAllWidgets">removeAllWidgets</a></b></span>()</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaymanager.html#removeApp">removeApp</a></b></span>(const QString &amp;) : bool</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaymanager.html#requestProjectSettingsAtMonitorIndex">requestProjectSettingsAtMonitorIndex</a></b></span>(const int)</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaymanager.html#activeWallpaperCounter-prop">setActiveWallpaperCounter</a></b></span>(int)</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaymanager.html#activeWidgetsCounter-prop">setActiveWidgetsCounter</a></b></span>(int)</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaymanager.html#setAllWallpaperValue">setAllWallpaperValue</a></b></span>(const QString &amp;, const QString &amp;)</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaymanager.html#setWallpaperValue">setWallpaperValue</a></b></span>(const QString &amp;, const QString &amp;, const QString &amp;)</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaymanager.html#setWallpaperValueAtMonitorIndex">setWallpaperValueAtMonitorIndex</a></b></span>(const int, const QString &amp;, const QString &amp;)</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaymanager.html#setAllWallpaperValue">setAllWallpaperValue</a></b></span>(const QString &amp;, const QString &amp;) : bool</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaymanager.html#setWallpaperValue">setWallpaperValue</a></b></span>(const QString &amp;, const QString &amp;, const QString &amp;) : bool</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaymanager.html#setWallpaperValueAtMonitorIndex">setWallpaperValueAtMonitorIndex</a></b></span>(const int, const QString &amp;, const QString &amp;) : bool</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaymanager.html#activeWallpaperCounter-prop">activeWallpaperCounter</a></b></span>() const : int</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaymanager.html#activeWidgetsCounter-prop">activeWidgetsCounter</a></b></span>() const : int</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaymanager.html#init">init</a></b></span>(const std::shared_ptr&lt;GlobalVariables&gt; &amp;, const std::shared_ptr&lt;MonitorListModel&gt; &amp;, const int &amp;, const std::shared_ptr&lt;Settings&gt; &amp;)</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaymanager.html#init">init</a></b></span>(const std::shared_ptr&lt;GlobalVariables&gt; &amp;, const std::shared_ptr&lt;MonitorListModel&gt; &amp;, const std::shared_ptr&lt;Settings&gt; &amp;)</li>
</ul>
</td></tr>
</table></div>

View File

@ -21,7 +21,7 @@
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">ScreenPlayManager Class</h1>
<span class="small-subtitle">class <a href="screenplay.html">ScreenPlay</a>::ScreenPlayManager</span>
<span class="small-subtitle">class <a href="screenplay-module.html">ScreenPlay</a>::ScreenPlayManager</span>
<!-- $$$ScreenPlayManager-brief -->
<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>
<!-- @@@ScreenPlayManager -->
@ -36,28 +36,21 @@
<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>
<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>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaymanager.html#init">init</a></b>(const std::shared_ptr&lt;GlobalVariables&gt; &amp;<i>globalVariables</i>, const std::shared_ptr&lt;MonitorListModel&gt; &amp;<i>mlm</i>, const int &amp;<i>telemetry</i>, const std::shared_ptr&lt;Settings&gt; &amp;<i>settings</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaymanager.html#init">init</a></b>(const std::shared_ptr&lt;GlobalVariables&gt; &amp;<i>globalVariables</i>, const std::shared_ptr&lt;MonitorListModel&gt; &amp;<i>mlm</i>, const std::shared_ptr&lt;Settings&gt; &amp;<i>settings</i>)</td></tr>
</table></div>
<a name="public-slots"></a>
<h2 id="public-slots">Public Slots</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#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>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaymanager.html#closeConnection">closeConnection</a></b>(const QString &amp;<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 &amp;<i>types</i>)</td></tr>
<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 &amp;<i>absoluteStoragePath</i>, const QString &amp;<i>previewImage</i>, const QString &amp;<i>file</i>, const QVector&lt;int&gt; &amp;<i>monitorIndex</i>, const float <i>volume</i>, const float <i>playbackRate</i>, const QJsonObject &amp;<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 &amp;<i>position</i>, const QString &amp;<i>absoluteStoragePath</i>, const QString &amp;<i>previewImage</i>, const QJsonObject &amp;<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 &amp;<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>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaymanager.html#removeAllWallpapers">removeAllWallpapers</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaymanager.html#removeAllWidgets">removeAllWidgets</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaymanager.html#removeApp">removeApp</a></b>(const QString &amp;<i>appID</i>)</td></tr>
<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>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaymanager.html#removeAllWallpapers">removeAllWallpapers</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaymanager.html#removeAllWidgets">removeAllWidgets</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaymanager.html#requestProjectSettingsAtMonitorIndex">requestProjectSettingsAtMonitorIndex</a></b>(const int <i>index</i>)</td></tr>
<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>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaymanager.html#setAllWallpaperValue">setAllWallpaperValue</a></b>(const QString &amp;<i>key</i>, const QString &amp;<i>value</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaymanager.html#setWallpaperValue">setWallpaperValue</a></b>(const QString &amp;<i>appID</i>, const QString &amp;<i>key</i>, const QString &amp;<i>value</i>)</td></tr>
<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 &amp;<i>key</i>, const QString &amp;<i>value</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaymanager.html#setAllWallpaperValue">setAllWallpaperValue</a></b>(const QString &amp;<i>key</i>, const QString &amp;<i>value</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaymanager.html#setWallpaperValue">setWallpaperValue</a></b>(const QString &amp;<i>appID</i>, const QString &amp;<i>key</i>, const QString &amp;<i>value</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaymanager.html#setWallpaperValueAtMonitorIndex">setWallpaperValueAtMonitorIndex</a></b>(const int <i>index</i>, const QString &amp;<i>key</i>, const QString &amp;<i>value</i>)</td></tr>
</table></div>
<a name="signals"></a>
<h2 id="signals">Signals</h2>
@ -69,89 +62,50 @@
<!-- $$$ScreenPlayManager-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<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>
<p>Creates and (indirectly) destroys Wallpaper and Widgets via opening and closing QLocalPipe connectons of the <a href="screenplaysdk-module.html">ScreenPlaySDK</a>. Also responsible to set the current active wallpaper to the monitorListModel.</p>
</div>
<!-- @@@ScreenPlayManager -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$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>
<p>Constructor that checks if another <a href="screenplay.html">ScreenPlay</a> instance is running via a localsocket. Starts a save timer to limit the amount of times to save. This is used for limiting slider small value save spam.</p>
<p>Constructor that checks if another <a href="screenplay-module.html">ScreenPlay</a> instance is running via a localsocket. Starts a save timer to limit the amount of times to save. This is used for limiting slider small value save spam.</p>
<!-- @@@ScreenPlayManager -->
<!-- $$$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 -->
<!-- $$$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> &amp;<i>appID</i>)</h3>
<p>Closes a Wallpaper or Widget connection by the given <i>appID</i>.</p>
<!-- @@@closeConnection -->
<!-- $$$closeConntectionByType[overload1]$$$closeConntectionByTypeconstQStringList& -->
<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> &amp;<i>types</i>)</h3>
<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> &amp;<i>absoluteStoragePath</i>, const <span class="type">QString</span> &amp;<i>previewImage</i>, const <span class="type">QString</span> &amp;<i>file</i>, const <span class="type">QVector</span>&lt;<span class="type">int</span>&gt; &amp;<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> &amp;<i>properties</i>, const <span class="type">bool</span> <i>saveToProfilesConfigFile</i>)</h3>
<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 -->
<!-- $$$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> &amp;<i>position</i>, const <span class="type">QString</span> &amp;<i>absoluteStoragePath</i>, const <span class="type">QString</span> &amp;<i>previewImage</i>, const <span class="type">QJsonObject</span> &amp;<i>properties</i>, const <span class="type">bool</span> <i>saveToProfilesConfigFile</i>)</h3>
<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& -->
<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> &amp;<i>appID</i>) const</h3>
<p>Returns <code>a</code> <a href="screenplay-screenplaywallpaper.html">ScreenPlayWallpaper</a> if successful, otherwhise <code>std::nullopt</code>.</p>
<p>Returns <code>a</code> <a href="screenplay-screenplaywallpaper.html">ScreenPlayWallpaper</a> if successful, otherwhise <code>std::nullopt</code>. This function is only used in QML.</p>
<!-- @@@getWallpaperByAppID -->
<!-- $$$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 <a href="screenplay-sdkconnection.html">SDKConnection</a> object shared_ptr to the m_clients list.</p>
<!-- @@@newConnection -->
<!-- $$$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>
<h3 class="fn" id="removeAllWallpapers"><a name="removeAllWallpapers"></a><code>[slot] </code><span class="type">bool</span> ScreenPlayManager::<span class="name">removeAllWallpapers</span>()</h3>
<p>Removes all wallpaper entries in the profiles.json.</p>
<!-- @@@removeAllWallpapers -->
<!-- $$$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>
<h3 class="fn" id="removeAllWidgets"><a name="removeAllWidgets"></a><code>[slot] </code><span class="type">bool</span> ScreenPlayManager::<span class="name">removeAllWidgets</span>()</h3>
<p>Removes all widgets and resets the activeWidgetCounter to 0.</p>
<!-- @@@removeAllWidgets -->
<!-- $$$removeApp[overload1]$$$removeAppconstQString& -->
<h3 class="fn" id="removeApp"><a name="removeApp"></a><code>[slot] </code><span class="type">bool</span> ScreenPlayManager::<span class="name">removeApp</span>(const <span class="type">QString</span> &amp;<i>appID</i>)</h3>
<p>Disconnects the connection, remove</p>
<!-- @@@removeApp -->
<!-- $$$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>
<h3 class="fn" id="requestProjectSettingsAtMonitorIndex"><a name="requestProjectSettingsAtMonitorIndex"></a><code>[slot] </code><span class="type">bool</span> ScreenPlayManager::<span class="name">requestProjectSettingsAtMonitorIndex</span>(const <span class="type">int</span> <i>index</i>)</h3>
<p>Request a spesific json profile to display in the active wallpaper popup on the right.</p>
<!-- @@@requestProjectSettingsAtMonitorIndex -->
<!-- $$$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> &amp;<i>key</i>, const <span class="type">QString</span> &amp;<i>value</i>)</h3>
<h3 class="fn" id="setAllWallpaperValue"><a name="setAllWallpaperValue"></a><code>[slot] </code><span class="type">bool</span> ScreenPlayManager::<span class="name">setAllWallpaperValue</span>(const <span class="type">QString</span> &amp;<i>key</i>, const <span class="type">QString</span> &amp;<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 -->
<!-- $$$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> &amp;<i>appID</i>, const <span class="type">QString</span> &amp;<i>key</i>, const <span class="type">QString</span> &amp;<i>value</i>)</h3>
<h3 class="fn" id="setWallpaperValue"><a name="setWallpaperValue"></a><code>[slot] </code><span class="type">bool</span> ScreenPlayManager::<span class="name">setWallpaperValue</span>(const <span class="type">QString</span> &amp;<i>appID</i>, const <span class="type">QString</span> &amp;<i>key</i>, const <span class="type">QString</span> &amp;<i>value</i>)</h3>
<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>
<!-- @@@setWallpaperValue -->
<!-- $$$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> &amp;<i>key</i>, const <span class="type">QString</span> &amp;<i>value</i>)</h3>
<h3 class="fn" id="setWallpaperValueAtMonitorIndex"><a name="setWallpaperValueAtMonitorIndex"></a><code>[slot] </code><span class="type">bool</span> ScreenPlayManager::<span class="name">setWallpaperValueAtMonitorIndex</span>(const <span class="type">int</span> <i>index</i>, const <span class="type">QString</span> &amp;<i>key</i>, const <span class="type">QString</span> &amp;<i>value</i>)</h3>
<p>Set a wallpaper <i>value</i> at a given <i>index</i> and <i>key</i>.</p>
<!-- @@@setWallpaperValueAtMonitorIndex -->
<!-- $$$init[overload1]$$$initconststd::shared_ptr<GlobalVariables>&conststd::shared_ptr<MonitorListModel>&constint&conststd::shared_ptr<Settings>& -->
<h3 class="fn" id="init"><a name="init"></a><span class="type">void</span> ScreenPlayManager::<span class="name">init</span>(const <span class="type">std::shared_ptr</span>&lt;<span class="type"><a href="screenplay-globalvariables.html">GlobalVariables</a></span>&gt; &amp;<i>globalVariables</i>, const <span class="type">std::shared_ptr</span>&lt;<span class="type"><a href="screenplay-monitorlistmodel.html">MonitorListModel</a></span>&gt; &amp;<i>mlm</i>, const <span class="type">int</span> &amp;<i>telemetry</i>, const <span class="type">std::shared_ptr</span>&lt;<span class="type"><a href="screenplay-settings.html">Settings</a></span>&gt; &amp;<i>settings</i>)</h3>
<p>Inits this class instead of init in the constructor. This is because we need to check first if another <a href="screenplay.html">ScreenPlay</a> instance is running. If it is not the case we call this function.</p>
<!-- $$$init[overload1]$$$initconststd::shared_ptr<GlobalVariables>&conststd::shared_ptr<MonitorListModel>&conststd::shared_ptr<Settings>& -->
<h3 class="fn" id="init"><a name="init"></a><span class="type">void</span> ScreenPlayManager::<span class="name">init</span>(const <span class="type">std::shared_ptr</span>&lt;<span class="type"><a href="screenplay-globalvariables.html">GlobalVariables</a></span>&gt; &amp;<i>globalVariables</i>, const <span class="type">std::shared_ptr</span>&lt;<span class="type"><a href="screenplay-monitorlistmodel.html">MonitorListModel</a></span>&gt; &amp;<i>mlm</i>, const <span class="type">std::shared_ptr</span>&lt;<span class="type"><a href="screenplay-settings.html">Settings</a></span>&gt; &amp;<i>settings</i>)</h3>
<p>Inits this class instead of init in the constructor. This is because we need to check first if another <a href="screenplay-module.html">ScreenPlay</a> instance is running. If it is not the case we call this function.</p>
<!-- @@@init -->
</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/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>

View File

@ -14,11 +14,10 @@
<p>This is the complete list of members for <a href="screenplay-screenplaywallpaper.html">ScreenPlay::ScreenPlayWallpaper</a>, including inherited members.</p>
<div class="table"><table class="propsummary">
<tr><td class="topAlign"><ul>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywallpaper.html#ScreenPlayWallpaper-1">ScreenPlayWallpaper</a></b></span>(const QVector&lt;int&gt; &amp;, const std::shared_ptr&lt;GlobalVariables&gt; &amp;, const QString &amp;, const QString &amp;, const QString &amp;, const QString &amp;, const float, const float, const FillMode::FillMode, const InstalledType::InstalledType, const QJsonObject &amp;, const bool, QObject *)</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywallpaper.html#absolutePath-prop">absolutePathChanged</a></b></span>(QString)</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywallpaper.html#appID-prop">appIDChanged</a></b></span>(QString)</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywallpaper.html#file-prop">fileChanged</a></b></span>(QString)</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywallpaper.html#fillMode-prop">fillModeChanged</a></b></span>(FillMode::FillMode)</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywallpaper.html#fillMode-prop">fillModeChanged</a></b></span>(int)</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywallpaper.html#isLooping-prop">isLoopingChanged</a></b></span>(bool)</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywallpaper.html#playbackRate-prop">playbackRateChanged</a></b></span>(float)</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywallpaper.html#previewImage-prop">previewImageChanged</a></b></span>(QString)</li>
@ -28,29 +27,29 @@
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywallpaper.html#absolutePath-prop">setAbsolutePath</a></b></span>(QString)</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywallpaper.html#appID-prop">setAppID</a></b></span>(QString)</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywallpaper.html#file-prop">setFile</a></b></span>(QString)</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywallpaper.html#fillMode-prop">setFillMode</a></b></span>(FillMode::FillMode)</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywallpaper.html#fillMode-prop">setFillMode</a></b></span>(int)</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywallpaper.html#isLooping-prop">setIsLooping</a></b></span>(bool)</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywallpaper.html#playbackRate-prop">setPlaybackRate</a></b></span>(float)</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywallpaper.html#previewImage-prop">setPreviewImage</a></b></span>(QString)</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywallpaper.html#screenNumber-prop">setScreenNumber</a></b></span>(QVector&lt;int&gt;)</li>
</ul></td><td class="topAlign"><ul>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywallpaper.html#type-prop">setType</a></b></span>(InstalledType::InstalledType)</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywallpaper.html#type-prop">setType</a></b></span>(int)</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywallpaper.html#volume-prop">setVolume</a></b></span>(float)</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywallpaper.html#setWallpaperValue">setWallpaperValue</a></b></span>(const QString &amp;, const QString &amp;, const bool)</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywallpaper.html#type-prop">typeChanged</a></b></span>(InstalledType::InstalledType)</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywallpaper.html#setWallpaperValue">setWallpaperValue</a></b></span>(const QString &amp;, const QString &amp;, const bool) : bool</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywallpaper.html#type-prop">typeChanged</a></b></span>(int)</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywallpaper.html#volume-prop">volumeChanged</a></b></span>(float)</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywallpaper.html#dtor.ScreenPlayWallpaper">~ScreenPlayWallpaper</a></b></span>()</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywallpaper.html#absolutePath-prop">absolutePath</a></b></span>() const : QString</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywallpaper.html#appID-prop">appID</a></b></span>() const : QString</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywallpaper.html#file-prop">file</a></b></span>() const : QString</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywallpaper.html#fillMode-prop">fillMode</a></b></span>() const : FillMode::FillMode</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywallpaper.html#fillMode-prop">fillMode</a></b></span>() const : int</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywallpaper.html#getActiveSettingsJson">getActiveSettingsJson</a></b></span>() : QJsonObject</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywallpaper.html#isLooping-prop">isLooping</a></b></span>() const : bool</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywallpaper.html#playbackRate-prop">playbackRate</a></b></span>() const : float</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywallpaper.html#previewImage-prop">previewImage</a></b></span>() const : QString</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywallpaper.html#replace">replace</a></b></span>(const QString &amp;, const QString &amp;, const QString &amp;, const float, const FillMode::FillMode, const InstalledType::InstalledType, const bool)</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywallpaper.html#screenNumber-prop">screenNumber</a></b></span>() const : QVector&lt;int&gt;</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywallpaper.html#setSDKConnection">setSDKConnection</a></b></span>(const std::shared_ptr&lt;SDKConnection&gt; &amp;)</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywallpaper.html#type-prop">type</a></b></span>() const : InstalledType::InstalledType</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywallpaper.html#setSDKConnection">setSDKConnection</a></b></span>(std::unique_ptr&lt;SDKConnection&gt;)</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywallpaper.html#type-prop">type</a></b></span>() const : int</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywallpaper.html#volume-prop">volume</a></b></span>() const : float</li>
</ul>
</td></tr>

View File

@ -21,7 +21,7 @@
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">ScreenPlayWallpaper Class</h1>
<span class="small-subtitle">class <a href="screenplay.html">ScreenPlay</a>::ScreenPlayWallpaper</span>
<span class="small-subtitle">class <a href="screenplay-module.html">ScreenPlay</a>::ScreenPlayWallpaper</span>
<!-- $$$ScreenPlayWallpaper-brief -->
<p>A Single Object to manage a Wallpaper. <a href="#details">More...</a></p>
<!-- @@@ScreenPlayWallpaper -->
@ -33,19 +33,18 @@
<a name="public-functions"></a>
<h2 id="public-functions">Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaywallpaper.html#ScreenPlayWallpaper-1">ScreenPlayWallpaper</a></b>(const QVector&lt;int&gt; &amp;<i>screenNumber</i>, const std::shared_ptr&lt;GlobalVariables&gt; &amp;<i>globalVariables</i>, const QString &amp;<i>appID</i>, const QString &amp;<i>absolutePath</i>, const QString &amp;<i>previewImage</i>, const QString &amp;<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 &amp;<i>properties</i>, const bool <i>checkWallpaperVisible</i>, QObject *<i>parent</i> = nullptr)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaywallpaper.html#dtor.ScreenPlayWallpaper">~ScreenPlayWallpaper</a></b>()</td></tr>
<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>
<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>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaywallpaper.html#fillMode-prop">fillMode</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QJsonObject </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaywallpaper.html#getActiveSettingsJson">getActiveSettingsJson</a></b>()</td></tr>
<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>
<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>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaywallpaper.html#replace">replace</a></b>(const QString &amp;<i>absolutePath</i>, const QString &amp;<i>previewImage</i>, const QString &amp;<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>
<tr><td class="memItemLeft rightAlign topAlign"> QVector&lt;int&gt; </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaywallpaper.html#screenNumber-prop">screenNumber</a></b>() const</td></tr>
<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&lt;SDKConnection&gt; &amp;<i>connection</i>)</td></tr>
<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"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaywallpaper.html#setSDKConnection">setSDKConnection</a></b>(std::unique_ptr&lt;SDKConnection&gt; <i>connection</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </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>
</table></div>
<a name="public-slots"></a>
@ -56,14 +55,14 @@
<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>
<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#fillMode-prop">setFillMode</a></b>(int <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>
<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&lt;int&gt; <i>screenNumber</i>)</td></tr>
<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#type-prop">setType</a></b>(int <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>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaywallpaper.html#setWallpaperValue">setWallpaperValue</a></b>(const QString &amp;<i>key</i>, const QString &amp;<i>value</i>, const bool <i>save</i> = false)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaywallpaper.html#setWallpaperValue">setWallpaperValue</a></b>(const QString &amp;<i>key</i>, const QString &amp;<i>value</i>, const bool <i>save</i> = false)</td></tr>
</table></div>
<a name="signals"></a>
<h2 id="signals">Signals</h2>
@ -71,12 +70,12 @@
<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>
<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#fillMode-prop">fillModeChanged</a></b>(int <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>
<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&lt;int&gt; <i>screenNumber</i>)</td></tr>
<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#type-prop">typeChanged</a></b>(int <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>
</table></div>
<a name="details"></a>
@ -88,10 +87,6 @@
<!-- @@@ScreenPlayWallpaper -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$ScreenPlayWallpaper$$$ScreenPlayWallpaperconstQVector<int>&conststd::shared_ptr<GlobalVariables>&constQString&constQString&constQString&constQString&constfloatconstfloatconstFillMode::FillModeconstInstalledType::InstalledTypeconstQJsonObject&constboolQObject* -->
<h3 class="fn" id="ScreenPlayWallpaper-1"><a name="ScreenPlayWallpaper-1"></a>ScreenPlayWallpaper::<span class="name">ScreenPlayWallpaper</span>(const <span class="type">QVector</span>&lt;<span class="type">int</span>&gt; &amp;<i>screenNumber</i>, const <span class="type">std::shared_ptr</span>&lt;<span class="type"><a href="screenplay-globalvariables.html">GlobalVariables</a></span>&gt; &amp;<i>globalVariables</i>, const <span class="type">QString</span> &amp;<i>appID</i>, const <span class="type">QString</span> &amp;<i>absolutePath</i>, const <span class="type">QString</span> &amp;<i>previewImage</i>, const <span class="type">QString</span> &amp;<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> &amp;<i>properties</i>, const <span class="type">bool</span> <i>checkWallpaperVisible</i>, <span class="type">QObject</span> *<i>parent</i> = nullptr)</h3>
<p>Constructor for ScreenPlayWallpaper.</p>
<!-- @@@ScreenPlayWallpaper -->
<!-- $$$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>
@ -101,20 +96,20 @@
<p>Prints the exit code if != 0.</p>
<!-- @@@processExit -->
<!-- $$$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> &amp;<i>key</i>, const <span class="type">QString</span> &amp;<i>value</i>, const <span class="type">bool</span> <i>save</i> = false)</h3>
<h3 class="fn" id="setWallpaperValue"><a name="setWallpaperValue"></a><code>[slot] </code><span class="type">bool</span> ScreenPlayWallpaper::<span class="name">setWallpaperValue</span>(const <span class="type">QString</span> &amp;<i>key</i>, const <span class="type">QString</span> &amp;<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 -->
<!-- $$$~ScreenPlayWallpaper[overload1]$$$~ScreenPlayWallpaper -->
<h3 class="fn" id="dtor.ScreenPlayWallpaper"><a name="dtor.ScreenPlayWallpaper"></a><code>[virtual] </code>ScreenPlayWallpaper::<span class="name">~ScreenPlayWallpaper</span>()</h3>
<p>Destructor for <a href="screenplay-screenplaywallpaper.html">ScreenPlayWallpaper</a>.</p>
<!-- @@@~ScreenPlayWallpaper -->
<!-- $$$getActiveSettingsJson[overload1]$$$getActiveSettingsJson -->
<h3 class="fn" id="getActiveSettingsJson"><a name="getActiveSettingsJson"></a><span class="type">QJsonObject</span> ScreenPlayWallpaper::<span class="name">getActiveSettingsJson</span>()</h3>
<p>Loads the project.json that contains all settings to display the wallpaper.</p>
<!-- @@@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> &amp;<i>absolutePath</i>, const <span class="type">QString</span> &amp;<i>previewImage</i>, const <span class="type">QString</span> &amp;<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>
<p>Replaces the current wallpaper with the given one.</p>
<!-- @@@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>&lt;<span class="type"><a href="screenplay-sdkconnection.html">SDKConnection</a></span>&gt; &amp;<i>connection</i>)</h3>
<p>Connects to <a href="screenplay.html">ScreenPlay</a>. Start a alive ping check for every 16 seconds.</p>
<!-- $$$setSDKConnection[overload1]$$$setSDKConnectionstd::unique_ptr<SDKConnection> -->
<h3 class="fn" id="setSDKConnection"><a name="setSDKConnection"></a><span class="type">void</span> ScreenPlayWallpaper::<span class="name">setSDKConnection</span>(<span class="type">std::unique_ptr</span>&lt;<span class="type"><a href="screenplay-sdkconnection.html">SDKConnection</a></span>&gt; <i>connection</i>)</h3>
<p>Connects to <a href="screenplay-module.html">ScreenPlay</a>. Start a alive ping check for every GlobalVariables::contentPingAliveIntervalMS seconds.</p>
<!-- @@@setSDKConnection -->
</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/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>

View File

@ -14,7 +14,6 @@
<p>This is the complete list of members for <a href="screenplay-screenplaywidget.html">ScreenPlay::ScreenPlayWidget</a>, including inherited members.</p>
<div class="table"><table class="propsummary">
<tr><td class="topAlign"><ul>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywidget.html#ScreenPlayWidget">ScreenPlayWidget</a></b></span>(const QString &amp;, const std::shared_ptr&lt;GlobalVariables&gt; &amp;, const QPoint &amp;, const QString &amp;, const QString &amp;, const QJsonObject &amp;, const InstalledType::InstalledType)</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywidget.html#absolutePath-prop">absolutePathChanged</a></b></span>(QString)</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywidget.html#appID-prop">appIDChanged</a></b></span>(QString)</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywidget.html#getActiveSettingsJson">getActiveSettingsJson</a></b></span>() : QJsonObject</li>
@ -23,16 +22,16 @@
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywidget.html#absolutePath-prop">setAbsolutePath</a></b></span>(QString)</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywidget.html#appID-prop">setAppID</a></b></span>(QString)</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywidget.html#position-prop">setPosition</a></b></span>(QPoint)</li>
</ul></td><td class="topAlign"><ul>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywidget.html#previewImage-prop">setPreviewImage</a></b></span>(QString)</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywidget.html#type-prop">setType</a></b></span>(InstalledType::InstalledType)</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywidget.html#type-prop">typeChanged</a></b></span>(InstalledType::InstalledType)</li>
</ul></td><td class="topAlign"><ul>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywidget.html#type-prop">setType</a></b></span>(int)</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywidget.html#type-prop">typeChanged</a></b></span>(int)</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywidget.html#absolutePath-prop">absolutePath</a></b></span>() const : QString</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywidget.html#appID-prop">appID</a></b></span>() const : QString</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywidget.html#position-prop">position</a></b></span>() const : QPoint</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywidget.html#previewImage-prop">previewImage</a></b></span>() const : QString</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywidget.html#setSDKConnection">setSDKConnection</a></b></span>(const std::shared_ptr&lt;SDKConnection&gt; &amp;)</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywidget.html#type-prop">type</a></b></span>() const : InstalledType::InstalledType</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywidget.html#setSDKConnection">setSDKConnection</a></b></span>(std::unique_ptr&lt;SDKConnection&gt;)</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywidget.html#type-prop">type</a></b></span>() const : int</li>
</ul>
</td></tr>
</table></div>

View File

@ -21,7 +21,7 @@
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">ScreenPlayWidget Class</h1>
<span class="small-subtitle">class <a href="screenplay.html">ScreenPlay</a>::ScreenPlayWidget</span>
<span class="small-subtitle">class <a href="screenplay-module.html">ScreenPlay</a>::ScreenPlayWidget</span>
<!-- $$$ScreenPlayWidget-brief -->
<p>A Single Object to manage a Widget. <a href="#details">More...</a></p>
<!-- @@@ScreenPlayWidget -->
@ -33,13 +33,12 @@
<a name="public-functions"></a>
<h2 id="public-functions">Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaywidget.html#ScreenPlayWidget">ScreenPlayWidget</a></b>(const QString &amp;<i>appID</i>, const std::shared_ptr&lt;GlobalVariables&gt; &amp;<i>globalVariables</i>, const QPoint &amp;<i>position</i>, const QString &amp;<i>absolutePath</i>, const QString &amp;<i>previewImage</i>, const QJsonObject &amp;<i>properties</i>, const InstalledType::InstalledType <i>type</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaywidget.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-screenplaywidget.html#appID-prop">appID</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QPoint </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaywidget.html#position-prop">position</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaywidget.html#previewImage-prop">previewImage</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaywidget.html#setSDKConnection">setSDKConnection</a></b>(const std::shared_ptr&lt;SDKConnection&gt; &amp;<i>connection</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> InstalledType::InstalledType </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaywidget.html#type-prop">type</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaywidget.html#setSDKConnection">setSDKConnection</a></b>(std::unique_ptr&lt;SDKConnection&gt; <i>connection</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaywidget.html#type-prop">type</a></b>() const</td></tr>
</table></div>
<a name="public-slots"></a>
<h2 id="public-slots">Public Slots</h2>
@ -49,7 +48,7 @@
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaywidget.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-screenplaywidget.html#position-prop">setPosition</a></b>(QPoint <i>position</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaywidget.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-screenplaywidget.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-screenplaywidget.html#type-prop">setType</a></b>(int <i>type</i>)</td></tr>
</table></div>
<a name="signals"></a>
<h2 id="signals">Signals</h2>
@ -58,7 +57,7 @@
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaywidget.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-screenplaywidget.html#position-prop">positionChanged</a></b>(QPoint <i>position</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaywidget.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-screenplaywidget.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-screenplaywidget.html#type-prop">typeChanged</a></b>(int <i>type</i>)</td></tr>
</table></div>
<a name="details"></a>
<!-- $$$ScreenPlayWidget-description -->
@ -69,17 +68,13 @@
<!-- @@@ScreenPlayWidget -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$ScreenPlayWidget[overload1]$$$ScreenPlayWidgetconstQString&conststd::shared_ptr<GlobalVariables>&constQPoint&constQString&constQString&constQJsonObject&constInstalledType::InstalledType -->
<h3 class="fn" id="ScreenPlayWidget"><a name="ScreenPlayWidget"></a>ScreenPlayWidget::<span class="name">ScreenPlayWidget</span>(const <span class="type">QString</span> &amp;<i>appID</i>, const <span class="type">std::shared_ptr</span>&lt;<span class="type"><a href="screenplay-globalvariables.html">GlobalVariables</a></span>&gt; &amp;<i>globalVariables</i>, const <span class="type">QPoint</span> &amp;<i>position</i>, const <span class="type">QString</span> &amp;<i>absolutePath</i>, const <span class="type">QString</span> &amp;<i>previewImage</i>, const <span class="type">QJsonObject</span> &amp;<i>properties</i>, const <span class="type">InstalledType::InstalledType</span> <i>type</i>)</h3>
<p>Constructs a ScreenPlayWidget</p>
<!-- @@@ScreenPlayWidget -->
<!-- $$$getActiveSettingsJson[overload1]$$$getActiveSettingsJson -->
<h3 class="fn" id="getActiveSettingsJson"><a name="getActiveSettingsJson"></a><code>[slot] </code><span class="type">QJsonObject</span> ScreenPlayWidget::<span class="name">getActiveSettingsJson</span>()</h3>
<p>Loads the project.json content.</p>
<!-- @@@getActiveSettingsJson -->
<!-- $$$setSDKConnection[overload1]$$$setSDKConnectionconststd::shared_ptr<SDKConnection>& -->
<h3 class="fn" id="setSDKConnection"><a name="setSDKConnection"></a><span class="type">void</span> ScreenPlayWidget::<span class="name">setSDKConnection</span>(const <span class="type">std::shared_ptr</span>&lt;<span class="type"><a href="screenplay-sdkconnection.html">SDKConnection</a></span>&gt; &amp;<i>connection</i>)</h3>
<p>Connects to <a href="screenplay.html">ScreenPlay</a>. Start a alive ping check for every 16 seconds.</p>
<!-- $$$setSDKConnection[overload1]$$$setSDKConnectionstd::unique_ptr<SDKConnection> -->
<h3 class="fn" id="setSDKConnection"><a name="setSDKConnection"></a><span class="type">void</span> ScreenPlayWidget::<span class="name">setSDKConnection</span>(<span class="type">std::unique_ptr</span>&lt;<span class="type"><a href="screenplay-sdkconnection.html">SDKConnection</a></span>&gt; <i>connection</i>)</h3>
<p>Connects to <a href="screenplay-module.html">ScreenPlay</a>. Start a alive ping check for every GlobalVariables::contentPingAliveIntervalMS seconds.</p>
<!-- @@@setSDKConnection -->
</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/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>

View File

@ -15,10 +15,10 @@
<ul>
<li class="fn"><span class="name"><b><a href="screenplay-sdkconnection.html#SDKConnection">SDKConnection</a></b></span>(QLocalSocket *, QObject *)</li>
<li class="fn"><span class="name"><b><a href="screenplay-sdkconnection.html#appID-prop">appIDChanged</a></b></span>(QString)</li>
<li class="fn"><span class="name"><b><a href="screenplay-sdkconnection.html#close">close</a></b></span>()</li>
<li class="fn"><span class="name"><b><a href="screenplay-sdkconnection.html#close">close</a></b></span>() : bool</li>
<li class="fn"><span class="name"><b><a href="screenplay-sdkconnection.html#monitor-prop">monitorChanged</a></b></span>(QVector&lt;int&gt;)</li>
<li class="fn"><span class="name"><b><a href="screenplay-sdkconnection.html#readyRead">readyRead</a></b></span>()</li>
<li class="fn"><span class="name"><b><a href="screenplay-sdkconnection.html#sendMessage">sendMessage</a></b></span>(const QByteArray &amp;)</li>
<li class="fn"><span class="name"><b><a href="screenplay-sdkconnection.html#sendMessage">sendMessage</a></b></span>(const QByteArray &amp;) : bool</li>
<li class="fn"><span class="name"><b><a href="screenplay-sdkconnection.html#appID-prop">setAppID</a></b></span>(QString)</li>
<li class="fn"><span class="name"><b><a href="screenplay-sdkconnection.html#monitor-prop">setMonitor</a></b></span>(QVector&lt;int&gt;)</li>
<li class="fn"><span class="name"><b><a href="screenplay-sdkconnection.html#type-prop">setType</a></b></span>(QString)</li>

View File

@ -21,7 +21,7 @@
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">SDKConnection Class</h1>
<span class="small-subtitle">class <a href="screenplay.html">ScreenPlay</a>::SDKConnection</span>
<span class="small-subtitle">class <a href="screenplay-module.html">ScreenPlay</a>::SDKConnection</span>
<!-- $$$SDKConnection-brief -->
<p>Contains all connections to Wallpaper and Widgets. <a href="#details">More...</a></p>
<!-- @@@SDKConnection -->
@ -41,9 +41,9 @@
<a name="public-slots"></a>
<h2 id="public-slots">Public Slots</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-sdkconnection.html#close">close</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="screenplay-sdkconnection.html#close">close</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-sdkconnection.html#readyRead">readyRead</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-sdkconnection.html#sendMessage">sendMessage</a></b>(const QByteArray &amp;<i>message</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="screenplay-sdkconnection.html#sendMessage">sendMessage</a></b>(const QByteArray &amp;<i>message</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-sdkconnection.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-sdkconnection.html#monitor-prop">setMonitor</a></b>(QVector&lt;int&gt; <i>monitor</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-sdkconnection.html#type-prop">setType</a></b>(QString <i>type</i>)</td></tr>
@ -68,7 +68,7 @@
<p>Constructor.</p>
<!-- @@@SDKConnection -->
<!-- $$$close[overload1]$$$close -->
<h3 class="fn" id="close"><a name="close"></a><code>[slot] </code><span class="type">void</span> SDKConnection::<span class="name">close</span>()</h3>
<h3 class="fn" id="close"><a name="close"></a><code>[slot] </code><span class="type">bool</span> SDKConnection::<span class="name">close</span>()</h3>
<p>Closes the socket connection. Before it explicitly sends a quit command to make sure the wallpaper closes (fast). This also requestDecreaseWidgetCount() because Widgets.</p>
<!-- @@@close -->
<!-- $$$readyRead[overload1]$$$readyRead -->
@ -76,12 +76,12 @@
<p>Read incomming messages. Checks for types like:</p>
<ol class="1" type="1"><li>ping: Used to check if wallpaper is still alive</li>
<li><a href="screenplay-sdkconnection.html#appID-prop">appID</a>: First message of an app must contain the ID to match it to our list of running apps</li>
<li>command: Used mainly for requestRaise. This will get fired if the user tries to open a second <a href="screenplay.html">ScreenPlay</a> instance</li>
<li>command: Used mainly for requestRaise. This will get fired if the user tries to open a second <a href="screenplay-module.html">ScreenPlay</a> instance</li>
<li>general Json object</li>
</ol>
<!-- @@@readyRead -->
<!-- $$$sendMessage[overload1]$$$sendMessageconstQByteArray& -->
<h3 class="fn" id="sendMessage"><a name="sendMessage"></a><code>[slot] </code><span class="type">void</span> SDKConnection::<span class="name">sendMessage</span>(const <span class="type">QByteArray</span> &amp;<i>message</i>)</h3>
<h3 class="fn" id="sendMessage"><a name="sendMessage"></a><code>[slot] </code><span class="type">bool</span> SDKConnection::<span class="name">sendMessage</span>(const <span class="type">QByteArray</span> &amp;<i>message</i>)</h3>
<p>Sends a message to the connected socket.</p>
<!-- @@@sendMessage -->
</div>

View File

@ -40,12 +40,12 @@
<li class="fn"><span class="name"><b><a href="screenplay-settings.html#steamVersion-prop">setSteamVersion</a></b></span>(bool)</li>
</ul></td><td class="topAlign"><ul>
<li class="fn"><span class="name"><b><a href="screenplay-settings.html#theme-prop">setTheme</a></b></span>(ScreenPlay::Settings::Theme)</li>
<li class="fn"><span class="name"><b><a href="screenplay-settings.html#videoFillMode-prop">setVideoFillMode</a></b></span>(ScreenPlay::FillMode::FillMode)</li>
<li class="fn"><span class="name"><b><a href="screenplay-settings.html#videoFillMode-prop">setVideoFillMode</a></b></span>(int)</li>
<li class="fn"><span class="name"><b><a href="screenplay-settings.html#setupWidgetAndWindowPaths">setupWidgetAndWindowPaths</a></b></span>()</li>
<li class="fn"><span class="name"><b><a href="screenplay-settings.html#silentStart-prop">silentStartChanged</a></b></span>(bool)</li>
<li class="fn"><span class="name"><b><a href="screenplay-settings.html#steamVersion-prop">steamVersionChanged</a></b></span>(bool)</li>
<li class="fn"><span class="name"><b><a href="screenplay-settings.html#theme-prop">themeChanged</a></b></span>(ScreenPlay::Settings::Theme)</li>
<li class="fn"><span class="name"><b><a href="screenplay-settings.html#videoFillMode-prop">videoFillModeChanged</a></b></span>(ScreenPlay::FillMode::FillMode)</li>
<li class="fn"><span class="name"><b><a href="screenplay-settings.html#videoFillMode-prop">videoFillModeChanged</a></b></span>(int)</li>
<li class="fn"><span class="name"><b><a href="screenplay-settings.html#writeJsonFileFromResource">writeJsonFileFromResource</a></b></span>(const QString &amp;)</li>
<li class="fn"><span class="name"><b><a href="screenplay-settings.html#anonymousTelemetry-prop">anonymousTelemetry</a></b></span>() const : bool</li>
<li class="fn"><span class="name"><b><a href="screenplay-settings.html#autostart-prop">autostart</a></b></span>() const : bool</li>
@ -61,7 +61,7 @@
<li class="fn"><span class="name"><b><a href="screenplay-settings.html#silentStart-prop">silentStart</a></b></span>() const : bool</li>
<li class="fn"><span class="name"><b><a href="screenplay-settings.html#steamVersion-prop">steamVersion</a></b></span>() const : bool</li>
<li class="fn"><span class="name"><b><a href="screenplay-settings.html#theme-prop">theme</a></b></span>() const : ScreenPlay::Settings::Theme</li>
<li class="fn"><span class="name"><b><a href="screenplay-settings.html#videoFillMode-prop">videoFillMode</a></b></span>() const : ScreenPlay::FillMode::FillMode</li>
<li class="fn"><span class="name"><b><a href="screenplay-settings.html#videoFillMode-prop">videoFillMode</a></b></span>() const : int</li>
</ul>
</td></tr>
</table></div>

View File

@ -21,7 +21,7 @@
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">Settings Class</h1>
<span class="small-subtitle">class <a href="screenplay.html">ScreenPlay</a>::Settings</span>
<span class="small-subtitle">class <a href="screenplay-module.html">ScreenPlay</a>::Settings</span>
<!-- $$$Settings-brief -->
<p>Global settings class for reading and writing settings. <a href="#details">More...</a></p>
<!-- @@@Settings -->
@ -48,7 +48,7 @@
<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>
<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>
<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>
<tr><td class="memItemLeft rightAlign topAlign"> ScreenPlay::FillMode::FillMode </td><td class="memItemRight bottomAlign"><b><a href="screenplay-settings.html#videoFillMode-prop">videoFillMode</a></b>() const</td></tr>
<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>
</table></div>
<a name="public-slots"></a>
<h2 id="public-slots">Public Slots</h2>
@ -67,7 +67,7 @@
<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>
<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>
<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>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-settings.html#videoFillMode-prop">setVideoFillMode</a></b>(ScreenPlay::FillMode::FillMode <i>videoFillMode</i>)</td></tr>
<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>
<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 &amp;<i>filename</i>)</td></tr>
</table></div>
@ -87,7 +87,7 @@
<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>
<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>
<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>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-settings.html#videoFillMode-prop">videoFillModeChanged</a></b>(ScreenPlay::FillMode::FillMode <i>videoFillMode</i>)</td></tr>
<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>
</table></div>
<a name="details"></a>
<!-- $$$Settings-description -->
@ -97,7 +97,7 @@
<ul>
<li>User configuration via AppData<b class="redFont"><code>\Local</code></b>ScreenPlayScreenPlay<ul>
<li>profiles.json - saved wallpaper and widgets config</li>
<li>Computer\HKEY_CURRENT_USER\Software\<a href="screenplay.html">ScreenPlay</a>\<a href="screenplay.html">ScreenPlay</a> - ScreenPlayContentPath for steam plugin</li>
<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>
</ul>
</li>
<li>Communication via the SDK Connector</li>
@ -110,7 +110,7 @@
<!-- $$$Settings[overload1]$$$Settingsconststd::shared_ptr<GlobalVariables>&QObject* -->
<h3 class="fn" id="Settings"><a name="Settings"></a>Settings::<span class="name">Settings</span>(const <span class="type">std::shared_ptr</span>&lt;<span class="type"><a href="screenplay-globalvariables.html">GlobalVariables</a></span>&gt; &amp;<i>globalVariables</i>, <span class="type">QObject</span> *<i>parent</i> = nullptr)</h3>
<p>Constructor and sets up:</p>
<ol class="1" type="1"><li>Sets the git build hash via <a href="screenplay.html">ScreenPlay</a>.pro c++ define</li>
<ol class="1" type="1"><li>Sets the git build hash via <a href="screenplay-module.html">ScreenPlay</a>.pro c++ define</li>
<li>Checks the langauge via settings or system and available ones and installes a translator.</li>
<li>Checks the AbsoluteStoragePath.</li>
<li>Checks regisitry for steam plugin settings</li>

View File

@ -12,34 +12,20 @@
<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">List of All Members for Util</h1>
<p>This is the complete list of members for <a href="screenplay-util.html">ScreenPlay::Util</a>, including inherited members.</p>
<div class="table"><table class="propsummary">
<tr><td class="topAlign"><ul>
<ul>
<li class="fn"><span class="name"><b><a href="screenplay-util.html#Util">Util</a></b></span>(QNetworkAccessManager *, QObject *)</li>
<li class="fn"><span class="name"><b><a href="screenplay-util.html#copyPreviewThumbnail">copyPreviewThumbnail</a></b></span>(QJsonObject &amp;, const QString &amp;, const QString &amp;) : bool</li>
<li class="fn"><span class="name"><b><a href="screenplay-util.html#copyToClipboard">copyToClipboard</a></b></span>(const QString &amp;) const</li>
<li class="fn"><span class="name"><b><a href="screenplay-util.html#debugMessages-prop">debugMessagesChanged</a></b></span>(QString)</li>
<li class="fn"><span class="name"><b><a href="screenplay-util.html#fillArray">fillArray</a></b></span>(const QVector&lt;QString&gt; &amp;) : QJsonArray</li>
<li class="fn"><span class="name"><b><a href="screenplay-util.html#generateRandomString">generateRandomString</a></b></span>(quint32) : QString</li>
<li class="fn"><span class="name"><b><a href="screenplay-util.html#getInstalledTypeFromString">getInstalledTypeFromString</a></b></span>(const QString &amp;) : std::optional&lt;InstalledType::InstalledType&gt;</li>
<li class="fn"><span class="name"><b><a href="screenplay-util.html#getSearchTypeFromInstalledType">getSearchTypeFromInstalledType</a></b></span>(const InstalledType::InstalledType) : SearchType::SearchType</li>
<li class="fn"><span class="name"><b><a href="screenplay-util.html#getVersionNumberFromString">getVersionNumberFromString</a></b></span>(const QString &amp;) : std::optional&lt;QVersionNumber&gt;</li>
<li class="fn"><span class="name"><b><a href="screenplay-util.html#logToGui">logToGui</a></b></span>(QtMsgType, const QMessageLogContext &amp;, const QString &amp;)</li>
<li class="fn"><span class="name"><b><a href="screenplay-util.html#openFolderInExplorer">openFolderInExplorer</a></b></span>(const QString &amp;) const</li>
<li class="fn"><span class="name"><b><a href="screenplay-util.html#openJsonFileToObject">openJsonFileToObject</a></b></span>(const QString &amp;) : std::optional&lt;QJsonObject&gt;</li>
</ul></td><td class="topAlign"><ul>
<li class="fn"><span class="name"><b><a href="screenplay-util.html#openJsonFileToString">openJsonFileToString</a></b></span>(const QString &amp;) : std::optional&lt;QString&gt;</li>
<li class="fn"><span class="name"><b><a href="screenplay-util.html#parseQByteArrayToQJsonObject">parseQByteArrayToQJsonObject</a></b></span>(const QByteArray &amp;) : std::optional&lt;QJsonObject&gt;</li>
<li class="fn"><span class="name"><b><a href="screenplay-util.html#requestAllLicenses">requestAllLicenses</a></b></span>()</li>
<li class="fn"><span class="name"><b><a href="screenplay-util.html#requestDataProtection">requestDataProtection</a></b></span>()</li>
<li class="fn"><span class="name"><b><a href="screenplay-util.html#toLocal">toLocal</a></b></span>(const QString &amp;) : QString</li>
<li class="fn"><span class="name"><b><a href="screenplay-util.html#toString">toString</a></b></span>(const QStringList &amp;) : QString</li>
<li class="fn"><span class="name"><b><a href="screenplay-util.html#writeFile">writeFile</a></b></span>(const QString &amp;, const QString &amp;) : bool</li>
<li class="fn"><span class="name"><b><a href="screenplay-util.html#writeFileFromQrc">writeFileFromQrc</a></b></span>(const QString &amp;, const QString &amp;) : bool</li>
<li class="fn"><span class="name"><b><a href="screenplay-util.html#writeJsonObjectToFile">writeJsonObjectToFile</a></b></span>(const QString &amp;, const QJsonObject &amp;, bool) : bool</li>
<li class="fn"><span class="name"><b><a href="screenplay-util.html#writeSettings">writeSettings</a></b></span>(const QJsonObject &amp;, const QString &amp;) : bool</li>
<li class="fn"><span class="name"><b><a href="screenplay-util.html#debugMessages-prop">debugMessages</a></b></span>() const : QString</li>
</ul>
</td></tr>
</table></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/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>
</html>

View File

@ -21,7 +21,7 @@
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">Util Class</h1>
<span class="small-subtitle">class <a href="screenplay.html">ScreenPlay</a>::Util</span>
<span class="small-subtitle">class <a href="screenplay-module.html">ScreenPlay</a>::Util</span>
<!-- $$$Util-brief -->
<p>Easy to use global object to use when certain functionality is not available in QML. <a href="#details">More...</a></p>
<!-- @@@Util -->
@ -39,22 +39,12 @@
<a name="public-slots"></a>
<h2 id="public-slots">Public Slots</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="screenplay-util.html#copyPreviewThumbnail">copyPreviewThumbnail</a></b>(QJsonObject &amp;<i>obj</i>, const QString &amp;<i>name</i>, const QString &amp;<i>destination</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="screenplay-util.html#copyPreviewThumbnail">copyPreviewThumbnail</a></b>(QJsonObject &amp;<i>obj</i>, const QString &amp;<i>previewThumbnail</i>, const QString &amp;<i>destination</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-util.html#copyToClipboard">copyToClipboard</a></b>(const QString &amp;<i>text</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QJsonArray </td><td class="memItemRight bottomAlign"><b><a href="screenplay-util.html#fillArray">fillArray</a></b>(const QVector&lt;QString&gt; &amp;<i>items</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="screenplay-util.html#generateRandomString">generateRandomString</a></b>(quint32 <i>length</i> = 32)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> std::optional&lt;InstalledType::InstalledType&gt; </td><td class="memItemRight bottomAlign"><b><a href="screenplay-util.html#getInstalledTypeFromString">getInstalledTypeFromString</a></b>(const QString &amp;<i>type</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> SearchType::SearchType </td><td class="memItemRight bottomAlign"><b><a href="screenplay-util.html#getSearchTypeFromInstalledType">getSearchTypeFromInstalledType</a></b>(const InstalledType::InstalledType <i>type</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> std::optional&lt;QVersionNumber&gt; </td><td class="memItemRight bottomAlign"><b><a href="screenplay-util.html#getVersionNumberFromString">getVersionNumberFromString</a></b>(const QString &amp;<i>str</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-util.html#logToGui">logToGui</a></b>(QtMsgType <i>type</i>, const QMessageLogContext &amp;<i>context</i>, const QString &amp;<i>msg</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-util.html#openFolderInExplorer">openFolderInExplorer</a></b>(const QString &amp;<i>url</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> std::optional&lt;QJsonObject&gt; </td><td class="memItemRight bottomAlign"><b><a href="screenplay-util.html#openJsonFileToObject">openJsonFileToObject</a></b>(const QString &amp;<i>path</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> std::optional&lt;QString&gt; </td><td class="memItemRight bottomAlign"><b><a href="screenplay-util.html#openJsonFileToString">openJsonFileToString</a></b>(const QString &amp;<i>path</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> std::optional&lt;QJsonObject&gt; </td><td class="memItemRight bottomAlign"><b><a href="screenplay-util.html#parseQByteArrayToQJsonObject">parseQByteArrayToQJsonObject</a></b>(const QByteArray &amp;<i>byteArray</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-util.html#requestAllLicenses">requestAllLicenses</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-util.html#requestDataProtection">requestDataProtection</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="screenplay-util.html#toLocal">toLocal</a></b>(const QString &amp;<i>url</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="screenplay-util.html#toString">toString</a></b>(const QStringList &amp;<i>list</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="screenplay-util.html#writeFile">writeFile</a></b>(const QString &amp;<i>text</i>, const QString &amp;<i>absolutePath</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="screenplay-util.html#writeFileFromQrc">writeFileFromQrc</a></b>(const QString &amp;<i>qrcPath</i>, const QString &amp;<i>absolutePath</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="screenplay-util.html#writeJsonObjectToFile">writeJsonObjectToFile</a></b>(const QString &amp;<i>absoluteFilePath</i>, const QJsonObject &amp;<i>object</i>, bool <i>truncate</i> = true)</td></tr>
@ -78,38 +68,13 @@
<p>Constructor.</p>
<!-- @@@Util -->
<!-- $$$copyPreviewThumbnail[overload1]$$$copyPreviewThumbnailQJsonObject&constQString&constQString& -->
<h3 class="fn" id="copyPreviewThumbnail"><a name="copyPreviewThumbnail"></a><code>[static slot] </code><span class="type">bool</span> Util::<span class="name">copyPreviewThumbnail</span>(<span class="type">QJsonObject</span> &amp;<i>obj</i>, const <span class="type">QString</span> &amp;<i>name</i>, const <span class="type">QString</span> &amp;<i>destination</i>)</h3>
<h3 class="fn" id="copyPreviewThumbnail"><a name="copyPreviewThumbnail"></a><code>[static slot] </code><span class="type">bool</span> Util::<span class="name">copyPreviewThumbnail</span>(<span class="type">QJsonObject</span> &amp;<i>obj</i>, const <span class="type">QString</span> &amp;<i>previewThumbnail</i>, const <span class="type">QString</span> &amp;<i>destination</i>)</h3>
<p>Takes reference to <i>obj</i>. If the copy of the thumbnail is successful, it adds the corresponding settings entry to the json object reference.</p>
<!-- @@@copyPreviewThumbnail -->
<!-- $$$copyToClipboard[overload1]$$$copyToClipboardconstQString& -->
<h3 class="fn" id="copyToClipboard"><a name="copyToClipboard"></a><code>[slot] </code><span class="type">void</span> Util::<span class="name">copyToClipboard</span>(const <span class="type">QString</span> &amp;<i>text</i>) const</h3>
<p>Copies the given string to the clipboard.</p>
<!-- @@@copyToClipboard -->
<!-- $$$fillArray[overload1]$$$fillArrayconstQVector<QString>& -->
<h3 class="fn" id="fillArray"><a name="fillArray"></a><code>[static slot] </code><span class="type">QJsonArray</span> Util::<span class="name">fillArray</span>(const <span class="type">QVector</span>&lt;<span class="type">QString</span>&gt; &amp;<i>items</i>)</h3>
<p>Util function that converts a QVector of Strings into a QJsonArray.</p>
<!-- @@@fillArray -->
<!-- $$$generateRandomString[overload1]$$$generateRandomStringquint32 -->
<h3 class="fn" id="generateRandomString"><a name="generateRandomString"></a><code>[static slot] </code><span class="type">QString</span> Util::<span class="name">generateRandomString</span>(<span class="type">quint32</span> <i>length</i> = 32)</h3>
<p>Generates a (non secure) random string with the default length of 32. Can contain:</p>
<ul>
<li>A-Z</li>
<li>a-z</li>
<li>0-9</li>
</ul>
<!-- @@@generateRandomString -->
<!-- $$$getInstalledTypeFromString[overload1]$$$getInstalledTypeFromStringconstQString& -->
<h3 class="fn" id="getInstalledTypeFromString"><a name="getInstalledTypeFromString"></a><code>[static slot] </code><span class="type">std::optional</span>&lt;<span class="type">InstalledType::InstalledType</span>&gt; Util::<span class="name">getInstalledTypeFromString</span>(const <span class="type">QString</span> &amp;<i>type</i>)</h3>
<p>Maps the installed type from a QString to an enum. Used for parsing the project.json.</p>
<!-- @@@getInstalledTypeFromString -->
<!-- $$$getSearchTypeFromInstalledType[overload1]$$$getSearchTypeFromInstalledTypeconstInstalledType::InstalledType -->
<h3 class="fn" id="getSearchTypeFromInstalledType"><a name="getSearchTypeFromInstalledType"></a><code>[static slot] </code><span class="type">SearchType::SearchType</span> Util::<span class="name">getSearchTypeFromInstalledType</span>(const <span class="type">InstalledType::InstalledType</span> <i>type</i>)</h3>
<p>Maps the Search type to an installed type. Used for filtering the installed content.</p>
<!-- @@@getSearchTypeFromInstalledType -->
<!-- $$$getVersionNumberFromString[overload1]$$$getVersionNumberFromStringconstQString& -->
<h3 class="fn" id="getVersionNumberFromString"><a name="getVersionNumberFromString"></a><code>[static slot] </code><span class="type">std::optional</span>&lt;<span class="type">QVersionNumber</span>&gt; Util::<span class="name">getVersionNumberFromString</span>(const <span class="type">QString</span> &amp;<i>str</i>)</h3>
<p>Parses a version from a given QString. The QString must be looke like this: 1.0&#x2e;0 - Major.Minor.Patch. A fixed position is used for parsing (at 0,2,4). Return std::nullopt when not successful.</p>
<!-- @@@getVersionNumberFromString -->
<!-- $$$logToGui[overload1]$$$logToGuiQtMsgTypeconstQMessageLogContext&constQString& -->
<h3 class="fn" id="logToGui"><a name="logToGui"></a><code>[static slot] </code><span class="type">void</span> Util::<span class="name">logToGui</span>(<span class="type">QtMsgType</span> <i>type</i>, const <span class="type">QMessageLogContext</span> &amp;<i>context</i>, const <span class="type">QString</span> &amp;<i>msg</i>)</h3>
<p>Basic logging to the GUI. No logging is done to a log file for now. This string can be copied in the settings tab in the UI.</p>
@ -118,18 +83,6 @@
<h3 class="fn" id="openFolderInExplorer"><a name="openFolderInExplorer"></a><code>[slot] </code><span class="type">void</span> Util::<span class="name">openFolderInExplorer</span>(const <span class="type">QString</span> &amp;<i>url</i>) const</h3>
<p>Opens a native folder window on the given path. Windows and Mac only for now!</p>
<!-- @@@openFolderInExplorer -->
<!-- $$$openJsonFileToObject[overload1]$$$openJsonFileToObjectconstQString& -->
<h3 class="fn" id="openJsonFileToObject"><a name="openJsonFileToObject"></a><code>[static slot] </code><span class="type">std::optional</span>&lt;<span class="type">QJsonObject</span>&gt; Util::<span class="name">openJsonFileToObject</span>(const <span class="type">QString</span> &amp;<i>path</i>)</h3>
<p>Opens a json file (absolute path) and tries to convert it to a QJsonObject. Returns std::nullopt when not successful.</p>
<!-- @@@openJsonFileToObject -->
<!-- $$$openJsonFileToString[overload1]$$$openJsonFileToStringconstQString& -->
<h3 class="fn" id="openJsonFileToString"><a name="openJsonFileToString"></a><code>[static slot] </code><span class="type">std::optional</span>&lt;<span class="type">QString</span>&gt; Util::<span class="name">openJsonFileToString</span>(const <span class="type">QString</span> &amp;<i>path</i>)</h3>
<p>Opens a json file (absolute path) and tries to convert it to a QString. Returns std::nullopt when not successful.</p>
<!-- @@@openJsonFileToString -->
<!-- $$$parseQByteArrayToQJsonObject[overload1]$$$parseQByteArrayToQJsonObjectconstQByteArray& -->
<h3 class="fn" id="parseQByteArrayToQJsonObject"><a name="parseQByteArrayToQJsonObject"></a><code>[static slot] </code><span class="type">std::optional</span>&lt;<span class="type">QJsonObject</span>&gt; Util::<span class="name">parseQByteArrayToQJsonObject</span>(const <span class="type">QByteArray</span> &amp;<i>byteArray</i>)</h3>
<p>Parses a QByteArray to a QJsonObject. If returns and std::nullopt on failure.</p>
<!-- @@@parseQByteArrayToQJsonObject -->
<!-- $$$requestAllLicenses[overload1]$$$requestAllLicenses -->
<h3 class="fn" id="requestAllLicenses"><a name="requestAllLicenses"></a><code>[slot] </code><span class="type">void</span> Util::<span class="name">requestAllLicenses</span>()</h3>
<p>Loads all content of the legal folder in the qrc into a property string of this class. allLicenseLoaded is emited when loading is finished.</p>
@ -138,14 +91,6 @@
<h3 class="fn" id="requestDataProtection"><a name="requestDataProtection"></a><code>[slot] </code><span class="type">void</span> Util::<span class="name">requestDataProtection</span>()</h3>
<p>Loads all dataprotection of the legal folder in the qrc into a property string of this class. allDataProtectionLoaded is emited when loading is finished.</p>
<!-- @@@requestDataProtection -->
<!-- $$$toLocal[overload1]$$$toLocalconstQString& -->
<h3 class="fn" id="toLocal"><a name="toLocal"></a><code>[static slot] </code><span class="type">QString</span> Util::<span class="name">toLocal</span>(const <span class="type">QString</span> &amp;<i>url</i>)</h3>
<p>Converts the given <i>url</i> string to a local file path.</p>
<!-- @@@toLocal -->
<!-- $$$toString[overload1]$$$toStringconstQStringList& -->
<h3 class="fn" id="toString"><a name="toString"></a><code>[static slot] </code><span class="type">QString</span> Util::<span class="name">toString</span>(const <span class="type">QStringList</span> &amp;<i>list</i>)</h3>
<p>Helper function to append a QStringList into a QString with a space between the items.</p>
<!-- @@@toString -->
<!-- $$$writeFile[overload1]$$$writeFileconstQString&constQString& -->
<h3 class="fn" id="writeFile"><a name="writeFile"></a><code>[static slot] </code><span class="type">bool</span> Util::<span class="name">writeFile</span>(const <span class="type">QString</span> &amp;<i>text</i>, const <span class="type">QString</span> &amp;<i>absolutePath</i>)</h3>
<p>Tries to save into a text file with absolute path.</p>

View File

@ -20,7 +20,7 @@
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">Wizards Class</h1>
<span class="small-subtitle">class <a href="screenplay.html">ScreenPlay</a>::Wizards</span>
<span class="small-subtitle">class <a href="screenplay-module.html">ScreenPlay</a>::Wizards</span>
<!-- $$$Wizards-brief -->
<p>Baseclass for all wizards. Mostly for copying and creating project files. <a href="#details">More...</a></p>
<!-- @@@Wizards -->
@ -38,9 +38,9 @@
<h2 id="public-slots">Public Slots</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-wizards.html#createHTMLWallpaper">createHTMLWallpaper</a></b>(const QString &amp;<i>title</i>, const QString &amp;<i>licenseName</i>, const QString &amp;<i>licenseFile</i>, const QString &amp;<i>createdBy</i>, const QString &amp;<i>previewThumbnail</i>, const QVector&lt;QString&gt; &amp;<i>tags</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-wizards.html#createHTMLWidget">createHTMLWidget</a></b>(const QString &amp;<i>title</i>, const QString &amp;<i>licenseName</i>, const QString &amp;<i>licenseFile</i>, const QString &amp;<i>previewThumbnail</i>, const QString &amp;<i>createdBy</i>, const QVector&lt;QString&gt; &amp;<i>tags</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-wizards.html#createHTMLWidget">createHTMLWidget</a></b>(const QString &amp;<i>title</i>, const QString &amp;<i>licenseName</i>, const QString &amp;<i>licenseFile</i>, const QString &amp;<i>createdBy</i>, const QString &amp;<i>previewThumbnail</i>, const QVector&lt;QString&gt; &amp;<i>tags</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-wizards.html#createQMLWallpaper">createQMLWallpaper</a></b>(const QString &amp;<i>title</i>, const QString &amp;<i>licenseName</i>, const QString &amp;<i>licenseFile</i>, const QString &amp;<i>createdBy</i>, const QString &amp;<i>previewThumbnail</i>, const QVector&lt;QString&gt; &amp;<i>tags</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-wizards.html#createQMLWidget">createQMLWidget</a></b>(const QString &amp;<i>title</i>, const QString &amp;<i>licenseName</i>, const QString &amp;<i>licenseFile</i>, const QString &amp;<i>previewThumbnail</i>, const QString &amp;<i>createdBy</i>, const QVector&lt;QString&gt; &amp;<i>tags</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-wizards.html#createQMLWidget">createQMLWidget</a></b>(const QString &amp;<i>title</i>, const QString &amp;<i>licenseName</i>, const QString &amp;<i>licenseFile</i>, const QString &amp;<i>createdBy</i>, const QString &amp;<i>previewThumbnail</i>, const QVector&lt;QString&gt; &amp;<i>tags</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-wizards.html#createWebsiteWallpaper">createWebsiteWallpaper</a></b>(const QString &amp;<i>title</i>, const QString &amp;<i>previewThumbnail</i>, const QUrl &amp;<i>url</i>, const QVector&lt;QString&gt; &amp;<i>tags</i>)</td></tr>
</table></div>
<a name="details"></a>
@ -60,7 +60,7 @@
<p>Creates a HTML wallpaper.</p>
<!-- @@@createHTMLWallpaper -->
<!-- $$$createHTMLWidget[overload1]$$$createHTMLWidgetconstQString&constQString&constQString&constQString&constQString&constQVector<QString>& -->
<h3 class="fn" id="createHTMLWidget"><a name="createHTMLWidget"></a><code>[slot] </code><span class="type">void</span> Wizards::<span class="name">createHTMLWidget</span>(const <span class="type">QString</span> &amp;<i>title</i>, const <span class="type">QString</span> &amp;<i>licenseName</i>, const <span class="type">QString</span> &amp;<i>licenseFile</i>, const <span class="type">QString</span> &amp;<i>previewThumbnail</i>, const <span class="type">QString</span> &amp;<i>createdBy</i>, const <span class="type">QVector</span>&lt;<span class="type">QString</span>&gt; &amp;<i>tags</i>)</h3>
<h3 class="fn" id="createHTMLWidget"><a name="createHTMLWidget"></a><code>[slot] </code><span class="type">void</span> Wizards::<span class="name">createHTMLWidget</span>(const <span class="type">QString</span> &amp;<i>title</i>, const <span class="type">QString</span> &amp;<i>licenseName</i>, const <span class="type">QString</span> &amp;<i>licenseFile</i>, const <span class="type">QString</span> &amp;<i>createdBy</i>, const <span class="type">QString</span> &amp;<i>previewThumbnail</i>, const <span class="type">QVector</span>&lt;<span class="type">QString</span>&gt; &amp;<i>tags</i>)</h3>
<p>Creates a new widget.</p>
<!-- @@@createHTMLWidget -->
<!-- $$$createQMLWallpaper[overload1]$$$createQMLWallpaperconstQString&constQString&constQString&constQString&constQString&constQVector<QString>& -->
@ -68,7 +68,7 @@
<p>.</p>
<!-- @@@createQMLWallpaper -->
<!-- $$$createQMLWidget[overload1]$$$createQMLWidgetconstQString&constQString&constQString&constQString&constQString&constQVector<QString>& -->
<h3 class="fn" id="createQMLWidget"><a name="createQMLWidget"></a><code>[slot] </code><span class="type">void</span> Wizards::<span class="name">createQMLWidget</span>(const <span class="type">QString</span> &amp;<i>title</i>, const <span class="type">QString</span> &amp;<i>licenseName</i>, const <span class="type">QString</span> &amp;<i>licenseFile</i>, const <span class="type">QString</span> &amp;<i>previewThumbnail</i>, const <span class="type">QString</span> &amp;<i>createdBy</i>, const <span class="type">QVector</span>&lt;<span class="type">QString</span>&gt; &amp;<i>tags</i>)</h3>
<h3 class="fn" id="createQMLWidget"><a name="createQMLWidget"></a><code>[slot] </code><span class="type">void</span> Wizards::<span class="name">createQMLWidget</span>(const <span class="type">QString</span> &amp;<i>title</i>, const <span class="type">QString</span> &amp;<i>licenseName</i>, const <span class="type">QString</span> &amp;<i>licenseFile</i>, const <span class="type">QString</span> &amp;<i>createdBy</i>, const <span class="type">QString</span> &amp;<i>previewThumbnail</i>, const <span class="type">QVector</span>&lt;<span class="type">QString</span>&gt; &amp;<i>tags</i>)</h3>
<p>Creates a new widget.</p>
<!-- @@@createQMLWidget -->
<!-- $$$createWebsiteWallpaper[overload1]$$$createWebsiteWallpaperconstQString&constQString&constQUrl&constQVector<QString>& -->

View File

@ -54,7 +54,7 @@
<div class="classes">
<h2>Classes</h2>
<h3> class <a href="screenplay-app.html">App</a></h3><!-- $$$App-brief -->
<p>The App class contains all members for <a href="screenplay.html">ScreenPlay</a>. <a href="screenplay-app.html#details">More...</a></p>
<p>The App class contains all members for <a href="screenplay-module.html">ScreenPlay</a>. <a href="screenplay-app.html#details">More...</a></p>
<!-- @@@App -->
<h3> class <a href="screenplay-create.html">Create</a></h3><!-- $$$Create-brief -->
<p>Baseclass for creating wallapers, widgets and the corresponding wizards. <a href="screenplay-create.html#details">More...</a></p>

View File

@ -0,0 +1,27 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<!-- screenplaysdk.cpp -->
<title>List of All Members for ScreenPlaySDK | ScreenPlay</title>
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
</head>
<body>
<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 ">
<li>ScreenPlaySDK</li>
<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">List of All Members for ScreenPlaySDK</h1>
<p>This is the complete list of members for <a href="screenplaysdk.html">ScreenPlaySDK</a>, including inherited members.</p>
<ul>
<li class="fn"><span class="name"><b><a href="screenplaysdk.html#appID-prop">appIDChanged</a></b></span>(QString)</li>
<li class="fn"><span class="name"><b><a href="screenplaysdk.html#isConnected-prop">isConnectedChanged</a></b></span>(bool)</li>
<li class="fn"><span class="name"><b><a href="screenplaysdk.html#appID-prop">setAppID</a></b></span>(QString)</li>
<li class="fn"><span class="name"><b><a href="screenplaysdk.html#isConnected-prop">setIsConnected</a></b></span>(bool)</li>
<li class="fn"><span class="name"><b><a href="screenplaysdk.html#type-prop">setType</a></b></span>(QString)</li>
<li class="fn"><span class="name"><b><a href="screenplaysdk.html#type-prop">typeChanged</a></b></span>(QString)</li>
<li class="fn"><span class="name"><b><a href="screenplaysdk.html#appID-prop">appID</a></b></span>() const : QString</li>
<li class="fn"><span class="name"><b><a href="screenplaysdk.html#isConnected-prop">isConnected</a></b></span>() const : bool</li>
<li class="fn"><span class="name"><b><a href="screenplaysdk.html#type-prop">type</a></b></span>() const : QString</li>
</ul>
<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>
</html>

View File

@ -0,0 +1,37 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<!-- screenplaysdk.cpp -->
<title>ScreenPlaySDK | ScreenPlay</title>
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
</head>
<body>
<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 ">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#classes">Classes</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">ScreenPlaySDK</h1>
<span class="subtitle"></span>
<!-- $$$ScreenPlaySDK-brief -->
<p>Namespace for ScreenPlaySDK. <a href="#details">More...</a></p>
<!-- @@@ScreenPlaySDK -->
<a name="classes"></a>
<h2 id="classes">Classes</h2>
<div class="table"><table class="annotated">
<tr class="odd topAlign"><td class="tblName"><p><a href="screenplaysdk.html">ScreenPlaySDK</a></p></td><td class="tblDescr"><p></p></td></tr>
</table></div>
<!-- $$$ScreenPlaySDK-description -->
<a name="details"></a>
<div class="descr">
<h2 id="details">Detailed Description</h2>
</div>
<!-- @@@ScreenPlaySDK -->
<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>
</html>

View File

@ -0,0 +1,60 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<!-- screenplaysdk.cpp -->
<title>ScreenPlaySDK Class | ScreenPlay</title>
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
</head>
<body>
<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 ">
<li>ScreenPlaySDK</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">ScreenPlaySDK Class</h1>
<!-- $$$ScreenPlaySDK-brief -->
<p>. <a href="#details">More...</a></p>
<!-- @@@ScreenPlaySDK -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include &lt;ScreenPlaySDK&gt;</span>
</td></tr></table></div><ul>
<li><a href="screenplaysdk-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">
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="screenplaysdk.html#appID-prop">appID</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="screenplaysdk.html#isConnected-prop">isConnected</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="screenplaysdk.html#type-prop">type</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">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplaysdk.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="screenplaysdk.html#isConnected-prop">setIsConnected</a></b>(bool <i>isConnected</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplaysdk.html#type-prop">setType</a></b>(QString <i>type</i>)</td></tr>
</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="screenplaysdk.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="screenplaysdk.html#isConnected-prop">isConnectedChanged</a></b>(bool <i>isConnected</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplaysdk.html#type-prop">typeChanged</a></b>(QString <i>type</i>)</td></tr>
</table></div>
<a name="details"></a>
<!-- $$$ScreenPlaySDK-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
</div>
<!-- @@@ScreenPlaySDK -->
<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>
</html>

View File

@ -0,0 +1,37 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<!-- shaderlibrary.cpp -->
<title>ScreenPlayShader | ScreenPlay</title>
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
</head>
<body>
<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 ">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#classes">Classes</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">ScreenPlayShader</h1>
<span class="subtitle"></span>
<!-- $$$ScreenPlayShader-brief -->
<p>Module for ScreenPlayShader. <a href="#details">More...</a></p>
<!-- @@@ScreenPlayShader -->
<a name="classes"></a>
<h2 id="classes">Classes</h2>
<div class="table"><table class="annotated">
<tr class="odd topAlign"><td class="tblName"><p><a href="shaderlibrary.html">ShaderLibrary</a></p></td><td class="tblDescr"><p></p></td></tr>
</table></div>
<!-- $$$ScreenPlayShader-description -->
<a name="details"></a>
<div class="descr">
<h2 id="details">Detailed Description</h2>
</div>
<!-- @@@ScreenPlayShader -->
<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>
</html>

View File

@ -0,0 +1,42 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<!-- sysinfo.cpp -->
<title>ScreenPlaySysInfo | ScreenPlay</title>
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
</head>
<body>
<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 ">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#classes">Classes</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">ScreenPlaySysInfo</h1>
<span class="subtitle"></span>
<!-- $$$ScreenPlaySysInfo-brief -->
<p>Module for ScreenPlaySysInfo. <a href="#details">More...</a></p>
<!-- @@@ScreenPlaySysInfo -->
<a name="classes"></a>
<h2 id="classes">Classes</h2>
<div class="table"><table class="annotated">
<tr class="odd topAlign"><td class="tblName"><p><a href="cpu.html">CPU</a></p></td><td class="tblDescr"><p></p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="gpu.html">GPU</a></p></td><td class="tblDescr"><p></p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="ram.html">RAM</a></p></td><td class="tblDescr"><p></p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="storage.html">Storage</a></p></td><td class="tblDescr"><p></p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="sysinfo.html">SysInfo</a></p></td><td class="tblDescr"><p></p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="uptime.html">Uptime</a></p></td><td class="tblDescr"><p></p></td></tr>
</table></div>
<!-- $$$ScreenPlaySysInfo-description -->
<a name="details"></a>
<div class="descr">
<h2 id="details">Detailed Description</h2>
</div>
<!-- @@@ScreenPlaySysInfo -->
<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>
</html>

View File

@ -0,0 +1,37 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<!-- util.cpp -->
<title>ScreenPlayUtil | ScreenPlay</title>
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
</head>
<body>
<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 ">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#namespaces">Namespaces</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">ScreenPlayUtil</h1>
<span class="subtitle"></span>
<!-- $$$ScreenPlayUtil-brief -->
<p>Module for ScreenPlayUtil. <a href="#details">More...</a></p>
<!-- @@@ScreenPlayUtil -->
<a name="namespaces"></a>
<h2 id="namespaces">Namespaces</h2>
<div class="table"><table class="annotated">
<tr class="odd topAlign"><td class="tblName"><p><a href="screenplayutil.html">ScreenPlayUtil</a></p></td><td class="tblDescr"><p>Namespace for ScreenPlayUtil</p></td></tr>
</table></div>
<!-- $$$ScreenPlayUtil-description -->
<a name="details"></a>
<div class="descr">
<h2 id="details">Detailed Description</h2>
</div>
<!-- @@@ScreenPlayUtil -->
<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>
</html>

View File

@ -0,0 +1,142 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<!-- util.cpp -->
<title>ScreenPlayUtil Namespace | ScreenPlay</title>
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
</head>
<body>
<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 ">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#functions">Functions</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">ScreenPlayUtil Namespace</h1>
<!-- $$$ScreenPlayUtil-brief -->
<p>Namespace for ScreenPlayUtil. <a href="#details">More...</a></p>
<!-- @@@ScreenPlayUtil -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include &lt;ScreenPlayUtil&gt;</span>
</td></tr></table></div><ul>
</ul>
<a name="functions"></a>
<h2 id="functions">Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="screenplayutil.html#executableEnding">executableEnding</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QJsonArray </td><td class="memItemRight bottomAlign"><b><a href="screenplayutil.html#fillArray">fillArray</a></b>(const QVector&lt;QString&gt; &amp;<i>items</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="screenplayutil.html#generateRandomString">generateRandomString</a></b>(quint32 <i>length</i> = 32)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QStringList </td><td class="memItemRight bottomAlign"><b><a href="screenplayutil.html#getAvailableFillModes">getAvailableFillModes</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QStringList </td><td class="memItemRight bottomAlign"><b><a href="screenplayutil.html#getAvailableTypes">getAvailableTypes</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QStringList </td><td class="memItemRight bottomAlign"><b><a href="screenplayutil.html#getAvailableWallpaper">getAvailableWallpaper</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QStringList </td><td class="memItemRight bottomAlign"><b><a href="screenplayutil.html#getAvailableWidgets">getAvailableWidgets</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> std::optional&lt;ScreenPlay::InstalledType::InstalledType&gt; </td><td class="memItemRight bottomAlign"><b><a href="screenplayutil.html#getInstalledTypeFromString">getInstalledTypeFromString</a></b>(const QString &amp;<i>type</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> ScreenPlay::SearchType::SearchType </td><td class="memItemRight bottomAlign"><b><a href="screenplayutil.html#getSearchTypeFromInstalledType">getSearchTypeFromInstalledType</a></b>(const ScreenPlay::InstalledType::InstalledType <i>type</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> std::optional&lt;QVersionNumber&gt; </td><td class="memItemRight bottomAlign"><b><a href="screenplayutil.html#getVersionNumberFromString">getVersionNumberFromString</a></b>(const QString &amp;<i>str</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="screenplayutil.html#isWallpaper">isWallpaper</a></b>(const ScreenPlay::InstalledType::InstalledType <i>type</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="screenplayutil.html#isWidget">isWidget</a></b>(const ScreenPlay::InstalledType::InstalledType <i>type</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> std::optional&lt;QJsonObject&gt; </td><td class="memItemRight bottomAlign"><b><a href="screenplayutil.html#openJsonFileToObject">openJsonFileToObject</a></b>(const QString &amp;<i>path</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> std::optional&lt;QString&gt; </td><td class="memItemRight bottomAlign"><b><a href="screenplayutil.html#openJsonFileToString">openJsonFileToString</a></b>(const QString &amp;<i>path</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> std::optional&lt;QJsonObject&gt; </td><td class="memItemRight bottomAlign"><b><a href="screenplayutil.html#parseQByteArrayToQJsonObject">parseQByteArrayToQJsonObject</a></b>(const QByteArray &amp;<i>byteArray</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> std::optional&lt;QVector&lt;int&gt;&gt; </td><td class="memItemRight bottomAlign"><b><a href="screenplayutil.html#parseStringToIntegerList">parseStringToIntegerList</a></b>(const QString <i>string</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="screenplayutil.html#toLocal">toLocal</a></b>(const QString &amp;<i>url</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="screenplayutil.html#toString">toString</a></b>(const QStringList &amp;<i>list</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="screenplayutil.html#writeJsonObjectToFile">writeJsonObjectToFile</a></b>(const QString &amp;<i>absoluteFilePath</i>, const QJsonObject &amp;<i>object</i>, bool <i>truncate</i> = true)</td></tr>
</table></div>
<a name="details"></a>
<!-- $$$ScreenPlayUtil-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
</div>
<!-- @@@ScreenPlayUtil -->
<div class="func">
<h2>Function Documentation</h2>
<!-- $$$executableEnding[overload1]$$$executableEnding -->
<h3 class="fn" id="executableEnding"><a name="executableEnding"></a><span class="type">QString</span> ScreenPlayUtil::<span class="name">executableEnding</span>()</h3>
<p>Return .exe in windows otherwise empty string.</p>
<!-- @@@executableEnding -->
<!-- $$$fillArray[overload1]$$$fillArrayconstQVector<QString>& -->
<h3 class="fn" id="fillArray"><a name="fillArray"></a><span class="type">QJsonArray</span> ScreenPlayUtil::<span class="name">fillArray</span>(const <span class="type">QVector</span>&lt;<span class="type">QString</span>&gt; &amp;<i>items</i>)</h3>
<p>Util function that converts a QVector of Strings into a QJsonArray.</p>
<!-- @@@fillArray -->
<!-- $$$generateRandomString[overload1]$$$generateRandomStringquint32 -->
<h3 class="fn" id="generateRandomString"><a name="generateRandomString"></a><span class="type">QString</span> ScreenPlayUtil::<span class="name">generateRandomString</span>(<span class="type">quint32</span> <i>length</i> = 32)</h3>
<p>Generates a (non secure) random string with the default length of 32. Can contain:</p>
<ul>
<li>A-Z</li>
<li>a-z</li>
<li>0-9</li>
</ul>
<!-- @@@generateRandomString -->
<!-- $$$getAvailableFillModes[overload1]$$$getAvailableFillModes -->
<h3 class="fn" id="getAvailableFillModes"><a name="getAvailableFillModes"></a><span class="type">QStringList</span> ScreenPlayUtil::<span class="name">getAvailableFillModes</span>()</h3>
<p>See https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit</p>
<!-- @@@getAvailableFillModes -->
<!-- $$$getAvailableTypes[overload1]$$$getAvailableTypes -->
<h3 class="fn" id="getAvailableTypes"><a name="getAvailableTypes"></a><span class="type">QStringList</span> ScreenPlayUtil::<span class="name">getAvailableTypes</span>()</h3>
<p>.</p>
<!-- @@@getAvailableTypes -->
<!-- $$$getAvailableWallpaper[overload1]$$$getAvailableWallpaper -->
<h3 class="fn" id="getAvailableWallpaper"><a name="getAvailableWallpaper"></a><span class="type">QStringList</span> ScreenPlayUtil::<span class="name">getAvailableWallpaper</span>()</h3>
<p>.</p>
<!-- @@@getAvailableWallpaper -->
<!-- $$$getAvailableWidgets[overload1]$$$getAvailableWidgets -->
<h3 class="fn" id="getAvailableWidgets"><a name="getAvailableWidgets"></a><span class="type">QStringList</span> ScreenPlayUtil::<span class="name">getAvailableWidgets</span>()</h3>
<p>.</p>
<!-- @@@getAvailableWidgets -->
<!-- $$$getInstalledTypeFromString[overload1]$$$getInstalledTypeFromStringconstQString& -->
<h3 class="fn" id="getInstalledTypeFromString"><a name="getInstalledTypeFromString"></a><span class="type">std::optional</span>&lt;<span class="type">ScreenPlay::InstalledType::InstalledType</span>&gt; ScreenPlayUtil::<span class="name">getInstalledTypeFromString</span>(const <span class="type">QString</span> &amp;<i>type</i>)</h3>
<p>Maps the installed type from a QString to an enum. Used for parsing the project.json.</p>
<!-- @@@getInstalledTypeFromString -->
<!-- $$$getSearchTypeFromInstalledType[overload1]$$$getSearchTypeFromInstalledTypeconstScreenPlay::InstalledType::InstalledType -->
<h3 class="fn" id="getSearchTypeFromInstalledType"><a name="getSearchTypeFromInstalledType"></a><span class="type">ScreenPlay::SearchType::SearchType</span> ScreenPlayUtil::<span class="name">getSearchTypeFromInstalledType</span>(const <span class="type">ScreenPlay::InstalledType::InstalledType</span> <i>type</i>)</h3>
<p>Maps the Search type to an installed type. Used for filtering the installed content.</p>
<!-- @@@getSearchTypeFromInstalledType -->
<!-- $$$getVersionNumberFromString[overload1]$$$getVersionNumberFromStringconstQString& -->
<h3 class="fn" id="getVersionNumberFromString"><a name="getVersionNumberFromString"></a><span class="type">std::optional</span>&lt;<span class="type">QVersionNumber</span>&gt; ScreenPlayUtil::<span class="name">getVersionNumberFromString</span>(const <span class="type">QString</span> &amp;<i>str</i>)</h3>
<p>Parses a version from a given QString. The QString must be looke like this: 1.0&#x2e;0 - Major.Minor.Patch. A fixed position is used for parsing (at 0,2,4). Return std::nullopt when not successful.</p>
<!-- @@@getVersionNumberFromString -->
<!-- $$$isWallpaper[overload1]$$$isWallpaperconstScreenPlay::InstalledType::InstalledType -->
<h3 class="fn" id="isWallpaper"><a name="isWallpaper"></a><span class="type">bool</span> ScreenPlayUtil::<span class="name">isWallpaper</span>(const <span class="type">ScreenPlay::InstalledType::InstalledType</span> <i>type</i>)</h3>
<p>.</p>
<!-- @@@isWallpaper -->
<!-- $$$isWidget[overload1]$$$isWidgetconstScreenPlay::InstalledType::InstalledType -->
<h3 class="fn" id="isWidget"><a name="isWidget"></a><span class="type">bool</span> ScreenPlayUtil::<span class="name">isWidget</span>(const <span class="type">ScreenPlay::InstalledType::InstalledType</span> <i>type</i>)</h3>
<p>.</p>
<!-- @@@isWidget -->
<!-- $$$openJsonFileToObject[overload1]$$$openJsonFileToObjectconstQString& -->
<h3 class="fn" id="openJsonFileToObject"><a name="openJsonFileToObject"></a><span class="type">std::optional</span>&lt;<span class="type">QJsonObject</span>&gt; ScreenPlayUtil::<span class="name">openJsonFileToObject</span>(const <span class="type">QString</span> &amp;<i>path</i>)</h3>
<p>Opens a json file (absolute path) and tries to convert it to a QJsonObject. Returns std::nullopt when not successful.</p>
<!-- @@@openJsonFileToObject -->
<!-- $$$openJsonFileToString[overload1]$$$openJsonFileToStringconstQString& -->
<h3 class="fn" id="openJsonFileToString"><a name="openJsonFileToString"></a><span class="type">std::optional</span>&lt;<span class="type">QString</span>&gt; ScreenPlayUtil::<span class="name">openJsonFileToString</span>(const <span class="type">QString</span> &amp;<i>path</i>)</h3>
<p>Opens a json file (absolute path) and tries to convert it to a QString. Returns std::nullopt when not successful.</p>
<!-- @@@openJsonFileToString -->
<!-- $$$parseQByteArrayToQJsonObject[overload1]$$$parseQByteArrayToQJsonObjectconstQByteArray& -->
<h3 class="fn" id="parseQByteArrayToQJsonObject"><a name="parseQByteArrayToQJsonObject"></a><span class="type">std::optional</span>&lt;<span class="type">QJsonObject</span>&gt; ScreenPlayUtil::<span class="name">parseQByteArrayToQJsonObject</span>(const <span class="type">QByteArray</span> &amp;<i>byteArray</i>)</h3>
<p>Parses a QByteArray to a QJsonObject. If returns and std::nullopt on failure.</p>
<!-- @@@parseQByteArrayToQJsonObject -->
<!-- $$$parseStringToIntegerList[overload1]$$$parseStringToIntegerListconstQString -->
<h3 class="fn" id="parseStringToIntegerList"><a name="parseStringToIntegerList"></a><span class="type">std::optional</span>&lt;<span class="type">QVector</span>&lt;<span class="type">int</span>&gt;&gt; ScreenPlayUtil::<span class="name">parseStringToIntegerList</span>(const <span class="type">QString</span> <i>string</i>)</h3>
<p>parseIntList parses a list of string separated with a comma &quot;1,2,3&quot;. IMPORTANT: No trailing comma!</p>
<!-- @@@parseStringToIntegerList -->
<!-- $$$toLocal[overload1]$$$toLocalconstQString& -->
<h3 class="fn" id="toLocal"><a name="toLocal"></a><span class="type">QString</span> ScreenPlayUtil::<span class="name">toLocal</span>(const <span class="type">QString</span> &amp;<i>url</i>)</h3>
<p>Converts the given <i>url</i> string to a local file path.</p>
<!-- @@@toLocal -->
<!-- $$$toString[overload1]$$$toStringconstQStringList& -->
<h3 class="fn" id="toString"><a name="toString"></a><span class="type">QString</span> ScreenPlayUtil::<span class="name">toString</span>(const <span class="type">QStringList</span> &amp;<i>list</i>)</h3>
<p>Helper function to append a QStringList into a QString with a space between the items.</p>
<!-- @@@toString -->
<!-- $$$writeJsonObjectToFile[overload1]$$$writeJsonObjectToFileconstQString&constQJsonObject&bool -->
<h3 class="fn" id="writeJsonObjectToFile"><a name="writeJsonObjectToFile"></a><span class="type">bool</span> ScreenPlayUtil::<span class="name">writeJsonObjectToFile</span>(const <span class="type">QString</span> &amp;<i>absoluteFilePath</i>, const <span class="type">QJsonObject</span> &amp;<i>object</i>, <span class="type">bool</span> <i>truncate</i> = true)</h3>
<p>.</p>
<!-- @@@writeJsonObjectToFile -->
</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/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>
</html>

View File

@ -0,0 +1,39 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<!-- basewindow.cpp -->
<title>ScreenPlayWallpaper | ScreenPlay</title>
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
</head>
<body>
<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 ">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#classes">Classes</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</h1>
<span class="subtitle"></span>
<!-- $$$ScreenPlayWallpaper-brief -->
<p>Module for ScreenPlayWallpaper. <a href="#details">More...</a></p>
<!-- @@@ScreenPlayWallpaper -->
<a name="classes"></a>
<h2 id="classes">Classes</h2>
<div class="table"><table class="annotated">
<tr class="odd topAlign"><td class="tblName"><p><a href="basewindow.html">BaseWindow</a></p></td><td class="tblDescr"><p></p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="winwindow.html">WinWindow</a></p></td><td class="tblDescr"><p></p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="windowsdesktopproperties.html">WindowsDesktopProperties</a></p></td><td class="tblDescr"><p></p></td></tr>
</table></div>
<!-- $$$ScreenPlayWallpaper-description -->
<a name="details"></a>
<div class="descr">
<h2 id="details">Detailed Description</h2>
</div>
<!-- @@@ScreenPlayWallpaper -->
<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>
</html>

View File

@ -0,0 +1,37 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<!-- widgetwindow.cpp -->
<title>ScreenPlayWidget | ScreenPlay</title>
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
</head>
<body>
<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 ">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#classes">Classes</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">ScreenPlayWidget</h1>
<span class="subtitle"></span>
<!-- $$$ScreenPlayWidget-brief -->
<p>Module for ScreenPlayWidget. <a href="#details">More...</a></p>
<!-- @@@ScreenPlayWidget -->
<a name="classes"></a>
<h2 id="classes">Classes</h2>
<div class="table"><table class="annotated">
<tr class="odd topAlign"><td class="tblName"><p><a href="widgetwindow.html">WidgetWindow</a></p></td><td class="tblDescr"><p></p></td></tr>
</table></div>
<!-- $$$ScreenPlayWidget-description -->
<a name="details"></a>
<div class="descr">
<h2 id="details">Detailed Description</h2>
</div>
<!-- @@@ScreenPlayWidget -->
<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>
</html>

View File

@ -0,0 +1,24 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<!-- shaderlibrary.cpp -->
<title>List of All Members for ShaderLibrary | ScreenPlay</title>
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
</head>
<body>
<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 ">
<li>ShaderLibrary</li>
<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">List of All Members for ShaderLibrary</h1>
<p>This is the complete list of members for <a href="shaderlibrary.html">ShaderLibrary</a>, including inherited members.</p>
<ul>
<li class="fn"><span class="name"><b><a href="shaderlibrary.html#lightning-prop">lightningChanged</a></b></span>(Shader *)</li>
<li class="fn"><span class="name"><b><a href="shaderlibrary.html#lightning-prop">setLightning</a></b></span>(Shader *)</li>
<li class="fn"><span class="name"><b><a href="shaderlibrary.html#water-prop">setWater</a></b></span>(Shader *)</li>
<li class="fn"><span class="name"><b><a href="shaderlibrary.html#water-prop">waterChanged</a></b></span>(Shader *)</li>
<li class="fn"><span class="name"><b><a href="shaderlibrary.html#lightning-prop">lightning</a></b></span>() const : Shader *</li>
<li class="fn"><span class="name"><b><a href="shaderlibrary.html#water-prop">water</a></b></span>() const : Shader *</li>
</ul>
<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>
</html>

View File

@ -0,0 +1,57 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<!-- shaderlibrary.cpp -->
<title>ShaderLibrary Class | ScreenPlay</title>
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
</head>
<body>
<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 ">
<li>ShaderLibrary</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">ShaderLibrary Class</h1>
<!-- $$$ShaderLibrary-brief -->
<p>. <a href="#details">More...</a></p>
<!-- @@@ShaderLibrary -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include &lt;ShaderLibrary&gt;</span>
</td></tr></table></div><ul>
<li><a href="shaderlibrary-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">
<tr><td class="memItemLeft rightAlign topAlign"> Shader *</td><td class="memItemRight bottomAlign"><b><a href="shaderlibrary.html#lightning-prop">lightning</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Shader *</td><td class="memItemRight bottomAlign"><b><a href="shaderlibrary.html#water-prop">water</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">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="shaderlibrary.html#lightning-prop">setLightning</a></b>(Shader *<i>lightning</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="shaderlibrary.html#water-prop">setWater</a></b>(Shader *<i>water</i>)</td></tr>
</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="shaderlibrary.html#lightning-prop">lightningChanged</a></b>(Shader *<i>lightning</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="shaderlibrary.html#water-prop">waterChanged</a></b>(Shader *<i>water</i>)</td></tr>
</table></div>
<a name="details"></a>
<!-- $$$ShaderLibrary-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
</div>
<!-- @@@ShaderLibrary -->
<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>
</html>

35
Docs/html/storage.html Normal file
View File

@ -0,0 +1,35 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<!-- storage.cpp -->
<title>Storage Class | ScreenPlay</title>
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
</head>
<body>
<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 ">
<li>Storage</li>
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">Storage Class</h1>
<!-- $$$Storage-brief -->
<p>. <a href="#details">More...</a></p>
<!-- @@@Storage -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include &lt;Storage&gt;</span>
</td></tr></table></div><ul>
</ul>
<a name="details"></a>
<!-- $$$Storage-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
</div>
<!-- @@@Storage -->
<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>
</html>

View File

@ -0,0 +1,28 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<!-- sysinfo.cpp -->
<title>List of All Members for SysInfo | ScreenPlay</title>
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
</head>
<body>
<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 ">
<li>SysInfo</li>
<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">List of All Members for SysInfo</h1>
<p>This is the complete list of members for <a href="sysinfo.html">SysInfo</a>, including inherited members.</p>
<ul>
<li class="fn"><span class="name"><b><a href="sysinfo.html#cpu-prop">cpuChanged</a></b></span>(CPU *)</li>
<li class="fn"><span class="name"><b><a href="sysinfo.html#gpu-prop">gpuChanged</a></b></span>(GPU *)</li>
<li class="fn"><span class="name"><b><a href="sysinfo.html#ram-prop">ramChanged</a></b></span>(RAM *)</li>
<li class="fn"><span class="name"><b><a href="sysinfo.html#storage-prop">storageChanged</a></b></span>(Storage *)</li>
<li class="fn"><span class="name"><b><a href="sysinfo.html#uptime-prop">uptimeChanged</a></b></span>(Uptime *)</li>
<li class="fn"><span class="name"><b><a href="sysinfo.html#cpu-prop">cpu</a></b></span>() const : CPU *</li>
<li class="fn"><span class="name"><b><a href="sysinfo.html#gpu-prop">gpu</a></b></span>() const : GPU *</li>
<li class="fn"><span class="name"><b><a href="sysinfo.html#ram-prop">ram</a></b></span>() const : RAM *</li>
<li class="fn"><span class="name"><b><a href="sysinfo.html#storage-prop">storage</a></b></span>() const : Storage *</li>
<li class="fn"><span class="name"><b><a href="sysinfo.html#uptime-prop">uptime</a></b></span>() const : Uptime *</li>
</ul>
<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>
</html>

56
Docs/html/sysinfo.html Normal file
View File

@ -0,0 +1,56 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<!-- sysinfo.cpp -->
<title>SysInfo Class | ScreenPlay</title>
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
</head>
<body>
<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 ">
<li>SysInfo</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="#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">SysInfo Class</h1>
<!-- $$$SysInfo-brief -->
<p>. <a href="#details">More...</a></p>
<!-- @@@SysInfo -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include &lt;SysInfo&gt;</span>
</td></tr></table></div><ul>
<li><a href="sysinfo-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">
<tr><td class="memItemLeft rightAlign topAlign"> CPU *</td><td class="memItemRight bottomAlign"><b><a href="sysinfo.html#cpu-prop">cpu</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> GPU *</td><td class="memItemRight bottomAlign"><b><a href="sysinfo.html#gpu-prop">gpu</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> RAM *</td><td class="memItemRight bottomAlign"><b><a href="sysinfo.html#ram-prop">ram</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Storage *</td><td class="memItemRight bottomAlign"><b><a href="sysinfo.html#storage-prop">storage</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Uptime *</td><td class="memItemRight bottomAlign"><b><a href="sysinfo.html#uptime-prop">uptime</a></b>() const</td></tr>
</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="sysinfo.html#cpu-prop">cpuChanged</a></b>(CPU *<i>cpu</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="sysinfo.html#gpu-prop">gpuChanged</a></b>(GPU *)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="sysinfo.html#ram-prop">ramChanged</a></b>(RAM *<i>ram</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="sysinfo.html#storage-prop">storageChanged</a></b>(Storage *<i>storage</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="sysinfo.html#uptime-prop">uptimeChanged</a></b>(Uptime *<i>uptime</i>)</td></tr>
</table></div>
<a name="details"></a>
<!-- $$$SysInfo-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
</div>
<!-- @@@SysInfo -->
<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>
</html>

View File

@ -0,0 +1,33 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<!-- uptime.cpp -->
<title>List of All Members for Uptime | ScreenPlay</title>
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
</head>
<body>
<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 ">
<li>Uptime</li>
<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">List of All Members for Uptime</h1>
<p>This is the complete list of members for <a href="uptime.html">Uptime</a>, including inherited members.</p>
<ul>
<li class="fn"><span class="name"><b><a href="uptime.html#days-prop">daysChanged</a></b></span>(int)</li>
<li class="fn"><span class="name"><b><a href="uptime.html#hours-prop">hoursChanged</a></b></span>(int)</li>
<li class="fn"><span class="name"><b><a href="uptime.html#minutes-prop">minutesChanged</a></b></span>(int)</li>
<li class="fn"><span class="name"><b><a href="uptime.html#seconds-prop">secondsChanged</a></b></span>(int)</li>
<li class="fn"><span class="name"><b><a href="uptime.html#days-prop">setDays</a></b></span>(int)</li>
<li class="fn"><span class="name"><b><a href="uptime.html#hours-prop">setHours</a></b></span>(int)</li>
<li class="fn"><span class="name"><b><a href="uptime.html#minutes-prop">setMinutes</a></b></span>(int)</li>
<li class="fn"><span class="name"><b><a href="uptime.html#seconds-prop">setSeconds</a></b></span>(int)</li>
<li class="fn"><span class="name"><b><a href="uptime.html#years-prop">setYears</a></b></span>(int)</li>
<li class="fn"><span class="name"><b><a href="uptime.html#years-prop">yearsChanged</a></b></span>(int)</li>
<li class="fn"><span class="name"><b><a href="uptime.html#days-prop">days</a></b></span>() const : int</li>
<li class="fn"><span class="name"><b><a href="uptime.html#hours-prop">hours</a></b></span>() const : int</li>
<li class="fn"><span class="name"><b><a href="uptime.html#minutes-prop">minutes</a></b></span>() const : int</li>
<li class="fn"><span class="name"><b><a href="uptime.html#seconds-prop">seconds</a></b></span>() const : int</li>
<li class="fn"><span class="name"><b><a href="uptime.html#years-prop">years</a></b></span>() const : int</li>
</ul>
<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>
</html>

66
Docs/html/uptime.html Normal file
View File

@ -0,0 +1,66 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<!-- uptime.cpp -->
<title>Uptime Class | ScreenPlay</title>
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
</head>
<body>
<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 ">
<li>Uptime</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">Uptime Class</h1>
<!-- $$$Uptime-brief -->
<p>. <a href="#details">More...</a></p>
<!-- @@@Uptime -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include &lt;Uptime&gt;</span>
</td></tr></table></div><ul>
<li><a href="uptime-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">
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="uptime.html#days-prop">days</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="uptime.html#hours-prop">hours</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="uptime.html#minutes-prop">minutes</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="uptime.html#seconds-prop">seconds</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="uptime.html#years-prop">years</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">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="uptime.html#days-prop">setDays</a></b>(int <i>days</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="uptime.html#hours-prop">setHours</a></b>(int <i>hours</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="uptime.html#minutes-prop">setMinutes</a></b>(int <i>minutes</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="uptime.html#seconds-prop">setSeconds</a></b>(int <i>seconds</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="uptime.html#years-prop">setYears</a></b>(int <i>years</i>)</td></tr>
</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="uptime.html#days-prop">daysChanged</a></b>(int <i>days</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="uptime.html#hours-prop">hoursChanged</a></b>(int <i>hours</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="uptime.html#minutes-prop">minutesChanged</a></b>(int <i>minutes</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="uptime.html#seconds-prop">secondsChanged</a></b>(int <i>seconds</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="uptime.html#years-prop">yearsChanged</a></b>(int <i>years</i>)</td></tr>
</table></div>
<a name="details"></a>
<!-- $$$Uptime-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
</div>
<!-- @@@Uptime -->
<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>
</html>

View File

@ -0,0 +1,33 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<!-- widgetwindow.cpp -->
<title>List of All Members for WidgetWindow | ScreenPlay</title>
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
</head>
<body>
<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 ">
<li>WidgetWindow</li>
<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">List of All Members for WidgetWindow</h1>
<p>This is the complete list of members for <a href="widgetwindow.html">WidgetWindow</a>, including inherited members.</p>
<ul>
<li class="fn"><span class="name"><b><a href="widgetwindow.html#appID-prop">appIDChanged</a></b></span>(QString)</li>
<li class="fn"><span class="name"><b><a href="widgetwindow.html#position-prop">positionChanged</a></b></span>(QPoint)</li>
<li class="fn"><span class="name"><b><a href="widgetwindow.html#projectConfig-prop">projectConfigChanged</a></b></span>(QString)</li>
<li class="fn"><span class="name"><b><a href="widgetwindow.html#appID-prop">setAppID</a></b></span>(QString)</li>
<li class="fn"><span class="name"><b><a href="widgetwindow.html#position-prop">setPosition</a></b></span>(QPoint)</li>
<li class="fn"><span class="name"><b><a href="widgetwindow.html#projectConfig-prop">setProjectConfig</a></b></span>(QString)</li>
<li class="fn"><span class="name"><b><a href="widgetwindow.html#sourcePath-prop">setSourcePath</a></b></span>(QString)</li>
<li class="fn"><span class="name"><b><a href="widgetwindow.html#type-prop">setType</a></b></span>(QString)</li>
<li class="fn"><span class="name"><b><a href="widgetwindow.html#sourcePath-prop">sourcePathChanged</a></b></span>(QString)</li>
<li class="fn"><span class="name"><b><a href="widgetwindow.html#type-prop">typeChanged</a></b></span>(QString)</li>
<li class="fn"><span class="name"><b><a href="widgetwindow.html#appID-prop">appID</a></b></span>() const : QString</li>
<li class="fn"><span class="name"><b><a href="widgetwindow.html#position-prop">position</a></b></span>() const : QPoint</li>
<li class="fn"><span class="name"><b><a href="widgetwindow.html#projectConfig-prop">projectConfig</a></b></span>() const : QString</li>
<li class="fn"><span class="name"><b><a href="widgetwindow.html#sourcePath-prop">sourcePath</a></b></span>() const : QString</li>
<li class="fn"><span class="name"><b><a href="widgetwindow.html#type-prop">type</a></b></span>() const : QString</li>
</ul>
<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>
</html>

View File

@ -0,0 +1,66 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<!-- widgetwindow.cpp -->
<title>WidgetWindow Class | ScreenPlay</title>
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
</head>
<body>
<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 ">
<li>WidgetWindow</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">WidgetWindow Class</h1>
<!-- $$$WidgetWindow-brief -->
<p>. <a href="#details">More...</a></p>
<!-- @@@WidgetWindow -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include &lt;WidgetWindow&gt;</span>
</td></tr></table></div><ul>
<li><a href="widgetwindow-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">
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="widgetwindow.html#appID-prop">appID</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QPoint </td><td class="memItemRight bottomAlign"><b><a href="widgetwindow.html#position-prop">position</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="widgetwindow.html#projectConfig-prop">projectConfig</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="widgetwindow.html#sourcePath-prop">sourcePath</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="widgetwindow.html#type-prop">type</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">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="widgetwindow.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="widgetwindow.html#position-prop">setPosition</a></b>(QPoint <i>position</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="widgetwindow.html#projectConfig-prop">setProjectConfig</a></b>(QString <i>projectConfig</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="widgetwindow.html#sourcePath-prop">setSourcePath</a></b>(QString <i>sourcePath</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="widgetwindow.html#type-prop">setType</a></b>(QString <i>type</i>)</td></tr>
</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="widgetwindow.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="widgetwindow.html#position-prop">positionChanged</a></b>(QPoint <i>position</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="widgetwindow.html#projectConfig-prop">projectConfigChanged</a></b>(QString <i>projectConfig</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="widgetwindow.html#sourcePath-prop">sourcePathChanged</a></b>(QString <i>sourcePath</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="widgetwindow.html#type-prop">typeChanged</a></b>(QString <i>type</i>)</td></tr>
</table></div>
<a name="details"></a>
<!-- $$$WidgetWindow-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
</div>
<!-- @@@WidgetWindow -->
<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>
</html>

View File

@ -0,0 +1,40 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<!-- windowsdesktopproperties.cpp -->
<title>List of All Members for WindowsDesktopProperties | ScreenPlay</title>
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
</head>
<body>
<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 ">
<li>WindowsDesktopProperties</li>
<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">List of All Members for WindowsDesktopProperties</h1>
<p>This is the complete list of members for <a href="windowsdesktopproperties.html">WindowsDesktopProperties</a>, including inherited members.</p>
<div class="table"><table class="propsummary">
<tr><td class="topAlign"><ul>
<li class="fn"><span class="name"><b><a href="windowsdesktopproperties.html#color-prop">colorChanged</a></b></span>(QColor)</li>
<li class="fn"><span class="name"><b><a href="windowsdesktopproperties.html#isTiled-prop">isTiledChanged</a></b></span>(bool)</li>
<li class="fn"><span class="name"><b><a href="windowsdesktopproperties.html#position-prop">positionChanged</a></b></span>(QPoint)</li>
<li class="fn"><span class="name"><b><a href="windowsdesktopproperties.html#color-prop">setColor</a></b></span>(QColor)</li>
<li class="fn"><span class="name"><b><a href="windowsdesktopproperties.html#isTiled-prop">setIsTiled</a></b></span>(bool)</li>
<li class="fn"><span class="name"><b><a href="windowsdesktopproperties.html#position-prop">setPosition</a></b></span>(QPoint)</li>
<li class="fn"><span class="name"><b><a href="windowsdesktopproperties.html#wallpaperPath-prop">setWallpaperPath</a></b></span>(QString)</li>
<li class="fn"><span class="name"><b><a href="windowsdesktopproperties.html#wallpaperStyle-prop">setWallpaperStyle</a></b></span>(int)</li>
<li class="fn"><span class="name"><b><a href="windowsdesktopproperties.html#windowsVersion-prop">setWindowsVersion</a></b></span>(int)</li>
</ul></td><td class="topAlign"><ul>
<li class="fn"><span class="name"><b><a href="windowsdesktopproperties.html#wallpaperPath-prop">wallpaperPathChanged</a></b></span>(QString)</li>
<li class="fn"><span class="name"><b><a href="windowsdesktopproperties.html#wallpaperStyle-prop">wallpaperStyleChanged</a></b></span>(int)</li>
<li class="fn"><span class="name"><b><a href="windowsdesktopproperties.html#windowsVersion-prop">windowsVersionChanged</a></b></span>(int)</li>
<li class="fn"><span class="name"><b><a href="windowsdesktopproperties.html#color-prop">color</a></b></span>() const : QColor</li>
<li class="fn"><span class="name"><b><a href="windowsdesktopproperties.html#isTiled-prop">isTiled</a></b></span>() const : bool</li>
<li class="fn"><span class="name"><b><a href="windowsdesktopproperties.html#position-prop">position</a></b></span>() const : QPoint</li>
<li class="fn"><span class="name"><b><a href="windowsdesktopproperties.html#wallpaperPath-prop">wallpaperPath</a></b></span>() const : QString</li>
<li class="fn"><span class="name"><b><a href="windowsdesktopproperties.html#wallpaperStyle-prop">wallpaperStyle</a></b></span>() const : int</li>
<li class="fn"><span class="name"><b><a href="windowsdesktopproperties.html#windowsVersion-prop">windowsVersion</a></b></span>() const : int</li>
</ul>
</td></tr>
</table></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/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>
</html>

View File

@ -0,0 +1,69 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<!-- windowsdesktopproperties.cpp -->
<title>WindowsDesktopProperties Class | ScreenPlay</title>
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
</head>
<body>
<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 ">
<li>WindowsDesktopProperties</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">WindowsDesktopProperties Class</h1>
<!-- $$$WindowsDesktopProperties-brief -->
<p>. <a href="#details">More...</a></p>
<!-- @@@WindowsDesktopProperties -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include &lt;WindowsDesktopProperties&gt;</span>
</td></tr></table></div><ul>
<li><a href="windowsdesktopproperties-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">
<tr><td class="memItemLeft rightAlign topAlign"> QColor </td><td class="memItemRight bottomAlign"><b><a href="windowsdesktopproperties.html#color-prop">color</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="windowsdesktopproperties.html#isTiled-prop">isTiled</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QPoint </td><td class="memItemRight bottomAlign"><b><a href="windowsdesktopproperties.html#position-prop">position</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="windowsdesktopproperties.html#wallpaperPath-prop">wallpaperPath</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="windowsdesktopproperties.html#wallpaperStyle-prop">wallpaperStyle</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="windowsdesktopproperties.html#windowsVersion-prop">windowsVersion</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">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="windowsdesktopproperties.html#color-prop">setColor</a></b>(QColor <i>color</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="windowsdesktopproperties.html#isTiled-prop">setIsTiled</a></b>(bool <i>isTiled</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="windowsdesktopproperties.html#position-prop">setPosition</a></b>(QPoint <i>position</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="windowsdesktopproperties.html#wallpaperPath-prop">setWallpaperPath</a></b>(QString <i>wallpaperPath</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="windowsdesktopproperties.html#wallpaperStyle-prop">setWallpaperStyle</a></b>(int <i>wallpaperStyle</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="windowsdesktopproperties.html#windowsVersion-prop">setWindowsVersion</a></b>(int <i>windowsVersion</i>)</td></tr>
</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="windowsdesktopproperties.html#color-prop">colorChanged</a></b>(QColor <i>color</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="windowsdesktopproperties.html#isTiled-prop">isTiledChanged</a></b>(bool <i>isTiled</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="windowsdesktopproperties.html#position-prop">positionChanged</a></b>(QPoint <i>position</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="windowsdesktopproperties.html#wallpaperPath-prop">wallpaperPathChanged</a></b>(QString <i>wallpaperPath</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="windowsdesktopproperties.html#wallpaperStyle-prop">wallpaperStyleChanged</a></b>(int <i>wallpaperStyle</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="windowsdesktopproperties.html#windowsVersion-prop">windowsVersionChanged</a></b>(int <i>windowsVersion</i>)</td></tr>
</table></div>
<a name="details"></a>
<!-- $$$WindowsDesktopProperties-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
</div>
<!-- @@@WindowsDesktopProperties -->
<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>
</html>

View File

@ -0,0 +1,92 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<!-- winwindow.cpp -->
<title>List of All Members for WinWindow | ScreenPlay</title>
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
</head>
<body>
<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 ">
<li>WinWindow</li>
<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">List of All Members for WinWindow</h1>
<p>This is the complete list of members for <a href="winwindow.html">WinWindow</a>, including inherited members.</p>
<div class="table"><table class="propsummary">
<tr><td class="topAlign"><ul>
<li class="fn"><span class="name"><b><a href="basewindow.html#OSVersion-prop">OSVersionChanged</a></b></span>(QString)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#activeScreensList-prop">activeScreensListChanged</a></b></span>(QVector&lt;int&gt;)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#appID-prop">appIDChanged</a></b></span>(QString)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#basePath-prop">basePathChanged</a></b></span>(QString)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#canFade-prop">canFadeChanged</a></b></span>(bool)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#checkWallpaperVisible-prop">checkWallpaperVisibleChanged</a></b></span>(bool)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#contentBasePath-prop">contentBasePathChanged</a></b></span>(const QString &amp;)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#currentTime-prop">currentTimeChanged</a></b></span>(float)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#debugMode-prop">debugModeChanged</a></b></span>(bool)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#fillMode-prop">fillModeChanged</a></b></span>(QString)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#fullContentPath-prop">fullContentPathChanged</a></b></span>(QString)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#getApplicationPath">getApplicationPath</a></b></span>() : QString</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#height-prop">heightChanged</a></b></span>(int)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#isPlaying-prop">isPlayingChanged</a></b></span>(bool)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#loadFromFile">loadFromFile</a></b></span>(const QString &amp;) : QString</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#loops-prop">loopsChanged</a></b></span>(bool)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#messageReceived">messageReceived</a></b></span>(QString, QString)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#muted-prop">mutedChanged</a></b></span>(bool)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#playbackRate-prop">playbackRateChanged</a></b></span>(float)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#replaceWallpaper">replaceWallpaper</a></b></span>(const QString, const QString, const float, const QString, const QString, const bool)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#sdk-prop">sdkChanged</a></b></span>(int *)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#activeScreensList-prop">setActiveScreensList</a></b></span>(QVector&lt;int&gt;)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#appID-prop">setAppID</a></b></span>(QString)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#basePath-prop">setBasePath</a></b></span>(QString)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#canFade-prop">setCanFade</a></b></span>(bool)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#checkWallpaperVisible-prop">setCheckWallpaperVisible</a></b></span>(bool)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#contentBasePath-prop">setContentBasePath</a></b></span>(const QString &amp;)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#currentTime-prop">setCurrentTime</a></b></span>(float)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#debugMode-prop">setDebugMode</a></b></span>(bool)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#fillMode-prop">setFillMode</a></b></span>(QString)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#fullContentPath-prop">setFullContentPath</a></b></span>(QString)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#height-prop">setHeight</a></b></span>(int)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#isPlaying-prop">setIsPlaying</a></b></span>(bool)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#loops-prop">setLoops</a></b></span>(bool)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#muted-prop">setMuted</a></b></span>(bool)</li>
</ul></td><td class="topAlign"><ul>
<li class="fn"><span class="name"><b><a href="basewindow.html#OSVersion-prop">setOSVersion</a></b></span>(QString)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#playbackRate-prop">setPlaybackRate</a></b></span>(float)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#sdk-prop">setSdk</a></b></span>(int *)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#type-prop">setType</a></b></span>(int)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#visualsPaused-prop">setVisualsPaused</a></b></span>(bool)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#volume-prop">setVolume</a></b></span>(float)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#width-prop">setWidth</a></b></span>(int)</li>
<li class="fn"><span class="name"><b><a href="winwindow.html#windowsDesktopProperties-prop">setWindowsDesktopProperties</a></b></span>(WindowsDesktopProperties *)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#type-prop">typeChanged</a></b></span>(int)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#visualsPaused-prop">visualsPausedChanged</a></b></span>(bool)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#volume-prop">volumeChanged</a></b></span>(float)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#width-prop">widthChanged</a></b></span>(int)</li>
<li class="fn"><span class="name"><b><a href="winwindow.html#windowsDesktopProperties-prop">windowsDesktopPropertiesChanged</a></b></span>(WindowsDesktopProperties *)</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#OSVersion-prop">OSVersion</a></b></span>() const : QString</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#activeScreensList-prop">activeScreensList</a></b></span>() const : QVector&lt;int&gt;</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#appID-prop">appID</a></b></span>() const : QString</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#basePath-prop">basePath</a></b></span>() const : QString</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#canFade-prop">canFade</a></b></span>() const : bool</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#checkWallpaperVisible-prop">checkWallpaperVisible</a></b></span>() const : bool</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#contentBasePath-prop">contentBasePath</a></b></span>() const : const QString &amp;</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#currentTime-prop">currentTime</a></b></span>() const : float</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#debugMode-prop">debugMode</a></b></span>() const : bool</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#fillMode-prop">fillMode</a></b></span>() const : QString</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#fullContentPath-prop">fullContentPath</a></b></span>() const : QString</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#height-prop">height</a></b></span>() const : int</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#isPlaying-prop">isPlaying</a></b></span>() const : bool</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#loops-prop">loops</a></b></span>() const : bool</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#muted-prop">muted</a></b></span>() const : bool</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#playbackRate-prop">playbackRate</a></b></span>() const : float</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#sdk-prop">sdk</a></b></span>() const : int *</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#type-prop">type</a></b></span>() const : int</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#visualsPaused-prop">visualsPaused</a></b></span>() const : bool</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#volume-prop">volume</a></b></span>() const : float</li>
<li class="fn"><span class="name"><b><a href="basewindow.html#width-prop">width</a></b></span>() const : int</li>
<li class="fn"><span class="name"><b><a href="winwindow.html#windowsDesktopProperties-prop">windowsDesktopProperties</a></b></span>() const : WindowsDesktopProperties *</li>
</ul>
</td></tr>
</table></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/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>
</html>

54
Docs/html/winwindow.html Normal file
View File

@ -0,0 +1,54 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<!-- winwindow.cpp -->
<title>WinWindow Class | ScreenPlay</title>
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
</head>
<body>
<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 ">
<li>WinWindow</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">WinWindow Class</h1>
<!-- $$$WinWindow-brief -->
<p>. <a href="#details">More...</a></p>
<!-- @@@WinWindow -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include &lt;WinWindow&gt;</span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="basewindow.html">BaseWindow</a></td></tr></table></div><ul>
<li><a href="winwindow-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">
<tr><td class="memItemLeft rightAlign topAlign"> WindowsDesktopProperties *</td><td class="memItemRight bottomAlign"><b><a href="winwindow.html#windowsDesktopProperties-prop">windowsDesktopProperties</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">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="winwindow.html#windowsDesktopProperties-prop">setWindowsDesktopProperties</a></b>(WindowsDesktopProperties *<i>windowsDesktopProperties</i>)</td></tr>
</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="winwindow.html#windowsDesktopProperties-prop">windowsDesktopPropertiesChanged</a></b>(WindowsDesktopProperties *<i>windowsDesktopProperties</i>)</td></tr>
</table></div>
<a name="details"></a>
<!-- $$$WinWindow-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
</div>
<!-- @@@WinWindow -->
<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>
</html>

View File

@ -1,117 +1,98 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Screen Play Developer Documentation</title>
<link rel="stylesheet" type="text/css" href="css/style.css" />
<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css" />
</head>
<body>
<div class="container-fullwidth nav sticky-top">
<div class="container navWrapper"><span class="logo">ScreenPlay Generated Docs </span></div>
</div>
<div class="wrapper container">
<h1 class="display-4 text-center">ScreenPlay Documentation</h1>
<br />
<p class="text-justify">
This is the ScreenPlay Code documentation. Every file gets generated via <kbd>qdoc.exe config.qdocconf</kbd>, except this index.html file. This docs is <b>automatically generated</b> via our ScreenPlayDeveloperDocs
<a href="https://gitlab.com/kelteseth/ScreenPlayDeveloperDocs">GitLab repository</a>. If you want to help documenting ScreenPlay, you can do that in the <a href="https://gitlab.com/kelteseth/ScreenPlay">main repository</a>.
</p>
<h2>Getting started</h2>
<hr />
<ul>
<li><a href="html/screenplay.html">ScreenPlay Namespace. This contains all classes and descriptions.</a></li>
<li><a href="https://gitlab.com/kelteseth/ScreenPlay/-/blob/master/Docs/DeveloperSetup.md">Developer Setup</a></li>
<li><a href="https://gitlab.com/kelteseth/ScreenPlay/-/blob/master/Docs/ProjectOverview.md">Developer Overview</a></li>
</ul>
<h2>ScreenPlay consists of 6 projects:</h2>
<hr />
<ul>
<li>
<strong>ScreenPlay</strong>
<ul>
<li>The main ScreenPlay App UI with Create, Installed, Community and Settings.</li>
</ul>
</li>
<li>
<strong>ScreenPlayUtil</strong>
<ul>
<li>Contains functions like json project file loading/saving and enums like FillMode and ContentType that is needed by all projects.</li>
</ul>
</li>
<li>
<strong>ScreenPlaySDK</strong>
<ul>
<li>A SDK used internally in the ScreenPlayWallpaper and ScreenPlayWidget to talk to the main ScreenPlay app via QLocalsockets (Windows Pipes and Unix sockets).</li>
</ul>
</li>
<li>
<strong>ScreenPlayShader</strong>
<ul>
<li>A list of ready to use shader in Wallpaper and Widgets.</li>
</ul>
</li>
<li>
<strong>ScreenPlaySysInfo</strong>
<ul>
<li>A qml plugin to read CPU, GPU, Network and all sort of statistics.</li>
</ul>
</li>
<li>
<strong>ScreenPlayWallpaper</strong>
<ul>
<li>The Wallpaper executable that is used for displaying a single wallpaper. This uses ScreenPlaySDK to talk via QLocalsockets with the main ScreenPlayApp.</li>
</ul>
</li>
<li>
<strong>ScreenPlayWidget</strong>
<ul>
<li>The Widget executable that is used for displaying a single widget. This uses ScreenPlaySDK to talk via QLocalsockets with the main ScreenPlayApp .</li>
</ul>
</li>
</ul>
<h2>C++ Namespace And Classes</h2>
<hr />
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Screen Play Developer Documentation</title>
<link rel="stylesheet" type="text/css" href="css/style.css" />
<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css" />
</head>
<div class="container">
<div class="row">
<div class="col">
<ul>
<li><a href="html/screenplay-create.html">Create</a></li>
<li><a href="html/screenplay-createimportvideo.html">CreateImport</a></li>
<li><a href="html/screenplay-globalvariables.html">GlobalVariables</a></li>
<li><a href="html/screenplay-installedlistfilter.html">InstalledListFilter</a></li>
<li><a href="html/screenplay-installedlistmodel.html">InstalledListModel</a></li>
<li><a href="html/screenplay-monitorlistmodel.html">MonitorListModel</a></li>
<li><a href="html/screenplay-profilelistmodel.html">ProfileListModel</a></li>
<li><a href="html/screenplay-projectsettingslistmodel.html">ProjectSettingsListModel</a></li>
</ul>
</div>
<div class="col">
<ul>
<li><a href="html/screenplay-screenplaymanager.html">ScreenPlayManager</a></li>
<li><a href="html/screenplay-screenplaywallpaper.html">ScreenPlayWallpaper</a></li>
<li><a href="html/screenplay-screenplaywidget.html">ScreenPlayWidget</a></li>
<li><a href="html/screenplay-sdkconnection.html">SDKConnection</a></li>
<li><a href="html/screenplay-settings.html">Settings</a></li>
<li><a href="html/screenplay-util.html">Util</a></li>
<li><a href="html/screenplay-app.html">App</a></li>
</ul>
</div>
</div>
</div>
<body>
<div class="container-fullwidth nav sticky-top">
<div class="container navWrapper"><span class="logo">ScreenPlay Generated Docs </span></div>
</div>
<div class="wrapper container">
<h1 class="display-4 text-center">ScreenPlay Documentation</h1>
<br />
<p class="text-justify">
This is the ScreenPlay Code documentation. Every file gets generated via <kbd>qdoc.exe
config.qdocconf</kbd>, except this index.html file. This docs is <b>automatically generated</b> via our
ScreenPlayDeveloperDocs
<a href="https://gitlab.com/kelteseth/ScreenPlayDeveloperDocs">GitLab repository</a>. If you want to help
documenting ScreenPlay, you can do that in the <a href="https://gitlab.com/kelteseth/ScreenPlay">main
repository</a>.
</p>
<h2>Getting started</h2>
<hr />
<ul>
<li><a href="html/screenplay.html">ScreenPlay Namespace. This contains all classes and descriptions.</a>
</li>
<li><a href="https://gitlab.com/kelteseth/ScreenPlay/-/blob/master/Docs/DeveloperSetup.md">Developer
Setup</a></li>
<li><a href="https://gitlab.com/kelteseth/ScreenPlay/-/blob/master/Docs/ProjectOverview.md">Developer
Overview</a></li>
</ul>
<h2>ScreenPlay consists of 7 projects:</h2>
<hr />
<ul>
<li>
<strong><a href="html/screenplay-module.html">ScreenPlay App</a></strong>
<ul>
<li>The main ScreenPlay module. This contains things like <a href="html/screenplay-app.html">ScreenPlayApp</a> UI with Create, Installed, Community and Settings.</li>
</ul>
</li>
<li>
<strong><a href="html/screenplaywallpaper-module.html">ScreenPlayWallpaper App</a></strong>
<ul>
<li>The Wallpaper executable that is used for displaying a single wallpaper. This uses ScreenPlaySDK
to talk via QLocalsockets with the main ScreenPlayApp.</li>
</ul>
</li>
<li>
<strong><a href="html/screenplaywidget-module.html">ScreenPlayWidget App</a></strong>
<ul>
<li>The Widget executable that is used for displaying a single widget. This uses ScreenPlaySDK to
talk via QLocalsockets with the main ScreenPlayApp .</li>
</ul>
</li>
<br>
<li>
<strong><a href="html/screenplayutil.html">ScreenPlayUtil Library</a></strong>
<ul>
<li>Contains functions like json project file loading/saving and enums like FillMode and ContentType
that is needed by all projects.</li>
</ul>
</li>
<li>
<strong><a href="html/screenplaysdk-module.html">ScreenPlaySDK Library</a></strong>
<ul>
<li>A SDK used internally in the ScreenPlayWallpaper and ScreenPlayWidget to talk to the main
ScreenPlay app via QLocalsockets (Windows Pipes and Unix sockets).</li>
</ul>
</li>
<li>
<strong><a href="html/shaderlibrary.html">ScreenPlayShader Library</a></strong>
<ul>
<li>A list of ready to use shader in Wallpaper and Widgets.</li>
</ul>
</li>
<li>
<strong><a href="html/screenplaysysinfo-module.html">ScreenPlaySysInfo Library</a></strong>
<ul>
<li>A qml plugin to read CPU, GPU, Network and all sort of statistics.</li>
</ul>
</li>
<h2>QML Common Components</h2>
<hr />
<ul>
<li><a href="html/qml-imageselector.html">ImageSelector</a></li>
</ul>
</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/bootstrap.bundle.min.js"></script>
</body>
</html>
</ul>
</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/bootstrap.bundle.min.js"></script>
</body>
</html>

View File

@ -1,7 +1,11 @@
#include "app.h"
namespace ScreenPlay {
/*!
\module ScreenPlay
\title ScreenPlay
\brief Module for ScreenPlay.
*/
/*!
\namespace ScreenPlay
\inmodule ScreenPlay

View File

@ -1,8 +1,20 @@
#include "screenplaysdk.h"
/*!
\module ScreenPlaySDK
\title ScreenPlaySDK
\brief Namespace for ScreenPlaySDK.
*/
// USE THIS ONLY FOR redirectMessageOutputToMainWindow
static ScreenPlaySDK* global_sdkPtr = nullptr;
/*!
\class ScreenPlaySDK
\inmodule ScreenPlaySDK
\brief .
*/
ScreenPlaySDK::ScreenPlaySDK(QQuickItem* parent)
: QQuickItem(parent)
{

View File

@ -1,5 +1,17 @@
#include "shaderlibrary.h"
/*!
\module ScreenPlayShader
\title ScreenPlayShader
\brief Module for ScreenPlayShader.
*/
/*!
\class ShaderLibrary
\inmodule ScreenPlayShader
\brief .
*/
ShaderLibrary::ShaderLibrary(QQuickItem* parent)
: QQuickItem(parent)
{

View File

@ -5,6 +5,13 @@
#define STATUS_SUCCESS 0
#define STATUS_INFO_LENGTH_MISMATCH 0xC0000004
/*!
\class CPU
\inmodule ScreenPlaySysInfo
\brief .
*/
CPU::CPU(QObject* parent)
: QObject(parent)
{

View File

@ -4,8 +4,32 @@
#include "infoware/version.hpp"
#include <QDebug>
static const char* vendor_name(iware::gpu::vendor_t vendor) noexcept;
static const char* vendor_name(iware::gpu::vendor_t vendor) noexcept
{
switch (vendor) {
case iware::gpu::vendor_t::intel:
return "Intel";
case iware::gpu::vendor_t::amd:
return "AMD";
case iware::gpu::vendor_t::nvidia:
return "NVidia";
case iware::gpu::vendor_t::microsoft:
return "Microsoft";
case iware::gpu::vendor_t::qualcomm:
return "Qualcomm";
case iware::gpu::vendor_t::apple:
return "Apple";
default:
return "Unknown";
}
}
/*!
\class GPU
\inmodule ScreenPlaySysInfo
\brief .
*/
GPU::GPU(QObject* parent)
: QObject(parent)
{
@ -29,22 +53,3 @@ GPU::GPU(QObject* parent)
setMaxFrequency(properties_of_device.max_frequency);
}
}
static const char* vendor_name(iware::gpu::vendor_t vendor) noexcept
{
switch (vendor) {
case iware::gpu::vendor_t::intel:
return "Intel";
case iware::gpu::vendor_t::amd:
return "AMD";
case iware::gpu::vendor_t::nvidia:
return "NVidia";
case iware::gpu::vendor_t::microsoft:
return "Microsoft";
case iware::gpu::vendor_t::qualcomm:
return "Qualcomm";
case iware::gpu::vendor_t::apple:
return "Apple";
default:
return "Unknown";
}
}

View File

@ -3,6 +3,13 @@
#include <QtQml/qqml.h>
#include <qmetatype.h>
/*!
\class RAM
\inmodule ScreenPlaySysInfo
\brief .
*/
RAM::RAM(QObject* parent)
: QObject(parent)
{

View File

@ -1,5 +1,12 @@
#include "storage.h"
/*!
\class Storage
\inmodule ScreenPlaySysInfo
\brief .
*/
Storage::Storage(QObject* parent)
: QAbstractListModel(parent)
{

View File

@ -1,5 +1,18 @@
#include "sysinfo.h"
/*!
\module ScreenPlaySysInfo
\title ScreenPlaySysInfo
\brief Module for ScreenPlaySysInfo.
*/
/*!
\class SysInfo
\inmodule ScreenPlaySysInfo
\brief .
*/
SysInfo::SysInfo(QQuickItem* parent)
: QQuickItem(parent)
, m_ram(std::make_unique<RAM>())

View File

@ -5,6 +5,12 @@
#include <sysinfoapi.h>
#endif
/*!
\class Uptime
\inmodule ScreenPlaySysInfo
\brief .
*/
Uptime::Uptime(QObject* parent)
: QObject(parent)
{

View File

@ -37,11 +37,9 @@
namespace ScreenPlay {
/*!
\class ScreenPlay::GlobalVariables
\inmodule ScreenPlay
\brief GlobalVariables.
A header only class used only for storing some global variables like localStoragePath.
\class ScreenPlay::SearchType
\inmodule ScreenPlayUtil
\brief Global Enums.
*/
@ -58,6 +56,12 @@ namespace SearchType {
Q_ENUM_NS(SearchType)
}
/*!
\class ScreenPlay::FillMode
\inmodule ScreenPlayUtil
\brief Global Enums.
*/
namespace FillMode {
Q_NAMESPACE
@ -72,6 +76,12 @@ namespace FillMode {
Q_ENUM_NS(FillMode)
}
/*!
\class ScreenPlay::InstalledType
\inmodule ScreenPlayUtil
\brief Global Enums.
*/
namespace InstalledType {
Q_NAMESPACE

View File

@ -3,6 +3,17 @@
#include <QJsonParseError>
#include <QRandomGenerator>
/*!
\module ScreenPlayUtil
\title ScreenPlayUtil
\brief Module for ScreenPlayUtil.
*/
/*!
\namespace ScreenPlayUtil
\inmodule ScreenPlayUtil
\brief Namespace for ScreenPlayUtil.
*/
namespace ScreenPlayUtil {
/*!

View File

@ -2,6 +2,18 @@
#include "ScreenPlayUtil/util.h"
/*!
\module ScreenPlayWallpaper
\title ScreenPlayWallpaper
\brief Module for ScreenPlayWallpaper.
*/
/*!
\class BaseWindow
\inmodule ScreenPlayWallpaper
\brief .
*/
BaseWindow::BaseWindow(QObject* parent)
: QObject(parent)
{

View File

@ -1,5 +1,12 @@
#include "windowsdesktopproperties.h"
/*!
\class WindowsDesktopProperties
\inmodule ScreenPlayWallpaper
\brief .
*/
WindowsDesktopProperties::WindowsDesktopProperties(QObject* parent)
: QObject(parent)
{

View File

@ -126,6 +126,12 @@ void WinWindow::setupWindowMouseHook()
}
}
/*!
\class WinWindow
\inmodule ScreenPlayWallpaper
\brief .
*/
WinWindow::WinWindow(
const QVector<int>& activeScreensList,
const QString& projectFilePath,
@ -211,12 +217,20 @@ WinWindow::WinWindow(
void WinWindow::setVisible(bool show)
{
if (show) {
if (!ShowWindow(m_windowHandle, SW_SHOW))
if (!ShowWindow(m_windowHandleWorker, SW_SHOW)) {
qDebug() << "Cannot set window handle SW_SHOW";
}
if (!ShowWindow(m_windowHandle, SW_SHOW)) {
qDebug() << "Cannot set window handle SW_SHOW";
}
} else {
if (!ShowWindow(m_windowHandle, SW_HIDE))
if (!ShowWindow(m_windowHandleWorker, SW_HIDE)) {
qDebug() << "Cannot set window handle SW_HIDE";
}
if (!ShowWindow(m_windowHandle, SW_HIDE)) {
qDebug() << "Cannot set window handle SW_HIDE";
}
}
}
@ -282,6 +296,7 @@ void WinWindow::setupWallpaperForOneScreen(int activeScreen)
SWP_HIDEWINDOW)) {
qFatal("Could not set window pos");
}
if (SetParent(m_windowHandle, m_windowHandleWorker) == nullptr) {
qFatal("Could not attach to parent window");
}
@ -388,6 +403,8 @@ void WinWindow::configureWindowGeometry()
qFatal("No worker window found");
}
ShowWindow(m_windowHandleWorker, SW_HIDE);
RECT rect {};
if (!GetWindowRect(m_windowHandleWorker, &rect)) {
qFatal("Unable to get WindoeRect from worker");

View File

@ -5,6 +5,18 @@
#include "ScreenPlayUtil/contenttypes.h"
#include "ScreenPlayUtil/util.h"
/*!
\module ScreenPlayWidget
\title ScreenPlayWidget
\brief Module for ScreenPlayWidget.
*/
/*!
\class WidgetWindow
\inmodule ScreenPlayWidget
\brief .
*/
WidgetWindow::WidgetWindow(
const QString& projectPath,
const QString& appID,

16
Tools/qdoc.py Normal file
View File

@ -0,0 +1,16 @@
import subprocess
import os
import shutil
def main():
print("\nRuns qdoc with the settings from Docs/config.qdocconf. For this you need to have Qt 6.1 installed!")
shutil.rmtree('../Docs/html/')
os.mkdir('../Docs/html/')
if os.name == "nt":
process = subprocess.Popen("C:\\Qt\\6.1.0\\msvc2019_64\\bin\\qdoc.exe ../Docs/config.qdocconf", stdout=subprocess.PIPE)
else:
process = subprocess.Popen("qdoc ../Docs/configCI.qdocconf", stdout=subprocess.PIPE)
if __name__ == "__main__":
main()