Documentation/Source/eric4.E4Gui.E4SingleApplication.html

Mon, 28 Dec 2009 16:18:43 +0000

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Mon, 28 Dec 2009 16:18:43 +0000
changeset 3
0d9daebf5b8c
permissions
-rw-r--r--

Added documentation set.

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
<html><head>
<title>eric4.E4Gui.E4SingleApplication</title>
<style>
body {
    background:white;
    margin: 0em 1em 10em 1em;
    color: black;
}

h1 { color: white; background: #4FA4FF; }
h2 { color: white; background: #4FA4FF; }
h3 { color: white; background: #00557F; }
h4 { color: white; background: #00557F; }
    
a { color: #AA5500; }

</style>
</head>
<body><a NAME="top" ID="top"></a>
<h1>eric4.E4Gui.E4SingleApplication</h1>
<p>
Module implementing the single application server and client.
</p>
<h3>Global Attributes</h3>
<table>
<tr><td>SAArguments</td></tr><tr><td>SAFile</td></tr><tr><td>SAOpenFile</td></tr><tr><td>SAOpenProject</td></tr>
</table>
<h3>Classes</h3>
<table>
<tr>
<td><a href="#E4SingleApplicationClient">E4SingleApplicationClient</a></td>
<td>Class implementing the single application client of the IDE.</td>
</tr><tr>
<td><a href="#E4SingleApplicationServer">E4SingleApplicationServer</a></td>
<td>Class implementing the single application server embedded within the IDE.</td>
</tr>
</table>
<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>
<hr /><hr />
<a NAME="E4SingleApplicationClient" ID="E4SingleApplicationClient"></a>
<h2>E4SingleApplicationClient</h2>
<p>
    Class implementing the single application client of the IDE.
</p>
<h3>Derived from</h3>
SingleApplicationClient
<h3>Class Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>
<table>
<tr>
<td><a href="#E4SingleApplicationClient.__init__">E4SingleApplicationClient</a></td>
<td>Constructor</td>
</tr><tr>
<td><a href="#E4SingleApplicationClient.__openFile">__openFile</a></td>
<td>Private method to open a file in the application server.</td>
</tr><tr>
<td><a href="#E4SingleApplicationClient.__openProject">__openProject</a></td>
<td>Private method to open a project in the application server.</td>
</tr><tr>
<td><a href="#E4SingleApplicationClient.__sendArguments">__sendArguments</a></td>
<td>Private method to set the command arguments in the application server.</td>
</tr><tr>
<td><a href="#E4SingleApplicationClient.processArgs">processArgs</a></td>
<td>Public method to process the command line args passed to the UI.</td>
</tr>
</table>
<a NAME="E4SingleApplicationClient.__init__" ID="E4SingleApplicationClient.__init__"></a>
<h4>E4SingleApplicationClient (Constructor)</h4>
<b>E4SingleApplicationClient</b>(<i></i>)
<p>
        Constructor
</p><a NAME="E4SingleApplicationClient.__openFile" ID="E4SingleApplicationClient.__openFile"></a>
<h4>E4SingleApplicationClient.__openFile</h4>
<b>__openFile</b>(<i>fname</i>)
<p>
        Private method to open a file in the application server.
</p><dl>
<dt><i>fname</i></dt>
<dd>
name of file to be opened (string)
</dd>
</dl><a NAME="E4SingleApplicationClient.__openProject" ID="E4SingleApplicationClient.__openProject"></a>
<h4>E4SingleApplicationClient.__openProject</h4>
<b>__openProject</b>(<i>pfname</i>)
<p>
        Private method to open a project in the application server.
</p><dl>
<dt><i>pfname</i></dt>
<dd>
name of the projectfile to be opened (string)
</dd>
</dl><a NAME="E4SingleApplicationClient.__sendArguments" ID="E4SingleApplicationClient.__sendArguments"></a>
<h4>E4SingleApplicationClient.__sendArguments</h4>
<b>__sendArguments</b>(<i>argsStr</i>)
<p>
        Private method to set the command arguments in the application server.
</p><dl>
<dt><i>argsStr</i></dt>
<dd>
space delimited list of command args (string)
</dd>
</dl><a NAME="E4SingleApplicationClient.processArgs" ID="E4SingleApplicationClient.processArgs"></a>
<h4>E4SingleApplicationClient.processArgs</h4>
<b>processArgs</b>(<i>args</i>)
<p>
        Public method to process the command line args passed to the UI.
</p><dl>
<dt><i>args</i></dt>
<dd>
list of files to open
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr /><hr />
<a NAME="E4SingleApplicationServer" ID="E4SingleApplicationServer"></a>
<h2>E4SingleApplicationServer</h2>
<p>
    Class implementing the single application server embedded within the IDE.
</p>
<h3>Derived from</h3>
SingleApplicationServer
<h3>Class Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>
<table>
<tr>
<td><a href="#E4SingleApplicationServer.__init__">E4SingleApplicationServer</a></td>
<td>Constructor</td>
</tr><tr>
<td><a href="#E4SingleApplicationServer.__saArguments">__saArguments</a></td>
<td>Private method used to handle the "Arguments" command.</td>
</tr><tr>
<td><a href="#E4SingleApplicationServer.__saOpenFile">__saOpenFile</a></td>
<td>Private method used to handle the "Open File" command.</td>
</tr><tr>
<td><a href="#E4SingleApplicationServer.__saOpenProject">__saOpenProject</a></td>
<td>Private method used to handle the "Open Project" command.</td>
</tr><tr>
<td><a href="#E4SingleApplicationServer.handleCommand">handleCommand</a></td>
<td>Public slot to handle the command sent by the client.</td>
</tr>
</table>
<a NAME="E4SingleApplicationServer.__init__" ID="E4SingleApplicationServer.__init__"></a>
<h4>E4SingleApplicationServer (Constructor)</h4>
<b>E4SingleApplicationServer</b>(<i></i>)
<p>
        Constructor
</p><a NAME="E4SingleApplicationServer.__saArguments" ID="E4SingleApplicationServer.__saArguments"></a>
<h4>E4SingleApplicationServer.__saArguments</h4>
<b>__saArguments</b>(<i>argsStr</i>)
<p>
        Private method used to handle the "Arguments" command.
</p><dl>
<dt><i>argsStr</i></dt>
<dd>
space delimited list of command args(string)
</dd>
</dl><a NAME="E4SingleApplicationServer.__saOpenFile" ID="E4SingleApplicationServer.__saOpenFile"></a>
<h4>E4SingleApplicationServer.__saOpenFile</h4>
<b>__saOpenFile</b>(<i>fname</i>)
<p>
        Private method used to handle the "Open File" command.
</p><dl>
<dt><i>fname</i></dt>
<dd>
filename to be opened (string)
</dd>
</dl><a NAME="E4SingleApplicationServer.__saOpenProject" ID="E4SingleApplicationServer.__saOpenProject"></a>
<h4>E4SingleApplicationServer.__saOpenProject</h4>
<b>__saOpenProject</b>(<i>pfname</i>)
<p>
        Private method used to handle the "Open Project" command.
</p><dl>
<dt><i>pfname</i></dt>
<dd>
filename of the project to be opened (string)
</dd>
</dl><a NAME="E4SingleApplicationServer.handleCommand" ID="E4SingleApplicationServer.handleCommand"></a>
<h4>E4SingleApplicationServer.handleCommand</h4>
<b>handleCommand</b>(<i>cmd, params</i>)
<p>
        Public slot to handle the command sent by the client.
</p><dl>
<dt><i>cmd</i></dt>
<dd>
commandstring (string)
</dd><dt><i>params</i></dt>
<dd>
parameterstring (string)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>

eric ide

mercurial