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 10433
- 328f3ec4b77a
- parent 9447
- 662075aa9361
- child 10479
- 856476537696
equal
deleted
inserted
replaced
| 10432:2fe91fe443dd | 10433:328f3ec4b77a |
|---|---|
| 123 <p> | 123 <p> |
| 124 Constructor | 124 Constructor |
| 125 </p> | 125 </p> |
| 126 <dl> | 126 <dl> |
| 127 | 127 |
| 128 <dt><i>parent</i></dt> | 128 <dt><i>parent</i> (QObject)</dt> |
| 129 <dd> | 129 <dd> |
| 130 reference to the parent object (QObject) | 130 reference to the parent object |
| 131 </dd> | 131 </dd> |
| 132 </dl> | 132 </dl> |
| 133 <a NAME="PreviewProcessingThread.__convertMarkdown" ID="PreviewProcessingThread.__convertMarkdown"></a> | 133 <a NAME="PreviewProcessingThread.__convertMarkdown" ID="PreviewProcessingThread.__convertMarkdown"></a> |
| 134 <h4>PreviewProcessingThread.__convertMarkdown</h4> | 134 <h4>PreviewProcessingThread.__convertMarkdown</h4> |
| 135 <b>__convertMarkdown</b>(<i>text, convertNewLineToBreak, usePyMdownExtensions, htmlFormat</i>) | 135 <b>__convertMarkdown</b>(<i>text, convertNewLineToBreak, usePyMdownExtensions, htmlFormat</i>) |
| 177 <p> | 177 <p> |
| 178 Private method to convert ReST text into HTML. | 178 Private method to convert ReST text into HTML. |
| 179 </p> | 179 </p> |
| 180 <dl> | 180 <dl> |
| 181 | 181 |
| 182 <dt><i>text</i></dt> | 182 <dt><i>text</i> (str)</dt> |
| 183 <dd> | 183 <dd> |
| 184 text to be processed (string) | 184 text to be processed |
| 185 </dd> | 185 </dd> |
| 186 <dt><i>useSphinx</i></dt> | 186 <dt><i>useSphinx</i> (bool)</dt> |
| 187 <dd> | 187 <dd> |
| 188 flag indicating to use Sphinx to generate the | 188 flag indicating to use Sphinx to generate the |
| 189 ReST preview (boolean) | 189 ReST preview |
| 190 </dd> | 190 </dd> |
| 191 <dt><i>restDocutilsHtmlFormat</i></dt> | 191 <dt><i>restDocutilsHtmlFormat</i> (str)</dt> |
| 192 <dd> | 192 <dd> |
| 193 HTML format to be generated by docutils | 193 HTML format to be generated by docutils |
| 194 (string) | |
| 195 </dd> | 194 </dd> |
| 196 </dl> | 195 </dl> |
| 197 <dl> | 196 <dl> |
| 198 <dt>Return:</dt> | 197 <dt>Return:</dt> |
| 199 <dd> | 198 <dd> |
| 200 processed HTML (string) | 199 processed HTML |
| 200 </dd> | |
| 201 </dl> | |
| 202 <dl> | |
| 203 <dt>Return Type:</dt> | |
| 204 <dd> | |
| 205 str | |
| 201 </dd> | 206 </dd> |
| 202 </dl> | 207 </dl> |
| 203 <a NAME="PreviewProcessingThread.__convertReSTDocutils" ID="PreviewProcessingThread.__convertReSTDocutils"></a> | 208 <a NAME="PreviewProcessingThread.__convertReSTDocutils" ID="PreviewProcessingThread.__convertReSTDocutils"></a> |
| 204 <h4>PreviewProcessingThread.__convertReSTDocutils</h4> | 209 <h4>PreviewProcessingThread.__convertReSTDocutils</h4> |
| 205 <b>__convertReSTDocutils</b>(<i>text, htmlFormat</i>) | 210 <b>__convertReSTDocutils</b>(<i>text, htmlFormat</i>) |
| 207 <p> | 212 <p> |
| 208 Private method to convert ReST text into HTML using 'docutils'. | 213 Private method to convert ReST text into HTML using 'docutils'. |
| 209 </p> | 214 </p> |
| 210 <dl> | 215 <dl> |
| 211 | 216 |
| 212 <dt><i>text</i></dt> | 217 <dt><i>text</i> (str)</dt> |
| 213 <dd> | 218 <dd> |
| 214 text to be processed (string) | 219 text to be processed |
| 215 </dd> | 220 </dd> |
| 216 <dt><i>htmlFormat</i></dt> | 221 <dt><i>htmlFormat</i> (str)</dt> |
| 217 <dd> | 222 <dd> |
| 218 HTML format to be generated (string) | 223 HTML format to be generated |
| 219 </dd> | 224 </dd> |
| 220 </dl> | 225 </dl> |
| 221 <dl> | 226 <dl> |
| 222 <dt>Return:</dt> | 227 <dt>Return:</dt> |
| 223 <dd> | 228 <dd> |
| 224 processed HTML (string) | 229 processed HTML |
| 230 </dd> | |
| 231 </dl> | |
| 232 <dl> | |
| 233 <dt>Return Type:</dt> | |
| 234 <dd> | |
| 235 str | |
| 225 </dd> | 236 </dd> |
| 226 </dl> | 237 </dl> |
| 227 <a NAME="PreviewProcessingThread.__convertReSTSphinx" ID="PreviewProcessingThread.__convertReSTSphinx"></a> | 238 <a NAME="PreviewProcessingThread.__convertReSTSphinx" ID="PreviewProcessingThread.__convertReSTSphinx"></a> |
| 228 <h4>PreviewProcessingThread.__convertReSTSphinx</h4> | 239 <h4>PreviewProcessingThread.__convertReSTSphinx</h4> |
| 229 <b>__convertReSTSphinx</b>(<i>text</i>) | 240 <b>__convertReSTSphinx</b>(<i>text</i>) |
| 231 <p> | 242 <p> |
| 232 Private method to convert ReST text into HTML using 'sphinx'. | 243 Private method to convert ReST text into HTML using 'sphinx'. |
| 233 </p> | 244 </p> |
| 234 <dl> | 245 <dl> |
| 235 | 246 |
| 236 <dt><i>text</i></dt> | 247 <dt><i>text</i> (str)</dt> |
| 237 <dd> | 248 <dd> |
| 238 text to be processed (string) | 249 text to be processed |
| 239 </dd> | 250 </dd> |
| 240 </dl> | 251 </dl> |
| 241 <dl> | 252 <dl> |
| 242 <dt>Return:</dt> | 253 <dt>Return:</dt> |
| 243 <dd> | 254 <dd> |
| 244 processed HTML (string) | 255 processed HTML |
| 256 </dd> | |
| 257 </dl> | |
| 258 <dl> | |
| 259 <dt>Return Type:</dt> | |
| 260 <dd> | |
| 261 str | |
| 245 </dd> | 262 </dd> |
| 246 </dl> | 263 </dl> |
| 247 <a NAME="PreviewProcessingThread.__getHtml" ID="PreviewProcessingThread.__getHtml"></a> | 264 <a NAME="PreviewProcessingThread.__getHtml" ID="PreviewProcessingThread.__getHtml"></a> |
| 248 <h4>PreviewProcessingThread.__getHtml</h4> | 265 <h4>PreviewProcessingThread.__getHtml</h4> |
| 249 <b>__getHtml</b>(<i>language, text, ssiEnabled, filePath, rootPath, useSphinx, convertNewLineToBreak, usePyMdownExtensions, markdownHtmlFormat, restDocutilsHtmlFormat, </i>) | 266 <b>__getHtml</b>(<i>language, text, ssiEnabled, filePath, rootPath, useSphinx, convertNewLineToBreak, usePyMdownExtensions, markdownHtmlFormat, restDocutilsHtmlFormat, </i>) |
| 350 <p> | 367 <p> |
| 351 Note: Only a limited subset of SSI statements are supported. | 368 Note: Only a limited subset of SSI statements are supported. |
| 352 </p> | 369 </p> |
| 353 <dl> | 370 <dl> |
| 354 | 371 |
| 355 <dt><i>txt</i></dt> | 372 <dt><i>txt</i> (str)</dt> |
| 356 <dd> | 373 <dd> |
| 357 text to be processed (string) | 374 text to be processed |
| 358 </dd> | 375 </dd> |
| 359 <dt><i>filename</i></dt> | 376 <dt><i>filename</i> (str)</dt> |
| 360 <dd> | 377 <dd> |
| 361 name of the file associated with the given text | 378 name of the file associated with the given text |
| 362 (string) | 379 </dd> |
| 363 </dd> | 380 <dt><i>root</i> (str)</dt> |
| 364 <dt><i>root</i></dt> | 381 <dd> |
| 365 <dd> | 382 directory of the document root |
| 366 directory of the document root (string) | |
| 367 </dd> | 383 </dd> |
| 368 </dl> | 384 </dl> |
| 369 <dl> | 385 <dl> |
| 370 <dt>Return:</dt> | 386 <dt>Return:</dt> |
| 371 <dd> | 387 <dd> |
| 372 processed HTML (string) | 388 processed HTML |
| 389 </dd> | |
| 390 </dl> | |
| 391 <dl> | |
| 392 <dt>Return Type:</dt> | |
| 393 <dd> | |
| 394 str | |
| 373 </dd> | 395 </dd> |
| 374 </dl> | 396 </dl> |
| 375 <a NAME="PreviewProcessingThread.process" ID="PreviewProcessingThread.process"></a> | 397 <a NAME="PreviewProcessingThread.process" ID="PreviewProcessingThread.process"></a> |
| 376 <h4>PreviewProcessingThread.process</h4> | 398 <h4>PreviewProcessingThread.process</h4> |
| 377 <b>process</b>(<i>filePath, language, text, ssiEnabled, rootPath, useSphinx, convertNewLineToBreak, usePyMdownExtensions, markdownHtmlFormat, restDocutilsHtmlFormat, </i>) | 399 <b>process</b>(<i>filePath, language, text, ssiEnabled, rootPath, useSphinx, convertNewLineToBreak, usePyMdownExtensions, markdownHtmlFormat, restDocutilsHtmlFormat, </i>) |
| 527 <p> | 549 <p> |
| 528 Constructor | 550 Constructor |
| 529 </p> | 551 </p> |
| 530 <dl> | 552 <dl> |
| 531 | 553 |
| 532 <dt><i>parent</i></dt> | 554 <dt><i>parent</i> (QWidget)</dt> |
| 533 <dd> | 555 <dd> |
| 534 reference to the parent widget (QWidget) | 556 reference to the parent widget |
| 535 </dd> | 557 </dd> |
| 536 </dl> | 558 </dl> |
| 537 <a NAME="PreviewerHTML.__execJavaScript" ID="PreviewerHTML.__execJavaScript"></a> | 559 <a NAME="PreviewerHTML.__execJavaScript" ID="PreviewerHTML.__execJavaScript"></a> |
| 538 <h4>PreviewerHTML.__execJavaScript</h4> | 560 <h4>PreviewerHTML.__execJavaScript</h4> |
| 539 <b>__execJavaScript</b>(<i>script</i>) | 561 <b>__execJavaScript</b>(<i>script</i>) |
| 604 <p> | 626 <p> |
| 605 Private method to enable/disable JavaScript. | 627 Private method to enable/disable JavaScript. |
| 606 </p> | 628 </p> |
| 607 <dl> | 629 <dl> |
| 608 | 630 |
| 609 <dt><i>enable</i></dt> | 631 <dt><i>enable</i> (bool)</dt> |
| 610 <dd> | 632 <dd> |
| 611 flag indicating the enable state (boolean) | 633 flag indicating the enable state |
| 612 </dd> | 634 </dd> |
| 613 </dl> | 635 </dl> |
| 614 <a NAME="PreviewerHTML.__showLink" ID="PreviewerHTML.__showLink"></a> | 636 <a NAME="PreviewerHTML.__showLink" ID="PreviewerHTML.__showLink"></a> |
| 615 <h4>PreviewerHTML.__showLink</h4> | 637 <h4>PreviewerHTML.__showLink</h4> |
| 616 <b>__showLink</b>(<i>urlStr</i>) | 638 <b>__showLink</b>(<i>urlStr</i>) |
| 639 <p> | 661 <p> |
| 640 Private slot to enable/disable JavaScript. | 662 Private slot to enable/disable JavaScript. |
| 641 </p> | 663 </p> |
| 642 <dl> | 664 <dl> |
| 643 | 665 |
| 644 <dt><i>checked</i></dt> | 666 <dt><i>checked</i> (bool)</dt> |
| 645 <dd> | 667 <dd> |
| 646 state of the checkbox (boolean) | 668 state of the checkbox |
| 647 </dd> | 669 </dd> |
| 648 </dl> | 670 </dl> |
| 649 <a NAME="PreviewerHTML.on_previewView_titleChanged" ID="PreviewerHTML.on_previewView_titleChanged"></a> | 671 <a NAME="PreviewerHTML.on_previewView_titleChanged" ID="PreviewerHTML.on_previewView_titleChanged"></a> |
| 650 <h4>PreviewerHTML.on_previewView_titleChanged</h4> | 672 <h4>PreviewerHTML.on_previewView_titleChanged</h4> |
| 651 <b>on_previewView_titleChanged</b>(<i>title</i>) | 673 <b>on_previewView_titleChanged</b>(<i>title</i>) |
| 653 <p> | 675 <p> |
| 654 Private slot to handle a change of the title. | 676 Private slot to handle a change of the title. |
| 655 </p> | 677 </p> |
| 656 <dl> | 678 <dl> |
| 657 | 679 |
| 658 <dt><i>title</i></dt> | 680 <dt><i>title</i> (str)</dt> |
| 659 <dd> | 681 <dd> |
| 660 new title (string) | 682 new title |
| 661 </dd> | 683 </dd> |
| 662 </dl> | 684 </dl> |
| 663 <a NAME="PreviewerHTML.on_ssiCheckBox_clicked" ID="PreviewerHTML.on_ssiCheckBox_clicked"></a> | 685 <a NAME="PreviewerHTML.on_ssiCheckBox_clicked" ID="PreviewerHTML.on_ssiCheckBox_clicked"></a> |
| 664 <h4>PreviewerHTML.on_ssiCheckBox_clicked</h4> | 686 <h4>PreviewerHTML.on_ssiCheckBox_clicked</h4> |
| 665 <b>on_ssiCheckBox_clicked</b>(<i>checked</i>) | 687 <b>on_ssiCheckBox_clicked</b>(<i>checked</i>) |
| 667 <p> | 689 <p> |
| 668 Private slot to enable/disable SSI. | 690 Private slot to enable/disable SSI. |
| 669 </p> | 691 </p> |
| 670 <dl> | 692 <dl> |
| 671 | 693 |
| 672 <dt><i>checked</i></dt> | 694 <dt><i>checked</i> (bool)</dt> |
| 673 <dd> | 695 <dd> |
| 674 state of the checkbox (boolean) | 696 state of the checkbox |
| 675 </dd> | 697 </dd> |
| 676 </dl> | 698 </dl> |
| 677 <a NAME="PreviewerHTML.processEditor" ID="PreviewerHTML.processEditor"></a> | 699 <a NAME="PreviewerHTML.processEditor" ID="PreviewerHTML.processEditor"></a> |
| 678 <h4>PreviewerHTML.processEditor</h4> | 700 <h4>PreviewerHTML.processEditor</h4> |
| 679 <b>processEditor</b>(<i>editor=None</i>) | 701 <b>processEditor</b>(<i>editor=None</i>) |
| 681 <p> | 703 <p> |
| 682 Public slot to process an editor's text. | 704 Public slot to process an editor's text. |
| 683 </p> | 705 </p> |
| 684 <dl> | 706 <dl> |
| 685 | 707 |
| 686 <dt><i>editor</i></dt> | 708 <dt><i>editor</i> (Editor)</dt> |
| 687 <dd> | 709 <dd> |
| 688 editor to be processed (Editor) | 710 editor to be processed |
| 689 </dd> | 711 </dd> |
| 690 </dl> | 712 </dl> |
| 691 <a NAME="PreviewerHTML.resultCallback" ID="PreviewerHTML.resultCallback"></a> | 713 <a NAME="PreviewerHTML.resultCallback" ID="PreviewerHTML.resultCallback"></a> |
| 692 <h4>PreviewerHTML.resultCallback</h4> | 714 <h4>PreviewerHTML.resultCallback</h4> |
| 693 <b>resultCallback</b>(<i>resDict=resultDict</i>) | 715 <b>resultCallback</b>(<i>resDict=resultDict</i>) |
