--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.CodeAssist.html Sat Feb 28 15:09:53 2015 +0100 @@ -0,0 +1,123 @@ +<!DOCTYPE html> +<html><head> +<title>Plugin_Refactoring_Rope.RefactoringRope.CodeAssist</title> +<meta charset="UTF-8"> +<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>Plugin_Refactoring_Rope.RefactoringRope.CodeAssist</h1> +<p> +Module implementing the autocompletion interface to rope. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#CodeAssist">CodeAssist</a></td> +<td>Class implementing the autocompletion interface to rope.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="CodeAssist" ID="CodeAssist"></a> +<h2>CodeAssist</h2> +<p> + Class implementing the autocompletion interface to rope. +</p> +<h3>Derived from</h3> +QObject +<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="#CodeAssist.__init__">CodeAssist</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#CodeAssist.getCallTips">getCallTips</a></td> +<td>Public method to calculate calltips.</td> +</tr><tr> +<td><a href="#CodeAssist.getCompletions">getCompletions</a></td> +<td>Public method to calculate the possible completions.</td> +</tr> +</table> +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<a NAME="CodeAssist.__init__" ID="CodeAssist.__init__"></a> +<h4>CodeAssist (Constructor)</h4> +<b>CodeAssist</b>(<i>refactoring, editor, plugin, parent = None</i>) +<p> + Constructor +</p><dl> +<dt><i>refactoring</i></dt> +<dd> +reference to the rope refactoring object + (Refactoring) +</dd><dt><i>editor</i></dt> +<dd> +reference to the editor object, that called this method + QScintilla.Editor) +</dd><dt><i>plugin</i></dt> +<dd> +reference to the plugin object +</dd><dt><i>parent</i></dt> +<dd> +parent (QObject) +</dd> +</dl><a NAME="CodeAssist.getCallTips" ID="CodeAssist.getCallTips"></a> +<h4>CodeAssist.getCallTips</h4> +<b>getCallTips</b>(<i>pos</i>) +<p> + Public method to calculate calltips. +</p><dl> +<dt><i>pos</i></dt> +<dd> +position in the text for the calltip (integer) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +list of possible calltips (list of strings) +</dd> +</dl><a NAME="CodeAssist.getCompletions" ID="CodeAssist.getCompletions"></a> +<h4>CodeAssist.getCompletions</h4> +<b>getCompletions</b>(<i></i>) +<p> + Public method to calculate the possible completions. +</p><dl> +<dt>Returns:</dt> +<dd> +list of proposals (QStringList) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file