Fri, 27 Oct 2023 14:09:40 +0200
Regenerated the source documentation with the corrected module parser.
<!DOCTYPE html> <html><head> <title>eric7.QScintilla.Lexers.LexerBatch</title> <meta charset="UTF-8"> <link rel="stylesheet" href="styles.css"> </head> <body> <a NAME="top" ID="top"></a> <h1>eric7.QScintilla.Lexers.LexerBatch</h1> <p> Module implementing a Batch file lexer with some additional methods. </p> <h3>Global Attributes</h3> <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> <table> <tr> <td><a href="#LexerBatch">LexerBatch</a></td> <td>Subclass to implement some additional lexer dependant methods.</td> </tr> </table> <h3>Functions</h3> <table> <tr> <td><a href="#createLexer">createLexer</a></td> <td>Function to instantiate a lexer object.</td> </tr> </table> <hr /> <hr /> <a NAME="LexerBatch" ID="LexerBatch"></a> <h2>LexerBatch</h2> <p> Subclass to implement some additional lexer dependant methods. </p> <h3>Derived from</h3> Lexer, QsciLexerBatch <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="#LexerBatch.__init__">LexerBatch</a></td> <td>Constructor</td> </tr> <tr> <td><a href="#LexerBatch.defaultKeywords">defaultKeywords</a></td> <td>Public method to get the default keywords.</td> </tr> <tr> <td><a href="#LexerBatch.isCommentStyle">isCommentStyle</a></td> <td>Public method to check, if a style is a comment style.</td> </tr> <tr> <td><a href="#LexerBatch.isStringStyle">isStringStyle</a></td> <td>Public method to check, if a style is a string style.</td> </tr> </table> <h3>Static Methods</h3> <table> <tr><td>None</td></tr> </table> <a NAME="LexerBatch.__init__" ID="LexerBatch.__init__"></a> <h4>LexerBatch (Constructor)</h4> <b>LexerBatch</b>(<i>parent=None</i>) <p> Constructor </p> <dl> <dt><i>parent</i></dt> <dd> parent widget of this lexer </dd> </dl> <a NAME="LexerBatch.defaultKeywords" ID="LexerBatch.defaultKeywords"></a> <h4>LexerBatch.defaultKeywords</h4> <b>defaultKeywords</b>(<i>kwSet</i>) <p> Public method to get the default keywords. </p> <dl> <dt><i>kwSet</i></dt> <dd> number of the keyword set (integer) </dd> </dl> <dl> <dt>Return:</dt> <dd> string giving the keywords (string) or None </dd> </dl> <a NAME="LexerBatch.isCommentStyle" ID="LexerBatch.isCommentStyle"></a> <h4>LexerBatch.isCommentStyle</h4> <b>isCommentStyle</b>(<i>style</i>) <p> Public method to check, if a style is a comment style. </p> <dl> <dt><i>style</i></dt> <dd> style to check (integer) </dd> </dl> <dl> <dt>Return:</dt> <dd> flag indicating a comment style (boolean) </dd> </dl> <a NAME="LexerBatch.isStringStyle" ID="LexerBatch.isStringStyle"></a> <h4>LexerBatch.isStringStyle</h4> <b>isStringStyle</b>(<i>style</i>) <p> Public method to check, if a style is a string style. </p> <dl> <dt><i>style</i></dt> <dd> style to check (integer) </dd> </dl> <dl> <dt>Return:</dt> <dd> flag indicating a string style (boolean) </dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> <a NAME="createLexer" ID="createLexer"></a> <h2>createLexer</h2> <b>createLexer</b>(<i>variant="", parent=None</i>) <p> Function to instantiate a lexer object. </p> <dl> <dt><i>variant</i> (str)</dt> <dd> name of the language variant </dd> <dt><i>parent</i> (QObject)</dt> <dd> parent widget of this lexer </dd> </dl> <dl> <dt>Return:</dt> <dd> instantiated lexer object </dd> </dl> <dl> <dt>Return Type:</dt> <dd> LexerBatch </dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html>