Mercurial Repositories > eric / file comparison

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

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

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

Mercurial Repository: eric

eric ide

mercurial