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

<!DOCTYPE html>
<html><head>
<title>eric7.QScintilla.Lexers.LexerRuby</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.QScintilla.Lexers.LexerRuby</h1>
<p>
Module implementing a Ruby 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="#LexerRuby">LexerRuby</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="LexerRuby" ID="LexerRuby"></a>
<h2>LexerRuby</h2>
<p>
    Subclass to implement some additional lexer dependant methods.
</p>

<h3>Derived from</h3>
Lexer, QsciLexerRuby
<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="#LexerRuby.__init__">LexerRuby</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#LexerRuby.autoCompletionWordSeparators">autoCompletionWordSeparators</a></td>
<td>Public method to return the list of separators for autocompletion.</td>
</tr>
<tr>
<td><a href="#LexerRuby.defaultKeywords">defaultKeywords</a></td>
<td>Public method to get the default keywords.</td>
</tr>
<tr>
<td><a href="#LexerRuby.initProperties">initProperties</a></td>
<td>Public slot to initialize the properties.</td>
</tr>
<tr>
<td><a href="#LexerRuby.isCommentStyle">isCommentStyle</a></td>
<td>Public method to check, if a style is a comment style.</td>
</tr>
<tr>
<td><a href="#LexerRuby.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="LexerRuby.__init__" ID="LexerRuby.__init__"></a>
<h4>LexerRuby (Constructor)</h4>
<b>LexerRuby</b>(<i>parent=None</i>)
<p>
        Constructor
</p>

<dl>

<dt><i>parent</i> (QWidget)</dt>
<dd>
parent widget of this lexer
</dd>
</dl>
<a NAME="LexerRuby.autoCompletionWordSeparators" ID="LexerRuby.autoCompletionWordSeparators"></a>
<h4>LexerRuby.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="LexerRuby.defaultKeywords" ID="LexerRuby.defaultKeywords"></a>
<h4>LexerRuby.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>
string giving the keywords or None
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<a NAME="LexerRuby.initProperties" ID="LexerRuby.initProperties"></a>
<h4>LexerRuby.initProperties</h4>
<b>initProperties</b>(<i></i>)
<p>
        Public slot to initialize the properties.
</p>

<a NAME="LexerRuby.isCommentStyle" ID="LexerRuby.isCommentStyle"></a>
<h4>LexerRuby.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="LexerRuby.isStringStyle" ID="LexerRuby.isStringStyle"></a>
<h4>LexerRuby.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>
<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 (unused)
</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>
LexerRuby
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>