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