Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.QScintilla.MarkupProviders.MarkdownProvider.html

eric6/Documentation/Source/eric6.QScintilla.MarkupProviders.MarkdownProvider.html

branch
maintenance
changeset 6989
8b8cadf8d7e9
parent 6942
2602857055c5
child 7273
391d6b7b1eff
equal deleted inserted replaced
6938:7926553b7509 6989:8b8cadf8d7e9
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.QScintilla.MarkupProviders.MarkdownProvider</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><a NAME="top" ID="top"></a>
22 <h1>eric6.QScintilla.MarkupProviders.MarkdownProvider</h1>
23 <p>
24 Module implementing the Markdown markup provider.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#MarkdownProvider">MarkdownProvider</a></td>
34 <td>Class implementing the Markdown markup provider.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="MarkdownProvider" ID="MarkdownProvider"></a>
43 <h2>MarkdownProvider</h2>
44 <p>
45 Class implementing the Markdown markup provider.
46 </p>
47 <h3>Derived from</h3>
48 MarkupBase
49 <h3>Class Attributes</h3>
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <h3>Class Methods</h3>
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Methods</h3>
58 <table>
59 <tr>
60 <td><a href="#MarkdownProvider.__init__">MarkdownProvider</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#MarkdownProvider.__insertMarkup">__insertMarkup</a></td>
64 <td>Private method to insert the specified markup.</td>
65 </tr><tr>
66 <td><a href="#MarkdownProvider.__makeList">__makeList</a></td>
67 <td>Private method to generate the desired list markup.</td>
68 </tr><tr>
69 <td><a href="#MarkdownProvider.bold">bold</a></td>
70 <td>Public method to generate bold text.</td>
71 </tr><tr>
72 <td><a href="#MarkdownProvider.bulletedList">bulletedList</a></td>
73 <td>Public method to generate bulleted list text.</td>
74 </tr><tr>
75 <td><a href="#MarkdownProvider.code">code</a></td>
76 <td>Public method to generate inline code text.</td>
77 </tr><tr>
78 <td><a href="#MarkdownProvider.codeBlock">codeBlock</a></td>
79 <td>Public method to generate code block text.</td>
80 </tr><tr>
81 <td><a href="#MarkdownProvider.hasBold">hasBold</a></td>
82 <td>Public method to indicate the availability of bold markup.</td>
83 </tr><tr>
84 <td><a href="#MarkdownProvider.hasBulletedList">hasBulletedList</a></td>
85 <td>Public method to indicate the availability of bulleted list markup.</td>
86 </tr><tr>
87 <td><a href="#MarkdownProvider.hasCode">hasCode</a></td>
88 <td>Public method to indicate the availability of inline code markup.</td>
89 </tr><tr>
90 <td><a href="#MarkdownProvider.hasCodeBlock">hasCodeBlock</a></td>
91 <td>Public method to indicate the availability of code block markup.</td>
92 </tr><tr>
93 <td><a href="#MarkdownProvider.hasHyperlink">hasHyperlink</a></td>
94 <td>Public method to indicate the availability of hyperlink markup.</td>
95 </tr><tr>
96 <td><a href="#MarkdownProvider.hasImage">hasImage</a></td>
97 <td>Public method to indicate the availability of image markup.</td>
98 </tr><tr>
99 <td><a href="#MarkdownProvider.hasItalic">hasItalic</a></td>
100 <td>Public method to indicate the availability of italic markup.</td>
101 </tr><tr>
102 <td><a href="#MarkdownProvider.hasLine">hasLine</a></td>
103 <td>Public method to indicate the availability of a horizontal line markup.</td>
104 </tr><tr>
105 <td><a href="#MarkdownProvider.hasNumberedList">hasNumberedList</a></td>
106 <td>Public method to indicate the availability of numbered list markup.</td>
107 </tr><tr>
108 <td><a href="#MarkdownProvider.hasQuote">hasQuote</a></td>
109 <td>Public method to indicate the availability of block quote markup.</td>
110 </tr><tr>
111 <td><a href="#MarkdownProvider.hasStrikethrough">hasStrikethrough</a></td>
112 <td>Public method to indicate the availability of strikethrough markup.</td>
113 </tr><tr>
114 <td><a href="#MarkdownProvider.header">header</a></td>
115 <td>Public method to generate a header.</td>
116 </tr><tr>
117 <td><a href="#MarkdownProvider.headerLevels">headerLevels</a></td>
118 <td>Public method to determine the available header levels.</td>
119 </tr><tr>
120 <td><a href="#MarkdownProvider.hyperlink">hyperlink</a></td>
121 <td>Public method to generate hyperlink text.</td>
122 </tr><tr>
123 <td><a href="#MarkdownProvider.image">image</a></td>
124 <td>Public method to generate image text.</td>
125 </tr><tr>
126 <td><a href="#MarkdownProvider.italic">italic</a></td>
127 <td>Public method to generate italic text.</td>
128 </tr><tr>
129 <td><a href="#MarkdownProvider.kind">kind</a></td>
130 <td>Public method to get the markup kind.</td>
131 </tr><tr>
132 <td><a href="#MarkdownProvider.line">line</a></td>
133 <td>Public method to generate a horizontal line text.</td>
134 </tr><tr>
135 <td><a href="#MarkdownProvider.numberedList">numberedList</a></td>
136 <td>Public method to generate numbered list text.</td>
137 </tr><tr>
138 <td><a href="#MarkdownProvider.quote">quote</a></td>
139 <td>Public method to generate block quote text.</td>
140 </tr><tr>
141 <td><a href="#MarkdownProvider.strikethrough">strikethrough</a></td>
142 <td>Public method to generate strikethrough text.</td>
143 </tr>
144 </table>
145 <h3>Static Methods</h3>
146 <table>
147 <tr><td>None</td></tr>
148 </table>
149 <a NAME="MarkdownProvider.__init__" ID="MarkdownProvider.__init__"></a>
150 <h4>MarkdownProvider (Constructor)</h4>
151 <b>MarkdownProvider</b>(<i></i>)
152 <p>
153 Constructor
154 </p><a NAME="MarkdownProvider.__insertMarkup" ID="MarkdownProvider.__insertMarkup"></a>
155 <h4>MarkdownProvider.__insertMarkup</h4>
156 <b>__insertMarkup</b>(<i>markup, editor</i>)
157 <p>
158 Private method to insert the specified markup.
159 </p><p>
160 If the editor has selected text, this text is enclosed by the given
161 markup. If no text is selected, the markup is inserted at the cursor
162 position and the cursor is positioned in between.
163 </p><dl>
164 <dt><i>markup</i> (str)</dt>
165 <dd>
166 markup string to be inserted
167 </dd><dt><i>editor</i> (Editor)</dt>
168 <dd>
169 reference to the editor to work on
170 </dd>
171 </dl><a NAME="MarkdownProvider.__makeList" ID="MarkdownProvider.__makeList"></a>
172 <h4>MarkdownProvider.__makeList</h4>
173 <b>__makeList</b>(<i>editor, numberedList</i>)
174 <p>
175 Private method to generate the desired list markup.
176 </p><dl>
177 <dt><i>editor</i> (Editor)</dt>
178 <dd>
179 reference to the editor to work on
180 </dd><dt><i>numberedList</i> (bool)</dt>
181 <dd>
182 flag indicating the generation of a numbered list
183 </dd>
184 </dl><a NAME="MarkdownProvider.bold" ID="MarkdownProvider.bold"></a>
185 <h4>MarkdownProvider.bold</h4>
186 <b>bold</b>(<i>editor</i>)
187 <p>
188 Public method to generate bold text.
189 </p><dl>
190 <dt><i>editor</i> (Editor)</dt>
191 <dd>
192 reference to the editor to work on
193 </dd>
194 </dl><a NAME="MarkdownProvider.bulletedList" ID="MarkdownProvider.bulletedList"></a>
195 <h4>MarkdownProvider.bulletedList</h4>
196 <b>bulletedList</b>(<i>editor</i>)
197 <p>
198 Public method to generate bulleted list text.
199 </p><dl>
200 <dt><i>editor</i> (Editor)</dt>
201 <dd>
202 reference to the editor to work on
203 </dd>
204 </dl><a NAME="MarkdownProvider.code" ID="MarkdownProvider.code"></a>
205 <h4>MarkdownProvider.code</h4>
206 <b>code</b>(<i>editor</i>)
207 <p>
208 Public method to generate inline code text.
209 </p><dl>
210 <dt><i>editor</i> (Editor)</dt>
211 <dd>
212 reference to the editor to work on
213 </dd>
214 </dl><a NAME="MarkdownProvider.codeBlock" ID="MarkdownProvider.codeBlock"></a>
215 <h4>MarkdownProvider.codeBlock</h4>
216 <b>codeBlock</b>(<i>editor</i>)
217 <p>
218 Public method to generate code block text.
219 </p><dl>
220 <dt><i>editor</i> (Editor)</dt>
221 <dd>
222 reference to the editor to work on
223 </dd>
224 </dl><a NAME="MarkdownProvider.hasBold" ID="MarkdownProvider.hasBold"></a>
225 <h4>MarkdownProvider.hasBold</h4>
226 <b>hasBold</b>(<i></i>)
227 <p>
228 Public method to indicate the availability of bold markup.
229 </p><dl>
230 <dt>Returns:</dt>
231 <dd>
232 flag indicating the availability of bold markup
233 </dd>
234 </dl><dl>
235 <dt>Return Type:</dt>
236 <dd>
237 bool
238 </dd>
239 </dl><a NAME="MarkdownProvider.hasBulletedList" ID="MarkdownProvider.hasBulletedList"></a>
240 <h4>MarkdownProvider.hasBulletedList</h4>
241 <b>hasBulletedList</b>(<i></i>)
242 <p>
243 Public method to indicate the availability of bulleted list markup.
244 </p><dl>
245 <dt>Returns:</dt>
246 <dd>
247 flag indicating the availability of bulleted list markup
248 </dd>
249 </dl><dl>
250 <dt>Return Type:</dt>
251 <dd>
252 bool
253 </dd>
254 </dl><a NAME="MarkdownProvider.hasCode" ID="MarkdownProvider.hasCode"></a>
255 <h4>MarkdownProvider.hasCode</h4>
256 <b>hasCode</b>(<i></i>)
257 <p>
258 Public method to indicate the availability of inline code markup.
259 </p><dl>
260 <dt>Returns:</dt>
261 <dd>
262 flag indicating the availability of inline code markup
263 </dd>
264 </dl><dl>
265 <dt>Return Type:</dt>
266 <dd>
267 bool
268 </dd>
269 </dl><a NAME="MarkdownProvider.hasCodeBlock" ID="MarkdownProvider.hasCodeBlock"></a>
270 <h4>MarkdownProvider.hasCodeBlock</h4>
271 <b>hasCodeBlock</b>(<i></i>)
272 <p>
273 Public method to indicate the availability of code block markup.
274 </p><dl>
275 <dt>Returns:</dt>
276 <dd>
277 flag indicating the availability of code block markup
278 </dd>
279 </dl><dl>
280 <dt>Return Type:</dt>
281 <dd>
282 bool
283 </dd>
284 </dl><a NAME="MarkdownProvider.hasHyperlink" ID="MarkdownProvider.hasHyperlink"></a>
285 <h4>MarkdownProvider.hasHyperlink</h4>
286 <b>hasHyperlink</b>(<i></i>)
287 <p>
288 Public method to indicate the availability of hyperlink markup.
289 </p><dl>
290 <dt>Returns:</dt>
291 <dd>
292 flag indicating the availability of hyperlink markup
293 </dd>
294 </dl><dl>
295 <dt>Return Type:</dt>
296 <dd>
297 bool
298 </dd>
299 </dl><a NAME="MarkdownProvider.hasImage" ID="MarkdownProvider.hasImage"></a>
300 <h4>MarkdownProvider.hasImage</h4>
301 <b>hasImage</b>(<i></i>)
302 <p>
303 Public method to indicate the availability of image markup.
304 </p><dl>
305 <dt>Returns:</dt>
306 <dd>
307 flag indicating the availability of image markup
308 </dd>
309 </dl><dl>
310 <dt>Return Type:</dt>
311 <dd>
312 bool
313 </dd>
314 </dl><a NAME="MarkdownProvider.hasItalic" ID="MarkdownProvider.hasItalic"></a>
315 <h4>MarkdownProvider.hasItalic</h4>
316 <b>hasItalic</b>(<i></i>)
317 <p>
318 Public method to indicate the availability of italic markup.
319 </p><dl>
320 <dt>Returns:</dt>
321 <dd>
322 flag indicating the availability of italic markup
323 </dd>
324 </dl><dl>
325 <dt>Return Type:</dt>
326 <dd>
327 bool
328 </dd>
329 </dl><a NAME="MarkdownProvider.hasLine" ID="MarkdownProvider.hasLine"></a>
330 <h4>MarkdownProvider.hasLine</h4>
331 <b>hasLine</b>(<i></i>)
332 <p>
333 Public method to indicate the availability of a horizontal line markup.
334 </p><dl>
335 <dt>Returns:</dt>
336 <dd>
337 flag indicating the availability of a horizontal line markup
338 </dd>
339 </dl><dl>
340 <dt>Return Type:</dt>
341 <dd>
342 bool
343 </dd>
344 </dl><a NAME="MarkdownProvider.hasNumberedList" ID="MarkdownProvider.hasNumberedList"></a>
345 <h4>MarkdownProvider.hasNumberedList</h4>
346 <b>hasNumberedList</b>(<i></i>)
347 <p>
348 Public method to indicate the availability of numbered list markup.
349 </p><dl>
350 <dt>Returns:</dt>
351 <dd>
352 flag indicating the availability of numbered list markup
353 </dd>
354 </dl><dl>
355 <dt>Return Type:</dt>
356 <dd>
357 bool
358 </dd>
359 </dl><a NAME="MarkdownProvider.hasQuote" ID="MarkdownProvider.hasQuote"></a>
360 <h4>MarkdownProvider.hasQuote</h4>
361 <b>hasQuote</b>(<i></i>)
362 <p>
363 Public method to indicate the availability of block quote markup.
364 </p><dl>
365 <dt>Returns:</dt>
366 <dd>
367 flag indicating the availability of block quote markup
368 </dd>
369 </dl><dl>
370 <dt>Return Type:</dt>
371 <dd>
372 bool
373 </dd>
374 </dl><a NAME="MarkdownProvider.hasStrikethrough" ID="MarkdownProvider.hasStrikethrough"></a>
375 <h4>MarkdownProvider.hasStrikethrough</h4>
376 <b>hasStrikethrough</b>(<i></i>)
377 <p>
378 Public method to indicate the availability of strikethrough markup.
379 </p><dl>
380 <dt>Returns:</dt>
381 <dd>
382 flag indicating the availability of strikethrough markup
383 </dd>
384 </dl><dl>
385 <dt>Return Type:</dt>
386 <dd>
387 bool
388 </dd>
389 </dl><a NAME="MarkdownProvider.header" ID="MarkdownProvider.header"></a>
390 <h4>MarkdownProvider.header</h4>
391 <b>header</b>(<i>editor, level</i>)
392 <p>
393 Public method to generate a header.
394 </p><dl>
395 <dt><i>editor</i> (Editor)</dt>
396 <dd>
397 reference to the editor to work on
398 </dd><dt><i>level</i> (int)</dt>
399 <dd>
400 header level
401 </dd>
402 </dl><a NAME="MarkdownProvider.headerLevels" ID="MarkdownProvider.headerLevels"></a>
403 <h4>MarkdownProvider.headerLevels</h4>
404 <b>headerLevels</b>(<i></i>)
405 <p>
406 Public method to determine the available header levels.
407 </p><dl>
408 <dt>Returns:</dt>
409 <dd>
410 supported header levels
411 </dd>
412 </dl><dl>
413 <dt>Return Type:</dt>
414 <dd>
415 int
416 </dd>
417 </dl><a NAME="MarkdownProvider.hyperlink" ID="MarkdownProvider.hyperlink"></a>
418 <h4>MarkdownProvider.hyperlink</h4>
419 <b>hyperlink</b>(<i>editor</i>)
420 <p>
421 Public method to generate hyperlink text.
422 </p><dl>
423 <dt><i>editor</i> (Editor)</dt>
424 <dd>
425 reference to the editor to work on
426 </dd>
427 </dl><a NAME="MarkdownProvider.image" ID="MarkdownProvider.image"></a>
428 <h4>MarkdownProvider.image</h4>
429 <b>image</b>(<i>editor</i>)
430 <p>
431 Public method to generate image text.
432 </p><dl>
433 <dt><i>editor</i> (Editor)</dt>
434 <dd>
435 reference to the editor to work on
436 </dd>
437 </dl><a NAME="MarkdownProvider.italic" ID="MarkdownProvider.italic"></a>
438 <h4>MarkdownProvider.italic</h4>
439 <b>italic</b>(<i>editor</i>)
440 <p>
441 Public method to generate italic text.
442 </p><dl>
443 <dt><i>editor</i> (Editor)</dt>
444 <dd>
445 reference to the editor to work on
446 </dd>
447 </dl><a NAME="MarkdownProvider.kind" ID="MarkdownProvider.kind"></a>
448 <h4>MarkdownProvider.kind</h4>
449 <b>kind</b>(<i></i>)
450 <p>
451 Public method to get the markup kind.
452 </p><dl>
453 <dt>Returns:</dt>
454 <dd>
455 string with markup kind
456 </dd>
457 </dl><dl>
458 <dt>Return Type:</dt>
459 <dd>
460 str
461 </dd>
462 </dl><a NAME="MarkdownProvider.line" ID="MarkdownProvider.line"></a>
463 <h4>MarkdownProvider.line</h4>
464 <b>line</b>(<i>editor</i>)
465 <p>
466 Public method to generate a horizontal line text.
467 </p><dl>
468 <dt><i>editor</i> (Editor)</dt>
469 <dd>
470 reference to the editor to work on
471 </dd>
472 </dl><a NAME="MarkdownProvider.numberedList" ID="MarkdownProvider.numberedList"></a>
473 <h4>MarkdownProvider.numberedList</h4>
474 <b>numberedList</b>(<i>editor</i>)
475 <p>
476 Public method to generate numbered list text.
477 </p><dl>
478 <dt><i>editor</i> (Editor)</dt>
479 <dd>
480 reference to the editor to work on
481 </dd>
482 </dl><a NAME="MarkdownProvider.quote" ID="MarkdownProvider.quote"></a>
483 <h4>MarkdownProvider.quote</h4>
484 <b>quote</b>(<i>editor</i>)
485 <p>
486 Public method to generate block quote text.
487 </p><dl>
488 <dt><i>editor</i> (Editor)</dt>
489 <dd>
490 reference to the editor to work on
491 </dd>
492 </dl><a NAME="MarkdownProvider.strikethrough" ID="MarkdownProvider.strikethrough"></a>
493 <h4>MarkdownProvider.strikethrough</h4>
494 <b>strikethrough</b>(<i>editor</i>)
495 <p>
496 Public method to generate strikethrough text.
497 </p><dl>
498 <dt><i>editor</i> (Editor)</dt>
499 <dd>
500 reference to the editor to work on
501 </dd>
502 </dl>
503 <div align="right"><a href="#top">Up</a></div>
504 <hr />
505 </body></html>

Mercurial Repository: eric

eric ide

mercurial