--- a/src/eric7/Documentation/Source/eric7.QScintilla.MarkupProviders.RestructuredTextProvider.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.QScintilla.MarkupProviders.RestructuredTextProvider.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,57 +7,53 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.QScintilla.MarkupProviders.RestructuredTextProvider</h1>
-
<p>
Module implementing the reStructured Text markup provider.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#RestructuredTextProvider">RestructuredTextProvider</a></td>
<td>Class implementing the reStructured Text markup provider.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
-
<tr>
<td><a href="#createProvider">createProvider</a></td>
<td>Function to instantiate a markup provider object.</td>
</tr>
</table>
+
<hr />
<hr />
<a NAME="RestructuredTextProvider" ID="RestructuredTextProvider"></a>
<h2>RestructuredTextProvider</h2>
-
<p>
Class implementing the reStructured Text markup provider.
</p>
+
<h3>Derived from</h3>
MarkupBase
<h3>Class Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#RestructuredTextProvider.__init__">RestructuredTextProvider</a></td>
<td>Constructor</td>
@@ -163,23 +159,23 @@
<td>Public method to generate block quote text.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="RestructuredTextProvider.__init__" ID="RestructuredTextProvider.__init__"></a>
<h4>RestructuredTextProvider (Constructor)</h4>
<b>RestructuredTextProvider</b>(<i></i>)
-
<p>
Constructor
</p>
+
<a NAME="RestructuredTextProvider.__insertMarkup" ID="RestructuredTextProvider.__insertMarkup"></a>
<h4>RestructuredTextProvider.__insertMarkup</h4>
<b>__insertMarkup</b>(<i>markup, editor</i>)
-
<p>
Private method to insert the specified markup.
</p>
@@ -188,6 +184,7 @@
markup. If no text is selected, the markup is inserted at the cursor
position and the cursor is positioned in between.
</p>
+
<dl>
<dt><i>markup</i> (str)</dt>
@@ -202,10 +199,10 @@
<a NAME="RestructuredTextProvider.__makeList" ID="RestructuredTextProvider.__makeList"></a>
<h4>RestructuredTextProvider.__makeList</h4>
<b>__makeList</b>(<i>editor, numberedList</i>)
-
<p>
Private method to generate the desired list markup.
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -220,10 +217,10 @@
<a NAME="RestructuredTextProvider.bold" ID="RestructuredTextProvider.bold"></a>
<h4>RestructuredTextProvider.bold</h4>
<b>bold</b>(<i>editor</i>)
-
<p>
Public method to generate bold text.
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -234,10 +231,10 @@
<a NAME="RestructuredTextProvider.bulletedList" ID="RestructuredTextProvider.bulletedList"></a>
<h4>RestructuredTextProvider.bulletedList</h4>
<b>bulletedList</b>(<i>editor</i>)
-
<p>
Public method to generate bulleted list text.
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -248,10 +245,10 @@
<a NAME="RestructuredTextProvider.code" ID="RestructuredTextProvider.code"></a>
<h4>RestructuredTextProvider.code</h4>
<b>code</b>(<i>editor</i>)
-
<p>
Public method to generate inline code text.
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -262,10 +259,10 @@
<a NAME="RestructuredTextProvider.codeBlock" ID="RestructuredTextProvider.codeBlock"></a>
<h4>RestructuredTextProvider.codeBlock</h4>
<b>codeBlock</b>(<i>editor</i>)
-
<p>
Public method to generate code block text.
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -276,10 +273,10 @@
<a NAME="RestructuredTextProvider.hasBold" ID="RestructuredTextProvider.hasBold"></a>
<h4>RestructuredTextProvider.hasBold</h4>
<b>hasBold</b>(<i></i>)
-
<p>
Public method to indicate the availability of bold markup.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -295,10 +292,10 @@
<a NAME="RestructuredTextProvider.hasBulletedList" ID="RestructuredTextProvider.hasBulletedList"></a>
<h4>RestructuredTextProvider.hasBulletedList</h4>
<b>hasBulletedList</b>(<i></i>)
-
<p>
Public method to indicate the availability of bulleted list markup.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -314,10 +311,10 @@
<a NAME="RestructuredTextProvider.hasCode" ID="RestructuredTextProvider.hasCode"></a>
<h4>RestructuredTextProvider.hasCode</h4>
<b>hasCode</b>(<i></i>)
-
<p>
Public method to indicate the availability of inline code markup.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -333,10 +330,10 @@
<a NAME="RestructuredTextProvider.hasCodeBlock" ID="RestructuredTextProvider.hasCodeBlock"></a>
<h4>RestructuredTextProvider.hasCodeBlock</h4>
<b>hasCodeBlock</b>(<i></i>)
-
<p>
Public method to indicate the availability of code block markup.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -352,10 +349,10 @@
<a NAME="RestructuredTextProvider.hasHyperlink" ID="RestructuredTextProvider.hasHyperlink"></a>
<h4>RestructuredTextProvider.hasHyperlink</h4>
<b>hasHyperlink</b>(<i></i>)
-
<p>
Public method to indicate the availability of hyperlink markup.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -371,10 +368,10 @@
<a NAME="RestructuredTextProvider.hasImage" ID="RestructuredTextProvider.hasImage"></a>
<h4>RestructuredTextProvider.hasImage</h4>
<b>hasImage</b>(<i></i>)
-
<p>
Public method to indicate the availability of image markup.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -390,10 +387,10 @@
<a NAME="RestructuredTextProvider.hasItalic" ID="RestructuredTextProvider.hasItalic"></a>
<h4>RestructuredTextProvider.hasItalic</h4>
<b>hasItalic</b>(<i></i>)
-
<p>
Public method to indicate the availability of italic markup.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -409,10 +406,10 @@
<a NAME="RestructuredTextProvider.hasLine" ID="RestructuredTextProvider.hasLine"></a>
<h4>RestructuredTextProvider.hasLine</h4>
<b>hasLine</b>(<i></i>)
-
<p>
Public method to indicate the availability of a horizontal line markup.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -428,10 +425,10 @@
<a NAME="RestructuredTextProvider.hasNumberedList" ID="RestructuredTextProvider.hasNumberedList"></a>
<h4>RestructuredTextProvider.hasNumberedList</h4>
<b>hasNumberedList</b>(<i></i>)
-
<p>
Public method to indicate the availability of numbered list markup.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -447,10 +444,10 @@
<a NAME="RestructuredTextProvider.hasQuote" ID="RestructuredTextProvider.hasQuote"></a>
<h4>RestructuredTextProvider.hasQuote</h4>
<b>hasQuote</b>(<i></i>)
-
<p>
Public method to indicate the availability of block quote markup.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -466,10 +463,10 @@
<a NAME="RestructuredTextProvider.header" ID="RestructuredTextProvider.header"></a>
<h4>RestructuredTextProvider.header</h4>
<b>header</b>(<i>editor, level</i>)
-
<p>
Public method to generate a header.
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -484,10 +481,10 @@
<a NAME="RestructuredTextProvider.headerLevels" ID="RestructuredTextProvider.headerLevels"></a>
<h4>RestructuredTextProvider.headerLevels</h4>
<b>headerLevels</b>(<i></i>)
-
<p>
Public method to determine the available header levels.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -503,10 +500,10 @@
<a NAME="RestructuredTextProvider.hyperlink" ID="RestructuredTextProvider.hyperlink"></a>
<h4>RestructuredTextProvider.hyperlink</h4>
<b>hyperlink</b>(<i>editor</i>)
-
<p>
Public method to generate hyperlink text.
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -517,10 +514,10 @@
<a NAME="RestructuredTextProvider.image" ID="RestructuredTextProvider.image"></a>
<h4>RestructuredTextProvider.image</h4>
<b>image</b>(<i>editor</i>)
-
<p>
Public method to generate image text.
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -531,10 +528,10 @@
<a NAME="RestructuredTextProvider.italic" ID="RestructuredTextProvider.italic"></a>
<h4>RestructuredTextProvider.italic</h4>
<b>italic</b>(<i>editor</i>)
-
<p>
Public method to generate italic text.
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -545,10 +542,10 @@
<a NAME="RestructuredTextProvider.kind" ID="RestructuredTextProvider.kind"></a>
<h4>RestructuredTextProvider.kind</h4>
<b>kind</b>(<i></i>)
-
<p>
Public method to get the markup kind.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -564,10 +561,10 @@
<a NAME="RestructuredTextProvider.line" ID="RestructuredTextProvider.line"></a>
<h4>RestructuredTextProvider.line</h4>
<b>line</b>(<i>editor</i>)
-
<p>
Public method to generate a horizontal line text.
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -578,10 +575,10 @@
<a NAME="RestructuredTextProvider.numberedList" ID="RestructuredTextProvider.numberedList"></a>
<h4>RestructuredTextProvider.numberedList</h4>
<b>numberedList</b>(<i>editor</i>)
-
<p>
Public method to generate numbered list text.
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -592,10 +589,10 @@
<a NAME="RestructuredTextProvider.quote" ID="RestructuredTextProvider.quote"></a>
<h4>RestructuredTextProvider.quote</h4>
<b>quote</b>(<i>editor</i>)
-
<p>
Public method to generate block quote text.
</p>
+
<dl>
<dt><i>editor</i> (Editor)</dt>
@@ -609,10 +606,10 @@
<a NAME="createProvider" ID="createProvider"></a>
<h2>createProvider</h2>
<b>createProvider</b>(<i></i>)
-
<p>
Function to instantiate a markup provider object.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -627,4 +624,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
