src/eric7/Documentation/Source/eric7.EricWidgets.EricSingleApplication.html

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

eric ide

mercurial