Sun, 30 Jan 2011 18:26:37 +0100
Added source docu.
--- a/PluginRope.e4p Sun Jan 30 18:22:22 2011 +0100 +++ b/PluginRope.e4p Sun Jan 30 18:26:37 2011 +0100 @@ -162,6 +162,8 @@ <Other>RefactoringRope/rope/PKG-INFO</Other> <Other>PKGLIST</Other> <Other>RefactoringRope/Documentation/LICENSE.GPL3</Other> + <Other>PluginRefactoringRope.zip</Other> + <Other>RefactoringRope/Documentation/source</Other> </Others> <MainScript>PluginRefactoringRope.py</MainScript> <Vcs> @@ -283,4 +285,66 @@ <FiletypeAssociation pattern="*.py" type="SOURCES"/> <FiletypeAssociation pattern="Ui_*.py" type="__IGNORE__"/> </FiletypeAssociations> + <Documentation> + <DocumentationParams> + <dict> + <key> + <string>ERIC4DOC</string> + </key> + <value> + <dict> + <key> + <string>cssFile</string> + </key> + <value> + <string>%PYTHON%/eric5/CSSs/default.css</string> + </value> + <key> + <string>ignoreDirectories</string> + </key> + <value> + <list> + <string>rope</string> + <string>.ropeproject</string> + </list> + </value> + <key> + <string>ignoreFilePatterns</string> + </key> + <value> + <list> + <string>Ui_*</string> + </list> + </value> + <key> + <string>outputDirectory</string> + </key> + <value> + <string>RefactoringRope/Documentation/source</string> + </value> + <key> + <string>qtHelpEnabled</string> + </key> + <value> + <bool>False</bool> + </value> + <key> + <string>sourceExtensions</string> + </key> + <value> + <list> + <string></string> + </list> + </value> + <key> + <string>useRecursion</string> + </key> + <value> + <bool>True</bool> + </value> + </dict> + </value> + </dict> + </DocumentationParams> + </Documentation> </Project>
--- /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
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.AddParameterDialog.html Sun Jan 30 18:26:37 2011 +0100 @@ -0,0 +1,100 @@ +<?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.RefactoringRope.AddParameterDialog</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.RefactoringRope.AddParameterDialog</h1> +<p> +Module implementing the Add New Parameter dialog. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#AddParameterDialog">AddParameterDialog</a></td> +<td>Class implementing the Add New Parameter dialog.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="AddParameterDialog" ID="AddParameterDialog"></a> +<h2>AddParameterDialog</h2> +<p> + Class implementing the Add New Parameter dialog. +</p> +<h3>Derived from</h3> +QDialog, Ui_AddParameterDialog +<h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#AddParameterDialog.__init__">AddParameterDialog</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#AddParameterDialog.getData">getData</a></td> +<td>Public method to extract the data entered into the dialog.</td> +</tr><tr> +<td><a href="#AddParameterDialog.on_nameEdit_textChanged">on_nameEdit_textChanged</a></td> +<td>Private slot called, when the name entry is changed.</td> +</tr> +</table> +<a NAME="AddParameterDialog.__init__" ID="AddParameterDialog.__init__"></a> +<h4>AddParameterDialog (Constructor)</h4> +<b>AddParameterDialog</b>(<i>parent = None</i>) +<p> + Constructor +</p><dl> +<dt><i>parent</i></dt> +<dd> +reference to the parent widget (QWidget) +</dd> +</dl><a NAME="AddParameterDialog.getData" ID="AddParameterDialog.getData"></a> +<h4>AddParameterDialog.getData</h4> +<b>getData</b>(<i></i>) +<p> + Public method to extract the data entered into the dialog. +</p><dl> +<dt>Returns:</dt> +<dd> +tuple of three strings (name, default and value) +</dd> +</dl><a NAME="AddParameterDialog.on_nameEdit_textChanged" ID="AddParameterDialog.on_nameEdit_textChanged"></a> +<h4>AddParameterDialog.on_nameEdit_textChanged</h4> +<b>on_nameEdit_textChanged</b>(<i>txt</i>) +<p> + Private slot called, when the name entry is changed. +</p><dl> +<dt><i>txt</i></dt> +<dd> +text of the entry (string) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.ChangeOccurrencesDialog.html Sun Jan 30 18:26:37 2011 +0100 @@ -0,0 +1,130 @@ +<?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.RefactoringRope.ChangeOccurrencesDialog</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.RefactoringRope.ChangeOccurrencesDialog</h1> +<p> +Module implementing the Change Occurrences dialog. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#ChangeOccurrencesDialog">ChangeOccurrencesDialog</a></td> +<td>Class implementing the Change Occurrences dialog.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="ChangeOccurrencesDialog" ID="ChangeOccurrencesDialog"></a> +<h2>ChangeOccurrencesDialog</h2> +<p> + Class implementing the Change Occurrences dialog. +</p> +<h3>Derived from</h3> +RefactoringDialogBase, Ui_ChangeOccurrencesDialog +<h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#ChangeOccurrencesDialog.__init__">ChangeOccurrencesDialog</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#ChangeOccurrencesDialog._calculateChanges">_calculateChanges</a></td> +<td>Protected method to calculate the changes.</td> +</tr><tr> +<td><a href="#ChangeOccurrencesDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> +<td>Private slot to act on the button pressed.</td> +</tr><tr> +<td><a href="#ChangeOccurrencesDialog.on_replaceEdit_textChanged">on_replaceEdit_textChanged</a></td> +<td>Private slot to react to changes of the new name.</td> +</tr> +</table> +<a NAME="ChangeOccurrencesDialog.__init__" ID="ChangeOccurrencesDialog.__init__"></a> +<h4>ChangeOccurrencesDialog (Constructor)</h4> +<b>ChangeOccurrencesDialog</b>(<i>refactoring, title, renamer, parent = None</i>) +<p> + Constructor +</p><dl> +<dt><i>refactoring</i></dt> +<dd> +reference to the main refactoring object + (Refactoring) +</dd><dt><i>title</i></dt> +<dd> +title of the dialog (string) +</dd><dt><i>renamer</i></dt> +<dd> +reference to the renamer object + (rope.refactor.rename.Rename) +</dd><dt><i>parent</i></dt> +<dd> +reference to the parent widget (QWidget) +</dd> +</dl><a NAME="ChangeOccurrencesDialog._calculateChanges" ID="ChangeOccurrencesDialog._calculateChanges"></a> +<h4>ChangeOccurrencesDialog._calculateChanges</h4> +<b>_calculateChanges</b>(<i>handle</i>) +<p> + Protected method to calculate the changes. +</p><dl> +<dt><i>handle</i></dt> +<dd> +reference to the task handle + (rope.base.taskhandle.TaskHandle) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +reference to the Changes object (rope.base.change.ChangeSet) +</dd> +</dl><a NAME="ChangeOccurrencesDialog.on_buttonBox_clicked" ID="ChangeOccurrencesDialog.on_buttonBox_clicked"></a> +<h4>ChangeOccurrencesDialog.on_buttonBox_clicked</h4> +<b>on_buttonBox_clicked</b>(<i>button</i>) +<p> + Private slot to act on the button pressed. +</p><dl> +<dt><i>button</i></dt> +<dd> +reference to the button pressed (QAbstractButton) +</dd> +</dl><a NAME="ChangeOccurrencesDialog.on_replaceEdit_textChanged" ID="ChangeOccurrencesDialog.on_replaceEdit_textChanged"></a> +<h4>ChangeOccurrencesDialog.on_replaceEdit_textChanged</h4> +<b>on_replaceEdit_textChanged</b>(<i>text</i>) +<p> + Private slot to react to changes of the new name. +</p><dl> +<dt><i>text</i></dt> +<dd> +text entered into the edit (string) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.ChangeSignatureDialog.html Sun Jan 30 18:26:37 2011 +0100 @@ -0,0 +1,183 @@ +<?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.RefactoringRope.ChangeSignatureDialog</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.RefactoringRope.ChangeSignatureDialog</h1> +<p> +Module implementing the Change Signature dialog. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#ChangeSignatureDialog">ChangeSignatureDialog</a></td> +<td>Class implementing the Change Signature dialog.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="ChangeSignatureDialog" ID="ChangeSignatureDialog"></a> +<h2>ChangeSignatureDialog</h2> +<p> + Class implementing the Change Signature dialog. +</p> +<h3>Derived from</h3> +RefactoringDialogBase, Ui_ChangeSignatureDialog +<h3>Class Attributes</h3> +<table> +<tr><td>DefaultRole</td></tr><tr><td>IsAddedRole</td></tr><tr><td>NameRole</td></tr><tr><td>ValueRole</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#ChangeSignatureDialog.__init__">ChangeSignatureDialog</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#ChangeSignatureDialog.__getParameterIndex">__getParameterIndex</a></td> +<td>Private method to calculate the index of the given paramter.</td> +</tr><tr> +<td><a href="#ChangeSignatureDialog._calculateChanges">_calculateChanges</a></td> +<td>Protected method to calculate the changes.</td> +</tr><tr> +<td><a href="#ChangeSignatureDialog.on_addButton_clicked">on_addButton_clicked</a></td> +<td>Private slot to add a new parameter.</td> +</tr><tr> +<td><a href="#ChangeSignatureDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> +<td>Private slot to act on the button pressed.</td> +</tr><tr> +<td><a href="#ChangeSignatureDialog.on_downButton_clicked">on_downButton_clicked</a></td> +<td>Private slot called to move the selected item down in the list.</td> +</tr><tr> +<td><a href="#ChangeSignatureDialog.on_parameterList_currentRowChanged">on_parameterList_currentRowChanged</a></td> +<td>Private slot called, when the current row is changed.</td> +</tr><tr> +<td><a href="#ChangeSignatureDialog.on_removeButton_clicked">on_removeButton_clicked</a></td> +<td>Private slot to remove a parameter.</td> +</tr><tr> +<td><a href="#ChangeSignatureDialog.on_upButton_clicked">on_upButton_clicked</a></td> +<td>Private slot called to move the selected item up in the list.</td> +</tr> +</table> +<a NAME="ChangeSignatureDialog.__init__" ID="ChangeSignatureDialog.__init__"></a> +<h4>ChangeSignatureDialog (Constructor)</h4> +<b>ChangeSignatureDialog</b>(<i>refactoring, title, changer, parent=None</i>) +<p> + Constructor +</p><dl> +<dt><i>refactoring</i></dt> +<dd> +reference to the main refactoring object + (Refactoring) +</dd><dt><i>title</i></dt> +<dd> +title of the dialog (string) +</dd><dt><i>changer</i></dt> +<dd> +reference to the signature changer object + (rope.refactor.change_signature.ChangeSignature) +</dd><dt><i>parent</i></dt> +<dd> +reference to the parent widget (QWidget) +</dd> +</dl><a NAME="ChangeSignatureDialog.__getParameterIndex" ID="ChangeSignatureDialog.__getParameterIndex"></a> +<h4>ChangeSignatureDialog.__getParameterIndex</h4> +<b>__getParameterIndex</b>(<i>definition_info, name</i>) +<p> + Private method to calculate the index of the given paramter. +</p><dl> +<dt><i>definition_info</i></dt> +<dd> +object containing the method definition +</dd><dt><i>name</i></dt> +<dd> +parameter name (string) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +index of the parameter (integer) +</dd> +</dl><a NAME="ChangeSignatureDialog._calculateChanges" ID="ChangeSignatureDialog._calculateChanges"></a> +<h4>ChangeSignatureDialog._calculateChanges</h4> +<b>_calculateChanges</b>(<i>handle</i>) +<p> + Protected method to calculate the changes. +</p><dl> +<dt><i>handle</i></dt> +<dd> +reference to the task handle + (rope.base.taskhandle.TaskHandle) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +reference to the Changes object (rope.base.change.ChangeSet) +</dd> +</dl><a NAME="ChangeSignatureDialog.on_addButton_clicked" ID="ChangeSignatureDialog.on_addButton_clicked"></a> +<h4>ChangeSignatureDialog.on_addButton_clicked</h4> +<b>on_addButton_clicked</b>(<i></i>) +<p> + Private slot to add a new parameter. +</p><a NAME="ChangeSignatureDialog.on_buttonBox_clicked" ID="ChangeSignatureDialog.on_buttonBox_clicked"></a> +<h4>ChangeSignatureDialog.on_buttonBox_clicked</h4> +<b>on_buttonBox_clicked</b>(<i>button</i>) +<p> + Private slot to act on the button pressed. +</p><dl> +<dt><i>button</i></dt> +<dd> +reference to the button pressed (QAbstractButton) +</dd> +</dl><a NAME="ChangeSignatureDialog.on_downButton_clicked" ID="ChangeSignatureDialog.on_downButton_clicked"></a> +<h4>ChangeSignatureDialog.on_downButton_clicked</h4> +<b>on_downButton_clicked</b>(<i></i>) +<p> + Private slot called to move the selected item down in the list. +</p><a NAME="ChangeSignatureDialog.on_parameterList_currentRowChanged" ID="ChangeSignatureDialog.on_parameterList_currentRowChanged"></a> +<h4>ChangeSignatureDialog.on_parameterList_currentRowChanged</h4> +<b>on_parameterList_currentRowChanged</b>(<i>currentRow</i>) +<p> + Private slot called, when the current row is changed. +</p><dl> +<dt><i>currentRow</i></dt> +<dd> +index of the current row (integer) +</dd> +</dl><a NAME="ChangeSignatureDialog.on_removeButton_clicked" ID="ChangeSignatureDialog.on_removeButton_clicked"></a> +<h4>ChangeSignatureDialog.on_removeButton_clicked</h4> +<b>on_removeButton_clicked</b>(<i></i>) +<p> + Private slot to remove a parameter. +</p><a NAME="ChangeSignatureDialog.on_upButton_clicked" ID="ChangeSignatureDialog.on_upButton_clicked"></a> +<h4>ChangeSignatureDialog.on_upButton_clicked</h4> +<b>on_upButton_clicked</b>(<i></i>) +<p> + Private slot called to move the selected item up in the list. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.ChangesPreviewDialog.html Sun Jan 30 18:26:37 2011 +0100 @@ -0,0 +1,94 @@ +<?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.RefactoringRope.ChangesPreviewDialog</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.RefactoringRope.ChangesPreviewDialog</h1> +<p> +Module implementing the Changes preview dialog. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#ChangesPreviewDialog">ChangesPreviewDialog</a></td> +<td>Class implementing the Changes preview dialog.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="ChangesPreviewDialog" ID="ChangesPreviewDialog"></a> +<h2>ChangesPreviewDialog</h2> +<p> + Class implementing the Changes preview dialog. +</p> +<h3>Derived from</h3> +PreviewDialogBase +<h3>Class Attributes</h3> +<table> +<tr><td>ChangeRole</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#ChangesPreviewDialog.__init__">ChangesPreviewDialog</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#ChangesPreviewDialog.on_changesList_currentItemChanged">on_changesList_currentItemChanged</a></td> +<td>Private slot called when a change is selected.</td> +</tr> +</table> +<a NAME="ChangesPreviewDialog.__init__" ID="ChangesPreviewDialog.__init__"></a> +<h4>ChangesPreviewDialog (Constructor)</h4> +<b>ChangesPreviewDialog</b>(<i>changes, parent</i>) +<p> + Constructor +</p><dl> +<dt><i>changes</i></dt> +<dd> +reference to the Changes object + (rope.base.change.ChangeSet) +</dd><dt><i>parent</i></dt> +<dd> +reference to the parent widget (QWidget) +</dd> +</dl><a NAME="ChangesPreviewDialog.on_changesList_currentItemChanged" ID="ChangesPreviewDialog.on_changesList_currentItemChanged"></a> +<h4>ChangesPreviewDialog.on_changesList_currentItemChanged</h4> +<b>on_changesList_currentItemChanged</b>(<i>current, previous</i>) +<p> + Private slot called when a change is selected. +</p><dl> +<dt><i>current</i></dt> +<dd> +reference to the new current item (QListWidgetItem) +</dd><dt><i>previous</i></dt> +<dd> +reference to the old current item (QListWidgetItem) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.ConfirmationDialog.html Sun Jan 30 18:26:37 2011 +0100 @@ -0,0 +1,99 @@ +<?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.RefactoringRope.ConfirmationDialog</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.RefactoringRope.ConfirmationDialog</h1> +<p> +Module implementing the Confirmation dialog. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#ConfirmationDialog">ConfirmationDialog</a></td> +<td>Class implementing the Confirmation dialog.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="ConfirmationDialog" ID="ConfirmationDialog"></a> +<h2>ConfirmationDialog</h2> +<p> + Class implementing the Confirmation dialog. +</p> +<h3>Derived from</h3> +QDialog, Ui_ConfirmationDialog +<h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#ConfirmationDialog.__init__">ConfirmationDialog</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#ConfirmationDialog.__previewChanges">__previewChanges</a></td> +<td>Private method to preview the changes.</td> +</tr><tr> +<td><a href="#ConfirmationDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> +<td>Private slot to act on the button pressed.</td> +</tr> +</table> +<a NAME="ConfirmationDialog.__init__" ID="ConfirmationDialog.__init__"></a> +<h4>ConfirmationDialog (Constructor)</h4> +<b>ConfirmationDialog</b>(<i>changes, parent=None</i>) +<p> + Constructor +</p><dl> +<dt><i>changes</i></dt> +<dd> +reference to the Changes object + (rope.base.change.ChangeSet) +</dd><dt><i>parent</i></dt> +<dd> +reference to the parent widget (QWidget) +</dd> +</dl><a NAME="ConfirmationDialog.__previewChanges" ID="ConfirmationDialog.__previewChanges"></a> +<h4>ConfirmationDialog.__previewChanges</h4> +<b>__previewChanges</b>(<i></i>) +<p> + Private method to preview the changes. +</p><a NAME="ConfirmationDialog.on_buttonBox_clicked" ID="ConfirmationDialog.on_buttonBox_clicked"></a> +<h4>ConfirmationDialog.on_buttonBox_clicked</h4> +<b>on_buttonBox_clicked</b>(<i>button</i>) +<p> + Private slot to act on the button pressed. +</p><dl> +<dt><i>button</i></dt> +<dd> +reference to the button pressed (QAbstractButton) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.ExtractDialog.html Sun Jan 30 18:26:37 2011 +0100 @@ -0,0 +1,131 @@ +<?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.RefactoringRope.ExtractDialog</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.RefactoringRope.ExtractDialog</h1> +<p> +Module implementing the Extract dialog. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#ExtractDialog">ExtractDialog</a></td> +<td>Class implementing the Extract dialog.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="ExtractDialog" ID="ExtractDialog"></a> +<h2>ExtractDialog</h2> +<p> + Class implementing the Extract dialog. +</p> +<h3>Derived from</h3> +RefactoringDialogBase, Ui_ExtractDialog +<h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#ExtractDialog.__init__">ExtractDialog</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#ExtractDialog._calculateChanges">_calculateChanges</a></td> +<td>Protected method to calculate the changes.</td> +</tr><tr> +<td><a href="#ExtractDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> +<td>Private slot to act on the button pressed.</td> +</tr><tr> +<td><a href="#ExtractDialog.on_newNameEdit_textChanged">on_newNameEdit_textChanged</a></td> +<td>Private slot to react to changes of the new name.</td> +</tr> +</table> +<a NAME="ExtractDialog.__init__" ID="ExtractDialog.__init__"></a> +<h4>ExtractDialog (Constructor)</h4> +<b>ExtractDialog</b>(<i>refactoring, title, extractor, parent=None</i>) +<p> + Constructor +</p><dl> +<dt><i>refactoring</i></dt> +<dd> +reference to the main refactoring object + (Refactoring) +</dd><dt><i>title</i></dt> +<dd> +title of the dialog (string) +</dd><dt><i>extractor</i></dt> +<dd> +reference to the extractor object + (rope.refactor.extract.ExtractMethod or + rope.refactor.extract.ExtractVariable) +</dd><dt><i>parent</i></dt> +<dd> +reference to the parent widget (QWidget) +</dd> +</dl><a NAME="ExtractDialog._calculateChanges" ID="ExtractDialog._calculateChanges"></a> +<h4>ExtractDialog._calculateChanges</h4> +<b>_calculateChanges</b>(<i>handle</i>) +<p> + Protected method to calculate the changes. +</p><dl> +<dt><i>handle</i></dt> +<dd> +reference to the task handle + (rope.base.taskhandle.TaskHandle) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +reference to the Changes object (rope.base.change.ChangeSet) +</dd> +</dl><a NAME="ExtractDialog.on_buttonBox_clicked" ID="ExtractDialog.on_buttonBox_clicked"></a> +<h4>ExtractDialog.on_buttonBox_clicked</h4> +<b>on_buttonBox_clicked</b>(<i>button</i>) +<p> + Private slot to act on the button pressed. +</p><dl> +<dt><i>button</i></dt> +<dd> +reference to the button pressed (QAbstractButton) +</dd> +</dl><a NAME="ExtractDialog.on_newNameEdit_textChanged" ID="ExtractDialog.on_newNameEdit_textChanged"></a> +<h4>ExtractDialog.on_newNameEdit_textChanged</h4> +<b>on_newNameEdit_textChanged</b>(<i>text</i>) +<p> + Private slot to react to changes of the new name. +</p><dl> +<dt><i>text</i></dt> +<dd> +text entered into the edit (string) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.FileSystemCommands.html Sun Jan 30 18:26:37 2011 +0100 @@ -0,0 +1,145 @@ +<?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.RefactoringRope.FileSystemCommands</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.RefactoringRope.FileSystemCommands</h1> +<p> +Module implementing file system commands for rope. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#e5FileSystemCommands">e5FileSystemCommands</a></td> +<td>Class implementing file system commands for rope.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="e5FileSystemCommands" ID="e5FileSystemCommands"></a> +<h2>e5FileSystemCommands</h2> +<p> + Class implementing file system commands for rope. +</p> +<h3>Derived from</h3> +object +<h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#e5FileSystemCommands.__init__">e5FileSystemCommands</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#e5FileSystemCommands.create_file">create_file</a></td> +<td>Public method called by rope to create a new file.</td> +</tr><tr> +<td><a href="#e5FileSystemCommands.create_folder">create_folder</a></td> +<td>Public method called by rope to create a new directory.</td> +</tr><tr> +<td><a href="#e5FileSystemCommands.move">move</a></td> +<td>Public method called by rope to rename a file or directory.</td> +</tr><tr> +<td><a href="#e5FileSystemCommands.remove">remove</a></td> +<td>Public method called by rope to remove a file or directory.</td> +</tr><tr> +<td><a href="#e5FileSystemCommands.write">write</a></td> +<td>Public method called by rope to write data to a file.</td> +</tr> +</table> +<a NAME="e5FileSystemCommands.__init__" ID="e5FileSystemCommands.__init__"></a> +<h4>e5FileSystemCommands (Constructor)</h4> +<b>e5FileSystemCommands</b>(<i>project</i>) +<p> + Constructor +</p><dl> +<dt><i>project</i></dt> +<dd> +reference to the eric4 project object (Project.Project) +</dd> +</dl><a NAME="e5FileSystemCommands.create_file" ID="e5FileSystemCommands.create_file"></a> +<h4>e5FileSystemCommands.create_file</h4> +<b>create_file</b>(<i>path</i>) +<p> + Public method called by rope to create a new file. +</p><dl> +<dt><i>path</i></dt> +<dd> +new filename (string) +</dd> +</dl><a NAME="e5FileSystemCommands.create_folder" ID="e5FileSystemCommands.create_folder"></a> +<h4>e5FileSystemCommands.create_folder</h4> +<b>create_folder</b>(<i>path</i>) +<p> + Public method called by rope to create a new directory. +</p><dl> +<dt><i>path</i></dt> +<dd> +new directory (string) +</dd> +</dl><a NAME="e5FileSystemCommands.move" ID="e5FileSystemCommands.move"></a> +<h4>e5FileSystemCommands.move</h4> +<b>move</b>(<i>path, new_location</i>) +<p> + Public method called by rope to rename a file or directory. +</p><dl> +<dt><i>path</i></dt> +<dd> +old file/directory name (string) +</dd><dt><i>new_location</i></dt> +<dd> +new file/directory name (string) +</dd> +</dl><a NAME="e5FileSystemCommands.remove" ID="e5FileSystemCommands.remove"></a> +<h4>e5FileSystemCommands.remove</h4> +<b>remove</b>(<i>path</i>) +<p> + Public method called by rope to remove a file or directory. +</p><dl> +<dt><i>path</i></dt> +<dd> +name of file/directory to remove (string) +</dd> +</dl><a NAME="e5FileSystemCommands.write" ID="e5FileSystemCommands.write"></a> +<h4>e5FileSystemCommands.write</h4> +<b>write</b>(<i>path, data</i>) +<p> + Public method called by rope to write data to a file. +</p><dl> +<dt><i>path</i></dt> +<dd> +filename of file to write to (string) +</dd><dt><i>data</i></dt> +<dd> +dat to be written +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.GetterSetterDialog.html Sun Jan 30 18:26:37 2011 +0100 @@ -0,0 +1,104 @@ +<?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.RefactoringRope.GetterSetterDialog</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.RefactoringRope.GetterSetterDialog</h1> +<p> +Module implementing a dialog to create getter and setter method names. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#GetterSetterDialog">GetterSetterDialog</a></td> +<td>Class implementing a dialog to create getter and setter method names.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="GetterSetterDialog" ID="GetterSetterDialog"></a> +<h2>GetterSetterDialog</h2> +<p> + Class implementing a dialog to create getter and setter method names. +</p> +<h3>Derived from</h3> +QDialog, Ui_GetterSetterDialog +<h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#GetterSetterDialog.__init__">GetterSetterDialog</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#GetterSetterDialog.getData">getData</a></td> +<td>Public method to return the getter and setter method names.</td> +</tr><tr> +<td><a href="#GetterSetterDialog.on_typeCheckBox_toggled">on_typeCheckBox_toggled</a></td> +<td>Slot to react to changes of the type checkbox.</td> +</tr> +</table> +<a NAME="GetterSetterDialog.__init__" ID="GetterSetterDialog.__init__"></a> +<h4>GetterSetterDialog (Constructor)</h4> +<b>GetterSetterDialog</b>(<i>fieldName, parent=None</i>) +<p> + Constructor +</p><dl> +<dt><i>fieldName</i></dt> +<dd> +name of the field to create getter and setter + method names (string) +</dd><dt><i>parent</i></dt> +<dd> +parent widget of the dialog (QWidget) +</dd> +</dl><a NAME="GetterSetterDialog.getData" ID="GetterSetterDialog.getData"></a> +<h4>GetterSetterDialog.getData</h4> +<b>getData</b>(<i></i>) +<p> + Public method to return the getter and setter method names. +</p><dl> +<dt>Returns:</dt> +<dd> +tuple of two strings with getter and setter method names +</dd> +</dl><a NAME="GetterSetterDialog.on_typeCheckBox_toggled" ID="GetterSetterDialog.on_typeCheckBox_toggled"></a> +<h4>GetterSetterDialog.on_typeCheckBox_toggled</h4> +<b>on_typeCheckBox_toggled</b>(<i>checked</i>) +<p> + Slot to react to changes of the type checkbox. +</p><dl> +<dt><i>checked</i></dt> +<dd> +state of the checkbox (boolean) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.HelpDialog.html Sun Jan 30 18:26:37 2011 +0100 @@ -0,0 +1,128 @@ +<?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.RefactoringRope.HelpDialog</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.RefactoringRope.HelpDialog</h1> +<p> +Module implementing a dialog to show help about rope. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#HelpDialog">HelpDialog</a></td> +<td>Class implementing a dialog to show help about rope.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="HelpDialog" ID="HelpDialog"></a> +<h2>HelpDialog</h2> +<p> + Class implementing a dialog to show help about rope. +</p> +<h3>Derived from</h3> +QDialog, Ui_HelpDialog +<h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#HelpDialog.__init__">HelpDialog</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#HelpDialog.findNextPrev">findNextPrev</a></td> +<td>Public slot to find the next occurrence of a text.</td> +</tr><tr> +<td><a href="#HelpDialog.helpWidget">helpWidget</a></td> +<td>Public method to get a reference to the help widget.</td> +</tr><tr> +<td><a href="#HelpDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> +<td>Private slot called by a button of the button box clicked.</td> +</tr> +</table> +<a NAME="HelpDialog.__init__" ID="HelpDialog.__init__"></a> +<h4>HelpDialog (Constructor)</h4> +<b>HelpDialog</b>(<i>title, helpfile, parent = None</i>) +<p> + Constructor +</p><dl> +<dt><i>title</i></dt> +<dd> +window title (string) +</dd><dt><i>helpfile</i></dt> +<dd> +filename of the helpfile (string) +</dd><dt><i>parent</i></dt> +<dd> +reference to the parent widget (QWidget) +</dd> +</dl><a NAME="HelpDialog.findNextPrev" ID="HelpDialog.findNextPrev"></a> +<h4>HelpDialog.findNextPrev</h4> +<b>findNextPrev</b>(<i>txt, case, word, backwards</i>) +<p> + Public slot to find the next occurrence of a text. +</p><dl> +<dt><i>txt</i></dt> +<dd> +text to search for (string) +</dd><dt><i>case</i></dt> +<dd> +flag indicating a case sensitive search (boolean) +</dd><dt><i>word</i></dt> +<dd> +flag indicating a word based search (boolean) +</dd><dt><i>backwards</i></dt> +<dd> +flag indicating a backwards search (boolean) +</dd> +</dl><a NAME="HelpDialog.helpWidget" ID="HelpDialog.helpWidget"></a> +<h4>HelpDialog.helpWidget</h4> +<b>helpWidget</b>(<i></i>) +<p> + Public method to get a reference to the help widget. +</p><dl> +<dt>Returns:</dt> +<dd> +reference to the help widget (QTextEdit) +</dd> +</dl><a NAME="HelpDialog.on_buttonBox_clicked" ID="HelpDialog.on_buttonBox_clicked"></a> +<h4>HelpDialog.on_buttonBox_clicked</h4> +<b>on_buttonBox_clicked</b>(<i>button</i>) +<p> + Private slot called by a button of the button box clicked. +</p><dl> +<dt><i>button</i></dt> +<dd> +button that was clicked (QAbstractButton) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.HistoryDialog.html Sun Jan 30 18:26:37 2011 +0100 @@ -0,0 +1,109 @@ +<?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.RefactoringRope.HistoryDialog</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.RefactoringRope.HistoryDialog</h1> +<p> +Module implementing the History dialog. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#HistoryDialog">HistoryDialog</a></td> +<td>Class implementing the History dialog.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="HistoryDialog" ID="HistoryDialog"></a> +<h2>HistoryDialog</h2> +<p> + Class implementing the History dialog. +</p> +<h3>Derived from</h3> +PreviewDialogBase +<h3>Class Attributes</h3> +<table> +<tr><td>ChangeIDRole</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#HistoryDialog.__init__">HistoryDialog</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#HistoryDialog.accept">accept</a></td> +<td>Public slot to undo the selected set of changes.</td> +</tr><tr> +<td><a href="#HistoryDialog.on_changesList_currentItemChanged">on_changesList_currentItemChanged</a></td> +<td>Private slot called when a change is selected.</td> +</tr> +</table> +<a NAME="HistoryDialog.__init__" ID="HistoryDialog.__init__"></a> +<h4>HistoryDialog (Constructor)</h4> +<b>HistoryDialog</b>(<i>refactoring, changes, isUndo, parent = None</i>) +<p> + Constructor +</p><dl> +<dt><i>refactoring</i></dt> +<dd> +reference to the main refactoring object + (Refactoring) +</dd><dt><i>changes</i></dt> +<dd> +list of ChangeSet objects + (list of rope.base.change.ChangeSet) +</dd><dt><i>isUndo</i></dt> +<dd> +flag indicating an undo history dialog (boolean) +</dd><dt><i>parent</i></dt> +<dd> +reference to the parent widget (QWidget) +</dd> +</dl><a NAME="HistoryDialog.accept" ID="HistoryDialog.accept"></a> +<h4>HistoryDialog.accept</h4> +<b>accept</b>(<i></i>) +<p> + Public slot to undo the selected set of changes. +</p><a NAME="HistoryDialog.on_changesList_currentItemChanged" ID="HistoryDialog.on_changesList_currentItemChanged"></a> +<h4>HistoryDialog.on_changesList_currentItemChanged</h4> +<b>on_changesList_currentItemChanged</b>(<i>current, previous</i>) +<p> + Private slot called when a change is selected. +</p><dl> +<dt><i>current</i></dt> +<dd> +reference to the new current item (QListWidgetItem) +</dd><dt><i>previous</i></dt> +<dd> +reference to the old current item (QListWidgetItem) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.InlineArgumentDefaultDialog.html Sun Jan 30 18:26:37 2011 +0100 @@ -0,0 +1,146 @@ +<?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.RefactoringRope.InlineArgumentDefaultDialog</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.RefactoringRope.InlineArgumentDefaultDialog</h1> +<p> +Module implementing the Inline Argument Default dialog. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#InlineArgumentDefaultDialog">InlineArgumentDefaultDialog</a></td> +<td>Class implementing the Inline Argument Default dialog.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="InlineArgumentDefaultDialog" ID="InlineArgumentDefaultDialog"></a> +<h2>InlineArgumentDefaultDialog</h2> +<p> + Class implementing the Inline Argument Default dialog. +</p> +<h3>Derived from</h3> +RefactoringDialogBase, Ui_InlineArgumentDefaultDialog +<h3>Class Attributes</h3> +<table> +<tr><td>NameRole</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#InlineArgumentDefaultDialog.__init__">InlineArgumentDefaultDialog</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#InlineArgumentDefaultDialog.__getParameterIndex">__getParameterIndex</a></td> +<td>Private method to calculate the index of the given paramter.</td> +</tr><tr> +<td><a href="#InlineArgumentDefaultDialog._calculateChanges">_calculateChanges</a></td> +<td>Protected method to calculate the changes.</td> +</tr><tr> +<td><a href="#InlineArgumentDefaultDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> +<td>Private slot to act on the button pressed.</td> +</tr><tr> +<td><a href="#InlineArgumentDefaultDialog.on_parameterList_itemSelectionChanged">on_parameterList_itemSelectionChanged</a></td> +<td>Private slot called, when the selection changes.</td> +</tr> +</table> +<a NAME="InlineArgumentDefaultDialog.__init__" ID="InlineArgumentDefaultDialog.__init__"></a> +<h4>InlineArgumentDefaultDialog (Constructor)</h4> +<b>InlineArgumentDefaultDialog</b>(<i>refactoring, title, changer, parent=None</i>) +<p> + Constructor +</p><dl> +<dt><i>refactoring</i></dt> +<dd> +reference to the main refactoring object + (Refactoring) +</dd><dt><i>title</i></dt> +<dd> +title of the dialog (string) +</dd><dt><i>changer</i></dt> +<dd> +reference to the signature changer object + (rope.refactor.change_signature.ChangeSignature) +</dd><dt><i>parent</i></dt> +<dd> +reference to the parent widget (QWidget) +</dd> +</dl><a NAME="InlineArgumentDefaultDialog.__getParameterIndex" ID="InlineArgumentDefaultDialog.__getParameterIndex"></a> +<h4>InlineArgumentDefaultDialog.__getParameterIndex</h4> +<b>__getParameterIndex</b>(<i>definition_info, name</i>) +<p> + Private method to calculate the index of the given paramter. +</p><dl> +<dt><i>definition_info</i></dt> +<dd> +object containing the method definition +</dd><dt><i>name</i></dt> +<dd> +parameter name (string) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +index of the parameter (integer) +</dd> +</dl><a NAME="InlineArgumentDefaultDialog._calculateChanges" ID="InlineArgumentDefaultDialog._calculateChanges"></a> +<h4>InlineArgumentDefaultDialog._calculateChanges</h4> +<b>_calculateChanges</b>(<i>handle</i>) +<p> + Protected method to calculate the changes. +</p><dl> +<dt><i>handle</i></dt> +<dd> +reference to the task handle + (rope.base.taskhandle.TaskHandle) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +reference to the Changes object (rope.base.change.ChangeSet) +</dd> +</dl><a NAME="InlineArgumentDefaultDialog.on_buttonBox_clicked" ID="InlineArgumentDefaultDialog.on_buttonBox_clicked"></a> +<h4>InlineArgumentDefaultDialog.on_buttonBox_clicked</h4> +<b>on_buttonBox_clicked</b>(<i>button</i>) +<p> + Private slot to act on the button pressed. +</p><dl> +<dt><i>button</i></dt> +<dd> +reference to the button pressed (QAbstractButton) +</dd> +</dl><a NAME="InlineArgumentDefaultDialog.on_parameterList_itemSelectionChanged" ID="InlineArgumentDefaultDialog.on_parameterList_itemSelectionChanged"></a> +<h4>InlineArgumentDefaultDialog.on_parameterList_itemSelectionChanged</h4> +<b>on_parameterList_itemSelectionChanged</b>(<i></i>) +<p> + Private slot called, when the selection changes. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.InlineDialog.html Sun Jan 30 18:26:37 2011 +0100 @@ -0,0 +1,119 @@ +<?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.RefactoringRope.InlineDialog</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.RefactoringRope.InlineDialog</h1> +<p> +Module implementing the Inline dialog. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#InlineDialog">InlineDialog</a></td> +<td>Class implementing the Inline dialog.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="InlineDialog" ID="InlineDialog"></a> +<h2>InlineDialog</h2> +<p> + Class implementing the Inline dialog. +</p> +<h3>Derived from</h3> +RefactoringDialogBase, Ui_InlineDialog +<h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#InlineDialog.__init__">InlineDialog</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#InlineDialog._calculateChanges">_calculateChanges</a></td> +<td>Protected method to calculate the changes.</td> +</tr><tr> +<td><a href="#InlineDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> +<td>Private slot to act on the button pressed.</td> +</tr> +</table> +<a NAME="InlineDialog.__init__" ID="InlineDialog.__init__"></a> +<h4>InlineDialog (Constructor)</h4> +<b>InlineDialog</b>(<i>refactoring, title, inliner, parent = None</i>) +<p> + Constructor +</p><dl> +<dt><i>refactoring</i></dt> +<dd> +reference to the main refactoring object + (Refactoring) +</dd><dt><i>title</i></dt> +<dd> +title of the dialog (string) +</dd><dt><i>inliner</i></dt> +<dd> +reference to the inliner object + (rope.refactor.inline.InlineMethod, + rope.refactor.inline.InlineVariable + or rope.refactor.inline.InlineParameter) +</dd><dt><i>parent</i></dt> +<dd> +reference to the parent widget (QWidget) +</dd> +</dl><a NAME="InlineDialog._calculateChanges" ID="InlineDialog._calculateChanges"></a> +<h4>InlineDialog._calculateChanges</h4> +<b>_calculateChanges</b>(<i>handle</i>) +<p> + Protected method to calculate the changes. +</p><dl> +<dt><i>handle</i></dt> +<dd> +reference to the task handle + (rope.base.taskhandle.TaskHandle) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +reference to the Changes object (rope.base.change.ChangeSet) +</dd> +</dl><a NAME="InlineDialog.on_buttonBox_clicked" ID="InlineDialog.on_buttonBox_clicked"></a> +<h4>InlineDialog.on_buttonBox_clicked</h4> +<b>on_buttonBox_clicked</b>(<i>button</i>) +<p> + Private slot to act on the button pressed. +</p><dl> +<dt><i>button</i></dt> +<dd> +reference to the button pressed (QAbstractButton) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.IntroduceFactoryDialog.html Sun Jan 30 18:26:37 2011 +0100 @@ -0,0 +1,130 @@ +<?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.RefactoringRope.IntroduceFactoryDialog</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.RefactoringRope.IntroduceFactoryDialog</h1> +<p> +Module implementing the Introduce Factory dialog. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#IntroduceFactoryDialog">IntroduceFactoryDialog</a></td> +<td>Class implementing the Introduce Factory dialog.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="IntroduceFactoryDialog" ID="IntroduceFactoryDialog"></a> +<h2>IntroduceFactoryDialog</h2> +<p> + Class implementing the Introduce Factory dialog. +</p> +<h3>Derived from</h3> +RefactoringDialogBase, Ui_IntroduceFactoryDialog +<h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#IntroduceFactoryDialog.__init__">IntroduceFactoryDialog</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#IntroduceFactoryDialog._calculateChanges">_calculateChanges</a></td> +<td>Protected method to calculate the changes.</td> +</tr><tr> +<td><a href="#IntroduceFactoryDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> +<td>Private slot to act on the button pressed.</td> +</tr><tr> +<td><a href="#IntroduceFactoryDialog.on_nameEdit_textChanged">on_nameEdit_textChanged</a></td> +<td>Private slot to react to changes of the name.</td> +</tr> +</table> +<a NAME="IntroduceFactoryDialog.__init__" ID="IntroduceFactoryDialog.__init__"></a> +<h4>IntroduceFactoryDialog (Constructor)</h4> +<b>IntroduceFactoryDialog</b>(<i>refactoring, title, introducer, parent = None</i>) +<p> + Constructor +</p><dl> +<dt><i>refactoring</i></dt> +<dd> +reference to the main refactoring object + (Refactoring) +</dd><dt><i>title</i></dt> +<dd> +title of the dialog (string) +</dd><dt><i>introducer</i></dt> +<dd> +reference to the factory introducer object + (rope.refactor.introduce_factory.IntroduceFactoryRefactoring) +</dd><dt><i>parent</i></dt> +<dd> +reference to the parent widget (QWidget) +</dd> +</dl><a NAME="IntroduceFactoryDialog._calculateChanges" ID="IntroduceFactoryDialog._calculateChanges"></a> +<h4>IntroduceFactoryDialog._calculateChanges</h4> +<b>_calculateChanges</b>(<i>handle</i>) +<p> + Protected method to calculate the changes. +</p><dl> +<dt><i>handle</i></dt> +<dd> +reference to the task handle + (rope.base.taskhandle.TaskHandle) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +reference to the Changes object (rope.base.change.ChangeSet) +</dd> +</dl><a NAME="IntroduceFactoryDialog.on_buttonBox_clicked" ID="IntroduceFactoryDialog.on_buttonBox_clicked"></a> +<h4>IntroduceFactoryDialog.on_buttonBox_clicked</h4> +<b>on_buttonBox_clicked</b>(<i>button</i>) +<p> + Private slot to act on the button pressed. +</p><dl> +<dt><i>button</i></dt> +<dd> +reference to the button pressed (QAbstractButton) +</dd> +</dl><a NAME="IntroduceFactoryDialog.on_nameEdit_textChanged" ID="IntroduceFactoryDialog.on_nameEdit_textChanged"></a> +<h4>IntroduceFactoryDialog.on_nameEdit_textChanged</h4> +<b>on_nameEdit_textChanged</b>(<i>text</i>) +<p> + Private slot to react to changes of the name. +</p><dl> +<dt><i>text</i></dt> +<dd> +text entered into the edit (string) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.IntroduceParameterDialog.html Sun Jan 30 18:26:37 2011 +0100 @@ -0,0 +1,130 @@ +<?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.RefactoringRope.IntroduceParameterDialog</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.RefactoringRope.IntroduceParameterDialog</h1> +<p> +Module implementing the Introduce Parameter dialog. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#IntroduceParameterDialog">IntroduceParameterDialog</a></td> +<td>Class implementing the Introduce Parameter dialog.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="IntroduceParameterDialog" ID="IntroduceParameterDialog"></a> +<h2>IntroduceParameterDialog</h2> +<p> + Class implementing the Introduce Parameter dialog. +</p> +<h3>Derived from</h3> +RefactoringDialogBase, Ui_IntroduceParameterDialog +<h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#IntroduceParameterDialog.__init__">IntroduceParameterDialog</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#IntroduceParameterDialog._calculateChanges">_calculateChanges</a></td> +<td>Protected method to calculate the changes.</td> +</tr><tr> +<td><a href="#IntroduceParameterDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> +<td>Private slot to act on the button pressed.</td> +</tr><tr> +<td><a href="#IntroduceParameterDialog.on_nameEdit_textChanged">on_nameEdit_textChanged</a></td> +<td>Private slot to react to changes of the name.</td> +</tr> +</table> +<a NAME="IntroduceParameterDialog.__init__" ID="IntroduceParameterDialog.__init__"></a> +<h4>IntroduceParameterDialog (Constructor)</h4> +<b>IntroduceParameterDialog</b>(<i>refactoring, title, introducer, parent=None</i>) +<p> + Constructor +</p><dl> +<dt><i>refactoring</i></dt> +<dd> +reference to the main refactoring object + (Refactoring) +</dd><dt><i>title</i></dt> +<dd> +title of the dialog (string) +</dd><dt><i>introducer</i></dt> +<dd> +reference to the factory introducer object + (rope.refactor.introduce_parameter.IntroduceParameter) +</dd><dt><i>parent</i></dt> +<dd> +reference to the parent widget (QWidget) +</dd> +</dl><a NAME="IntroduceParameterDialog._calculateChanges" ID="IntroduceParameterDialog._calculateChanges"></a> +<h4>IntroduceParameterDialog._calculateChanges</h4> +<b>_calculateChanges</b>(<i>handle</i>) +<p> + Protected method to calculate the changes. +</p><dl> +<dt><i>handle</i></dt> +<dd> +reference to the task handle + (rope.base.taskhandle.TaskHandle) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +reference to the Changes object (rope.base.change.ChangeSet) +</dd> +</dl><a NAME="IntroduceParameterDialog.on_buttonBox_clicked" ID="IntroduceParameterDialog.on_buttonBox_clicked"></a> +<h4>IntroduceParameterDialog.on_buttonBox_clicked</h4> +<b>on_buttonBox_clicked</b>(<i>button</i>) +<p> + Private slot to act on the button pressed. +</p><dl> +<dt><i>button</i></dt> +<dd> +reference to the button pressed (QAbstractButton) +</dd> +</dl><a NAME="IntroduceParameterDialog.on_nameEdit_textChanged" ID="IntroduceParameterDialog.on_nameEdit_textChanged"></a> +<h4>IntroduceParameterDialog.on_nameEdit_textChanged</h4> +<b>on_nameEdit_textChanged</b>(<i>text</i>) +<p> + Private slot to react to changes of the name. +</p><dl> +<dt><i>text</i></dt> +<dd> +text entered into the edit (string) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.MatchesDialog.html Sun Jan 30 18:26:37 2011 +0100 @@ -0,0 +1,128 @@ +<?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.RefactoringRope.MatchesDialog</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.RefactoringRope.MatchesDialog</h1> +<p> +Module implementing a dialog to show matching references/definitions. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#MatchesDialog">MatchesDialog</a></td> +<td>Class implementing a dialog to show matching references/definitions.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="MatchesDialog" ID="MatchesDialog"></a> +<h2>MatchesDialog</h2> +<p> + Class implementing a dialog to show matching references/definitions. +</p> +<h3>Derived from</h3> +QDialog, Ui_MatchesDialog +<h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#MatchesDialog.__init__">MatchesDialog</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#MatchesDialog.__resizeColumns">__resizeColumns</a></td> +<td>Private method to resize the list columns.</td> +</tr><tr> +<td><a href="#MatchesDialog.__resort">__resort</a></td> +<td>Private method to resort the tree.</td> +</tr><tr> +<td><a href="#MatchesDialog.addEntry">addEntry</a></td> +<td>Public slot to add an entry to the list.</td> +</tr><tr> +<td><a href="#MatchesDialog.on_matchesList_itemActivated">on_matchesList_itemActivated</a></td> +<td>Private slot to handle the itemActivated signal of the list.</td> +</tr> +</table> +<a NAME="MatchesDialog.__init__" ID="MatchesDialog.__init__"></a> +<h4>MatchesDialog (Constructor)</h4> +<b>MatchesDialog</b>(<i>ui, showConfidence, parent = None, name = None</i>) +<p> + Constructor +</p><dl> +<dt><i>ui</i></dt> +<dd> +reference to the UI object +</dd><dt><i>showConfidence</i></dt> +<dd> +flag indicating the display of the + confidence column (boolean) +</dd><dt><i>parent</i></dt> +<dd> +parent of this dialog (QWidget) +</dd><dt><i>name</i></dt> +<dd> +name of this dialog (string) +</dd> +</dl><a NAME="MatchesDialog.__resizeColumns" ID="MatchesDialog.__resizeColumns"></a> +<h4>MatchesDialog.__resizeColumns</h4> +<b>__resizeColumns</b>(<i></i>) +<p> + Private method to resize the list columns. +</p><a NAME="MatchesDialog.__resort" ID="MatchesDialog.__resort"></a> +<h4>MatchesDialog.__resort</h4> +<b>__resort</b>(<i></i>) +<p> + Private method to resort the tree. +</p><a NAME="MatchesDialog.addEntry" ID="MatchesDialog.addEntry"></a> +<h4>MatchesDialog.addEntry</h4> +<b>addEntry</b>(<i>resource, lineno, unsure=False</i>) +<p> + Public slot to add an entry to the list. +</p><dl> +<dt><i>resource</i></dt> +<dd> +reference to the resource object + (rope.base.resources.Resource) +</dd><dt><i>lineno</i></dt> +<dd> +linenumber of the match (integer) +</dd><dt><i>unsure</i></dt> +<dd> +flag indicating an unsure match (boolean) +</dd> +</dl><a NAME="MatchesDialog.on_matchesList_itemActivated" ID="MatchesDialog.on_matchesList_itemActivated"></a> +<h4>MatchesDialog.on_matchesList_itemActivated</h4> +<b>on_matchesList_itemActivated</b>(<i>item, column</i>) +<p> + Private slot to handle the itemActivated signal of the list. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.MethodToMethodObjectDialog.html Sun Jan 30 18:26:37 2011 +0100 @@ -0,0 +1,130 @@ +<?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.RefactoringRope.MethodToMethodObjectDialog</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.RefactoringRope.MethodToMethodObjectDialog</h1> +<p> +Module implementing the Method To Method object dialog. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#MethodToMethodObjectDialog">MethodToMethodObjectDialog</a></td> +<td>Class implementing the Method To Method object dialog.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="MethodToMethodObjectDialog" ID="MethodToMethodObjectDialog"></a> +<h2>MethodToMethodObjectDialog</h2> +<p> + Class implementing the Method To Method object dialog. +</p> +<h3>Derived from</h3> +RefactoringDialogBase, Ui_MethodToMethodObjectDialog +<h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#MethodToMethodObjectDialog.__init__">MethodToMethodObjectDialog</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#MethodToMethodObjectDialog._calculateChanges">_calculateChanges</a></td> +<td>Protected method to calculate the changes.</td> +</tr><tr> +<td><a href="#MethodToMethodObjectDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> +<td>Private slot to act on the button pressed.</td> +</tr><tr> +<td><a href="#MethodToMethodObjectDialog.on_nameEdit_textChanged">on_nameEdit_textChanged</a></td> +<td>Private slot to react to changes of the name.</td> +</tr> +</table> +<a NAME="MethodToMethodObjectDialog.__init__" ID="MethodToMethodObjectDialog.__init__"></a> +<h4>MethodToMethodObjectDialog (Constructor)</h4> +<b>MethodToMethodObjectDialog</b>(<i>refactoring, title, converter, parent = None</i>) +<p> + Constructor +</p><dl> +<dt><i>refactoring</i></dt> +<dd> +reference to the main refactoring object + (Refactoring) +</dd><dt><i>title</i></dt> +<dd> +title of the dialog (string) +</dd><dt><i>converter</i></dt> +<dd> +reference to the converter object + (rope.refactor.method_object.MethodObject) +</dd><dt><i>parent</i></dt> +<dd> +reference to the parent widget (QWidget) +</dd> +</dl><a NAME="MethodToMethodObjectDialog._calculateChanges" ID="MethodToMethodObjectDialog._calculateChanges"></a> +<h4>MethodToMethodObjectDialog._calculateChanges</h4> +<b>_calculateChanges</b>(<i>handle</i>) +<p> + Protected method to calculate the changes. +</p><dl> +<dt><i>handle</i></dt> +<dd> +reference to the task handle + (rope.base.taskhandle.TaskHandle) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +reference to the Changes object (rope.base.change.ChangeSet) +</dd> +</dl><a NAME="MethodToMethodObjectDialog.on_buttonBox_clicked" ID="MethodToMethodObjectDialog.on_buttonBox_clicked"></a> +<h4>MethodToMethodObjectDialog.on_buttonBox_clicked</h4> +<b>on_buttonBox_clicked</b>(<i>button</i>) +<p> + Private slot to act on the button pressed. +</p><dl> +<dt><i>button</i></dt> +<dd> +reference to the button pressed (QAbstractButton) +</dd> +</dl><a NAME="MethodToMethodObjectDialog.on_nameEdit_textChanged" ID="MethodToMethodObjectDialog.on_nameEdit_textChanged"></a> +<h4>MethodToMethodObjectDialog.on_nameEdit_textChanged</h4> +<b>on_nameEdit_textChanged</b>(<i>text</i>) +<p> + Private slot to react to changes of the name. +</p><dl> +<dt><i>text</i></dt> +<dd> +text entered into the edit (QString) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.MoveMethodDialog.html Sun Jan 30 18:26:37 2011 +0100 @@ -0,0 +1,151 @@ +<?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.RefactoringRope.MoveMethodDialog</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.RefactoringRope.MoveMethodDialog</h1> +<p> +Module implementing the Move Method dialog. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#MoveMethodDialog">MoveMethodDialog</a></td> +<td>Class implementing the Move Method dialog.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="MoveMethodDialog" ID="MoveMethodDialog"></a> +<h2>MoveMethodDialog</h2> +<p> + Class implementing the Move Method dialog. +</p> +<h3>Derived from</h3> +RefactoringDialogBase, Ui_MoveMethodDialog +<h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#MoveMethodDialog.__init__">MoveMethodDialog</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#MoveMethodDialog.__updateUI">__updateUI</a></td> +<td>Private method to perform various UI updates.</td> +</tr><tr> +<td><a href="#MoveMethodDialog._calculateChanges">_calculateChanges</a></td> +<td>Protected method to calculate the changes.</td> +</tr><tr> +<td><a href="#MoveMethodDialog.on_attributeEdit_textChanged">on_attributeEdit_textChanged</a></td> +<td>Private slot to react to changes of the attribute.</td> +</tr><tr> +<td><a href="#MoveMethodDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> +<td>Private slot to act on the button pressed.</td> +</tr><tr> +<td><a href="#MoveMethodDialog.on_methodEdit_textChanged">on_methodEdit_textChanged</a></td> +<td>Private slot to react to changes of the attribute.</td> +</tr> +</table> +<a NAME="MoveMethodDialog.__init__" ID="MoveMethodDialog.__init__"></a> +<h4>MoveMethodDialog (Constructor)</h4> +<b>MoveMethodDialog</b>(<i>refactoring, title, mover, parent=None</i>) +<p> + Constructor +</p><dl> +<dt><i>refactoring</i></dt> +<dd> +reference to the main refactoring object + (Refactoring) +</dd><dt><i>title</i></dt> +<dd> +title of the dialog (string) +</dd><dt><i>mover</i></dt> +<dd> +reference to the mover object + (rope.refactor.move.MoveMethod) +</dd><dt><i>parent</i></dt> +<dd> +reference to the parent widget (QWidget) +</dd> +</dl><a NAME="MoveMethodDialog.__updateUI" ID="MoveMethodDialog.__updateUI"></a> +<h4>MoveMethodDialog.__updateUI</h4> +<b>__updateUI</b>(<i></i>) +<p> + Private method to perform various UI updates. +</p><a NAME="MoveMethodDialog._calculateChanges" ID="MoveMethodDialog._calculateChanges"></a> +<h4>MoveMethodDialog._calculateChanges</h4> +<b>_calculateChanges</b>(<i>handle</i>) +<p> + Protected method to calculate the changes. +</p><dl> +<dt><i>handle</i></dt> +<dd> +reference to the task handle + (rope.base.taskhandle.TaskHandle) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +reference to the Changes object (rope.base.change.ChangeSet) +</dd> +</dl><a NAME="MoveMethodDialog.on_attributeEdit_textChanged" ID="MoveMethodDialog.on_attributeEdit_textChanged"></a> +<h4>MoveMethodDialog.on_attributeEdit_textChanged</h4> +<b>on_attributeEdit_textChanged</b>(<i>text</i>) +<p> + Private slot to react to changes of the attribute. +</p><dl> +<dt><i>text</i></dt> +<dd> +text entered into the edit (string) +</dd> +</dl><a NAME="MoveMethodDialog.on_buttonBox_clicked" ID="MoveMethodDialog.on_buttonBox_clicked"></a> +<h4>MoveMethodDialog.on_buttonBox_clicked</h4> +<b>on_buttonBox_clicked</b>(<i>button</i>) +<p> + Private slot to act on the button pressed. +</p><dl> +<dt><i>button</i></dt> +<dd> +reference to the button pressed (QAbstractButton) +</dd> +</dl><a NAME="MoveMethodDialog.on_methodEdit_textChanged" ID="MoveMethodDialog.on_methodEdit_textChanged"></a> +<h4>MoveMethodDialog.on_methodEdit_textChanged</h4> +<b>on_methodEdit_textChanged</b>(<i>text</i>) +<p> + Private slot to react to changes of the attribute. +</p><dl> +<dt><i>text</i></dt> +<dd> +text entered into the edit (string) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.MoveModuleDialog.html Sun Jan 30 18:26:37 2011 +0100 @@ -0,0 +1,151 @@ +<?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.RefactoringRope.MoveModuleDialog</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.RefactoringRope.MoveModuleDialog</h1> +<p> +Module implementing the Move Module dialog. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#MoveModuleDialog">MoveModuleDialog</a></td> +<td>Class implementing the Move Module dialog.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="MoveModuleDialog" ID="MoveModuleDialog"></a> +<h2>MoveModuleDialog</h2> +<p> + Class implementing the Move Module dialog. +</p> +<h3>Derived from</h3> +RefactoringDialogBase, Ui_MoveModuleDialog +<h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#MoveModuleDialog.__init__">MoveModuleDialog</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#MoveModuleDialog.__checkDestination">__checkDestination</a></td> +<td>Private method to check the destination entered.</td> +</tr><tr> +<td><a href="#MoveModuleDialog._calculateChanges">_calculateChanges</a></td> +<td>Protected method to calculate the changes.</td> +</tr><tr> +<td><a href="#MoveModuleDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> +<td>Private slot to act on the button pressed.</td> +</tr><tr> +<td><a href="#MoveModuleDialog.on_destinationEdit_textChanged">on_destinationEdit_textChanged</a></td> +<td>Slot called, when the destinationEdit text is changed.</td> +</tr><tr> +<td><a href="#MoveModuleDialog.on_selectButton_clicked">on_selectButton_clicked</a></td> +<td>Slot called to select the destination via a file selection dialog.</td> +</tr> +</table> +<a NAME="MoveModuleDialog.__init__" ID="MoveModuleDialog.__init__"></a> +<h4>MoveModuleDialog (Constructor)</h4> +<b>MoveModuleDialog</b>(<i>refactoring, title, mover, parent=None</i>) +<p> + Constructor +</p><dl> +<dt><i>refactoring</i></dt> +<dd> +reference to the main refactoring object + (Refactoring) +</dd><dt><i>title</i></dt> +<dd> +title of the dialog (string) +</dd><dt><i>mover</i></dt> +<dd> +reference to the mover object + (rope.refactor.move.MoveMethod) +</dd><dt><i>parent</i></dt> +<dd> +reference to the parent widget (QWidget) +</dd> +</dl><a NAME="MoveModuleDialog.__checkDestination" ID="MoveModuleDialog.__checkDestination"></a> +<h4>MoveModuleDialog.__checkDestination</h4> +<b>__checkDestination</b>(<i></i>) +<p> + Private method to check the destination entered. +</p><dl> +<dt>Returns:</dt> +<dd> +flag indicating a valid entry (boolean) +</dd> +</dl><a NAME="MoveModuleDialog._calculateChanges" ID="MoveModuleDialog._calculateChanges"></a> +<h4>MoveModuleDialog._calculateChanges</h4> +<b>_calculateChanges</b>(<i>handle</i>) +<p> + Protected method to calculate the changes. +</p><dl> +<dt><i>handle</i></dt> +<dd> +reference to the task handle + (rope.base.taskhandle.TaskHandle) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +reference to the Changes object (rope.base.change.ChangeSet) +</dd> +</dl><a NAME="MoveModuleDialog.on_buttonBox_clicked" ID="MoveModuleDialog.on_buttonBox_clicked"></a> +<h4>MoveModuleDialog.on_buttonBox_clicked</h4> +<b>on_buttonBox_clicked</b>(<i>button</i>) +<p> + Private slot to act on the button pressed. +</p><dl> +<dt><i>button</i></dt> +<dd> +reference to the button pressed (QAbstractButton) +</dd> +</dl><a NAME="MoveModuleDialog.on_destinationEdit_textChanged" ID="MoveModuleDialog.on_destinationEdit_textChanged"></a> +<h4>MoveModuleDialog.on_destinationEdit_textChanged</h4> +<b>on_destinationEdit_textChanged</b>(<i>text</i>) +<p> + Slot called, when the destinationEdit text is changed. +</p><dl> +<dt><i>text</i></dt> +<dd> +text entered into the edit (string) +</dd> +</dl><a NAME="MoveModuleDialog.on_selectButton_clicked" ID="MoveModuleDialog.on_selectButton_clicked"></a> +<h4>MoveModuleDialog.on_selectButton_clicked</h4> +<b>on_selectButton_clicked</b>(<i></i>) +<p> + Slot called to select the destination via a file selection dialog. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.PreviewDialogBase.html Sun Jan 30 18:26:37 2011 +0100 @@ -0,0 +1,90 @@ +<?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.RefactoringRope.PreviewDialogBase</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.RefactoringRope.PreviewDialogBase</h1> +<p> +Module implementing a dialog base class to preview changes. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#PreviewDialogBase">PreviewDialogBase</a></td> +<td>Class implementing a dialog base class to preview changes.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="PreviewDialogBase" ID="PreviewDialogBase"></a> +<h2>PreviewDialogBase</h2> +<p> + Class implementing a dialog base class to preview changes. +</p> +<h3>Derived from</h3> +QDialog, Ui_PreviewDialog +<h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#PreviewDialogBase.__init__">PreviewDialogBase</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#PreviewDialogBase._appendText">_appendText</a></td> +<td>Restricted method to append text to the end of the contents pane.</td> +</tr> +</table> +<a NAME="PreviewDialogBase.__init__" ID="PreviewDialogBase.__init__"></a> +<h4>PreviewDialogBase (Constructor)</h4> +<b>PreviewDialogBase</b>(<i>parent = None</i>) +<p> + Constructor +</p><dl> +<dt><i>parent</i></dt> +<dd> +reference to the parent widget (QWidget) +</dd> +</dl><a NAME="PreviewDialogBase._appendText" ID="PreviewDialogBase._appendText"></a> +<h4>PreviewDialogBase._appendText</h4> +<b>_appendText</b>(<i>txt, format</i>) +<p> + Restricted method to append text to the end of the contents pane. +</p><dl> +<dt><i>txt</i></dt> +<dd> +text to insert (string) +</dd><dt><i>format</i></dt> +<dd> +text format to be used (QTextCharFormat) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.ProgressHandle.html Sun Jan 30 18:26:37 2011 +0100 @@ -0,0 +1,105 @@ +<?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.RefactoringRope.ProgressHandle</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.RefactoringRope.ProgressHandle</h1> +<p> +Module implementing a TaskHandle class with a progress dialog. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#ProgressHandle">ProgressHandle</a></td> +<td>Class implementing TaskHandle with a progress dialog.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="ProgressHandle" ID="ProgressHandle"></a> +<h2>ProgressHandle</h2> +<p> + Class implementing TaskHandle with a progress dialog. +</p> +<h3>Derived from</h3> +rope.base.taskhandle.TaskHandle +<h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#ProgressHandle.__init__">ProgressHandle</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#ProgressHandle.__updateProgress">__updateProgress</a></td> +<td>Private slot to handle the task progress.</td> +</tr><tr> +<td><a href="#ProgressHandle.reset">reset</a></td> +<td>Public slot to reset the progress dialog.</td> +</tr><tr> +<td><a href="#ProgressHandle.show">show</a></td> +<td>Public slot to show the progress dialog.</td> +</tr> +</table> +<a NAME="ProgressHandle.__init__" ID="ProgressHandle.__init__"></a> +<h4>ProgressHandle (Constructor)</h4> +<b>ProgressHandle</b>(<i>title, interruptable=True, parent=None</i>) +<p> + Constructor +</p><dl> +<dt><i>title</i></dt> +<dd> +title for the taskhandle (string) +</dd><dt><i>interruptable</i></dt> +<dd> +flag indicating, that the task may be + interrupted (boolean) +</dd><dt><i>parent</i></dt> +<dd> +reference to the parent widget (QWidget) +</dd> +</dl><a NAME="ProgressHandle.__updateProgress" ID="ProgressHandle.__updateProgress"></a> +<h4>ProgressHandle.__updateProgress</h4> +<b>__updateProgress</b>(<i></i>) +<p> + Private slot to handle the task progress. +</p><a NAME="ProgressHandle.reset" ID="ProgressHandle.reset"></a> +<h4>ProgressHandle.reset</h4> +<b>reset</b>(<i></i>) +<p> + Public slot to reset the progress dialog. +</p><a NAME="ProgressHandle.show" ID="ProgressHandle.show"></a> +<h4>ProgressHandle.show</h4> +<b>show</b>(<i></i>) +<p> + Public slot to show the progress dialog. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.Refactoring.html Sun Jan 30 18:26:37 2011 +0100 @@ -0,0 +1,722 @@ +<?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.RefactoringRope.Refactoring</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.RefactoringRope.Refactoring</h1> +<p> +Module implementing the refactoring interface to rope. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#Refactoring">Refactoring</a></td> +<td>Class implementing the refactoring interface to rope.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="Refactoring" ID="Refactoring"></a> +<h2>Refactoring</h2> +<p> + Class implementing the refactoring interface to rope. +</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="#Refactoring.__init__">Refactoring</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#Refactoring.__canRedo">__canRedo</a></td> +<td>Private slot to check, if there are changes to be redone.</td> +</tr><tr> +<td><a href="#Refactoring.__canRedoFile">__canRedoFile</a></td> +<td>Private slot to check, if there are redoable changes for a resource.</td> +</tr><tr> +<td><a href="#Refactoring.__canUndo">__canUndo</a></td> +<td>Private slot to check, if there are changes to be undone.</td> +</tr><tr> +<td><a href="#Refactoring.__canUndoFile">__canUndoFile</a></td> +<td>Private slot to check, if there are undoable changes for a resource.</td> +</tr><tr> +<td><a href="#Refactoring.__changeOccurrences">__changeOccurrences</a></td> +<td>Private slot to perform the Change Occurrences refactoring.</td> +</tr><tr> +<td><a href="#Refactoring.__changeSignature">__changeSignature</a></td> +<td>Private slot to change the signature of a method or function.</td> +</tr><tr> +<td><a href="#Refactoring.__clearHistory">__clearHistory</a></td> +<td>Private slot to clear the redo and undo lists.</td> +</tr><tr> +<td><a href="#Refactoring.__configChanged">__configChanged</a></td> +<td>Private slot called, when the rope config file has changed.</td> +</tr><tr> +<td><a href="#Refactoring.__convertLocalToAttribute">__convertLocalToAttribute</a></td> +<td>Private slot to convert a local variable to an attribute.</td> +</tr><tr> +<td><a href="#Refactoring.__defaultConfig">__defaultConfig</a></td> +<td>Private slot to return the contents of rope's default configuration.</td> +</tr><tr> +<td><a href="#Refactoring.__doExtract">__doExtract</a></td> +<td>Private method to perform the extract refactoring.</td> +</tr><tr> +<td><a href="#Refactoring.__doImports">__doImports</a></td> +<td>Private method to perform the various imports refactorings.</td> +</tr><tr> +<td><a href="#Refactoring.__doRename">__doRename</a></td> +<td>Private method to perform the various renaming refactorings.</td> +</tr><tr> +<td><a href="#Refactoring.__editConfig">__editConfig</a></td> +<td>Private slot to open the rope configuration file in an editor.</td> +</tr><tr> +<td><a href="#Refactoring.__encapsulateAttribute">__encapsulateAttribute</a></td> +<td>Private slot to encapsulate an attribute.</td> +</tr><tr> +<td><a href="#Refactoring.__extractLocalVariable">__extractLocalVariable</a></td> +<td>Private slot to handle the Extract Local Variable action.</td> +</tr><tr> +<td><a href="#Refactoring.__extractMethod">__extractMethod</a></td> +<td>Private slot to handle the Extract Method action.</td> +</tr><tr> +<td><a href="#Refactoring.__getFileRedoList">__getFileRedoList</a></td> +<td>Private slot to get a list of redoable changes.</td> +</tr><tr> +<td><a href="#Refactoring.__getFileUndoList">__getFileUndoList</a></td> +<td>Private slot to get a list of undoable changes.</td> +</tr><tr> +<td><a href="#Refactoring.__importsExpandStar">__importsExpandStar</a></td> +<td>Private slot to expand star imports.</td> +</tr><tr> +<td><a href="#Refactoring.__importsFromToImport">__importsFromToImport</a></td> +<td>Private slot to transform from imports to plain imports.</td> +</tr><tr> +<td><a href="#Refactoring.__importsHandleLong">__importsHandleLong</a></td> +<td>Private slot to handle long imports.</td> +</tr><tr> +<td><a href="#Refactoring.__importsOrganize">__importsOrganize</a></td> +<td>Private slot to organize imports.</td> +</tr><tr> +<td><a href="#Refactoring.__importsRelativeToAbsolute">__importsRelativeToAbsolute</a></td> +<td>Private slot to transform relative to absolute imports.</td> +</tr><tr> +<td><a href="#Refactoring.__inline">__inline</a></td> +<td>Private slot to handle the Inline Local Variable action.</td> +</tr><tr> +<td><a href="#Refactoring.__inlineArgumentDefault">__inlineArgumentDefault</a></td> +<td>Private slot to inline the default value of a parameter of a method or function.</td> +</tr><tr> +<td><a href="#Refactoring.__introduceFactoryMethod">__introduceFactoryMethod</a></td> +<td>Private slot to introduce a factory method or global function.</td> +</tr><tr> +<td><a href="#Refactoring.__introduceParameter">__introduceParameter</a></td> +<td>Private slot to introduce a parameter in a function.</td> +</tr><tr> +<td><a href="#Refactoring.__methodToMethodObject">__methodToMethodObject</a></td> +<td>Private slot to change the signature of a method or function.</td> +</tr><tr> +<td><a href="#Refactoring.__moveMethod">__moveMethod</a></td> +<td>Private slot to handle the Move Method action.</td> +</tr><tr> +<td><a href="#Refactoring.__moveModule">__moveModule</a></td> +<td>Private slot to handle the Move Current Module action.</td> +</tr><tr> +<td><a href="#Refactoring.__performSOA">__performSOA</a></td> +<td>Private slot to perform SOA on all modules.</td> +</tr><tr> +<td><a href="#Refactoring.__queryDefinition">__queryDefinition</a></td> +<td>Private slot to handle the Find Definition action</td> +</tr><tr> +<td><a href="#Refactoring.__queryImplementations">__queryImplementations</a></td> +<td>Private slot to handle the Find Implementations action.</td> +</tr><tr> +<td><a href="#Refactoring.__queryReferences">__queryReferences</a></td> +<td>Private slot to handle the Find References action.</td> +</tr><tr> +<td><a href="#Refactoring.__redo">__redo</a></td> +<td>Private slot to redo the last refactoring.</td> +</tr><tr> +<td><a href="#Refactoring.__rename">__rename</a></td> +<td>Private slot to handle the Rename action.</td> +</tr><tr> +<td><a href="#Refactoring.__renameLocal">__renameLocal</a></td> +<td>Private slot to handle the Local Rename action.</td> +</tr><tr> +<td><a href="#Refactoring.__renameModule">__renameModule</a></td> +<td>Private slot to handle the Rename Current Module action.</td> +</tr><tr> +<td><a href="#Refactoring.__restructure">__restructure</a></td> +<td>Private slot to restructure code.</td> +</tr><tr> +<td><a href="#Refactoring.__ropeConfigFile">__ropeConfigFile</a></td> +<td>Private method to get the name of the rope configuration file.</td> +</tr><tr> +<td><a href="#Refactoring.__ropeInfo">__ropeInfo</a></td> +<td>Private slot to show some info about rope.</td> +</tr><tr> +<td><a href="#Refactoring.__showFileRedoHistory">__showFileRedoHistory</a></td> +<td>Private method to show list of changes related to the current file available for a redo operation.</td> +</tr><tr> +<td><a href="#Refactoring.__showFileUndoHistory">__showFileUndoHistory</a></td> +<td>Private method to show list of changes related to the current file available for an undo operation.</td> +</tr><tr> +<td><a href="#Refactoring.__showProjectRedoHistory">__showProjectRedoHistory</a></td> +<td>Private method to show list of changes available for a redo operation.</td> +</tr><tr> +<td><a href="#Refactoring.__showProjectUndoHistory">__showProjectUndoHistory</a></td> +<td>Private method to show list of changes available for an undo operation.</td> +</tr><tr> +<td><a href="#Refactoring.__showRefactoringHistoryMenu">__showRefactoringHistoryMenu</a></td> +<td>Private slot called before the refactoring history menu is shown.</td> +</tr><tr> +<td><a href="#Refactoring.__showRefactoringMenu">__showRefactoringMenu</a></td> +<td>Private slot called before the refactoring menu is shown.</td> +</tr><tr> +<td><a href="#Refactoring.__showRopeHelp">__showRopeHelp</a></td> +<td>Private slot to show help about the refactorings offered by Rope.</td> +</tr><tr> +<td><a href="#Refactoring.__transformModuleToPackage">__transformModuleToPackage</a></td> +<td>Private slot to transform a module to a package.</td> +</tr><tr> +<td><a href="#Refactoring.__undo">__undo</a></td> +<td>Private slot to undo the last refactoring.</td> +</tr><tr> +<td><a href="#Refactoring.__updateConfig">__updateConfig</a></td> +<td>Private slot to update the configuration file.</td> +</tr><tr> +<td><a href="#Refactoring.__useFunction">__useFunction</a></td> +<td>Private slot to use a function wherever possible.</td> +</tr><tr> +<td><a href="#Refactoring.confirmAllBuffersSaved">confirmAllBuffersSaved</a></td> +<td>Private method to check, if any editor has unsaved changes.</td> +</tr><tr> +<td><a href="#Refactoring.confirmBufferIsSaved">confirmBufferIsSaved</a></td> +<td>Public method to check, if an editor has unsaved changes.</td> +</tr><tr> +<td><a href="#Refactoring.getActions">getActions</a></td> +<td>Public method to get a list of all actions.</td> +</tr><tr> +<td><a href="#Refactoring.getProject">getProject</a></td> +<td>Public method to get a reference to the rope project object.</td> +</tr><tr> +<td><a href="#Refactoring.handleRopeError">handleRopeError</a></td> +<td>Public slot to handle a rope error.</td> +</tr><tr> +<td><a href="#Refactoring.initActions">initActions</a></td> +<td>Public method to define the refactoring actions.</td> +</tr><tr> +<td><a href="#Refactoring.initMenu">initMenu</a></td> +<td>Public slot to initialize the refactoring menu.</td> +</tr><tr> +<td><a href="#Refactoring.projectClosed">projectClosed</a></td> +<td>Public slot to handle the projectClosed signal.</td> +</tr><tr> +<td><a href="#Refactoring.projectOpened">projectOpened</a></td> +<td>Public slot to handle the projectOpened signal.</td> +</tr><tr> +<td><a href="#Refactoring.refreshEditors">refreshEditors</a></td> +<td>Public method to refresh modified editors.</td> +</tr> +</table> +<a NAME="Refactoring.__init__" ID="Refactoring.__init__"></a> +<h4>Refactoring (Constructor)</h4> +<b>Refactoring</b>(<i>plugin, newStyle, parent=None</i>) +<p> + Constructor +</p><dl> +<dt><i>plugin</i></dt> +<dd> +reference to the plugin object +</dd><dt><i>newStyle</i></dt> +<dd> +flag indicating usage of new style signals (bool) +</dd><dt><i>parent</i></dt> +<dd> +parent (QObject) +</dd> +</dl><a NAME="Refactoring.__canRedo" ID="Refactoring.__canRedo"></a> +<h4>Refactoring.__canRedo</h4> +<b>__canRedo</b>(<i></i>) +<p> + Private slot to check, if there are changes to be redone. +</p><dl> +<dt>Returns:</dt> +<dd> +flag indicating, that redoable changes are available (boolean) +</dd> +</dl><a NAME="Refactoring.__canRedoFile" ID="Refactoring.__canRedoFile"></a> +<h4>Refactoring.__canRedoFile</h4> +<b>__canRedoFile</b>(<i>resource</i>) +<p> + Private slot to check, if there are redoable changes for a resource. +</p><dl> +<dt><i>resource</i></dt> +<dd> +file resource to check against + (rope.base.resources.File) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +flag indicating, that redoable changes are available (boolean) +</dd> +</dl><a NAME="Refactoring.__canUndo" ID="Refactoring.__canUndo"></a> +<h4>Refactoring.__canUndo</h4> +<b>__canUndo</b>(<i></i>) +<p> + Private slot to check, if there are changes to be undone. +</p><dl> +<dt>Returns:</dt> +<dd> +flag indicating, that undoable changes are available (boolean) +</dd> +</dl><a NAME="Refactoring.__canUndoFile" ID="Refactoring.__canUndoFile"></a> +<h4>Refactoring.__canUndoFile</h4> +<b>__canUndoFile</b>(<i>resource</i>) +<p> + Private slot to check, if there are undoable changes for a resource. +</p><dl> +<dt><i>resource</i></dt> +<dd> +file resource to check against + (rope.base.resources.File) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +flag indicating, that undoable changes are available (boolean) +</dd> +</dl><a NAME="Refactoring.__changeOccurrences" ID="Refactoring.__changeOccurrences"></a> +<h4>Refactoring.__changeOccurrences</h4> +<b>__changeOccurrences</b>(<i></i>) +<p> + Private slot to perform the Change Occurrences refactoring. +</p><a NAME="Refactoring.__changeSignature" ID="Refactoring.__changeSignature"></a> +<h4>Refactoring.__changeSignature</h4> +<b>__changeSignature</b>(<i></i>) +<p> + Private slot to change the signature of a method or function. +</p><a NAME="Refactoring.__clearHistory" ID="Refactoring.__clearHistory"></a> +<h4>Refactoring.__clearHistory</h4> +<b>__clearHistory</b>(<i></i>) +<p> + Private slot to clear the redo and undo lists. +</p><a NAME="Refactoring.__configChanged" ID="Refactoring.__configChanged"></a> +<h4>Refactoring.__configChanged</h4> +<b>__configChanged</b>(<i></i>) +<p> + Private slot called, when the rope config file has changed. +</p><a NAME="Refactoring.__convertLocalToAttribute" ID="Refactoring.__convertLocalToAttribute"></a> +<h4>Refactoring.__convertLocalToAttribute</h4> +<b>__convertLocalToAttribute</b>(<i></i>) +<p> + Private slot to convert a local variable to an attribute. +</p><a NAME="Refactoring.__defaultConfig" ID="Refactoring.__defaultConfig"></a> +<h4>Refactoring.__defaultConfig</h4> +<b>__defaultConfig</b>(<i></i>) +<p> + Private slot to return the contents of rope's default configuration. +</p><dl> +<dt>Returns:</dt> +<dd> +string containing the source of rope's default + configuration (string) +</dd> +</dl><a NAME="Refactoring.__doExtract" ID="Refactoring.__doExtract"></a> +<h4>Refactoring.__doExtract</h4> +<b>__doExtract</b>(<i>title, kind</i>) +<p> + Private method to perform the extract refactoring. +</p><dl> +<dt><i>title</i></dt> +<dd> +title of the refactoring (string) +</dd><dt><i>kind</i></dt> +<dd> +kind of extraction to be done (string, + "method" or "variable") +</dd> +</dl><a NAME="Refactoring.__doImports" ID="Refactoring.__doImports"></a> +<h4>Refactoring.__doImports</h4> +<b>__doImports</b>(<i>title, method</i>) +<p> + Private method to perform the various imports refactorings. +</p><a NAME="Refactoring.__doRename" ID="Refactoring.__doRename"></a> +<h4>Refactoring.__doRename</h4> +<b>__doRename</b>(<i>title, isLocal=False, renameModule=False</i>) +<p> + Private method to perform the various renaming refactorings. +</p><dl> +<dt><i>title</i></dt> +<dd> +title of the refactoring (string) +</dd><dt><i>isLocal</i></dt> +<dd> +flag indicating to restrict refactoring to + the local file (boolean) +</dd><dt><i>renameModule</i></dt> +<dd> +flag indicating a module rename refactoring + (boolean) +</dd> +</dl><a NAME="Refactoring.__editConfig" ID="Refactoring.__editConfig"></a> +<h4>Refactoring.__editConfig</h4> +<b>__editConfig</b>(<i></i>) +<p> + Private slot to open the rope configuration file in an editor. +</p><a NAME="Refactoring.__encapsulateAttribute" ID="Refactoring.__encapsulateAttribute"></a> +<h4>Refactoring.__encapsulateAttribute</h4> +<b>__encapsulateAttribute</b>(<i></i>) +<p> + Private slot to encapsulate an attribute. +</p><a NAME="Refactoring.__extractLocalVariable" ID="Refactoring.__extractLocalVariable"></a> +<h4>Refactoring.__extractLocalVariable</h4> +<b>__extractLocalVariable</b>(<i></i>) +<p> + Private slot to handle the Extract Local Variable action. +</p><a NAME="Refactoring.__extractMethod" ID="Refactoring.__extractMethod"></a> +<h4>Refactoring.__extractMethod</h4> +<b>__extractMethod</b>(<i></i>) +<p> + Private slot to handle the Extract Method action. +</p><a NAME="Refactoring.__getFileRedoList" ID="Refactoring.__getFileRedoList"></a> +<h4>Refactoring.__getFileRedoList</h4> +<b>__getFileRedoList</b>(<i>resource</i>) +<p> + Private slot to get a list of redoable changes. +</p><dl> +<dt><i>resource</i></dt> +<dd> +file resource to filter against + (rope.base.resources.File) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +list of change objects (list of rope.base.change.Change) +</dd> +</dl><a NAME="Refactoring.__getFileUndoList" ID="Refactoring.__getFileUndoList"></a> +<h4>Refactoring.__getFileUndoList</h4> +<b>__getFileUndoList</b>(<i>resource</i>) +<p> + Private slot to get a list of undoable changes. +</p><dl> +<dt><i>resource</i></dt> +<dd> +file resource to filter against + (rope.base.resources.File) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +list of change objects (list of rope.base.change.Change) +</dd> +</dl><a NAME="Refactoring.__importsExpandStar" ID="Refactoring.__importsExpandStar"></a> +<h4>Refactoring.__importsExpandStar</h4> +<b>__importsExpandStar</b>(<i></i>) +<p> + Private slot to expand star imports. +</p><a NAME="Refactoring.__importsFromToImport" ID="Refactoring.__importsFromToImport"></a> +<h4>Refactoring.__importsFromToImport</h4> +<b>__importsFromToImport</b>(<i></i>) +<p> + Private slot to transform from imports to plain imports. +</p><a NAME="Refactoring.__importsHandleLong" ID="Refactoring.__importsHandleLong"></a> +<h4>Refactoring.__importsHandleLong</h4> +<b>__importsHandleLong</b>(<i></i>) +<p> + Private slot to handle long imports. +</p><a NAME="Refactoring.__importsOrganize" ID="Refactoring.__importsOrganize"></a> +<h4>Refactoring.__importsOrganize</h4> +<b>__importsOrganize</b>(<i></i>) +<p> + Private slot to organize imports. +</p><a NAME="Refactoring.__importsRelativeToAbsolute" ID="Refactoring.__importsRelativeToAbsolute"></a> +<h4>Refactoring.__importsRelativeToAbsolute</h4> +<b>__importsRelativeToAbsolute</b>(<i></i>) +<p> + Private slot to transform relative to absolute imports. +</p><a NAME="Refactoring.__inline" ID="Refactoring.__inline"></a> +<h4>Refactoring.__inline</h4> +<b>__inline</b>(<i></i>) +<p> + Private slot to handle the Inline Local Variable action. +</p><a NAME="Refactoring.__inlineArgumentDefault" ID="Refactoring.__inlineArgumentDefault"></a> +<h4>Refactoring.__inlineArgumentDefault</h4> +<b>__inlineArgumentDefault</b>(<i></i>) +<p> + Private slot to inline the default value of a parameter of a + method or function. +</p><a NAME="Refactoring.__introduceFactoryMethod" ID="Refactoring.__introduceFactoryMethod"></a> +<h4>Refactoring.__introduceFactoryMethod</h4> +<b>__introduceFactoryMethod</b>(<i></i>) +<p> + Private slot to introduce a factory method or global function. +</p><a NAME="Refactoring.__introduceParameter" ID="Refactoring.__introduceParameter"></a> +<h4>Refactoring.__introduceParameter</h4> +<b>__introduceParameter</b>(<i></i>) +<p> + Private slot to introduce a parameter in a function. +</p><a NAME="Refactoring.__methodToMethodObject" ID="Refactoring.__methodToMethodObject"></a> +<h4>Refactoring.__methodToMethodObject</h4> +<b>__methodToMethodObject</b>(<i></i>) +<p> + Private slot to change the signature of a method or function. +</p><a NAME="Refactoring.__moveMethod" ID="Refactoring.__moveMethod"></a> +<h4>Refactoring.__moveMethod</h4> +<b>__moveMethod</b>(<i></i>) +<p> + Private slot to handle the Move Method action. +</p><a NAME="Refactoring.__moveModule" ID="Refactoring.__moveModule"></a> +<h4>Refactoring.__moveModule</h4> +<b>__moveModule</b>(<i></i>) +<p> + Private slot to handle the Move Current Module action. +</p><a NAME="Refactoring.__performSOA" ID="Refactoring.__performSOA"></a> +<h4>Refactoring.__performSOA</h4> +<b>__performSOA</b>(<i></i>) +<p> + Private slot to perform SOA on all modules. +</p><a NAME="Refactoring.__queryDefinition" ID="Refactoring.__queryDefinition"></a> +<h4>Refactoring.__queryDefinition</h4> +<b>__queryDefinition</b>(<i></i>) +<p> + Private slot to handle the Find Definition action +</p><a NAME="Refactoring.__queryImplementations" ID="Refactoring.__queryImplementations"></a> +<h4>Refactoring.__queryImplementations</h4> +<b>__queryImplementations</b>(<i></i>) +<p> + Private slot to handle the Find Implementations action. +</p><a NAME="Refactoring.__queryReferences" ID="Refactoring.__queryReferences"></a> +<h4>Refactoring.__queryReferences</h4> +<b>__queryReferences</b>(<i></i>) +<p> + Private slot to handle the Find References action. +</p><a NAME="Refactoring.__redo" ID="Refactoring.__redo"></a> +<h4>Refactoring.__redo</h4> +<b>__redo</b>(<i></i>) +<p> + Private slot to redo the last refactoring. +</p><a NAME="Refactoring.__rename" ID="Refactoring.__rename"></a> +<h4>Refactoring.__rename</h4> +<b>__rename</b>(<i></i>) +<p> + Private slot to handle the Rename action. +</p><a NAME="Refactoring.__renameLocal" ID="Refactoring.__renameLocal"></a> +<h4>Refactoring.__renameLocal</h4> +<b>__renameLocal</b>(<i></i>) +<p> + Private slot to handle the Local Rename action. +</p><a NAME="Refactoring.__renameModule" ID="Refactoring.__renameModule"></a> +<h4>Refactoring.__renameModule</h4> +<b>__renameModule</b>(<i></i>) +<p> + Private slot to handle the Rename Current Module action. +</p><a NAME="Refactoring.__restructure" ID="Refactoring.__restructure"></a> +<h4>Refactoring.__restructure</h4> +<b>__restructure</b>(<i></i>) +<p> + Private slot to restructure code. +</p><a NAME="Refactoring.__ropeConfigFile" ID="Refactoring.__ropeConfigFile"></a> +<h4>Refactoring.__ropeConfigFile</h4> +<b>__ropeConfigFile</b>(<i></i>) +<p> + Private method to get the name of the rope configuration file. +</p><dl> +<dt>Returns:</dt> +<dd> +name of the rope configuration file (string) +</dd> +</dl><a NAME="Refactoring.__ropeInfo" ID="Refactoring.__ropeInfo"></a> +<h4>Refactoring.__ropeInfo</h4> +<b>__ropeInfo</b>(<i></i>) +<p> + Private slot to show some info about rope. +</p><a NAME="Refactoring.__showFileRedoHistory" ID="Refactoring.__showFileRedoHistory"></a> +<h4>Refactoring.__showFileRedoHistory</h4> +<b>__showFileRedoHistory</b>(<i></i>) +<p> + Private method to show list of changes related to the current file + available for a redo operation. +</p><a NAME="Refactoring.__showFileUndoHistory" ID="Refactoring.__showFileUndoHistory"></a> +<h4>Refactoring.__showFileUndoHistory</h4> +<b>__showFileUndoHistory</b>(<i></i>) +<p> + Private method to show list of changes related to the current file + available for an undo operation. +</p><a NAME="Refactoring.__showProjectRedoHistory" ID="Refactoring.__showProjectRedoHistory"></a> +<h4>Refactoring.__showProjectRedoHistory</h4> +<b>__showProjectRedoHistory</b>(<i></i>) +<p> + Private method to show list of changes available for a redo operation. +</p><a NAME="Refactoring.__showProjectUndoHistory" ID="Refactoring.__showProjectUndoHistory"></a> +<h4>Refactoring.__showProjectUndoHistory</h4> +<b>__showProjectUndoHistory</b>(<i></i>) +<p> + Private method to show list of changes available for an undo operation. +</p><a NAME="Refactoring.__showRefactoringHistoryMenu" ID="Refactoring.__showRefactoringHistoryMenu"></a> +<h4>Refactoring.__showRefactoringHistoryMenu</h4> +<b>__showRefactoringHistoryMenu</b>(<i></i>) +<p> + Private slot called before the refactoring history menu is shown. +</p><a NAME="Refactoring.__showRefactoringMenu" ID="Refactoring.__showRefactoringMenu"></a> +<h4>Refactoring.__showRefactoringMenu</h4> +<b>__showRefactoringMenu</b>(<i></i>) +<p> + Private slot called before the refactoring menu is shown. +</p><a NAME="Refactoring.__showRopeHelp" ID="Refactoring.__showRopeHelp"></a> +<h4>Refactoring.__showRopeHelp</h4> +<b>__showRopeHelp</b>(<i></i>) +<p> + Private slot to show help about the refactorings offered by Rope. +</p><a NAME="Refactoring.__transformModuleToPackage" ID="Refactoring.__transformModuleToPackage"></a> +<h4>Refactoring.__transformModuleToPackage</h4> +<b>__transformModuleToPackage</b>(<i></i>) +<p> + Private slot to transform a module to a package. +</p><a NAME="Refactoring.__undo" ID="Refactoring.__undo"></a> +<h4>Refactoring.__undo</h4> +<b>__undo</b>(<i></i>) +<p> + Private slot to undo the last refactoring. +</p><a NAME="Refactoring.__updateConfig" ID="Refactoring.__updateConfig"></a> +<h4>Refactoring.__updateConfig</h4> +<b>__updateConfig</b>(<i></i>) +<p> + Private slot to update the configuration file. +</p><a NAME="Refactoring.__useFunction" ID="Refactoring.__useFunction"></a> +<h4>Refactoring.__useFunction</h4> +<b>__useFunction</b>(<i></i>) +<p> + Private slot to use a function wherever possible. +</p><a NAME="Refactoring.confirmAllBuffersSaved" ID="Refactoring.confirmAllBuffersSaved"></a> +<h4>Refactoring.confirmAllBuffersSaved</h4> +<b>confirmAllBuffersSaved</b>(<i></i>) +<p> + Private method to check, if any editor has unsaved changes. +</p><dl> +<dt>Returns:</dt> +<dd> +flag indicating, that no editor contains unsaved edits + (boolean) +</dd> +</dl><a NAME="Refactoring.confirmBufferIsSaved" ID="Refactoring.confirmBufferIsSaved"></a> +<h4>Refactoring.confirmBufferIsSaved</h4> +<b>confirmBufferIsSaved</b>(<i>editor</i>) +<p> + Public method to check, if an editor has unsaved changes. +</p><dl> +<dt><i>editor</i></dt> +<dd> +reference to the editor to be checked +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +flag indicating, that the editor doesn't contain + unsaved edits (boolean) +</dd> +</dl><a NAME="Refactoring.getActions" ID="Refactoring.getActions"></a> +<h4>Refactoring.getActions</h4> +<b>getActions</b>(<i></i>) +<p> + Public method to get a list of all actions. +</p><dl> +<dt>Returns:</dt> +<dd> +list of all actions (list of E5Action) +</dd> +</dl><a NAME="Refactoring.getProject" ID="Refactoring.getProject"></a> +<h4>Refactoring.getProject</h4> +<b>getProject</b>(<i></i>) +<p> + Public method to get a reference to the rope project object. +</p><dl> +<dt>Returns:</dt> +<dd> +reference to the rope project object (RopeProject) +</dd> +</dl><a NAME="Refactoring.handleRopeError" ID="Refactoring.handleRopeError"></a> +<h4>Refactoring.handleRopeError</h4> +<b>handleRopeError</b>(<i>err, title, handle=None</i>) +<p> + Public slot to handle a rope error. +</p><dl> +<dt><i>err</i></dt> +<dd> +rope exception object (Exception) +</dd><dt><i>title</i></dt> +<dd> +title to be displayed (string) +</dd><dt><i>handle</i></dt> +<dd> +reference to a taskhandle (ProgressHandle) +</dd> +</dl><a NAME="Refactoring.initActions" ID="Refactoring.initActions"></a> +<h4>Refactoring.initActions</h4> +<b>initActions</b>(<i></i>) +<p> + Public method to define the refactoring actions. +</p><a NAME="Refactoring.initMenu" ID="Refactoring.initMenu"></a> +<h4>Refactoring.initMenu</h4> +<b>initMenu</b>(<i></i>) +<p> + Public slot to initialize the refactoring menu. +</p><dl> +<dt>Returns:</dt> +<dd> +the menu generated (QMenu) +</dd> +</dl><a NAME="Refactoring.projectClosed" ID="Refactoring.projectClosed"></a> +<h4>Refactoring.projectClosed</h4> +<b>projectClosed</b>(<i></i>) +<p> + Public slot to handle the projectClosed signal. +</p><a NAME="Refactoring.projectOpened" ID="Refactoring.projectOpened"></a> +<h4>Refactoring.projectOpened</h4> +<b>projectOpened</b>(<i></i>) +<p> + Public slot to handle the projectOpened signal. +</p><a NAME="Refactoring.refreshEditors" ID="Refactoring.refreshEditors"></a> +<h4>Refactoring.refreshEditors</h4> +<b>refreshEditors</b>(<i>changes</i>) +<p> + Public method to refresh modified editors. +</p><dl> +<dt><i>reference</i></dt> +<dd> +to the Changes object (rope.base.change.ChangeSet) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.RefactoringDialogBase.html Sun Jan 30 18:26:37 2011 +0100 @@ -0,0 +1,148 @@ +<?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.RefactoringRope.RefactoringDialogBase</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.RefactoringRope.RefactoringDialogBase</h1> +<p> +Module implementing the Refactoring dialog base class. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#RefactoringDialogBase">RefactoringDialogBase</a></td> +<td>Class implementing the Refactoring dialog base class.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="RefactoringDialogBase" ID="RefactoringDialogBase"></a> +<h2>RefactoringDialogBase</h2> +<p> + Class implementing the Refactoring dialog base class. +</p> +<h3>Derived from</h3> +QDialog +<h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#RefactoringDialogBase.__init__">RefactoringDialogBase</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#RefactoringDialogBase.__createProgressHandle">__createProgressHandle</a></td> +<td>Private method to create a TaskHandle to update a progress dialog.</td> +</tr><tr> +<td><a href="#RefactoringDialogBase.__getChanges">__getChanges</a></td> +<td>Private method to build the Changes object.</td> +</tr><tr> +<td><a href="#RefactoringDialogBase._calculateChanges">_calculateChanges</a></td> +<td>Protected method to calculate the changes.</td> +</tr><tr> +<td><a href="#RefactoringDialogBase.applyChanges">applyChanges</a></td> +<td>Public method to apply the changes.</td> +</tr><tr> +<td><a href="#RefactoringDialogBase.previewChanges">previewChanges</a></td> +<td>Public method to preview the changes.</td> +</tr> +</table> +<a NAME="RefactoringDialogBase.__init__" ID="RefactoringDialogBase.__init__"></a> +<h4>RefactoringDialogBase (Constructor)</h4> +<b>RefactoringDialogBase</b>(<i>refactoring, title, parent=None</i>) +<p> + Constructor +</p><dl> +<dt><i>refactoring</i></dt> +<dd> +reference to the main refactoring object + (Refactoring) +</dd><dt><i>title</i></dt> +<dd> +title of the dialog (string) +</dd><dt><i>parent</i></dt> +<dd> +reference to the parent widget (QWidget) +</dd> +</dl><a NAME="RefactoringDialogBase.__createProgressHandle" ID="RefactoringDialogBase.__createProgressHandle"></a> +<h4>RefactoringDialogBase.__createProgressHandle</h4> +<b>__createProgressHandle</b>(<i>interruptable=True</i>) +<p> + Private method to create a TaskHandle to update a progress dialog. +</p><dl> +<dt><i>interruptable</i></dt> +<dd> +flag indicating, that the task may be + interrupted (boolean) +</dd> +</dl><a NAME="RefactoringDialogBase.__getChanges" ID="RefactoringDialogBase.__getChanges"></a> +<h4>RefactoringDialogBase.__getChanges</h4> +<b>__getChanges</b>(<i></i>) +<p> + Private method to build the Changes object. +</p><dl> +<dt>Returns:</dt> +<dd> +reference to the Changes object (rope.base.change.ChangeSet) +</dd> +</dl><a NAME="RefactoringDialogBase._calculateChanges" ID="RefactoringDialogBase._calculateChanges"></a> +<h4>RefactoringDialogBase._calculateChanges</h4> +<b>_calculateChanges</b>(<i>handle</i>) +<p> + Protected method to calculate the changes. +</p><dl> +<dt><i>handle</i></dt> +<dd> +reference to the task handle + (rope.base.taskhandle.TaskHandle) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +reference to the Changes object (rope.base.change.ChangeSet) +</dd> +</dl><a NAME="RefactoringDialogBase.applyChanges" ID="RefactoringDialogBase.applyChanges"></a> +<h4>RefactoringDialogBase.applyChanges</h4> +<b>applyChanges</b>(<i>changes = None</i>) +<p> + Public method to apply the changes. +</p><dl> +<dt><i>reference</i></dt> +<dd> +to the Changes object (rope.base.change.ChangeSet) +</dd> +</dl><a NAME="RefactoringDialogBase.previewChanges" ID="RefactoringDialogBase.previewChanges"></a> +<h4>RefactoringDialogBase.previewChanges</h4> +<b>previewChanges</b>(<i></i>) +<p> + Public method to preview the changes. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.RenameDialog.html Sun Jan 30 18:26:37 2011 +0100 @@ -0,0 +1,153 @@ +<?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.RefactoringRope.RenameDialog</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.RefactoringRope.RenameDialog</h1> +<p> +Module implementing the Rename dialog. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#RenameDialog">RenameDialog</a></td> +<td>Class implementing the Rename dialog.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="RenameDialog" ID="RenameDialog"></a> +<h2>RenameDialog</h2> +<p> + Class implementing the Rename dialog. +</p> +<h3>Derived from</h3> +RefactoringDialogBase, Ui_RenameDialog +<h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#RenameDialog.__init__">RenameDialog</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#RenameDialog.__confirmUnsure">__confirmUnsure</a></td> +<td>Private method to confirm unsure occurrences.</td> +</tr><tr> +<td><a href="#RenameDialog._calculateChanges">_calculateChanges</a></td> +<td>Protected method to calculate the changes.</td> +</tr><tr> +<td><a href="#RenameDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> +<td>Private slot to act on the button pressed.</td> +</tr><tr> +<td><a href="#RenameDialog.on_newNameEdit_textChanged">on_newNameEdit_textChanged</a></td> +<td>Private slot to react to changes of the new name.</td> +</tr> +</table> +<a NAME="RenameDialog.__init__" ID="RenameDialog.__init__"></a> +<h4>RenameDialog (Constructor)</h4> +<b>RenameDialog</b>(<i>refactoring, title, renamer, resource=None, parent=None</i>) +<p> + Constructor +</p><dl> +<dt><i>refactoring</i></dt> +<dd> +reference to the main refactoring object + (Refactoring) +</dd><dt><i>title</i></dt> +<dd> +title of the dialog (string) +</dd><dt><i>renamer</i></dt> +<dd> +reference to the renamer object + (rope.refactor.rename.Rename) +</dd><dt><i>resource</i></dt> +<dd> +reference to a resource object, if the action is to + be applied to the local file only (rope.base.resources.File) +</dd><dt><i>parent</i></dt> +<dd> +reference to the parent widget (QWidget) +</dd> +</dl><a NAME="RenameDialog.__confirmUnsure" ID="RenameDialog.__confirmUnsure"></a> +<h4>RenameDialog.__confirmUnsure</h4> +<b>__confirmUnsure</b>(<i>occurrence</i>) +<p> + Private method to confirm unsure occurrences. +</p><dl> +<dt><i>occurrence</i></dt> +<dd> +reference to the occurrence object + (rope.refactor.occurrences.Occurrence) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +flag indicating an occurrence (boolean) +</dd> +</dl><a NAME="RenameDialog._calculateChanges" ID="RenameDialog._calculateChanges"></a> +<h4>RenameDialog._calculateChanges</h4> +<b>_calculateChanges</b>(<i>handle</i>) +<p> + Protected method to calculate the changes. +</p><dl> +<dt><i>handle</i></dt> +<dd> +reference to the task handle + (rope.base.taskhandle.TaskHandle) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +reference to the Changes object (rope.base.change.ChangeSet) +</dd> +</dl><a NAME="RenameDialog.on_buttonBox_clicked" ID="RenameDialog.on_buttonBox_clicked"></a> +<h4>RenameDialog.on_buttonBox_clicked</h4> +<b>on_buttonBox_clicked</b>(<i>button</i>) +<p> + Private slot to act on the button pressed. +</p><dl> +<dt><i>button</i></dt> +<dd> +reference to the button pressed (QAbstractButton) +</dd> +</dl><a NAME="RenameDialog.on_newNameEdit_textChanged" ID="RenameDialog.on_newNameEdit_textChanged"></a> +<h4>RenameDialog.on_newNameEdit_textChanged</h4> +<b>on_newNameEdit_textChanged</b>(<i>text</i>) +<p> + Private slot to react to changes of the new name. +</p><dl> +<dt><i>text</i></dt> +<dd> +text entered into the edit (string) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.RestructureDialog.html Sun Jan 30 18:26:37 2011 +0100 @@ -0,0 +1,153 @@ +<?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.RefactoringRope.RestructureDialog</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.RefactoringRope.RestructureDialog</h1> +<p> +Module implementing the Restructure dialog. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#RestructureDialog">RestructureDialog</a></td> +<td>Class implementing the Restructure dialog.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="RestructureDialog" ID="RestructureDialog"></a> +<h2>RestructureDialog</h2> +<p> + Class implementing the Restructure dialog. +</p> +<h3>Derived from</h3> +RefactoringDialogBase, Ui_RestructureDialog +<h3>Class Attributes</h3> +<table> +<tr><td>history</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#RestructureDialog.__init__">RestructureDialog</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#RestructureDialog.__loadData">__loadData</a></td> +<td>Private slot to load the history data into the dialog.</td> +</tr><tr> +<td><a href="#RestructureDialog.__saveData">__saveData</a></td> +<td>Private slot to save the data for later reuse.</td> +</tr><tr> +<td><a href="#RestructureDialog.__updateUI">__updateUI</a></td> +<td>Private slot to update the UI.</td> +</tr><tr> +<td><a href="#RestructureDialog._calculateChanges">_calculateChanges</a></td> +<td>Protected method to calculate the changes.</td> +</tr><tr> +<td><a href="#RestructureDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> +<td>Private slot to act on the button pressed.</td> +</tr><tr> +<td><a href="#RestructureDialog.on_goalEdit_textChanged">on_goalEdit_textChanged</a></td> +<td>Private slot to react to changes of the goal.</td> +</tr><tr> +<td><a href="#RestructureDialog.on_patternEdit_textChanged">on_patternEdit_textChanged</a></td> +<td>Private slot to react to changes of the pattern.</td> +</tr> +</table> +<a NAME="RestructureDialog.__init__" ID="RestructureDialog.__init__"></a> +<h4>RestructureDialog (Constructor)</h4> +<b>RestructureDialog</b>(<i>refactoring, title, parent = None</i>) +<p> + Constructor +</p><dl> +<dt><i>refactoring</i></dt> +<dd> +reference to the main refactoring object + (Refactoring) +</dd><dt><i>title</i></dt> +<dd> +title of the dialog (string) +</dd><dt><i>parent</i></dt> +<dd> +reference to the parent widget (QWidget) +</dd> +</dl><a NAME="RestructureDialog.__loadData" ID="RestructureDialog.__loadData"></a> +<h4>RestructureDialog.__loadData</h4> +<b>__loadData</b>(<i></i>) +<p> + Private slot to load the history data into the dialog. +</p><a NAME="RestructureDialog.__saveData" ID="RestructureDialog.__saveData"></a> +<h4>RestructureDialog.__saveData</h4> +<b>__saveData</b>(<i></i>) +<p> + Private slot to save the data for later reuse. +</p><a NAME="RestructureDialog.__updateUI" ID="RestructureDialog.__updateUI"></a> +<h4>RestructureDialog.__updateUI</h4> +<b>__updateUI</b>(<i></i>) +<p> + Private slot to update the UI. +</p><a NAME="RestructureDialog._calculateChanges" ID="RestructureDialog._calculateChanges"></a> +<h4>RestructureDialog._calculateChanges</h4> +<b>_calculateChanges</b>(<i>handle</i>) +<p> + Protected method to calculate the changes. +</p><dl> +<dt><i>handle</i></dt> +<dd> +reference to the task handle + (rope.base.taskhandle.TaskHandle) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +reference to the Changes object (rope.base.change.ChangeSet) +</dd> +</dl><a NAME="RestructureDialog.on_buttonBox_clicked" ID="RestructureDialog.on_buttonBox_clicked"></a> +<h4>RestructureDialog.on_buttonBox_clicked</h4> +<b>on_buttonBox_clicked</b>(<i>button</i>) +<p> + Private slot to act on the button pressed. +</p><dl> +<dt><i>button</i></dt> +<dd> +reference to the button pressed (QAbstractButton) +</dd> +</dl><a NAME="RestructureDialog.on_goalEdit_textChanged" ID="RestructureDialog.on_goalEdit_textChanged"></a> +<h4>RestructureDialog.on_goalEdit_textChanged</h4> +<b>on_goalEdit_textChanged</b>(<i></i>) +<p> + Private slot to react to changes of the goal. +</p><a NAME="RestructureDialog.on_patternEdit_textChanged" ID="RestructureDialog.on_patternEdit_textChanged"></a> +<h4>RestructureDialog.on_patternEdit_textChanged</h4> +<b>on_patternEdit_textChanged</b>(<i></i>) +<p> + Private slot to react to changes of the pattern. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.SearchDialog.html Sun Jan 30 18:26:37 2011 +0100 @@ -0,0 +1,146 @@ +<?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.RefactoringRope.SearchDialog</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.RefactoringRope.SearchDialog</h1> +<p> +Module implementing the search dialog for the rope help dialog. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#SearchDialog">SearchDialog</a></td> +<td>Module implementing the search dialog for the rope help dialog.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="SearchDialog" ID="SearchDialog"></a> +<h2>SearchDialog</h2> +<p> + Module implementing the search dialog for the rope help dialog. +</p> +<h3>Derived from</h3> +QDialog, Ui_SearchDialog +<h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#SearchDialog.__init__">SearchDialog</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#SearchDialog.__findNextPrev">__findNextPrev</a></td> +<td>Private slot to find the next occurrence of text.</td> +</tr><tr> +<td><a href="#SearchDialog.findNext">findNext</a></td> +<td>Public slot to find the next occurrence.</td> +</tr><tr> +<td><a href="#SearchDialog.findPrevious">findPrevious</a></td> +<td>Public slot to find the previous occurrence.</td> +</tr><tr> +<td><a href="#SearchDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> +<td>Private slot called by a button of the button box clicked.</td> +</tr><tr> +<td><a href="#SearchDialog.on_findButton_clicked">on_findButton_clicked</a></td> +<td>Private slot to find the entered text in the displayed page.</td> +</tr><tr> +<td><a href="#SearchDialog.on_findtextCombo_editTextChanged">on_findtextCombo_editTextChanged</a></td> +<td>Private slot to enable/disable the find buttons.</td> +</tr><tr> +<td><a href="#SearchDialog.showFind">showFind</a></td> +<td>Public method to display this dialog.</td> +</tr> +</table> +<a NAME="SearchDialog.__init__" ID="SearchDialog.__init__"></a> +<h4>SearchDialog (Constructor)</h4> +<b>SearchDialog</b>(<i>parent = None, name = "", fl = Qt.WindowFlags(Qt.Widget)</i>) +<p> + Constructor +</p><dl> +<dt><i>parent</i></dt> +<dd> +parent widget of this dialog (QWidget) +</dd><dt><i>name</i></dt> +<dd> +object name of the dialog (string) +</dd><dt><i>fl</i></dt> +<dd> +window flags +</dd> +</dl><a NAME="SearchDialog.__findNextPrev" ID="SearchDialog.__findNextPrev"></a> +<h4>SearchDialog.__findNextPrev</h4> +<b>__findNextPrev</b>(<i>backwards</i>) +<p> + Private slot to find the next occurrence of text. +</p><dl> +<dt><i>backwards</i></dt> +<dd> +flag indicating a backwards search (boolean) +</dd> +</dl><a NAME="SearchDialog.findNext" ID="SearchDialog.findNext"></a> +<h4>SearchDialog.findNext</h4> +<b>findNext</b>(<i></i>) +<p> + Public slot to find the next occurrence. +</p><a NAME="SearchDialog.findPrevious" ID="SearchDialog.findPrevious"></a> +<h4>SearchDialog.findPrevious</h4> +<b>findPrevious</b>(<i></i>) +<p> + Public slot to find the previous occurrence. +</p><a NAME="SearchDialog.on_buttonBox_clicked" ID="SearchDialog.on_buttonBox_clicked"></a> +<h4>SearchDialog.on_buttonBox_clicked</h4> +<b>on_buttonBox_clicked</b>(<i>button</i>) +<p> + Private slot called by a button of the button box clicked. +</p><dl> +<dt><i>button</i></dt> +<dd> +button that was clicked (QAbstractButton) +</dd> +</dl><a NAME="SearchDialog.on_findButton_clicked" ID="SearchDialog.on_findButton_clicked"></a> +<h4>SearchDialog.on_findButton_clicked</h4> +<b>on_findButton_clicked</b>(<i></i>) +<p> + Private slot to find the entered text in the displayed page. +</p><a NAME="SearchDialog.on_findtextCombo_editTextChanged" ID="SearchDialog.on_findtextCombo_editTextChanged"></a> +<h4>SearchDialog.on_findtextCombo_editTextChanged</h4> +<b>on_findtextCombo_editTextChanged</b>(<i>txt</i>) +<p> + Private slot to enable/disable the find buttons. +</p><a NAME="SearchDialog.showFind" ID="SearchDialog.showFind"></a> +<h4>SearchDialog.showFind</h4> +<b>showFind</b>(<i></i>) +<p> + Public method to display this dialog. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.UseFunctionDialog.html Sun Jan 30 18:26:37 2011 +0100 @@ -0,0 +1,117 @@ +<?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.RefactoringRope.UseFunctionDialog</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.RefactoringRope.UseFunctionDialog</h1> +<p> +Module implementing the Inline dialog. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#UseFunctionDialog">UseFunctionDialog</a></td> +<td>Class implementing the Inline dialog.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="UseFunctionDialog" ID="UseFunctionDialog"></a> +<h2>UseFunctionDialog</h2> +<p> + Class implementing the Inline dialog. +</p> +<h3>Derived from</h3> +RefactoringDialogBase, Ui_UseFunctionDialog +<h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#UseFunctionDialog.__init__">UseFunctionDialog</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#UseFunctionDialog._calculateChanges">_calculateChanges</a></td> +<td>Protected method to calculate the changes.</td> +</tr><tr> +<td><a href="#UseFunctionDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> +<td>Private slot to act on the button pressed.</td> +</tr> +</table> +<a NAME="UseFunctionDialog.__init__" ID="UseFunctionDialog.__init__"></a> +<h4>UseFunctionDialog (Constructor)</h4> +<b>UseFunctionDialog</b>(<i>refactoring, title, user, parent=None</i>) +<p> + Constructor +</p><dl> +<dt><i>refactoring</i></dt> +<dd> +reference to the main refactoring object + (Refactoring) +</dd><dt><i>title</i></dt> +<dd> +title of the dialog (string) +</dd><dt><i>user</i></dt> +<dd> +reference to the usefunction object + (rope.refactor.usefunction.UseFunction) +</dd><dt><i>parent</i></dt> +<dd> +reference to the parent widget (QWidget) +</dd> +</dl><a NAME="UseFunctionDialog._calculateChanges" ID="UseFunctionDialog._calculateChanges"></a> +<h4>UseFunctionDialog._calculateChanges</h4> +<b>_calculateChanges</b>(<i>handle</i>) +<p> + Protected method to calculate the changes. +</p><dl> +<dt><i>handle</i></dt> +<dd> +reference to the task handle + (rope.base.taskhandle.TaskHandle) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +reference to the Changes object (rope.base.change.ChangeSet) +</dd> +</dl><a NAME="UseFunctionDialog.on_buttonBox_clicked" ID="UseFunctionDialog.on_buttonBox_clicked"></a> +<h4>UseFunctionDialog.on_buttonBox_clicked</h4> +<b>on_buttonBox_clicked</b>(<i>button</i>) +<p> + Private slot to act on the button pressed. +</p><dl> +<dt><i>button</i></dt> +<dd> +reference to the button pressed (QAbstractButton) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/RefactoringRope/Documentation/source/index-Plugin_Refactoring_Rope.RefactoringRope.html Sun Jan 30 18:26:37 2011 +0100 @@ -0,0 +1,115 @@ +<?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.RefactoringRope</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> +<h1>Plugin_Refactoring_Rope.RefactoringRope</h1> +<p> +Package implementing the rope refactoring interface module for eric5. +</p><p> +This package implements just the interface for the eric5 IDE. The +refactoring is done using the rope refactoring library +(<a href="http://rope.sourceforge.net">http://rope.sourceforge.net</a>). +</p> + + +<h3>Modules</h3> +<table> +<tr> +<td><a href="Plugin_Refactoring_Rope.RefactoringRope.AddParameterDialog.html">AddParameterDialog</a></td> +<td>Module implementing the Add New Parameter dialog.</td> +</tr><tr> +<td><a href="Plugin_Refactoring_Rope.RefactoringRope.ChangeOccurrencesDialog.html">ChangeOccurrencesDialog</a></td> +<td>Module implementing the Change Occurrences dialog.</td> +</tr><tr> +<td><a href="Plugin_Refactoring_Rope.RefactoringRope.ChangeSignatureDialog.html">ChangeSignatureDialog</a></td> +<td>Module implementing the Change Signature dialog.</td> +</tr><tr> +<td><a href="Plugin_Refactoring_Rope.RefactoringRope.ChangesPreviewDialog.html">ChangesPreviewDialog</a></td> +<td>Module implementing the Changes preview dialog.</td> +</tr><tr> +<td><a href="Plugin_Refactoring_Rope.RefactoringRope.ConfirmationDialog.html">ConfirmationDialog</a></td> +<td>Module implementing the Confirmation dialog.</td> +</tr><tr> +<td><a href="Plugin_Refactoring_Rope.RefactoringRope.ExtractDialog.html">ExtractDialog</a></td> +<td>Module implementing the Extract dialog.</td> +</tr><tr> +<td><a href="Plugin_Refactoring_Rope.RefactoringRope.FileSystemCommands.html">FileSystemCommands</a></td> +<td>Module implementing file system commands for rope.</td> +</tr><tr> +<td><a href="Plugin_Refactoring_Rope.RefactoringRope.GetterSetterDialog.html">GetterSetterDialog</a></td> +<td>Module implementing a dialog to create getter and setter method names.</td> +</tr><tr> +<td><a href="Plugin_Refactoring_Rope.RefactoringRope.HelpDialog.html">HelpDialog</a></td> +<td>Module implementing a dialog to show help about rope.</td> +</tr><tr> +<td><a href="Plugin_Refactoring_Rope.RefactoringRope.HistoryDialog.html">HistoryDialog</a></td> +<td>Module implementing the History dialog.</td> +</tr><tr> +<td><a href="Plugin_Refactoring_Rope.RefactoringRope.InlineArgumentDefaultDialog.html">InlineArgumentDefaultDialog</a></td> +<td>Module implementing the Inline Argument Default dialog.</td> +</tr><tr> +<td><a href="Plugin_Refactoring_Rope.RefactoringRope.InlineDialog.html">InlineDialog</a></td> +<td>Module implementing the Inline dialog.</td> +</tr><tr> +<td><a href="Plugin_Refactoring_Rope.RefactoringRope.IntroduceFactoryDialog.html">IntroduceFactoryDialog</a></td> +<td>Module implementing the Introduce Factory dialog.</td> +</tr><tr> +<td><a href="Plugin_Refactoring_Rope.RefactoringRope.IntroduceParameterDialog.html">IntroduceParameterDialog</a></td> +<td>Module implementing the Introduce Parameter dialog.</td> +</tr><tr> +<td><a href="Plugin_Refactoring_Rope.RefactoringRope.MatchesDialog.html">MatchesDialog</a></td> +<td>Module implementing a dialog to show matching references/definitions.</td> +</tr><tr> +<td><a href="Plugin_Refactoring_Rope.RefactoringRope.MethodToMethodObjectDialog.html">MethodToMethodObjectDialog</a></td> +<td>Module implementing the Method To Method object dialog.</td> +</tr><tr> +<td><a href="Plugin_Refactoring_Rope.RefactoringRope.MoveMethodDialog.html">MoveMethodDialog</a></td> +<td>Module implementing the Move Method dialog.</td> +</tr><tr> +<td><a href="Plugin_Refactoring_Rope.RefactoringRope.MoveModuleDialog.html">MoveModuleDialog</a></td> +<td>Module implementing the Move Module dialog.</td> +</tr><tr> +<td><a href="Plugin_Refactoring_Rope.RefactoringRope.PreviewDialogBase.html">PreviewDialogBase</a></td> +<td>Module implementing a dialog base class to preview changes.</td> +</tr><tr> +<td><a href="Plugin_Refactoring_Rope.RefactoringRope.ProgressHandle.html">ProgressHandle</a></td> +<td>Module implementing a TaskHandle class with a progress dialog.</td> +</tr><tr> +<td><a href="Plugin_Refactoring_Rope.RefactoringRope.Refactoring.html">Refactoring</a></td> +<td>Module implementing the refactoring interface to rope.</td> +</tr><tr> +<td><a href="Plugin_Refactoring_Rope.RefactoringRope.RefactoringDialogBase.html">RefactoringDialogBase</a></td> +<td>Module implementing the Refactoring dialog base class.</td> +</tr><tr> +<td><a href="Plugin_Refactoring_Rope.RefactoringRope.RenameDialog.html">RenameDialog</a></td> +<td>Module implementing the Rename dialog.</td> +</tr><tr> +<td><a href="Plugin_Refactoring_Rope.RefactoringRope.RestructureDialog.html">RestructureDialog</a></td> +<td>Module implementing the Restructure dialog.</td> +</tr><tr> +<td><a href="Plugin_Refactoring_Rope.RefactoringRope.SearchDialog.html">SearchDialog</a></td> +<td>Module implementing the search dialog for the rope help dialog.</td> +</tr><tr> +<td><a href="Plugin_Refactoring_Rope.RefactoringRope.UseFunctionDialog.html">UseFunctionDialog</a></td> +<td>Module implementing the Inline dialog.</td> +</tr> +</table> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/RefactoringRope/Documentation/source/index-Plugin_Refactoring_Rope.html Sun Jan 30 18:26:37 2011 +0100 @@ -0,0 +1,43 @@ +<?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</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> +<h1>Plugin_Refactoring_Rope</h1> +<p> +Package implementing the Rope refactoring plugin. +</p> + +<h3>Packages</h3> +<table> +<tr> +<td><a href="index-Plugin_Refactoring_Rope.RefactoringRope.html">RefactoringRope</a></td> +<td>Package implementing the rope refactoring interface module for eric5.</td> +</tr> +</table> + +<h3>Modules</h3> +<table> +<tr> +<td><a href="Plugin_Refactoring_Rope.PluginRefactoringRope.html">PluginRefactoringRope</a></td> +<td>Module implementing the Rope refactoring plugin.</td> +</tr> +</table> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/RefactoringRope/Documentation/source/index.html Sun Jan 30 18:26:37 2011 +0100 @@ -0,0 +1,34 @@ +<?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>Table of contents</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> +<h1>Table of contents</h1> + + +<h3>Packages</h3> +<table> +<tr> +<td><a href="index-Plugin_Refactoring_Rope.html">Plugin_Refactoring_Rope</a></td> +<td>Package implementing the Rope refactoring plugin.</td> +</tr> +</table> + +</body></html> \ No newline at end of file