Documentation/Source/eric6.Helpviewer.HelpSingleApplication.html

<!DOCTYPE html>
<html><head>
<title>eric6.Helpviewer.HelpSingleApplication</title>
<meta charset="UTF-8">
<style>
body {
    background: #EDECE6;
    margin: 0em 1em 10em 1em;
    color: black;
}

h1 { color: white; background: #85774A; }
h2 { color: white; background: #85774A; }
h3 { color: white; background: #9D936E; }
h4 { color: white; background: #9D936E; }
    
a { color: #BA6D36; }

</style>
</head>
<body><a NAME="top" ID="top"></a>
<h1>eric6.Helpviewer.HelpSingleApplication</h1>
<p>
Module implementing the single application server and client for the web
browser.
</p>
<h3>Global Attributes</h3>
<table>
<tr><td>SAFile</td></tr><tr><td>SALoadUrl</td></tr><tr><td>SANewTab</td></tr><tr><td>SASearch</td></tr><tr><td>SAShutdown</td></tr>
</table>
<h3>Classes</h3>
<table>
<tr>
<td><a href="#HelpSingleApplicationClient">HelpSingleApplicationClient</a></td>
<td>Class implementing the single application client of the help viewer.</td>
</tr><tr>
<td><a href="#HelpSingleApplicationServer">HelpSingleApplicationServer</a></td>
<td>Class implementing the single application server embedded within the Help viewer.</td>
</tr>
</table>
<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>
<hr /><hr />
<a NAME="HelpSingleApplicationClient" ID="HelpSingleApplicationClient"></a>
<h2>HelpSingleApplicationClient</h2>
<p>
    Class implementing the single application client of the help viewer.
</p>
<h3>Derived from</h3>
SingleApplicationClient
<h3>Class Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Class Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>
<table>
<tr>
<td><a href="#HelpSingleApplicationClient.__init__">HelpSingleApplicationClient</a></td>
<td>Constructor</td>
</tr><tr>
<td><a href="#HelpSingleApplicationClient.__loadUrl">__loadUrl</a></td>
<td>Private method to send an URL to be loaded.</td>
</tr><tr>
<td><a href="#HelpSingleApplicationClient.__newTab">__newTab</a></td>
<td>Private method to send an URL to be loaded in a new tab.</td>
</tr><tr>
<td><a href="#HelpSingleApplicationClient.__search">__search</a></td>
<td>Private method to send a word to search for.</td>
</tr><tr>
<td><a href="#HelpSingleApplicationClient.__shutdown">__shutdown</a></td>
<td>Private method to signal a shutdown request to the browser.</td>
</tr><tr>
<td><a href="#HelpSingleApplicationClient.processArgs">processArgs</a></td>
<td>Public method to process the command line args passed to the UI.</td>
</tr>
</table>
<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<a NAME="HelpSingleApplicationClient.__init__" ID="HelpSingleApplicationClient.__init__"></a>
<h4>HelpSingleApplicationClient (Constructor)</h4>
<b>HelpSingleApplicationClient</b>(<i>name=""</i>)
<p>
        Constructor
</p><dl>
<dt><i>name</i> (str)</dt>
<dd>
name to be used by the single application server
</dd>
</dl><a NAME="HelpSingleApplicationClient.__loadUrl" ID="HelpSingleApplicationClient.__loadUrl"></a>
<h4>HelpSingleApplicationClient.__loadUrl</h4>
<b>__loadUrl</b>(<i>url</i>)
<p>
        Private method to send an URL to be loaded.
</p><dl>
<dt><i>url</i> (str)</dt>
<dd>
URL to be loaded
</dd>
</dl><a NAME="HelpSingleApplicationClient.__newTab" ID="HelpSingleApplicationClient.__newTab"></a>
<h4>HelpSingleApplicationClient.__newTab</h4>
<b>__newTab</b>(<i>url</i>)
<p>
        Private method to send an URL to be loaded in a new tab.
</p><dl>
<dt><i>url</i> (str)</dt>
<dd>
URL to be loaded
</dd>
</dl><a NAME="HelpSingleApplicationClient.__search" ID="HelpSingleApplicationClient.__search"></a>
<h4>HelpSingleApplicationClient.__search</h4>
<b>__search</b>(<i>word</i>)
<p>
        Private method to send a word to search for.
</p><dl>
<dt><i>word</i> (str)</dt>
<dd>
to to be searched for
</dd>
</dl><a NAME="HelpSingleApplicationClient.__shutdown" ID="HelpSingleApplicationClient.__shutdown"></a>
<h4>HelpSingleApplicationClient.__shutdown</h4>
<b>__shutdown</b>(<i></i>)
<p>
        Private method to signal a shutdown request to the browser.
</p><a NAME="HelpSingleApplicationClient.processArgs" ID="HelpSingleApplicationClient.processArgs"></a>
<h4>HelpSingleApplicationClient.processArgs</h4>
<b>processArgs</b>(<i>args, disconnect=True</i>)
<p>
        Public method to process the command line args passed to the UI.
</p><dl>
<dt><i>args</i> (list of str)</dt>
<dd>
list of command line arguments
</dd><dt><i>disconnect</i> (bool)</dt>
<dd>
flag indicating to disconnect when done
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr /><hr />
<a NAME="HelpSingleApplicationServer" ID="HelpSingleApplicationServer"></a>
<h2>HelpSingleApplicationServer</h2>
<p>
    Class implementing the single application server embedded within the
    Help viewer.
</p><h3>Signals</h3>
<dl>
<dt>loadUrl(str)</dt>
<dd>
emitted to load an URL
</dd><dt>newTab(str)</dt>
<dd>
emitted to load an URL in a new tab
</dd><dt>search(str)</dt>
<dd>
emitted to search for a given word
</dd><dt>shutdown()</dt>
<dd>
emitted to shut down the browser
</dd>
</dl>
<h3>Derived from</h3>
SingleApplicationServer
<h3>Class Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Class Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>
<table>
<tr>
<td><a href="#HelpSingleApplicationServer.__init__">HelpSingleApplicationServer</a></td>
<td>Constructor</td>
</tr><tr>
<td><a href="#HelpSingleApplicationServer.__saLoadUrl">__saLoadUrl</a></td>
<td>Private method to load an URL in a new tab.</td>
</tr><tr>
<td><a href="#HelpSingleApplicationServer.__saNewTab">__saNewTab</a></td>
<td>Private method to load an URL .</td>
</tr><tr>
<td><a href="#HelpSingleApplicationServer.__saSearch">__saSearch</a></td>
<td>Private method to search for a given word.</td>
</tr><tr>
<td><a href="#HelpSingleApplicationServer.__saShutdown">__saShutdown</a></td>
<td>Private method to shut down the web browser.</td>
</tr><tr>
<td><a href="#HelpSingleApplicationServer.handleCommand">handleCommand</a></td>
<td>Public slot to handle the command sent by the client.</td>
</tr>
</table>
<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<a NAME="HelpSingleApplicationServer.__init__" ID="HelpSingleApplicationServer.__init__"></a>
<h4>HelpSingleApplicationServer (Constructor)</h4>
<b>HelpSingleApplicationServer</b>(<i>name=""</i>)
<p>
        Constructor
</p><dl>
<dt><i>name</i> (str)</dt>
<dd>
name to be used by the single application server
</dd>
</dl><a NAME="HelpSingleApplicationServer.__saLoadUrl" ID="HelpSingleApplicationServer.__saLoadUrl"></a>
<h4>HelpSingleApplicationServer.__saLoadUrl</h4>
<b>__saLoadUrl</b>(<i>url</i>)
<p>
        Private method to load an URL in a new tab.
</p><dl>
<dt><i>url</i> (str)</dt>
<dd>
URL to be loaded
</dd>
</dl><a NAME="HelpSingleApplicationServer.__saNewTab" ID="HelpSingleApplicationServer.__saNewTab"></a>
<h4>HelpSingleApplicationServer.__saNewTab</h4>
<b>__saNewTab</b>(<i>url</i>)
<p>
        Private method to load an URL .
</p><dl>
<dt><i>url</i> (str)</dt>
<dd>
URL to be loaded
</dd>
</dl><a NAME="HelpSingleApplicationServer.__saSearch" ID="HelpSingleApplicationServer.__saSearch"></a>
<h4>HelpSingleApplicationServer.__saSearch</h4>
<b>__saSearch</b>(<i>word</i>)
<p>
        Private method to search for a given word.
</p><dl>
<dt><i>word</i> (str)</dt>
<dd>
word to be searched for
</dd>
</dl><a NAME="HelpSingleApplicationServer.__saShutdown" ID="HelpSingleApplicationServer.__saShutdown"></a>
<h4>HelpSingleApplicationServer.__saShutdown</h4>
<b>__saShutdown</b>(<i></i>)
<p>
        Private method to shut down the web browser.
</p><a NAME="HelpSingleApplicationServer.handleCommand" ID="HelpSingleApplicationServer.handleCommand"></a>
<h4>HelpSingleApplicationServer.handleCommand</h4>
<b>handleCommand</b>(<i>command, arguments</i>)
<p>
        Public slot to handle the command sent by the client.
</p><dl>
<dt><i>command</i> (str)</dt>
<dd>
command sent by the client
</dd><dt><i>arguments</i> (list of str)</dt>
<dd>
list of command arguments
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>