Mercurial Repositories > eric / file comparison

comparison: eric7/Documentation/Source/eric7.WebBrowser.WebBrowserSingleApplication.html

eric7/Documentation/Source/eric7.WebBrowser.WebBrowserSingleApplication.html

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
equal deleted inserted replaced
8371:d6062691d424 8372:e0227a7c850e
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.WebBrowser.WebBrowserSingleApplication</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.WebBrowser.WebBrowserSingleApplication</h1>
24
25 <p>
26 Module implementing the single application server and client for the web
27 browser.
28 </p>
29 <h3>Global Attributes</h3>
30
31 <table>
32 <tr><td>SAFile</td></tr><tr><td>SALoadUrl</td></tr><tr><td>SANewTab</td></tr><tr><td>SASearch</td></tr><tr><td>SAShutdown</td></tr>
33 </table>
34 <h3>Classes</h3>
35
36 <table>
37
38 <tr>
39 <td><a href="#WebBrowserSingleApplicationClient">WebBrowserSingleApplicationClient</a></td>
40 <td>Class implementing the single application client of the web browser.</td>
41 </tr>
42 <tr>
43 <td><a href="#WebBrowserSingleApplicationServer">WebBrowserSingleApplicationServer</a></td>
44 <td>Class implementing the single application server embedded within the Web Browser.</td>
45 </tr>
46 </table>
47 <h3>Functions</h3>
48
49 <table>
50 <tr><td>None</td></tr>
51 </table>
52 <hr />
53 <hr />
54 <a NAME="WebBrowserSingleApplicationClient" ID="WebBrowserSingleApplicationClient"></a>
55 <h2>WebBrowserSingleApplicationClient</h2>
56
57 <p>
58 Class implementing the single application client of the web browser.
59 </p>
60 <h3>Derived from</h3>
61 SingleApplicationClient
62 <h3>Class Attributes</h3>
63
64 <table>
65 <tr><td>None</td></tr>
66 </table>
67 <h3>Class Methods</h3>
68
69 <table>
70 <tr><td>None</td></tr>
71 </table>
72 <h3>Methods</h3>
73
74 <table>
75
76 <tr>
77 <td><a href="#WebBrowserSingleApplicationClient.__init__">WebBrowserSingleApplicationClient</a></td>
78 <td>Constructor</td>
79 </tr>
80 <tr>
81 <td><a href="#WebBrowserSingleApplicationClient.__loadUrl">__loadUrl</a></td>
82 <td>Private method to send an URL to be loaded.</td>
83 </tr>
84 <tr>
85 <td><a href="#WebBrowserSingleApplicationClient.__newTab">__newTab</a></td>
86 <td>Private method to send an URL to be loaded in a new tab.</td>
87 </tr>
88 <tr>
89 <td><a href="#WebBrowserSingleApplicationClient.__search">__search</a></td>
90 <td>Private method to send a word to search for.</td>
91 </tr>
92 <tr>
93 <td><a href="#WebBrowserSingleApplicationClient.__shutdown">__shutdown</a></td>
94 <td>Private method to signal a shutdown request to the browser.</td>
95 </tr>
96 <tr>
97 <td><a href="#WebBrowserSingleApplicationClient.processArgs">processArgs</a></td>
98 <td>Public method to process the command line args passed to the UI.</td>
99 </tr>
100 </table>
101 <h3>Static Methods</h3>
102
103 <table>
104 <tr><td>None</td></tr>
105 </table>
106
107 <a NAME="WebBrowserSingleApplicationClient.__init__" ID="WebBrowserSingleApplicationClient.__init__"></a>
108 <h4>WebBrowserSingleApplicationClient (Constructor)</h4>
109 <b>WebBrowserSingleApplicationClient</b>(<i>name=""</i>)
110
111 <p>
112 Constructor
113 </p>
114 <dl>
115
116 <dt><i>name</i> (str)</dt>
117 <dd>
118 name to be used by the single application server
119 </dd>
120 </dl>
121 <a NAME="WebBrowserSingleApplicationClient.__loadUrl" ID="WebBrowserSingleApplicationClient.__loadUrl"></a>
122 <h4>WebBrowserSingleApplicationClient.__loadUrl</h4>
123 <b>__loadUrl</b>(<i>url</i>)
124
125 <p>
126 Private method to send an URL to be loaded.
127 </p>
128 <dl>
129
130 <dt><i>url</i> (str)</dt>
131 <dd>
132 URL to be loaded
133 </dd>
134 </dl>
135 <a NAME="WebBrowserSingleApplicationClient.__newTab" ID="WebBrowserSingleApplicationClient.__newTab"></a>
136 <h4>WebBrowserSingleApplicationClient.__newTab</h4>
137 <b>__newTab</b>(<i>url</i>)
138
139 <p>
140 Private method to send an URL to be loaded in a new tab.
141 </p>
142 <dl>
143
144 <dt><i>url</i> (str)</dt>
145 <dd>
146 URL to be loaded
147 </dd>
148 </dl>
149 <a NAME="WebBrowserSingleApplicationClient.__search" ID="WebBrowserSingleApplicationClient.__search"></a>
150 <h4>WebBrowserSingleApplicationClient.__search</h4>
151 <b>__search</b>(<i>word</i>)
152
153 <p>
154 Private method to send a word to search for.
155 </p>
156 <dl>
157
158 <dt><i>word</i> (str)</dt>
159 <dd>
160 to to be searched for
161 </dd>
162 </dl>
163 <a NAME="WebBrowserSingleApplicationClient.__shutdown" ID="WebBrowserSingleApplicationClient.__shutdown"></a>
164 <h4>WebBrowserSingleApplicationClient.__shutdown</h4>
165 <b>__shutdown</b>(<i></i>)
166
167 <p>
168 Private method to signal a shutdown request to the browser.
169 </p>
170 <a NAME="WebBrowserSingleApplicationClient.processArgs" ID="WebBrowserSingleApplicationClient.processArgs"></a>
171 <h4>WebBrowserSingleApplicationClient.processArgs</h4>
172 <b>processArgs</b>(<i>args, disconnect=True</i>)
173
174 <p>
175 Public method to process the command line args passed to the UI.
176 </p>
177 <dl>
178
179 <dt><i>args</i> (list of str)</dt>
180 <dd>
181 list of command line arguments
182 </dd>
183 <dt><i>disconnect</i> (bool)</dt>
184 <dd>
185 flag indicating to disconnect when done
186 </dd>
187 </dl>
188 <div align="right"><a href="#top">Up</a></div>
189 <hr />
190 <hr />
191 <a NAME="WebBrowserSingleApplicationServer" ID="WebBrowserSingleApplicationServer"></a>
192 <h2>WebBrowserSingleApplicationServer</h2>
193
194 <p>
195 Class implementing the single application server embedded within the
196 Web Browser.
197 </p>
198 <h3>Signals</h3>
199 <dl>
200
201 <dt>loadUrl(str)</dt>
202 <dd>
203 emitted to load an URL
204 </dd>
205 <dt>newTab(str)</dt>
206 <dd>
207 emitted to load an URL in a new tab
208 </dd>
209 <dt>search(str)</dt>
210 <dd>
211 emitted to search for a given word
212 </dd>
213 <dt>shutdown()</dt>
214 <dd>
215 emitted to shut down the browser
216 </dd>
217 </dl>
218 <h3>Derived from</h3>
219 SingleApplicationServer
220 <h3>Class Attributes</h3>
221
222 <table>
223 <tr><td>None</td></tr>
224 </table>
225 <h3>Class Methods</h3>
226
227 <table>
228 <tr><td>None</td></tr>
229 </table>
230 <h3>Methods</h3>
231
232 <table>
233
234 <tr>
235 <td><a href="#WebBrowserSingleApplicationServer.__init__">WebBrowserSingleApplicationServer</a></td>
236 <td>Constructor</td>
237 </tr>
238 <tr>
239 <td><a href="#WebBrowserSingleApplicationServer.__saLoadUrl">__saLoadUrl</a></td>
240 <td>Private method to load an URL in a new tab.</td>
241 </tr>
242 <tr>
243 <td><a href="#WebBrowserSingleApplicationServer.__saNewTab">__saNewTab</a></td>
244 <td>Private method to load an URL .</td>
245 </tr>
246 <tr>
247 <td><a href="#WebBrowserSingleApplicationServer.__saSearch">__saSearch</a></td>
248 <td>Private method to search for a given word.</td>
249 </tr>
250 <tr>
251 <td><a href="#WebBrowserSingleApplicationServer.__saShutdown">__saShutdown</a></td>
252 <td>Private method to shut down the web browser.</td>
253 </tr>
254 <tr>
255 <td><a href="#WebBrowserSingleApplicationServer.handleCommand">handleCommand</a></td>
256 <td>Public slot to handle the command sent by the client.</td>
257 </tr>
258 </table>
259 <h3>Static Methods</h3>
260
261 <table>
262 <tr><td>None</td></tr>
263 </table>
264
265 <a NAME="WebBrowserSingleApplicationServer.__init__" ID="WebBrowserSingleApplicationServer.__init__"></a>
266 <h4>WebBrowserSingleApplicationServer (Constructor)</h4>
267 <b>WebBrowserSingleApplicationServer</b>(<i>name=""</i>)
268
269 <p>
270 Constructor
271 </p>
272 <dl>
273
274 <dt><i>name</i> (str)</dt>
275 <dd>
276 name to be used by the single application server
277 </dd>
278 </dl>
279 <a NAME="WebBrowserSingleApplicationServer.__saLoadUrl" ID="WebBrowserSingleApplicationServer.__saLoadUrl"></a>
280 <h4>WebBrowserSingleApplicationServer.__saLoadUrl</h4>
281 <b>__saLoadUrl</b>(<i>url</i>)
282
283 <p>
284 Private method to load an URL in a new tab.
285 </p>
286 <dl>
287
288 <dt><i>url</i> (str)</dt>
289 <dd>
290 URL to be loaded
291 </dd>
292 </dl>
293 <a NAME="WebBrowserSingleApplicationServer.__saNewTab" ID="WebBrowserSingleApplicationServer.__saNewTab"></a>
294 <h4>WebBrowserSingleApplicationServer.__saNewTab</h4>
295 <b>__saNewTab</b>(<i>url</i>)
296
297 <p>
298 Private method to load an URL .
299 </p>
300 <dl>
301
302 <dt><i>url</i> (str)</dt>
303 <dd>
304 URL to be loaded
305 </dd>
306 </dl>
307 <a NAME="WebBrowserSingleApplicationServer.__saSearch" ID="WebBrowserSingleApplicationServer.__saSearch"></a>
308 <h4>WebBrowserSingleApplicationServer.__saSearch</h4>
309 <b>__saSearch</b>(<i>word</i>)
310
311 <p>
312 Private method to search for a given word.
313 </p>
314 <dl>
315
316 <dt><i>word</i> (str)</dt>
317 <dd>
318 word to be searched for
319 </dd>
320 </dl>
321 <a NAME="WebBrowserSingleApplicationServer.__saShutdown" ID="WebBrowserSingleApplicationServer.__saShutdown"></a>
322 <h4>WebBrowserSingleApplicationServer.__saShutdown</h4>
323 <b>__saShutdown</b>(<i></i>)
324
325 <p>
326 Private method to shut down the web browser.
327 </p>
328 <a NAME="WebBrowserSingleApplicationServer.handleCommand" ID="WebBrowserSingleApplicationServer.handleCommand"></a>
329 <h4>WebBrowserSingleApplicationServer.handleCommand</h4>
330 <b>handleCommand</b>(<i>command, arguments</i>)
331
332 <p>
333 Public slot to handle the command sent by the client.
334 </p>
335 <dl>
336
337 <dt><i>command</i> (str)</dt>
338 <dd>
339 command sent by the client
340 </dd>
341 <dt><i>arguments</i> (list of str)</dt>
342 <dd>
343 list of command arguments
344 </dd>
345 </dl>
346 <div align="right"><a href="#top">Up</a></div>
347 <hr />
348 </body></html>

Mercurial Repository: eric

eric ide

mercurial