--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/src/eric7/Documentation/Source/eric7.QScintilla.MarkupProviders.MarkdownProvider.html Thu Jul 07 11:23:56 2022 +0200
@@ -0,0 +1,645 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.QScintilla.MarkupProviders.MarkdownProvider</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.QScintilla.MarkupProviders.MarkdownProvider</h1>
+
+<p>
+Module implementing the Markdown markup provider.
+</p>
+<h3>Global Attributes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+
+<table>
+
+<tr>
+<td><a href="#MarkdownProvider">MarkdownProvider</a></td>
+<td>Class implementing the Markdown markup provider.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr />
+<hr />
+<a NAME="MarkdownProvider" ID="MarkdownProvider"></a>
+<h2>MarkdownProvider</h2>
+
+<p>
+ Class implementing the Markdown 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="#MarkdownProvider.__init__">MarkdownProvider</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#MarkdownProvider.__insertMarkup">__insertMarkup</a></td>
+<td>Private method to insert the specified markup.</td>
+</tr>
+<tr>
+<td><a href="#MarkdownProvider.__makeList">__makeList</a></td>
+<td>Private method to generate the desired list markup.</td>
+</tr>
+<tr>
+<td><a href="#MarkdownProvider.bold">bold</a></td>
+<td>Public method to generate bold text.</td>
+</tr>
+<tr>
+<td><a href="#MarkdownProvider.bulletedList">bulletedList</a></td>
+<td>Public method to generate bulleted list text.</td>
+</tr>
+<tr>
+<td><a href="#MarkdownProvider.code">code</a></td>
+<td>Public method to generate inline code text.</td>
+</tr>
+<tr>
+<td><a href="#MarkdownProvider.codeBlock">codeBlock</a></td>
+<td>Public method to generate code block text.</td>
+</tr>
+<tr>
+<td><a href="#MarkdownProvider.hasBold">hasBold</a></td>
+<td>Public method to indicate the availability of bold markup.</td>
+</tr>
+<tr>
+<td><a href="#MarkdownProvider.hasBulletedList">hasBulletedList</a></td>
+<td>Public method to indicate the availability of bulleted list markup.</td>
+</tr>
+<tr>
+<td><a href="#MarkdownProvider.hasCode">hasCode</a></td>
+<td>Public method to indicate the availability of inline code markup.</td>
+</tr>
+<tr>
+<td><a href="#MarkdownProvider.hasCodeBlock">hasCodeBlock</a></td>
+<td>Public method to indicate the availability of code block markup.</td>
+</tr>
+<tr>
+<td><a href="#MarkdownProvider.hasHyperlink">hasHyperlink</a></td>
+<td>Public method to indicate the availability of hyperlink markup.</td>
+</tr>
+<tr>
+<td><a href="#MarkdownProvider.hasImage">hasImage</a></td>
+<td>Public method to indicate the availability of image markup.</td>
+</tr>
+<tr>
+<td><a href="#MarkdownProvider.hasItalic">hasItalic</a></td>
+<td>Public method to indicate the availability of italic markup.</td>
+</tr>
+<tr>
+<td><a href="#MarkdownProvider.hasLine">hasLine</a></td>
+<td>Public method to indicate the availability of a horizontal line markup.</td>
+</tr>
+<tr>
+<td><a href="#MarkdownProvider.hasNumberedList">hasNumberedList</a></td>
+<td>Public method to indicate the availability of numbered list markup.</td>
+</tr>
+<tr>
+<td><a href="#MarkdownProvider.hasQuote">hasQuote</a></td>
+<td>Public method to indicate the availability of block quote markup.</td>
+</tr>
+<tr>
+<td><a href="#MarkdownProvider.hasStrikethrough">hasStrikethrough</a></td>
+<td>Public method to indicate the availability of strikethrough markup.</td>
+</tr>
+<tr>
+<td><a href="#MarkdownProvider.header">header</a></td>
+<td>Public method to generate a header.</td>
+</tr>
+<tr>
+<td><a href="#MarkdownProvider.headerLevels">headerLevels</a></td>
+<td>Public method to determine the available header levels.</td>
+</tr>
+<tr>
+<td><a href="#MarkdownProvider.hyperlink">hyperlink</a></td>
+<td>Public method to generate hyperlink text.</td>
+</tr>
+<tr>
+<td><a href="#MarkdownProvider.image">image</a></td>
+<td>Public method to generate image text.</td>
+</tr>
+<tr>
+<td><a href="#MarkdownProvider.italic">italic</a></td>
+<td>Public method to generate italic text.</td>
+</tr>
+<tr>
+<td><a href="#MarkdownProvider.kind">kind</a></td>
+<td>Public method to get the markup kind.</td>
+</tr>
+<tr>
+<td><a href="#MarkdownProvider.line">line</a></td>
+<td>Public method to generate a horizontal line text.</td>
+</tr>
+<tr>
+<td><a href="#MarkdownProvider.numberedList">numberedList</a></td>
+<td>Public method to generate numbered list text.</td>
+</tr>
+<tr>
+<td><a href="#MarkdownProvider.quote">quote</a></td>
+<td>Public method to generate block quote text.</td>
+</tr>
+<tr>
+<td><a href="#MarkdownProvider.strikethrough">strikethrough</a></td>
+<td>Public method to generate strikethrough text.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<a NAME="MarkdownProvider.__init__" ID="MarkdownProvider.__init__"></a>
+<h4>MarkdownProvider (Constructor)</h4>
+<b>MarkdownProvider</b>(<i></i>)
+
+<p>
+ Constructor
+</p>
+<a NAME="MarkdownProvider.__insertMarkup" ID="MarkdownProvider.__insertMarkup"></a>
+<h4>MarkdownProvider.__insertMarkup</h4>
+<b>__insertMarkup</b>(<i>markup, editor</i>)
+
+<p>
+ Private method to insert the specified markup.
+</p>
+<p>
+ If the editor has selected text, this text is enclosed by the given
+ 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>
+<dd>
+markup string to be inserted
+</dd>
+<dt><i>editor</i> (Editor)</dt>
+<dd>
+reference to the editor to work on
+</dd>
+</dl>
+<a NAME="MarkdownProvider.__makeList" ID="MarkdownProvider.__makeList"></a>
+<h4>MarkdownProvider.__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>
+<dd>
+reference to the editor to work on
+</dd>
+<dt><i>numberedList</i> (bool)</dt>
+<dd>
+flag indicating the generation of a numbered list
+</dd>
+</dl>
+<a NAME="MarkdownProvider.bold" ID="MarkdownProvider.bold"></a>
+<h4>MarkdownProvider.bold</h4>
+<b>bold</b>(<i>editor</i>)
+
+<p>
+ Public method to generate bold text.
+</p>
+<dl>
+
+<dt><i>editor</i> (Editor)</dt>
+<dd>
+reference to the editor to work on
+</dd>
+</dl>
+<a NAME="MarkdownProvider.bulletedList" ID="MarkdownProvider.bulletedList"></a>
+<h4>MarkdownProvider.bulletedList</h4>
+<b>bulletedList</b>(<i>editor</i>)
+
+<p>
+ Public method to generate bulleted list text.
+</p>
+<dl>
+
+<dt><i>editor</i> (Editor)</dt>
+<dd>
+reference to the editor to work on
+</dd>
+</dl>
+<a NAME="MarkdownProvider.code" ID="MarkdownProvider.code"></a>
+<h4>MarkdownProvider.code</h4>
+<b>code</b>(<i>editor</i>)
+
+<p>
+ Public method to generate inline code text.
+</p>
+<dl>
+
+<dt><i>editor</i> (Editor)</dt>
+<dd>
+reference to the editor to work on
+</dd>
+</dl>
+<a NAME="MarkdownProvider.codeBlock" ID="MarkdownProvider.codeBlock"></a>
+<h4>MarkdownProvider.codeBlock</h4>
+<b>codeBlock</b>(<i>editor</i>)
+
+<p>
+ Public method to generate code block text.
+</p>
+<dl>
+
+<dt><i>editor</i> (Editor)</dt>
+<dd>
+reference to the editor to work on
+</dd>
+</dl>
+<a NAME="MarkdownProvider.hasBold" ID="MarkdownProvider.hasBold"></a>
+<h4>MarkdownProvider.hasBold</h4>
+<b>hasBold</b>(<i></i>)
+
+<p>
+ Public method to indicate the availability of bold markup.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating the availability of bold markup
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<a NAME="MarkdownProvider.hasBulletedList" ID="MarkdownProvider.hasBulletedList"></a>
+<h4>MarkdownProvider.hasBulletedList</h4>
+<b>hasBulletedList</b>(<i></i>)
+
+<p>
+ Public method to indicate the availability of bulleted list markup.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating the availability of bulleted list markup
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<a NAME="MarkdownProvider.hasCode" ID="MarkdownProvider.hasCode"></a>
+<h4>MarkdownProvider.hasCode</h4>
+<b>hasCode</b>(<i></i>)
+
+<p>
+ Public method to indicate the availability of inline code markup.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating the availability of inline code markup
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<a NAME="MarkdownProvider.hasCodeBlock" ID="MarkdownProvider.hasCodeBlock"></a>
+<h4>MarkdownProvider.hasCodeBlock</h4>
+<b>hasCodeBlock</b>(<i></i>)
+
+<p>
+ Public method to indicate the availability of code block markup.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating the availability of code block markup
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<a NAME="MarkdownProvider.hasHyperlink" ID="MarkdownProvider.hasHyperlink"></a>
+<h4>MarkdownProvider.hasHyperlink</h4>
+<b>hasHyperlink</b>(<i></i>)
+
+<p>
+ Public method to indicate the availability of hyperlink markup.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating the availability of hyperlink markup
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<a NAME="MarkdownProvider.hasImage" ID="MarkdownProvider.hasImage"></a>
+<h4>MarkdownProvider.hasImage</h4>
+<b>hasImage</b>(<i></i>)
+
+<p>
+ Public method to indicate the availability of image markup.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating the availability of image markup
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<a NAME="MarkdownProvider.hasItalic" ID="MarkdownProvider.hasItalic"></a>
+<h4>MarkdownProvider.hasItalic</h4>
+<b>hasItalic</b>(<i></i>)
+
+<p>
+ Public method to indicate the availability of italic markup.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating the availability of italic markup
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<a NAME="MarkdownProvider.hasLine" ID="MarkdownProvider.hasLine"></a>
+<h4>MarkdownProvider.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>
+flag indicating the availability of a horizontal line markup
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<a NAME="MarkdownProvider.hasNumberedList" ID="MarkdownProvider.hasNumberedList"></a>
+<h4>MarkdownProvider.hasNumberedList</h4>
+<b>hasNumberedList</b>(<i></i>)
+
+<p>
+ Public method to indicate the availability of numbered list markup.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating the availability of numbered list markup
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<a NAME="MarkdownProvider.hasQuote" ID="MarkdownProvider.hasQuote"></a>
+<h4>MarkdownProvider.hasQuote</h4>
+<b>hasQuote</b>(<i></i>)
+
+<p>
+ Public method to indicate the availability of block quote markup.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating the availability of block quote markup
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<a NAME="MarkdownProvider.hasStrikethrough" ID="MarkdownProvider.hasStrikethrough"></a>
+<h4>MarkdownProvider.hasStrikethrough</h4>
+<b>hasStrikethrough</b>(<i></i>)
+
+<p>
+ Public method to indicate the availability of strikethrough markup.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating the availability of strikethrough markup
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<a NAME="MarkdownProvider.header" ID="MarkdownProvider.header"></a>
+<h4>MarkdownProvider.header</h4>
+<b>header</b>(<i>editor, level</i>)
+
+<p>
+ Public method to generate a header.
+</p>
+<dl>
+
+<dt><i>editor</i> (Editor)</dt>
+<dd>
+reference to the editor to work on
+</dd>
+<dt><i>level</i> (int)</dt>
+<dd>
+header level
+</dd>
+</dl>
+<a NAME="MarkdownProvider.headerLevels" ID="MarkdownProvider.headerLevels"></a>
+<h4>MarkdownProvider.headerLevels</h4>
+<b>headerLevels</b>(<i></i>)
+
+<p>
+ Public method to determine the available header levels.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+supported header levels
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+int
+</dd>
+</dl>
+<a NAME="MarkdownProvider.hyperlink" ID="MarkdownProvider.hyperlink"></a>
+<h4>MarkdownProvider.hyperlink</h4>
+<b>hyperlink</b>(<i>editor</i>)
+
+<p>
+ Public method to generate hyperlink text.
+</p>
+<dl>
+
+<dt><i>editor</i> (Editor)</dt>
+<dd>
+reference to the editor to work on
+</dd>
+</dl>
+<a NAME="MarkdownProvider.image" ID="MarkdownProvider.image"></a>
+<h4>MarkdownProvider.image</h4>
+<b>image</b>(<i>editor</i>)
+
+<p>
+ Public method to generate image text.
+</p>
+<dl>
+
+<dt><i>editor</i> (Editor)</dt>
+<dd>
+reference to the editor to work on
+</dd>
+</dl>
+<a NAME="MarkdownProvider.italic" ID="MarkdownProvider.italic"></a>
+<h4>MarkdownProvider.italic</h4>
+<b>italic</b>(<i>editor</i>)
+
+<p>
+ Public method to generate italic text.
+</p>
+<dl>
+
+<dt><i>editor</i> (Editor)</dt>
+<dd>
+reference to the editor to work on
+</dd>
+</dl>
+<a NAME="MarkdownProvider.kind" ID="MarkdownProvider.kind"></a>
+<h4>MarkdownProvider.kind</h4>
+<b>kind</b>(<i></i>)
+
+<p>
+ Public method to get the markup kind.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+string with markup kind
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<a NAME="MarkdownProvider.line" ID="MarkdownProvider.line"></a>
+<h4>MarkdownProvider.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>
+<dd>
+reference to the editor to work on
+</dd>
+</dl>
+<a NAME="MarkdownProvider.numberedList" ID="MarkdownProvider.numberedList"></a>
+<h4>MarkdownProvider.numberedList</h4>
+<b>numberedList</b>(<i>editor</i>)
+
+<p>
+ Public method to generate numbered list text.
+</p>
+<dl>
+
+<dt><i>editor</i> (Editor)</dt>
+<dd>
+reference to the editor to work on
+</dd>
+</dl>
+<a NAME="MarkdownProvider.quote" ID="MarkdownProvider.quote"></a>
+<h4>MarkdownProvider.quote</h4>
+<b>quote</b>(<i>editor</i>)
+
+<p>
+ Public method to generate block quote text.
+</p>
+<dl>
+
+<dt><i>editor</i> (Editor)</dt>
+<dd>
+reference to the editor to work on
+</dd>
+</dl>
+<a NAME="MarkdownProvider.strikethrough" ID="MarkdownProvider.strikethrough"></a>
+<h4>MarkdownProvider.strikethrough</h4>
+<b>strikethrough</b>(<i>editor</i>)
+
+<p>
+ Public method to generate strikethrough text.
+</p>
+<dl>
+
+<dt><i>editor</i> (Editor)</dt>
+<dd>
+reference to the editor to work on
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file
