|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric7.EricWidgets.EricSingleApplication</title> |
|
4 <meta charset="UTF-8"> |
|
5 <style> |
|
6 body { |
|
7 background: #EDECE6; |
|
8 margin: 0em 1em 10em 1em; |
|
9 color: black; |
|
10 } |
|
11 |
|
12 h1 { color: white; background: #85774A; } |
|
13 h2 { color: white; background: #85774A; } |
|
14 h3 { color: white; background: #9D936E; } |
|
15 h4 { color: white; background: #9D936E; } |
|
16 |
|
17 a { color: #BA6D36; } |
|
18 |
|
19 </style> |
|
20 </head> |
|
21 <body> |
|
22 <a NAME="top" ID="top"></a> |
|
23 <h1>eric7.EricWidgets.EricSingleApplication</h1> |
|
24 |
|
25 <p> |
|
26 Module implementing the single application server and client. |
|
27 </p> |
|
28 <h3>Global Attributes</h3> |
|
29 |
|
30 <table> |
|
31 <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> |
|
32 </table> |
|
33 <h3>Classes</h3> |
|
34 |
|
35 <table> |
|
36 |
|
37 <tr> |
|
38 <td><a href="#EricSingleApplicationClient">EricSingleApplicationClient</a></td> |
|
39 <td>Class implementing the single application client of the IDE.</td> |
|
40 </tr> |
|
41 <tr> |
|
42 <td><a href="#EricSingleApplicationServer">EricSingleApplicationServer</a></td> |
|
43 <td>Class implementing the single application server embedded within the IDE.</td> |
|
44 </tr> |
|
45 </table> |
|
46 <h3>Functions</h3> |
|
47 |
|
48 <table> |
|
49 <tr><td>None</td></tr> |
|
50 </table> |
|
51 <hr /> |
|
52 <hr /> |
|
53 <a NAME="EricSingleApplicationClient" ID="EricSingleApplicationClient"></a> |
|
54 <h2>EricSingleApplicationClient</h2> |
|
55 |
|
56 <p> |
|
57 Class implementing the single application client of the IDE. |
|
58 </p> |
|
59 <h3>Derived from</h3> |
|
60 SingleApplicationClient |
|
61 <h3>Class Attributes</h3> |
|
62 |
|
63 <table> |
|
64 <tr><td>None</td></tr> |
|
65 </table> |
|
66 <h3>Class Methods</h3> |
|
67 |
|
68 <table> |
|
69 <tr><td>None</td></tr> |
|
70 </table> |
|
71 <h3>Methods</h3> |
|
72 |
|
73 <table> |
|
74 |
|
75 <tr> |
|
76 <td><a href="#EricSingleApplicationClient.__init__">EricSingleApplicationClient</a></td> |
|
77 <td>Constructor</td> |
|
78 </tr> |
|
79 <tr> |
|
80 <td><a href="#EricSingleApplicationClient.__openFile">__openFile</a></td> |
|
81 <td>Private method to open a file in the application server.</td> |
|
82 </tr> |
|
83 <tr> |
|
84 <td><a href="#EricSingleApplicationClient.__openMultiProject">__openMultiProject</a></td> |
|
85 <td>Private method to open a project in the application server.</td> |
|
86 </tr> |
|
87 <tr> |
|
88 <td><a href="#EricSingleApplicationClient.__openProject">__openProject</a></td> |
|
89 <td>Private method to open a project in the application server.</td> |
|
90 </tr> |
|
91 <tr> |
|
92 <td><a href="#EricSingleApplicationClient.__sendArguments">__sendArguments</a></td> |
|
93 <td>Private method to set the command arguments in the application server.</td> |
|
94 </tr> |
|
95 <tr> |
|
96 <td><a href="#EricSingleApplicationClient.processArgs">processArgs</a></td> |
|
97 <td>Public method to process the command line args passed to the UI.</td> |
|
98 </tr> |
|
99 </table> |
|
100 <h3>Static Methods</h3> |
|
101 |
|
102 <table> |
|
103 <tr><td>None</td></tr> |
|
104 </table> |
|
105 |
|
106 <a NAME="EricSingleApplicationClient.__init__" ID="EricSingleApplicationClient.__init__"></a> |
|
107 <h4>EricSingleApplicationClient (Constructor)</h4> |
|
108 <b>EricSingleApplicationClient</b>(<i></i>) |
|
109 |
|
110 <p> |
|
111 Constructor |
|
112 </p> |
|
113 <a NAME="EricSingleApplicationClient.__openFile" ID="EricSingleApplicationClient.__openFile"></a> |
|
114 <h4>EricSingleApplicationClient.__openFile</h4> |
|
115 <b>__openFile</b>(<i>fname</i>) |
|
116 |
|
117 <p> |
|
118 Private method to open a file in the application server. |
|
119 </p> |
|
120 <dl> |
|
121 |
|
122 <dt><i>fname</i></dt> |
|
123 <dd> |
|
124 name of file to be opened (string) |
|
125 </dd> |
|
126 </dl> |
|
127 <a NAME="EricSingleApplicationClient.__openMultiProject" ID="EricSingleApplicationClient.__openMultiProject"></a> |
|
128 <h4>EricSingleApplicationClient.__openMultiProject</h4> |
|
129 <b>__openMultiProject</b>(<i>pfname</i>) |
|
130 |
|
131 <p> |
|
132 Private method to open a project in the application server. |
|
133 </p> |
|
134 <dl> |
|
135 |
|
136 <dt><i>pfname</i></dt> |
|
137 <dd> |
|
138 name of the projectfile to be opened (string) |
|
139 </dd> |
|
140 </dl> |
|
141 <a NAME="EricSingleApplicationClient.__openProject" ID="EricSingleApplicationClient.__openProject"></a> |
|
142 <h4>EricSingleApplicationClient.__openProject</h4> |
|
143 <b>__openProject</b>(<i>pfname</i>) |
|
144 |
|
145 <p> |
|
146 Private method to open a project in the application server. |
|
147 </p> |
|
148 <dl> |
|
149 |
|
150 <dt><i>pfname</i></dt> |
|
151 <dd> |
|
152 name of the projectfile to be opened (string) |
|
153 </dd> |
|
154 </dl> |
|
155 <a NAME="EricSingleApplicationClient.__sendArguments" ID="EricSingleApplicationClient.__sendArguments"></a> |
|
156 <h4>EricSingleApplicationClient.__sendArguments</h4> |
|
157 <b>__sendArguments</b>(<i>argsStr</i>) |
|
158 |
|
159 <p> |
|
160 Private method to set the command arguments in the application server. |
|
161 </p> |
|
162 <dl> |
|
163 |
|
164 <dt><i>argsStr</i></dt> |
|
165 <dd> |
|
166 space delimited list of command args (string) |
|
167 </dd> |
|
168 </dl> |
|
169 <a NAME="EricSingleApplicationClient.processArgs" ID="EricSingleApplicationClient.processArgs"></a> |
|
170 <h4>EricSingleApplicationClient.processArgs</h4> |
|
171 <b>processArgs</b>(<i>args</i>) |
|
172 |
|
173 <p> |
|
174 Public method to process the command line args passed to the UI. |
|
175 </p> |
|
176 <dl> |
|
177 |
|
178 <dt><i>args</i></dt> |
|
179 <dd> |
|
180 list of files to open |
|
181 </dd> |
|
182 </dl> |
|
183 <div align="right"><a href="#top">Up</a></div> |
|
184 <hr /> |
|
185 <hr /> |
|
186 <a NAME="EricSingleApplicationServer" ID="EricSingleApplicationServer"></a> |
|
187 <h2>EricSingleApplicationServer</h2> |
|
188 |
|
189 <p> |
|
190 Class implementing the single application server embedded within the IDE. |
|
191 </p> |
|
192 <h3>Derived from</h3> |
|
193 SingleApplicationServer |
|
194 <h3>Class Attributes</h3> |
|
195 |
|
196 <table> |
|
197 <tr><td>None</td></tr> |
|
198 </table> |
|
199 <h3>Class Methods</h3> |
|
200 |
|
201 <table> |
|
202 <tr><td>None</td></tr> |
|
203 </table> |
|
204 <h3>Methods</h3> |
|
205 |
|
206 <table> |
|
207 |
|
208 <tr> |
|
209 <td><a href="#EricSingleApplicationServer.__init__">EricSingleApplicationServer</a></td> |
|
210 <td>Constructor</td> |
|
211 </tr> |
|
212 <tr> |
|
213 <td><a href="#EricSingleApplicationServer.__saArguments">__saArguments</a></td> |
|
214 <td>Private method used to handle the "Arguments" command.</td> |
|
215 </tr> |
|
216 <tr> |
|
217 <td><a href="#EricSingleApplicationServer.__saOpenFile">__saOpenFile</a></td> |
|
218 <td>Private method used to handle the "Open File" command.</td> |
|
219 </tr> |
|
220 <tr> |
|
221 <td><a href="#EricSingleApplicationServer.__saOpenMultiProject">__saOpenMultiProject</a></td> |
|
222 <td>Private method used to handle the "Open Multi-Project" command.</td> |
|
223 </tr> |
|
224 <tr> |
|
225 <td><a href="#EricSingleApplicationServer.__saOpenProject">__saOpenProject</a></td> |
|
226 <td>Private method used to handle the "Open Project" command.</td> |
|
227 </tr> |
|
228 <tr> |
|
229 <td><a href="#EricSingleApplicationServer.handleCommand">handleCommand</a></td> |
|
230 <td>Public slot to handle the command sent by the client.</td> |
|
231 </tr> |
|
232 </table> |
|
233 <h3>Static Methods</h3> |
|
234 |
|
235 <table> |
|
236 <tr><td>None</td></tr> |
|
237 </table> |
|
238 |
|
239 <a NAME="EricSingleApplicationServer.__init__" ID="EricSingleApplicationServer.__init__"></a> |
|
240 <h4>EricSingleApplicationServer (Constructor)</h4> |
|
241 <b>EricSingleApplicationServer</b>(<i></i>) |
|
242 |
|
243 <p> |
|
244 Constructor |
|
245 </p> |
|
246 <a NAME="EricSingleApplicationServer.__saArguments" ID="EricSingleApplicationServer.__saArguments"></a> |
|
247 <h4>EricSingleApplicationServer.__saArguments</h4> |
|
248 <b>__saArguments</b>(<i>argsStr</i>) |
|
249 |
|
250 <p> |
|
251 Private method used to handle the "Arguments" command. |
|
252 </p> |
|
253 <dl> |
|
254 |
|
255 <dt><i>argsStr</i></dt> |
|
256 <dd> |
|
257 space delimited list of command args(string) |
|
258 </dd> |
|
259 </dl> |
|
260 <a NAME="EricSingleApplicationServer.__saOpenFile" ID="EricSingleApplicationServer.__saOpenFile"></a> |
|
261 <h4>EricSingleApplicationServer.__saOpenFile</h4> |
|
262 <b>__saOpenFile</b>(<i>fname</i>) |
|
263 |
|
264 <p> |
|
265 Private method used to handle the "Open File" command. |
|
266 </p> |
|
267 <dl> |
|
268 |
|
269 <dt><i>fname</i></dt> |
|
270 <dd> |
|
271 filename to be opened (string) |
|
272 </dd> |
|
273 </dl> |
|
274 <a NAME="EricSingleApplicationServer.__saOpenMultiProject" ID="EricSingleApplicationServer.__saOpenMultiProject"></a> |
|
275 <h4>EricSingleApplicationServer.__saOpenMultiProject</h4> |
|
276 <b>__saOpenMultiProject</b>(<i>pfname</i>) |
|
277 |
|
278 <p> |
|
279 Private method used to handle the "Open Multi-Project" command. |
|
280 </p> |
|
281 <dl> |
|
282 |
|
283 <dt><i>pfname</i></dt> |
|
284 <dd> |
|
285 filename of the multi project to be opened (string) |
|
286 </dd> |
|
287 </dl> |
|
288 <a NAME="EricSingleApplicationServer.__saOpenProject" ID="EricSingleApplicationServer.__saOpenProject"></a> |
|
289 <h4>EricSingleApplicationServer.__saOpenProject</h4> |
|
290 <b>__saOpenProject</b>(<i>pfname</i>) |
|
291 |
|
292 <p> |
|
293 Private method used to handle the "Open Project" command. |
|
294 </p> |
|
295 <dl> |
|
296 |
|
297 <dt><i>pfname</i></dt> |
|
298 <dd> |
|
299 filename of the project to be opened (string) |
|
300 </dd> |
|
301 </dl> |
|
302 <a NAME="EricSingleApplicationServer.handleCommand" ID="EricSingleApplicationServer.handleCommand"></a> |
|
303 <h4>EricSingleApplicationServer.handleCommand</h4> |
|
304 <b>handleCommand</b>(<i>command, arguments</i>) |
|
305 |
|
306 <p> |
|
307 Public slot to handle the command sent by the client. |
|
308 </p> |
|
309 <dl> |
|
310 |
|
311 <dt><i>command</i> (str)</dt> |
|
312 <dd> |
|
313 command sent by the client |
|
314 </dd> |
|
315 <dt><i>arguments</i> (list of str)</dt> |
|
316 <dd> |
|
317 list of command arguments |
|
318 </dd> |
|
319 </dl> |
|
320 <div align="right"><a href="#top">Up</a></div> |
|
321 <hr /> |
|
322 </body></html> |