Mercurial Repositories > eric / file comparison

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

eric6/Documentation/Source/eric6.WebBrowser.WebBrowserSingleApplication.html

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

Mercurial Repository: eric

eric ide

mercurial