--- a/eric6/Documentation/Source/eric6.QScintilla.Lexers.LexerLua.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.QScintilla.Lexers.LexerLua.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,147 +18,193 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.QScintilla.Lexers.LexerLua</h1> + <p> Module implementing a Lua 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="#LexerLua">LexerLua</a></td> <td>Subclass to implement some additional lexer dependant methods.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="LexerLua" ID="LexerLua"></a> <h2>LexerLua</h2> + <p> Subclass to implement some additional lexer dependant methods. </p> <h3>Derived from</h3> Lexer, QsciLexerLua <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="#LexerLua.__init__">LexerLua</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#LexerLua.autoCompletionWordSeparators">autoCompletionWordSeparators</a></td> <td>Public method to return the list of separators for autocompletion.</td> -</tr><tr> +</tr> +<tr> <td><a href="#LexerLua.defaultKeywords">defaultKeywords</a></td> <td>Public method to get the default keywords.</td> -</tr><tr> +</tr> +<tr> <td><a href="#LexerLua.initProperties">initProperties</a></td> <td>Public slot to initialize the properties.</td> -</tr><tr> +</tr> +<tr> <td><a href="#LexerLua.isCommentStyle">isCommentStyle</a></td> <td>Public method to check, if a style is a comment style.</td> -</tr><tr> +</tr> +<tr> <td><a href="#LexerLua.isStringStyle">isStringStyle</a></td> <td>Public method to check, if a style is a string style.</td> -</tr><tr> +</tr> +<tr> <td><a href="#LexerLua.maximumKeywordSet">maximumKeywordSet</a></td> <td>Public method to get the maximum keyword set.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="LexerLua.__init__" ID="LexerLua.__init__"></a> <h4>LexerLua (Constructor)</h4> <b>LexerLua</b>(<i>parent=None</i>) + <p> Constructor -</p><dl> +</p> +<dl> + <dt><i>parent</i></dt> <dd> parent widget of this lexer </dd> -</dl><a NAME="LexerLua.autoCompletionWordSeparators" ID="LexerLua.autoCompletionWordSeparators"></a> +</dl> +<a NAME="LexerLua.autoCompletionWordSeparators" ID="LexerLua.autoCompletionWordSeparators"></a> <h4>LexerLua.autoCompletionWordSeparators</h4> <b>autoCompletionWordSeparators</b>(<i></i>) + <p> Public method to return the list of separators for autocompletion. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> list of separators (list of strings) </dd> -</dl><a NAME="LexerLua.defaultKeywords" ID="LexerLua.defaultKeywords"></a> +</dl> +<a NAME="LexerLua.defaultKeywords" ID="LexerLua.defaultKeywords"></a> <h4>LexerLua.defaultKeywords</h4> <b>defaultKeywords</b>(<i>kwSet</i>) + <p> Public method to get the default keywords. -</p><dl> +</p> +<dl> + <dt><i>kwSet</i></dt> <dd> number of the keyword set (integer) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> string giving the keywords (string) or None </dd> -</dl><a NAME="LexerLua.initProperties" ID="LexerLua.initProperties"></a> +</dl> +<a NAME="LexerLua.initProperties" ID="LexerLua.initProperties"></a> <h4>LexerLua.initProperties</h4> <b>initProperties</b>(<i></i>) + <p> Public slot to initialize the properties. -</p><a NAME="LexerLua.isCommentStyle" ID="LexerLua.isCommentStyle"></a> +</p> +<a NAME="LexerLua.isCommentStyle" ID="LexerLua.isCommentStyle"></a> <h4>LexerLua.isCommentStyle</h4> <b>isCommentStyle</b>(<i>style</i>) + <p> Public method to check, if a style is a comment style. -</p><dl> +</p> +<dl> + <dt><i>style</i></dt> <dd> style to check (integer) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> flag indicating a comment style (boolean) </dd> -</dl><a NAME="LexerLua.isStringStyle" ID="LexerLua.isStringStyle"></a> +</dl> +<a NAME="LexerLua.isStringStyle" ID="LexerLua.isStringStyle"></a> <h4>LexerLua.isStringStyle</h4> <b>isStringStyle</b>(<i>style</i>) + <p> Public method to check, if a style is a string style. -</p><dl> +</p> +<dl> + <dt><i>style</i></dt> <dd> style to check (integer) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> flag indicating a string style (boolean) </dd> -</dl><a NAME="LexerLua.maximumKeywordSet" ID="LexerLua.maximumKeywordSet"></a> +</dl> +<a NAME="LexerLua.maximumKeywordSet" ID="LexerLua.maximumKeywordSet"></a> <h4>LexerLua.maximumKeywordSet</h4> <b>maximumKeywordSet</b>(<i></i>) + <p> Public method to get the maximum keyword set. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> maximum keyword set (integer)