|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric6.E5Gui.E5SingleApplication</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><a NAME="top" ID="top"></a> |
|
22 <h1>eric6.E5Gui.E5SingleApplication</h1> |
|
23 <p> |
|
24 Module implementing the single application server and client. |
|
25 </p> |
|
26 <h3>Global Attributes</h3> |
|
27 <table> |
|
28 <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> |
|
29 </table> |
|
30 <h3>Classes</h3> |
|
31 <table> |
|
32 <tr> |
|
33 <td><a href="#E5SingleApplicationClient">E5SingleApplicationClient</a></td> |
|
34 <td>Class implementing the single application client of the IDE.</td> |
|
35 </tr><tr> |
|
36 <td><a href="#E5SingleApplicationServer">E5SingleApplicationServer</a></td> |
|
37 <td>Class implementing the single application server embedded within the IDE.</td> |
|
38 </tr> |
|
39 </table> |
|
40 <h3>Functions</h3> |
|
41 <table> |
|
42 <tr><td>None</td></tr> |
|
43 </table> |
|
44 <hr /><hr /> |
|
45 <a NAME="E5SingleApplicationClient" ID="E5SingleApplicationClient"></a> |
|
46 <h2>E5SingleApplicationClient</h2> |
|
47 <p> |
|
48 Class implementing the single application client of the IDE. |
|
49 </p> |
|
50 <h3>Derived from</h3> |
|
51 SingleApplicationClient |
|
52 <h3>Class Attributes</h3> |
|
53 <table> |
|
54 <tr><td>None</td></tr> |
|
55 </table> |
|
56 <h3>Class Methods</h3> |
|
57 <table> |
|
58 <tr><td>None</td></tr> |
|
59 </table> |
|
60 <h3>Methods</h3> |
|
61 <table> |
|
62 <tr> |
|
63 <td><a href="#E5SingleApplicationClient.__init__">E5SingleApplicationClient</a></td> |
|
64 <td>Constructor</td> |
|
65 </tr><tr> |
|
66 <td><a href="#E5SingleApplicationClient.__openFile">__openFile</a></td> |
|
67 <td>Private method to open a file in the application server.</td> |
|
68 </tr><tr> |
|
69 <td><a href="#E5SingleApplicationClient.__openMultiProject">__openMultiProject</a></td> |
|
70 <td>Private method to open a project in the application server.</td> |
|
71 </tr><tr> |
|
72 <td><a href="#E5SingleApplicationClient.__openProject">__openProject</a></td> |
|
73 <td>Private method to open a project in the application server.</td> |
|
74 </tr><tr> |
|
75 <td><a href="#E5SingleApplicationClient.__sendArguments">__sendArguments</a></td> |
|
76 <td>Private method to set the command arguments in the application server.</td> |
|
77 </tr><tr> |
|
78 <td><a href="#E5SingleApplicationClient.processArgs">processArgs</a></td> |
|
79 <td>Public method to process the command line args passed to the UI.</td> |
|
80 </tr> |
|
81 </table> |
|
82 <h3>Static Methods</h3> |
|
83 <table> |
|
84 <tr><td>None</td></tr> |
|
85 </table> |
|
86 <a NAME="E5SingleApplicationClient.__init__" ID="E5SingleApplicationClient.__init__"></a> |
|
87 <h4>E5SingleApplicationClient (Constructor)</h4> |
|
88 <b>E5SingleApplicationClient</b>(<i></i>) |
|
89 <p> |
|
90 Constructor |
|
91 </p><a NAME="E5SingleApplicationClient.__openFile" ID="E5SingleApplicationClient.__openFile"></a> |
|
92 <h4>E5SingleApplicationClient.__openFile</h4> |
|
93 <b>__openFile</b>(<i>fname</i>) |
|
94 <p> |
|
95 Private method to open a file in the application server. |
|
96 </p><dl> |
|
97 <dt><i>fname</i></dt> |
|
98 <dd> |
|
99 name of file to be opened (string) |
|
100 </dd> |
|
101 </dl><a NAME="E5SingleApplicationClient.__openMultiProject" ID="E5SingleApplicationClient.__openMultiProject"></a> |
|
102 <h4>E5SingleApplicationClient.__openMultiProject</h4> |
|
103 <b>__openMultiProject</b>(<i>pfname</i>) |
|
104 <p> |
|
105 Private method to open a project in the application server. |
|
106 </p><dl> |
|
107 <dt><i>pfname</i></dt> |
|
108 <dd> |
|
109 name of the projectfile to be opened (string) |
|
110 </dd> |
|
111 </dl><a NAME="E5SingleApplicationClient.__openProject" ID="E5SingleApplicationClient.__openProject"></a> |
|
112 <h4>E5SingleApplicationClient.__openProject</h4> |
|
113 <b>__openProject</b>(<i>pfname</i>) |
|
114 <p> |
|
115 Private method to open a project in the application server. |
|
116 </p><dl> |
|
117 <dt><i>pfname</i></dt> |
|
118 <dd> |
|
119 name of the projectfile to be opened (string) |
|
120 </dd> |
|
121 </dl><a NAME="E5SingleApplicationClient.__sendArguments" ID="E5SingleApplicationClient.__sendArguments"></a> |
|
122 <h4>E5SingleApplicationClient.__sendArguments</h4> |
|
123 <b>__sendArguments</b>(<i>argsStr</i>) |
|
124 <p> |
|
125 Private method to set the command arguments in the application server. |
|
126 </p><dl> |
|
127 <dt><i>argsStr</i></dt> |
|
128 <dd> |
|
129 space delimited list of command args (string) |
|
130 </dd> |
|
131 </dl><a NAME="E5SingleApplicationClient.processArgs" ID="E5SingleApplicationClient.processArgs"></a> |
|
132 <h4>E5SingleApplicationClient.processArgs</h4> |
|
133 <b>processArgs</b>(<i>args</i>) |
|
134 <p> |
|
135 Public method to process the command line args passed to the UI. |
|
136 </p><dl> |
|
137 <dt><i>args</i></dt> |
|
138 <dd> |
|
139 list of files to open |
|
140 </dd> |
|
141 </dl> |
|
142 <div align="right"><a href="#top">Up</a></div> |
|
143 <hr /><hr /> |
|
144 <a NAME="E5SingleApplicationServer" ID="E5SingleApplicationServer"></a> |
|
145 <h2>E5SingleApplicationServer</h2> |
|
146 <p> |
|
147 Class implementing the single application server embedded within the IDE. |
|
148 </p> |
|
149 <h3>Derived from</h3> |
|
150 SingleApplicationServer |
|
151 <h3>Class Attributes</h3> |
|
152 <table> |
|
153 <tr><td>None</td></tr> |
|
154 </table> |
|
155 <h3>Class Methods</h3> |
|
156 <table> |
|
157 <tr><td>None</td></tr> |
|
158 </table> |
|
159 <h3>Methods</h3> |
|
160 <table> |
|
161 <tr> |
|
162 <td><a href="#E5SingleApplicationServer.__init__">E5SingleApplicationServer</a></td> |
|
163 <td>Constructor</td> |
|
164 </tr><tr> |
|
165 <td><a href="#E5SingleApplicationServer.__saArguments">__saArguments</a></td> |
|
166 <td>Private method used to handle the "Arguments" command.</td> |
|
167 </tr><tr> |
|
168 <td><a href="#E5SingleApplicationServer.__saOpenFile">__saOpenFile</a></td> |
|
169 <td>Private method used to handle the "Open File" command.</td> |
|
170 </tr><tr> |
|
171 <td><a href="#E5SingleApplicationServer.__saOpenMultiProject">__saOpenMultiProject</a></td> |
|
172 <td>Private method used to handle the "Open Multi-Project" command.</td> |
|
173 </tr><tr> |
|
174 <td><a href="#E5SingleApplicationServer.__saOpenProject">__saOpenProject</a></td> |
|
175 <td>Private method used to handle the "Open Project" command.</td> |
|
176 </tr><tr> |
|
177 <td><a href="#E5SingleApplicationServer.handleCommand">handleCommand</a></td> |
|
178 <td>Public slot to handle the command sent by the client.</td> |
|
179 </tr> |
|
180 </table> |
|
181 <h3>Static Methods</h3> |
|
182 <table> |
|
183 <tr><td>None</td></tr> |
|
184 </table> |
|
185 <a NAME="E5SingleApplicationServer.__init__" ID="E5SingleApplicationServer.__init__"></a> |
|
186 <h4>E5SingleApplicationServer (Constructor)</h4> |
|
187 <b>E5SingleApplicationServer</b>(<i></i>) |
|
188 <p> |
|
189 Constructor |
|
190 </p><a NAME="E5SingleApplicationServer.__saArguments" ID="E5SingleApplicationServer.__saArguments"></a> |
|
191 <h4>E5SingleApplicationServer.__saArguments</h4> |
|
192 <b>__saArguments</b>(<i>argsStr</i>) |
|
193 <p> |
|
194 Private method used to handle the "Arguments" command. |
|
195 </p><dl> |
|
196 <dt><i>argsStr</i></dt> |
|
197 <dd> |
|
198 space delimited list of command args(string) |
|
199 </dd> |
|
200 </dl><a NAME="E5SingleApplicationServer.__saOpenFile" ID="E5SingleApplicationServer.__saOpenFile"></a> |
|
201 <h4>E5SingleApplicationServer.__saOpenFile</h4> |
|
202 <b>__saOpenFile</b>(<i>fname</i>) |
|
203 <p> |
|
204 Private method used to handle the "Open File" command. |
|
205 </p><dl> |
|
206 <dt><i>fname</i></dt> |
|
207 <dd> |
|
208 filename to be opened (string) |
|
209 </dd> |
|
210 </dl><a NAME="E5SingleApplicationServer.__saOpenMultiProject" ID="E5SingleApplicationServer.__saOpenMultiProject"></a> |
|
211 <h4>E5SingleApplicationServer.__saOpenMultiProject</h4> |
|
212 <b>__saOpenMultiProject</b>(<i>pfname</i>) |
|
213 <p> |
|
214 Private method used to handle the "Open Multi-Project" command. |
|
215 </p><dl> |
|
216 <dt><i>pfname</i></dt> |
|
217 <dd> |
|
218 filename of the multi project to be opened (string) |
|
219 </dd> |
|
220 </dl><a NAME="E5SingleApplicationServer.__saOpenProject" ID="E5SingleApplicationServer.__saOpenProject"></a> |
|
221 <h4>E5SingleApplicationServer.__saOpenProject</h4> |
|
222 <b>__saOpenProject</b>(<i>pfname</i>) |
|
223 <p> |
|
224 Private method used to handle the "Open Project" command. |
|
225 </p><dl> |
|
226 <dt><i>pfname</i></dt> |
|
227 <dd> |
|
228 filename of the project to be opened (string) |
|
229 </dd> |
|
230 </dl><a NAME="E5SingleApplicationServer.handleCommand" ID="E5SingleApplicationServer.handleCommand"></a> |
|
231 <h4>E5SingleApplicationServer.handleCommand</h4> |
|
232 <b>handleCommand</b>(<i>command, arguments</i>) |
|
233 <p> |
|
234 Public slot to handle the command sent by the client. |
|
235 </p><dl> |
|
236 <dt><i>command</i> (str)</dt> |
|
237 <dd> |
|
238 command sent by the client |
|
239 </dd><dt><i>arguments</i> (list of str)</dt> |
|
240 <dd> |
|
241 list of command arguments |
|
242 </dd> |
|
243 </dl> |
|
244 <div align="right"><a href="#top">Up</a></div> |
|
245 <hr /> |
|
246 </body></html> |