Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric4.QScintilla.Lexers.LexerContainer.html
Documentation/Source/eric4.QScintilla.Lexers.LexerContainer.html
- changeset 3
- 0d9daebf5b8c
equal
deleted
inserted
replaced
| 2:bc6196164237 | 3:0d9daebf5b8c |
|---|---|
| 1 <?xml version="1.0" encoding="utf-8"?> | |
| 2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' | |
| 3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> | |
| 4 <html><head> | |
| 5 <title>eric4.QScintilla.Lexers.LexerContainer</title> | |
| 6 <style> | |
| 7 body { | |
| 8 background:white; | |
| 9 margin: 0em 1em 10em 1em; | |
| 10 color: black; | |
| 11 } | |
| 12 | |
| 13 h1 { color: white; background: #4FA4FF; } | |
| 14 h2 { color: white; background: #4FA4FF; } | |
| 15 h3 { color: white; background: #00557F; } | |
| 16 h4 { color: white; background: #00557F; } | |
| 17 | |
| 18 a { color: #AA5500; } | |
| 19 | |
| 20 </style> | |
| 21 </head> | |
| 22 <body><a NAME="top" ID="top"></a> | |
| 23 <h1>eric4.QScintilla.Lexers.LexerContainer</h1> | |
| 24 <p> | |
| 25 Module implementing a base class for custom lexers. | |
| 26 </p> | |
| 27 <h3>Global Attributes</h3> | |
| 28 <table> | |
| 29 <tr><td>None</td></tr> | |
| 30 </table> | |
| 31 <h3>Classes</h3> | |
| 32 <table> | |
| 33 <tr> | |
| 34 <td><a href="#LexerContainer">LexerContainer</a></td> | |
| 35 <td>Subclass as a base for the implementation of custom lexers.</td> | |
| 36 </tr> | |
| 37 </table> | |
| 38 <h3>Functions</h3> | |
| 39 <table> | |
| 40 <tr><td>None</td></tr> | |
| 41 </table> | |
| 42 <hr /><hr /> | |
| 43 <a NAME="LexerContainer" ID="LexerContainer"></a> | |
| 44 <h2>LexerContainer</h2> | |
| 45 <p> | |
| 46 | |
| 47 </p><p> | |
| 48 Subclass as a base for the implementation of custom lexers. | |
| 49 </p> | |
| 50 <h3>Derived from</h3> | |
| 51 QsciLexer, Lexer | |
| 52 <h3>Class Attributes</h3> | |
| 53 <table> | |
| 54 <tr><td>None</td></tr> | |
| 55 </table> | |
| 56 <h3>Methods</h3> | |
| 57 <table> | |
| 58 <tr> | |
| 59 <td><a href="#LexerContainer.__init__">LexerContainer</a></td> | |
| 60 <td>Constructor</td> | |
| 61 </tr><tr> | |
| 62 <td><a href="#LexerContainer.description">description</a></td> | |
| 63 <td>Public method returning the descriptions of the styles supported by the lexer.</td> | |
| 64 </tr><tr> | |
| 65 <td><a href="#LexerContainer.language">language</a></td> | |
| 66 <td>Public method returning the language of the lexer.</td> | |
| 67 </tr><tr> | |
| 68 <td><a href="#LexerContainer.lexer">lexer</a></td> | |
| 69 <td>Public method returning the type of the lexer.</td> | |
| 70 </tr><tr> | |
| 71 <td><a href="#LexerContainer.styleBitsNeeded">styleBitsNeeded</a></td> | |
| 72 <td>Public method to get the number of style bits needed by the lexer.</td> | |
| 73 </tr><tr> | |
| 74 <td><a href="#LexerContainer.styleText">styleText</a></td> | |
| 75 <td>Public method to perform the styling.</td> | |
| 76 </tr> | |
| 77 </table> | |
| 78 <a NAME="LexerContainer.__init__" ID="LexerContainer.__init__"></a> | |
| 79 <h4>LexerContainer (Constructor)</h4> | |
| 80 <b>LexerContainer</b>(<i>parent = None</i>) | |
| 81 <p> | |
| 82 Constructor | |
| 83 </p><dl> | |
| 84 <dt><i>parent</i></dt> | |
| 85 <dd> | |
| 86 parent widget of this lexer | |
| 87 </dd> | |
| 88 </dl><a NAME="LexerContainer.description" ID="LexerContainer.description"></a> | |
| 89 <h4>LexerContainer.description</h4> | |
| 90 <b>description</b>(<i>style</i>) | |
| 91 <p> | |
| 92 Public method returning the descriptions of the styles supported | |
| 93 by the lexer. | |
| 94 </p><p> | |
| 95 <b>Note</b>: This methods needs to be overridden by the lexer class. | |
| 96 </p><dl> | |
| 97 <dt><i>style</i></dt> | |
| 98 <dd> | |
| 99 style number (integer) | |
| 100 </dd> | |
| 101 </dl><dl> | |
| 102 <dt>Returns:</dt> | |
| 103 <dd> | |
| 104 description for the given style (string) | |
| 105 </dd> | |
| 106 </dl><a NAME="LexerContainer.language" ID="LexerContainer.language"></a> | |
| 107 <h4>LexerContainer.language</h4> | |
| 108 <b>language</b>(<i></i>) | |
| 109 <p> | |
| 110 Public method returning the language of the lexer. | |
| 111 </p><dl> | |
| 112 <dt>Returns:</dt> | |
| 113 <dd> | |
| 114 language of the lexer (string) | |
| 115 </dd> | |
| 116 </dl><a NAME="LexerContainer.lexer" ID="LexerContainer.lexer"></a> | |
| 117 <h4>LexerContainer.lexer</h4> | |
| 118 <b>lexer</b>(<i></i>) | |
| 119 <p> | |
| 120 Public method returning the type of the lexer. | |
| 121 </p><dl> | |
| 122 <dt>Returns:</dt> | |
| 123 <dd> | |
| 124 type of the lexer (string) | |
| 125 </dd> | |
| 126 </dl><a NAME="LexerContainer.styleBitsNeeded" ID="LexerContainer.styleBitsNeeded"></a> | |
| 127 <h4>LexerContainer.styleBitsNeeded</h4> | |
| 128 <b>styleBitsNeeded</b>(<i></i>) | |
| 129 <p> | |
| 130 Public method to get the number of style bits needed by the lexer. | |
| 131 </p><dl> | |
| 132 <dt>Returns:</dt> | |
| 133 <dd> | |
| 134 number of style bits needed (integer) | |
| 135 </dd> | |
| 136 </dl><a NAME="LexerContainer.styleText" ID="LexerContainer.styleText"></a> | |
| 137 <h4>LexerContainer.styleText</h4> | |
| 138 <b>styleText</b>(<i>start, end</i>) | |
| 139 <p> | |
| 140 Public method to perform the styling. | |
| 141 </p><dl> | |
| 142 <dt><i>start</i></dt> | |
| 143 <dd> | |
| 144 position of first character to be styled (integer) | |
| 145 </dd><dt><i>end</i></dt> | |
| 146 <dd> | |
| 147 position of last character to be styled (integer) | |
| 148 </dd> | |
| 149 </dl> | |
| 150 <div align="right"><a href="#top">Up</a></div> | |
| 151 <hr /> | |
| 152 </body></html> |
