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

<?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>
body {
    background: #EDECE6;
    margin: 0em 1em 10em 1em;
    color: black;
}

h1 { color: white; background: #85774A; }
h2 { color: white; background: #85774A; }
h3 { color: white; background: #9D936E; }
h4 { color: white; background: #9D936E; }
    
a { color: #BA6D36; }

</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>
    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>Class Methods</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.keywords">keywords</a></td>
<td>Public method to get the keywords.</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>
<h3>Static Methods</h3>
<table>
<tr><td>None</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.keywords" ID="LexerContainer.keywords"></a>
<h4>LexerContainer.keywords</h4>
<b>keywords</b>(<i>kwSet</i>)
<p>
        Public method to get the keywords.
</p><dl>
<dt><i>kwSet</i></dt>
<dd>
number of the keyword set (integer)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
string giving the keywords (string) or None
</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>