--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.MoveDialog.html Fri Sep 29 10:32:30 2017 +0200 @@ -0,0 +1,216 @@ +<!DOCTYPE html> +<html><head> +<title>Plugin_Refactoring_Rope.RefactoringRope.MoveDialog</title> +<meta charset="UTF-8"> +<style> +body { + background: #EDECE6; + margin: 0em 1em 10em 1em; + color: black; +} + +h1 { color: white; background: #85774A; } +h2 { color: white; background: #85774A; } +h3 { color: white; background: #9D936E; } +h4 { color: white; background: #9D936E; } + +a { color: #BA6D36; } + +</style> +</head> +<body><a NAME="top" ID="top"></a> +<h1>Plugin_Refactoring_Rope.RefactoringRope.MoveDialog</h1> +<p> +Module implementing the Move Method or Module dialog. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#MoveDialog">MoveDialog</a></td> +<td>Class implementing the Move Method or Module dialog.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="MoveDialog" ID="MoveDialog"></a> +<h2>MoveDialog</h2> +<p> + Class implementing the Move Method or Module dialog. +</p> +<h3>Derived from</h3> +RefactoringDialogBase, Ui_MoveDialog +<h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Class Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#MoveDialog.__init__">MoveDialog</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#MoveDialog.__checkDestination">__checkDestination</a></td> +<td>Private method to check the destination entered.</td> +</tr><tr> +<td><a href="#MoveDialog.__processMoveType">__processMoveType</a></td> +<td>Private method to process the move type data sent by the refactoring client in order to polish the dialog.</td> +</tr><tr> +<td><a href="#MoveDialog.__updateUI">__updateUI</a></td> +<td>Private method to perform various UI updates.</td> +</tr><tr> +<td><a href="#MoveDialog._calculateChanges">_calculateChanges</a></td> +<td>Protected method to initiate the calculation of the changes.</td> +</tr><tr> +<td><a href="#MoveDialog.on_attributeEdit_textChanged">on_attributeEdit_textChanged</a></td> +<td>Private slot to react to changes of the attribute.</td> +</tr><tr> +<td><a href="#MoveDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> +<td>Private slot to act on the button pressed.</td> +</tr><tr> +<td><a href="#MoveDialog.on_destinationEdit_textChanged">on_destinationEdit_textChanged</a></td> +<td>Private slot to react to changes of the destination module.</td> +</tr><tr> +<td><a href="#MoveDialog.on_methodEdit_textChanged">on_methodEdit_textChanged</a></td> +<td>Private slot to react to changes of the method.</td> +</tr><tr> +<td><a href="#MoveDialog.on_selectButton_clicked">on_selectButton_clicked</a></td> +<td>Private slot called to select the destination module via a file selection dialog.</td> +</tr><tr> +<td><a href="#MoveDialog.processChangeData">processChangeData</a></td> +<td>Public method to process the change data sent by the refactoring client.</td> +</tr> +</table> +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<a NAME="MoveDialog.__init__" ID="MoveDialog.__init__"></a> +<h4>MoveDialog (Constructor)</h4> +<b>MoveDialog</b>(<i>refactoring, title, filename, offset, parent=None</i>) +<p> + Constructor +</p><dl> +<dt><i>refactoring</i> (RefactoringServer)</dt> +<dd> +reference to the main refactoring object +</dd><dt><i>title</i> (str)</dt> +<dd> +title of the dialog +</dd><dt><i>filename</i> (str)</dt> +<dd> +file name to be worked on +</dd><dt><i>offset</i> (int or None)</dt> +<dd> +offset within file +</dd><dt><i>parent</i> (QWidget)</dt> +<dd> +reference to the parent widget +</dd> +</dl><a NAME="MoveDialog.__checkDestination" ID="MoveDialog.__checkDestination"></a> +<h4>MoveDialog.__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 +</dd> +</dl><dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl><a NAME="MoveDialog.__processMoveType" ID="MoveDialog.__processMoveType"></a> +<h4>MoveDialog.__processMoveType</h4> +<b>__processMoveType</b>(<i>data</i>) +<p> + Private method to process the move type data sent by the refactoring + client in order to polish the dialog. +</p><dl> +<dt><i>data</i> (dict)</dt> +<dd> +dictionary containing the move type data +</dd> +</dl><a NAME="MoveDialog.__updateUI" ID="MoveDialog.__updateUI"></a> +<h4>MoveDialog.__updateUI</h4> +<b>__updateUI</b>(<i></i>) +<p> + Private method to perform various UI updates. +</p><a NAME="MoveDialog._calculateChanges" ID="MoveDialog._calculateChanges"></a> +<h4>MoveDialog._calculateChanges</h4> +<b>_calculateChanges</b>(<i></i>) +<p> + Protected method to initiate the calculation of the changes. +</p><a NAME="MoveDialog.on_attributeEdit_textChanged" ID="MoveDialog.on_attributeEdit_textChanged"></a> +<h4>MoveDialog.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> (str)</dt> +<dd> +text entered into the edit +</dd> +</dl><a NAME="MoveDialog.on_buttonBox_clicked" ID="MoveDialog.on_buttonBox_clicked"></a> +<h4>MoveDialog.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> (QAbstractButton)</dt> +<dd> +reference to the button pressed +</dd> +</dl><a NAME="MoveDialog.on_destinationEdit_textChanged" ID="MoveDialog.on_destinationEdit_textChanged"></a> +<h4>MoveDialog.on_destinationEdit_textChanged</h4> +<b>on_destinationEdit_textChanged</b>(<i>text</i>) +<p> + Private slot to react to changes of the destination module. +</p><dl> +<dt><i>text</i> (str)</dt> +<dd> +text entered into the edit +</dd> +</dl><a NAME="MoveDialog.on_methodEdit_textChanged" ID="MoveDialog.on_methodEdit_textChanged"></a> +<h4>MoveDialog.on_methodEdit_textChanged</h4> +<b>on_methodEdit_textChanged</b>(<i>text</i>) +<p> + Private slot to react to changes of the method. +</p><dl> +<dt><i>text</i> (str)</dt> +<dd> +text entered into the edit +</dd> +</dl><a NAME="MoveDialog.on_selectButton_clicked" ID="MoveDialog.on_selectButton_clicked"></a> +<h4>MoveDialog.on_selectButton_clicked</h4> +<b>on_selectButton_clicked</b>(<i></i>) +<p> + Private slot called to select the destination module via a file + selection dialog. +</p><a NAME="MoveDialog.processChangeData" ID="MoveDialog.processChangeData"></a> +<h4>MoveDialog.processChangeData</h4> +<b>processChangeData</b>(<i>data</i>) +<p> + Public method to process the change data sent by the refactoring + client. +</p><dl> +<dt><i>data</i> (dict)</dt> +<dd> +dictionary containing the change data +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file