Mercurial Repositories > eric / file comparison

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

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

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

Mercurial Repository: eric

eric ide

mercurial