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

<!DOCTYPE html>
<html><head>
<title>eric7.QScintilla.Lexers.Lexer</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.QScintilla.Lexers.Lexer</h1>
<p>
Module implementing the lexer mixin class.
</p>

<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Classes</h3>
<table>
<tr>
<td><a href="#Lexer">Lexer</a></td>
<td>Class to implement the lexer mixin class.</td>
</tr>
</table>

<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>

<hr />
<hr />
<a NAME="Lexer" ID="Lexer"></a>
<h2>Lexer</h2>
<p>
    Class to implement the lexer mixin class.
</p>

<h3>Derived from</h3>
None
<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="#Lexer.__init__">Lexer</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#Lexer.alwaysKeepTabs">alwaysKeepTabs</a></td>
<td>Public method to check, if tab conversion is allowed.</td>
</tr>
<tr>
<td><a href="#Lexer.autoCompletionWordSeparators">autoCompletionWordSeparators</a></td>
<td>Public method to return the list of separators for autocompletion.</td>
</tr>
<tr>
<td><a href="#Lexer.boxCommentStr">boxCommentStr</a></td>
<td>Public method to return the box comment strings.</td>
</tr>
<tr>
<td><a href="#Lexer.canBlockComment">canBlockComment</a></td>
<td>Public method to determine, whether the lexer language supports a block comment.</td>
</tr>
<tr>
<td><a href="#Lexer.canBoxComment">canBoxComment</a></td>
<td>Public method to determine, whether the lexer language supports a box comment.</td>
</tr>
<tr>
<td><a href="#Lexer.canStreamComment">canStreamComment</a></td>
<td>Public method to determine, whether the lexer language supports a stream comment.</td>
</tr>
<tr>
<td><a href="#Lexer.commentStr">commentStr</a></td>
<td>Public method to return the comment string.</td>
</tr>
<tr>
<td><a href="#Lexer.defaultKeywords">defaultKeywords</a></td>
<td>Public method to get the default keywords.</td>
</tr>
<tr>
<td><a href="#Lexer.hasSmartIndent">hasSmartIndent</a></td>
<td>Public method indicating whether lexer can do smart indentation.</td>
</tr>
<tr>
<td><a href="#Lexer.hasSubstyles">hasSubstyles</a></td>
<td>Public method to indicate the support of sub-styles.</td>
</tr>
<tr>
<td><a href="#Lexer.initProperties">initProperties</a></td>
<td>Public slot to initialize the properties.</td>
</tr>
<tr>
<td><a href="#Lexer.isCommentStyle">isCommentStyle</a></td>
<td>Public method to check, if a style is a comment style.</td>
</tr>
<tr>
<td><a href="#Lexer.isStringStyle">isStringStyle</a></td>
<td>Public method to check, if a style is a string style.</td>
</tr>
<tr>
<td><a href="#Lexer.keywords">keywords</a></td>
<td>Public method to get the keywords.</td>
</tr>
<tr>
<td><a href="#Lexer.keywordsDescription">keywordsDescription</a></td>
<td>Public method to get the description for a keywords set.</td>
</tr>
<tr>
<td><a href="#Lexer.lexerName">lexerName</a></td>
<td>Public method to return the lexer name.</td>
</tr>
<tr>
<td><a href="#Lexer.maximumKeywordSet">maximumKeywordSet</a></td>
<td>Public method to get the maximum keyword set.</td>
</tr>
<tr>
<td><a href="#Lexer.smartIndentLine">smartIndentLine</a></td>
<td>Public method to handle smart indentation for a line.</td>
</tr>
<tr>
<td><a href="#Lexer.smartIndentSelection">smartIndentSelection</a></td>
<td>Public method to handle smart indentation for a selection of lines.</td>
</tr>
<tr>
<td><a href="#Lexer.streamCommentStr">streamCommentStr</a></td>
<td>Public method to return the stream comment strings.</td>
</tr>
</table>

<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>


<a NAME="Lexer.__init__" ID="Lexer.__init__"></a>
<h4>Lexer (Constructor)</h4>
<b>Lexer</b>(<i></i>)
<p>
        Constructor
</p>

<a NAME="Lexer.alwaysKeepTabs" ID="Lexer.alwaysKeepTabs"></a>
<h4>Lexer.alwaysKeepTabs</h4>
<b>alwaysKeepTabs</b>(<i></i>)
<p>
        Public method to check, if tab conversion is allowed.
</p>

<dl>
<dt>Return:</dt>
<dd>
flag indicating to keep tabs
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<a NAME="Lexer.autoCompletionWordSeparators" ID="Lexer.autoCompletionWordSeparators"></a>
<h4>Lexer.autoCompletionWordSeparators</h4>
<b>autoCompletionWordSeparators</b>(<i></i>)
<p>
        Public method to return the list of separators for autocompletion.
</p>

<dl>
<dt>Return:</dt>
<dd>
list of separators
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
list of str
</dd>
</dl>
<a NAME="Lexer.boxCommentStr" ID="Lexer.boxCommentStr"></a>
<h4>Lexer.boxCommentStr</h4>
<b>boxCommentStr</b>(<i></i>)
<p>
        Public method to return the box comment strings.
</p>

<dl>
<dt>Return:</dt>
<dd>
dictionary containing the start, middle and end box comment strings
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
dict of {"start": str, "middle": str, "end": str}
</dd>
</dl>
<a NAME="Lexer.canBlockComment" ID="Lexer.canBlockComment"></a>
<h4>Lexer.canBlockComment</h4>
<b>canBlockComment</b>(<i></i>)
<p>
        Public method to determine, whether the lexer language supports a
        block comment.
</p>

<dl>
<dt>Return:</dt>
<dd>
flag indicating block comment is available
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<a NAME="Lexer.canBoxComment" ID="Lexer.canBoxComment"></a>
<h4>Lexer.canBoxComment</h4>
<b>canBoxComment</b>(<i></i>)
<p>
        Public method to determine, whether the lexer language supports a
        box comment.
</p>

<dl>
<dt>Return:</dt>
<dd>
flag box comment is available
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<a NAME="Lexer.canStreamComment" ID="Lexer.canStreamComment"></a>
<h4>Lexer.canStreamComment</h4>
<b>canStreamComment</b>(<i></i>)
<p>
        Public method to determine, whether the lexer language supports a
        stream comment.
</p>

<dl>
<dt>Return:</dt>
<dd>
flag indicating stream comment is available
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<a NAME="Lexer.commentStr" ID="Lexer.commentStr"></a>
<h4>Lexer.commentStr</h4>
<b>commentStr</b>(<i></i>)
<p>
        Public method to return the comment string.
</p>

<dl>
<dt>Return:</dt>
<dd>
comment string
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<a NAME="Lexer.defaultKeywords" ID="Lexer.defaultKeywords"></a>
<h4>Lexer.defaultKeywords</h4>
<b>defaultKeywords</b>(<i>kwSet</i>)
<p>
        Public method to get the default keywords.
</p>

<dl>

<dt><i>kwSet</i> (int)</dt>
<dd>
number of the keyword set
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
space separated list of keywords
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str or None
</dd>
</dl>
<a NAME="Lexer.hasSmartIndent" ID="Lexer.hasSmartIndent"></a>
<h4>Lexer.hasSmartIndent</h4>
<b>hasSmartIndent</b>(<i></i>)
<p>
        Public method indicating whether lexer can do smart indentation.
</p>

<dl>
<dt>Return:</dt>
<dd>
flag indicating availability of smartIndentLine and
            smartIndentSelection methods
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<a NAME="Lexer.hasSubstyles" ID="Lexer.hasSubstyles"></a>
<h4>Lexer.hasSubstyles</h4>
<b>hasSubstyles</b>(<i></i>)
<p>
        Public method to indicate the support of sub-styles.
</p>

<dl>
<dt>Return:</dt>
<dd>
flag indicating sub-styling support
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<a NAME="Lexer.initProperties" ID="Lexer.initProperties"></a>
<h4>Lexer.initProperties</h4>
<b>initProperties</b>(<i></i>)
<p>
        Public slot to initialize the properties.
</p>

<a NAME="Lexer.isCommentStyle" ID="Lexer.isCommentStyle"></a>
<h4>Lexer.isCommentStyle</h4>
<b>isCommentStyle</b>(<i>style</i>)
<p>
        Public method to check, if a style is a comment style.
</p>

<dl>

<dt><i>style</i> (int)</dt>
<dd>
style to check
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
flag indicating a comment style
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<a NAME="Lexer.isStringStyle" ID="Lexer.isStringStyle"></a>
<h4>Lexer.isStringStyle</h4>
<b>isStringStyle</b>(<i>style</i>)
<p>
        Public method to check, if a style is a string style.
</p>

<dl>

<dt><i>style</i> (int)</dt>
<dd>
style to check
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
flag indicating a string style
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<a NAME="Lexer.keywords" ID="Lexer.keywords"></a>
<h4>Lexer.keywords</h4>
<b>keywords</b>(<i>kwSet</i>)
<p>
        Public method to get the keywords.
</p>

<dl>

<dt><i>kwSet</i> (int)</dt>
<dd>
number of the keyword set
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
space separated list of keywords
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str or None
</dd>
</dl>
<a NAME="Lexer.keywordsDescription" ID="Lexer.keywordsDescription"></a>
<h4>Lexer.keywordsDescription</h4>
<b>keywordsDescription</b>(<i>kwSet</i>)
<p>
        Public method to get the description for a keywords set.
</p>

<dl>

<dt><i>kwSet</i> (int)</dt>
<dd>
number of the keyword set
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
description of the keyword set
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<a NAME="Lexer.lexerName" ID="Lexer.lexerName"></a>
<h4>Lexer.lexerName</h4>
<b>lexerName</b>(<i></i>)
<p>
        Public method to return the lexer name.
</p>

<dl>
<dt>Return:</dt>
<dd>
lexer name
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<a NAME="Lexer.maximumKeywordSet" ID="Lexer.maximumKeywordSet"></a>
<h4>Lexer.maximumKeywordSet</h4>
<b>maximumKeywordSet</b>(<i></i>)
<p>
        Public method to get the maximum keyword set.
</p>
<p>
        Note: A return value of 0 indicates to determine this dynamically.
</p>

<dl>
<dt>Return:</dt>
<dd>
maximum keyword set
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
int
</dd>
</dl>
<a NAME="Lexer.smartIndentLine" ID="Lexer.smartIndentLine"></a>
<h4>Lexer.smartIndentLine</h4>
<b>smartIndentLine</b>(<i>editor</i>)
<p>
        Public method to handle smart indentation for a line.
</p>

<dl>

<dt><i>editor</i> (Editor)</dt>
<dd>
reference to the QScintilla editor object
</dd>
</dl>
<a NAME="Lexer.smartIndentSelection" ID="Lexer.smartIndentSelection"></a>
<h4>Lexer.smartIndentSelection</h4>
<b>smartIndentSelection</b>(<i>editor</i>)
<p>
        Public method to handle smart indentation for a selection of lines.
</p>
<p>
        Note: The assumption is, that the first line determines the new
              indentation level.
</p>

<dl>

<dt><i>editor</i> (Editor)</dt>
<dd>
reference to the QScintilla editor object
</dd>
</dl>
<a NAME="Lexer.streamCommentStr" ID="Lexer.streamCommentStr"></a>
<h4>Lexer.streamCommentStr</h4>
<b>streamCommentStr</b>(<i></i>)
<p>
        Public method to return the stream comment strings.
</p>

<dl>
<dt>Return:</dt>
<dd>
dictionary containing the start and end stream comment strings
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
dict of {"start": str, "end": str}
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>