--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Documentation/Source/eric5.QScintilla.TypingCompleters.CompleterRuby.html Sat Jan 02 18:19:35 2010 +0000 @@ -0,0 +1,161 @@ +<?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.TypingCompleters.CompleterRuby</title> +<style> +b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' +</style> +</head> +<body><a NAME="top" ID="top"></a> +<h1>eric5.QScintilla.TypingCompleters.CompleterRuby</h1> +<p> +Module implementing a typing completer for Ruby. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#CompleterRuby">CompleterRuby</a></td> +<td>Class implementing typing completer for Ruby.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="CompleterRuby" ID="CompleterRuby"></a> +<h2>CompleterRuby</h2> +<p> + Class implementing typing completer for Ruby. +</p> +<h3>Derived from</h3> +CompleterBase +<h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#CompleterRuby.__init__">CompleterRuby</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#CompleterRuby.__inComment">__inComment</a></td> +<td>Private method to check, if the cursor is inside a comment</td> +</tr><tr> +<td><a href="#CompleterRuby.__inDoubleQuotedString">__inDoubleQuotedString</a></td> +<td>Private method to check, if the cursor is within a double quoted string.</td> +</tr><tr> +<td><a href="#CompleterRuby.__inHereDocument">__inHereDocument</a></td> +<td>Private method to check, if the cursor is within a here document.</td> +</tr><tr> +<td><a href="#CompleterRuby.__inInlineDocument">__inInlineDocument</a></td> +<td>Private method to check, if the cursor is within an inline document.</td> +</tr><tr> +<td><a href="#CompleterRuby.__inSingleQuotedString">__inSingleQuotedString</a></td> +<td>Private method to check, if the cursor is within a single quoted string.</td> +</tr><tr> +<td><a href="#CompleterRuby.charAdded">charAdded</a></td> +<td>Public slot called to handle the user entering a character.</td> +</tr><tr> +<td><a href="#CompleterRuby.readSettings">readSettings</a></td> +<td>Public slot called to reread the configuration parameters.</td> +</tr> +</table> +<a NAME="CompleterRuby.__init__" ID="CompleterRuby.__init__"></a> +<h4>CompleterRuby (Constructor)</h4> +<b>CompleterRuby</b>(<i>editor, parent = None</i>) +<p> + Constructor +</p><dl> +<dt><i>editor</i></dt> +<dd> +reference to the editor object (QScintilla.Editor) +</dd><dt><i>parent</i></dt> +<dd> +reference to the parent object (QObject) +</dd> +</dl><a NAME="CompleterRuby.__inComment" ID="CompleterRuby.__inComment"></a> +<h4>CompleterRuby.__inComment</h4> +<b>__inComment</b>(<i>line, col</i>) +<p> + Private method to check, if the cursor is inside a comment +</p><dl> +<dt><i>line</i></dt> +<dd> +current line (integer) +</dd><dt><i>col</i></dt> +<dd> +current position within line (integer) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +flag indicating, if the cursor is inside a comment (boolean) +</dd> +</dl><a NAME="CompleterRuby.__inDoubleQuotedString" ID="CompleterRuby.__inDoubleQuotedString"></a> +<h4>CompleterRuby.__inDoubleQuotedString</h4> +<b>__inDoubleQuotedString</b>(<i></i>) +<p> + Private method to check, if the cursor is within a double quoted string. +</p><dl> +<dt>Returns:</dt> +<dd> +flag indicating, if the cursor is inside a double + quoted string (boolean) +</dd> +</dl><a NAME="CompleterRuby.__inHereDocument" ID="CompleterRuby.__inHereDocument"></a> +<h4>CompleterRuby.__inHereDocument</h4> +<b>__inHereDocument</b>(<i></i>) +<p> + Private method to check, if the cursor is within a here document. +</p><dl> +<dt>Returns:</dt> +<dd> +flag indicating, if the cursor is inside a here document (boolean) +</dd> +</dl><a NAME="CompleterRuby.__inInlineDocument" ID="CompleterRuby.__inInlineDocument"></a> +<h4>CompleterRuby.__inInlineDocument</h4> +<b>__inInlineDocument</b>(<i></i>) +<p> + Private method to check, if the cursor is within an inline document. +</p><dl> +<dt>Returns:</dt> +<dd> +flag indicating, if the cursor is inside an inline document (boolean) +</dd> +</dl><a NAME="CompleterRuby.__inSingleQuotedString" ID="CompleterRuby.__inSingleQuotedString"></a> +<h4>CompleterRuby.__inSingleQuotedString</h4> +<b>__inSingleQuotedString</b>(<i></i>) +<p> + Private method to check, if the cursor is within a single quoted string. +</p><dl> +<dt>Returns:</dt> +<dd> +flag indicating, if the cursor is inside a single + quoted string (boolean) +</dd> +</dl><a NAME="CompleterRuby.charAdded" ID="CompleterRuby.charAdded"></a> +<h4>CompleterRuby.charAdded</h4> +<b>charAdded</b>(<i>charNumber</i>) +<p> + Public slot called to handle the user entering a character. +</p><dl> +<dt><i>charNumber</i></dt> +<dd> +value of the character entered (integer) +</dd> +</dl><a NAME="CompleterRuby.readSettings" ID="CompleterRuby.readSettings"></a> +<h4>CompleterRuby.readSettings</h4> +<b>readSettings</b>(<i></i>) +<p> + Public slot called to reread the configuration parameters. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file