Mercurial Repositories > eric / file revision
Documentation/Source/eric5.QScintilla.Lexers.Lexer.html@edde1fe80b3e
Documentation/Source/eric5.QScintilla.Lexers.Lexer.html
Sat, 02 Jan 2010 18:19:35 +0000
- author
- Detlev Offenbach <detlev@die-offenbachs.de>
- date
- Sat, 02 Jan 2010 18:19:35 +0000
- changeset 17
- edde1fe80b3e
- child 21
- b88a0e6268bd
- permissions
- -rw-r--r--
Updated documentation.
<?xml version="1.0" encoding="utf-8"?> <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> <html><head> <title>eric5.QScintilla.Lexers.Lexer</title> <style> b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' </style> </head> <body><a NAME="top" ID="top"></a> <h1>eric5.QScintilla.Lexers.Lexer</h1> <p> Module implementing the lexer base class. </p> <h3>Global Attributes</h3> <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> <table> <tr> <td><a href="#Lexer">Lexer</a></td> <td>Class to implement the lexer mixin class.</td> </tr> </table> <h3>Functions</h3> <table> <tr><td>None</td></tr> </table> <hr /><hr /> <a NAME="Lexer" ID="Lexer"></a> <h2>Lexer</h2> <p> </p><p> Class to implement the lexer mixin class. </p> <h3>Derived from</h3> object <h3>Class Attributes</h3> <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> <table> <tr> <td><a href="#Lexer.__init__">Lexer</a></td> <td>Constructor</td> </tr><tr> <td><a href="#Lexer.alwaysKeepTabs">alwaysKeepTabs</a></td> <td>Public method to check, if tab conversion is allowed.</td> </tr><tr> <td><a href="#Lexer.autoCompletionWordSeparators">autoCompletionWordSeparators</a></td> <td>Public method to return the list of separators for autocompletion.</td> </tr><tr> <td><a href="#Lexer.boxCommentStr">boxCommentStr</a></td> <td>Public method to return the box comment strings.</td> </tr><tr> <td><a href="#Lexer.canBlockComment">canBlockComment</a></td> <td>Public method to determine, whether the lexer language supports a block comment.</td> </tr><tr> <td><a href="#Lexer.canBoxComment">canBoxComment</a></td> <td>Public method to determine, whether the lexer language supports a box comment.</td> </tr><tr> <td><a href="#Lexer.canStreamComment">canStreamComment</a></td> <td>Public method to determine, whether the lexer language supports a stream comment.</td> </tr><tr> <td><a href="#Lexer.commentStr">commentStr</a></td> <td>Public method to return the comment string.</td> </tr><tr> <td><a href="#Lexer.hasSmartIndent">hasSmartIndent</a></td> <td>Public method indicating whether lexer can do smart indentation.</td> </tr><tr> <td><a href="#Lexer.initProperties">initProperties</a></td> <td>Public slot to initialize the properties.</td> </tr><tr> <td><a href="#Lexer.isCommentStyle">isCommentStyle</a></td> <td>Public method to check, if a style is a comment style.</td> </tr><tr> <td><a href="#Lexer.isStringStyle">isStringStyle</a></td> <td>Public method to check, if a style is a string style.</td> </tr><tr> <td><a href="#Lexer.smartIndentLine">smartIndentLine</a></td> <td>Public method to handle smart indentation for a line.</td> </tr><tr> <td><a href="#Lexer.smartIndentSelection">smartIndentSelection</a></td> <td>Public method to handle smart indentation for a selection of lines.</td> </tr><tr> <td><a href="#Lexer.streamCommentStr">streamCommentStr</a></td> <td>Public method to return the stream comment strings.</td> </tr> </table> <a NAME="Lexer.__init__" ID="Lexer.__init__"></a> <h4>Lexer (Constructor)</h4> <b>Lexer</b>(<i></i>) <p> Constructor </p><a NAME="Lexer.alwaysKeepTabs" ID="Lexer.alwaysKeepTabs"></a> <h4>Lexer.alwaysKeepTabs</h4> <b>alwaysKeepTabs</b>(<i></i>) <p> Public method to check, if tab conversion is allowed. </p><dl> <dt>Returns:</dt> <dd> flag indicating to keep tabs (boolean) </dd> </dl><a NAME="Lexer.autoCompletionWordSeparators" ID="Lexer.autoCompletionWordSeparators"></a> <h4>Lexer.autoCompletionWordSeparators</h4> <b>autoCompletionWordSeparators</b>(<i></i>) <p> Public method to return the list of separators for autocompletion. </p><dl> <dt>Returns:</dt> <dd> list of separators (list of strings) </dd> </dl><a NAME="Lexer.boxCommentStr" ID="Lexer.boxCommentStr"></a> <h4>Lexer.boxCommentStr</h4> <b>boxCommentStr</b>(<i></i>) <p> Public method to return the box comment strings. </p><dl> <dt>Returns:</dt> <dd> box comment strings (dictionary with three QStrings) </dd> </dl><a NAME="Lexer.canBlockComment" ID="Lexer.canBlockComment"></a> <h4>Lexer.canBlockComment</h4> <b>canBlockComment</b>(<i></i>) <p> Public method to determine, whether the lexer language supports a block comment. </p><dl> <dt>Returns:</dt> <dd> flag (boolean) </dd> </dl><a NAME="Lexer.canBoxComment" ID="Lexer.canBoxComment"></a> <h4>Lexer.canBoxComment</h4> <b>canBoxComment</b>(<i></i>) <p> Public method to determine, whether the lexer language supports a box comment. </p><dl> <dt>Returns:</dt> <dd> flag (boolean) </dd> </dl><a NAME="Lexer.canStreamComment" ID="Lexer.canStreamComment"></a> <h4>Lexer.canStreamComment</h4> <b>canStreamComment</b>(<i></i>) <p> Public method to determine, whether the lexer language supports a stream comment. </p><dl> <dt>Returns:</dt> <dd> flag (boolean) </dd> </dl><a NAME="Lexer.commentStr" ID="Lexer.commentStr"></a> <h4>Lexer.commentStr</h4> <b>commentStr</b>(<i></i>) <p> Public method to return the comment string. </p><dl> <dt>Returns:</dt> <dd> comment string (string) </dd> </dl><a NAME="Lexer.hasSmartIndent" ID="Lexer.hasSmartIndent"></a> <h4>Lexer.hasSmartIndent</h4> <b>hasSmartIndent</b>(<i></i>) <p> Public method indicating whether lexer can do smart indentation. </p><dl> <dt>Returns:</dt> <dd> flag indicating availability of smartIndentLine and smartIndentSelection methods (boolean) </dd> </dl><a NAME="Lexer.initProperties" ID="Lexer.initProperties"></a> <h4>Lexer.initProperties</h4> <b>initProperties</b>(<i></i>) <p> Public slot to initialize the properties. </p><a NAME="Lexer.isCommentStyle" ID="Lexer.isCommentStyle"></a> <h4>Lexer.isCommentStyle</h4> <b>isCommentStyle</b>(<i>style</i>) <p> Public method to check, if a style is a comment style. </p><dl> <dt>Returns:</dt> <dd> flag indicating a comment style (boolean) </dd> </dl><a NAME="Lexer.isStringStyle" ID="Lexer.isStringStyle"></a> <h4>Lexer.isStringStyle</h4> <b>isStringStyle</b>(<i>style</i>) <p> Public method to check, if a style is a string style. </p><dl> <dt>Returns:</dt> <dd> flag indicating a string style (boolean) </dd> </dl><a NAME="Lexer.smartIndentLine" ID="Lexer.smartIndentLine"></a> <h4>Lexer.smartIndentLine</h4> <b>smartIndentLine</b>(<i>editor</i>) <p> Public method to handle smart indentation for a line. </p><dl> <dt><i>editor</i></dt> <dd> reference to the QScintilla editor object </dd> </dl><a NAME="Lexer.smartIndentSelection" ID="Lexer.smartIndentSelection"></a> <h4>Lexer.smartIndentSelection</h4> <b>smartIndentSelection</b>(<i>editor</i>) <p> Public method to handle smart indentation for a selection of lines. </p><p> Note: The assumption is, that the first line determines the new indentation level. </p><dl> <dt><i>editor</i></dt> <dd> reference to the QScintilla editor object </dd> </dl><a NAME="Lexer.streamCommentStr" ID="Lexer.streamCommentStr"></a> <h4>Lexer.streamCommentStr</h4> <b>streamCommentStr</b>(<i></i>) <p> Public method to return the stream comment strings. </p><dl> <dt>Returns:</dt> <dd> stream comment strings (dictionary with two strings) </dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html>
