Documentation/Source/eric6.E5Gui.E5SingleApplication.html

changeset 3673
e26d7d0c1088
child 4107
501c964e20e7
diff -r f0cb7579c0b4 -r e26d7d0c1088 Documentation/Source/eric6.E5Gui.E5SingleApplication.html
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric6.E5Gui.E5SingleApplication.html	Sat Jul 05 12:29:15 2014 +0200
@@ -0,0 +1,220 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric6.E5Gui.E5SingleApplication</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.E5Gui.E5SingleApplication</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="#E5SingleApplicationClient">E5SingleApplicationClient</a></td>
+<td>Class implementing the single application client of the IDE.</td>
+</tr><tr>
+<td><a href="#E5SingleApplicationServer">E5SingleApplicationServer</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="E5SingleApplicationClient" ID="E5SingleApplicationClient"></a>
+<h2>E5SingleApplicationClient</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>Class Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#E5SingleApplicationClient.__init__">E5SingleApplicationClient</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#E5SingleApplicationClient.__openFile">__openFile</a></td>
+<td>Private method to open a file in the application server.</td>
+</tr><tr>
+<td><a href="#E5SingleApplicationClient.__openProject">__openProject</a></td>
+<td>Private method to open a project in the application server.</td>
+</tr><tr>
+<td><a href="#E5SingleApplicationClient.__sendArguments">__sendArguments</a></td>
+<td>Private method to set the command arguments in the application server.</td>
+</tr><tr>
+<td><a href="#E5SingleApplicationClient.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="E5SingleApplicationClient.__init__" ID="E5SingleApplicationClient.__init__"></a>
+<h4>E5SingleApplicationClient (Constructor)</h4>
+<b>E5SingleApplicationClient</b>(<i></i>)
+<p>
+        Constructor
+</p><a NAME="E5SingleApplicationClient.__openFile" ID="E5SingleApplicationClient.__openFile"></a>
+<h4>E5SingleApplicationClient.__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="E5SingleApplicationClient.__openProject" ID="E5SingleApplicationClient.__openProject"></a>
+<h4>E5SingleApplicationClient.__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="E5SingleApplicationClient.__sendArguments" ID="E5SingleApplicationClient.__sendArguments"></a>
+<h4>E5SingleApplicationClient.__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="E5SingleApplicationClient.processArgs" ID="E5SingleApplicationClient.processArgs"></a>
+<h4>E5SingleApplicationClient.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="E5SingleApplicationServer" ID="E5SingleApplicationServer"></a>
+<h2>E5SingleApplicationServer</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>Class Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#E5SingleApplicationServer.__init__">E5SingleApplicationServer</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#E5SingleApplicationServer.__saArguments">__saArguments</a></td>
+<td>Private method used to handle the "Arguments" command.</td>
+</tr><tr>
+<td><a href="#E5SingleApplicationServer.__saOpenFile">__saOpenFile</a></td>
+<td>Private method used to handle the "Open File" command.</td>
+</tr><tr>
+<td><a href="#E5SingleApplicationServer.__saOpenProject">__saOpenProject</a></td>
+<td>Private method used to handle the "Open Project" command.</td>
+</tr><tr>
+<td><a href="#E5SingleApplicationServer.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="E5SingleApplicationServer.__init__" ID="E5SingleApplicationServer.__init__"></a>
+<h4>E5SingleApplicationServer (Constructor)</h4>
+<b>E5SingleApplicationServer</b>(<i></i>)
+<p>
+        Constructor
+</p><a NAME="E5SingleApplicationServer.__saArguments" ID="E5SingleApplicationServer.__saArguments"></a>
+<h4>E5SingleApplicationServer.__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="E5SingleApplicationServer.__saOpenFile" ID="E5SingleApplicationServer.__saOpenFile"></a>
+<h4>E5SingleApplicationServer.__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="E5SingleApplicationServer.__saOpenProject" ID="E5SingleApplicationServer.__saOpenProject"></a>
+<h4>E5SingleApplicationServer.__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="E5SingleApplicationServer.handleCommand" ID="E5SingleApplicationServer.handleCommand"></a>
+<h4>E5SingleApplicationServer.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>
\ No newline at end of file

eric ide

mercurial