Documentation/Source/eric5.QScintilla.Lexers.LexerRuby.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.LexerRuby</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.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>None</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>
QsciLexerRuby, Lexer
<h3>Class Attributes</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>
<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></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>Returns:</dt>
<dd>
list of separators (list of strings)
</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></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="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>Returns:</dt>
<dd>
flag indicating a comment style (boolean)
</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>Returns:</dt>
<dd>
flag indicating a string style (boolean)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>