--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.PluginRefactoringRope.html Sun Jan 30 18:26:37 2011 +0100 @@ -0,0 +1,127 @@ +<?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>Plugin_Refactoring_Rope.PluginRefactoringRope</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>Plugin_Refactoring_Rope.PluginRefactoringRope</h1> +<p> +Module implementing the Rope refactoring plugin. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>author</td></tr><tr><td>autoactivate</td></tr><tr><td>className</td></tr><tr><td>deactivateable</td></tr><tr><td>error</td></tr><tr><td>internalPackages</td></tr><tr><td>longDescription</td></tr><tr><td>name</td></tr><tr><td>packageName</td></tr><tr><td>pyqtApi</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#RefactoringRopePlugin">RefactoringRopePlugin</a></td> +<td>Class implementing the Rope refactoring plugin.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="RefactoringRopePlugin" ID="RefactoringRopePlugin"></a> +<h2>RefactoringRopePlugin</h2> +<p> + Class implementing the Rope refactoring plugin. +</p> +<h3>Derived from</h3> +QObject +<h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#RefactoringRopePlugin.__init__">RefactoringRopePlugin</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#RefactoringRopePlugin.__initialize">__initialize</a></td> +<td>Private slot to (re)initialize the plugin.</td> +</tr><tr> +<td><a href="#RefactoringRopePlugin.__loadTranslator">__loadTranslator</a></td> +<td>Private method to load the translation file.</td> +</tr><tr> +<td><a href="#RefactoringRopePlugin.__projectClosed">__projectClosed</a></td> +<td>Public slot to handle the projectClosed signal.</td> +</tr><tr> +<td><a href="#RefactoringRopePlugin.__projectOpened">__projectOpened</a></td> +<td>Public slot to handle the projectOpened signal.</td> +</tr><tr> +<td><a href="#RefactoringRopePlugin.activate">activate</a></td> +<td>Public method to activate this plugin.</td> +</tr><tr> +<td><a href="#RefactoringRopePlugin.deactivate">deactivate</a></td> +<td>Public method to deactivate this plugin.</td> +</tr> +</table> +<a NAME="RefactoringRopePlugin.__init__" ID="RefactoringRopePlugin.__init__"></a> +<h4>RefactoringRopePlugin (Constructor)</h4> +<b>RefactoringRopePlugin</b>(<i>ui</i>) +<p> + Constructor +</p><dl> +<dt><i>ui</i></dt> +<dd> +reference to the user interface object (UI.UserInterface) +</dd> +</dl><a NAME="RefactoringRopePlugin.__initialize" ID="RefactoringRopePlugin.__initialize"></a> +<h4>RefactoringRopePlugin.__initialize</h4> +<b>__initialize</b>(<i></i>) +<p> + Private slot to (re)initialize the plugin. +</p><a NAME="RefactoringRopePlugin.__loadTranslator" ID="RefactoringRopePlugin.__loadTranslator"></a> +<h4>RefactoringRopePlugin.__loadTranslator</h4> +<b>__loadTranslator</b>(<i></i>) +<p> + Private method to load the translation file. +</p><a NAME="RefactoringRopePlugin.__projectClosed" ID="RefactoringRopePlugin.__projectClosed"></a> +<h4>RefactoringRopePlugin.__projectClosed</h4> +<b>__projectClosed</b>(<i></i>) +<p> + Public slot to handle the projectClosed signal. +</p><a NAME="RefactoringRopePlugin.__projectOpened" ID="RefactoringRopePlugin.__projectOpened"></a> +<h4>RefactoringRopePlugin.__projectOpened</h4> +<b>__projectOpened</b>(<i></i>) +<p> + Public slot to handle the projectOpened signal. +</p><a NAME="RefactoringRopePlugin.activate" ID="RefactoringRopePlugin.activate"></a> +<h4>RefactoringRopePlugin.activate</h4> +<b>activate</b>(<i></i>) +<p> + Public method to activate this plugin. +</p><dl> +<dt>Returns:</dt> +<dd> +tuple of None and activation status (boolean) +</dd> +</dl><a NAME="RefactoringRopePlugin.deactivate" ID="RefactoringRopePlugin.deactivate"></a> +<h4>RefactoringRopePlugin.deactivate</h4> +<b>deactivate</b>(<i></i>) +<p> + Public method to deactivate this plugin. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file