diff -r 892c1787d666 -r edde1fe80b3e Documentation/Source/eric5.DebugClients.Ruby.Completer.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Documentation/Source/eric5.DebugClients.Ruby.Completer.html Sat Jan 02 18:19:35 2010 +0000 @@ -0,0 +1,108 @@ +<?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.DebugClients.Ruby.Completer</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.DebugClients.Ruby.Completer</h1> +<p> +File implementing a command line completer class. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#Completer">Completer</a></td> +<td>Class implementing a command completer.</td> +</tr> +</table> +<h3>Modules</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="Completer" ID="Completer"></a> +<h2>Completer</h2> +<p> +Class implementing a command completer. +</p> +<h3>Derived from</h3> +None +<h3>Class Attributes</h3> +<table> +<tr><td>Operators</td></tr><tr><td>ReservedWords</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#Completer.complete">complete</a></td> +<td>Public method to select the possible completions</td> +</tr><tr> +<td><a href="#Completer.initialize">initialize</a></td> +<td>constructor</td> +</tr><tr> +<td><a href="#Completer.select_message">select_message</a></td> +<td>Method used to pick completion candidates.</td> +</tr> +</table> +<a NAME="Completer.complete" ID="Completer.complete"></a> +<h4>Completer.complete</h4> +<b>complete</b>(<i></i>) +<p> +Public method to select the possible completions +</p><dl> +<dt><i>input</i></dt> +<dd> +text to be completed (String) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +list of possible completions (Array) +</dd> +</dl><a NAME="Completer.initialize" ID="Completer.initialize"></a> +<h4>Completer.initialize</h4> +<b>initialize</b>(<i></i>) +<p> +constructor +</p><dl> +<dt><i>binding</i></dt> +<dd> +binding object used to determine the possible completions +</dd> +</dl><a NAME="Completer.select_message" ID="Completer.select_message"></a> +<h4>Completer.select_message</h4> +<b>select_message</b>(<i>message, candidates</i>) +<p> +Method used to pick completion candidates. +</p><dl> +<dt><i>receiver</i></dt> +<dd> +object receiving the message +</dd><dt><i>message</i></dt> +<dd> +message to be sent to object +</dd><dt><i>candidates</i></dt> +<dd> +possible completion candidates +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +filtered list of candidates +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file