mirror of
https://gitlab.com/kelteseth/ScreenPlay.git
synced 2024-11-09 20:42:47 +01:00
87 lines
8.7 KiB
HTML
87 lines
8.7 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<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"/>
|
|
</head>
|
|
<body>
|
|
<div class="container-fullwidth nav sticky-top"><div class="container navWrapper"><a href="../index.html"><span class="logo">ScreenPlay Generated Docs </span></a><span class="navHome"><a href="../index.html">Home</a></span></div></div> <div id= mainWrapper class="wrapper container ">
|
|
<li>ScreenPlayWidget</li>
|
|
<div class="sidebar">
|
|
<div class="toc">
|
|
<h3><a name="toc">Contents</a></h3>
|
|
<ul>
|
|
<li class="level1"><a href="#public-functions">Public Functions</a></li>
|
|
<li class="level1"><a href="#public-slots">Public Slots</a></li>
|
|
<li class="level1"><a href="#signals">Signals</a></li>
|
|
<li class="level1"><a href="#details">Detailed Description</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="sidebar-content" id="sidebar-content"></div></div>
|
|
<h1 class="title">ScreenPlayWidget Class</h1>
|
|
<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 -->
|
|
<div class="table"><table class="alignedsummary">
|
|
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <ScreenPlayWidget></span>
|
|
</td></tr></table></div><ul>
|
|
<li><a href="screenplay-screenplaywidget-members.html">List of all members, including inherited members</a></li>
|
|
</ul>
|
|
<a name="public-functions"></a>
|
|
<h2 id="public-functions">Public Functions</h2>
|
|
<div class="table"><table class="alignedsummary">
|
|
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaywidget.html#ScreenPlayWidget">ScreenPlayWidget</a></b>(const QString &<i>appID</i>, const std::shared_ptr<GlobalVariables> &<i>globalVariables</i>, const QPoint &<i>position</i>, const QString &<i>absolutePath</i>, const QString &<i>previewImage</i>, const QJsonObject &<i>properties</i>, const InstalledType::InstalledType <i>type</i>)</td></tr>
|
|
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaywidget.html#absolutePath-prop">absolutePath</a></b>() const</td></tr>
|
|
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaywidget.html#appID-prop">appID</a></b>() const</td></tr>
|
|
<tr><td class="memItemLeft rightAlign topAlign"> QPoint </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaywidget.html#position-prop">position</a></b>() const</td></tr>
|
|
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaywidget.html#previewImage-prop">previewImage</a></b>() const</td></tr>
|
|
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaywidget.html#setSDKConnection">setSDKConnection</a></b>(const std::shared_ptr<SDKConnection> &<i>connection</i>)</td></tr>
|
|
<tr><td class="memItemLeft rightAlign topAlign"> InstalledType::InstalledType </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaywidget.html#type-prop">type</a></b>() const</td></tr>
|
|
</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"> QJsonObject </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaywidget.html#getActiveSettingsJson">getActiveSettingsJson</a></b>()</td></tr>
|
|
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaywidget.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-screenplaywidget.html#appID-prop">setAppID</a></b>(QString <i>appID</i>)</td></tr>
|
|
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaywidget.html#position-prop">setPosition</a></b>(QPoint <i>position</i>)</td></tr>
|
|
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaywidget.html#previewImage-prop">setPreviewImage</a></b>(QString <i>previewImage</i>)</td></tr>
|
|
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaywidget.html#type-prop">setType</a></b>(InstalledType::InstalledType <i>type</i>)</td></tr>
|
|
</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-screenplaywidget.html#absolutePath-prop">absolutePathChanged</a></b>(QString <i>absolutePath</i>)</td></tr>
|
|
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaywidget.html#appID-prop">appIDChanged</a></b>(QString <i>appID</i>)</td></tr>
|
|
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaywidget.html#position-prop">positionChanged</a></b>(QPoint <i>position</i>)</td></tr>
|
|
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaywidget.html#previewImage-prop">previewImageChanged</a></b>(QString <i>previewImage</i>)</td></tr>
|
|
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-screenplaywidget.html#type-prop">typeChanged</a></b>(InstalledType::InstalledType <i>type</i>)</td></tr>
|
|
</table></div>
|
|
<a name="details"></a>
|
|
<!-- $$$ScreenPlayWidget-description -->
|
|
<div class="descr">
|
|
<h2 id="details">Detailed Description</h2>
|
|
<p>This class is only for managing the QProcess to an extern ScreenPlayWidget!</p>
|
|
</div>
|
|
<!-- @@@ScreenPlayWidget -->
|
|
<div class="func">
|
|
<h2>Member Function Documentation</h2>
|
|
<!-- $$$ScreenPlayWidget[overload1]$$$ScreenPlayWidgetconstQString&conststd::shared_ptr<GlobalVariables>&constQPoint&constQString&constQString&constQJsonObject&constInstalledType::InstalledType -->
|
|
<h3 class="fn" id="ScreenPlayWidget"><a name="ScreenPlayWidget"></a>ScreenPlayWidget::<span class="name">ScreenPlayWidget</span>(const <span class="type">QString</span> &<i>appID</i>, const <span class="type">std::shared_ptr</span><<span class="type"><a href="screenplay-globalvariables.html">GlobalVariables</a></span>> &<i>globalVariables</i>, const <span class="type">QPoint</span> &<i>position</i>, const <span class="type">QString</span> &<i>absolutePath</i>, const <span class="type">QString</span> &<i>previewImage</i>, const <span class="type">QJsonObject</span> &<i>properties</i>, const <span class="type">InstalledType::InstalledType</span> <i>type</i>)</h3>
|
|
<p>Constructs a ScreenPlayWidget</p>
|
|
<!-- @@@ScreenPlayWidget -->
|
|
<!-- $$$getActiveSettingsJson[overload1]$$$getActiveSettingsJson -->
|
|
<h3 class="fn" id="getActiveSettingsJson"><a name="getActiveSettingsJson"></a><code>[slot] </code><span class="type">QJsonObject</span> ScreenPlayWidget::<span class="name">getActiveSettingsJson</span>()</h3>
|
|
<p>Loads the project.json content.</p>
|
|
<!-- @@@getActiveSettingsJson -->
|
|
<!-- $$$setSDKConnection[overload1]$$$setSDKConnectionconststd::shared_ptr<SDKConnection>& -->
|
|
<h3 class="fn" id="setSDKConnection"><a name="setSDKConnection"></a><span class="type">void</span> ScreenPlayWidget::<span class="name">setSDKConnection</span>(const <span class="type">std::shared_ptr</span><<span class="type"><a href="screenplay-sdkconnection.html">SDKConnection</a></span>> &<i>connection</i>)</h3>
|
|
<p>Connects to <a href="screenplay.html">ScreenPlay</a>. Start a alive ping check for every 16 seconds.</p>
|
|
<!-- @@@setSDKConnection -->
|
|
</div>
|
|
<div id= license class="footer center"><p>This documentation is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a>.</p></div> <script src="../js/bootstrap.bundle.min.js"></script> <script src="../js/mermaid.min.js"></script> <script>var config = {startOnLoad:true,flowchart:{useMaxWidth:true,htmlLabels:true}};mermaid.initialize(config);</script></body>
|
|
</html>
|