RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.GetterSetterDialog.html

branch
server_client_variant
changeset 204
b4bf79b956bc
parent 87
1fbf5fdbe721
child 321
d51e810107ec
--- a/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.GetterSetterDialog.html	Fri Sep 29 10:23:35 2017 +0200
+++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.GetterSetterDialog.html	Fri Sep 29 10:32:30 2017 +0200
@@ -21,7 +21,7 @@
 <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.
+Module implementing the encapsulate attribute dialog.
 </p>
 <h3>Global Attributes</h3>
 <table>
@@ -31,7 +31,7 @@
 <table>
 <tr>
 <td><a href="#GetterSetterDialog">GetterSetterDialog</a></td>
-<td>Class implementing a dialog to create getter and setter method names.</td>
+<td>Class implementing the encapsulate attribute dialog.</td>
 </tr>
 </table>
 <h3>Functions</h3>
@@ -42,10 +42,10 @@
 <a NAME="GetterSetterDialog" ID="GetterSetterDialog"></a>
 <h2>GetterSetterDialog</h2>
 <p>
-    Class implementing a dialog to create getter and setter method names.
+    Class implementing the encapsulate attribute dialog.
 </p>
 <h3>Derived from</h3>
-QDialog, Ui_GetterSetterDialog
+RefactoringDialogBase, Ui_GetterSetterDialog
 <h3>Class Attributes</h3>
 <table>
 <tr><td>None</td></tr>
@@ -60,11 +60,29 @@
 <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>
+<td><a href="#GetterSetterDialog.__processFieldName">__processFieldName</a></td>
+<td>Private method to process the field name data sent by the refactoring client in order to polish the dialog.</td>
+</tr><tr>
+<td><a href="#GetterSetterDialog.__updateUI">__updateUI</a></td>
+<td>Private slot to update the UI.</td>
+</tr><tr>
+<td><a href="#GetterSetterDialog._calculateChanges">_calculateChanges</a></td>
+<td>Protected method to initiate the calculation of the changes.</td>
+</tr><tr>
+<td><a href="#GetterSetterDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
+<td>Private slot to act on the button pressed.</td>
+</tr><tr>
+<td><a href="#GetterSetterDialog.on_getterEdit_textChanged">on_getterEdit_textChanged</a></td>
+<td>Private slot to react to changes of the getter method.</td>
+</tr><tr>
+<td><a href="#GetterSetterDialog.on_setterEdit_textChanged">on_setterEdit_textChanged</a></td>
+<td>Private slot to react to changes of the setter method.</td>
 </tr><tr>
 <td><a href="#GetterSetterDialog.on_typeCheckBox_toggled">on_typeCheckBox_toggled</a></td>
 <td>Private slot to react to changes of the type checkbox.</td>
+</tr><tr>
+<td><a href="#GetterSetterDialog.processChangeData">processChangeData</a></td>
+<td>Public method to process the change data sent by the refactoring client.</td>
 </tr>
 </table>
 <h3>Static Methods</h3>
@@ -73,27 +91,76 @@
 </table>
 <a NAME="GetterSetterDialog.__init__" ID="GetterSetterDialog.__init__"></a>
 <h4>GetterSetterDialog (Constructor)</h4>
-<b>GetterSetterDialog</b>(<i>fieldName, parent=None</i>)
+<b>GetterSetterDialog</b>(<i>refactoring, title, filename, offset, parent=None</i>)
 <p>
         Constructor
 </p><dl>
-<dt><i>fieldName</i></dt>
+<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>
-name of the field to create getter and setter
-            method names (string)
-</dd><dt><i>parent</i></dt>
+offset within file
+</dd><dt><i>parent</i> (QWidget)</dt>
 <dd>
-parent widget of the dialog (QWidget)
+reference to the parent widget
+</dd>
+</dl><a NAME="GetterSetterDialog.__processFieldName" ID="GetterSetterDialog.__processFieldName"></a>
+<h4>GetterSetterDialog.__processFieldName</h4>
+<b>__processFieldName</b>(<i>data</i>)
+<p>
+        Private method to process the field name data sent by the refactoring
+        client in order to polish the dialog.
+</p><dl>
+<dt><i>data</i> (dict)</dt>
+<dd>
+dictionary containing the inline type data
 </dd>
-</dl><a NAME="GetterSetterDialog.getData" ID="GetterSetterDialog.getData"></a>
-<h4>GetterSetterDialog.getData</h4>
-<b>getData</b>(<i></i>)
+</dl><a NAME="GetterSetterDialog.__updateUI" ID="GetterSetterDialog.__updateUI"></a>
+<h4>GetterSetterDialog.__updateUI</h4>
+<b>__updateUI</b>(<i></i>)
+<p>
+        Private slot to update the UI.
+</p><a NAME="GetterSetterDialog._calculateChanges" ID="GetterSetterDialog._calculateChanges"></a>
+<h4>GetterSetterDialog._calculateChanges</h4>
+<b>_calculateChanges</b>(<i></i>)
+<p>
+        Protected method to initiate the calculation of the changes.
+</p><a NAME="GetterSetterDialog.on_buttonBox_clicked" ID="GetterSetterDialog.on_buttonBox_clicked"></a>
+<h4>GetterSetterDialog.on_buttonBox_clicked</h4>
+<b>on_buttonBox_clicked</b>(<i>button</i>)
 <p>
-        Public method to return the getter and setter method names.
+        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="GetterSetterDialog.on_getterEdit_textChanged" ID="GetterSetterDialog.on_getterEdit_textChanged"></a>
+<h4>GetterSetterDialog.on_getterEdit_textChanged</h4>
+<b>on_getterEdit_textChanged</b>(<i>text</i>)
+<p>
+        Private slot to react to changes of the getter method.
 </p><dl>
-<dt>Returns:</dt>
+<dt><i>text</i> (str)</dt>
 <dd>
-tuple of two strings with getter and setter method names
+text entered into the edit
+</dd>
+</dl><a NAME="GetterSetterDialog.on_setterEdit_textChanged" ID="GetterSetterDialog.on_setterEdit_textChanged"></a>
+<h4>GetterSetterDialog.on_setterEdit_textChanged</h4>
+<b>on_setterEdit_textChanged</b>(<i>text</i>)
+<p>
+        Private slot to react to changes of the setter method.
+</p><dl>
+<dt><i>text</i> (str)</dt>
+<dd>
+text entered into the edit
 </dd>
 </dl><a NAME="GetterSetterDialog.on_typeCheckBox_toggled" ID="GetterSetterDialog.on_typeCheckBox_toggled"></a>
 <h4>GetterSetterDialog.on_typeCheckBox_toggled</h4>
@@ -101,9 +168,20 @@
 <p>
         Private slot to react to changes of the type checkbox.
 </p><dl>
-<dt><i>checked</i></dt>
+<dt><i>checked</i> (bool)</dt>
 <dd>
-state of the checkbox (boolean)
+state of the checkbox
+</dd>
+</dl><a NAME="GetterSetterDialog.processChangeData" ID="GetterSetterDialog.processChangeData"></a>
+<h4>GetterSetterDialog.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>

eric ide

mercurial