diff -r 65b340b40844 -r a0fac63ef73f RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.Refactoring.html --- /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