Mercurial Repositories > eric / file comparison
comparison: eric7/Documentation/Source/eric7.QScintilla.MarkupProviders.RestructuredTextProvider.html
eric7/Documentation/Source/eric7.QScintilla.MarkupProviders.RestructuredTextProvider.html
- branch
- eric7
- changeset 8372
- e0227a7c850e
- child 8596
- d64760b2da50
equal
deleted
inserted
replaced
| 8371:d6062691d424 | 8372:e0227a7c850e |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.QScintilla.MarkupProviders.RestructuredTextProvider</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <style> | |
| 6 body { | |
| 7 background: #EDECE6; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #85774A; } | |
| 13 h2 { color: white; background: #85774A; } | |
| 14 h3 { color: white; background: #9D936E; } | |
| 15 h4 { color: white; background: #9D936E; } | |
| 16 | |
| 17 a { color: #BA6D36; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | |
| 21 <body> | |
| 22 <a NAME="top" ID="top"></a> | |
| 23 <h1>eric7.QScintilla.MarkupProviders.RestructuredTextProvider</h1> | |
| 24 | |
| 25 <p> | |
| 26 Module implementing the reStructured Text markup provider. | |
| 27 </p> | |
| 28 <h3>Global Attributes</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <h3>Classes</h3> | |
| 34 | |
| 35 <table> | |
| 36 | |
| 37 <tr> | |
| 38 <td><a href="#RestructuredTextProvider">RestructuredTextProvider</a></td> | |
| 39 <td>Class implementing the reStructured Text markup provider.</td> | |
| 40 </tr> | |
| 41 </table> | |
| 42 <h3>Functions</h3> | |
| 43 | |
| 44 <table> | |
| 45 <tr><td>None</td></tr> | |
| 46 </table> | |
| 47 <hr /> | |
| 48 <hr /> | |
| 49 <a NAME="RestructuredTextProvider" ID="RestructuredTextProvider"></a> | |
| 50 <h2>RestructuredTextProvider</h2> | |
| 51 | |
| 52 <p> | |
| 53 Class implementing the reStructured Text markup provider. | |
| 54 </p> | |
| 55 <h3>Derived from</h3> | |
| 56 MarkupBase | |
| 57 <h3>Class Attributes</h3> | |
| 58 | |
| 59 <table> | |
| 60 <tr><td>None</td></tr> | |
| 61 </table> | |
| 62 <h3>Class Methods</h3> | |
| 63 | |
| 64 <table> | |
| 65 <tr><td>None</td></tr> | |
| 66 </table> | |
| 67 <h3>Methods</h3> | |
| 68 | |
| 69 <table> | |
| 70 | |
| 71 <tr> | |
| 72 <td><a href="#RestructuredTextProvider.__init__">RestructuredTextProvider</a></td> | |
| 73 <td>Constructor</td> | |
| 74 </tr> | |
| 75 <tr> | |
| 76 <td><a href="#RestructuredTextProvider.__insertMarkup">__insertMarkup</a></td> | |
| 77 <td>Private method to insert the specified markup.</td> | |
| 78 </tr> | |
| 79 <tr> | |
| 80 <td><a href="#RestructuredTextProvider.__makeList">__makeList</a></td> | |
| 81 <td>Private method to generate the desired list markup.</td> | |
| 82 </tr> | |
| 83 <tr> | |
| 84 <td><a href="#RestructuredTextProvider.bold">bold</a></td> | |
| 85 <td>Public method to generate bold text.</td> | |
| 86 </tr> | |
| 87 <tr> | |
| 88 <td><a href="#RestructuredTextProvider.bulletedList">bulletedList</a></td> | |
| 89 <td>Public method to generate bulleted list text.</td> | |
| 90 </tr> | |
| 91 <tr> | |
| 92 <td><a href="#RestructuredTextProvider.code">code</a></td> | |
| 93 <td>Public method to generate inline code text.</td> | |
| 94 </tr> | |
| 95 <tr> | |
| 96 <td><a href="#RestructuredTextProvider.codeBlock">codeBlock</a></td> | |
| 97 <td>Public method to generate code block text.</td> | |
| 98 </tr> | |
| 99 <tr> | |
| 100 <td><a href="#RestructuredTextProvider.hasBold">hasBold</a></td> | |
| 101 <td>Public method to indicate the availability of bold markup.</td> | |
| 102 </tr> | |
| 103 <tr> | |
| 104 <td><a href="#RestructuredTextProvider.hasBulletedList">hasBulletedList</a></td> | |
| 105 <td>Public method to indicate the availability of bulleted list markup.</td> | |
| 106 </tr> | |
| 107 <tr> | |
| 108 <td><a href="#RestructuredTextProvider.hasCode">hasCode</a></td> | |
| 109 <td>Public method to indicate the availability of inline code markup.</td> | |
| 110 </tr> | |
| 111 <tr> | |
| 112 <td><a href="#RestructuredTextProvider.hasCodeBlock">hasCodeBlock</a></td> | |
| 113 <td>Public method to indicate the availability of code block markup.</td> | |
| 114 </tr> | |
| 115 <tr> | |
| 116 <td><a href="#RestructuredTextProvider.hasHyperlink">hasHyperlink</a></td> | |
| 117 <td>Public method to indicate the availability of hyperlink markup.</td> | |
| 118 </tr> | |
| 119 <tr> | |
| 120 <td><a href="#RestructuredTextProvider.hasImage">hasImage</a></td> | |
| 121 <td>Public method to indicate the availability of image markup.</td> | |
| 122 </tr> | |
| 123 <tr> | |
| 124 <td><a href="#RestructuredTextProvider.hasItalic">hasItalic</a></td> | |
| 125 <td>Public method to indicate the availability of italic markup.</td> | |
| 126 </tr> | |
| 127 <tr> | |
| 128 <td><a href="#RestructuredTextProvider.hasLine">hasLine</a></td> | |
| 129 <td>Public method to indicate the availability of a horizontal line markup.</td> | |
| 130 </tr> | |
| 131 <tr> | |
| 132 <td><a href="#RestructuredTextProvider.hasNumberedList">hasNumberedList</a></td> | |
| 133 <td>Public method to indicate the availability of numbered list markup.</td> | |
| 134 </tr> | |
| 135 <tr> | |
| 136 <td><a href="#RestructuredTextProvider.hasQuote">hasQuote</a></td> | |
| 137 <td>Public method to indicate the availability of block quote markup.</td> | |
| 138 </tr> | |
| 139 <tr> | |
| 140 <td><a href="#RestructuredTextProvider.header">header</a></td> | |
| 141 <td>Public method to generate a header.</td> | |
| 142 </tr> | |
| 143 <tr> | |
| 144 <td><a href="#RestructuredTextProvider.headerLevels">headerLevels</a></td> | |
| 145 <td>Public method to determine the available header levels.</td> | |
| 146 </tr> | |
| 147 <tr> | |
| 148 <td><a href="#RestructuredTextProvider.hyperlink">hyperlink</a></td> | |
| 149 <td>Public method to generate hyperlink text.</td> | |
| 150 </tr> | |
| 151 <tr> | |
| 152 <td><a href="#RestructuredTextProvider.image">image</a></td> | |
| 153 <td>Public method to generate image text.</td> | |
| 154 </tr> | |
| 155 <tr> | |
| 156 <td><a href="#RestructuredTextProvider.italic">italic</a></td> | |
| 157 <td>Public method to generate italic text.</td> | |
| 158 </tr> | |
| 159 <tr> | |
| 160 <td><a href="#RestructuredTextProvider.kind">kind</a></td> | |
| 161 <td>Public method to get the markup kind.</td> | |
| 162 </tr> | |
| 163 <tr> | |
| 164 <td><a href="#RestructuredTextProvider.line">line</a></td> | |
| 165 <td>Public method to generate a horizontal line text.</td> | |
| 166 </tr> | |
| 167 <tr> | |
| 168 <td><a href="#RestructuredTextProvider.numberedList">numberedList</a></td> | |
| 169 <td>Public method to generate numbered list text.</td> | |
| 170 </tr> | |
| 171 <tr> | |
| 172 <td><a href="#RestructuredTextProvider.quote">quote</a></td> | |
| 173 <td>Public method to generate block quote text.</td> | |
| 174 </tr> | |
| 175 </table> | |
| 176 <h3>Static Methods</h3> | |
| 177 | |
| 178 <table> | |
| 179 <tr><td>None</td></tr> | |
| 180 </table> | |
| 181 | |
| 182 <a NAME="RestructuredTextProvider.__init__" ID="RestructuredTextProvider.__init__"></a> | |
| 183 <h4>RestructuredTextProvider (Constructor)</h4> | |
| 184 <b>RestructuredTextProvider</b>(<i></i>) | |
| 185 | |
| 186 <p> | |
| 187 Constructor | |
| 188 </p> | |
| 189 <a NAME="RestructuredTextProvider.__insertMarkup" ID="RestructuredTextProvider.__insertMarkup"></a> | |
| 190 <h4>RestructuredTextProvider.__insertMarkup</h4> | |
| 191 <b>__insertMarkup</b>(<i>markup, editor</i>) | |
| 192 | |
| 193 <p> | |
| 194 Private method to insert the specified markup. | |
| 195 </p> | |
| 196 <p> | |
| 197 If the editor has selected text, this text is enclosed by the given | |
| 198 markup. If no text is selected, the markup is inserted at the cursor | |
| 199 position and the cursor is positioned in between. | |
| 200 </p> | |
| 201 <dl> | |
| 202 | |
| 203 <dt><i>markup</i> (str)</dt> | |
| 204 <dd> | |
| 205 markup string to be inserted | |
| 206 </dd> | |
| 207 <dt><i>editor</i> (Editor)</dt> | |
| 208 <dd> | |
| 209 reference to the editor to work on | |
| 210 </dd> | |
| 211 </dl> | |
| 212 <a NAME="RestructuredTextProvider.__makeList" ID="RestructuredTextProvider.__makeList"></a> | |
| 213 <h4>RestructuredTextProvider.__makeList</h4> | |
| 214 <b>__makeList</b>(<i>editor, numberedList</i>) | |
| 215 | |
| 216 <p> | |
| 217 Private method to generate the desired list markup. | |
| 218 </p> | |
| 219 <dl> | |
| 220 | |
| 221 <dt><i>editor</i> (Editor)</dt> | |
| 222 <dd> | |
| 223 reference to the editor to work on | |
| 224 </dd> | |
| 225 <dt><i>numberedList</i> (bool)</dt> | |
| 226 <dd> | |
| 227 flag indicating the generation of a numbered list | |
| 228 </dd> | |
| 229 </dl> | |
| 230 <a NAME="RestructuredTextProvider.bold" ID="RestructuredTextProvider.bold"></a> | |
| 231 <h4>RestructuredTextProvider.bold</h4> | |
| 232 <b>bold</b>(<i>editor</i>) | |
| 233 | |
| 234 <p> | |
| 235 Public method to generate bold text. | |
| 236 </p> | |
| 237 <dl> | |
| 238 | |
| 239 <dt><i>editor</i> (Editor)</dt> | |
| 240 <dd> | |
| 241 reference to the editor to work on | |
| 242 </dd> | |
| 243 </dl> | |
| 244 <a NAME="RestructuredTextProvider.bulletedList" ID="RestructuredTextProvider.bulletedList"></a> | |
| 245 <h4>RestructuredTextProvider.bulletedList</h4> | |
| 246 <b>bulletedList</b>(<i>editor</i>) | |
| 247 | |
| 248 <p> | |
| 249 Public method to generate bulleted list text. | |
| 250 </p> | |
| 251 <dl> | |
| 252 | |
| 253 <dt><i>editor</i> (Editor)</dt> | |
| 254 <dd> | |
| 255 reference to the editor to work on | |
| 256 </dd> | |
| 257 </dl> | |
| 258 <a NAME="RestructuredTextProvider.code" ID="RestructuredTextProvider.code"></a> | |
| 259 <h4>RestructuredTextProvider.code</h4> | |
| 260 <b>code</b>(<i>editor</i>) | |
| 261 | |
| 262 <p> | |
| 263 Public method to generate inline code text. | |
| 264 </p> | |
| 265 <dl> | |
| 266 | |
| 267 <dt><i>editor</i> (Editor)</dt> | |
| 268 <dd> | |
| 269 reference to the editor to work on | |
| 270 </dd> | |
| 271 </dl> | |
| 272 <a NAME="RestructuredTextProvider.codeBlock" ID="RestructuredTextProvider.codeBlock"></a> | |
| 273 <h4>RestructuredTextProvider.codeBlock</h4> | |
| 274 <b>codeBlock</b>(<i>editor</i>) | |
| 275 | |
| 276 <p> | |
| 277 Public method to generate code block text. | |
| 278 </p> | |
| 279 <dl> | |
| 280 | |
| 281 <dt><i>editor</i> (Editor)</dt> | |
| 282 <dd> | |
| 283 reference to the editor to work on | |
| 284 </dd> | |
| 285 </dl> | |
| 286 <a NAME="RestructuredTextProvider.hasBold" ID="RestructuredTextProvider.hasBold"></a> | |
| 287 <h4>RestructuredTextProvider.hasBold</h4> | |
| 288 <b>hasBold</b>(<i></i>) | |
| 289 | |
| 290 <p> | |
| 291 Public method to indicate the availability of bold markup. | |
| 292 </p> | |
| 293 <dl> | |
| 294 <dt>Return:</dt> | |
| 295 <dd> | |
| 296 flag indicating the availability of bold markup | |
| 297 </dd> | |
| 298 </dl> | |
| 299 <dl> | |
| 300 <dt>Return Type:</dt> | |
| 301 <dd> | |
| 302 bool | |
| 303 </dd> | |
| 304 </dl> | |
| 305 <a NAME="RestructuredTextProvider.hasBulletedList" ID="RestructuredTextProvider.hasBulletedList"></a> | |
| 306 <h4>RestructuredTextProvider.hasBulletedList</h4> | |
| 307 <b>hasBulletedList</b>(<i></i>) | |
| 308 | |
| 309 <p> | |
| 310 Public method to indicate the availability of bulleted list markup. | |
| 311 </p> | |
| 312 <dl> | |
| 313 <dt>Return:</dt> | |
| 314 <dd> | |
| 315 flag indicating the availability of bulleted list markup | |
| 316 </dd> | |
| 317 </dl> | |
| 318 <dl> | |
| 319 <dt>Return Type:</dt> | |
| 320 <dd> | |
| 321 bool | |
| 322 </dd> | |
| 323 </dl> | |
| 324 <a NAME="RestructuredTextProvider.hasCode" ID="RestructuredTextProvider.hasCode"></a> | |
| 325 <h4>RestructuredTextProvider.hasCode</h4> | |
| 326 <b>hasCode</b>(<i></i>) | |
| 327 | |
| 328 <p> | |
| 329 Public method to indicate the availability of inline code markup. | |
| 330 </p> | |
| 331 <dl> | |
| 332 <dt>Return:</dt> | |
| 333 <dd> | |
| 334 flag indicating the availability of inline code markup | |
| 335 </dd> | |
| 336 </dl> | |
| 337 <dl> | |
| 338 <dt>Return Type:</dt> | |
| 339 <dd> | |
| 340 bool | |
| 341 </dd> | |
| 342 </dl> | |
| 343 <a NAME="RestructuredTextProvider.hasCodeBlock" ID="RestructuredTextProvider.hasCodeBlock"></a> | |
| 344 <h4>RestructuredTextProvider.hasCodeBlock</h4> | |
| 345 <b>hasCodeBlock</b>(<i></i>) | |
| 346 | |
| 347 <p> | |
| 348 Public method to indicate the availability of code block markup. | |
| 349 </p> | |
| 350 <dl> | |
| 351 <dt>Return:</dt> | |
| 352 <dd> | |
| 353 flag indicating the availability of code block markup | |
| 354 </dd> | |
| 355 </dl> | |
| 356 <dl> | |
| 357 <dt>Return Type:</dt> | |
| 358 <dd> | |
| 359 bool | |
| 360 </dd> | |
| 361 </dl> | |
| 362 <a NAME="RestructuredTextProvider.hasHyperlink" ID="RestructuredTextProvider.hasHyperlink"></a> | |
| 363 <h4>RestructuredTextProvider.hasHyperlink</h4> | |
| 364 <b>hasHyperlink</b>(<i></i>) | |
| 365 | |
| 366 <p> | |
| 367 Public method to indicate the availability of hyperlink markup. | |
| 368 </p> | |
| 369 <dl> | |
| 370 <dt>Return:</dt> | |
| 371 <dd> | |
| 372 flag indicating the availability of hyperlink markup | |
| 373 </dd> | |
| 374 </dl> | |
| 375 <dl> | |
| 376 <dt>Return Type:</dt> | |
| 377 <dd> | |
| 378 bool | |
| 379 </dd> | |
| 380 </dl> | |
| 381 <a NAME="RestructuredTextProvider.hasImage" ID="RestructuredTextProvider.hasImage"></a> | |
| 382 <h4>RestructuredTextProvider.hasImage</h4> | |
| 383 <b>hasImage</b>(<i></i>) | |
| 384 | |
| 385 <p> | |
| 386 Public method to indicate the availability of image markup. | |
| 387 </p> | |
| 388 <dl> | |
| 389 <dt>Return:</dt> | |
| 390 <dd> | |
| 391 flag indicating the availability of image markup | |
| 392 </dd> | |
| 393 </dl> | |
| 394 <dl> | |
| 395 <dt>Return Type:</dt> | |
| 396 <dd> | |
| 397 bool | |
| 398 </dd> | |
| 399 </dl> | |
| 400 <a NAME="RestructuredTextProvider.hasItalic" ID="RestructuredTextProvider.hasItalic"></a> | |
| 401 <h4>RestructuredTextProvider.hasItalic</h4> | |
| 402 <b>hasItalic</b>(<i></i>) | |
| 403 | |
| 404 <p> | |
| 405 Public method to indicate the availability of italic markup. | |
| 406 </p> | |
| 407 <dl> | |
| 408 <dt>Return:</dt> | |
| 409 <dd> | |
| 410 flag indicating the availability of italic markup | |
| 411 </dd> | |
| 412 </dl> | |
| 413 <dl> | |
| 414 <dt>Return Type:</dt> | |
| 415 <dd> | |
| 416 bool | |
| 417 </dd> | |
| 418 </dl> | |
| 419 <a NAME="RestructuredTextProvider.hasLine" ID="RestructuredTextProvider.hasLine"></a> | |
| 420 <h4>RestructuredTextProvider.hasLine</h4> | |
| 421 <b>hasLine</b>(<i></i>) | |
| 422 | |
| 423 <p> | |
| 424 Public method to indicate the availability of a horizontal line markup. | |
| 425 </p> | |
| 426 <dl> | |
| 427 <dt>Return:</dt> | |
| 428 <dd> | |
| 429 flag indicating the availability of a horizontal line markup | |
| 430 </dd> | |
| 431 </dl> | |
| 432 <dl> | |
| 433 <dt>Return Type:</dt> | |
| 434 <dd> | |
| 435 bool | |
| 436 </dd> | |
| 437 </dl> | |
| 438 <a NAME="RestructuredTextProvider.hasNumberedList" ID="RestructuredTextProvider.hasNumberedList"></a> | |
| 439 <h4>RestructuredTextProvider.hasNumberedList</h4> | |
| 440 <b>hasNumberedList</b>(<i></i>) | |
| 441 | |
| 442 <p> | |
| 443 Public method to indicate the availability of numbered list markup. | |
| 444 </p> | |
| 445 <dl> | |
| 446 <dt>Return:</dt> | |
| 447 <dd> | |
| 448 flag indicating the availability of numbered list markup | |
| 449 </dd> | |
| 450 </dl> | |
| 451 <dl> | |
| 452 <dt>Return Type:</dt> | |
| 453 <dd> | |
| 454 bool | |
| 455 </dd> | |
| 456 </dl> | |
| 457 <a NAME="RestructuredTextProvider.hasQuote" ID="RestructuredTextProvider.hasQuote"></a> | |
| 458 <h4>RestructuredTextProvider.hasQuote</h4> | |
| 459 <b>hasQuote</b>(<i></i>) | |
| 460 | |
| 461 <p> | |
| 462 Public method to indicate the availability of block quote markup. | |
| 463 </p> | |
| 464 <dl> | |
| 465 <dt>Return:</dt> | |
| 466 <dd> | |
| 467 flag indicating the availability of block quote markup | |
| 468 </dd> | |
| 469 </dl> | |
| 470 <dl> | |
| 471 <dt>Return Type:</dt> | |
| 472 <dd> | |
| 473 bool | |
| 474 </dd> | |
| 475 </dl> | |
| 476 <a NAME="RestructuredTextProvider.header" ID="RestructuredTextProvider.header"></a> | |
| 477 <h4>RestructuredTextProvider.header</h4> | |
| 478 <b>header</b>(<i>editor, level</i>) | |
| 479 | |
| 480 <p> | |
| 481 Public method to generate a header. | |
| 482 </p> | |
| 483 <dl> | |
| 484 | |
| 485 <dt><i>editor</i> (Editor)</dt> | |
| 486 <dd> | |
| 487 reference to the editor to work on | |
| 488 </dd> | |
| 489 <dt><i>level</i> (int)</dt> | |
| 490 <dd> | |
| 491 header level | |
| 492 </dd> | |
| 493 </dl> | |
| 494 <a NAME="RestructuredTextProvider.headerLevels" ID="RestructuredTextProvider.headerLevels"></a> | |
| 495 <h4>RestructuredTextProvider.headerLevels</h4> | |
| 496 <b>headerLevels</b>(<i></i>) | |
| 497 | |
| 498 <p> | |
| 499 Public method to determine the available header levels. | |
| 500 </p> | |
| 501 <dl> | |
| 502 <dt>Return:</dt> | |
| 503 <dd> | |
| 504 supported header levels | |
| 505 </dd> | |
| 506 </dl> | |
| 507 <dl> | |
| 508 <dt>Return Type:</dt> | |
| 509 <dd> | |
| 510 int | |
| 511 </dd> | |
| 512 </dl> | |
| 513 <a NAME="RestructuredTextProvider.hyperlink" ID="RestructuredTextProvider.hyperlink"></a> | |
| 514 <h4>RestructuredTextProvider.hyperlink</h4> | |
| 515 <b>hyperlink</b>(<i>editor</i>) | |
| 516 | |
| 517 <p> | |
| 518 Public method to generate hyperlink text. | |
| 519 </p> | |
| 520 <dl> | |
| 521 | |
| 522 <dt><i>editor</i> (Editor)</dt> | |
| 523 <dd> | |
| 524 reference to the editor to work on | |
| 525 </dd> | |
| 526 </dl> | |
| 527 <a NAME="RestructuredTextProvider.image" ID="RestructuredTextProvider.image"></a> | |
| 528 <h4>RestructuredTextProvider.image</h4> | |
| 529 <b>image</b>(<i>editor</i>) | |
| 530 | |
| 531 <p> | |
| 532 Public method to generate image text. | |
| 533 </p> | |
| 534 <dl> | |
| 535 | |
| 536 <dt><i>editor</i> (Editor)</dt> | |
| 537 <dd> | |
| 538 reference to the editor to work on | |
| 539 </dd> | |
| 540 </dl> | |
| 541 <a NAME="RestructuredTextProvider.italic" ID="RestructuredTextProvider.italic"></a> | |
| 542 <h4>RestructuredTextProvider.italic</h4> | |
| 543 <b>italic</b>(<i>editor</i>) | |
| 544 | |
| 545 <p> | |
| 546 Public method to generate italic text. | |
| 547 </p> | |
| 548 <dl> | |
| 549 | |
| 550 <dt><i>editor</i> (Editor)</dt> | |
| 551 <dd> | |
| 552 reference to the editor to work on | |
| 553 </dd> | |
| 554 </dl> | |
| 555 <a NAME="RestructuredTextProvider.kind" ID="RestructuredTextProvider.kind"></a> | |
| 556 <h4>RestructuredTextProvider.kind</h4> | |
| 557 <b>kind</b>(<i></i>) | |
| 558 | |
| 559 <p> | |
| 560 Public method to get the markup kind. | |
| 561 </p> | |
| 562 <dl> | |
| 563 <dt>Return:</dt> | |
| 564 <dd> | |
| 565 string with markup kind | |
| 566 </dd> | |
| 567 </dl> | |
| 568 <dl> | |
| 569 <dt>Return Type:</dt> | |
| 570 <dd> | |
| 571 str | |
| 572 </dd> | |
| 573 </dl> | |
| 574 <a NAME="RestructuredTextProvider.line" ID="RestructuredTextProvider.line"></a> | |
| 575 <h4>RestructuredTextProvider.line</h4> | |
| 576 <b>line</b>(<i>editor</i>) | |
| 577 | |
| 578 <p> | |
| 579 Public method to generate a horizontal line text. | |
| 580 </p> | |
| 581 <dl> | |
| 582 | |
| 583 <dt><i>editor</i> (Editor)</dt> | |
| 584 <dd> | |
| 585 reference to the editor to work on | |
| 586 </dd> | |
| 587 </dl> | |
| 588 <a NAME="RestructuredTextProvider.numberedList" ID="RestructuredTextProvider.numberedList"></a> | |
| 589 <h4>RestructuredTextProvider.numberedList</h4> | |
| 590 <b>numberedList</b>(<i>editor</i>) | |
| 591 | |
| 592 <p> | |
| 593 Public method to generate numbered list text. | |
| 594 </p> | |
| 595 <dl> | |
| 596 | |
| 597 <dt><i>editor</i> (Editor)</dt> | |
| 598 <dd> | |
| 599 reference to the editor to work on | |
| 600 </dd> | |
| 601 </dl> | |
| 602 <a NAME="RestructuredTextProvider.quote" ID="RestructuredTextProvider.quote"></a> | |
| 603 <h4>RestructuredTextProvider.quote</h4> | |
| 604 <b>quote</b>(<i>editor</i>) | |
| 605 | |
| 606 <p> | |
| 607 Public method to generate block quote text. | |
| 608 </p> | |
| 609 <dl> | |
| 610 | |
| 611 <dt><i>editor</i> (Editor)</dt> | |
| 612 <dd> | |
| 613 reference to the editor to work on | |
| 614 </dd> | |
| 615 </dl> | |
| 616 <div align="right"><a href="#top">Up</a></div> | |
| 617 <hr /> | |
| 618 </body></html> |
