--- a/Documentation/Source/eric5.Utilities.SingleApplication.html Thu Jan 14 17:27:31 2010 +0000 +++ b/Documentation/Source/eric5.Utilities.SingleApplication.html Thu Jan 14 18:35:52 2010 +0000 @@ -22,7 +22,7 @@ <body><a NAME="top" ID="top"></a> <h1>eric5.Utilities.SingleApplication</h1> <p> -Module implementing the single application server and client. +Module implementing the single application server and client. </p> <h3>Global Attributes</h3> <table> @@ -32,10 +32,10 @@ <table> <tr> <td><a href="#SingleApplicationClient">SingleApplicationClient</a></td> -<td>Class implementing the single application client base class.</td> +<td>Class implementing the single application client base class.</td> </tr><tr> <td><a href="#SingleApplicationServer">SingleApplicationServer</a></td> -<td>Class implementing the single application server base class.</td> +<td>Class implementing the single application server base class.</td> </tr> </table> <h3>Functions</h3> @@ -46,7 +46,7 @@ <a NAME="SingleApplicationClient" ID="SingleApplicationClient"></a> <h2>SingleApplicationClient</h2> <p> - Class implementing the single application client base class. + Class implementing the single application client base class. </p> <h3>Derived from</h3> object @@ -58,84 +58,84 @@ <table> <tr> <td><a href="#SingleApplicationClient.__init__">SingleApplicationClient</a></td> -<td>Constructor</td> +<td>Constructor</td> </tr><tr> <td><a href="#SingleApplicationClient.connect">connect</a></td> -<td>Public method to connect the single application client to its server.</td> +<td>Public method to connect the single application client to its server.</td> </tr><tr> <td><a href="#SingleApplicationClient.disconnect">disconnect</a></td> -<td>Public method to disconnect from the Single Appliocation server.</td> +<td>Public method to disconnect from the Single Appliocation server.</td> </tr><tr> <td><a href="#SingleApplicationClient.errstr">errstr</a></td> -<td>Public method to return a meaningful error string for the last error.</td> +<td>Public method to return a meaningful error string for the last error.</td> </tr><tr> <td><a href="#SingleApplicationClient.processArgs">processArgs</a></td> -<td>Public method to process the command line args passed to the UI.</td> +<td>Public method to process the command line args passed to the UI.</td> </tr><tr> <td><a href="#SingleApplicationClient.sendCommand">sendCommand</a></td> -<td>Public method to send the command to the application server.</td> +<td>Public method to send the command to the application server.</td> </tr> </table> <a NAME="SingleApplicationClient.__init__" ID="SingleApplicationClient.__init__"></a> <h4>SingleApplicationClient (Constructor)</h4> <b>SingleApplicationClient</b>(<i>name</i>) <p> - Constructor + Constructor </p><dl> <dt><i>name</i></dt> <dd> -name of the local server to connect to (string) +name of the local server to connect to (string) </dd> </dl><a NAME="SingleApplicationClient.connect" ID="SingleApplicationClient.connect"></a> <h4>SingleApplicationClient.connect</h4> <b>connect</b>(<i></i>) <p> - Public method to connect the single application client to its server. + Public method to connect the single application client to its server. </p><dl> <dt>Returns:</dt> <dd> -value indicating success or an error number. Value is one of: - <table> - <tr><td>0</td><td>No application is running</td></tr> - <tr><td>1</td><td>Application is already running</td></tr> - </table> +value indicating success or an error number. Value is one of: + <table> + <tr><td>0</td><td>No application is running</td></tr> + <tr><td>1</td><td>Application is already running</td></tr> + </table> </dd> </dl><a NAME="SingleApplicationClient.disconnect" ID="SingleApplicationClient.disconnect"></a> <h4>SingleApplicationClient.disconnect</h4> <b>disconnect</b>(<i></i>) <p> - Public method to disconnect from the Single Appliocation server. + Public method to disconnect from the Single Appliocation server. </p><a NAME="SingleApplicationClient.errstr" ID="SingleApplicationClient.errstr"></a> <h4>SingleApplicationClient.errstr</h4> <b>errstr</b>(<i></i>) <p> - Public method to return a meaningful error string for the last error. + Public method to return a meaningful error string for the last error. </p><dl> <dt>Returns:</dt> <dd> -error string for the last error (string) +error string for the last error (string) </dd> </dl><a NAME="SingleApplicationClient.processArgs" ID="SingleApplicationClient.processArgs"></a> <h4>SingleApplicationClient.processArgs</h4> <b>processArgs</b>(<i>args</i>) <p> - Public method to process the command line args passed to the UI. + Public method to process the command line args passed to the UI. </p><p> - <b>Note</b>: This method must be overridden by subclasses. + <b>Note</b>: This method must be overridden by subclasses. </p><dl> <dt><i>args</i></dt> <dd> -command line args (list of strings) +command line args (list of strings) </dd> </dl><a NAME="SingleApplicationClient.sendCommand" ID="SingleApplicationClient.sendCommand"></a> <h4>SingleApplicationClient.sendCommand</h4> <b>sendCommand</b>(<i>cmd</i>) <p> - Public method to send the command to the application server. + Public method to send the command to the application server. </p><dl> <dt><i>cmd</i></dt> <dd> -command to be sent (string) +command to be sent (string) </dd> </dl> <div align="right"><a href="#top">Up</a></div> @@ -143,7 +143,7 @@ <a NAME="SingleApplicationServer" ID="SingleApplicationServer"></a> <h2>SingleApplicationServer</h2> <p> - Class implementing the single application server base class. + Class implementing the single application server base class. </p> <h3>Derived from</h3> QLocalServer @@ -155,69 +155,69 @@ <table> <tr> <td><a href="#SingleApplicationServer.__init__">SingleApplicationServer</a></td> -<td>Constructor</td> +<td>Constructor</td> </tr><tr> <td><a href="#SingleApplicationServer.__disconnected">__disconnected</a></td> -<td>Private method to handle the closure of the socket.</td> +<td>Private method to handle the closure of the socket.</td> </tr><tr> <td><a href="#SingleApplicationServer.__newConnection">__newConnection</a></td> -<td>Private slot to handle a new connection.</td> +<td>Private slot to handle a new connection.</td> </tr><tr> <td><a href="#SingleApplicationServer.__parseLine">__parseLine</a></td> -<td>Private method to handle data from the client.</td> +<td>Private method to handle data from the client.</td> </tr><tr> <td><a href="#SingleApplicationServer.handleCommand">handleCommand</a></td> -<td>Public slot to handle the command sent by the client.</td> +<td>Public slot to handle the command sent by the client.</td> </tr><tr> <td><a href="#SingleApplicationServer.shutdown">shutdown</a></td> -<td>Public method used to shut down the server.</td> +<td>Public method used to shut down the server.</td> </tr> </table> <a NAME="SingleApplicationServer.__init__" ID="SingleApplicationServer.__init__"></a> <h4>SingleApplicationServer (Constructor)</h4> <b>SingleApplicationServer</b>(<i>name</i>) <p> - Constructor + Constructor </p><dl> <dt><i>name</i></dt> <dd> -name this server is listening to (string) +name this server is listening to (string) </dd> </dl><a NAME="SingleApplicationServer.__disconnected" ID="SingleApplicationServer.__disconnected"></a> <h4>SingleApplicationServer.__disconnected</h4> <b>__disconnected</b>(<i></i>) <p> - Private method to handle the closure of the socket. + Private method to handle the closure of the socket. </p><a NAME="SingleApplicationServer.__newConnection" ID="SingleApplicationServer.__newConnection"></a> <h4>SingleApplicationServer.__newConnection</h4> <b>__newConnection</b>(<i></i>) <p> - Private slot to handle a new connection. + Private slot to handle a new connection. </p><a NAME="SingleApplicationServer.__parseLine" ID="SingleApplicationServer.__parseLine"></a> <h4>SingleApplicationServer.__parseLine</h4> <b>__parseLine</b>(<i></i>) <p> - Private method to handle data from the client. + Private method to handle data from the client. </p><a NAME="SingleApplicationServer.handleCommand" ID="SingleApplicationServer.handleCommand"></a> <h4>SingleApplicationServer.handleCommand</h4> <b>handleCommand</b>(<i>cmd, params</i>) <p> - Public slot to handle the command sent by the client. + Public slot to handle the command sent by the client. </p><p> - <b>Note</b>: This method must be overridden by subclasses. + <b>Note</b>: This method must be overridden by subclasses. </p><dl> <dt><i>cmd</i></dt> <dd> -commandstring (string) +commandstring (string) </dd><dt><i>params</i></dt> <dd> -parameterstring (string) +parameterstring (string) </dd> </dl><a NAME="SingleApplicationServer.shutdown" ID="SingleApplicationServer.shutdown"></a> <h4>SingleApplicationServer.shutdown</h4> <b>shutdown</b>(<i></i>) <p> - Public method used to shut down the server. + Public method used to shut down the server. </p> <div align="right"><a href="#top">Up</a></div> <hr />