Mercurial Repositories > eric / file revision
Documentation/Source/eric5.QScintilla.Lexers.LexerContainer.html@edde1fe80b3e
Documentation/Source/eric5.QScintilla.Lexers.LexerContainer.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.LexerContainer</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.LexerContainer</h1> <p> Module implementing a base class for custom lexers. </p> <h3>Global Attributes</h3> <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> <table> <tr> <td><a href="#LexerContainer">LexerContainer</a></td> <td>Subclass as a base for the implementation of custom lexers.</td> </tr> </table> <h3>Functions</h3> <table> <tr><td>None</td></tr> </table> <hr /><hr /> <a NAME="LexerContainer" ID="LexerContainer"></a> <h2>LexerContainer</h2> <p> </p><p> Subclass as a base for the implementation of custom lexers. </p> <h3>Derived from</h3> QsciLexer, Lexer <h3>Class Attributes</h3> <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> <table> <tr> <td><a href="#LexerContainer.__init__">LexerContainer</a></td> <td>Constructor</td> </tr><tr> <td><a href="#LexerContainer.description">description</a></td> <td>Public method returning the descriptions of the styles supported by the lexer.</td> </tr><tr> <td><a href="#LexerContainer.language">language</a></td> <td>Public method returning the language of the lexer.</td> </tr><tr> <td><a href="#LexerContainer.lexer">lexer</a></td> <td>Public method returning the type of the lexer.</td> </tr><tr> <td><a href="#LexerContainer.styleBitsNeeded">styleBitsNeeded</a></td> <td>Public method to get the number of style bits needed by the lexer.</td> </tr><tr> <td><a href="#LexerContainer.styleText">styleText</a></td> <td>Public method to perform the styling.</td> </tr> </table> <a NAME="LexerContainer.__init__" ID="LexerContainer.__init__"></a> <h4>LexerContainer (Constructor)</h4> <b>LexerContainer</b>(<i>parent = None</i>) <p> Constructor </p><dl> <dt><i>parent</i></dt> <dd> parent widget of this lexer </dd> </dl><a NAME="LexerContainer.description" ID="LexerContainer.description"></a> <h4>LexerContainer.description</h4> <b>description</b>(<i>style</i>) <p> Public method returning the descriptions of the styles supported by the lexer. </p><p> <b>Note</b>: This methods needs to be overridden by the lexer class. </p><dl> <dt><i>style</i></dt> <dd> style number (integer) </dd> </dl><dl> <dt>Returns:</dt> <dd> description for the given style (string) </dd> </dl><a NAME="LexerContainer.language" ID="LexerContainer.language"></a> <h4>LexerContainer.language</h4> <b>language</b>(<i></i>) <p> Public method returning the language of the lexer. </p><dl> <dt>Returns:</dt> <dd> language of the lexer (string) </dd> </dl><a NAME="LexerContainer.lexer" ID="LexerContainer.lexer"></a> <h4>LexerContainer.lexer</h4> <b>lexer</b>(<i></i>) <p> Public method returning the type of the lexer. </p><dl> <dt>Returns:</dt> <dd> type of the lexer (string) </dd> </dl><a NAME="LexerContainer.styleBitsNeeded" ID="LexerContainer.styleBitsNeeded"></a> <h4>LexerContainer.styleBitsNeeded</h4> <b>styleBitsNeeded</b>(<i></i>) <p> Public method to get the number of style bits needed by the lexer. </p><dl> <dt>Returns:</dt> <dd> number of style bits needed (integer) </dd> </dl><a NAME="LexerContainer.styleText" ID="LexerContainer.styleText"></a> <h4>LexerContainer.styleText</h4> <b>styleText</b>(<i>start, end</i>) <p> Public method to perform the styling. </p><dl> <dt><i>start</i></dt> <dd> position of first character to be styled (integer) </dd><dt><i>end</i></dt> <dd> position of last character to be styled (integer) </dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html>
