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