|
1 <?xml version="1.0" encoding="utf-8"?> |
|
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' |
|
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> |
|
4 <html><head> |
|
5 <title>eric5.E4Gui.E4SingleApplication</title> |
|
6 <style> |
|
7 b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' |
|
8 </style> |
|
9 </head> |
|
10 <body><a NAME="top" ID="top"></a> |
|
11 <h1>eric5.E4Gui.E4SingleApplication</h1> |
|
12 <p> |
|
13 Module implementing the single application server and client. |
|
14 </p> |
|
15 <h3>Global Attributes</h3> |
|
16 <table> |
|
17 <tr><td>SAArguments</td></tr><tr><td>SAFile</td></tr><tr><td>SAOpenFile</td></tr><tr><td>SAOpenProject</td></tr> |
|
18 </table> |
|
19 <h3>Classes</h3> |
|
20 <table> |
|
21 <tr> |
|
22 <td><a href="#E4SingleApplicationClient">E4SingleApplicationClient</a></td> |
|
23 <td>Class implementing the single application client of the IDE.</td> |
|
24 </tr><tr> |
|
25 <td><a href="#E4SingleApplicationServer">E4SingleApplicationServer</a></td> |
|
26 <td>Class implementing the single application server embedded within the IDE.</td> |
|
27 </tr> |
|
28 </table> |
|
29 <h3>Functions</h3> |
|
30 <table> |
|
31 <tr><td>None</td></tr> |
|
32 </table> |
|
33 <hr /><hr /> |
|
34 <a NAME="E4SingleApplicationClient" ID="E4SingleApplicationClient"></a> |
|
35 <h2>E4SingleApplicationClient</h2> |
|
36 <p> |
|
37 Class implementing the single application client of the IDE. |
|
38 </p> |
|
39 <h3>Derived from</h3> |
|
40 SingleApplicationClient |
|
41 <h3>Class Attributes</h3> |
|
42 <table> |
|
43 <tr><td>None</td></tr> |
|
44 </table> |
|
45 <h3>Methods</h3> |
|
46 <table> |
|
47 <tr> |
|
48 <td><a href="#E4SingleApplicationClient.__init__">E4SingleApplicationClient</a></td> |
|
49 <td>Constructor</td> |
|
50 </tr><tr> |
|
51 <td><a href="#E4SingleApplicationClient.__openFile">__openFile</a></td> |
|
52 <td>Private method to open a file in the application server.</td> |
|
53 </tr><tr> |
|
54 <td><a href="#E4SingleApplicationClient.__openProject">__openProject</a></td> |
|
55 <td>Private method to open a project in the application server.</td> |
|
56 </tr><tr> |
|
57 <td><a href="#E4SingleApplicationClient.__sendArguments">__sendArguments</a></td> |
|
58 <td>Private method to set the command arguments in the application server.</td> |
|
59 </tr><tr> |
|
60 <td><a href="#E4SingleApplicationClient.processArgs">processArgs</a></td> |
|
61 <td>Public method to process the command line args passed to the UI.</td> |
|
62 </tr> |
|
63 </table> |
|
64 <a NAME="E4SingleApplicationClient.__init__" ID="E4SingleApplicationClient.__init__"></a> |
|
65 <h4>E4SingleApplicationClient (Constructor)</h4> |
|
66 <b>E4SingleApplicationClient</b>(<i></i>) |
|
67 <p> |
|
68 Constructor |
|
69 </p><a NAME="E4SingleApplicationClient.__openFile" ID="E4SingleApplicationClient.__openFile"></a> |
|
70 <h4>E4SingleApplicationClient.__openFile</h4> |
|
71 <b>__openFile</b>(<i>fname</i>) |
|
72 <p> |
|
73 Private method to open a file in the application server. |
|
74 </p><dl> |
|
75 <dt><i>fname</i></dt> |
|
76 <dd> |
|
77 name of file to be opened (string) |
|
78 </dd> |
|
79 </dl><a NAME="E4SingleApplicationClient.__openProject" ID="E4SingleApplicationClient.__openProject"></a> |
|
80 <h4>E4SingleApplicationClient.__openProject</h4> |
|
81 <b>__openProject</b>(<i>pfname</i>) |
|
82 <p> |
|
83 Private method to open a project in the application server. |
|
84 </p><dl> |
|
85 <dt><i>pfname</i></dt> |
|
86 <dd> |
|
87 name of the projectfile to be opened (string) |
|
88 </dd> |
|
89 </dl><a NAME="E4SingleApplicationClient.__sendArguments" ID="E4SingleApplicationClient.__sendArguments"></a> |
|
90 <h4>E4SingleApplicationClient.__sendArguments</h4> |
|
91 <b>__sendArguments</b>(<i>argsStr</i>) |
|
92 <p> |
|
93 Private method to set the command arguments in the application server. |
|
94 </p><dl> |
|
95 <dt><i>argsStr</i></dt> |
|
96 <dd> |
|
97 space delimited list of command args (string) |
|
98 </dd> |
|
99 </dl><a NAME="E4SingleApplicationClient.processArgs" ID="E4SingleApplicationClient.processArgs"></a> |
|
100 <h4>E4SingleApplicationClient.processArgs</h4> |
|
101 <b>processArgs</b>(<i>args</i>) |
|
102 <p> |
|
103 Public method to process the command line args passed to the UI. |
|
104 </p><dl> |
|
105 <dt><i>args</i></dt> |
|
106 <dd> |
|
107 list of files to open |
|
108 </dd> |
|
109 </dl> |
|
110 <div align="right"><a href="#top">Up</a></div> |
|
111 <hr /><hr /> |
|
112 <a NAME="E4SingleApplicationServer" ID="E4SingleApplicationServer"></a> |
|
113 <h2>E4SingleApplicationServer</h2> |
|
114 <p> |
|
115 Class implementing the single application server embedded within the IDE. |
|
116 </p> |
|
117 <h3>Derived from</h3> |
|
118 SingleApplicationServer |
|
119 <h3>Class Attributes</h3> |
|
120 <table> |
|
121 <tr><td>None</td></tr> |
|
122 </table> |
|
123 <h3>Methods</h3> |
|
124 <table> |
|
125 <tr> |
|
126 <td><a href="#E4SingleApplicationServer.__init__">E4SingleApplicationServer</a></td> |
|
127 <td>Constructor</td> |
|
128 </tr><tr> |
|
129 <td><a href="#E4SingleApplicationServer.__saArguments">__saArguments</a></td> |
|
130 <td>Private method used to handle the "Arguments" command.</td> |
|
131 </tr><tr> |
|
132 <td><a href="#E4SingleApplicationServer.__saOpenFile">__saOpenFile</a></td> |
|
133 <td>Private method used to handle the "Open File" command.</td> |
|
134 </tr><tr> |
|
135 <td><a href="#E4SingleApplicationServer.__saOpenProject">__saOpenProject</a></td> |
|
136 <td>Private method used to handle the "Open Project" command.</td> |
|
137 </tr><tr> |
|
138 <td><a href="#E4SingleApplicationServer.handleCommand">handleCommand</a></td> |
|
139 <td>Public slot to handle the command sent by the client.</td> |
|
140 </tr> |
|
141 </table> |
|
142 <a NAME="E4SingleApplicationServer.__init__" ID="E4SingleApplicationServer.__init__"></a> |
|
143 <h4>E4SingleApplicationServer (Constructor)</h4> |
|
144 <b>E4SingleApplicationServer</b>(<i></i>) |
|
145 <p> |
|
146 Constructor |
|
147 </p><a NAME="E4SingleApplicationServer.__saArguments" ID="E4SingleApplicationServer.__saArguments"></a> |
|
148 <h4>E4SingleApplicationServer.__saArguments</h4> |
|
149 <b>__saArguments</b>(<i>argsStr</i>) |
|
150 <p> |
|
151 Private method used to handle the "Arguments" command. |
|
152 </p><dl> |
|
153 <dt><i>argsStr</i></dt> |
|
154 <dd> |
|
155 space delimited list of command args(string) |
|
156 </dd> |
|
157 </dl><a NAME="E4SingleApplicationServer.__saOpenFile" ID="E4SingleApplicationServer.__saOpenFile"></a> |
|
158 <h4>E4SingleApplicationServer.__saOpenFile</h4> |
|
159 <b>__saOpenFile</b>(<i>fname</i>) |
|
160 <p> |
|
161 Private method used to handle the "Open File" command. |
|
162 </p><dl> |
|
163 <dt><i>fname</i></dt> |
|
164 <dd> |
|
165 filename to be opened (string) |
|
166 </dd> |
|
167 </dl><a NAME="E4SingleApplicationServer.__saOpenProject" ID="E4SingleApplicationServer.__saOpenProject"></a> |
|
168 <h4>E4SingleApplicationServer.__saOpenProject</h4> |
|
169 <b>__saOpenProject</b>(<i>pfname</i>) |
|
170 <p> |
|
171 Private method used to handle the "Open Project" command. |
|
172 </p><dl> |
|
173 <dt><i>pfname</i></dt> |
|
174 <dd> |
|
175 filename of the project to be opened (string) |
|
176 </dd> |
|
177 </dl><a NAME="E4SingleApplicationServer.handleCommand" ID="E4SingleApplicationServer.handleCommand"></a> |
|
178 <h4>E4SingleApplicationServer.handleCommand</h4> |
|
179 <b>handleCommand</b>(<i>cmd, params</i>) |
|
180 <p> |
|
181 Public slot to handle the command sent by the client. |
|
182 </p><dl> |
|
183 <dt><i>cmd</i></dt> |
|
184 <dd> |
|
185 commandstring (string) |
|
186 </dd><dt><i>params</i></dt> |
|
187 <dd> |
|
188 parameterstring (string) |
|
189 </dd> |
|
190 </dl> |
|
191 <div align="right"><a href="#top">Up</a></div> |
|
192 <hr /> |
|
193 </body></html> |