Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.WebBrowser.Tools.WebBrowserTools.html
src/eric7/Documentation/Source/eric7.WebBrowser.Tools.WebBrowserTools.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 9167
- 2d2b9a26e904
- child 9676
- 9edcc7302ac4
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.WebBrowser.Tools.WebBrowserTools</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.Tools.WebBrowserTools</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing tool functions for the web browser. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>WebBrowserDataDirectory</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 <tr><td>None</td></tr> | |
| 23 </table> | |
| 24 <h3>Functions</h3> | |
| 25 | |
| 26 <table> | |
| 27 | |
| 28 <tr> | |
| 29 <td><a href="#containsSpace">containsSpace</a></td> | |
| 30 <td>Function to check, if a string contains whitespace characters.</td> | |
| 31 </tr> | |
| 32 <tr> | |
| 33 <td><a href="#ensureUniqueFilename">ensureUniqueFilename</a></td> | |
| 34 <td>Module function to generate an unique file name based on a pattern.</td> | |
| 35 </tr> | |
| 36 <tr> | |
| 37 <td><a href="#filterCharsFromFilename">filterCharsFromFilename</a></td> | |
| 38 <td>Module function to filter illegal characters.</td> | |
| 39 </tr> | |
| 40 <tr> | |
| 41 <td><a href="#getFileNameFromUrl">getFileNameFromUrl</a></td> | |
| 42 <td>Module function to generate a file name based on the given URL.</td> | |
| 43 </tr> | |
| 44 <tr> | |
| 45 <td><a href="#getHtmlPage">getHtmlPage</a></td> | |
| 46 <td>Module function to load a HTML page.</td> | |
| 47 </tr> | |
| 48 <tr> | |
| 49 <td><a href="#getJavascript">getJavascript</a></td> | |
| 50 <td>Module function to load a JavaScript source file.</td> | |
| 51 </tr> | |
| 52 <tr> | |
| 53 <td><a href="#getWebEngineVersions">getWebEngineVersions</a></td> | |
| 54 <td>Module function to extract the web engine related versions from the default user agent string.</td> | |
| 55 </tr> | |
| 56 <tr> | |
| 57 <td><a href="#pixmapFileToDataUrl">pixmapFileToDataUrl</a></td> | |
| 58 <td>Module function to load a pixmap file and convert the pixmap to a data: URL.</td> | |
| 59 </tr> | |
| 60 <tr> | |
| 61 <td><a href="#pixmapFromByteArray">pixmapFromByteArray</a></td> | |
| 62 <td>Module function to convert a byte array to a pixmap.</td> | |
| 63 </tr> | |
| 64 <tr> | |
| 65 <td><a href="#pixmapToByteArray">pixmapToByteArray</a></td> | |
| 66 <td>Module function to convert a pixmap to a byte array containing the pixmap as a PNG encoded as base64.</td> | |
| 67 </tr> | |
| 68 <tr> | |
| 69 <td><a href="#pixmapToDataUrl">pixmapToDataUrl</a></td> | |
| 70 <td>Module function to convert a pixmap to a data: URL.</td> | |
| 71 </tr> | |
| 72 <tr> | |
| 73 <td><a href="#readAllFileContents">readAllFileContents</a></td> | |
| 74 <td>Function to read the string contents of the given file.</td> | |
| 75 </tr> | |
| 76 </table> | |
| 77 <hr /> | |
| 78 <hr /> | |
| 79 <a NAME="containsSpace" ID="containsSpace"></a> | |
| 80 <h2>containsSpace</h2> | |
| 81 <b>containsSpace</b>(<i>string</i>) | |
| 82 | |
| 83 <p> | |
| 84 Function to check, if a string contains whitespace characters. | |
| 85 </p> | |
| 86 <dl> | |
| 87 | |
| 88 <dt><i>string</i> (str)</dt> | |
| 89 <dd> | |
| 90 string to be checked | |
| 91 </dd> | |
| 92 </dl> | |
| 93 <dl> | |
| 94 <dt>Return:</dt> | |
| 95 <dd> | |
| 96 flag indicating the presence of at least one whitespace character | |
| 97 </dd> | |
| 98 </dl> | |
| 99 <dl> | |
| 100 <dt>Return Type:</dt> | |
| 101 <dd> | |
| 102 bool | |
| 103 </dd> | |
| 104 </dl> | |
| 105 <div align="right"><a href="#top">Up</a></div> | |
| 106 <hr /> | |
| 107 <hr /> | |
| 108 <a NAME="ensureUniqueFilename" ID="ensureUniqueFilename"></a> | |
| 109 <h2>ensureUniqueFilename</h2> | |
| 110 <b>ensureUniqueFilename</b>(<i>name, appendFormat="({0})"</i>) | |
| 111 | |
| 112 <p> | |
| 113 Module function to generate an unique file name based on a pattern. | |
| 114 </p> | |
| 115 <dl> | |
| 116 | |
| 117 <dt><i>name</i></dt> | |
| 118 <dd> | |
| 119 desired file name (string) | |
| 120 </dd> | |
| 121 <dt><i>appendFormat</i></dt> | |
| 122 <dd> | |
| 123 format pattern to be used to make the unique name | |
| 124 (string) | |
| 125 </dd> | |
| 126 </dl> | |
| 127 <dl> | |
| 128 <dt>Return:</dt> | |
| 129 <dd> | |
| 130 unique file name | |
| 131 </dd> | |
| 132 </dl> | |
| 133 <div align="right"><a href="#top">Up</a></div> | |
| 134 <hr /> | |
| 135 <hr /> | |
| 136 <a NAME="filterCharsFromFilename" ID="filterCharsFromFilename"></a> | |
| 137 <h2>filterCharsFromFilename</h2> | |
| 138 <b>filterCharsFromFilename</b>(<i>name</i>) | |
| 139 | |
| 140 <p> | |
| 141 Module function to filter illegal characters. | |
| 142 </p> | |
| 143 <dl> | |
| 144 | |
| 145 <dt><i>name</i></dt> | |
| 146 <dd> | |
| 147 name to be sanitized (string) | |
| 148 </dd> | |
| 149 </dl> | |
| 150 <dl> | |
| 151 <dt>Return:</dt> | |
| 152 <dd> | |
| 153 sanitized name (string) | |
| 154 </dd> | |
| 155 </dl> | |
| 156 <div align="right"><a href="#top">Up</a></div> | |
| 157 <hr /> | |
| 158 <hr /> | |
| 159 <a NAME="getFileNameFromUrl" ID="getFileNameFromUrl"></a> | |
| 160 <h2>getFileNameFromUrl</h2> | |
| 161 <b>getFileNameFromUrl</b>(<i>url</i>) | |
| 162 | |
| 163 <p> | |
| 164 Module function to generate a file name based on the given URL. | |
| 165 </p> | |
| 166 <dl> | |
| 167 | |
| 168 <dt><i>url</i></dt> | |
| 169 <dd> | |
| 170 URL (QUrl) | |
| 171 </dd> | |
| 172 </dl> | |
| 173 <dl> | |
| 174 <dt>Return:</dt> | |
| 175 <dd> | |
| 176 file name (string) | |
| 177 </dd> | |
| 178 </dl> | |
| 179 <div align="right"><a href="#top">Up</a></div> | |
| 180 <hr /> | |
| 181 <hr /> | |
| 182 <a NAME="getHtmlPage" ID="getHtmlPage"></a> | |
| 183 <h2>getHtmlPage</h2> | |
| 184 <b>getHtmlPage</b>(<i>pageFileName</i>) | |
| 185 | |
| 186 <p> | |
| 187 Module function to load a HTML page. | |
| 188 </p> | |
| 189 <p> | |
| 190 Note: If the given HTML file path is not absolute, it is assumed to | |
| 191 denote a HTML file in the html data directory. | |
| 192 </p> | |
| 193 <dl> | |
| 194 | |
| 195 <dt><i>pageFileName</i> (str)</dt> | |
| 196 <dd> | |
| 197 file name of the HTML file | |
| 198 </dd> | |
| 199 </dl> | |
| 200 <dl> | |
| 201 <dt>Return:</dt> | |
| 202 <dd> | |
| 203 HTML page | |
| 204 </dd> | |
| 205 </dl> | |
| 206 <dl> | |
| 207 <dt>Return Type:</dt> | |
| 208 <dd> | |
| 209 str | |
| 210 </dd> | |
| 211 </dl> | |
| 212 <div align="right"><a href="#top">Up</a></div> | |
| 213 <hr /> | |
| 214 <hr /> | |
| 215 <a NAME="getJavascript" ID="getJavascript"></a> | |
| 216 <h2>getJavascript</h2> | |
| 217 <b>getJavascript</b>(<i>jsFileName</i>) | |
| 218 | |
| 219 <p> | |
| 220 Module function to load a JavaScript source file. | |
| 221 </p> | |
| 222 <p> | |
| 223 Note: If the given JavaScript source file path is not absolute, it is | |
| 224 assumed to denote a JavaScript source file in the javascript data | |
| 225 directory. | |
| 226 </p> | |
| 227 <dl> | |
| 228 | |
| 229 <dt><i>jsFileName</i> (str)</dt> | |
| 230 <dd> | |
| 231 file name of the JavaScript source file | |
| 232 </dd> | |
| 233 </dl> | |
| 234 <dl> | |
| 235 <dt>Return:</dt> | |
| 236 <dd> | |
| 237 JavaScript source | |
| 238 </dd> | |
| 239 </dl> | |
| 240 <dl> | |
| 241 <dt>Return Type:</dt> | |
| 242 <dd> | |
| 243 str | |
| 244 </dd> | |
| 245 </dl> | |
| 246 <div align="right"><a href="#top">Up</a></div> | |
| 247 <hr /> | |
| 248 <hr /> | |
| 249 <a NAME="getWebEngineVersions" ID="getWebEngineVersions"></a> | |
| 250 <h2>getWebEngineVersions</h2> | |
| 251 <b>getWebEngineVersions</b>(<i></i>) | |
| 252 | |
| 253 <p> | |
| 254 Module function to extract the web engine related versions from the default | |
| 255 user agent string. | |
| 256 </p> | |
| 257 <p> | |
| 258 Note: For PyQt 6.3.1 or newer the data is extracted via some Qt functions. | |
| 259 </p> | |
| 260 <dl> | |
| 261 <dt>Return:</dt> | |
| 262 <dd> | |
| 263 tuple containing the Chromium version, the Chromium security patch | |
| 264 version and the QtWebEngine version | |
| 265 </dd> | |
| 266 </dl> | |
| 267 <dl> | |
| 268 <dt>Return Type:</dt> | |
| 269 <dd> | |
| 270 tuple of (str, str, str) | |
| 271 </dd> | |
| 272 </dl> | |
| 273 <div align="right"><a href="#top">Up</a></div> | |
| 274 <hr /> | |
| 275 <hr /> | |
| 276 <a NAME="pixmapFileToDataUrl" ID="pixmapFileToDataUrl"></a> | |
| 277 <h2>pixmapFileToDataUrl</h2> | |
| 278 <b>pixmapFileToDataUrl</b>(<i>pixmapFile, asString=False</i>) | |
| 279 | |
| 280 <p> | |
| 281 Module function to load a pixmap file and convert the pixmap to a | |
| 282 data: URL. | |
| 283 </p> | |
| 284 <p> | |
| 285 Note: If the given pixmap file path is not absolute, it is assumed to | |
| 286 denote a pixmap file in the icons data directory. | |
| 287 </p> | |
| 288 <dl> | |
| 289 | |
| 290 <dt><i>pixmapFile</i> (str)</dt> | |
| 291 <dd> | |
| 292 file name of the pixmap file | |
| 293 </dd> | |
| 294 <dt><i>asString</i> (bool)</dt> | |
| 295 <dd> | |
| 296 flag indicating a string representation is requested | |
| 297 </dd> | |
| 298 </dl> | |
| 299 <dl> | |
| 300 <dt>Return:</dt> | |
| 301 <dd> | |
| 302 data: URL | |
| 303 </dd> | |
| 304 </dl> | |
| 305 <dl> | |
| 306 <dt>Return Type:</dt> | |
| 307 <dd> | |
| 308 QUrl or str | |
| 309 </dd> | |
| 310 </dl> | |
| 311 <div align="right"><a href="#top">Up</a></div> | |
| 312 <hr /> | |
| 313 <hr /> | |
| 314 <a NAME="pixmapFromByteArray" ID="pixmapFromByteArray"></a> | |
| 315 <h2>pixmapFromByteArray</h2> | |
| 316 <b>pixmapFromByteArray</b>(<i>data</i>) | |
| 317 | |
| 318 <p> | |
| 319 Module function to convert a byte array to a pixmap. | |
| 320 </p> | |
| 321 <dl> | |
| 322 | |
| 323 <dt><i>data</i> (bytes or QByteArray)</dt> | |
| 324 <dd> | |
| 325 data for the pixmap | |
| 326 </dd> | |
| 327 </dl> | |
| 328 <dl> | |
| 329 <dt>Return:</dt> | |
| 330 <dd> | |
| 331 extracted pixmap | |
| 332 </dd> | |
| 333 </dl> | |
| 334 <dl> | |
| 335 <dt>Return Type:</dt> | |
| 336 <dd> | |
| 337 QPixmap | |
| 338 </dd> | |
| 339 </dl> | |
| 340 <div align="right"><a href="#top">Up</a></div> | |
| 341 <hr /> | |
| 342 <hr /> | |
| 343 <a NAME="pixmapToByteArray" ID="pixmapToByteArray"></a> | |
| 344 <h2>pixmapToByteArray</h2> | |
| 345 <b>pixmapToByteArray</b>(<i>pixmap</i>) | |
| 346 | |
| 347 <p> | |
| 348 Module function to convert a pixmap to a byte array containing the pixmap | |
| 349 as a PNG encoded as base64. | |
| 350 </p> | |
| 351 <dl> | |
| 352 | |
| 353 <dt><i>pixmap</i> (QPixmap)</dt> | |
| 354 <dd> | |
| 355 pixmap to be converted | |
| 356 </dd> | |
| 357 </dl> | |
| 358 <dl> | |
| 359 <dt>Return:</dt> | |
| 360 <dd> | |
| 361 byte array containing the pixmap | |
| 362 </dd> | |
| 363 </dl> | |
| 364 <dl> | |
| 365 <dt>Return Type:</dt> | |
| 366 <dd> | |
| 367 QByteArray | |
| 368 </dd> | |
| 369 </dl> | |
| 370 <div align="right"><a href="#top">Up</a></div> | |
| 371 <hr /> | |
| 372 <hr /> | |
| 373 <a NAME="pixmapToDataUrl" ID="pixmapToDataUrl"></a> | |
| 374 <h2>pixmapToDataUrl</h2> | |
| 375 <b>pixmapToDataUrl</b>(<i>pixmap, mimetype="image/png"</i>) | |
| 376 | |
| 377 <p> | |
| 378 Module function to convert a pixmap to a data: URL. | |
| 379 </p> | |
| 380 <dl> | |
| 381 | |
| 382 <dt><i>pixmap</i> (QPixmap)</dt> | |
| 383 <dd> | |
| 384 pixmap to be converted | |
| 385 </dd> | |
| 386 <dt><i>mimetype</i> (str)</dt> | |
| 387 <dd> | |
| 388 MIME type to be used | |
| 389 </dd> | |
| 390 </dl> | |
| 391 <dl> | |
| 392 <dt>Return:</dt> | |
| 393 <dd> | |
| 394 data: URL | |
| 395 </dd> | |
| 396 </dl> | |
| 397 <dl> | |
| 398 <dt>Return Type:</dt> | |
| 399 <dd> | |
| 400 QUrl | |
| 401 </dd> | |
| 402 </dl> | |
| 403 <div align="right"><a href="#top">Up</a></div> | |
| 404 <hr /> | |
| 405 <hr /> | |
| 406 <a NAME="readAllFileContents" ID="readAllFileContents"></a> | |
| 407 <h2>readAllFileContents</h2> | |
| 408 <b>readAllFileContents</b>(<i>filename</i>) | |
| 409 | |
| 410 <p> | |
| 411 Function to read the string contents of the given file. | |
| 412 </p> | |
| 413 <dl> | |
| 414 | |
| 415 <dt><i>filename</i> (str)</dt> | |
| 416 <dd> | |
| 417 name of the file | |
| 418 </dd> | |
| 419 </dl> | |
| 420 <dl> | |
| 421 <dt>Return:</dt> | |
| 422 <dd> | |
| 423 contents of the file | |
| 424 </dd> | |
| 425 </dl> | |
| 426 <dl> | |
| 427 <dt>Return Type:</dt> | |
| 428 <dd> | |
| 429 str | |
| 430 </dd> | |
| 431 </dl> | |
| 432 <div align="right"><a href="#top">Up</a></div> | |
| 433 <hr /> | |
| 434 </body></html> |
