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

<!DOCTYPE html>
<html><head>
<title>eric7.QScintilla.Lexers.LexerBash</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.QScintilla.Lexers.LexerBash</h1>

<p>
Module implementing a Bash lexer with some additional methods.
</p>
<h3>Global Attributes</h3>

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

<table>

<tr>
<td><a href="#LexerBash">LexerBash</a></td>
<td>Subclass to implement some additional lexer dependant methods.</td>
</tr>
</table>
<h3>Functions</h3>

<table>

<tr>
<td><a href="#createLexer">createLexer</a></td>
<td>Function to instantiate a lexer object.</td>
</tr>
</table>
<hr />
<hr />
<a NAME="LexerBash" ID="LexerBash"></a>
<h2>LexerBash</h2>

<p>
    Subclass to implement some additional lexer dependant methods.
</p>
<h3>Derived from</h3>
Lexer, QsciLexerBash
<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="#LexerBash.__init__">LexerBash</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#LexerBash.defaultKeywords">defaultKeywords</a></td>
<td>Public method to get the default keywords.</td>
</tr>
<tr>
<td><a href="#LexerBash.initProperties">initProperties</a></td>
<td>Public slot to initialize the properties.</td>
</tr>
<tr>
<td><a href="#LexerBash.isCommentStyle">isCommentStyle</a></td>
<td>Public method to check, if a style is a comment style.</td>
</tr>
<tr>
<td><a href="#LexerBash.isStringStyle">isStringStyle</a></td>
<td>Public method to check, if a style is a string style.</td>
</tr>
</table>
<h3>Static Methods</h3>

<table>
<tr><td>None</td></tr>
</table>

<a NAME="LexerBash.__init__" ID="LexerBash.__init__"></a>
<h4>LexerBash (Constructor)</h4>
<b>LexerBash</b>(<i>parent=None</i>)

<p>
        Constructor
</p>
<dl>

<dt><i>parent</i></dt>
<dd>
parent widget of this lexer
</dd>
</dl>
<a NAME="LexerBash.defaultKeywords" ID="LexerBash.defaultKeywords"></a>
<h4>LexerBash.defaultKeywords</h4>
<b>defaultKeywords</b>(<i>kwSet</i>)

<p>
        Public method to get the default 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="LexerBash.initProperties" ID="LexerBash.initProperties"></a>
<h4>LexerBash.initProperties</h4>
<b>initProperties</b>(<i></i>)

<p>
        Public slot to initialize the properties.
</p>
<a NAME="LexerBash.isCommentStyle" ID="LexerBash.isCommentStyle"></a>
<h4>LexerBash.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></dt>
<dd>
style to check (integer)
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
flag indicating a comment style (boolean)
</dd>
</dl>
<a NAME="LexerBash.isStringStyle" ID="LexerBash.isStringStyle"></a>
<h4>LexerBash.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></dt>
<dd>
style to check (integer)
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
flag indicating a string style (boolean)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="createLexer" ID="createLexer"></a>
<h2>createLexer</h2>
<b>createLexer</b>(<i>variant="", parent=None</i>)

<p>
    Function to instantiate a lexer object.
</p>
<dl>

<dt><i>variant</i> (str)</dt>
<dd>
name of the language variant
</dd>
<dt><i>parent</i> (QObject)</dt>
<dd>
parent widget of this lexer
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
instantiated lexer object
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
LexerBash
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>