mirror of
https://gitlab.com/kelteseth/ScreenPlay.git
synced 2024-11-25 20:22:39 +01:00
f9d2c9ca1b
Change Qt version to 5.15 for better qdoc analysis Remove no longer used fixWindowsPath function
108 lines
8.7 KiB
HTML
108 lines
8.7 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<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"/>
|
|
</head>
|
|
<body>
|
|
<div class="container-fullwidth nav"><div class="container navWrapper"><a href="../index.html"><span class="logo">ScreenPlay Generated Docs </span></a><span class="navHome"><a href="../index.html">Home</a></span></div></div> <div id= mainWrapper class="wrapper container ">
|
|
<li>SDKConnector</li>
|
|
<div class="sidebar">
|
|
<div class="toc">
|
|
<h3><a name="toc">Contents</a></h3>
|
|
<ul>
|
|
<li class="level1"><a href="#public-functions">Public Functions</a></li>
|
|
<li class="level1"><a href="#public-slots">Public Slots</a></li>
|
|
<li class="level1"><a href="#details">Detailed Description</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="sidebar-content" id="sidebar-content"></div></div>
|
|
<h1 class="title">SDKConnector Class</h1>
|
|
<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 -->
|
|
<div class="table"><table class="alignedsummary">
|
|
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <SDKConnector></span>
|
|
</td></tr></table></div><ul>
|
|
<li><a href="screenplay-sdkconnector-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-sdkconnector.html#SDKConnector">SDKConnector</a></b>(QObject *<i>parent</i> = nullptr)</td></tr>
|
|
</table></div>
|
|
<a name="public-slots"></a>
|
|
<h2 id="public-slots">Public Slots</h2>
|
|
<div class="table"><table class="alignedsummary">
|
|
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="screenplay-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#setWallpaperValue">setWallpaperValue</a></b>(QString <i>appID</i>, QString <i>key</i>, QString <i>value</i>)</td></tr>
|
|
</table></div>
|
|
<a name="details"></a>
|
|
<!-- $$$SDKConnector-description -->
|
|
<div class="descr">
|
|
<h2 id="details">Detailed Description</h2>
|
|
<p>To deal with crashes in faulty widgets and wallpaper we open an external application. The communication is done via the ScreenPlaySDK subproject. To identify a incomming connection we use the appID. When a new connection is established we save the QLocalSocket and wait for the first message. If the message contains "appID=MyUniqueKeyA-Z_a-z_0-9,type=qmlWallpaper" we cant map the socket to a wallpaper/widget.</p>
|
|
</div>
|
|
<!-- @@@SDKConnector -->
|
|
<div class="func">
|
|
<h2>Member Function Documentation</h2>
|
|
<!-- $$$SDKConnector[overload1]$$$SDKConnectorQObject* -->
|
|
<h3 class="fn" id="SDKConnector"><a name="SDKConnector"></a>SDKConnector::<span class="name">SDKConnector</span>(<span class="type">QObject</span> *<i>parent</i> = nullptr)</h3>
|
|
<p>Starts the QLocalServer with the pipename <a href="screenplay.html">ScreenPlay</a>.</p>
|
|
<!-- @@@SDKConnector -->
|
|
<!-- $$$closeAllConnections[overload1]$$$closeAllConnections -->
|
|
<h3 class="fn" id="closeAllConnections"><a name="closeAllConnections"></a><code>[slot] </code><span class="type">void</span> SDKConnector::<span class="name">closeAllConnections</span>()</h3>
|
|
<p>Closes all m_clients connections and clears the QVector.</p>
|
|
<!-- @@@closeAllConnections -->
|
|
<!-- $$$closeAllWallpapers[overload1]$$$closeAllWallpapers -->
|
|
<h3 class="fn" id="closeAllWallpapers"><a name="closeAllWallpapers"></a><code>[slot] </code><span class="type">void</span> SDKConnector::<span class="name">closeAllWallpapers</span>()</h3>
|
|
<p>Closes all wallpaper connection with the following type:</p>
|
|
<ul>
|
|
<li>videoWallpaper</li>
|
|
<li>qmlWallpaper</li>
|
|
<li>htmlWallpaper</li>
|
|
<li>godotWallpaper</li>
|
|
</ul>
|
|
<!-- @@@closeAllWallpapers -->
|
|
<!-- $$$closeAllWidgets[overload1]$$$closeAllWidgets -->
|
|
<h3 class="fn" id="closeAllWidgets"><a name="closeAllWidgets"></a><code>[slot] </code><span class="type">void</span> 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>
|
|
<!-- @@@closeWallpaper -->
|
|
<!-- $$$closeWallpapersAt[overload1]$$$closeWallpapersAtint -->
|
|
<h3 class="fn" id="closeWallpapersAt"><a name="closeWallpapersAt"></a><code>[slot] </code><span class="type">void</span> SDKConnector::<span class="name">closeWallpapersAt</span>(<span class="type">int</span> <i>at</i>)</h3>
|
|
<p>Closes a wallpaper at the given <i>index</i>. The native monitor index is used here. On Windows the monitor 0 is the main display.</p>
|
|
<!-- @@@closeWallpapersAt -->
|
|
<!-- $$$newConnection[overload1]$$$newConnection -->
|
|
<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 -->
|
|
<!-- $$$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>
|
|
<!-- @@@setWallpaperValue -->
|
|
</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>
|