Mirrors/ScreenPlay
Mirrors/ScreenPlay
1
0
Fork 0
mirror of https://gitlab.com/kelteseth/ScreenPlay.git synced 2024-07-18 18:48:28 +02:00
Code Issues Projects Releases Activity

Update docs

Browse Source
This commit is contained in:
Elias Steurer 2020-12-26 21:14:42 +01:00
parent 05f9bc001e
commit 7e204d4cb4
32 changed files with 318 additions and 3744 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@ -90,3 +90,4 @@ CTestTestfile.cmake
_deps
.cmake/**
/Common/ffmpeg/*
/Docs/html/screenplay.index

0
Docs/configWindows.qdocconf → Docs/config.qdocconf
View File

15
Docs/html/qml-fileselector-members.html Normal file
View File

@ -0,0 +1,15 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<!-- FileSelector.qml -->
<title>List of All Members for FileSelector | 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="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">List of All Members for FileSelector</h1>
<p>This is the complete list of members for <a href="qml-fileselector.html">FileSelector</a>, including inherited members.</p>
<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>

41
Docs/html/qml-fileselector.html Normal file
View File

@ -0,0 +1,41 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<!-- FileSelector.qml -->
<title>FileSelector QML Type | 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="#details">Detailed Description</a></li>
<li class="level2"><a href="#setting-default-text-and-capitalization">Setting default text and capitalization</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">FileSelector QML Type</h1>
<span class="subtitle"></span>
<!-- $$$FileSelector-brief -->
<p>A image selector with popup preview. <a href="#details">More...</a></p>
<!-- @@@FileSelector -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import </td></tr></table></div><ul>
<li><a href="qml-fileselector-members.html">List of all members, including inherited members</a></li>
</ul>
<!-- $$$FileSelector-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p>Test</p>
<p class="centerAlign"><font color="red">[Missing image rootPreview.png]</font></p><a name="setting-default-text-and-capitalization"></a>
<h2 id="setting-default-text-and-capitalization">Setting default text and capitalization</h2>
<p>Test</p>
<pre class="qml"><span class="type">root</span> {
}</pre>
<!-- @@@FileSelector -->
<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>

4
Docs/html/qml-imageselector.html
View File

@ -30,10 +30,10 @@
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p>Test</p>
<p class="centerAlign"><font color="red">[Missing image ImageSelectorPreview.png]</font></p><a name="setting-default-text-and-capitalization"></a>
<p class="centerAlign"><font color="red">[Missing image rootPreview.png]</font></p><a name="setting-default-text-and-capitalization"></a>
<h2 id="setting-default-text-and-capitalization">Setting default text and capitalization</h2>
<p>Test</p>
<pre class="qml"><span class="type"><a href="qml-imageselector.html">ImageSelector</a></span> {
<pre class="qml"><span class="type">root</span> {
}</pre>
<!-- @@@ImageSelector -->

6
Docs/html/screenplay-app-members.html
View File

@ -14,6 +14,7 @@
<p>This is the complete list of members for <a href="screenplay-app.html">ScreenPlay::App</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-app.html#App">App</a></b></span>()</li>
<li class="fn"><span class="name"><b><a href="screenplay-app.html#create-prop">createChanged</a></b></span>(ScreenPlay::Create *)</li>
<li class="fn"><span class="name"><b><a href="screenplay-app.html#exit">exit</a></b></span>()</li>
<li class="fn"><span class="name"><b><a href="screenplay-app.html#globalVariables-prop">globalVariablesChanged</a></b></span>(ScreenPlay::GlobalVariables *)</li>
@ -31,12 +32,14 @@
<li class="fn"><span class="name"><b><a href="screenplay-app.html#mainWindowEngine-prop">setMainWindowEngine</a></b></span>(QQmlApplicationEngine *)</li>
<li class="fn"><span class="name"><b><a href="screenplay-app.html#monitorListModel-prop">setMonitorListModel</a></b></span>(ScreenPlay::MonitorListModel *)</li>
<li class="fn"><span class="name"><b><a href="screenplay-app.html#profileListModel-prop">setProfileListModel</a></b></span>(ScreenPlay::ProfileListModel *)</li>
</ul></td><td class="topAlign"><ul>
<li class="fn"><span class="name"><b><a href="screenplay-app.html#screenPlayManager-prop">setScreenPlayManager</a></b></span>(ScreenPlay::ScreenPlayManager *)</li>
</ul></td><td class="topAlign"><ul>
<li class="fn"><span class="name"><b><a href="screenplay-app.html#settings-prop">setSettings</a></b></span>(ScreenPlay::Settings *)</li>
<li class="fn"><span class="name"><b><a href="screenplay-app.html#util-prop">setUtil</a></b></span>(ScreenPlay::Util *)</li>
<li class="fn"><span class="name"><b><a href="screenplay-app.html#wizards-prop">setWizards</a></b></span>(ScreenPlay::Wizards *)</li>
<li class="fn"><span class="name"><b><a href="screenplay-app.html#settings-prop">settingsChanged</a></b></span>(ScreenPlay::Settings *)</li>
<li class="fn"><span class="name"><b><a href="screenplay-app.html#util-prop">utilChanged</a></b></span>(ScreenPlay::Util *)</li>
<li class="fn"><span class="name"><b><a href="screenplay-app.html#wizards-prop">wizardsChanged</a></b></span>(ScreenPlay::Wizards *)</li>
<li class="fn"><span class="name"><b><a href="screenplay-app.html#create-prop">create</a></b></span>() const : ScreenPlay::Create *</li>
<li class="fn"><span class="name"><b><a href="screenplay-app.html#globalVariables-prop">globalVariables</a></b></span>() const : ScreenPlay::GlobalVariables *</li>
<li class="fn"><span class="name"><b><a href="screenplay-app.html#init">init</a></b></span>()</li>
@ -48,6 +51,7 @@
<li class="fn"><span class="name"><b><a href="screenplay-app.html#screenPlayManager-prop">screenPlayManager</a></b></span>() const : ScreenPlay::ScreenPlayManager *</li>
<li class="fn"><span class="name"><b><a href="screenplay-app.html#settings-prop">settings</a></b></span>() const : ScreenPlay::Settings *</li>
<li class="fn"><span class="name"><b><a href="screenplay-app.html#util-prop">util</a></b></span>() const : ScreenPlay::Util *</li>
<li class="fn"><span class="name"><b><a href="screenplay-app.html#wizards-prop">wizards</a></b></span>() const : ScreenPlay::Wizards *</li>
</ul>
</td></tr>
</table></div>

10
Docs/html/screenplay-app.html
View File

@ -33,6 +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-app.html#App">App</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> ScreenPlay::Create *</td><td class="memItemRight bottomAlign"><b><a href="screenplay-app.html#create-prop">create</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> ScreenPlay::GlobalVariables *</td><td class="memItemRight bottomAlign"><b><a href="screenplay-app.html#globalVariables-prop">globalVariables</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-app.html#init">init</a></b>()</td></tr>
@ -44,6 +45,7 @@
<tr><td class="memItemLeft rightAlign topAlign"> ScreenPlay::ScreenPlayManager *</td><td class="memItemRight bottomAlign"><b><a href="screenplay-app.html#screenPlayManager-prop">screenPlayManager</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> ScreenPlay::Settings *</td><td class="memItemRight bottomAlign"><b><a href="screenplay-app.html#settings-prop">settings</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> ScreenPlay::Util *</td><td class="memItemRight bottomAlign"><b><a href="screenplay-app.html#util-prop">util</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> ScreenPlay::Wizards *</td><td class="memItemRight bottomAlign"><b><a href="screenplay-app.html#wizards-prop">wizards</a></b>() const</td></tr>
</table></div>
<a name="public-slots"></a>
<h2 id="public-slots">Public Slots</h2>
@ -60,6 +62,7 @@
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-app.html#screenPlayManager-prop">setScreenPlayManager</a></b>(ScreenPlay::ScreenPlayManager *<i>screenPlayManager</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-app.html#settings-prop">setSettings</a></b>(ScreenPlay::Settings *<i>settings</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-app.html#util-prop">setUtil</a></b>(ScreenPlay::Util *<i>util</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-app.html#wizards-prop">setWizards</a></b>(ScreenPlay::Wizards *<i>wizards</i>)</td></tr>
</table></div>
<a name="signals"></a>
<h2 id="signals">Signals</h2>
@ -74,6 +77,7 @@
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-app.html#screenPlayManager-prop">screenPlayManagerChanged</a></b>(ScreenPlay::ScreenPlayManager *<i>screenPlayManager</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-app.html#settings-prop">settingsChanged</a></b>(ScreenPlay::Settings *<i>settings</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-app.html#util-prop">utilChanged</a></b>(ScreenPlay::Util *<i>util</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-app.html#wizards-prop">wizardsChanged</a></b>(ScreenPlay::Wizards *<i>wizards</i>)</td></tr>
</table></div>
<a name="details"></a>
<!-- $$$App-description -->
@ -105,13 +109,17 @@
<!-- @@@App -->
<div class="func">
<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>
<!-- @@@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>
<!-- @@@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>.</p>
<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>
<!-- @@@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>

9
Docs/html/screenplay-create-members.html
View File

@ -12,18 +12,13 @@
<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">List of All Members for Create</h1>
<p>This is the complete list of members for <a href="screenplay-create.html">ScreenPlay::Create</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-create.html#Create-1">Create</a></b></span>()</li>
<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#createHTMLWallpaper">createHTMLWallpaper</a></b></span>(const QString &amp;, const QString &amp;, const QString &amp;, const QString &amp;, const QVector&lt;QString&gt; &amp;)</li>
<li class="fn"><span class="name"><b><a href="screenplay-create.html#createQMLWallpaper">createQMLWallpaper</a></b></span>(const QString &amp;, const QString &amp;, const QString &amp;, const QString &amp;, const QVector&lt;QString&gt; &amp;)</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#createWidget">createWidget</a></b></span>(const QString &amp;, const QString &amp;, const QString &amp;, const QString &amp;, const QString &amp;, const QString &amp;, const QVector&lt;QString&gt; &amp;)</li>
<li class="fn"><span class="name"><b><a href="screenplay-create.html#ffmpegOutput-prop">ffmpegOutputChanged</a></b></span>(QString)</li>
</ul></td><td class="topAlign"><ul>
<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>
<li class="fn"><span class="name"><b><a href="screenplay-create.html#progress-prop">setProgress</a></b></span>(float)</li>
@ -33,7 +28,5 @@
<li class="fn"><span class="name"><b><a href="screenplay-create.html#progress-prop">progress</a></b></span>() const : float</li>
<li class="fn"><span class="name"><b><a href="screenplay-create.html#workingDir-prop">workingDir</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>

17
Docs/html/screenplay-create.html
View File

@ -44,10 +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#createHTMLWallpaper">createHTMLWallpaper</a></b>(const QString &amp;<i>localStoragePath</i>, const QString &amp;<i>title</i>, const QString &amp;<i>previewThumbnail</i>, const QString &amp;<i>license</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-create.html#createQMLWallpaper">createQMLWallpaper</a></b>(const QString &amp;<i>localStoragePath</i>, const QString &amp;<i>title</i>, const QString &amp;<i>previewThumbnail</i>, const QString &amp;<i>license</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-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#createWidget">createWidget</a></b>(const QString &amp;<i>localStoragePath</i>, const QString &amp;<i>title</i>, const QString &amp;<i>previewThumbnail</i>, const QString &amp;<i>createdBy</i>, const QString &amp;<i>license</i>, const QString &amp;<i>type</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-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>
@ -78,24 +75,12 @@
<!-- @@@Create -->
<!-- $$$abortAndCleanup[overload1]$$$abortAndCleanup -->
<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>.</p>
<p>This method is called when the user manually aborts the wallpaper import.</p>
<!-- @@@abortAndCleanup -->
<!-- $$$createHTMLWallpaper[overload1]$$$createHTMLWallpaperconstQString&constQString&constQString&constQString&constQVector<QString>& -->
<h3 class="fn" id="createHTMLWallpaper"><a name="createHTMLWallpaper"></a><code>[slot] </code><span class="type">void</span> Create::<span class="name">createHTMLWallpaper</span>(const <span class="type">QString</span> &amp;<i>localStoragePath</i>, const <span class="type">QString</span> &amp;<i>title</i>, const <span class="type">QString</span> &amp;<i>previewThumbnail</i>, const <span class="type">QString</span> &amp;<i>license</i>, const <span class="type">QVector</span>&lt;<span class="type">QString</span>&gt; &amp;<i>tags</i>)</h3>
<p>Creates a HTML wallpaper.</p>
<!-- @@@createHTMLWallpaper -->
<!-- $$$createQMLWallpaper[overload1]$$$createQMLWallpaperconstQString&constQString&constQString&constQString&constQVector<QString>& -->
<h3 class="fn" id="createQMLWallpaper"><a name="createQMLWallpaper"></a><code>[slot] </code><span class="type">void</span> Create::<span class="name">createQMLWallpaper</span>(const <span class="type">QString</span> &amp;<i>localStoragePath</i>, const <span class="type">QString</span> &amp;<i>title</i>, const <span class="type">QString</span> &amp;<i>previewThumbnail</i>, const <span class="type">QString</span> &amp;<i>license</i>, const <span class="type">QVector</span>&lt;<span class="type">QString</span>&gt; &amp;<i>tags</i>)</h3>
<p>.</p>
<!-- @@@createQMLWallpaper -->
<!-- $$$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>
<p>Starts the process.</p>
<!-- @@@createWallpaperStart -->
<!-- $$$createWidget[overload1]$$$createWidgetconstQString&constQString&constQString&constQString&constQString&constQString&constQVector<QString>& -->
<h3 class="fn" id="createWidget"><a name="createWidget"></a><code>[slot] </code><span class="type">void</span> Create::<span class="name">createWidget</span>(const <span class="type">QString</span> &amp;<i>localStoragePath</i>, const <span class="type">QString</span> &amp;<i>title</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">QString</span> &amp;<i>license</i>, const <span class="type">QString</span> &amp;<i>type</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>
<!-- @@@createWidget -->
<!-- $$$saveWallpaper[overload1]$$$saveWallpaperQStringQStringQStringQStringQStringScreenPlay::Create::VideoCodecQVector<QString> -->
<h3 class="fn" id="saveWallpaper"><a name="saveWallpaper"></a><code>[slot] </code><span class="type">void</span> Create::<span class="name">saveWallpaper</span>(<span class="type">QString</span> <i>title</i>, <span class="type">QString</span> <i>description</i>, <span class="type">QString</span> <i>filePath</i>, <span class="type">QString</span> <i>previewImagePath</i>, <span class="type">QString</span> <i>youtube</i>, <span class="type">ScreenPlay::Create::VideoCodec</span> <i>codec</i>, <span class="type">QVector</span>&lt;<span class="type">QString</span>&gt; <i>tags</i>)</h3>
<p>When converting of the wallpaper steps where successful.</p>

2
Docs/html/screenplay-globalvariables.html
View File

@ -66,7 +66,7 @@
<h2>Member Function Documentation</h2>
<!-- $$$GlobalVariables[overload1]$$$GlobalVariablesQObject* -->
<h3 class="fn" id="GlobalVariables"><a name="GlobalVariables"></a>GlobalVariables::<span class="name">GlobalVariables</span>(<span class="type">QObject</span> *<i>parent</i> = nullptr)</h3>
<p>.</p>
<p>Constructs the global variabls.</p>
<!-- @@@GlobalVariables -->
</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>

4
Docs/html/screenplay-projectsettingslistmodel.html
View File

@ -85,7 +85,7 @@
<!-- @@@setValueAtIndex -->
<!-- $$$append[overload1]$$$appendconstScreenPlay::SettingsItem&& -->
<h3 class="fn" id="append"><a name="append"></a><span class="type">void</span> ProjectSettingsListModel::<span class="name">append</span>(const <span class="type">ScreenPlay::SettingsItem</span> &amp;&amp;<i>item</i>)</h3>
<p>.</p>
<p>appends an SettingsItem.</p>
<!-- @@@append -->
<!-- $$$data[overload1]$$$dataconstQModelIndex&int -->
<h3 class="fn" id="data"><a name="data"></a><code>[override virtual] </code><span class="type">QVariant</span> ProjectSettingsListModel::<span class="name">data</span>(const <span class="type">QModelIndex</span> &amp;<i>index</i>, <span class="type">int</span> <i>role</i> = Qt::DisplayRole) const</h3>
@ -93,7 +93,7 @@
<!-- @@@data -->
<!-- $$$getActiveSettingsJson[overload1]$$$getActiveSettingsJson -->
<h3 class="fn" id="getActiveSettingsJson"><a name="getActiveSettingsJson"></a><span class="type">QJsonObject</span> ProjectSettingsListModel::<span class="name">getActiveSettingsJson</span>()</h3>
<p>ProjectSettingsListModel::getActiveSettingsJson <b class="redFont"><code>\return</code></b></p>
<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>

6
Docs/html/screenplay-screenplaymanager.html
View File

@ -76,7 +76,7 @@
<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-.</p>
<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>
<!-- @@@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>
@ -131,7 +131,7 @@
<!-- @@@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>.</p>
<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>
@ -151,7 +151,7 @@
<!-- @@@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>.</p>
<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 -->
</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>

3
Docs/html/screenplay-screenplaywallpaper-members.html
View File

@ -32,10 +32,11 @@
<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>
</ul></td><td class="topAlign"><ul>
<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#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#volume-prop">volumeChanged</a></b></span>(float)</li>
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywallpaper.html#absolutePath-prop">absolutePath</a></b></span>() const : QString</li>

13
Docs/html/screenplay-screenplaywallpaper.html
View File

@ -63,6 +63,7 @@
<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#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>
</table></div>
<a name="signals"></a>
<h2 id="signals">Signals</h2>
@ -89,7 +90,7 @@
<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 video Wallpaper.</p>
<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>
@ -99,17 +100,21 @@
<h3 class="fn" id="processExit"><a name="processExit"></a><code>[slot] </code><span class="type">void</span> ScreenPlayWallpaper::<span class="name">processExit</span>(<span class="type">int</span> <i>exitCode</i>, <span class="type">QProcess::ExitStatus</span> <i>exitStatus</i>)</h3>
<p>Prints the exit code if != 0.</p>
<!-- @@@processExit -->
<!-- $$$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>
<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 -->
<!-- $$$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>.</p>
<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>.</p>
<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>.</p>
<p>Connects to <a href="screenplay.html">ScreenPlay</a>. Start a alive ping check for every 16 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>

6
Docs/html/screenplay-screenplaywidget.html
View File

@ -71,15 +71,15 @@
<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>Constructor.</p>
<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>.</p>
<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>.</p>
<p>Connects to <a href="screenplay.html">ScreenPlay</a>. Start a alive ping check for every 16 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>

13
Docs/html/screenplay-sdkconnection.html
View File

@ -65,19 +65,24 @@
<h2>Member Function Documentation</h2>
<!-- $$$SDKConnection[overload1]$$$SDKConnectionQLocalSocket*QObject* -->
<h3 class="fn" id="SDKConnection"><a name="SDKConnection"></a>SDKConnection::<span class="name">SDKConnection</span>(<span class="type">QLocalSocket</span> *<i>socket</i>, <span class="type">QObject</span> *<i>parent</i> = nullptr)</h3>
<p>.</p>
<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>
<p>.</p>
<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 -->
<h3 class="fn" id="readyRead"><a name="readyRead"></a><code>[slot] </code><span class="type">void</span> SDKConnection::<span class="name">readyRead</span>()</h3>
<p>.</p>
<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>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>
<p>.</p>
<p>Sends a message to the connected socket.</p>
<!-- @@@sendMessage -->
</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>

9
Docs/html/screenplay-util-members.html
View File

@ -15,21 +15,28 @@
<div class="table"><table class="propsummary">
<tr><td class="topAlign"><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>
</ul></td><td class="topAlign"><ul>
<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>

37
Docs/html/screenplay-util.html
View File

@ -39,9 +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"> 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>
@ -50,8 +53,12 @@
<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>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="screenplay-util.html#writeSettings">writeSettings</a></b>(const QJsonObject &amp;<i>obj</i>, const QString &amp;<i>absolutePath</i>)</td></tr>
</table></div>
<a name="signals"></a>
<h2 id="signals">Signals</h2>
@ -70,10 +77,18 @@
<h3 class="fn" id="Util"><a name="Util"></a>Util::<span class="name">Util</span>(<span class="type">QNetworkAccessManager</span> *<i>networkAccessManager</i>, <span class="type">QObject</span> *<i>parent</i> = nullptr)</h3>
<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>
<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>
@ -85,8 +100,12 @@
<!-- @@@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>.</p>
<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>
@ -119,14 +138,30 @@
<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>
<!-- @@@writeFile -->
<!-- $$$writeFileFromQrc[overload1]$$$writeFileFromQrcconstQString&constQString& -->
<h3 class="fn" id="writeFileFromQrc"><a name="writeFileFromQrc"></a><code>[static slot] </code><span class="type">bool</span> Util::<span class="name">writeFileFromQrc</span>(const <span class="type">QString</span> &amp;<i>qrcPath</i>, const <span class="type">QString</span> &amp;<i>absolutePath</i>)</h3>
<p>Tries to save into a text file with absolute path.</p>
<!-- @@@writeFileFromQrc -->
<!-- $$$writeJsonObjectToFile[overload1]$$$writeJsonObjectToFileconstQString&constQJsonObject&bool -->
<h3 class="fn" id="writeJsonObjectToFile"><a name="writeJsonObjectToFile"></a><code>[static slot] </code><span class="type">bool</span> Util::<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>Writes a given QJsonObject to a file. The path must be absolute. When truncate is set to true the exsisting json file will be overriten.</p>
<!-- @@@writeJsonObjectToFile -->
<!-- $$$writeSettings[overload1]$$$writeSettingsconstQJsonObject&constQString& -->
<h3 class="fn" id="writeSettings"><a name="writeSettings"></a><code>[static slot] </code><span class="type">bool</span> Util::<span class="name">writeSettings</span>(const <span class="type">QJsonObject</span> &amp;<i>obj</i>, const <span class="type">QString</span> &amp;<i>absolutePath</i>)</h3>
<p>Takes ownership of <i>obj</i> and <i>name</i>. Tries to save into a text file with of name.</p>
<!-- @@@writeSettings -->
</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>

24
Docs/html/screenplay-wizards-members.html Normal file
View File

@ -0,0 +1,24 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<!-- wizards.cpp -->
<title>List of All Members for Wizards | 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>Wizards</li>
<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">List of All Members for Wizards</h1>
<p>This is the complete list of members for <a href="screenplay-wizards.html">ScreenPlay::Wizards</a>, including inherited members.</p>
<ul>
<li class="fn"><span class="name"><b><a href="screenplay-wizards.html#Wizards">Wizards</a></b></span>(const std::shared_ptr&lt;GlobalVariables&gt; &amp;, QObject *)</li>
<li class="fn"><span class="name"><b><a href="screenplay-wizards.html#createHTMLWallpaper">createHTMLWallpaper</a></b></span>(const QString &amp;, const QString &amp;, const QString &amp;, const QString &amp;, const QString &amp;, const QVector&lt;QString&gt; &amp;)</li>
<li class="fn"><span class="name"><b><a href="screenplay-wizards.html#createHTMLWidget">createHTMLWidget</a></b></span>(const QString &amp;, const QString &amp;, const QString &amp;, const QString &amp;, const QString &amp;, const QVector&lt;QString&gt; &amp;)</li>
<li class="fn"><span class="name"><b><a href="screenplay-wizards.html#createQMLWallpaper">createQMLWallpaper</a></b></span>(const QString &amp;, const QString &amp;, const QString &amp;, const QString &amp;, const QString &amp;, const QVector&lt;QString&gt; &amp;)</li>
<li class="fn"><span class="name"><b><a href="screenplay-wizards.html#createQMLWidget">createQMLWidget</a></b></span>(const QString &amp;, const QString &amp;, const QString &amp;, const QString &amp;, const QString &amp;, const QVector&lt;QString&gt; &amp;)</li>
<li class="fn"><span class="name"><b><a href="screenplay-wizards.html#createWebsiteWallpaper">createWebsiteWallpaper</a></b></span>(const QString &amp;, const QString &amp;, const QUrl &amp;, const QVector&lt;QString&gt; &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>

80
Docs/html/screenplay-wizards.html Normal file
View File

@ -0,0 +1,80 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<!-- wizards.cpp -->
<title>Wizards 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>Wizards</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="#details">Detailed Description</a></li>
</ul>
</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>
<!-- $$$Wizards-brief -->
<p>Baseclass for all wizards. Mostly for copying and creating project files. <a href="#details">More...</a></p>
<!-- @@@Wizards -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include &lt;Wizards&gt;</span>
</td></tr></table></div><ul>
<li><a href="screenplay-wizards-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"> </td><td class="memItemRight bottomAlign"><b><a href="screenplay-wizards.html#Wizards">Wizards</a></b>(const std::shared_ptr&lt;GlobalVariables&gt; &amp;<i>globalVariables</i>, QObject *<i>parent</i> = nullptr)</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-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#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#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>
<!-- $$$Wizards-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
</div>
<!-- @@@Wizards -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$Wizards[overload1]$$$Wizardsconststd::shared_ptr<GlobalVariables>&QObject* -->
<h3 class="fn" id="Wizards"><a name="Wizards"></a>Wizards::<span class="name">Wizards</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>
<!-- @@@Wizards -->
<!-- $$$createHTMLWallpaper[overload1]$$$createHTMLWallpaperconstQString&constQString&constQString&constQString&constQString&constQVector<QString>& -->
<h3 class="fn" id="createHTMLWallpaper"><a name="createHTMLWallpaper"></a><code>[slot] </code><span class="type">void</span> Wizards::<span class="name">createHTMLWallpaper</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 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>
<p>Creates a new widget.</p>
<!-- @@@createHTMLWidget -->
<!-- $$$createQMLWallpaper[overload1]$$$createQMLWallpaperconstQString&constQString&constQString&constQString&constQString&constQVector<QString>& -->
<h3 class="fn" id="createQMLWallpaper"><a name="createQMLWallpaper"></a><code>[slot] </code><span class="type">void</span> Wizards::<span class="name">createQMLWallpaper</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>.</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>
<p>Creates a new widget.</p>
<!-- @@@createQMLWidget -->
<!-- $$$createWebsiteWallpaper[overload1]$$$createWebsiteWallpaperconstQString&constQString&constQUrl&constQVector<QString>& -->
<h3 class="fn" id="createWebsiteWallpaper"><a name="createWebsiteWallpaper"></a><code>[slot] </code><span class="type">void</span> Wizards::<span class="name">createWebsiteWallpaper</span>(const <span class="type">QString</span> &amp;<i>title</i>, const <span class="type">QString</span> &amp;<i>previewThumbnail</i>, const <span class="type">QUrl</span> &amp;<i>url</i>, const <span class="type">QVector</span>&lt;<span class="type">QString</span>&gt; &amp;<i>tags</i>)</h3>
<p>.</p>
<!-- @@@createWebsiteWallpaper -->
</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>

4
Docs/html/screenplay.html
View File

@ -43,6 +43,7 @@
<tr><td class="memItemLeft rightAlign topAlign"> class </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaywidget.html">ScreenPlayWidget</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> class </td><td class="memItemRight bottomAlign"><b><a href="screenplay-settings.html">Settings</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> class </td><td class="memItemRight bottomAlign"><b><a href="screenplay-util.html">Util</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> class </td><td class="memItemRight bottomAlign"><b><a href="screenplay-wizards.html">Wizards</a></b></td></tr>
</table></div>
<a name="details"></a>
<!-- $$$ScreenPlay-description -->
@ -97,6 +98,9 @@
<h3> class <a href="screenplay-util.html">Util</a></h3><!-- $$$Util-brief -->
<p>Easy to use global object to use when certain functionality is not available in QML. <a href="screenplay-util.html#details">More...</a></p>
<!-- @@@Util -->
<h3> class <a href="screenplay-wizards.html">Wizards</a></h3><!-- $$$Wizards-brief -->
<p>Baseclass for all wizards. Mostly for copying and creating project files. <a href="screenplay-wizards.html#details">More...</a></p>
<!-- @@@Wizards -->
</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>

3662
Docs/html/screenplay.index
View File

File diff suppressed because it is too large Load Diff

9
ScreenPlay/app.cpp
View File

@ -40,6 +40,10 @@ namespace ScreenPlay {
\endraw
*/
/*!
\brief Constructor creates and holds all classes used by ScreenPlay via unique_ptr or
shared_ptr.
*/
App::App()
: QObject(nullptr)
{
@ -48,7 +52,7 @@ App::App()
QGuiApplication::setWindowIcon(QIcon(":/assets/icons/app.ico"));
QGuiApplication::setOrganizationName("ScreenPlay");
QGuiApplication::setOrganizationDomain("screen-play.app");
QGuiApplication::setOrganizationDomain("https://screen-play.app");
QGuiApplication::setApplicationName("ScreenPlay");
QGuiApplication::setApplicationVersion("0.13.0");
QGuiApplication::setQuitOnLastWindowClosed(false);
@ -218,7 +222,8 @@ void App::exit()
}
/*!
\brief .
\brief Loads the Steam plugin when needed. This enables to start ScreenPlay
via OS autostart without waiting for Steam first.
*/
bool App::loadSteamPlugin()
{

2
ScreenPlay/src/create.cpp
View File

@ -153,7 +153,7 @@ void Create::saveWallpaper(QString title, QString description, QString filePath,
}
/*!
\brief .
\brief This method is called when the user manually aborts the wallpaper import.
*/
void Create::abortAndCleanup()
{

4
ScreenPlay/src/createimportvideo.cpp
View File

@ -156,7 +156,7 @@ bool CreateImportVideo::createWallpaperInfo()
auto obj = Util::parseQByteArrayToQJsonObject(QByteArray::fromStdString(ffmpegOut.toStdString()));
if (!obj) {
QString error = ffmpegOut;
qDebug() << "Error parsing FFPROBE json output:" << error << "\n Args: " << args;
qWarning() << "Error parsing FFPROBE json output:" << error << "\n Args: " << args;
emit processOutput(ffmpegOut);
emit processOutput("Error parsing FFPROBE json output");
@ -165,7 +165,7 @@ bool CreateImportVideo::createWallpaperInfo()
}
if (obj->empty()) {
qDebug() << "Error! File could not be parsed.";
qWarning() << "Error! File could not be parsed.";
emit processOutput("Error! File could not be parsed.");
emit createWallpaperStateChanged(ImportVideoState::AnalyseVideoError);

7
ScreenPlay/src/globalvariables.cpp
View File

@ -1,16 +1,15 @@
#include "globalvariables.h"
namespace ScreenPlay {
/*!
\class ScreenPlay::GlobalVariables
\inmodule ScreenPlay
\brief Contains all variables that are globally needed.
*/
/*!
\brief .
\brief Constructs the global variabls.
*/
ScreenPlay::GlobalVariables::GlobalVariables(QObject* parent)
: QObject(parent)

10
ScreenPlay/src/projectsettingslistmodel.cpp
View File

@ -35,11 +35,10 @@ namespace ScreenPlay {
*/
/*!
Constructor when loading properties from settings.json
\brief Constructor when loading properties from settings.json
We need to _flatten_ the json to make it work with a flat list model!
See \sa getActiveSettingsJson to make the flat list to a hierarchical json object
*/
void ProjectSettingsListModel::init(const InstalledType::InstalledType& type, const QJsonObject& properties)
{
@ -59,9 +58,8 @@ void ProjectSettingsListModel::init(const InstalledType::InstalledType& type, co
}
/*!
* \brief ProjectSettingsListModel::getActiveSettingsJson
* \return
*/
\brief ProjectSettingsListModel::getActiveSettingsJson
*/
QJsonObject ProjectSettingsListModel::getActiveSettingsJson()
{
if (m_projectSettings.isEmpty()) {
@ -115,7 +113,7 @@ QJsonObject ProjectSettingsListModel::getActiveSettingsJson()
}
/*!
\brief .
\brief appends an SettingsItem.
*/
void ProjectSettingsListModel::append(const SettingsItem&& item)
{

13
ScreenPlay/src/screenplaymanager.cpp
View File

@ -14,7 +14,8 @@ namespace ScreenPlay {
*/
/*!
\brief Constructor-.
\brief Constructor that checks if another ScreenPlay 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.
*/
ScreenPlayManager::ScreenPlayManager(
QObject* parent)
@ -68,7 +69,8 @@ bool ScreenPlayManager::checkIsAnotherScreenPlayInstanceRunning()
}
/*!
\brief .
\brief Inits this class instead of init in the constructor. This is because we need to check
first if another ScreenPlay instance is running. If it is not the case we call this function.
*/
void ScreenPlayManager::init(
const std::shared_ptr<GlobalVariables>& globalVariables,
@ -216,7 +218,8 @@ void ScreenPlayManager::createWidget(
}
/*!
\brief .
\brief Iterates all Wallpaper and Widgets for the matching appID. Returns true if a matching appID
was successful set.
*/
void ScreenPlayManager::appConnected(const std::shared_ptr<SDKConnection>& connection)
{
@ -298,7 +301,7 @@ bool ScreenPlayManager::removeWallpaperAt(int index)
}
/*!
\brief .
\brief Disconnects the connection, remove
*/
bool ScreenPlayManager::removeApp(const QString& appID)
{
@ -515,7 +518,7 @@ void ScreenPlayManager::saveProfiles()
}
/*!
\brief .
\brief Removes a wallpaper from the given appID. Returns true on success.
*/
bool ScreenPlayManager::removeWallpaperByAppID(const QString& appID)
{

18
ScreenPlay/src/screenplaywallpaper.cpp
View File

@ -11,7 +11,7 @@ namespace ScreenPlay {
*/
/*!
\brief Constructor for video Wallpaper.
\brief Constructor for ScreenPlayWallpaper.
*/
ScreenPlayWallpaper::ScreenPlayWallpaper(const QVector<int>& screenNumber,
const std::shared_ptr<GlobalVariables>& globalVariables,
@ -96,7 +96,8 @@ ScreenPlayWallpaper::ScreenPlayWallpaper(const QVector<int>& screenNumber,
}
/*!
\brief .
\brief Loads the project.json that contains all settings to display
the wallpaper.
*/
QJsonObject ScreenPlayWallpaper::getActiveSettingsJson()
{
@ -132,7 +133,7 @@ void ScreenPlayWallpaper::processExit(int exitCode, QProcess::ExitStatus exitSta
{
Q_UNUSED(exitStatus)
if (exitCode != 0)
qDebug() << "WARNING EXIT CODE: " << exitCode;
qWarning() << "WARNING EXIT CODE: " << exitCode;
}
/*!
@ -140,9 +141,14 @@ void ScreenPlayWallpaper::processExit(int exitCode, QProcess::ExitStatus exitSta
*/
void ScreenPlayWallpaper::processError(QProcess::ProcessError error)
{
qDebug() << "EX: " << error;
qWarning() << "EX: " << error;
}
/*!
\brief Sets a wallpaper value. We directly set the property if it is either volume,
playbackRate or fillMode. Otherwise it is a simple key, value json pair.
*/
void ScreenPlayWallpaper::setWallpaperValue(const QString& key, const QString& value, const bool save)
{
QJsonObject obj;
@ -165,7 +171,7 @@ void ScreenPlayWallpaper::setWallpaperValue(const QString& key, const QString& v
}
/*!
\brief .
\brief Connects to ScreenPlay. Start a alive ping check for every 16 seconds.
*/
void ScreenPlayWallpaper::setSDKConnection(const std::shared_ptr<SDKConnection>& connection)
{
@ -190,7 +196,7 @@ void ScreenPlayWallpaper::setSDKConnection(const std::shared_ptr<SDKConnection>&
}
/*!
\brief .
\brief Replaces the current wallpaper with the given one.
*/
void ScreenPlayWallpaper::replace(
const QString& absolutePath,

6
ScreenPlay/src/screenplaywidget.cpp
View File

@ -11,7 +11,7 @@ namespace ScreenPlay {
*/
/*!
\brief Constructor.
\brief Constructs a ScreenPlayWidget
*/
ScreenPlayWidget::ScreenPlayWidget(
const QString& appID,
@ -66,7 +66,7 @@ ScreenPlayWidget::ScreenPlayWidget(
}
/*!
\brief .
\brief Connects to ScreenPlay. Start a alive ping check for every 16 seconds.
*/
void ScreenPlayWidget::setSDKConnection(const std::shared_ptr<SDKConnection>& connection)
{
@ -93,7 +93,7 @@ void ScreenPlayWidget::setSDKConnection(const std::shared_ptr<SDKConnection>& co
}
/*!
\brief .
\brief Loads the project.json content.
*/
QJsonObject ScreenPlayWidget::getActiveSettingsJson()
{

16
ScreenPlay/src/sdkconnection.cpp
View File

@ -11,7 +11,7 @@ namespace ScreenPlay {
*/
/*!
\brief .
\brief Constructor.
*/
ScreenPlay::SDKConnection::SDKConnection(QLocalSocket* socket, QObject* parent)
: QObject(parent)
@ -20,8 +20,15 @@ ScreenPlay::SDKConnection::SDKConnection(QLocalSocket* socket, QObject* parent)
m_socket = socket;
connect(m_socket, &QLocalSocket::readyRead, this, &SDKConnection::readyRead);
}
/*!
\brief .
\brief Read incomming messages. Checks for types like:
\list 1
\li ping: Used to check if wallpaper is still alive
\li appID: First message of an app must contain the ID to match it to our list of running apps
\li command: Used mainly for requestRaise. This will get fired if the user tries to open a second ScreenPlay instance
\li general Json object
\endlist
*/
void ScreenPlay::SDKConnection::readyRead()
{
@ -77,7 +84,7 @@ void ScreenPlay::SDKConnection::readyRead()
}
/*!
\brief .
\brief Sends a message to the connected socket.
*/
void ScreenPlay::SDKConnection::sendMessage(const QByteArray& message)
{
@ -86,7 +93,8 @@ void ScreenPlay::SDKConnection::sendMessage(const QByteArray& message)
}
/*!
\brief .
\brief Closes the socket connection. Before it explicitly sends a quit command to make sure
the wallpaper closes (fast). This also requestDecreaseWidgetCount() because Widgets.
*/
void ScreenPlay::SDKConnection::close()
{

11
ScreenPlay/src/util.cpp
View File

@ -297,6 +297,10 @@ void Util::Util::requestDataProtection()
});
}
/*!
\brief Util function that converts a QVector of Strings into a QJsonArray.
*/
QJsonArray Util::fillArray(const QVector<QString>& items)
{
QJsonArray array;
@ -306,6 +310,11 @@ QJsonArray Util::fillArray(const QVector<QString>& items)
return array;
}
/*!
\brief Maps the Search type to an installed type. Used for filtering the installed
content.
*/
SearchType::SearchType Util::getSearchTypeFromInstalledType(const InstalledType::InstalledType type)
{
using InstalledType::InstalledType;
@ -330,7 +339,7 @@ SearchType::SearchType Util::getSearchTypeFromInstalledType(const InstalledType:
}
/*!
\brief .
\brief Maps the installed type from a QString to an enum. Used for parsing the project.json.
*/
std::optional<InstalledType::InstalledType> Util::getInstalledTypeFromString(const QString& type)
{