Mercurial Repositories > eric / file comparison

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

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

branch
eric7
changeset 10479
856476537696
parent 10303
ee1aadab1215
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.WebBrowser.WebBrowserSingleApplication</h1> 9 <h1>eric7.WebBrowser.WebBrowserSingleApplication</h1>
10
11 <p> 10 <p>
12 Module implementing the single application server and client for the web 11 Module implementing the single application server and client for the web
13 browser. 12 browser.
14 </p> 13 </p>
14
15 <h3>Global Attributes</h3> 15 <h3>Global Attributes</h3>
16 16 <table>
17 <table> 17 <tr><td>SAFile</td></tr>
18 <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> 18 <tr><td>SALoadUrl</td></tr>
19 </table> 19 <tr><td>SANewTab</td></tr>
20 <tr><td>SASearch</td></tr>
21 <tr><td>SAShutdown</td></tr>
22 </table>
23
20 <h3>Classes</h3> 24 <h3>Classes</h3>
21 25 <table>
22 <table>
23
24 <tr> 26 <tr>
25 <td><a href="#WebBrowserSingleApplicationClient">WebBrowserSingleApplicationClient</a></td> 27 <td><a href="#WebBrowserSingleApplicationClient">WebBrowserSingleApplicationClient</a></td>
26 <td>Class implementing the single application client of the web browser.</td> 28 <td>Class implementing the single application client of the web browser.</td>
27 </tr> 29 </tr>
28 <tr> 30 <tr>
29 <td><a href="#WebBrowserSingleApplicationServer">WebBrowserSingleApplicationServer</a></td> 31 <td><a href="#WebBrowserSingleApplicationServer">WebBrowserSingleApplicationServer</a></td>
30 <td>Class implementing the single application server embedded within the Web Browser.</td> 32 <td>Class implementing the single application server embedded within the Web Browser.</td>
31 </tr> 33 </tr>
32 </table> 34 </table>
35
33 <h3>Functions</h3> 36 <h3>Functions</h3>
34 37 <table>
35 <table> 38 <tr><td>None</td></tr>
36 <tr><td>None</td></tr> 39 </table>
37 </table> 40
38 <hr /> 41 <hr />
39 <hr /> 42 <hr />
40 <a NAME="WebBrowserSingleApplicationClient" ID="WebBrowserSingleApplicationClient"></a> 43 <a NAME="WebBrowserSingleApplicationClient" ID="WebBrowserSingleApplicationClient"></a>
41 <h2>WebBrowserSingleApplicationClient</h2> 44 <h2>WebBrowserSingleApplicationClient</h2>
42
43 <p> 45 <p>
44 Class implementing the single application client of the web browser. 46 Class implementing the single application client of the web browser.
45 </p> 47 </p>
48
46 <h3>Derived from</h3> 49 <h3>Derived from</h3>
47 SingleApplicationClient 50 SingleApplicationClient
48 <h3>Class Attributes</h3> 51 <h3>Class Attributes</h3>
49 52 <table>
50 <table> 53 <tr><td>None</td></tr>
51 <tr><td>None</td></tr> 54 </table>
52 </table> 55
53 <h3>Class Methods</h3> 56 <h3>Class Methods</h3>
54 57 <table>
55 <table> 58 <tr><td>None</td></tr>
56 <tr><td>None</td></tr> 59 </table>
57 </table> 60
58 <h3>Methods</h3> 61 <h3>Methods</h3>
59 62 <table>
60 <table>
61
62 <tr> 63 <tr>
63 <td><a href="#WebBrowserSingleApplicationClient.__init__">WebBrowserSingleApplicationClient</a></td> 64 <td><a href="#WebBrowserSingleApplicationClient.__init__">WebBrowserSingleApplicationClient</a></td>
64 <td>Constructor</td> 65 <td>Constructor</td>
65 </tr> 66 </tr>
66 <tr> 67 <tr>
82 <tr> 83 <tr>
83 <td><a href="#WebBrowserSingleApplicationClient.processArgs">processArgs</a></td> 84 <td><a href="#WebBrowserSingleApplicationClient.processArgs">processArgs</a></td>
84 <td>Public method to process the command line args passed to the UI.</td> 85 <td>Public method to process the command line args passed to the UI.</td>
85 </tr> 86 </tr>
86 </table> 87 </table>
88
87 <h3>Static Methods</h3> 89 <h3>Static Methods</h3>
88 90 <table>
89 <table> 91 <tr><td>None</td></tr>
90 <tr><td>None</td></tr> 92 </table>
91 </table> 93
92 94
93 <a NAME="WebBrowserSingleApplicationClient.__init__" ID="WebBrowserSingleApplicationClient.__init__"></a> 95 <a NAME="WebBrowserSingleApplicationClient.__init__" ID="WebBrowserSingleApplicationClient.__init__"></a>
94 <h4>WebBrowserSingleApplicationClient (Constructor)</h4> 96 <h4>WebBrowserSingleApplicationClient (Constructor)</h4>
95 <b>WebBrowserSingleApplicationClient</b>(<i>name=""</i>) 97 <b>WebBrowserSingleApplicationClient</b>(<i>name=""</i>)
96
97 <p> 98 <p>
98 Constructor 99 Constructor
99 </p> 100 </p>
101
100 <dl> 102 <dl>
101 103
102 <dt><i>name</i> (str)</dt> 104 <dt><i>name</i> (str)</dt>
103 <dd> 105 <dd>
104 name to be used by the single application server 106 name to be used by the single application server
105 </dd> 107 </dd>
106 </dl> 108 </dl>
107 <a NAME="WebBrowserSingleApplicationClient.__loadUrl" ID="WebBrowserSingleApplicationClient.__loadUrl"></a> 109 <a NAME="WebBrowserSingleApplicationClient.__loadUrl" ID="WebBrowserSingleApplicationClient.__loadUrl"></a>
108 <h4>WebBrowserSingleApplicationClient.__loadUrl</h4> 110 <h4>WebBrowserSingleApplicationClient.__loadUrl</h4>
109 <b>__loadUrl</b>(<i>url</i>) 111 <b>__loadUrl</b>(<i>url</i>)
110
111 <p> 112 <p>
112 Private method to send an URL to be loaded. 113 Private method to send an URL to be loaded.
113 </p> 114 </p>
115
114 <dl> 116 <dl>
115 117
116 <dt><i>url</i> (str)</dt> 118 <dt><i>url</i> (str)</dt>
117 <dd> 119 <dd>
118 URL to be loaded 120 URL to be loaded
119 </dd> 121 </dd>
120 </dl> 122 </dl>
121 <a NAME="WebBrowserSingleApplicationClient.__newTab" ID="WebBrowserSingleApplicationClient.__newTab"></a> 123 <a NAME="WebBrowserSingleApplicationClient.__newTab" ID="WebBrowserSingleApplicationClient.__newTab"></a>
122 <h4>WebBrowserSingleApplicationClient.__newTab</h4> 124 <h4>WebBrowserSingleApplicationClient.__newTab</h4>
123 <b>__newTab</b>(<i>url</i>) 125 <b>__newTab</b>(<i>url</i>)
124
125 <p> 126 <p>
126 Private method to send an URL to be loaded in a new tab. 127 Private method to send an URL to be loaded in a new tab.
127 </p> 128 </p>
129
128 <dl> 130 <dl>
129 131
130 <dt><i>url</i> (str)</dt> 132 <dt><i>url</i> (str)</dt>
131 <dd> 133 <dd>
132 URL to be loaded 134 URL to be loaded
133 </dd> 135 </dd>
134 </dl> 136 </dl>
135 <a NAME="WebBrowserSingleApplicationClient.__search" ID="WebBrowserSingleApplicationClient.__search"></a> 137 <a NAME="WebBrowserSingleApplicationClient.__search" ID="WebBrowserSingleApplicationClient.__search"></a>
136 <h4>WebBrowserSingleApplicationClient.__search</h4> 138 <h4>WebBrowserSingleApplicationClient.__search</h4>
137 <b>__search</b>(<i>word</i>) 139 <b>__search</b>(<i>word</i>)
138
139 <p> 140 <p>
140 Private method to send a word to search for. 141 Private method to send a word to search for.
141 </p> 142 </p>
143
142 <dl> 144 <dl>
143 145
144 <dt><i>word</i> (str)</dt> 146 <dt><i>word</i> (str)</dt>
145 <dd> 147 <dd>
146 to to be searched for 148 to to be searched for
147 </dd> 149 </dd>
148 </dl> 150 </dl>
149 <a NAME="WebBrowserSingleApplicationClient.__shutdown" ID="WebBrowserSingleApplicationClient.__shutdown"></a> 151 <a NAME="WebBrowserSingleApplicationClient.__shutdown" ID="WebBrowserSingleApplicationClient.__shutdown"></a>
150 <h4>WebBrowserSingleApplicationClient.__shutdown</h4> 152 <h4>WebBrowserSingleApplicationClient.__shutdown</h4>
151 <b>__shutdown</b>(<i></i>) 153 <b>__shutdown</b>(<i></i>)
152
153 <p> 154 <p>
154 Private method to signal a shutdown request to the browser. 155 Private method to signal a shutdown request to the browser.
155 </p> 156 </p>
157
156 <a NAME="WebBrowserSingleApplicationClient.processArgs" ID="WebBrowserSingleApplicationClient.processArgs"></a> 158 <a NAME="WebBrowserSingleApplicationClient.processArgs" ID="WebBrowserSingleApplicationClient.processArgs"></a>
157 <h4>WebBrowserSingleApplicationClient.processArgs</h4> 159 <h4>WebBrowserSingleApplicationClient.processArgs</h4>
158 <b>processArgs</b>(<i>args, disconnect=True</i>) 160 <b>processArgs</b>(<i>args, disconnect=True</i>)
159
160 <p> 161 <p>
161 Public method to process the command line args passed to the UI. 162 Public method to process the command line args passed to the UI.
162 </p> 163 </p>
164
163 <dl> 165 <dl>
164 166
165 <dt><i>args</i> (argparse.Namespace)</dt> 167 <dt><i>args</i> (argparse.Namespace)</dt>
166 <dd> 168 <dd>
167 namespace object containing the parsed command line parameters 169 namespace object containing the parsed command line parameters
174 <div align="right"><a href="#top">Up</a></div> 176 <div align="right"><a href="#top">Up</a></div>
175 <hr /> 177 <hr />
176 <hr /> 178 <hr />
177 <a NAME="WebBrowserSingleApplicationServer" ID="WebBrowserSingleApplicationServer"></a> 179 <a NAME="WebBrowserSingleApplicationServer" ID="WebBrowserSingleApplicationServer"></a>
178 <h2>WebBrowserSingleApplicationServer</h2> 180 <h2>WebBrowserSingleApplicationServer</h2>
179
180 <p> 181 <p>
181 Class implementing the single application server embedded within the 182 Class implementing the single application server embedded within the
182 Web Browser. 183 Web Browser.
183 </p> 184 </p>
185
184 <h3>Signals</h3> 186 <h3>Signals</h3>
185 <dl> 187 <dl>
186 188
187 <dt>loadUrl(str)</dt> 189 <dt>loadUrl(str)</dt>
188 <dd> 190 <dd>
202 </dd> 204 </dd>
203 </dl> 205 </dl>
204 <h3>Derived from</h3> 206 <h3>Derived from</h3>
205 SingleApplicationServer 207 SingleApplicationServer
206 <h3>Class Attributes</h3> 208 <h3>Class Attributes</h3>
207 209 <table>
208 <table> 210 <tr><td>None</td></tr>
209 <tr><td>None</td></tr> 211 </table>
210 </table> 212
211 <h3>Class Methods</h3> 213 <h3>Class Methods</h3>
212 214 <table>
213 <table> 215 <tr><td>None</td></tr>
214 <tr><td>None</td></tr> 216 </table>
215 </table> 217
216 <h3>Methods</h3> 218 <h3>Methods</h3>
217 219 <table>
218 <table>
219
220 <tr> 220 <tr>
221 <td><a href="#WebBrowserSingleApplicationServer.__init__">WebBrowserSingleApplicationServer</a></td> 221 <td><a href="#WebBrowserSingleApplicationServer.__init__">WebBrowserSingleApplicationServer</a></td>
222 <td>Constructor</td> 222 <td>Constructor</td>
223 </tr> 223 </tr>
224 <tr> 224 <tr>
240 <tr> 240 <tr>
241 <td><a href="#WebBrowserSingleApplicationServer.handleCommand">handleCommand</a></td> 241 <td><a href="#WebBrowserSingleApplicationServer.handleCommand">handleCommand</a></td>
242 <td>Public slot to handle the command sent by the client.</td> 242 <td>Public slot to handle the command sent by the client.</td>
243 </tr> 243 </tr>
244 </table> 244 </table>
245
245 <h3>Static Methods</h3> 246 <h3>Static Methods</h3>
246 247 <table>
247 <table> 248 <tr><td>None</td></tr>
248 <tr><td>None</td></tr> 249 </table>
249 </table> 250
250 251
251 <a NAME="WebBrowserSingleApplicationServer.__init__" ID="WebBrowserSingleApplicationServer.__init__"></a> 252 <a NAME="WebBrowserSingleApplicationServer.__init__" ID="WebBrowserSingleApplicationServer.__init__"></a>
252 <h4>WebBrowserSingleApplicationServer (Constructor)</h4> 253 <h4>WebBrowserSingleApplicationServer (Constructor)</h4>
253 <b>WebBrowserSingleApplicationServer</b>(<i>name=""</i>) 254 <b>WebBrowserSingleApplicationServer</b>(<i>name=""</i>)
254
255 <p> 255 <p>
256 Constructor 256 Constructor
257 </p> 257 </p>
258
258 <dl> 259 <dl>
259 260
260 <dt><i>name</i> (str)</dt> 261 <dt><i>name</i> (str)</dt>
261 <dd> 262 <dd>
262 name to be used by the single application server 263 name to be used by the single application server
263 </dd> 264 </dd>
264 </dl> 265 </dl>
265 <a NAME="WebBrowserSingleApplicationServer.__saLoadUrl" ID="WebBrowserSingleApplicationServer.__saLoadUrl"></a> 266 <a NAME="WebBrowserSingleApplicationServer.__saLoadUrl" ID="WebBrowserSingleApplicationServer.__saLoadUrl"></a>
266 <h4>WebBrowserSingleApplicationServer.__saLoadUrl</h4> 267 <h4>WebBrowserSingleApplicationServer.__saLoadUrl</h4>
267 <b>__saLoadUrl</b>(<i>url</i>) 268 <b>__saLoadUrl</b>(<i>url</i>)
268
269 <p> 269 <p>
270 Private method to load an URL in a new tab. 270 Private method to load an URL in a new tab.
271 </p> 271 </p>
272
272 <dl> 273 <dl>
273 274
274 <dt><i>url</i> (str)</dt> 275 <dt><i>url</i> (str)</dt>
275 <dd> 276 <dd>
276 URL to be loaded 277 URL to be loaded
277 </dd> 278 </dd>
278 </dl> 279 </dl>
279 <a NAME="WebBrowserSingleApplicationServer.__saNewTab" ID="WebBrowserSingleApplicationServer.__saNewTab"></a> 280 <a NAME="WebBrowserSingleApplicationServer.__saNewTab" ID="WebBrowserSingleApplicationServer.__saNewTab"></a>
280 <h4>WebBrowserSingleApplicationServer.__saNewTab</h4> 281 <h4>WebBrowserSingleApplicationServer.__saNewTab</h4>
281 <b>__saNewTab</b>(<i>url</i>) 282 <b>__saNewTab</b>(<i>url</i>)
282
283 <p> 283 <p>
284 Private method to load an URL . 284 Private method to load an URL .
285 </p> 285 </p>
286
286 <dl> 287 <dl>
287 288
288 <dt><i>url</i> (str)</dt> 289 <dt><i>url</i> (str)</dt>
289 <dd> 290 <dd>
290 URL to be loaded 291 URL to be loaded
291 </dd> 292 </dd>
292 </dl> 293 </dl>
293 <a NAME="WebBrowserSingleApplicationServer.__saSearch" ID="WebBrowserSingleApplicationServer.__saSearch"></a> 294 <a NAME="WebBrowserSingleApplicationServer.__saSearch" ID="WebBrowserSingleApplicationServer.__saSearch"></a>
294 <h4>WebBrowserSingleApplicationServer.__saSearch</h4> 295 <h4>WebBrowserSingleApplicationServer.__saSearch</h4>
295 <b>__saSearch</b>(<i>word</i>) 296 <b>__saSearch</b>(<i>word</i>)
296
297 <p> 297 <p>
298 Private method to search for a given word. 298 Private method to search for a given word.
299 </p> 299 </p>
300
300 <dl> 301 <dl>
301 302
302 <dt><i>word</i> (str)</dt> 303 <dt><i>word</i> (str)</dt>
303 <dd> 304 <dd>
304 word to be searched for 305 word to be searched for
305 </dd> 306 </dd>
306 </dl> 307 </dl>
307 <a NAME="WebBrowserSingleApplicationServer.__saShutdown" ID="WebBrowserSingleApplicationServer.__saShutdown"></a> 308 <a NAME="WebBrowserSingleApplicationServer.__saShutdown" ID="WebBrowserSingleApplicationServer.__saShutdown"></a>
308 <h4>WebBrowserSingleApplicationServer.__saShutdown</h4> 309 <h4>WebBrowserSingleApplicationServer.__saShutdown</h4>
309 <b>__saShutdown</b>(<i></i>) 310 <b>__saShutdown</b>(<i></i>)
310
311 <p> 311 <p>
312 Private method to shut down the web browser. 312 Private method to shut down the web browser.
313 </p> 313 </p>
314
314 <a NAME="WebBrowserSingleApplicationServer.handleCommand" ID="WebBrowserSingleApplicationServer.handleCommand"></a> 315 <a NAME="WebBrowserSingleApplicationServer.handleCommand" ID="WebBrowserSingleApplicationServer.handleCommand"></a>
315 <h4>WebBrowserSingleApplicationServer.handleCommand</h4> 316 <h4>WebBrowserSingleApplicationServer.handleCommand</h4>
316 <b>handleCommand</b>(<i>command, arguments</i>) 317 <b>handleCommand</b>(<i>command, arguments</i>)
317
318 <p> 318 <p>
319 Public slot to handle the command sent by the client. 319 Public slot to handle the command sent by the client.
320 </p> 320 </p>
321
321 <dl> 322 <dl>
322 323
323 <dt><i>command</i> (str)</dt> 324 <dt><i>command</i> (str)</dt>
324 <dd> 325 <dd>
325 command sent by the client 326 command sent by the client

Mercurial Repository: eric

eric ide

mercurial