src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerContainer.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10070
9f5758c0fec1
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/eric7/Documentation/Source/eric7.QScintilla.Lexers.LexerContainer.html	Thu Jul 07 11:23:56 2022 +0200
@@ -0,0 +1,192 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.QScintilla.Lexers.LexerContainer</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.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>
+Lexer, QsciLexer
+<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.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>Return:</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>Return:</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>Return:</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>Return:</dt>
+<dd>
+type of the lexer (string)
+</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>
\ No newline at end of file

eric ide

mercurial