src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerPygments.html

branch
eric7
changeset 9295
d14096c04126
parent 9209
b99e7fd55fd3
child 10070
9f5758c0fec1
--- a/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerPygments.html	Tue Aug 23 19:33:07 2022 +0200
+++ b/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerPygments.html	Tue Aug 23 19:35:42 2022 +0200
@@ -63,10 +63,30 @@
 <td>Private method to guess a pygments lexer.</td>
 </tr>
 <tr>
+<td><a href="#LexerPygments.boxCommentStr">boxCommentStr</a></td>
+<td>Public method to return the box comment strings.</td>
+</tr>
+<tr>
+<td><a href="#LexerPygments.canBlockComment">canBlockComment</a></td>
+<td>Public method to determine, whether the lexer language supports a block comment.</td>
+</tr>
+<tr>
+<td><a href="#LexerPygments.canBoxComment">canBoxComment</a></td>
+<td>Public method to determine, whether the lexer language supports a box comment.</td>
+</tr>
+<tr>
+<td><a href="#LexerPygments.canStreamComment">canStreamComment</a></td>
+<td>Public method to determine, whether the lexer language supports a stream comment.</td>
+</tr>
+<tr>
 <td><a href="#LexerPygments.canStyle">canStyle</a></td>
 <td>Public method to check, if the lexer is able to style the text.</td>
 </tr>
 <tr>
+<td><a href="#LexerPygments.commentStr">commentStr</a></td>
+<td>Public method to return the comment string.</td>
+</tr>
+<tr>
 <td><a href="#LexerPygments.defaultColor">defaultColor</a></td>
 <td>Public method to get the default foreground color for a style.</td>
 </tr>
@@ -111,6 +131,10 @@
 <td>Public method to read the lexer settings.</td>
 </tr>
 <tr>
+<td><a href="#LexerPygments.streamCommentStr">streamCommentStr</a></td>
+<td>Public method to return the stream comment strings.</td>
+</tr>
+<tr>
 <td><a href="#LexerPygments.styleText">styleText</a></td>
 <td>Public method to perform the styling.</td>
 </tr>
@@ -159,6 +183,85 @@
 reference to the guessed lexer (pygments.lexer)
 </dd>
 </dl>
+<a NAME="LexerPygments.boxCommentStr" ID="LexerPygments.boxCommentStr"></a>
+<h4>LexerPygments.boxCommentStr</h4>
+<b>boxCommentStr</b>(<i></i>)
+
+<p>
+        Public method to return the box comment strings.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+dictionary containing the start, middle and end box comment strings
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+dict of {"start": str, "middle": str, "end": str}
+</dd>
+</dl>
+<a NAME="LexerPygments.canBlockComment" ID="LexerPygments.canBlockComment"></a>
+<h4>LexerPygments.canBlockComment</h4>
+<b>canBlockComment</b>(<i></i>)
+
+<p>
+        Public method to determine, whether the lexer language supports a
+        block comment.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating block comment is available
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<a NAME="LexerPygments.canBoxComment" ID="LexerPygments.canBoxComment"></a>
+<h4>LexerPygments.canBoxComment</h4>
+<b>canBoxComment</b>(<i></i>)
+
+<p>
+        Public method to determine, whether the lexer language supports a
+        box comment.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag box comment is available
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<a NAME="LexerPygments.canStreamComment" ID="LexerPygments.canStreamComment"></a>
+<h4>LexerPygments.canStreamComment</h4>
+<b>canStreamComment</b>(<i></i>)
+
+<p>
+        Public method to determine, whether the lexer language supports a
+        stream comment.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating stream comment is available
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
 <a NAME="LexerPygments.canStyle" ID="LexerPygments.canStyle"></a>
 <h4>LexerPygments.canStyle</h4>
 <b>canStyle</b>(<i></i>)
@@ -172,6 +275,25 @@
 flag indicating the lexer capability (boolean)
 </dd>
 </dl>
+<a NAME="LexerPygments.commentStr" ID="LexerPygments.commentStr"></a>
+<h4>LexerPygments.commentStr</h4>
+<b>commentStr</b>(<i></i>)
+
+<p>
+        Public method to return the comment string.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+comment string
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
 <a NAME="LexerPygments.defaultColor" ID="LexerPygments.defaultColor"></a>
 <h4>LexerPygments.defaultColor</h4>
 <b>defaultColor</b>(<i>style</i>)
@@ -380,6 +502,25 @@
 prefix for the settings key (defaults to "/Scintilla")
 </dd>
 </dl>
+<a NAME="LexerPygments.streamCommentStr" ID="LexerPygments.streamCommentStr"></a>
+<h4>LexerPygments.streamCommentStr</h4>
+<b>streamCommentStr</b>(<i></i>)
+
+<p>
+        Public method to return the stream comment strings.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+dictionary containing the start and end stream comment strings
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+dict of {"start": str, "end": str}
+</dd>
+</dl>
 <a NAME="LexerPygments.styleText" ID="LexerPygments.styleText"></a>
 <h4>LexerPygments.styleText</h4>
 <b>styleText</b>(<i>start, end</i>)

eric ide

mercurial