--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/eric7/Documentation/Source/eric7.EricWidgets.EricSingleApplication.html Thu Jul 07 11:23:56 2022 +0200 @@ -0,0 +1,308 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.EricWidgets.EricSingleApplication</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.EricWidgets.EricSingleApplication</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="#EricSingleApplicationClient">EricSingleApplicationClient</a></td> +<td>Class implementing the single application client of the IDE.</td> +</tr> +<tr> +<td><a href="#EricSingleApplicationServer">EricSingleApplicationServer</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="EricSingleApplicationClient" ID="EricSingleApplicationClient"></a> +<h2>EricSingleApplicationClient</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="#EricSingleApplicationClient.__init__">EricSingleApplicationClient</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#EricSingleApplicationClient.__openFile">__openFile</a></td> +<td>Private method to open a file in the application server.</td> +</tr> +<tr> +<td><a href="#EricSingleApplicationClient.__openMultiProject">__openMultiProject</a></td> +<td>Private method to open a project in the application server.</td> +</tr> +<tr> +<td><a href="#EricSingleApplicationClient.__openProject">__openProject</a></td> +<td>Private method to open a project in the application server.</td> +</tr> +<tr> +<td><a href="#EricSingleApplicationClient.__sendArguments">__sendArguments</a></td> +<td>Private method to set the command arguments in the application server.</td> +</tr> +<tr> +<td><a href="#EricSingleApplicationClient.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="EricSingleApplicationClient.__init__" ID="EricSingleApplicationClient.__init__"></a> +<h4>EricSingleApplicationClient (Constructor)</h4> +<b>EricSingleApplicationClient</b>(<i></i>) + +<p> + Constructor +</p> +<a NAME="EricSingleApplicationClient.__openFile" ID="EricSingleApplicationClient.__openFile"></a> +<h4>EricSingleApplicationClient.__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="EricSingleApplicationClient.__openMultiProject" ID="EricSingleApplicationClient.__openMultiProject"></a> +<h4>EricSingleApplicationClient.__openMultiProject</h4> +<b>__openMultiProject</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="EricSingleApplicationClient.__openProject" ID="EricSingleApplicationClient.__openProject"></a> +<h4>EricSingleApplicationClient.__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="EricSingleApplicationClient.__sendArguments" ID="EricSingleApplicationClient.__sendArguments"></a> +<h4>EricSingleApplicationClient.__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="EricSingleApplicationClient.processArgs" ID="EricSingleApplicationClient.processArgs"></a> +<h4>EricSingleApplicationClient.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="EricSingleApplicationServer" ID="EricSingleApplicationServer"></a> +<h2>EricSingleApplicationServer</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="#EricSingleApplicationServer.__init__">EricSingleApplicationServer</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#EricSingleApplicationServer.__saArguments">__saArguments</a></td> +<td>Private method used to handle the "Arguments" command.</td> +</tr> +<tr> +<td><a href="#EricSingleApplicationServer.__saOpenFile">__saOpenFile</a></td> +<td>Private method used to handle the "Open File" command.</td> +</tr> +<tr> +<td><a href="#EricSingleApplicationServer.__saOpenMultiProject">__saOpenMultiProject</a></td> +<td>Private method used to handle the "Open Multi-Project" command.</td> +</tr> +<tr> +<td><a href="#EricSingleApplicationServer.__saOpenProject">__saOpenProject</a></td> +<td>Private method used to handle the "Open Project" command.</td> +</tr> +<tr> +<td><a href="#EricSingleApplicationServer.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="EricSingleApplicationServer.__init__" ID="EricSingleApplicationServer.__init__"></a> +<h4>EricSingleApplicationServer (Constructor)</h4> +<b>EricSingleApplicationServer</b>(<i></i>) + +<p> + Constructor +</p> +<a NAME="EricSingleApplicationServer.__saArguments" ID="EricSingleApplicationServer.__saArguments"></a> +<h4>EricSingleApplicationServer.__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="EricSingleApplicationServer.__saOpenFile" ID="EricSingleApplicationServer.__saOpenFile"></a> +<h4>EricSingleApplicationServer.__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="EricSingleApplicationServer.__saOpenMultiProject" ID="EricSingleApplicationServer.__saOpenMultiProject"></a> +<h4>EricSingleApplicationServer.__saOpenMultiProject</h4> +<b>__saOpenMultiProject</b>(<i>pfname</i>) + +<p> + Private method used to handle the "Open Multi-Project" command. +</p> +<dl> + +<dt><i>pfname</i></dt> +<dd> +filename of the multi project to be opened (string) +</dd> +</dl> +<a NAME="EricSingleApplicationServer.__saOpenProject" ID="EricSingleApplicationServer.__saOpenProject"></a> +<h4>EricSingleApplicationServer.__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="EricSingleApplicationServer.handleCommand" ID="EricSingleApplicationServer.handleCommand"></a> +<h4>EricSingleApplicationServer.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> \ No newline at end of file