Mercurial Repositories > eric / file comparison

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

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

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

Mercurial Repository: eric

eric ide

mercurial