Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.UI.Previewers.PreviewerHTML.html
src/eric7/Documentation/Source/eric7.UI.Previewers.PreviewerHTML.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 9236
- db53a9efe7ef
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.UI.Previewers.PreviewerHTML</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.UI.Previewers.PreviewerHTML</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a previewer widget for HTML, Markdown and ReST files. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#PreviewProcessingThread">PreviewProcessingThread</a></td> | |
| 25 <td>Class implementing a thread to process some text into HTML usable by the previewer view.</td> | |
| 26 </tr> | |
| 27 <tr> | |
| 28 <td><a href="#PreviewerHTML">PreviewerHTML</a></td> | |
| 29 <td>Class implementing a previewer widget for HTML, Markdown and ReST files.</td> | |
| 30 </tr> | |
| 31 </table> | |
| 32 <h3>Functions</h3> | |
| 33 | |
| 34 <table> | |
| 35 <tr><td>None</td></tr> | |
| 36 </table> | |
| 37 <hr /> | |
| 38 <hr /> | |
| 39 <a NAME="PreviewProcessingThread" ID="PreviewProcessingThread"></a> | |
| 40 <h2>PreviewProcessingThread</h2> | |
| 41 | |
| 42 <p> | |
| 43 Class implementing a thread to process some text into HTML usable by the | |
| 44 previewer view. | |
| 45 </p> | |
| 46 <h3>Signals</h3> | |
| 47 <dl> | |
| 48 | |
| 49 <dt>htmlReady(str, str, str)</dt> | |
| 50 <dd> | |
| 51 emitted with the file name, the processed | |
| 52 HTML and the web site root path to signal the availability of the | |
| 53 processed HTML | |
| 54 </dd> | |
| 55 </dl> | |
| 56 <h3>Derived from</h3> | |
| 57 QThread | |
| 58 <h3>Class Attributes</h3> | |
| 59 | |
| 60 <table> | |
| 61 <tr><td>None</td></tr> | |
| 62 </table> | |
| 63 <h3>Class Methods</h3> | |
| 64 | |
| 65 <table> | |
| 66 <tr><td>None</td></tr> | |
| 67 </table> | |
| 68 <h3>Methods</h3> | |
| 69 | |
| 70 <table> | |
| 71 | |
| 72 <tr> | |
| 73 <td><a href="#PreviewProcessingThread.__init__">PreviewProcessingThread</a></td> | |
| 74 <td>Constructor</td> | |
| 75 </tr> | |
| 76 <tr> | |
| 77 <td><a href="#PreviewProcessingThread.__convertMarkdown">__convertMarkdown</a></td> | |
| 78 <td>Private method to convert Markdown text into HTML.</td> | |
| 79 </tr> | |
| 80 <tr> | |
| 81 <td><a href="#PreviewProcessingThread.__convertReST">__convertReST</a></td> | |
| 82 <td>Private method to convert ReST text into HTML.</td> | |
| 83 </tr> | |
| 84 <tr> | |
| 85 <td><a href="#PreviewProcessingThread.__convertReSTDocutils">__convertReSTDocutils</a></td> | |
| 86 <td>Private method to convert ReST text into HTML using 'docutils'.</td> | |
| 87 </tr> | |
| 88 <tr> | |
| 89 <td><a href="#PreviewProcessingThread.__convertReSTSphinx">__convertReSTSphinx</a></td> | |
| 90 <td>Private method to convert ReST text into HTML using 'sphinx'.</td> | |
| 91 </tr> | |
| 92 <tr> | |
| 93 <td><a href="#PreviewProcessingThread.__getHtml">__getHtml</a></td> | |
| 94 <td>Private method to process the given text depending upon the given language.</td> | |
| 95 </tr> | |
| 96 <tr> | |
| 97 <td><a href="#PreviewProcessingThread.__processRootPath">__processRootPath</a></td> | |
| 98 <td>Private method to adjust absolute references to the given root path.</td> | |
| 99 </tr> | |
| 100 <tr> | |
| 101 <td><a href="#PreviewProcessingThread.__processSSI">__processSSI</a></td> | |
| 102 <td>Private method to process the given text for SSI statements.</td> | |
| 103 </tr> | |
| 104 <tr> | |
| 105 <td><a href="#PreviewProcessingThread.process">process</a></td> | |
| 106 <td>Public method to convert the given text to HTML.</td> | |
| 107 </tr> | |
| 108 <tr> | |
| 109 <td><a href="#PreviewProcessingThread.run">run</a></td> | |
| 110 <td>Public thread method to convert the stored data.</td> | |
| 111 </tr> | |
| 112 </table> | |
| 113 <h3>Static Methods</h3> | |
| 114 | |
| 115 <table> | |
| 116 <tr><td>None</td></tr> | |
| 117 </table> | |
| 118 | |
| 119 <a NAME="PreviewProcessingThread.__init__" ID="PreviewProcessingThread.__init__"></a> | |
| 120 <h4>PreviewProcessingThread (Constructor)</h4> | |
| 121 <b>PreviewProcessingThread</b>(<i>parent=None</i>) | |
| 122 | |
| 123 <p> | |
| 124 Constructor | |
| 125 </p> | |
| 126 <dl> | |
| 127 | |
| 128 <dt><i>parent</i></dt> | |
| 129 <dd> | |
| 130 reference to the parent object (QObject) | |
| 131 </dd> | |
| 132 </dl> | |
| 133 <a NAME="PreviewProcessingThread.__convertMarkdown" ID="PreviewProcessingThread.__convertMarkdown"></a> | |
| 134 <h4>PreviewProcessingThread.__convertMarkdown</h4> | |
| 135 <b>__convertMarkdown</b>(<i>text, convertNewLineToBreak, usePyMdownExtensions, htmlFormat</i>) | |
| 136 | |
| 137 <p> | |
| 138 Private method to convert Markdown text into HTML. | |
| 139 </p> | |
| 140 <dl> | |
| 141 | |
| 142 <dt><i>text</i> (str)</dt> | |
| 143 <dd> | |
| 144 text to be processed | |
| 145 </dd> | |
| 146 <dt><i>convertNewLineToBreak</i> (bool)</dt> | |
| 147 <dd> | |
| 148 flag indicating to convert new lines | |
| 149 to HTML break (Markdown only) | |
| 150 </dd> | |
| 151 <dt><i>usePyMdownExtensions</i> (bool)</dt> | |
| 152 <dd> | |
| 153 flag indicating to enable the PyMdown | |
| 154 extensions, if they are available | |
| 155 </dd> | |
| 156 <dt><i>htmlFormat</i> (str)</dt> | |
| 157 <dd> | |
| 158 HTML format to be generated by markdown | |
| 159 </dd> | |
| 160 </dl> | |
| 161 <dl> | |
| 162 <dt>Return:</dt> | |
| 163 <dd> | |
| 164 processed HTML | |
| 165 </dd> | |
| 166 </dl> | |
| 167 <dl> | |
| 168 <dt>Return Type:</dt> | |
| 169 <dd> | |
| 170 str | |
| 171 </dd> | |
| 172 </dl> | |
| 173 <a NAME="PreviewProcessingThread.__convertReST" ID="PreviewProcessingThread.__convertReST"></a> | |
| 174 <h4>PreviewProcessingThread.__convertReST</h4> | |
| 175 <b>__convertReST</b>(<i>text, useSphinx, restDocutilsHtmlFormat</i>) | |
| 176 | |
| 177 <p> | |
| 178 Private method to convert ReST text into HTML. | |
| 179 </p> | |
| 180 <dl> | |
| 181 | |
| 182 <dt><i>text</i></dt> | |
| 183 <dd> | |
| 184 text to be processed (string) | |
| 185 </dd> | |
| 186 <dt><i>useSphinx</i></dt> | |
| 187 <dd> | |
| 188 flag indicating to use Sphinx to generate the | |
| 189 ReST preview (boolean) | |
| 190 </dd> | |
| 191 <dt><i>restDocutilsHtmlFormat</i></dt> | |
| 192 <dd> | |
| 193 HTML format to be generated by docutils | |
| 194 (string) | |
| 195 </dd> | |
| 196 </dl> | |
| 197 <dl> | |
| 198 <dt>Return:</dt> | |
| 199 <dd> | |
| 200 processed HTML (string) | |
| 201 </dd> | |
| 202 </dl> | |
| 203 <a NAME="PreviewProcessingThread.__convertReSTDocutils" ID="PreviewProcessingThread.__convertReSTDocutils"></a> | |
| 204 <h4>PreviewProcessingThread.__convertReSTDocutils</h4> | |
| 205 <b>__convertReSTDocutils</b>(<i>text, htmlFormat</i>) | |
| 206 | |
| 207 <p> | |
| 208 Private method to convert ReST text into HTML using 'docutils'. | |
| 209 </p> | |
| 210 <dl> | |
| 211 | |
| 212 <dt><i>text</i></dt> | |
| 213 <dd> | |
| 214 text to be processed (string) | |
| 215 </dd> | |
| 216 <dt><i>htmlFormat</i></dt> | |
| 217 <dd> | |
| 218 HTML format to be generated (string) | |
| 219 </dd> | |
| 220 </dl> | |
| 221 <dl> | |
| 222 <dt>Return:</dt> | |
| 223 <dd> | |
| 224 processed HTML (string) | |
| 225 </dd> | |
| 226 </dl> | |
| 227 <a NAME="PreviewProcessingThread.__convertReSTSphinx" ID="PreviewProcessingThread.__convertReSTSphinx"></a> | |
| 228 <h4>PreviewProcessingThread.__convertReSTSphinx</h4> | |
| 229 <b>__convertReSTSphinx</b>(<i>text</i>) | |
| 230 | |
| 231 <p> | |
| 232 Private method to convert ReST text into HTML using 'sphinx'. | |
| 233 </p> | |
| 234 <dl> | |
| 235 | |
| 236 <dt><i>text</i></dt> | |
| 237 <dd> | |
| 238 text to be processed (string) | |
| 239 </dd> | |
| 240 </dl> | |
| 241 <dl> | |
| 242 <dt>Return:</dt> | |
| 243 <dd> | |
| 244 processed HTML (string) | |
| 245 </dd> | |
| 246 </dl> | |
| 247 <a NAME="PreviewProcessingThread.__getHtml" ID="PreviewProcessingThread.__getHtml"></a> | |
| 248 <h4>PreviewProcessingThread.__getHtml</h4> | |
| 249 <b>__getHtml</b>(<i>language, text, ssiEnabled, filePath, rootPath, useSphinx, convertNewLineToBreak, usePyMdownExtensions, markdownHtmlFormat, restDocutilsHtmlFormat</i>) | |
| 250 | |
| 251 <p> | |
| 252 Private method to process the given text depending upon the given | |
| 253 language. | |
| 254 </p> | |
| 255 <dl> | |
| 256 | |
| 257 <dt><i>language</i> (str)</dt> | |
| 258 <dd> | |
| 259 language of the text | |
| 260 </dd> | |
| 261 <dt><i>text</i> (str)</dt> | |
| 262 <dd> | |
| 263 to be processed | |
| 264 </dd> | |
| 265 <dt><i>ssiEnabled</i> (bool)</dt> | |
| 266 <dd> | |
| 267 flag indicating to do some (limited) SSI processing | |
| 268 </dd> | |
| 269 <dt><i>filePath</i> (str)</dt> | |
| 270 <dd> | |
| 271 file path of the text | |
| 272 </dd> | |
| 273 <dt><i>rootPath</i> (str)</dt> | |
| 274 <dd> | |
| 275 root path to be used for SSI processing | |
| 276 </dd> | |
| 277 <dt><i>useSphinx</i> (bool)</dt> | |
| 278 <dd> | |
| 279 flag indicating to use Sphinx to generate the | |
| 280 ReST preview | |
| 281 </dd> | |
| 282 <dt><i>convertNewLineToBreak</i> (bool)</dt> | |
| 283 <dd> | |
| 284 flag indicating to convert new lines | |
| 285 to HTML break (Markdown only) | |
| 286 </dd> | |
| 287 <dt><i>usePyMdownExtensions</i> (bool)</dt> | |
| 288 <dd> | |
| 289 flag indicating to enable the PyMdown | |
| 290 extensions, if they are available | |
| 291 </dd> | |
| 292 <dt><i>markdownHtmlFormat</i> (str)</dt> | |
| 293 <dd> | |
| 294 HTML format to be generated by markdown | |
| 295 </dd> | |
| 296 <dt><i>restDocutilsHtmlFormat</i> (str)</dt> | |
| 297 <dd> | |
| 298 HTML format to be generated by docutils | |
| 299 </dd> | |
| 300 </dl> | |
| 301 <dl> | |
| 302 <dt>Return:</dt> | |
| 303 <dd> | |
| 304 processed HTML text | |
| 305 </dd> | |
| 306 </dl> | |
| 307 <dl> | |
| 308 <dt>Return Type:</dt> | |
| 309 <dd> | |
| 310 str | |
| 311 </dd> | |
| 312 </dl> | |
| 313 <a NAME="PreviewProcessingThread.__processRootPath" ID="PreviewProcessingThread.__processRootPath"></a> | |
| 314 <h4>PreviewProcessingThread.__processRootPath</h4> | |
| 315 <b>__processRootPath</b>(<i>txt, root</i>) | |
| 316 | |
| 317 <p> | |
| 318 Private method to adjust absolute references to the given root path. | |
| 319 </p> | |
| 320 <dl> | |
| 321 | |
| 322 <dt><i>txt</i> (str)</dt> | |
| 323 <dd> | |
| 324 text to be processed | |
| 325 </dd> | |
| 326 <dt><i>root</i> (str)</dt> | |
| 327 <dd> | |
| 328 directory of the document root | |
| 329 </dd> | |
| 330 </dl> | |
| 331 <dl> | |
| 332 <dt>Return:</dt> | |
| 333 <dd> | |
| 334 processed HTML | |
| 335 </dd> | |
| 336 </dl> | |
| 337 <dl> | |
| 338 <dt>Return Type:</dt> | |
| 339 <dd> | |
| 340 str | |
| 341 </dd> | |
| 342 </dl> | |
| 343 <a NAME="PreviewProcessingThread.__processSSI" ID="PreviewProcessingThread.__processSSI"></a> | |
| 344 <h4>PreviewProcessingThread.__processSSI</h4> | |
| 345 <b>__processSSI</b>(<i>txt, filename, root</i>) | |
| 346 | |
| 347 <p> | |
| 348 Private method to process the given text for SSI statements. | |
| 349 </p> | |
| 350 <p> | |
| 351 Note: Only a limited subset of SSI statements are supported. | |
| 352 </p> | |
| 353 <dl> | |
| 354 | |
| 355 <dt><i>txt</i></dt> | |
| 356 <dd> | |
| 357 text to be processed (string) | |
| 358 </dd> | |
| 359 <dt><i>filename</i></dt> | |
| 360 <dd> | |
| 361 name of the file associated with the given text | |
| 362 (string) | |
| 363 </dd> | |
| 364 <dt><i>root</i></dt> | |
| 365 <dd> | |
| 366 directory of the document root (string) | |
| 367 </dd> | |
| 368 </dl> | |
| 369 <dl> | |
| 370 <dt>Return:</dt> | |
| 371 <dd> | |
| 372 processed HTML (string) | |
| 373 </dd> | |
| 374 </dl> | |
| 375 <a NAME="PreviewProcessingThread.process" ID="PreviewProcessingThread.process"></a> | |
| 376 <h4>PreviewProcessingThread.process</h4> | |
| 377 <b>process</b>(<i>filePath, language, text, ssiEnabled, rootPath, useSphinx, convertNewLineToBreak, usePyMdownExtensions, markdownHtmlFormat, restDocutilsHtmlFormat</i>) | |
| 378 | |
| 379 <p> | |
| 380 Public method to convert the given text to HTML. | |
| 381 </p> | |
| 382 <dl> | |
| 383 | |
| 384 <dt><i>filePath</i> (str)</dt> | |
| 385 <dd> | |
| 386 file path of the text | |
| 387 </dd> | |
| 388 <dt><i>language</i> (str)</dt> | |
| 389 <dd> | |
| 390 language of the text | |
| 391 </dd> | |
| 392 <dt><i>text</i> (str)</dt> | |
| 393 <dd> | |
| 394 text to be processed | |
| 395 </dd> | |
| 396 <dt><i>ssiEnabled</i> (bool)</dt> | |
| 397 <dd> | |
| 398 flag indicating to do some (limited) SSI processing | |
| 399 </dd> | |
| 400 <dt><i>rootPath</i> (str)</dt> | |
| 401 <dd> | |
| 402 root path to be used for SSI processing | |
| 403 </dd> | |
| 404 <dt><i>useSphinx</i> (bool)</dt> | |
| 405 <dd> | |
| 406 flag indicating to use Sphinx to generate the | |
| 407 ReST preview | |
| 408 </dd> | |
| 409 <dt><i>convertNewLineToBreak</i> (bool)</dt> | |
| 410 <dd> | |
| 411 flag indicating to convert new lines | |
| 412 to HTML break (Markdown only) | |
| 413 </dd> | |
| 414 <dt><i>usePyMdownExtensions</i> (bool)</dt> | |
| 415 <dd> | |
| 416 flag indicating to enable the PyMdown | |
| 417 extensions, if they are available | |
| 418 </dd> | |
| 419 <dt><i>markdownHtmlFormat</i> (str)</dt> | |
| 420 <dd> | |
| 421 HTML format to be generated by markdown | |
| 422 </dd> | |
| 423 <dt><i>restDocutilsHtmlFormat</i> (str)</dt> | |
| 424 <dd> | |
| 425 HTML format to be generated by docutils | |
| 426 </dd> | |
| 427 </dl> | |
| 428 <a NAME="PreviewProcessingThread.run" ID="PreviewProcessingThread.run"></a> | |
| 429 <h4>PreviewProcessingThread.run</h4> | |
| 430 <b>run</b>(<i></i>) | |
| 431 | |
| 432 <p> | |
| 433 Public thread method to convert the stored data. | |
| 434 </p> | |
| 435 <div align="right"><a href="#top">Up</a></div> | |
| 436 <hr /> | |
| 437 <hr /> | |
| 438 <a NAME="PreviewerHTML" ID="PreviewerHTML"></a> | |
| 439 <h2>PreviewerHTML</h2> | |
| 440 | |
| 441 <p> | |
| 442 Class implementing a previewer widget for HTML, Markdown and ReST files. | |
| 443 </p> | |
| 444 <h3>Derived from</h3> | |
| 445 QWidget | |
| 446 <h3>Class Attributes</h3> | |
| 447 | |
| 448 <table> | |
| 449 <tr><td>None</td></tr> | |
| 450 </table> | |
| 451 <h3>Class Methods</h3> | |
| 452 | |
| 453 <table> | |
| 454 <tr><td>None</td></tr> | |
| 455 </table> | |
| 456 <h3>Methods</h3> | |
| 457 | |
| 458 <table> | |
| 459 | |
| 460 <tr> | |
| 461 <td><a href="#PreviewerHTML.__init__">PreviewerHTML</a></td> | |
| 462 <td>Constructor</td> | |
| 463 </tr> | |
| 464 <tr> | |
| 465 <td><a href="#PreviewerHTML.__execJavaScript">__execJavaScript</a></td> | |
| 466 <td>Private function to execute a JavaScript function Synchroneously.</td> | |
| 467 </tr> | |
| 468 <tr> | |
| 469 <td><a href="#PreviewerHTML.__restoreScrollBarPositions">__restoreScrollBarPositions</a></td> | |
| 470 <td>Private method to restore scroll bar positions for a previewed editor.</td> | |
| 471 </tr> | |
| 472 <tr> | |
| 473 <td><a href="#PreviewerHTML.__saveScrollBarPositions">__saveScrollBarPositions</a></td> | |
| 474 <td>Private method to save scroll bar positions for a previewed editor.</td> | |
| 475 </tr> | |
| 476 <tr> | |
| 477 <td><a href="#PreviewerHTML.__setHtml">__setHtml</a></td> | |
| 478 <td>Private method to set the HTML to the view and restore the scroll bars positions.</td> | |
| 479 </tr> | |
| 480 <tr> | |
| 481 <td><a href="#PreviewerHTML.__setJavaScriptEnabled">__setJavaScriptEnabled</a></td> | |
| 482 <td>Private method to enable/disable JavaScript.</td> | |
| 483 </tr> | |
| 484 <tr> | |
| 485 <td><a href="#PreviewerHTML.__showLink">__showLink</a></td> | |
| 486 <td>Private slot to show the hovered link in a tooltip.</td> | |
| 487 </tr> | |
| 488 <tr> | |
| 489 <td><a href="#PreviewerHTML.on_jsCheckBox_clicked">on_jsCheckBox_clicked</a></td> | |
| 490 <td>Private slot to enable/disable JavaScript.</td> | |
| 491 </tr> | |
| 492 <tr> | |
| 493 <td><a href="#PreviewerHTML.on_previewView_titleChanged">on_previewView_titleChanged</a></td> | |
| 494 <td>Private slot to handle a change of the title.</td> | |
| 495 </tr> | |
| 496 <tr> | |
| 497 <td><a href="#PreviewerHTML.on_ssiCheckBox_clicked">on_ssiCheckBox_clicked</a></td> | |
| 498 <td>Private slot to enable/disable SSI.</td> | |
| 499 </tr> | |
| 500 <tr> | |
| 501 <td><a href="#PreviewerHTML.processEditor">processEditor</a></td> | |
| 502 <td>Public slot to process an editor's text.</td> | |
| 503 </tr> | |
| 504 <tr> | |
| 505 <td><a href="#PreviewerHTML.resultCallback">resultCallback</a></td> | |
| 506 <td></td> | |
| 507 </tr> | |
| 508 <tr> | |
| 509 <td><a href="#PreviewerHTML.shutdown">shutdown</a></td> | |
| 510 <td>Public method to perform shutdown actions.</td> | |
| 511 </tr> | |
| 512 </table> | |
| 513 <h3>Static Methods</h3> | |
| 514 | |
| 515 <table> | |
| 516 <tr><td>None</td></tr> | |
| 517 </table> | |
| 518 | |
| 519 <a NAME="PreviewerHTML.__init__" ID="PreviewerHTML.__init__"></a> | |
| 520 <h4>PreviewerHTML (Constructor)</h4> | |
| 521 <b>PreviewerHTML</b>(<i>parent=None</i>) | |
| 522 | |
| 523 <p> | |
| 524 Constructor | |
| 525 </p> | |
| 526 <dl> | |
| 527 | |
| 528 <dt><i>parent</i></dt> | |
| 529 <dd> | |
| 530 reference to the parent widget (QWidget) | |
| 531 </dd> | |
| 532 </dl> | |
| 533 <a NAME="PreviewerHTML.__execJavaScript" ID="PreviewerHTML.__execJavaScript"></a> | |
| 534 <h4>PreviewerHTML.__execJavaScript</h4> | |
| 535 <b>__execJavaScript</b>(<i>script</i>) | |
| 536 | |
| 537 <p> | |
| 538 Private function to execute a JavaScript function Synchroneously. | |
| 539 </p> | |
| 540 <dl> | |
| 541 | |
| 542 <dt><i>script</i> (str)</dt> | |
| 543 <dd> | |
| 544 JavaScript script source to be executed | |
| 545 </dd> | |
| 546 </dl> | |
| 547 <dl> | |
| 548 <dt>Return:</dt> | |
| 549 <dd> | |
| 550 result of the script | |
| 551 </dd> | |
| 552 </dl> | |
| 553 <dl> | |
| 554 <dt>Return Type:</dt> | |
| 555 <dd> | |
| 556 depending upon script result | |
| 557 </dd> | |
| 558 </dl> | |
| 559 <a NAME="PreviewerHTML.__restoreScrollBarPositions" ID="PreviewerHTML.__restoreScrollBarPositions"></a> | |
| 560 <h4>PreviewerHTML.__restoreScrollBarPositions</h4> | |
| 561 <b>__restoreScrollBarPositions</b>(<i></i>) | |
| 562 | |
| 563 <p> | |
| 564 Private method to restore scroll bar positions for a previewed editor. | |
| 565 </p> | |
| 566 <a NAME="PreviewerHTML.__saveScrollBarPositions" ID="PreviewerHTML.__saveScrollBarPositions"></a> | |
| 567 <h4>PreviewerHTML.__saveScrollBarPositions</h4> | |
| 568 <b>__saveScrollBarPositions</b>(<i></i>) | |
| 569 | |
| 570 <p> | |
| 571 Private method to save scroll bar positions for a previewed editor. | |
| 572 </p> | |
| 573 <a NAME="PreviewerHTML.__setHtml" ID="PreviewerHTML.__setHtml"></a> | |
| 574 <h4>PreviewerHTML.__setHtml</h4> | |
| 575 <b>__setHtml</b>(<i>filePath, html, rootPath</i>) | |
| 576 | |
| 577 <p> | |
| 578 Private method to set the HTML to the view and restore the scroll bars | |
| 579 positions. | |
| 580 </p> | |
| 581 <dl> | |
| 582 | |
| 583 <dt><i>filePath</i> (str)</dt> | |
| 584 <dd> | |
| 585 file path of the previewed editor | |
| 586 </dd> | |
| 587 <dt><i>html</i> (str)</dt> | |
| 588 <dd> | |
| 589 processed HTML text ready to be shown | |
| 590 </dd> | |
| 591 <dt><i>rootPath</i> (str)</dt> | |
| 592 <dd> | |
| 593 path of the web site root | |
| 594 </dd> | |
| 595 </dl> | |
| 596 <a NAME="PreviewerHTML.__setJavaScriptEnabled" ID="PreviewerHTML.__setJavaScriptEnabled"></a> | |
| 597 <h4>PreviewerHTML.__setJavaScriptEnabled</h4> | |
| 598 <b>__setJavaScriptEnabled</b>(<i>enable</i>) | |
| 599 | |
| 600 <p> | |
| 601 Private method to enable/disable JavaScript. | |
| 602 </p> | |
| 603 <dl> | |
| 604 | |
| 605 <dt><i>enable</i></dt> | |
| 606 <dd> | |
| 607 flag indicating the enable state (boolean) | |
| 608 </dd> | |
| 609 </dl> | |
| 610 <a NAME="PreviewerHTML.__showLink" ID="PreviewerHTML.__showLink"></a> | |
| 611 <h4>PreviewerHTML.__showLink</h4> | |
| 612 <b>__showLink</b>(<i>urlStr</i>) | |
| 613 | |
| 614 <p> | |
| 615 Private slot to show the hovered link in a tooltip. | |
| 616 </p> | |
| 617 <dl> | |
| 618 | |
| 619 <dt><i>urlStr</i> (str)</dt> | |
| 620 <dd> | |
| 621 hovered URL | |
| 622 </dd> | |
| 623 </dl> | |
| 624 <a NAME="PreviewerHTML.on_jsCheckBox_clicked" ID="PreviewerHTML.on_jsCheckBox_clicked"></a> | |
| 625 <h4>PreviewerHTML.on_jsCheckBox_clicked</h4> | |
| 626 <b>on_jsCheckBox_clicked</b>(<i>checked</i>) | |
| 627 | |
| 628 <p> | |
| 629 Private slot to enable/disable JavaScript. | |
| 630 </p> | |
| 631 <dl> | |
| 632 | |
| 633 <dt><i>checked</i></dt> | |
| 634 <dd> | |
| 635 state of the checkbox (boolean) | |
| 636 </dd> | |
| 637 </dl> | |
| 638 <a NAME="PreviewerHTML.on_previewView_titleChanged" ID="PreviewerHTML.on_previewView_titleChanged"></a> | |
| 639 <h4>PreviewerHTML.on_previewView_titleChanged</h4> | |
| 640 <b>on_previewView_titleChanged</b>(<i>title</i>) | |
| 641 | |
| 642 <p> | |
| 643 Private slot to handle a change of the title. | |
| 644 </p> | |
| 645 <dl> | |
| 646 | |
| 647 <dt><i>title</i></dt> | |
| 648 <dd> | |
| 649 new title (string) | |
| 650 </dd> | |
| 651 </dl> | |
| 652 <a NAME="PreviewerHTML.on_ssiCheckBox_clicked" ID="PreviewerHTML.on_ssiCheckBox_clicked"></a> | |
| 653 <h4>PreviewerHTML.on_ssiCheckBox_clicked</h4> | |
| 654 <b>on_ssiCheckBox_clicked</b>(<i>checked</i>) | |
| 655 | |
| 656 <p> | |
| 657 Private slot to enable/disable SSI. | |
| 658 </p> | |
| 659 <dl> | |
| 660 | |
| 661 <dt><i>checked</i></dt> | |
| 662 <dd> | |
| 663 state of the checkbox (boolean) | |
| 664 </dd> | |
| 665 </dl> | |
| 666 <a NAME="PreviewerHTML.processEditor" ID="PreviewerHTML.processEditor"></a> | |
| 667 <h4>PreviewerHTML.processEditor</h4> | |
| 668 <b>processEditor</b>(<i>editor=None</i>) | |
| 669 | |
| 670 <p> | |
| 671 Public slot to process an editor's text. | |
| 672 </p> | |
| 673 <dl> | |
| 674 | |
| 675 <dt><i>editor</i></dt> | |
| 676 <dd> | |
| 677 editor to be processed (Editor) | |
| 678 </dd> | |
| 679 </dl> | |
| 680 <a NAME="PreviewerHTML.resultCallback" ID="PreviewerHTML.resultCallback"></a> | |
| 681 <h4>PreviewerHTML.resultCallback</h4> | |
| 682 <b>resultCallback</b>(<i>resDict=resultDict</i>) | |
| 683 | |
| 684 <a NAME="PreviewerHTML.shutdown" ID="PreviewerHTML.shutdown"></a> | |
| 685 <h4>PreviewerHTML.shutdown</h4> | |
| 686 <b>shutdown</b>(<i></i>) | |
| 687 | |
| 688 <p> | |
| 689 Public method to perform shutdown actions. | |
| 690 </p> | |
| 691 <div align="right"><a href="#top">Up</a></div> | |
| 692 <hr /> | |
| 693 </body></html> |
