mirror of
https://gitlab.com/kelteseth/ScreenPlay.git
synced 2024-09-14 22:42:34 +02:00
Fix documentation style by using \brief everywhere
Change Qt version to 5.15 for better qdoc analysis Remove no longer used fixWindowsPath function
This commit is contained in:
Elias Steurer
parent
d19fe5b977
commit
f9d2c9ca1b
@ -1,11 +1,11 @@
|
||||
# Run:
|
||||
# C:\Qt\5.14.0\msvc2017_64\bin\qdoc.exe config.qdocconf
|
||||
# C:\Qt\5.15.0\msvc2017_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\5.14.0\msvc2017_64\doc\global/qt-cpp-defines.qdocconf)
|
||||
include(C:\Qt\5.14.0\msvc2017_64\doc\global/compat.qdocconf)
|
||||
include(C:\Qt\5.14.0\msvc2017_64\doc\global/fileextensions.qdocconf)
|
||||
include(C:\Qt\5.15.0\msvc2017_64\doc\global\qt-cpp-defines.qdocconf)
|
||||
include(C:\Qt\5.15.0\msvc2017_64\doc\global\compat.qdocconf)
|
||||
include(C:\Qt\5.15.0\msvc2017_64\doc\global\fileextensions.qdocconf)
|
||||
|
||||
descripton = ScreenPlay is an open source cross plattform app for displaying Wallpaper, Widgets and AppDrawer.
|
||||
language = Cpp
|
||||
|
||||
@ -1,8 +1,7 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta charset="utf-8">
|
||||
<!-- CloseIcon.qml -->
|
||||
<title>List of All Members for CloseIcon | ScreenPlay</title>
|
||||
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
|
||||
|
||||
@ -1,8 +1,7 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta charset="utf-8">
|
||||
<!-- CloseIcon.qml -->
|
||||
<title>CloseIcon 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"/>
|
||||
@ -41,21 +40,21 @@
|
||||
<!-- $$$color -->
|
||||
<div class="qmlitem"><div class="qmlproto">
|
||||
<div class="table"><table class="qmlname">
|
||||
<tr valign="top" class="odd" id="">
|
||||
<tr valign="top" class="odd" id="color-prop">
|
||||
<td class="tblQmlPropNode"><p>
|
||||
<a name="color-prop"></a><span class="name">color</span> : <span class="type">color</span></p></td></tr>
|
||||
</table></div>
|
||||
</div><div class="qmldoc"><p>Color if the icon.</p>
|
||||
</table></div></div>
|
||||
<div class="qmldoc"><p>Color if the icon.</p>
|
||||
</div></div><!-- @@@color -->
|
||||
<br/>
|
||||
<!-- $$$icon -->
|
||||
<div class="qmlitem"><div class="qmlproto">
|
||||
<div class="table"><table class="qmlname">
|
||||
<tr valign="top" class="odd" id="">
|
||||
<tr valign="top" class="odd" id="icon-prop">
|
||||
<td class="tblQmlPropNode"><p>
|
||||
<a name="icon-prop"></a><span class="name">icon</span> : <span class="type">string</span></p></td></tr>
|
||||
</table></div>
|
||||
</div><div class="qmldoc"><p>Icon image if the icon.</p>
|
||||
</table></div></div>
|
||||
<div class="qmldoc"><p>Icon image if the icon.</p>
|
||||
</div></div><!-- @@@icon -->
|
||||
<br/>
|
||||
<div id= license class="footer center"><p>This documentation is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a>.</p></div> <script src="../js/mermaid.min.js"></script> <script>var config = {startOnLoad:true,flowchart:{useMaxWidth:true,htmlLabels:true}};mermaid.initialize(config);</script></body>
|
||||
|
||||
@ -1,8 +1,7 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta charset="utf-8">
|
||||
<!-- ImageSelector.qml -->
|
||||
<title>List of All Members for ImageSelector | ScreenPlay</title>
|
||||
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
|
||||
|
||||
@ -1,8 +1,7 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta charset="utf-8">
|
||||
<!-- ImageSelector.qml -->
|
||||
<title>ImageSelector 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"/>
|
||||
|
||||
@ -1,8 +1,7 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta charset="utf-8">
|
||||
<!-- app.cpp -->
|
||||
<title>List of All Members for App | ScreenPlay</title>
|
||||
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
|
||||
@ -16,6 +15,7 @@
|
||||
<div class="table"><table class="propsummary">
|
||||
<tr><td class="topAlign"><ul>
|
||||
<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>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-app.html#installedListFilter-prop">installedListFilterChanged</a></b></span>(ScreenPlay::InstalledListFilter *)</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-app.html#installedListModel-prop">installedListModelChanged</a></b></span>(ScreenPlay::InstalledListModel *)</li>
|
||||
@ -40,6 +40,7 @@
|
||||
<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#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>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-app.html#installedListFilter-prop">installedListFilter</a></b></span>() const : ScreenPlay::InstalledListFilter *</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-app.html#installedListModel-prop">installedListModel</a></b></span>() const : ScreenPlay::InstalledListModel *</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-app.html#mainWindowEngine-prop">mainWindowEngine</a></b></span>() const : QQmlApplicationEngine *</li>
|
||||
|
||||
@ -1,8 +1,7 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta charset="utf-8">
|
||||
<!-- app.cpp -->
|
||||
<title>App Class | ScreenPlay</title>
|
||||
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
|
||||
@ -22,7 +21,7 @@
|
||||
</div>
|
||||
<div class="sidebar-content" id="sidebar-content"></div></div>
|
||||
<h1 class="title">App Class</h1>
|
||||
<span class="small-subtitle">(<a href="screenplay-app.html">ScreenPlay::App</a>)<br/></span>
|
||||
<span class="small-subtitle">class <a href="screenplay.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>
|
||||
<!-- @@@App -->
|
||||
@ -36,6 +35,7 @@
|
||||
<div class="table"><table class="alignedsummary">
|
||||
<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>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> ScreenPlay::InstalledListFilter *</td><td class="memItemRight bottomAlign"><b><a href="screenplay-app.html#installedListFilter-prop">installedListFilter</a></b>() const</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> ScreenPlay::InstalledListModel *</td><td class="memItemRight bottomAlign"><b><a href="screenplay-app.html#installedListModel-prop">installedListModel</a></b>() const</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> QQmlApplicationEngine *</td><td class="memItemRight bottomAlign"><b><a href="screenplay-app.html#mainWindowEngine-prop">mainWindowEngine</a></b>() const</td></tr>
|
||||
@ -49,6 +49,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-app.html#exit">exit</a></b>()</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-app.html#create-prop">setCreate</a></b>(ScreenPlay::Create *<i>create</i>)</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-app.html#globalVariables-prop">setGlobalVariables</a></b>(ScreenPlay::GlobalVariables *<i>globalVariables</i>)</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-app.html#installedListFilter-prop">setInstalledListFilter</a></b>(ScreenPlay::InstalledListFilter *<i>installedListFilter</i>)</td></tr>
|
||||
@ -105,5 +106,16 @@
|
||||
</div>
|
||||
</div>
|
||||
<!-- @@@App -->
|
||||
<div class="func">
|
||||
<h2>Member Function Documentation</h2>
|
||||
<!-- $$$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 -->
|
||||
<!-- $$$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 <a href="screenplay-sdkconnector.html">SDKConnector</a> 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/mermaid.min.js"></script> <script>var config = {startOnLoad:true,flowchart:{useMaxWidth:true,htmlLabels:true}};mermaid.initialize(config);</script></body>
|
||||
</html>
|
||||
|
||||
@ -1,8 +1,7 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta charset="utf-8">
|
||||
<!-- create.cpp -->
|
||||
<title>List of All Members for Create | ScreenPlay</title>
|
||||
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
|
||||
@ -13,14 +12,19 @@
|
||||
<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>
|
||||
<ul>
|
||||
<div class="table"><table class="propsummary">
|
||||
<tr><td class="topAlign"><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 shared_ptr<ScreenPlay::GlobalVariables> &, 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 )</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-create.html#createHTMLWallpaper">createHTMLWallpaper</a></b></span>(const QString &, const QString &, const QString &, const QString &, const QVector<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#createWidget">createWidget</a></b></span>(const QString &, const QString &, const QString &, const QString &, const QString &, const QString &, const QVector<QString> &)</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 , QVector<QString> )</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<QString> )</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-create.html#progress-prop">setProgress</a></b></span>(float )</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-create.html#workingDir-prop">setWorkingDir</a></b></span>(const QString &)</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-create.html#workingDir-prop">workingDirChanged</a></b></span>(QString )</li>
|
||||
@ -28,5 +32,7 @@
|
||||
<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/mermaid.min.js"></script> <script>var config = {startOnLoad:true,flowchart:{useMaxWidth:true,htmlLabels:true}};mermaid.initialize(config);</script></body>
|
||||
</html>
|
||||
|
||||
@ -1,8 +1,7 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta charset="utf-8">
|
||||
<!-- create.cpp -->
|
||||
<title>Create Class | ScreenPlay</title>
|
||||
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
|
||||
@ -22,7 +21,7 @@
|
||||
</div>
|
||||
<div class="sidebar-content" id="sidebar-content"></div></div>
|
||||
<h1 class="title">Create Class</h1>
|
||||
<span class="small-subtitle">(<a href="screenplay-create.html">ScreenPlay::Create</a>)<br/></span>
|
||||
<span class="small-subtitle">class <a href="screenplay.html">ScreenPlay</a>::Create</span>
|
||||
<!-- $$$Create-brief -->
|
||||
<p>Baseclass for creating wallapers, widgets and the corresponding wizards. <a href="#details">More...</a></p>
|
||||
<!-- @@@Create -->
|
||||
@ -43,9 +42,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"> 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>)</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>, QVector<QString> <i>tags</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 &<i>localStoragePath</i>, const QString &<i>title</i>, const QString &<i>previewThumbnail</i>, const QString &<i>license</i>, const QVector<QString> &<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 &<i>localStoragePath</i>, const QString &<i>title</i>, const QString &<i>previewThumbnail</i>, const QString &<i>createdBy</i>, const QString &<i>license</i>, const QString &<i>type</i>, const QVector<QString> &<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<QString> <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 &<i>workingDir</i>)</td></tr>
|
||||
</table></div>
|
||||
@ -73,12 +75,24 @@
|
||||
<h3 class="fn" id="Create"><a name="Create"></a>Create::<span class="name">Create</span>(const <span class="type">shared_ptr</span><<span class="type">ScreenPlay::GlobalVariables</span>> &<i>globalVariables</i>, <span class="type">QObject</span> *<i>parent</i> = nullptr)</h3>
|
||||
<p>Constructor.</p>
|
||||
<!-- @@@Create -->
|
||||
<!-- $$$createWallpaperStart[overload1]$$$createWallpaperStartQString -->
|
||||
<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>)</h3>
|
||||
<!-- $$$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>
|
||||
<!-- @@@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> &<i>localStoragePath</i>, const <span class="type">QString</span> &<i>title</i>, const <span class="type">QString</span> &<i>previewThumbnail</i>, const <span class="type">QString</span> &<i>license</i>, const <span class="type">QVector</span><<span class="type">QString</span>> &<i>tags</i>)</h3>
|
||||
<p>Creates a HTML wallpaper.</p>
|
||||
<!-- @@@createHTMLWallpaper -->
|
||||
<!-- $$$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 -->
|
||||
<!-- $$$saveWallpaper[overload1]$$$saveWallpaperQStringQStringQStringQStringQStringQVector<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">QVector</span><<span class="type">QString</span>> <i>tags</i>)</h3>
|
||||
<!-- $$$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> &<i>localStoragePath</i>, const <span class="type">QString</span> &<i>title</i>, const <span class="type">QString</span> &<i>previewThumbnail</i>, const <span class="type">QString</span> &<i>createdBy</i>, const <span class="type">QString</span> &<i>license</i>, const <span class="type">QString</span> &<i>type</i>, const <span class="type">QVector</span><<span class="type">QString</span>> &<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><<span class="type">QString</span>> <i>tags</i>)</h3>
|
||||
<p>When converting of the wallpaper steps where successful.</p>
|
||||
<!-- @@@saveWallpaper -->
|
||||
</div>
|
||||
|
||||
@ -1,8 +1,7 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta charset="utf-8">
|
||||
<!-- createimportvideo.cpp -->
|
||||
<title>List of All Members for CreateImportVideo | ScreenPlay</title>
|
||||
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
|
||||
@ -14,12 +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 &, const QString &, QObject *)</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-createimportvideo.html#CreateImportVideo-2">CreateImportVideo</a></b></span>(const QString &, const QString &, const QStringList &, 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>() : bool</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-createimportvideo.html#createWallpaperVideo">createWallpaperVideo</a></b></span>(const QString &) : 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>
|
||||
|
||||
@ -1,8 +1,7 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta charset="utf-8">
|
||||
<!-- createimportvideo.cpp -->
|
||||
<title>CreateImportVideo Class | ScreenPlay</title>
|
||||
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
|
||||
@ -22,7 +21,7 @@
|
||||
</div>
|
||||
<div class="sidebar-content" id="sidebar-content"></div></div>
|
||||
<h1 class="title">CreateImportVideo Class</h1>
|
||||
<span class="small-subtitle">(<a href="screenplay-createimportvideo.html">ScreenPlay::CreateImportVideo</a>)<br/></span>
|
||||
<span class="small-subtitle">class <a href="screenplay.html">ScreenPlay</a>::CreateImportVideo</span>
|
||||
<!-- $$$CreateImportVideo-brief -->
|
||||
<p>This class imports (copies) and creates wallaper previews. <a href="#details">More...</a></p>
|
||||
<!-- @@@CreateImportVideo -->
|
||||
@ -34,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 &<i>videoPath</i>, const QString &<i>exportPath</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 &<i>videoPath</i>, const QString &<i>exportPath</i>, const QStringList &<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-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>
|
||||
@ -42,9 +41,10 @@
|
||||
<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-createimportvideo.html#createWallpaperGifPreview">createWallpaperGifPreview</a></b>()</td></tr>
|
||||
<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>()</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 &<i>codec</i>)</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&QObject* -->
|
||||
<h3 class="fn" id="CreateImportVideo-2"><a name="CreateImportVideo-2"></a>CreateImportVideo::<span class="name">CreateImportVideo</span>(const <span class="type">QString</span> &<i>videoPath</i>, const <span class="type">QString</span> &<i>exportPath</i>, <span class="type">QObject</span> *<i>parent</i> = nullptr)</h3>
|
||||
<!-- $$$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> &<i>videoPath</i>, const <span class="type">QString</span> &<i>exportPath</i>, const <span class="type">QStringList</span> &<i>codecs</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* -->
|
||||
@ -86,6 +86,10 @@ args<span class="operator">.</span>append(m_exportPath <span class="operator">+<
|
||||
<li>Generally broken.</li>
|
||||
</ul>
|
||||
<!-- @@@createWallpaperGifPreview -->
|
||||
<!-- $$$createWallpaperImagePreview[overload1]$$$createWallpaperImagePreview -->
|
||||
<h3 class="fn" id="createWallpaperImagePreview"><a name="createWallpaperImagePreview"></a><code>[slot] </code><span class="type">bool</span> CreateImportVideo::<span class="name">createWallpaperImagePreview</span>()</h3>
|
||||
<p>.</p>
|
||||
<!-- @@@createWallpaperImagePreview -->
|
||||
<!-- $$$createWallpaperImageThumbnailPreview[overload1]$$$createWallpaperImageThumbnailPreview -->
|
||||
<h3 class="fn" id="createWallpaperImageThumbnailPreview"><a name="createWallpaperImageThumbnailPreview"></a><code>[slot] </code><span class="type">bool</span> CreateImportVideo::<span class="name">createWallpaperImageThumbnailPreview</span>()</h3>
|
||||
<p>Starts ffmpeg and tries to covert the given video to a image preview. Returns <code>false</code> if :</p>
|
||||
@ -104,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]$$$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>
|
||||
<!-- $$$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> &<i>codec</i>)</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">"-c:v"</span>);
|
||||
@ -159,7 +163,7 @@ args<span class="operator">.</span>append(m_exportPath <span class="operator">+<
|
||||
<h3 class="fn" id="process"><a name="process"></a><code>[slot] </code><span class="type">void</span> CreateImportVideo::<span class="name">process</span>()</h3>
|
||||
<p>Processes the multiple steps of creating a wallpaper.</p>
|
||||
<ol class="1" type="1"><li><a href="screenplay-createimportvideo.html#createWallpaperInfo">createWallpaperInfo</a>()</li>
|
||||
<li>createWallpaperImagePreview()</li>
|
||||
<li><a href="screenplay-createimportvideo.html#createWallpaperImagePreview">createWallpaperImagePreview</a>()</li>
|
||||
<li><a href="screenplay-createimportvideo.html#createWallpaperVideoPreview">createWallpaperVideoPreview</a>()</li>
|
||||
<li><a href="screenplay-createimportvideo.html#createWallpaperGifPreview">createWallpaperGifPreview</a>()</li>
|
||||
<li><a href="screenplay-createimportvideo.html#createWallpaperVideo">createWallpaperVideo</a>() - skiped if already a webm</li>
|
||||
|
||||
@ -1,8 +1,7 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta charset="utf-8">
|
||||
<!-- installedlistfilter.cpp -->
|
||||
<title>List of All Members for InstalledListFilter | ScreenPlay</title>
|
||||
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
|
||||
|
||||
@ -1,8 +1,7 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta charset="utf-8">
|
||||
<!-- installedlistfilter.cpp -->
|
||||
<title>InstalledListFilter Class | ScreenPlay</title>
|
||||
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
|
||||
@ -21,7 +20,7 @@
|
||||
</div>
|
||||
<div class="sidebar-content" id="sidebar-content"></div></div>
|
||||
<h1 class="title">InstalledListFilter Class</h1>
|
||||
<span class="small-subtitle">(<a href="screenplay-installedlistfilter.html">ScreenPlay::InstalledListFilter</a>)<br/></span>
|
||||
<span class="small-subtitle">class <a href="screenplay.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 -->
|
||||
@ -65,7 +64,7 @@
|
||||
<!-- @@@sortByName -->
|
||||
<!-- $$$sortByRoleType[overload1]$$$sortByRoleTypeQString -->
|
||||
<h3 class="fn" id="sortByRoleType"><a name="sortByRoleType"></a><code>[slot] </code><span class="type">void</span> InstalledListFilter::<span class="name">sortByRoleType</span>(<span class="type">QString</span> <i>type</i>)</h3>
|
||||
<p>Set the filter proxy to sort by the given <i>type</i>. This can be</p>
|
||||
<p>Set the filter proxy to sort by the given <i>type</i>. This can be:</p>
|
||||
<ul>
|
||||
<li>All</li>
|
||||
<li>Videos</li>
|
||||
|
||||
@ -1,8 +1,7 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta charset="utf-8">
|
||||
<!-- installedlistmodel.cpp -->
|
||||
<title>List of All Members for InstalledListModel | ScreenPlay</title>
|
||||
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
|
||||
|
||||
@ -1,8 +1,7 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta charset="utf-8">
|
||||
<!-- installedlistmodel.cpp -->
|
||||
<title>InstalledListModel Class | ScreenPlay</title>
|
||||
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
|
||||
@ -23,7 +22,7 @@
|
||||
</div>
|
||||
<div class="sidebar-content" id="sidebar-content"></div></div>
|
||||
<h1 class="title">InstalledListModel Class</h1>
|
||||
<span class="small-subtitle">(<a href="screenplay-installedlistmodel.html">ScreenPlay::InstalledListModel</a>)<br/></span>
|
||||
<span class="small-subtitle">class <a href="screenplay.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 -->
|
||||
@ -69,25 +68,29 @@
|
||||
<h2>Member Function Documentation</h2>
|
||||
<!-- $$$InstalledListModel[overload1]$$$InstalledListModelconstshared_ptr<ScreenPlay::GlobalVariables>&QObject* -->
|
||||
<h3 class="fn" id="InstalledListModel"><a name="InstalledListModel"></a>InstalledListModel::<span class="name">InstalledListModel</span>(const <span class="type">shared_ptr</span><<span class="type">ScreenPlay::GlobalVariables</span>> &<i>globalVariables</i>, <span class="type">QObject</span> *<i>parent</i> = nullptr)</h3>
|
||||
<p>Constructor</p>
|
||||
<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> &<i>obj</i>, const <span class="type">QString</span> &<i>folderName</i>)</h3>
|
||||
<!-- @@@append -->
|
||||
<!-- $$$init[overload1]$$$init -->
|
||||
<h3 class="fn" id="init"><a name="init"></a><code>[slot] </code><span class="type">void</span> InstalledListModel::<span class="name">init</span>()</h3>
|
||||
<p>Init function that needs to be called after the constructor because we need the GlobalVariables to finish loading.</p>
|
||||
<!-- @@@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>
|
||||
<!-- @@@loadInstalledContent -->
|
||||
<!-- $$$data[overload1]$$$dataconstQModelIndex&int -->
|
||||
<h3 class="fn" id="data"><a name="data"></a><code>[override virtual] </code><span class="type">QVariant</span> InstalledListModel::<span class="name">data</span>(const <span class="type">QModelIndex</span> &<i>index</i>, <span class="type">int</span> <i>role</i> = Qt::DisplayRole) const</h3>
|
||||
<p>Retruns the data member of the ProjectFile.</p>
|
||||
<!-- @@@data -->
|
||||
<!-- $$$roleNames[overload1]$$$roleNames -->
|
||||
<h3 class="fn" id="roleNames"><a name="roleNames"></a><code>[override virtual] </code><span class="type">QHash</span><<span class="type">int</span>, <span class="type">QByteArray</span>> InstalledListModel::<span class="name">roleNames</span>() const</h3>
|
||||
<p>Returns the variable names for QML.</p>
|
||||
<!-- @@@roleNames -->
|
||||
<!-- $$$rowCount[overload1]$$$rowCountconstQModelIndex& -->
|
||||
<h3 class="fn" id="rowCount"><a name="rowCount"></a><code>[override virtual] </code><span class="type">int</span> InstalledListModel::<span class="name">rowCount</span>(const <span class="type">QModelIndex</span> &<i>parent</i> = QModelIndex()) const</h3>
|
||||
<p>Returns the length of the installed items.</p>
|
||||
<!-- @@@rowCount -->
|
||||
</div>
|
||||
<div id= license class="footer center"><p>This documentation is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a>.</p></div> <script src="../js/mermaid.min.js"></script> <script>var config = {startOnLoad:true,flowchart:{useMaxWidth:true,htmlLabels:true}};mermaid.initialize(config);</script></body>
|
||||
|
||||
@ -1,8 +1,7 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta charset="utf-8">
|
||||
<!-- monitorlistmodel.cpp -->
|
||||
<title>List of All Members for MonitorListModel | ScreenPlay</title>
|
||||
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
|
||||
@ -15,6 +14,14 @@
|
||||
<p>This is the complete list of members for <a href="screenplay-monitorlistmodel.html">ScreenPlay::MonitorListModel</a>, including inherited members.</p>
|
||||
<ul>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-monitorlistmodel.html#MonitorListModel">MonitorListModel</a></b></span>(QObject *)</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-monitorlistmodel.html#clearActiveWallpaper">clearActiveWallpaper</a></b></span>()</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-monitorlistmodel.html#closeWallpaper">closeWallpaper</a></b></span>(const QString &)</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-monitorlistmodel.html#reset">reset</a></b></span>()</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-monitorlistmodel.html#data">data</a></b></span>(const QModelIndex &, int ) const : QVariant</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-monitorlistmodel.html#getAppIDByMonitorIndex">getAppIDByMonitorIndex</a></b></span>(<i>const int</i>) const : int</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-monitorlistmodel.html#roleNames">roleNames</a></b></span>() const : QHash<int, QByteArray></li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-monitorlistmodel.html#rowCount">rowCount</a></b></span>(const QModelIndex &) const : int</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-monitorlistmodel.html#setWallpaperActiveMonitor">setWallpaperActiveMonitor</a></b></span>(const std::shared_ptr<ScreenPlayWallpaper> &, const QVector<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/mermaid.min.js"></script> <script>var config = {startOnLoad:true,flowchart:{useMaxWidth:true,htmlLabels:true}};mermaid.initialize(config);</script></body>
|
||||
</html>
|
||||
|
||||
@ -1,8 +1,7 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta charset="utf-8">
|
||||
<!-- monitorlistmodel.cpp -->
|
||||
<title>MonitorListModel Class | ScreenPlay</title>
|
||||
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
|
||||
@ -15,12 +14,14 @@
|
||||
<h3><a name="toc">Contents</a></h3>
|
||||
<ul>
|
||||
<li class="level1"><a href="#public-functions">Public Functions</a></li>
|
||||
<li class="level1"><a href="#reimplemented-public-functions">Reimplemented 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">MonitorListModel Class</h1>
|
||||
<span class="small-subtitle">(<a href="screenplay-monitorlistmodel.html">ScreenPlay::MonitorListModel</a>)<br/></span>
|
||||
<span class="small-subtitle">class <a href="screenplay.html">ScreenPlay</a>::MonitorListModel</span>
|
||||
<!-- $$$MonitorListModel-brief -->
|
||||
<p>MonitorListModel. <a href="#details">More...</a></p>
|
||||
<!-- @@@MonitorListModel -->
|
||||
@ -33,6 +34,22 @@
|
||||
<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-monitorlistmodel.html#MonitorListModel">MonitorListModel</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-monitorlistmodel.html#getAppIDByMonitorIndex">getAppIDByMonitorIndex</a></b>(<i>const int</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<ScreenPlayWallpaper> &<i>wallpaper</i>, const QVector<int> <i>monitors</i>)</td></tr>
|
||||
</table></div>
|
||||
<a name="reimplemented-public-functions"></a>
|
||||
<h2 id="reimplemented-public-functions">Reimplemented Public Functions</h2>
|
||||
<div class="table"><table class="alignedsummary">
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> virtual QVariant </td><td class="memItemRight bottomAlign"><b><a href="screenplay-monitorlistmodel.html#data">data</a></b>(const QModelIndex &<i>index</i>, int <i>role</i> = Qt::DisplayRole) const override</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> virtual QHash<int, QByteArray> </td><td class="memItemRight bottomAlign"><b><a href="screenplay-monitorlistmodel.html#roleNames">roleNames</a></b>() const override</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> virtual int </td><td class="memItemRight bottomAlign"><b><a href="screenplay-monitorlistmodel.html#rowCount">rowCount</a></b>(const QModelIndex &<i>parent</i> = QModelIndex()) const override</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-monitorlistmodel.html#clearActiveWallpaper">clearActiveWallpaper</a></b>()</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-monitorlistmodel.html#closeWallpaper">closeWallpaper</a></b>(const QString &<i>appID</i>)</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-monitorlistmodel.html#reset">reset</a></b>()</td></tr>
|
||||
</table></div>
|
||||
<a name="details"></a>
|
||||
<!-- $$$MonitorListModel-description -->
|
||||
@ -51,8 +68,40 @@
|
||||
<h2>Member Function Documentation</h2>
|
||||
<!-- $$$MonitorListModel[overload1]$$$MonitorListModelQObject* -->
|
||||
<h3 class="fn" id="MonitorListModel"><a name="MonitorListModel"></a>MonitorListModel::<span class="name">MonitorListModel</span>(<span class="type">QObject</span> *<i>parent</i> = nullptr)</h3>
|
||||
<p>Constructor</p>
|
||||
<p>Constructor.</p>
|
||||
<!-- @@@MonitorListModel -->
|
||||
<!-- $$$clearActiveWallpaper[overload1]$$$clearActiveWallpaper -->
|
||||
<h3 class="fn" id="clearActiveWallpaper"><a name="clearActiveWallpaper"></a><code>[slot] </code><span class="type">void</span> MonitorListModel::<span class="name">clearActiveWallpaper</span>()</h3>
|
||||
<p>Clears the listmodel.</p>
|
||||
<!-- @@@clearActiveWallpaper -->
|
||||
<!-- $$$closeWallpaper[overload1]$$$closeWallpaperconstQString& -->
|
||||
<h3 class="fn" id="closeWallpaper"><a name="closeWallpaper"></a><code>[slot] </code><span class="type">void</span> MonitorListModel::<span class="name">closeWallpaper</span>(const <span class="type">QString</span> &<i>appID</i>)</h3>
|
||||
<p>Removes the preview image and appID inside an monitor item.</p>
|
||||
<!-- @@@closeWallpaper -->
|
||||
<!-- $$$reset[overload1]$$$reset -->
|
||||
<h3 class="fn" id="reset"><a name="reset"></a><code>[slot] </code><span class="type">void</span> MonitorListModel::<span class="name">reset</span>()</h3>
|
||||
<p>Removes all items and loads them vida loadMonitors() again.</p>
|
||||
<!-- @@@reset -->
|
||||
<!-- $$$data[overload1]$$$dataconstQModelIndex&int -->
|
||||
<h3 class="fn" id="data"><a name="data"></a><code>[override virtual] </code><span class="type">QVariant</span> MonitorListModel::<span class="name">data</span>(const <span class="type">QModelIndex</span> &<i>index</i>, <span class="type">int</span> <i>role</i> = Qt::DisplayRole) const</h3>
|
||||
<p>Retruns the data member of the Monitor.</p>
|
||||
<!-- @@@data -->
|
||||
<!-- $$$getAppIDByMonitorIndex[overload1]$$$getAppIDByMonitorIndexconstint -->
|
||||
<h3 class="fn" id="getAppIDByMonitorIndex"><a name="getAppIDByMonitorIndex"></a><span class="type">int</span> MonitorListModel::<span class="name">getAppIDByMonitorIndex</span>(<i>const int</i>) const</h3>
|
||||
<p>If successful this function returns an AppID. Otherwhise std::nullopt.</p>
|
||||
<!-- @@@getAppIDByMonitorIndex -->
|
||||
<!-- $$$roleNames[overload1]$$$roleNames -->
|
||||
<h3 class="fn" id="roleNames"><a name="roleNames"></a><code>[override virtual] </code><span class="type">QHash</span><<span class="type">int</span>, <span class="type">QByteArray</span>> MonitorListModel::<span class="name">roleNames</span>() const</h3>
|
||||
<p>Returns the variable names for QML.</p>
|
||||
<!-- @@@roleNames -->
|
||||
<!-- $$$rowCount[overload1]$$$rowCountconstQModelIndex& -->
|
||||
<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> &<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><<span class="type"><a href="screenplay-screenplaywallpaper.html">ScreenPlayWallpaper</a></span>> &<i>wallpaper</i>, const <span class="type">QVector</span><<span class="type">int</span>> <i>monitors</i>)</h3>
|
||||
<p>Sets the previewImage and appID for a list item.</p>
|
||||
<!-- @@@setWallpaperActiveMonitor -->
|
||||
</div>
|
||||
<div id= license class="footer center"><p>This documentation is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a>.</p></div> <script src="../js/mermaid.min.js"></script> <script>var config = {startOnLoad:true,flowchart:{useMaxWidth:true,htmlLabels:true}};mermaid.initialize(config);</script></body>
|
||||
</html>
|
||||
|
||||
@ -1,8 +1,7 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta charset="utf-8">
|
||||
<!-- profilelistmodel.cpp -->
|
||||
<title>List of All Members for ProfileListModel | ScreenPlay</title>
|
||||
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
|
||||
|
||||
@ -1,8 +1,7 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta charset="utf-8">
|
||||
<!-- profilelistmodel.cpp -->
|
||||
<title>ProfileListModel Class | ScreenPlay</title>
|
||||
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
|
||||
@ -20,7 +19,7 @@
|
||||
</div>
|
||||
<div class="sidebar-content" id="sidebar-content"></div></div>
|
||||
<h1 class="title">ProfileListModel Class</h1>
|
||||
<span class="small-subtitle">(<a href="screenplay-profilelistmodel.html">ScreenPlay::ProfileListModel</a>)<br/></span>
|
||||
<span class="small-subtitle">class <a href="screenplay.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 -->
|
||||
|
||||
@ -1,8 +1,7 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta charset="utf-8">
|
||||
<!-- projectsettingslistmodel.cpp -->
|
||||
<title>List of All Members for ProjectSettingsListModel | ScreenPlay</title>
|
||||
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
|
||||
|
||||
@ -1,8 +1,7 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta charset="utf-8">
|
||||
<!-- projectsettingslistmodel.cpp -->
|
||||
<title>ProjectSettingsListModel Class | ScreenPlay</title>
|
||||
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
|
||||
@ -20,7 +19,7 @@
|
||||
</div>
|
||||
<div class="sidebar-content" id="sidebar-content"></div></div>
|
||||
<h1 class="title">ProjectSettingsListModel Class</h1>
|
||||
<span class="small-subtitle">(<a href="screenplay-projectsettingslistmodel.html">ScreenPlay::ProjectSettingsListModel</a>)<br/></span>
|
||||
<span class="small-subtitle">class <a href="screenplay.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 -->
|
||||
|
||||
@ -1,8 +1,7 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta charset="utf-8">
|
||||
<!-- screenplaymanager.cpp -->
|
||||
<title>List of All Members for ScreenPlayManager | ScreenPlay</title>
|
||||
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
|
||||
@ -14,13 +13,14 @@
|
||||
<h1 class="title">List of All Members for ScreenPlayManager</h1>
|
||||
<p>This is the complete list of members for <a href="screenplay-screenplaymanager.html">ScreenPlay::ScreenPlayManager</a>, including inherited members.</p>
|
||||
<ul>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-screenplaymanager.html#ScreenPlayManager">ScreenPlayManager</a></b></span>(const shared_ptr<ScreenPlay::GlobalVariables> &, const shared_ptr<ScreenPlay::MonitorListModel> &, const shared_ptr<ScreenPlay::SDKConnector> &, const int &, QObject *)</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-screenplaymanager.html#ScreenPlayManager">ScreenPlayManager</a></b></span>(const shared_ptr<ScreenPlay::GlobalVariables> &, const shared_ptr<ScreenPlay::MonitorListModel> &, const shared_ptr<ScreenPlay::SDKConnector> &, const int &, const shared_ptr<ScreenPlay::Settings> &, 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#createWallpaper">createWallpaper</a></b></span>(QVector<int> , const QString &, const QString &, const float , const QString &, const QString &, const bool )</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-screenplaymanager.html#createWidget">createWidget</a></b></span>(const QUrl &, const QString &, const QString &)</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-screenplaymanager.html#getWallpaperByAppID">getWallpaperByAppID</a></b></span>(<i>const QString &</i>) : int</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#removeAllWidgets">removeAllWidgets</a></b></span>()</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-screenplaymanager.html#requestProjectSettingsListModelAt">requestProjectSettingsListModelAt</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>
|
||||
|
||||
@ -1,8 +1,7 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta charset="utf-8">
|
||||
<!-- screenplaymanager.cpp -->
|
||||
<title>ScreenPlayManager Class | ScreenPlay</title>
|
||||
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
|
||||
@ -22,7 +21,7 @@
|
||||
</div>
|
||||
<div class="sidebar-content" id="sidebar-content"></div></div>
|
||||
<h1 class="title">ScreenPlayManager Class</h1>
|
||||
<span class="small-subtitle">(<a href="screenplay-screenplaymanager.html">ScreenPlay::ScreenPlayManager</a>)<br/></span>
|
||||
<span class="small-subtitle">class <a href="screenplay.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 -->
|
||||
@ -34,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-screenplaymanager.html#ScreenPlayManager">ScreenPlayManager</a></b>(const shared_ptr<ScreenPlay::GlobalVariables> &<i>globalVariables</i>, const shared_ptr<ScreenPlay::MonitorListModel> &<i>mlm</i>, const shared_ptr<ScreenPlay::SDKConnector> &<i>sdkc</i>, const int &<i>telemetry</i>, QObject *<i>parent</i> = nullptr)</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaymanager.html#ScreenPlayManager">ScreenPlayManager</a></b>(const shared_ptr<ScreenPlay::GlobalVariables> &<i>globalVariables</i>, const shared_ptr<ScreenPlay::MonitorListModel> &<i>mlm</i>, const shared_ptr<ScreenPlay::SDKConnector> &<i>sdkc</i>, const int &<i>telemetry</i>, const shared_ptr<ScreenPlay::Settings> &<i>settings</i>, 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>
|
||||
</table></div>
|
||||
@ -45,6 +44,7 @@
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaymanager.html#createWidget">createWidget</a></b>(const QUrl &<i>absoluteStoragePath</i>, const QString &<i>previewImage</i>, const QString &<i>type</i>)</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaymanager.html#getWallpaperByAppID">getWallpaperByAppID</a></b>(<i>const QString &</i>)</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"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaymanager.html#requestProjectSettingsListModelAt">requestProjectSettingsListModelAt</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>
|
||||
@ -66,9 +66,9 @@
|
||||
<!-- @@@ScreenPlayManager -->
|
||||
<div class="func">
|
||||
<h2>Member Function Documentation</h2>
|
||||
<!-- $$$ScreenPlayManager[overload1]$$$ScreenPlayManagerconstshared_ptr<ScreenPlay::GlobalVariables>&constshared_ptr<ScreenPlay::MonitorListModel>&constshared_ptr<ScreenPlay::SDKConnector>&constint&QObject* -->
|
||||
<h3 class="fn" id="ScreenPlayManager"><a name="ScreenPlayManager"></a>ScreenPlayManager::<span class="name">ScreenPlayManager</span>(const <span class="type">shared_ptr</span><<span class="type">ScreenPlay::GlobalVariables</span>> &<i>globalVariables</i>, const <span class="type">shared_ptr</span><<span class="type"><a href="screenplay-monitorlistmodel.html">ScreenPlay::MonitorListModel</a></span>> &<i>mlm</i>, const <span class="type">shared_ptr</span><<span class="type"><a href="screenplay-sdkconnector.html">ScreenPlay::SDKConnector</a></span>> &<i>sdkc</i>, const <span class="type">int</span> &<i>telemetry</i>, <span class="type">QObject</span> *<i>parent</i> = nullptr)</h3>
|
||||
<p>Constructor</p>
|
||||
<!-- $$$ScreenPlayManager[overload1]$$$ScreenPlayManagerconstshared_ptr<ScreenPlay::GlobalVariables>&constshared_ptr<ScreenPlay::MonitorListModel>&constshared_ptr<ScreenPlay::SDKConnector>&constint&constshared_ptr<ScreenPlay::Settings>&QObject* -->
|
||||
<h3 class="fn" id="ScreenPlayManager"><a name="ScreenPlayManager"></a>ScreenPlayManager::<span class="name">ScreenPlayManager</span>(const <span class="type">shared_ptr</span><<span class="type">ScreenPlay::GlobalVariables</span>> &<i>globalVariables</i>, const <span class="type">shared_ptr</span><<span class="type"><a href="screenplay-monitorlistmodel.html">ScreenPlay::MonitorListModel</a></span>> &<i>mlm</i>, const <span class="type">shared_ptr</span><<span class="type"><a href="screenplay-sdkconnector.html">ScreenPlay::SDKConnector</a></span>> &<i>sdkc</i>, const <span class="type">int</span> &<i>telemetry</i>, const <span class="type">shared_ptr</span><<span class="type"><a href="screenplay-settings.html">ScreenPlay::Settings</a></span>> &<i>settings</i>, <span class="type">QObject</span> *<i>parent</i> = nullptr)</h3>
|
||||
<p>Constructor-.</p>
|
||||
<!-- @@@ScreenPlayManager -->
|
||||
<!-- $$$createWallpaper[overload1]$$$createWallpaperQVector<int>constQString&constQString&constfloatconstQString&constQString&constbool -->
|
||||
<h3 class="fn" id="createWallpaper"><a name="createWallpaper"></a><code>[slot] </code><span class="type">void</span> ScreenPlayManager::<span class="name">createWallpaper</span>(<span class="type">QVector</span><<span class="type">int</span>> <i>monitorIndex</i>, const <span class="type">QString</span> &<i>absoluteStoragePath</i>, const <span class="type">QString</span> &<i>previewImage</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>saveToProfilesConfigFile</i> = true)</h3>
|
||||
@ -86,6 +86,10 @@
|
||||
<h3 class="fn" id="removeAllWallpapers"><a name="removeAllWallpapers"></a><code>[slot] </code><span class="type">void</span> ScreenPlayManager::<span class="name">removeAllWallpapers</span>()</h3>
|
||||
<p>Removes all wallpaper entries in the profiles.json. This method will likely be removed when using nlohmann/json in the future.</p>
|
||||
<!-- @@@removeAllWallpapers -->
|
||||
<!-- $$$removeAllWidgets[overload1]$$$removeAllWidgets -->
|
||||
<h3 class="fn" id="removeAllWidgets"><a name="removeAllWidgets"></a><code>[slot] </code><span class="type">void</span> ScreenPlayManager::<span class="name">removeAllWidgets</span>()</h3>
|
||||
<p>Removes all widgets and resets the activeWidgetCounter to 0.</p>
|
||||
<!-- @@@removeAllWidgets -->
|
||||
<!-- $$$requestProjectSettingsListModelAt[overload1]$$$requestProjectSettingsListModelAtconstint -->
|
||||
<h3 class="fn" id="requestProjectSettingsListModelAt"><a name="requestProjectSettingsListModelAt"></a><code>[slot] </code><span class="type">void</span> ScreenPlayManager::<span class="name">requestProjectSettingsListModelAt</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>
|
||||
|
||||
@ -1,8 +1,7 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta charset="utf-8">
|
||||
<!-- screenplaywallpaper.cpp -->
|
||||
<title>List of All Members for ScreenPlayWallpaper | ScreenPlay</title>
|
||||
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
|
||||
@ -15,13 +14,14 @@
|
||||
<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<int> &, const shared_ptr<ScreenPlay::GlobalVariables> &, const QString &, const QString &, const QString &, const QString &, const QJsonObject &, QObject *)</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywallpaper.html#ScreenPlayWallpaper">ScreenPlayWallpaper</a></b></span>(const QVector<int> &, const shared_ptr<ScreenPlay::GlobalVariables> &, const QString &, const QString &, const QString &, const float , const QString &, const QString &, QObject *)</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywallpaper.html#ScreenPlayWallpaper">ScreenPlayWallpaper</a></b></span>(const QVector<int> &, const shared_ptr<ScreenPlay::GlobalVariables> &, const QString &, const QString &, const QString &, const float , const QString &, const QString &, 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>(QString )</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywallpaper.html#previewImage-prop">previewImageChanged</a></b></span>(QString )</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywallpaper.html#processError">processError</a></b></span>(QProcess::ProcessError )</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywallpaper.html#processExit">processExit</a></b></span>(int , QProcess::ExitStatus )</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywallpaper.html#profileJsonObject-prop">profileJsonObjectChanged</a></b></span>(QJsonObject )</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywallpaper.html#screenNumber-prop">screenNumberChanged</a></b></span>(QVector<int> )</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-screenplaywallpaper.html#absolutePath-prop">setAbsolutePath</a></b></span>(QString )</li>
|
||||
|
||||
@ -1,8 +1,7 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta charset="utf-8">
|
||||
<!-- screenplaywallpaper.cpp -->
|
||||
<title>ScreenPlayWallpaper Class | ScreenPlay</title>
|
||||
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
|
||||
@ -22,7 +21,7 @@
|
||||
</div>
|
||||
<div class="sidebar-content" id="sidebar-content"></div></div>
|
||||
<h1 class="title">ScreenPlayWallpaper Class</h1>
|
||||
<span class="small-subtitle">(<a href="screenplay-screenplaywallpaper.html">ScreenPlay::ScreenPlayWallpaper</a>)<br/></span>
|
||||
<span class="small-subtitle">class <a href="screenplay.html">ScreenPlay</a>::ScreenPlayWallpaper</span>
|
||||
<!-- $$$ScreenPlayWallpaper-brief -->
|
||||
<p>A Single Object to manage a Wallpaper. <a href="#details">More...</a></p>
|
||||
<!-- @@@ScreenPlayWallpaper -->
|
||||
@ -34,8 +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-screenplaywallpaper.html#ScreenPlayWallpaper-1">ScreenPlayWallpaper</a></b>(const QVector<int> &<i>screenNumber</i>, const shared_ptr<ScreenPlay::GlobalVariables> &<i>globalVariables</i>, const QString &<i>appID</i>, const QString &<i>absolutePath</i>, const QString &<i>previewImage</i>, const QString &<i>type</i>, const QJsonObject &<i>profileJsonObject</i>, QObject *<i>parent</i> = nullptr)</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaywallpaper.html#ScreenPlayWallpaper">ScreenPlayWallpaper</a></b>(const QVector<int> &<i>screenNumber</i>, const shared_ptr<ScreenPlay::GlobalVariables> &<i>globalVariables</i>, const QString &<i>appID</i>, const QString &<i>absolutePath</i>, const QString &<i>previewImage</i>, const float <i>volume</i>, const QString &<i>fillMode</i>, const QString &<i>type</i>, QObject *<i>parent</i> = nullptr)</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaywallpaper.html#ScreenPlayWallpaper">ScreenPlayWallpaper</a></b>(const QVector<int> &<i>screenNumber</i>, const shared_ptr<ScreenPlay::GlobalVariables> &<i>globalVariables</i>, const QString &<i>appID</i>, const QString &<i>absolutePath</i>, const QString &<i>previewImage</i>, const float <i>volume</i>, const QString &<i>fillMode</i>, const QString &<i>type</i>, const bool <i>checkWallpaperVisible</i>, QObject *<i>parent</i> = nullptr)</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>
|
||||
@ -48,6 +46,8 @@
|
||||
<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-screenplaywallpaper.html#processError">processError</a></b>(QProcess::ProcessError <i>error</i>)</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaywallpaper.html#processExit">processExit</a></b>(int <i>exitCode</i>, QProcess::ExitStatus <i>exitStatus</i>)</td></tr>
|
||||
<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>
|
||||
@ -78,14 +78,18 @@
|
||||
<!-- @@@ScreenPlayWallpaper -->
|
||||
<div class="func">
|
||||
<h2>Member Function Documentation</h2>
|
||||
<!-- $$$ScreenPlayWallpaper$$$ScreenPlayWallpaperconstQVector<int>&constshared_ptr<ScreenPlay::GlobalVariables>&constQString&constQString&constQString&constQString&constQJsonObject&QObject* -->
|
||||
<h3 class="fn" id="ScreenPlayWallpaper-1"><a name="ScreenPlayWallpaper-1"></a>ScreenPlayWallpaper::<span class="name">ScreenPlayWallpaper</span>(const <span class="type">QVector</span><<span class="type">int</span>> &<i>screenNumber</i>, const <span class="type">shared_ptr</span><<span class="type">ScreenPlay::GlobalVariables</span>> &<i>globalVariables</i>, const <span class="type">QString</span> &<i>appID</i>, const <span class="type">QString</span> &<i>absolutePath</i>, const <span class="type">QString</span> &<i>previewImage</i>, const <span class="type">QString</span> &<i>type</i>, const <span class="type">QJsonObject</span> &<i>profileJsonObject</i>, <span class="type">QObject</span> *<i>parent</i> = nullptr)</h3>
|
||||
<p>Constructor for scene Wallpaper with multile json settings.</p>
|
||||
<!-- @@@ScreenPlayWallpaper -->
|
||||
<!-- $$$ScreenPlayWallpaper[overload1]$$$ScreenPlayWallpaperconstQVector<int>&constshared_ptr<ScreenPlay::GlobalVariables>&constQString&constQString&constQString&constfloatconstQString&constQString&QObject* -->
|
||||
<h3 class="fn" id="ScreenPlayWallpaper"><a name="ScreenPlayWallpaper"></a>ScreenPlayWallpaper::<span class="name">ScreenPlayWallpaper</span>(const <span class="type">QVector</span><<span class="type">int</span>> &<i>screenNumber</i>, const <span class="type">shared_ptr</span><<span class="type">ScreenPlay::GlobalVariables</span>> &<i>globalVariables</i>, const <span class="type">QString</span> &<i>appID</i>, const <span class="type">QString</span> &<i>absolutePath</i>, const <span class="type">QString</span> &<i>previewImage</i>, const <span class="type">float</span> <i>volume</i>, const <span class="type">QString</span> &<i>fillMode</i>, const <span class="type">QString</span> &<i>type</i>, <span class="type">QObject</span> *<i>parent</i> = nullptr)</h3>
|
||||
<!-- $$$ScreenPlayWallpaper[overload1]$$$ScreenPlayWallpaperconstQVector<int>&constshared_ptr<ScreenPlay::GlobalVariables>&constQString&constQString&constQString&constfloatconstQString&constQString&constboolQObject* -->
|
||||
<h3 class="fn" id="ScreenPlayWallpaper"><a name="ScreenPlayWallpaper"></a>ScreenPlayWallpaper::<span class="name">ScreenPlayWallpaper</span>(const <span class="type">QVector</span><<span class="type">int</span>> &<i>screenNumber</i>, const <span class="type">shared_ptr</span><<span class="type">ScreenPlay::GlobalVariables</span>> &<i>globalVariables</i>, const <span class="type">QString</span> &<i>appID</i>, const <span class="type">QString</span> &<i>absolutePath</i>, const <span class="type">QString</span> &<i>previewImage</i>, const <span class="type">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>, <span class="type">QObject</span> *<i>parent</i> = nullptr)</h3>
|
||||
<p>Constructor for video Wallpaper.</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>
|
||||
<!-- @@@processError -->
|
||||
<!-- $$$processExit[overload1]$$$processExitintQProcess::ExitStatus -->
|
||||
<h3 class="fn" id="processExit"><a name="processExit"></a><code>[slot] </code><span class="type">void</span> ScreenPlayWallpaper::<span class="name">processExit</span>(<span class="type">int</span> <i>exitCode</i>, <span class="type">QProcess::ExitStatus</span> <i>exitStatus</i>)</h3>
|
||||
<p>Prints the exit code if != 0.</p>
|
||||
<!-- @@@processExit -->
|
||||
</div>
|
||||
<div id= license class="footer center"><p>This documentation is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a>.</p></div> <script src="../js/mermaid.min.js"></script> <script>var config = {startOnLoad:true,flowchart:{useMaxWidth:true,htmlLabels:true}};mermaid.initialize(config);</script></body>
|
||||
</html>
|
||||
|
||||
@ -1,8 +1,7 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta charset="utf-8">
|
||||
<!-- screenplaywidget.cpp -->
|
||||
<title>List of All Members for ScreenPlayWidget | ScreenPlay</title>
|
||||
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
|
||||
|
||||
@ -1,8 +1,7 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta charset="utf-8">
|
||||
<!-- screenplaywidget.cpp -->
|
||||
<title>ScreenPlayWidget Class | ScreenPlay</title>
|
||||
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
|
||||
@ -22,7 +21,7 @@
|
||||
</div>
|
||||
<div class="sidebar-content" id="sidebar-content"></div></div>
|
||||
<h1 class="title">ScreenPlayWidget Class</h1>
|
||||
<span class="small-subtitle">(<a href="screenplay-screenplaywidget.html">ScreenPlay::ScreenPlayWidget</a>)<br/></span>
|
||||
<span class="small-subtitle">class <a href="screenplay.html">ScreenPlay</a>::ScreenPlayWidget</span>
|
||||
<!-- $$$ScreenPlayWidget-brief -->
|
||||
<p>A Single Object to manage a Widget. <a href="#details">More...</a></p>
|
||||
<!-- @@@ScreenPlayWidget -->
|
||||
@ -70,7 +69,7 @@
|
||||
<h2>Member Function Documentation</h2>
|
||||
<!-- $$$ScreenPlayWidget[overload1]$$$ScreenPlayWidgetconstQString&constshared_ptr<ScreenPlay::GlobalVariables>&constQString&constQString&constQString&constQString& -->
|
||||
<h3 class="fn" id="ScreenPlayWidget"><a name="ScreenPlayWidget"></a>ScreenPlayWidget::<span class="name">ScreenPlayWidget</span>(const <span class="type">QString</span> &<i>appID</i>, const <span class="type">shared_ptr</span><<span class="type">ScreenPlay::GlobalVariables</span>> &<i>globalVariables</i>, const <span class="type">QString</span> &<i>projectPath</i>, const <span class="type">QString</span> &<i>previewImage</i>, const <span class="type">QString</span> &<i>fullPath</i>, const <span class="type">QString</span> &<i>type</i>)</h3>
|
||||
<p>Constructor</p>
|
||||
<p>Constructor.</p>
|
||||
<!-- @@@ScreenPlayWidget -->
|
||||
</div>
|
||||
<div id= license class="footer center"><p>This documentation is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a>.</p></div> <script src="../js/mermaid.min.js"></script> <script>var config = {startOnLoad:true,flowchart:{useMaxWidth:true,htmlLabels:true}};mermaid.initialize(config);</script></body>
|
||||
|
||||
@ -1,8 +1,7 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta charset="utf-8">
|
||||
<!-- sdkconnector.cpp -->
|
||||
<title>List of All Members for SDKConnector | ScreenPlay</title>
|
||||
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
|
||||
@ -17,10 +16,11 @@
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-sdkconnector.html#SDKConnector">SDKConnector</a></b></span>(QObject *)</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-sdkconnector.html#closeAllConnections">closeAllConnections</a></b></span>()</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-sdkconnector.html#closeAllWallpapers">closeAllWallpapers</a></b></span>()</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-sdkconnector.html#closeAllWidgets">closeAllWidgets</a></b></span>()</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-sdkconnector.html#closeConntectionByType">closeConntectionByType</a></b></span>(const QStringList &)</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-sdkconnector.html#closeWallpaper">closeWallpaper</a></b></span>(const QString &)</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-sdkconnector.html#closeWallpapersAt">closeWallpapersAt</a></b></span>(int )</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-sdkconnector.html#newConnection">newConnection</a></b></span>()</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-sdkconnector.html#setSceneValue">setSceneValue</a></b></span>(QString , QString , QString )</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-sdkconnector.html#setWallpaperValue">setWallpaperValue</a></b></span>(QString , QString , 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/mermaid.min.js"></script> <script>var config = {startOnLoad:true,flowchart:{useMaxWidth:true,htmlLabels:true}};mermaid.initialize(config);</script></body>
|
||||
|
||||
@ -1,8 +1,7 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta charset="utf-8">
|
||||
<!-- sdkconnector.cpp -->
|
||||
<title>SDKConnector Class | ScreenPlay</title>
|
||||
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
|
||||
@ -21,7 +20,7 @@
|
||||
</div>
|
||||
<div class="sidebar-content" id="sidebar-content"></div></div>
|
||||
<h1 class="title">SDKConnector Class</h1>
|
||||
<span class="small-subtitle">(<a href="screenplay-sdkconnector.html">ScreenPlay::SDKConnector</a>)<br/></span>
|
||||
<span class="small-subtitle">class <a href="screenplay.html">ScreenPlay</a>::SDKConnector</span>
|
||||
<!-- $$$SDKConnector-brief -->
|
||||
<p>SDKConnector is used for the QLocalSocket connection between <a href="screenplay.html">ScreenPlay</a> and the standalone <a href="screenplay-screenplaywallpaper.html">ScreenPlayWallpaper</a> and <a href="screenplay-screenplaywidget.html">ScreenPlayWidget</a> executables. <a href="#details">More...</a></p>
|
||||
<!-- @@@SDKConnector -->
|
||||
@ -40,10 +39,11 @@
|
||||
<div class="table"><table class="alignedsummary">
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-sdkconnector.html#closeAllConnections">closeAllConnections</a></b>()</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-sdkconnector.html#closeAllWallpapers">closeAllWallpapers</a></b>()</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-sdkconnector.html#closeAllWidgets">closeAllWidgets</a></b>()</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-sdkconnector.html#closeConntectionByType">closeConntectionByType</a></b>(const QStringList &<i>list</i>)</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-sdkconnector.html#closeWallpaper">closeWallpaper</a></b>(const QString &<i>appID</i>)</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-sdkconnector.html#closeWallpapersAt">closeWallpapersAt</a></b>(int <i>at</i>)</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-sdkconnector.html#newConnection">newConnection</a></b>()</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-sdkconnector.html#setSceneValue">setSceneValue</a></b>(QString <i>appID</i>, QString <i>key</i>, QString <i>value</i>)</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-sdkconnector.html#setWallpaperValue">setWallpaperValue</a></b>(QString <i>appID</i>, QString <i>key</i>, QString <i>value</i>)</td></tr>
|
||||
</table></div>
|
||||
<a name="details"></a>
|
||||
@ -73,6 +73,19 @@
|
||||
<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> SDKConnector::<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 -->
|
||||
<!-- $$$closeConntectionByType[overload1]$$$closeConntectionByTypeconstQStringList& -->
|
||||
<h3 class="fn" id="closeConntectionByType"><a name="closeConntectionByType"></a><code>[slot] </code><span class="type">void</span> SDKConnector::<span class="name">closeConntectionByType</span>(const <span class="type">QStringList</span> &<i>list</i>)</h3>
|
||||
<p>Closes a connection by type. Used only by <a href="screenplay-sdkconnector.html#closeAllWidgets">closeAllWidgets</a>() and <a href="screenplay-sdkconnector.html#closeAllWallpapers">closeAllWallpapers</a>()</p>
|
||||
<!-- @@@closeConntectionByType -->
|
||||
<!-- $$$closeWallpaper[overload1]$$$closeWallpaperconstQString& -->
|
||||
<h3 class="fn" id="closeWallpaper"><a name="closeWallpaper"></a><code>[slot] </code><span class="type">void</span> SDKConnector::<span class="name">closeWallpaper</span>(const <span class="type">QString</span> &<i>appID</i>)</h3>
|
||||
<p>Closes a wallpaper by the given <i>appID</i>.</p>
|
||||
@ -85,10 +98,6 @@
|
||||
<h3 class="fn" id="newConnection"><a name="newConnection"></a><code>[slot] </code><span class="type">void</span> SDKConnector::<span class="name">newConnection</span>()</h3>
|
||||
<p>Appends a new SDKConnection object shared_ptr to the m_clients list.</p>
|
||||
<!-- @@@newConnection -->
|
||||
<!-- $$$setSceneValue[overload1]$$$setSceneValueQStringQStringQString -->
|
||||
<h3 class="fn" id="setSceneValue"><a name="setSceneValue"></a><code>[slot] </code><span class="type">void</span> SDKConnector::<span class="name">setSceneValue</span>(<span class="type">QString</span> <i>appID</i>, <span class="type">QString</span> <i>key</i>, <span class="type">QString</span> <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>
|
||||
<!-- @@@setSceneValue -->
|
||||
<!-- $$$setWallpaperValue[overload1]$$$setWallpaperValueQStringQStringQString -->
|
||||
<h3 class="fn" id="setWallpaperValue"><a name="setWallpaperValue"></a><code>[slot] </code><span class="type">void</span> SDKConnector::<span class="name">setWallpaperValue</span>(<span class="type">QString</span> <i>appID</i>, <span class="type">QString</span> <i>key</i>, <span class="type">QString</span> <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>
|
||||
|
||||
@ -1,8 +1,7 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta charset="utf-8">
|
||||
<!-- settings.cpp -->
|
||||
<title>List of All Members for Settings | ScreenPlay</title>
|
||||
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
|
||||
@ -18,36 +17,42 @@
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-settings.html#Settings">Settings</a></b></span>(const shared_ptr<ScreenPlay::GlobalVariables> &, QObject *)</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-settings.html#anonymousTelemetry-prop">anonymousTelemetryChanged</a></b></span>(bool )</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-settings.html#autostart-prop">autostartChanged</a></b></span>(bool )</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-settings.html#checkWallpaperVisible-prop">checkWallpaperVisibleChanged</a></b></span>(bool )</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-settings.html#decoder-prop">decoderChanged</a></b></span>(QString )</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-settings.html#font-prop">fontChanged</a></b></span>(QString )</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-settings.html#gitBuildHash-prop">gitBuildHashChanged</a></b></span>(QString )</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-settings.html#highPriorityStart-prop">highPriorityStartChanged</a></b></span>(bool )</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-settings.html#language-prop">languageChanged</a></b></span>(QString )</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-settings.html#language-prop">languageChanged</a></b></span>(ScreenPlay::Settings::Language )</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-settings.html#offlineMode-prop">offlineModeChanged</a></b></span>(bool )</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-settings.html#pauseWallpaperWhenIngame-prop">pauseWallpaperWhenIngameChanged</a></b></span>(bool )</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-settings.html#retranslateUI">retranslateUI</a></b></span>() : bool</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-settings.html#anonymousTelemetry-prop">setAnonymousTelemetry</a></b></span>(bool )</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-settings.html#autostart-prop">setAutostart</a></b></span>(bool )</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-settings.html#checkWallpaperVisible-prop">setCheckWallpaperVisible</a></b></span>(bool )</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-settings.html#decoder-prop">setDecoder</a></b></span>(QString )</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-settings.html#font-prop">setFont</a></b></span>(QString )</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-settings.html#gitBuildHash-prop">setGitBuildHash</a></b></span>(QString )</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-settings.html#highPriorityStart-prop">setHighPriorityStart</a></b></span>(bool )</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-settings.html#language-prop">setLanguage</a></b></span>(QString )</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-settings.html#offlineMode-prop">setOfflineMode</a></b></span>(bool )</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-settings.html#language-prop">setLanguage</a></b></span>(ScreenPlay::Settings::Language )</li>
|
||||
</ul></td><td class="topAlign"><ul>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-settings.html#pauseWallpaperWhenIngame-prop">setPauseWallpaperWhenIngame</a></b></span>(bool )</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-settings.html#offlineMode-prop">setOfflineMode</a></b></span>(bool )</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-settings.html#silentStart-prop">setSilentStart</a></b></span>(bool )</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-settings.html#videoFillMode-prop">setVideoFillMode</a></b></span>(ScreenPlay::Settings::FillMode )</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#videoFillMode-prop">videoFillModeChanged</a></b></span>(ScreenPlay::Settings::FillMode )</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-settings.html#writeJsonFileFromResource">writeJsonFileFromResource</a></b></span>(const QString &)</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-settings.html#writeSingleSettingConfig">writeSingleSettingConfig</a></b></span>(QString , QVariant ) : bool</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>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-settings.html#checkWallpaperVisible-prop">checkWallpaperVisible</a></b></span>() const : bool</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-settings.html#decoder-prop">decoder</a></b></span>() const : QString</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-settings.html#font-prop">font</a></b></span>() const : QString</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-settings.html#gitBuildHash-prop">gitBuildHash</a></b></span>() const : QString</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-settings.html#highPriorityStart-prop">highPriorityStart</a></b></span>() const : bool</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-settings.html#language-prop">language</a></b></span>() const : QString</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-settings.html#language-prop">language</a></b></span>() const : ScreenPlay::Settings::Language</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-settings.html#offlineMode-prop">offlineMode</a></b></span>() const : bool</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-settings.html#pauseWallpaperWhenIngame-prop">pauseWallpaperWhenIngame</a></b></span>() const : bool</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-settings.html#setupLanguage">setupLanguage</a></b></span>()</li>
|
||||
<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#version-prop">version</a></b></span>() const : QVersionNumber</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-settings.html#videoFillMode-prop">videoFillMode</a></b></span>() const : ScreenPlay::Settings::FillMode</li>
|
||||
</ul>
|
||||
</td></tr>
|
||||
</table></div>
|
||||
|
||||
@ -1,8 +1,7 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta charset="utf-8">
|
||||
<!-- settings.cpp -->
|
||||
<title>Settings Class | ScreenPlay</title>
|
||||
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
|
||||
@ -22,7 +21,7 @@
|
||||
</div>
|
||||
<div class="sidebar-content" id="sidebar-content"></div></div>
|
||||
<h1 class="title">Settings Class</h1>
|
||||
<span class="small-subtitle">(<a href="screenplay-settings.html">ScreenPlay::Settings</a>)<br/></span>
|
||||
<span class="small-subtitle">class <a href="screenplay.html">ScreenPlay</a>::Settings</span>
|
||||
<!-- $$$Settings-brief -->
|
||||
<p>Global settings class for reading and writing settings. <a href="#details">More...</a></p>
|
||||
<!-- @@@Settings -->
|
||||
@ -37,43 +36,49 @@
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="screenplay-settings.html#Settings">Settings</a></b>(const shared_ptr<ScreenPlay::GlobalVariables> &<i>globalVariables</i>, QObject *<i>parent</i> = nullptr)</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="screenplay-settings.html#anonymousTelemetry-prop">anonymousTelemetry</a></b>() const</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="screenplay-settings.html#autostart-prop">autostart</a></b>() const</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="screenplay-settings.html#checkWallpaperVisible-prop">checkWallpaperVisible</a></b>() const</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="screenplay-settings.html#decoder-prop">decoder</a></b>() const</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="screenplay-settings.html#font-prop">font</a></b>() const</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="screenplay-settings.html#gitBuildHash-prop">gitBuildHash</a></b>() const</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="screenplay-settings.html#highPriorityStart-prop">highPriorityStart</a></b>() const</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="screenplay-settings.html#language-prop">language</a></b>() const</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> ScreenPlay::Settings::Language </td><td class="memItemRight bottomAlign"><b><a href="screenplay-settings.html#language-prop">language</a></b>() const</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="screenplay-settings.html#offlineMode-prop">offlineMode</a></b>() const</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="screenplay-settings.html#pauseWallpaperWhenIngame-prop">pauseWallpaperWhenIngame</a></b>() const</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-settings.html#setupLanguage">setupLanguage</a></b>()</td></tr>
|
||||
<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"> QVersionNumber </td><td class="memItemRight bottomAlign"><b><a href="screenplay-settings.html#version-prop">version</a></b>() const</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> ScreenPlay::Settings::FillMode </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>
|
||||
<div class="table"><table class="alignedsummary">
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="screenplay-settings.html#retranslateUI">retranslateUI</a></b>()</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-settings.html#anonymousTelemetry-prop">setAnonymousTelemetry</a></b>(bool <i>anonymousTelemetry</i>)</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-settings.html#autostart-prop">setAutostart</a></b>(bool <i>autostart</i>)</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-settings.html#checkWallpaperVisible-prop">setCheckWallpaperVisible</a></b>(bool <i>checkWallpaperVisible</i>)</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-settings.html#decoder-prop">setDecoder</a></b>(QString <i>decoder</i>)</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-settings.html#font-prop">setFont</a></b>(QString <i>font</i>)</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-settings.html#gitBuildHash-prop">setGitBuildHash</a></b>(QString <i>gitBuildHash</i>)</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-settings.html#highPriorityStart-prop">setHighPriorityStart</a></b>(bool <i>highPriorityStart</i>)</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-settings.html#language-prop">setLanguage</a></b>(QString <i>language</i>)</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-settings.html#language-prop">setLanguage</a></b>(ScreenPlay::Settings::Language <i>language</i>)</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-settings.html#offlineMode-prop">setOfflineMode</a></b>(bool <i>offlineMode</i>)</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-settings.html#pauseWallpaperWhenIngame-prop">setPauseWallpaperWhenIngame</a></b>(bool <i>pauseWallpaperWhenIngame</i>)</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-settings.html#silentStart-prop">setSilentStart</a></b>(bool <i>silentStart</i>)</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-settings.html#videoFillMode-prop">setVideoFillMode</a></b>(ScreenPlay::Settings::FillMode <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 &<i>filename</i>)</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="screenplay-settings.html#writeSingleSettingConfig">writeSingleSettingConfig</a></b>(QString <i>name</i>, QVariant <i>value</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="screenplay-settings.html#anonymousTelemetry-prop">anonymousTelemetryChanged</a></b>(bool <i>anonymousTelemetry</i>)</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-settings.html#autostart-prop">autostartChanged</a></b>(bool <i>autostart</i>)</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-settings.html#checkWallpaperVisible-prop">checkWallpaperVisibleChanged</a></b>(bool <i>checkWallpaperVisible</i>)</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-settings.html#decoder-prop">decoderChanged</a></b>(QString <i>decoder</i>)</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-settings.html#font-prop">fontChanged</a></b>(QString <i>font</i>)</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-settings.html#gitBuildHash-prop">gitBuildHashChanged</a></b>(QString <i>gitBuildHash</i>)</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-settings.html#highPriorityStart-prop">highPriorityStartChanged</a></b>(bool <i>highPriorityStart</i>)</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-settings.html#language-prop">languageChanged</a></b>(QString <i>language</i>)</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-settings.html#language-prop">languageChanged</a></b>(ScreenPlay::Settings::Language <i>language</i>)</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-settings.html#offlineMode-prop">offlineModeChanged</a></b>(bool <i>offlineMode</i>)</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-settings.html#pauseWallpaperWhenIngame-prop">pauseWallpaperWhenIngameChanged</a></b>(bool <i>pauseWallpaperWhenIngame</i>)</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-settings.html#silentStart-prop">silentStartChanged</a></b>(bool <i>silentStart</i>)</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-settings.html#videoFillMode-prop">videoFillModeChanged</a></b>(ScreenPlay::Settings::FillMode <i>videoFillMode</i>)</td></tr>
|
||||
</table></div>
|
||||
<a name="details"></a>
|
||||
<!-- $$$Settings-description -->
|
||||
@ -81,9 +86,8 @@
|
||||
<h2 id="details">Detailed Description</h2>
|
||||
<p>Used for:</p>
|
||||
<ul>
|
||||
<li>User configuration via AppDataLocalScreenPlayScreenPlay<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>settings.json - saved settings like autostart and installedContentPath</li>
|
||||
<li>Computer\HKEY_CURRENT_USER\Software\<a href="screenplay.html">ScreenPlay</a>\<a href="screenplay.html">ScreenPlay</a> - ScreenPlayContentPath for steam plugin</li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -99,16 +103,17 @@
|
||||
<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>
|
||||
<li>Checks the langauge via settings or system and available ones and installes a translator.</li>
|
||||
<li>Checks the paths for config folders in appdata</li>
|
||||
<li>Checks if settings.json and profiles.json are available. If first run it creates the default settings and profiles json.</li>
|
||||
<li>Parses the version and checks with the compiled one.</li>
|
||||
<li>Checks the absoluteStoragePath.</li>
|
||||
<li>Checks the AbsoluteStoragePath.</li>
|
||||
<li>Checks regisitry for steam plugin settings</li>
|
||||
<li>Parses autostart, <a href="screenplay-settings.html#anonymousTelemetry-prop">anonymousTelemetry</a>, <a href="screenplay-settings.html#highPriorityStart-prop">highPriorityStart</a></li>
|
||||
<li>Checks <a href="screenplay-screenplaywallpaper.html">ScreenPlayWallpaper</a> and ScreenPlayWidgets executable paths.</li>
|
||||
</ol>
|
||||
<p>More errorchecking is needed here. For example when the proile or settings json cannot to parsed, use the default settings.</p>
|
||||
<!-- @@@Settings -->
|
||||
<!-- $$$retranslateUI[overload1]$$$retranslateUI -->
|
||||
<h3 class="fn" id="retranslateUI"><a name="retranslateUI"></a><code>[slot] </code><span class="type">bool</span> Settings::<span class="name">retranslateUI</span>()</h3>
|
||||
<p>Check for supported langauges. If we use a langauge that not uses latin characters, we change the font. For example this happens for korean user. We ship google Noto Sans CJK KR Regular for this..</p>
|
||||
<!-- @@@retranslateUI -->
|
||||
<!-- $$$setupWidgetAndWindowPaths[overload1]$$$setupWidgetAndWindowPaths -->
|
||||
<h3 class="fn" id="setupWidgetAndWindowPaths"><a name="setupWidgetAndWindowPaths"></a><code>[slot] </code><span class="type">void</span> Settings::<span class="name">setupWidgetAndWindowPaths</span>()</h3>
|
||||
<p>To have a better developer experience we check if we use a debug version. Then we assume That the paths are the default QtCreator paths and set the widgets and wallpaper executable paths accordingly.</p>
|
||||
@ -121,10 +126,10 @@
|
||||
<li>settings.json</li>
|
||||
</ul>
|
||||
<!-- @@@writeJsonFileFromResource -->
|
||||
<!-- $$$writeSingleSettingConfig[overload1]$$$writeSingleSettingConfigQStringQVariant -->
|
||||
<h3 class="fn" id="writeSingleSettingConfig"><a name="writeSingleSettingConfig"></a><code>[slot] </code><span class="type">bool</span> Settings::<span class="name">writeSingleSettingConfig</span>(<span class="type">QString</span> <i>name</i>, <span class="type">QVariant</span> <i>value</i>)</h3>
|
||||
<p>Save a single <i>value</i> with a given <i>name</i> (key) into the settings.json. Returns <code>true</code> when successful otherise returns <code>false</code>.</p>
|
||||
<!-- @@@writeSingleSettingConfig -->
|
||||
<!-- $$$setupLanguage[overload1]$$$setupLanguage -->
|
||||
<h3 class="fn" id="setupLanguage"><a name="setupLanguage"></a><span class="type">void</span> Settings::<span class="name">setupLanguage</span>()</h3>
|
||||
<p>Checks if there is already a saved language. If not we try to use the system langauge. If we do not support the system language we use english.</p>
|
||||
<!-- @@@setupLanguage -->
|
||||
</div>
|
||||
<div id= license class="footer center"><p>This documentation is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a>.</p></div> <script src="../js/mermaid.min.js"></script> <script>var config = {startOnLoad:true,flowchart:{useMaxWidth:true,htmlLabels:true}};mermaid.initialize(config);</script></body>
|
||||
</html>
|
||||
|
||||
@ -1,8 +1,7 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta charset="utf-8">
|
||||
<!-- util.cpp -->
|
||||
<title>List of All Members for Util | ScreenPlay</title>
|
||||
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
|
||||
@ -24,12 +23,14 @@
|
||||
<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#getVersionNumberFromString">getVersionNumberFromString</a></b></span>(<i>const QString &</i>) : int</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-util.html#logToGui">logToGui</a></b></span>(QtMsgType , const QMessageLogContext &, const QString &)</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-util.html#openFolderInExplorer">openFolderInExplorer</a></b></span>(const QString &) 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>(<i>const QString &</i>) : int</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-util.html#openJsonFileToString">openJsonFileToString</a></b></span>(<i>const QString &</i>) : int</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-util.html#parseQByteArrayToQJsonObject">parseQByteArrayToQJsonObject</a></b></span>(<i>const QByteArray &</i>) : int</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#toString">toString</a></b></span>(const QStringList &) : QString</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-util.html#writeJsonObjectToFile">writeJsonObjectToFile</a></b></span>(const QString &, const QJsonObject &, bool ) : bool</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-util.html#aquireFFMPEGStatus-prop">aquireFFMPEGStatus</a></b></span>() const : ScreenPlay::Util::AquireFFMPEGStatus</li>
|
||||
<li class="fn"><span class="name"><b><a href="screenplay-util.html#debugMessages-prop">debugMessages</a></b></span>() const : QString</li>
|
||||
|
||||
@ -1,8 +1,7 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta charset="utf-8">
|
||||
<!-- util.cpp -->
|
||||
<title>Util Class | ScreenPlay</title>
|
||||
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
|
||||
@ -22,7 +21,7 @@
|
||||
</div>
|
||||
<div class="sidebar-content" id="sidebar-content"></div></div>
|
||||
<h1 class="title">Util Class</h1>
|
||||
<span class="small-subtitle">(<a href="screenplay-util.html">ScreenPlay::Util</a>)<br/></span>
|
||||
<span class="small-subtitle">class <a href="screenplay.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 -->
|
||||
@ -47,11 +46,13 @@
|
||||
<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"> int </td><td class="memItemRight bottomAlign"><b><a href="screenplay-util.html#getVersionNumberFromString">getVersionNumberFromString</a></b>(<i>const QString &</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 &<i>context</i>, const QString &<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 &<i>url</i>) const</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="screenplay-util.html#openJsonFileToObject">openJsonFileToObject</a></b>(<i>const QString &</i>)</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="screenplay-util.html#openJsonFileToString">openJsonFileToString</a></b>(<i>const QString &</i>)</td></tr>
|
||||
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="screenplay-util.html#parseQByteArrayToQJsonObject">parseQByteArrayToQJsonObject</a></b>(<i>const QByteArray &</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#toString">toString</a></b>(const QStringList &<i>list</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 &<i>absoluteFilePath</i>, const QJsonObject &<i>object</i>, bool <i>truncate</i> = true)</td></tr>
|
||||
</table></div>
|
||||
<a name="signals"></a>
|
||||
@ -71,7 +72,7 @@
|
||||
<h2>Member Function Documentation</h2>
|
||||
<!-- $$$Util[overload1]$$$UtilQNetworkAccessManager*QObject* -->
|
||||
<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>
|
||||
<p>Constructor.</p>
|
||||
<!-- @@@Util -->
|
||||
<!-- $$$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> &<i>text</i>) const</h3>
|
||||
@ -98,17 +99,21 @@
|
||||
<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> &<i>context</i>, const <span class="type">QString</span> &<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>
|
||||
<!-- @@@logToGui -->
|
||||
<!-- $$$openFolderInExplorer[overload1]$$$openFolderInExplorerconstQString& -->
|
||||
<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> &<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">int</span> Util::<span class="name">openJsonFileToObject</span>(<i>const QString &</i>)</h3>
|
||||
<p>Opens a json file (absolute path) and tries to convert it to a QJsonObject. Return std::nullopt when not successful.</p>
|
||||
<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">int</span> Util::<span class="name">openJsonFileToString</span>(<i>const QString &</i>)</h3>
|
||||
<p>Opens a json file (absolute path) and tries to convert it to a QString. Return std::nullopt when not successful.</p>
|
||||
<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">int</span> Util::<span class="name">parseQByteArrayToQJsonObject</span>(<i>const QByteArray &</i>)</h3>
|
||||
<p>Opens a native folder window on the given path. Windows and Mac only for now!</p>
|
||||
<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>
|
||||
@ -118,6 +123,10 @@
|
||||
<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 -->
|
||||
<!-- $$$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> &<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><code>[static slot] </code><span class="type">bool</span> Util::<span class="name">writeJsonObjectToFile</span>(const <span class="type">QString</span> &<i>absoluteFilePath</i>, const <span class="type">QJsonObject</span> &<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>
|
||||
|
||||
@ -1,8 +1,7 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta charset="utf-8">
|
||||
<!-- app.cpp -->
|
||||
<title>ScreenPlay Namespace | ScreenPlay</title>
|
||||
<link rel="stylesheet" type="text/css" href="../css/style.css"/> <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"/>
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@ -98,6 +98,12 @@ App::App()
|
||||
m_isAnotherScreenPlayInstanceRunning = m_sdkConnector->m_isAnotherScreenPlayInstanceRunning;
|
||||
}
|
||||
|
||||
/*!
|
||||
\brief Used for initialization after the constructor. The sole purpose is to check if
|
||||
another ScreenPlay 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.
|
||||
*/
|
||||
void App::init()
|
||||
{
|
||||
// Util should be created as first so we redirect qDebugs etc. into the log
|
||||
@ -147,6 +153,9 @@ void App::init()
|
||||
m_mainWindowEngine->load(QUrl(QStringLiteral("qrc:/main.qml")));
|
||||
}
|
||||
|
||||
/*!
|
||||
\brief Tries to send the telemetry quit event before we call quit ourself.
|
||||
*/
|
||||
void App::exit()
|
||||
{
|
||||
if (!m_telemetry) {
|
||||
|
||||
@ -42,6 +42,9 @@ Create::Create()
|
||||
qmlRegisterType<Create>("ScreenPlay.Create", 1, 0, "Create");
|
||||
}
|
||||
|
||||
/*!
|
||||
\brief Creates a new widget.
|
||||
*/
|
||||
void Create::createWidget(const QString& localStoragePath, const QString& title, const QString& previewThumbnail, const QString& createdBy, const QString& license, const QString& type, const QVector<QString>& tags)
|
||||
{
|
||||
QtConcurrent::run([=]() {
|
||||
@ -127,6 +130,9 @@ void Create::createWidget(const QString& localStoragePath, const QString& title,
|
||||
});
|
||||
}
|
||||
|
||||
/*!
|
||||
\brief Creates a HTML wallpaper.
|
||||
*/
|
||||
void Create::createHTMLWallpaper(
|
||||
const QString& localStoragePath,
|
||||
const QString& title,
|
||||
@ -202,7 +208,7 @@ void Create::createHTMLWallpaper(
|
||||
}
|
||||
|
||||
/*!
|
||||
Starts the process.
|
||||
\brief Starts the process.
|
||||
*/
|
||||
void Create::createWallpaperStart(QString videoPath, Create::VideoCodec codec)
|
||||
{
|
||||
@ -248,7 +254,7 @@ void Create::createWallpaperStart(QString videoPath, Create::VideoCodec codec)
|
||||
}
|
||||
|
||||
/*!
|
||||
When converting of the wallpaper steps where successful.
|
||||
\brief When converting of the wallpaper steps where successful.
|
||||
*/
|
||||
void Create::saveWallpaper(QString title, QString description, QString filePath, QString previewImagePath, QString youtube, Create::VideoCodec codec, QVector<QString> tags)
|
||||
{
|
||||
@ -342,7 +348,9 @@ void Create::saveWallpaper(QString title, QString description, QString filePath,
|
||||
file.close();
|
||||
emit createWallpaperStateChanged(CreateImportVideo::ImportVideoState::CreateProjectFileFinished);
|
||||
}
|
||||
|
||||
/*!
|
||||
\brief .
|
||||
*/
|
||||
void Create::abortAndCleanup()
|
||||
{
|
||||
qWarning() << "Abort and Cleanup!";
|
||||
|
||||
@ -14,10 +14,10 @@ namespace ScreenPlay {
|
||||
*/
|
||||
|
||||
/*!
|
||||
This constructor is only needed for calling qRegisterMetaType on CreateImportVideo to register the enums.
|
||||
\code
|
||||
qRegisterMetaType<CreateImportVideo::ImportVideoState>("CreateImportVideo::ImportVideoState");
|
||||
\endcode
|
||||
\brief This constructor is only needed for calling qRegisterMetaType on CreateImportVideo to register the enums.
|
||||
\code
|
||||
qRegisterMetaType<CreateImportVideo::ImportVideoState>("CreateImportVideo::ImportVideoState");
|
||||
\endcode
|
||||
*/
|
||||
CreateImportVideo::CreateImportVideo(QObject* parent)
|
||||
: QObject(parent)
|
||||
@ -25,7 +25,7 @@ CreateImportVideo::CreateImportVideo(QObject* parent)
|
||||
}
|
||||
|
||||
/*!
|
||||
Creates a CreateImportVideo object to be used in a different thread. A \a videoPath and a \a exportPath are
|
||||
\brief Creates a CreateImportVideo object to be used in a different thread. A \a videoPath and a \a exportPath are
|
||||
needed for convertion.
|
||||
*/
|
||||
CreateImportVideo::CreateImportVideo(const QString& videoPath, const QString& exportPath, const QStringList& codecs, QObject* parent)
|
||||
@ -51,7 +51,7 @@ CreateImportVideo::CreateImportVideo(const QString& videoPath, const QString& ex
|
||||
}
|
||||
|
||||
/*!
|
||||
Processes the multiple steps of creating a wallpaper.
|
||||
\brief Processes the multiple steps of creating a wallpaper.
|
||||
\list 1
|
||||
\li createWallpaperInfo()
|
||||
\li createWallpaperImagePreview()
|
||||
@ -109,7 +109,7 @@ void CreateImportVideo::process()
|
||||
}
|
||||
|
||||
/*!
|
||||
Starts ffprobe and tries to parse the resulting json.
|
||||
\brief Starts ffprobe and tries to parse the resulting json.
|
||||
Returns \c false if :
|
||||
\list
|
||||
\li Parsing the output json of ffprobe fails.
|
||||
@ -257,7 +257,7 @@ bool CreateImportVideo::createWallpaperInfo()
|
||||
}
|
||||
|
||||
/*!
|
||||
Starts ffmpeg and tries to covert the given video to a five second preview.
|
||||
\brief Starts ffmpeg and tries to covert the given video to a five second preview.
|
||||
\code
|
||||
//[...]
|
||||
args.append("-vf");
|
||||
@ -339,7 +339,7 @@ bool CreateImportVideo::createWallpaperVideoPreview()
|
||||
}
|
||||
|
||||
/*!
|
||||
Starts ffmpeg and tries to covert the given video to a 5 second preview gif.
|
||||
\brief Starts ffmpeg and tries to covert the given video to a 5 second preview gif.
|
||||
\code
|
||||
//[...]
|
||||
args.append("-filter_complex");
|
||||
@ -390,7 +390,7 @@ bool CreateImportVideo::createWallpaperGifPreview()
|
||||
}
|
||||
|
||||
/*!
|
||||
Starts ffmpeg and tries to covert the given video to a image preview.
|
||||
\brief Starts ffmpeg and tries to covert the given video to a image preview.
|
||||
Returns \c false if :
|
||||
\list
|
||||
\li Cannot convert the video
|
||||
@ -454,6 +454,9 @@ bool CreateImportVideo::createWallpaperImageThumbnailPreview()
|
||||
return true;
|
||||
}
|
||||
|
||||
/*!
|
||||
\brief .
|
||||
*/
|
||||
bool CreateImportVideo::createWallpaperImagePreview()
|
||||
{
|
||||
|
||||
@ -508,7 +511,7 @@ bool CreateImportVideo::createWallpaperImagePreview()
|
||||
}
|
||||
|
||||
/*!
|
||||
Starts ffmpeg and tries to covert the given video to a webm video.
|
||||
\brief Starts ffmpeg and tries to covert the given video to a webm video.
|
||||
\code
|
||||
//[...]
|
||||
args.append("-c:v");
|
||||
@ -662,7 +665,7 @@ bool CreateImportVideo::createWallpaperVideo(const QString& codec)
|
||||
return true;
|
||||
}
|
||||
/*!
|
||||
Starts ffmpeg and tries to covert the given audio into a seperate mp3.
|
||||
\brief Starts ffmpeg and tries to covert the given audio into a seperate mp3.
|
||||
\code
|
||||
//[...]
|
||||
args.append("mp3");
|
||||
@ -719,6 +722,9 @@ bool CreateImportVideo::extractWallpaperAudio()
|
||||
return true;
|
||||
}
|
||||
|
||||
/*!
|
||||
\brief .
|
||||
*/
|
||||
void CreateImportVideo::waitForFinished(std::shared_ptr<QProcess>& process)
|
||||
{
|
||||
while (!process->waitForFinished(100)) //Wake up every 100ms and check if we must exit
|
||||
|
||||
@ -11,6 +11,8 @@ namespace ScreenPlay {
|
||||
\inmodule ScreenPlay
|
||||
\brief GlobalVariables.
|
||||
|
||||
A header only class used only for storing some global variables like localStoragePath.
|
||||
|
||||
*/
|
||||
|
||||
class GlobalVariables : public QObject {
|
||||
@ -29,26 +31,37 @@ public:
|
||||
setLocalSettingsPath(QUrl { QStandardPaths::writableLocation(QStandardPaths::DataLocation) });
|
||||
}
|
||||
|
||||
/*!
|
||||
\brief Returns the localStoragePath.
|
||||
*/
|
||||
QUrl localStoragePath() const
|
||||
{
|
||||
return m_localStoragePath;
|
||||
}
|
||||
|
||||
/*!
|
||||
\brief Returns the localSettingsPath.
|
||||
*/
|
||||
QUrl localSettingsPath() const
|
||||
{
|
||||
return m_localSettingsPath;
|
||||
}
|
||||
|
||||
/*!
|
||||
\brief Returns the wallpaperExecutablePath. This only differes in development builds.
|
||||
*/
|
||||
QUrl wallpaperExecutablePath() const
|
||||
{
|
||||
return m_wallpaperExecutablePath;
|
||||
}
|
||||
|
||||
/*!
|
||||
\brief Returns the widgetExecutablePath. This only differes in development builds.
|
||||
*/
|
||||
QUrl widgetExecutablePath() const
|
||||
{
|
||||
return m_widgetExecutablePath;
|
||||
}
|
||||
|
||||
/*!
|
||||
\brief Returns the current app version. Not yet used.
|
||||
*/
|
||||
QVersionNumber version() const
|
||||
{
|
||||
return m_version;
|
||||
|
||||
@ -11,9 +11,9 @@ namespace ScreenPlay {
|
||||
*/
|
||||
|
||||
/*!
|
||||
Sets the default role type to "All" to display all available content. Needs a given
|
||||
\brief Sets the default role type to "All" to display all available content. Needs a given
|
||||
\a ilm (InstalledListModel).
|
||||
*/
|
||||
*/
|
||||
InstalledListFilter::InstalledListFilter(const shared_ptr<InstalledListModel>& ilm)
|
||||
: QSortFilterProxyModel()
|
||||
, m_ilm(ilm)
|
||||
@ -24,14 +24,14 @@ InstalledListFilter::InstalledListFilter(const shared_ptr<InstalledListModel>& i
|
||||
}
|
||||
|
||||
/*!
|
||||
Set the filter proxy to sort by the given \a type. This can be
|
||||
\brief Set the filter proxy to sort by the given \a type. This can be:
|
||||
\list
|
||||
\li All
|
||||
\li Videos
|
||||
\li Widgets
|
||||
\li Scenes
|
||||
\endlist
|
||||
*/
|
||||
*/
|
||||
void InstalledListFilter::sortByRoleType(QString type)
|
||||
{
|
||||
if (type == "All") {
|
||||
@ -52,9 +52,9 @@ void InstalledListFilter::sortByRoleType(QString type)
|
||||
}
|
||||
|
||||
/*!
|
||||
Invoked when the user uses the quicksearch at the top right of the installed page.
|
||||
\brief Invoked when the user uses the quicksearch at the top right of the installed page.
|
||||
Uses the \a name to sort by name. This name is saved in the project.json title.
|
||||
*/
|
||||
*/
|
||||
void InstalledListFilter::sortByName(QString name)
|
||||
{
|
||||
setFilterRole(InstalledListModel::InstalledRole::TitleRole);
|
||||
@ -64,8 +64,8 @@ void InstalledListFilter::sortByName(QString name)
|
||||
}
|
||||
|
||||
/*!
|
||||
Resets the filter and sorts by title.
|
||||
*/
|
||||
\brief Resets the filter and sorts by title.
|
||||
*/
|
||||
void InstalledListFilter::resetFilter()
|
||||
{
|
||||
setFilterRole(InstalledListModel::InstalledRole::TitleRole);
|
||||
|
||||
@ -13,7 +13,7 @@ namespace ScreenPlay {
|
||||
*/
|
||||
|
||||
/*!
|
||||
Constructor
|
||||
\brief Constructor.
|
||||
*/
|
||||
InstalledListModel::InstalledListModel(
|
||||
const shared_ptr<GlobalVariables>& globalVariables,
|
||||
@ -26,7 +26,7 @@ InstalledListModel::InstalledListModel(
|
||||
}
|
||||
|
||||
/*!
|
||||
|
||||
\brief Init function that needs to be called after the constructor because we need the GlobalVariables to finish loading.
|
||||
*/
|
||||
void InstalledListModel::init()
|
||||
{
|
||||
@ -40,7 +40,7 @@ void InstalledListModel::init()
|
||||
}
|
||||
|
||||
/*!
|
||||
|
||||
\brief Returns the length of the installed items.
|
||||
*/
|
||||
int InstalledListModel::rowCount(const QModelIndex& parent) const
|
||||
{
|
||||
@ -51,7 +51,7 @@ int InstalledListModel::rowCount(const QModelIndex& parent) const
|
||||
}
|
||||
|
||||
/*!
|
||||
|
||||
\brief Retruns the data member of the ProjectFile.
|
||||
*/
|
||||
QVariant InstalledListModel::data(const QModelIndex& index, int role) const
|
||||
{
|
||||
@ -88,7 +88,7 @@ QVariant InstalledListModel::data(const QModelIndex& index, int role) const
|
||||
}
|
||||
|
||||
/*!
|
||||
|
||||
\brief Returns the variable names for QML.
|
||||
*/
|
||||
QHash<int, QByteArray> InstalledListModel::roleNames() const
|
||||
{
|
||||
|
||||
@ -18,7 +18,7 @@ namespace ScreenPlay {
|
||||
*/
|
||||
|
||||
/*!
|
||||
Constructor
|
||||
\brief Constructor.
|
||||
*/
|
||||
MonitorListModel::MonitorListModel(QObject* parent)
|
||||
: QAbstractListModel(parent)
|
||||
@ -30,6 +30,9 @@ MonitorListModel::MonitorListModel(QObject* parent)
|
||||
connect(guiAppInst, &QGuiApplication::screenRemoved, this, &MonitorListModel::screenRemoved);
|
||||
}
|
||||
|
||||
/*!
|
||||
\brief Returns the variable names for QML.
|
||||
*/
|
||||
QHash<int, QByteArray> MonitorListModel::roleNames() const
|
||||
{
|
||||
static const QHash<int, QByteArray> roles {
|
||||
@ -48,6 +51,10 @@ QHash<int, QByteArray> MonitorListModel::roleNames() const
|
||||
return roles;
|
||||
}
|
||||
|
||||
|
||||
/*!
|
||||
\brief Returns the amount of active monitors.
|
||||
*/
|
||||
int MonitorListModel::rowCount(const QModelIndex& parent) const
|
||||
{
|
||||
if (parent.isValid())
|
||||
@ -56,6 +63,9 @@ int MonitorListModel::rowCount(const QModelIndex& parent) const
|
||||
return m_monitorList.count();
|
||||
}
|
||||
|
||||
/*!
|
||||
\brief Retruns the data member of the Monitor.
|
||||
*/
|
||||
QVariant MonitorListModel::data(const QModelIndex& index, int role) const
|
||||
{
|
||||
if (!index.isValid())
|
||||
@ -113,6 +123,9 @@ QVariant MonitorListModel::data(const QModelIndex& index, int role) const
|
||||
return QVariant();
|
||||
}
|
||||
|
||||
/*!
|
||||
\brief Reloads the listmodel of monitors.
|
||||
*/
|
||||
void MonitorListModel::loadMonitors()
|
||||
{
|
||||
int offsetX = 0;
|
||||
@ -148,6 +161,9 @@ void MonitorListModel::loadMonitors()
|
||||
emit monitorReloadCompleted();
|
||||
}
|
||||
|
||||
/*!
|
||||
\brief Clears the listmodel.
|
||||
*/
|
||||
void MonitorListModel::clearActiveWallpaper()
|
||||
{
|
||||
int i { 0 };
|
||||
@ -163,6 +179,9 @@ void MonitorListModel::clearActiveWallpaper()
|
||||
}
|
||||
}
|
||||
|
||||
/*!
|
||||
\brief Removes the preview image and appID inside an monitor item.
|
||||
*/
|
||||
void MonitorListModel::closeWallpaper(const QString& appID)
|
||||
{
|
||||
int i {};
|
||||
@ -182,6 +201,9 @@ void MonitorListModel::closeWallpaper(const QString& appID)
|
||||
}
|
||||
}
|
||||
|
||||
/*!
|
||||
\brief Sets the previewImage and appID for a list item.
|
||||
*/
|
||||
void MonitorListModel::setWallpaperActiveMonitor(const std::shared_ptr<ScreenPlayWallpaper>& wallpaper, const QVector<int> monitors)
|
||||
{
|
||||
|
||||
@ -197,6 +219,9 @@ void MonitorListModel::setWallpaperActiveMonitor(const std::shared_ptr<ScreenPla
|
||||
}
|
||||
}
|
||||
|
||||
/*!
|
||||
\brief If successful this function returns an AppID. Otherwhise std::nullopt.
|
||||
*/
|
||||
std::optional<QString> MonitorListModel::getAppIDByMonitorIndex(const int index) const
|
||||
{
|
||||
for (auto& monitor : m_monitorList) {
|
||||
@ -207,6 +232,9 @@ std::optional<QString> MonitorListModel::getAppIDByMonitorIndex(const int index)
|
||||
return std::nullopt;
|
||||
}
|
||||
|
||||
/*!
|
||||
\brief Removes all items and loads them vida loadMonitors() again.
|
||||
*/
|
||||
void MonitorListModel::reset()
|
||||
{
|
||||
beginResetModel();
|
||||
|
||||
@ -12,7 +12,7 @@ namespace ScreenPlay {
|
||||
*/
|
||||
|
||||
/*!
|
||||
Constructor
|
||||
\brief Constructor-.
|
||||
*/
|
||||
ScreenPlayManager::ScreenPlayManager(
|
||||
const shared_ptr<GlobalVariables>& globalVariables,
|
||||
@ -32,11 +32,11 @@ ScreenPlayManager::ScreenPlayManager(
|
||||
}
|
||||
|
||||
/*!
|
||||
Creates a wallpaper with a given \a monitorIndex list, \a a absoluteStoragePath folder,
|
||||
\brief Creates a wallpaper with a given \a monitorIndex list, \a a absoluteStoragePath folder,
|
||||
a \a previewImage (relative path to the absoluteStoragePath), a default \a volume,
|
||||
a \a fillMode, a \a type (htmlWallpaper, qmlWallpaper etc.), a \a saveToProfilesConfigFile bool only set to flase
|
||||
if we call the method when using via the settings on startup to skip a unnecessary save.
|
||||
*/
|
||||
*/
|
||||
void ScreenPlayManager::createWallpaper(
|
||||
QVector<int> monitorIndex,
|
||||
const QString& absoluteStoragePath,
|
||||
@ -118,8 +118,8 @@ void ScreenPlayManager::createWallpaper(
|
||||
}
|
||||
|
||||
/*!
|
||||
Creates a ScreenPlayWidget object via a \a absoluteStoragePath and a \a preview image (relative path).
|
||||
*/
|
||||
\brief Creates a ScreenPlayWidget object via a \a absoluteStoragePath and a \a preview image (relative path).
|
||||
*/
|
||||
void ScreenPlayManager::createWidget(const QUrl& absoluteStoragePath, const QString& previewImage, const QString& type)
|
||||
{
|
||||
if (m_telemetry) {
|
||||
@ -138,7 +138,7 @@ void ScreenPlayManager::createWidget(const QUrl& absoluteStoragePath, const QStr
|
||||
}
|
||||
|
||||
/*!
|
||||
Removes all wallpaper entries in the profiles.json. This method will likely be removed
|
||||
\brief Removes all wallpaper entries in the profiles.json. This method will likely be removed
|
||||
when using nlohmann/json in the future.
|
||||
*/
|
||||
void ScreenPlayManager::removeAllWallpapers()
|
||||
@ -182,6 +182,9 @@ void ScreenPlayManager::removeAllWallpapers()
|
||||
}
|
||||
}
|
||||
|
||||
/*!
|
||||
\brief Removes all widgets and resets the activeWidgetCounter to 0.
|
||||
*/
|
||||
void ScreenPlayManager::removeAllWidgets()
|
||||
{
|
||||
if (!m_screenPlayWidgets.empty()) {
|
||||
@ -194,7 +197,7 @@ void ScreenPlayManager::removeAllWidgets()
|
||||
}
|
||||
|
||||
/*!
|
||||
Removes a Wallpaper at the given monitor \a at (index). Internally searches for a appID at the
|
||||
\brief Removes a Wallpaper at the given monitor \a at (index). Internally searches for a appID at the
|
||||
given monitor index and then closes the sdk connection, removes the entries in the
|
||||
monitor list model and decreases the active wallpaper counter property of ScreenPlayManager.
|
||||
*/
|
||||
@ -214,9 +217,8 @@ bool ScreenPlayManager::removeWallpaperAt(int at)
|
||||
}
|
||||
|
||||
/*!
|
||||
Request a spesific json profile to display in the active wallpaper popup on the right.
|
||||
|
||||
*/
|
||||
\brief Request a spesific json profile to display in the active wallpaper popup on the right.
|
||||
*/
|
||||
void ScreenPlayManager::requestProjectSettingsListModelAt(const int index)
|
||||
{
|
||||
for (const shared_ptr<ScreenPlayWallpaper>& uPtrWallpaper : qAsConst(m_screenPlayWallpapers)) {
|
||||
@ -231,8 +233,8 @@ void ScreenPlayManager::requestProjectSettingsListModelAt(const int index)
|
||||
}
|
||||
|
||||
/*!
|
||||
Set a wallpaper \a value at a given \a index and \a key.
|
||||
*/
|
||||
\brief Set a wallpaper \a value at a given \a index and \a key.
|
||||
*/
|
||||
void ScreenPlayManager::setWallpaperValue(const int index, const QString& key, const QString& value)
|
||||
{
|
||||
if (auto appID = m_monitorListModel->getAppIDByMonitorIndex(index)) {
|
||||
@ -245,8 +247,8 @@ void ScreenPlayManager::setWallpaperValue(const int index, const QString& key, c
|
||||
}
|
||||
|
||||
/*!
|
||||
Convenient function to set a \a value at a given \a index and \a key for all wallaper. For exmaple used to mute all wallpaper.
|
||||
*/
|
||||
\brief Convenient function to set a \a value at a given \a index and \a key for all wallaper. For exmaple used to mute all wallpaper.
|
||||
*/
|
||||
void ScreenPlayManager::setAllWallpaperValue(const QString& key, const QString& value)
|
||||
{
|
||||
for (const shared_ptr<ScreenPlayWallpaper>& uPtrWallpaper : qAsConst(m_screenPlayWallpapers)) {
|
||||
@ -255,8 +257,8 @@ void ScreenPlayManager::setAllWallpaperValue(const QString& key, const QString&
|
||||
}
|
||||
|
||||
/*!
|
||||
Returns \c a ScreenPlayWallpaper if successful, otherwhise \c std::nullopt.
|
||||
*/
|
||||
\brief Returns \c a ScreenPlayWallpaper if successful, otherwhise \c std::nullopt.
|
||||
*/
|
||||
std::optional<shared_ptr<ScreenPlayWallpaper>> ScreenPlayManager::getWallpaperByAppID(const QString& appID)
|
||||
{
|
||||
for (auto& wallpaper : m_screenPlayWallpapers) {
|
||||
@ -268,9 +270,9 @@ std::optional<shared_ptr<ScreenPlayWallpaper>> ScreenPlayManager::getWallpaperBy
|
||||
}
|
||||
|
||||
/*!
|
||||
Saves a given wallpaper \a newProfileObject to a \a profileName. We ignore the profileName argument
|
||||
\brief Saves a given wallpaper \a newProfileObject to a \a profileName. We ignore the profileName argument
|
||||
because we currently only support one profile. Returns \c true if successfuly saved to profiles.json, otherwise \c false.
|
||||
*/
|
||||
*/
|
||||
bool ScreenPlayManager::saveWallpaperProfile(const QString& profileName, const QJsonObject& newProfileObject)
|
||||
{
|
||||
// Remove when implementing profiles
|
||||
@ -323,8 +325,8 @@ bool ScreenPlayManager::saveWallpaperProfile(const QString& profileName, const Q
|
||||
}
|
||||
|
||||
/*!
|
||||
Loads all wallpaper from profiles.json when the version number matches and starts the available wallpaper
|
||||
*/
|
||||
\brief Loads all wallpaper from profiles.json when the version number matches and starts the available wallpaper
|
||||
*/
|
||||
void ScreenPlayManager::loadWallpaperProfiles()
|
||||
{
|
||||
|
||||
|
||||
@ -11,7 +11,7 @@ namespace ScreenPlay {
|
||||
*/
|
||||
|
||||
/*!
|
||||
Constructor for video Wallpaper.
|
||||
\brief Constructor for video Wallpaper.
|
||||
*/
|
||||
ScreenPlayWallpaper::ScreenPlayWallpaper(
|
||||
const QVector<int>& screenNumber,
|
||||
@ -68,13 +68,18 @@ ScreenPlayWallpaper::ScreenPlayWallpaper(
|
||||
m_process.startDetached();
|
||||
}
|
||||
|
||||
/*!
|
||||
\brief Prints the exit code if != 0.
|
||||
*/
|
||||
void ScreenPlayWallpaper::processExit(int exitCode, QProcess::ExitStatus exitStatus)
|
||||
{
|
||||
Q_UNUSED(exitStatus)
|
||||
if (exitCode != 0)
|
||||
qDebug() << "WARNING EXIT CODE: " << exitCode;
|
||||
}
|
||||
|
||||
/*!
|
||||
\brief Prints the exit code error.
|
||||
*/
|
||||
void ScreenPlayWallpaper::processError(QProcess::ProcessError error)
|
||||
{
|
||||
qDebug() << "EX: " << error;
|
||||
|
||||
@ -11,8 +11,7 @@ namespace ScreenPlay {
|
||||
*/
|
||||
|
||||
/*!
|
||||
|
||||
Constructor
|
||||
\brief Constructor.
|
||||
*/
|
||||
ScreenPlayWidget::ScreenPlayWidget(
|
||||
const QString& appID,
|
||||
|
||||
@ -13,8 +13,8 @@ namespace ScreenPlay {
|
||||
*/
|
||||
|
||||
/*!
|
||||
Starts the QLocalServer with the pipename ScreenPlay.
|
||||
*/
|
||||
\brief Starts the QLocalServer with the pipename ScreenPlay.
|
||||
*/
|
||||
SDKConnector::SDKConnector(QObject* parent)
|
||||
: QObject(parent)
|
||||
, m_server { make_unique<QLocalServer>() }
|
||||
@ -32,6 +32,11 @@ SDKConnector::SDKConnector(QObject* parent)
|
||||
}
|
||||
}
|
||||
|
||||
/*!
|
||||
\brief Checks if another ScreenPlay instance is running by trying to connect to a pipe
|
||||
with the name ScreenPlay.
|
||||
If successful we send a raise command and quit via m_isAnotherScreenPlayInstanceRunning = true.
|
||||
*/
|
||||
bool SDKConnector::isAnotherScreenPlayInstanceRunning()
|
||||
{
|
||||
QLocalSocket socket;
|
||||
@ -49,8 +54,9 @@ bool SDKConnector::isAnotherScreenPlayInstanceRunning()
|
||||
socket.close();
|
||||
return true;
|
||||
}
|
||||
|
||||
/*!
|
||||
Appends a new SDKConnection object shared_ptr to the m_clients list.
|
||||
\brief Appends a new SDKConnection object shared_ptr to the m_clients list.
|
||||
*/
|
||||
void SDKConnector::newConnection()
|
||||
{
|
||||
@ -62,7 +68,7 @@ void SDKConnector::newConnection()
|
||||
}
|
||||
|
||||
/*!
|
||||
Closes all m_clients connections and clears the QVector.
|
||||
\brief Closes all m_clients connections and clears the QVector.
|
||||
*/
|
||||
void SDKConnector::closeAllConnections()
|
||||
{
|
||||
@ -73,7 +79,7 @@ void SDKConnector::closeAllConnections()
|
||||
}
|
||||
|
||||
/*!
|
||||
Closes all wallpaper connection with the following type:
|
||||
\brief Closes all wallpaper connection with the following type:
|
||||
\list
|
||||
\li videoWallpaper
|
||||
\li qmlWallpaper
|
||||
@ -113,7 +119,7 @@ void SDKConnector::closeAllWidgets()
|
||||
}
|
||||
|
||||
/*!
|
||||
\brief SDKConnector::closeConntectionByType
|
||||
\brief Closes a connection by type. Used only by closeAllWidgets() and closeAllWallpapers()
|
||||
*/
|
||||
void SDKConnector::closeConntectionByType(const QStringList& list)
|
||||
{
|
||||
@ -147,7 +153,7 @@ void SDKConnector::closeWallpapersAt(int at)
|
||||
}
|
||||
|
||||
/*!
|
||||
\brief Closes a wallpaper by the given \a appID.
|
||||
\brief Closes a wallpaper by the given \a appID.
|
||||
*/
|
||||
void SDKConnector::closeWallpaper(const QString& appID)
|
||||
{
|
||||
|
||||
@ -21,11 +21,10 @@ namespace ScreenPlay {
|
||||
*/
|
||||
|
||||
/*!
|
||||
Constructor and sets up:
|
||||
\brief Constructor and sets up:
|
||||
\list 1
|
||||
\li Sets the git build hash via ScreenPlay.pro c++ define
|
||||
\li Checks the langauge via settings or system and available ones and installes a translator.
|
||||
\li Checks the paths for config folders in appdata
|
||||
\li Checks the AbsoluteStoragePath.
|
||||
\li Checks regisitry for steam plugin settings
|
||||
\li Parses autostart, anonymousTelemetry, highPriorityStart
|
||||
@ -115,7 +114,7 @@ Settings::Settings(const shared_ptr<GlobalVariables>& globalVariables,
|
||||
}
|
||||
|
||||
/*!
|
||||
Writes the default JsonFile from the resources and the given \a filename. Currently we have two default json files:
|
||||
\brief Writes the default JsonFile from the resources and the given \a filename. Currently we have two default json files:
|
||||
\list
|
||||
\li profiles.json
|
||||
\li settings.json
|
||||
@ -139,7 +138,7 @@ void Settings::writeJsonFileFromResource(const QString& filename)
|
||||
}
|
||||
|
||||
/*!
|
||||
To have a better developer experience we check if we use a debug version. Then we assume
|
||||
\brief To have a better developer experience we check if we use a debug version. Then we assume
|
||||
That the paths are the default QtCreator paths and set the widgets and wallpaper executable
|
||||
paths accordingly.
|
||||
*/
|
||||
@ -197,7 +196,7 @@ void Settings::setupWidgetAndWindowPaths()
|
||||
}
|
||||
|
||||
/*!
|
||||
When no default language is set in the registry we check the system set language. If there is no
|
||||
\brief When no default language is set in the registry we check the system set language. If there is no
|
||||
matching translation is available we set it to english. This function gets called from the UI when
|
||||
the user manually changes the language.
|
||||
*/
|
||||
@ -211,6 +210,10 @@ void Settings::restoreDefault(const QString& appConfigLocation, const QString& s
|
||||
writeJsonFileFromResource(settingsFileType);
|
||||
}
|
||||
|
||||
/*!
|
||||
\brief Checks if there is already a saved language. If not we try to use the system langauge.
|
||||
If we do not support the system language we use english.
|
||||
*/
|
||||
void Settings::setupLanguage()
|
||||
{
|
||||
QString langCode;
|
||||
@ -234,6 +237,11 @@ void Settings::setupLanguage()
|
||||
retranslateUI();
|
||||
}
|
||||
|
||||
/*!
|
||||
\brief Check for supported langauges. If we use a langauge that not uses
|
||||
latin characters, we change the font. For example this happens for korean user. We ship google
|
||||
Noto Sans CJK KR Regular for this..
|
||||
*/
|
||||
bool Settings::retranslateUI()
|
||||
{
|
||||
auto* app = static_cast<QGuiApplication*>(QGuiApplication::instance());
|
||||
|
||||
@ -9,7 +9,7 @@ namespace ScreenPlay {
|
||||
*/
|
||||
|
||||
/*!
|
||||
Constructor
|
||||
\brief Constructor.
|
||||
*/
|
||||
Util::Util(QNetworkAccessManager* networkAccessManager, QObject* parent)
|
||||
: QObject(parent)
|
||||
@ -45,7 +45,7 @@ Util::Util(QNetworkAccessManager* networkAccessManager, QObject* parent)
|
||||
}
|
||||
|
||||
/*!
|
||||
Copies the given string to the clipboard.
|
||||
\brief Copies the given string to the clipboard.
|
||||
*/
|
||||
void Util::copyToClipboard(const QString& text) const
|
||||
{
|
||||
@ -54,8 +54,8 @@ void Util::copyToClipboard(const QString& text) const
|
||||
}
|
||||
|
||||
/*!
|
||||
Opens a json file (absolute path) and tries to convert it to a QJsonObject.
|
||||
Return std::nullopt when not successful.
|
||||
\brief Opens a json file (absolute path) and tries to convert it to a QJsonObject.
|
||||
Returns std::nullopt when not successful.
|
||||
*/
|
||||
std::optional<QJsonObject> Util::openJsonFileToObject(const QString& path)
|
||||
{
|
||||
@ -78,8 +78,8 @@ std::optional<QJsonObject> Util::openJsonFileToObject(const QString& path)
|
||||
}
|
||||
|
||||
/*!
|
||||
Opens a json file (absolute path) and tries to convert it to a QString.
|
||||
Return std::nullopt when not successful.
|
||||
\brief Opens a json file (absolute path) and tries to convert it to a QString.
|
||||
Returns std::nullopt when not successful.
|
||||
*/
|
||||
std::optional<QString> Util::openJsonFileToString(const QString& path)
|
||||
{
|
||||
@ -96,7 +96,7 @@ std::optional<QString> Util::openJsonFileToString(const QString& path)
|
||||
}
|
||||
|
||||
/*!
|
||||
Generates a (non secure) random string with the default length of 32. Can contain:
|
||||
\brief Generates a (non secure) random string with the default length of 32. Can contain:
|
||||
\list
|
||||
\li A-Z
|
||||
\li a-z
|
||||
@ -120,7 +120,7 @@ QString Util::generateRandomString(quint32 length)
|
||||
}
|
||||
|
||||
/*!
|
||||
Parses a version from a given QString. The QString must be looke like this:
|
||||
\brief Parses a version from a given QString. The QString must be looke like this:
|
||||
1.0.0 - Major.Minor.Patch. A fixed position is used for parsing (at 0,2,4).
|
||||
Return std::nullopt when not successful.
|
||||
*/
|
||||
@ -143,7 +143,7 @@ std::optional<QVersionNumber> Util::getVersionNumberFromString(const QString& st
|
||||
}
|
||||
|
||||
/*!
|
||||
Writes a given QJsonObject to a file. The path must be absolute. When truncate is set to
|
||||
\brief 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.
|
||||
*/
|
||||
bool Util::writeJsonObjectToFile(const QString& absoluteFilePath, const QJsonObject& object, bool truncate)
|
||||
@ -168,6 +168,9 @@ bool Util::writeJsonObjectToFile(const QString& absoluteFilePath, const QJsonObj
|
||||
return true;
|
||||
}
|
||||
|
||||
/*!
|
||||
\brief Helper function to append a QStringList into a QString with a space between the items.
|
||||
*/
|
||||
QString Util::toString(const QStringList& list)
|
||||
{
|
||||
QString out;
|
||||
@ -177,13 +180,8 @@ QString Util::toString(const QStringList& list)
|
||||
return out;
|
||||
}
|
||||
|
||||
QString Util::fixWindowsPath(QString url)
|
||||
{
|
||||
return url.replace("/", "\\\\");
|
||||
}
|
||||
|
||||
/*!
|
||||
Opens a native folder window on the given path. Windows and Mac only for now!
|
||||
\brief Parses a QByteArray to a QJsonObject. If returns and std::nullopt on failure.
|
||||
*/
|
||||
std::optional<QJsonObject> Util::parseQByteArrayToQJsonObject(const QByteArray& byteArray)
|
||||
{
|
||||
@ -199,6 +197,9 @@ std::optional<QJsonObject> Util::parseQByteArrayToQJsonObject(const QByteArray&
|
||||
return std::nullopt;
|
||||
}
|
||||
|
||||
/*!
|
||||
\brief Opens a native folder window on the given path. Windows and Mac only for now!
|
||||
*/
|
||||
void Util::openFolderInExplorer(const QString& url) const
|
||||
{
|
||||
QString fileString { "file:///" };
|
||||
@ -223,10 +224,8 @@ void Util::openFolderInExplorer(const QString& url) const
|
||||
explorer.startDetached();
|
||||
}
|
||||
|
||||
|
||||
|
||||
/*!
|
||||
Loads all content of the legal folder in the qrc into a property string of this class.
|
||||
\brief Loads all content of the legal folder in the qrc into a property string of this class.
|
||||
allLicenseLoaded is emited when loading is finished.
|
||||
*/
|
||||
void Util::Util::requestAllLicenses()
|
||||
@ -272,7 +271,7 @@ void Util::Util::requestAllLicenses()
|
||||
}
|
||||
|
||||
/*!
|
||||
Loads all dataprotection of the legal folder in the qrc into a property string of this class.
|
||||
\brief Loads all dataprotection of the legal folder in the qrc into a property string of this class.
|
||||
allDataProtectionLoaded is emited when loading is finished.
|
||||
*/
|
||||
void Util::Util::requestDataProtection()
|
||||
@ -292,7 +291,7 @@ void Util::Util::requestDataProtection()
|
||||
}
|
||||
|
||||
/*!
|
||||
Downloads and extracts ffmpeg static version from https://ffmpeg.zeranoe.com
|
||||
\brief Downloads and extracts ffmpeg static version from https://ffmpeg.zeranoe.com
|
||||
The progress is tracked via setAquireFFMPEGStatus(AquireFFMPEGStatus);
|
||||
*/
|
||||
void Util::downloadFFMPEG()
|
||||
@ -380,7 +379,7 @@ void Util::downloadFFMPEG()
|
||||
}
|
||||
|
||||
/*!
|
||||
Basic logging to the GUI. No logging is done to a log file for now. This string can be copied
|
||||
\brief 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.
|
||||
*/
|
||||
void Util::logToGui(QtMsgType type, const QMessageLogContext& context, const QString& msg)
|
||||
@ -417,7 +416,7 @@ void Util::logToGui(QtMsgType type, const QMessageLogContext& context, const QSt
|
||||
}
|
||||
|
||||
/*!
|
||||
Convenient function for the ffmpeg download extraction via libzippp. Extracts a given bytearray
|
||||
\brief Convenient function for the ffmpeg download extraction via libzippp. Extracts a given bytearray
|
||||
to a given absolute file path and file name. Returns false if extraction or saving wasn't successful.
|
||||
*/
|
||||
bool Util::saveExtractedByteArray(libzippp::ZipEntry& entry, std::string& absolutePathAndName)
|
||||
|
||||
@ -90,7 +90,6 @@ public slots:
|
||||
|
||||
void downloadFFMPEG();
|
||||
|
||||
QString fixWindowsPath(QString url);
|
||||
static std::optional<QJsonObject> parseQByteArrayToQJsonObject(const QByteArray& byteArray);
|
||||
static std::optional<QJsonObject> openJsonFileToObject(const QString& path);
|
||||
static std::optional<QString> openJsonFileToString(const QString& path);
|
||||
|
||||
Loading…
Reference in New Issue
Block a user