Documentation/Source/eric5.QScintilla.Lexers.LexerContainer.html

changeset 58
37f0444c3479
parent 21
b88a0e6268bd
child 409
0ea528e80202
--- a/Documentation/Source/eric5.QScintilla.Lexers.LexerContainer.html	Thu Jan 14 17:27:31 2010 +0000
+++ b/Documentation/Source/eric5.QScintilla.Lexers.LexerContainer.html	Thu Jan 14 18:35:52 2010 +0000
@@ -22,7 +22,7 @@
 <body><a NAME="top" ID="top"></a>
 <h1>eric5.QScintilla.Lexers.LexerContainer</h1>
 <p>
-&#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#98;&#97;&#115;&#101; &#99;&#108;&#97;&#115;&#115; &#102;&#111;&#114; &#99;&#117;&#115;&#116;&#111;&#109; &#108;&#101;x&#101;&#114;&#115;.
+Module implementing a base class for custom lexers.
 </p>
 <h3>Global Attributes</h3>
 <table>
@@ -32,7 +32,7 @@
 <table>
 <tr>
 <td><a href="#LexerContainer">LexerContainer</a></td>
-<td>&#83;&#117;&#98;&#99;&#108;&#97;&#115;&#115; &#97;&#115; &#97; &#98;&#97;&#115;&#101; &#102;&#111;&#114; &#116;&#104;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#111;&#102; &#99;&#117;&#115;&#116;&#111;&#109; &#108;&#101;x&#101;&#114;&#115;.</td>
+<td>Subclass as a base for the implementation of custom lexers.</td>
 </tr>
 </table>
 <h3>Functions</h3>
@@ -45,7 +45,7 @@
 <p>
 
 </p><p>
-    &#83;&#117;&#98;&#99;&#108;&#97;&#115;&#115; &#97;&#115; &#97; &#98;&#97;&#115;&#101; &#102;&#111;&#114; &#116;&#104;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#111;&#102; &#99;&#117;&#115;&#116;&#111;&#109; &#108;&#101;x&#101;&#114;&#115;.
+    Subclass as a base for the implementation of custom lexers.
 </p>
 <h3>Derived from</h3>
 QsciLexer, Lexer
@@ -57,94 +57,94 @@
 <table>
 <tr>
 <td><a href="#LexerContainer.__init__">LexerContainer</a></td>
-<td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td>
+<td>Constructor</td>
 </tr><tr>
 <td><a href="#LexerContainer.description">description</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#114;&#101;&#116;&#117;&#114;&#110;&#105;&#110;&#103; &#116;&#104;&#101; &#100;&#101;&#115;&#99;&#114;&#105;&#112;&#116;&#105;&#111;&#110;&#115; &#111;&#102; &#116;&#104;&#101; &#115;&#116;y&#108;&#101;&#115; &#115;&#117;&#112;&#112;&#111;&#114;&#116;&#101;&#100; &#98;y &#116;&#104;&#101; &#108;&#101;x&#101;&#114;.</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>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#114;&#101;&#116;&#117;&#114;&#110;&#105;&#110;&#103; &#116;&#104;&#101; &#108;&#97;&#110;&#103;&#117;&#97;&#103;&#101; &#111;&#102; &#116;&#104;&#101; &#108;&#101;x&#101;&#114;.</td>
+<td>Public method returning the language of the lexer.</td>
 </tr><tr>
 <td><a href="#LexerContainer.lexer">lexer</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#114;&#101;&#116;&#117;&#114;&#110;&#105;&#110;&#103; &#116;&#104;&#101; &#116;y&#112;&#101; &#111;&#102; &#116;&#104;&#101; &#108;&#101;x&#101;&#114;.</td>
+<td>Public method returning the type of the lexer.</td>
 </tr><tr>
 <td><a href="#LexerContainer.styleBitsNeeded">styleBitsNeeded</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#116; &#116;&#104;&#101; &#110;&#117;&#109;&#98;&#101;&#114; &#111;&#102; &#115;&#116;y&#108;&#101; &#98;&#105;&#116;&#115; &#110;&#101;&#101;&#100;&#101;&#100; &#98;y &#116;&#104;&#101; &#108;&#101;x&#101;&#114;.</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>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#112;&#101;&#114;&#102;&#111;&#114;&#109; &#116;&#104;&#101; &#115;&#116;y&#108;&#105;&#110;&#103;.</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>
-        &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;
+        Constructor
 </p><dl>
 <dt><i>parent</i></dt>
 <dd>
-&#112;&#97;&#114;&#101;&#110;&#116; w&#105;&#100;&#103;&#101;&#116; &#111;&#102; &#116;&#104;&#105;&#115; &#108;&#101;x&#101;&#114;
+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>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#114;&#101;&#116;&#117;&#114;&#110;&#105;&#110;&#103; &#116;&#104;&#101; &#100;&#101;&#115;&#99;&#114;&#105;&#112;&#116;&#105;&#111;&#110;&#115; &#111;&#102; &#116;&#104;&#101; &#115;&#116;y&#108;&#101;&#115; &#115;&#117;&#112;&#112;&#111;&#114;&#116;&#101;&#100;
-        &#98;y &#116;&#104;&#101; &#108;&#101;x&#101;&#114;.
+        Public method returning the descriptions of the styles supported
+        by the lexer.
 </p><p>
-        &#60;&#98;&#62;&#78;&#111;&#116;&#101;&#60;/&#98;&#62;&#58; &#84;&#104;&#105;&#115; &#109;&#101;&#116;&#104;&#111;&#100;&#115; &#110;&#101;&#101;&#100;&#115; &#116;&#111; &#98;&#101; &#111;v&#101;&#114;&#114;&#105;&#100;&#100;&#101;&#110; &#98;y &#116;&#104;&#101; &#108;&#101;x&#101;&#114; &#99;&#108;&#97;&#115;&#115;.
+        <b>Note</b>: This methods needs to be overridden by the lexer class.
 </p><dl>
 <dt><i>style</i></dt>
 <dd>
-&#115;&#116;y&#108;&#101; &#110;&#117;&#109;&#98;&#101;&#114; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+style number (integer)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-&#100;&#101;&#115;&#99;&#114;&#105;&#112;&#116;&#105;&#111;&#110; &#102;&#111;&#114; &#116;&#104;&#101; &#103;&#105;v&#101;&#110; &#115;&#116;y&#108;&#101; (&#115;&#116;&#114;&#105;&#110;&#103;)
+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>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#114;&#101;&#116;&#117;&#114;&#110;&#105;&#110;&#103; &#116;&#104;&#101; &#108;&#97;&#110;&#103;&#117;&#97;&#103;&#101; &#111;&#102; &#116;&#104;&#101; &#108;&#101;x&#101;&#114;.
+        Public method returning the language of the lexer.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#108;&#97;&#110;&#103;&#117;&#97;&#103;&#101; &#111;&#102; &#116;&#104;&#101; &#108;&#101;x&#101;&#114; (&#115;&#116;&#114;&#105;&#110;&#103;)
+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>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#114;&#101;&#116;&#117;&#114;&#110;&#105;&#110;&#103; &#116;&#104;&#101; &#116;y&#112;&#101; &#111;&#102; &#116;&#104;&#101; &#108;&#101;x&#101;&#114;.
+        Public method returning the type of the lexer.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#116;y&#112;&#101; &#111;&#102; &#116;&#104;&#101; &#108;&#101;x&#101;&#114; (&#115;&#116;&#114;&#105;&#110;&#103;)
+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>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#116; &#116;&#104;&#101; &#110;&#117;&#109;&#98;&#101;&#114; &#111;&#102; &#115;&#116;y&#108;&#101; &#98;&#105;&#116;&#115; &#110;&#101;&#101;&#100;&#101;&#100; &#98;y &#116;&#104;&#101; &#108;&#101;x&#101;&#114;.
+        Public method to get the number of style bits needed by the lexer.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#110;&#117;&#109;&#98;&#101;&#114; &#111;&#102; &#115;&#116;y&#108;&#101; &#98;&#105;&#116;&#115; &#110;&#101;&#101;&#100;&#101;&#100; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+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>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#112;&#101;&#114;&#102;&#111;&#114;&#109; &#116;&#104;&#101; &#115;&#116;y&#108;&#105;&#110;&#103;.
+        Public method to perform the styling.
 </p><dl>
 <dt><i>start</i></dt>
 <dd>
-&#112;&#111;&#115;&#105;&#116;&#105;&#111;&#110; &#111;&#102; &#102;&#105;&#114;&#115;&#116; &#99;&#104;&#97;&#114;&#97;&#99;&#116;&#101;&#114; &#116;&#111; &#98;&#101; &#115;&#116;y&#108;&#101;&#100; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+position of first character to be styled (integer)
 </dd><dt><i>end</i></dt>
 <dd>
-&#112;&#111;&#115;&#105;&#116;&#105;&#111;&#110; &#111;&#102; &#108;&#97;&#115;&#116; &#99;&#104;&#97;&#114;&#97;&#99;&#116;&#101;&#114; &#116;&#111; &#98;&#101; &#115;&#116;y&#108;&#101;&#100; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+position of last character to be styled (integer)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>

eric ide

mercurial