--- a/eric6/Documentation/Source/eric6.E5Gui.E5SingleApplication.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.E5Gui.E5SingleApplication.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,225 +18,301 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<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>SAOpenMultiProject</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> +</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 /> +<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> +</tr> +<tr> <td><a href="#E5SingleApplicationClient.__openFile">__openFile</a></td> <td>Private method to open a file in the application server.</td> -</tr><tr> +</tr> +<tr> <td><a href="#E5SingleApplicationClient.__openMultiProject">__openMultiProject</a></td> <td>Private method to open a project in the application server.</td> -</tr><tr> +</tr> +<tr> <td><a href="#E5SingleApplicationClient.__openProject">__openProject</a></td> <td>Private method to open a project in the application server.</td> -</tr><tr> +</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> +</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> +</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> +</p> +<dl> + <dt><i>fname</i></dt> <dd> name of file to be opened (string) </dd> -</dl><a NAME="E5SingleApplicationClient.__openMultiProject" ID="E5SingleApplicationClient.__openMultiProject"></a> +</dl> +<a NAME="E5SingleApplicationClient.__openMultiProject" ID="E5SingleApplicationClient.__openMultiProject"></a> <h4>E5SingleApplicationClient.__openMultiProject</h4> <b>__openMultiProject</b>(<i>pfname</i>) + <p> Private method to open a project in the application server. -</p><dl> +</p> +<dl> + <dt><i>pfname</i></dt> <dd> name of the projectfile to be opened (string) </dd> -</dl><a NAME="E5SingleApplicationClient.__openProject" ID="E5SingleApplicationClient.__openProject"></a> +</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> +</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> +</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> +</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> +</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> +</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 /> +<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> +</tr> +<tr> <td><a href="#E5SingleApplicationServer.__saArguments">__saArguments</a></td> <td>Private method used to handle the "Arguments" command.</td> -</tr><tr> +</tr> +<tr> <td><a href="#E5SingleApplicationServer.__saOpenFile">__saOpenFile</a></td> <td>Private method used to handle the "Open File" command.</td> -</tr><tr> +</tr> +<tr> <td><a href="#E5SingleApplicationServer.__saOpenMultiProject">__saOpenMultiProject</a></td> <td>Private method used to handle the "Open Multi-Project" command.</td> -</tr><tr> +</tr> +<tr> <td><a href="#E5SingleApplicationServer.__saOpenProject">__saOpenProject</a></td> <td>Private method used to handle the "Open Project" command.</td> -</tr><tr> +</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> +</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> +</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> +</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> +</p> +<dl> + <dt><i>fname</i></dt> <dd> filename to be opened (string) </dd> -</dl><a NAME="E5SingleApplicationServer.__saOpenMultiProject" ID="E5SingleApplicationServer.__saOpenMultiProject"></a> +</dl> +<a NAME="E5SingleApplicationServer.__saOpenMultiProject" ID="E5SingleApplicationServer.__saOpenMultiProject"></a> <h4>E5SingleApplicationServer.__saOpenMultiProject</h4> <b>__saOpenMultiProject</b>(<i>pfname</i>) + <p> Private method used to handle the "Open Multi-Project" command. -</p><dl> +</p> +<dl> + <dt><i>pfname</i></dt> <dd> filename of the multi project to be opened (string) </dd> -</dl><a NAME="E5SingleApplicationServer.__saOpenProject" ID="E5SingleApplicationServer.__saOpenProject"></a> +</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> +</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> +</dl> +<a NAME="E5SingleApplicationServer.handleCommand" ID="E5SingleApplicationServer.handleCommand"></a> <h4>E5SingleApplicationServer.handleCommand</h4> <b>handleCommand</b>(<i>command, arguments</i>) + <p> Public slot to handle the command sent by the client. -</p><dl> +</p> +<dl> + <dt><i>command</i> (str)</dt> <dd> command sent by the client -</dd><dt><i>arguments</i> (list of str)</dt> +</dd> +<dt><i>arguments</i> (list of str)</dt> <dd> list of command arguments </dd>