diff -r 91b171fdd85f -r d51e810107ec RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.RestructureDialog.html --- a/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.RestructureDialog.html Fri Oct 11 19:05:23 2019 +0200 +++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.RestructureDialog.html Fri Oct 11 19:05:59 2019 +0200 @@ -18,128 +18,170 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<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 /> +<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>Class Methods</h3> + <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> + <table> + <tr> <td><a href="#RestructureDialog.__init__">RestructureDialog</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#RestructureDialog.__loadData">__loadData</a></td> <td>Private slot to load the history data into the dialog.</td> -</tr><tr> +</tr> +<tr> <td><a href="#RestructureDialog.__saveData">__saveData</a></td> <td>Private slot to save the data for later reuse.</td> -</tr><tr> +</tr> +<tr> <td><a href="#RestructureDialog.__updateUI">__updateUI</a></td> <td>Private slot to update the UI.</td> -</tr><tr> +</tr> +<tr> <td><a href="#RestructureDialog._calculateChanges">_calculateChanges</a></td> <td>Protected method to initiate the calculation of the changes.</td> -</tr><tr> +</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> +</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> +</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> <h3>Static Methods</h3> + <table> <tr><td>None</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> +</p> +<dl> + <dt><i>refactoring</i> (RefactoringServer)</dt> <dd> reference to the main refactoring object -</dd><dt><i>title</i> (str)</dt> +</dd> +<dt><i>title</i> (str)</dt> <dd> title of the dialog -</dd><dt><i>parent</i> (QWidget)</dt> +</dd> +<dt><i>parent</i> (QWidget)</dt> <dd> reference to the parent widget </dd> -</dl><a NAME="RestructureDialog.__loadData" ID="RestructureDialog.__loadData"></a> +</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> +</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> +</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> +</p> +<a NAME="RestructureDialog._calculateChanges" ID="RestructureDialog._calculateChanges"></a> <h4>RestructureDialog._calculateChanges</h4> <b>_calculateChanges</b>(<i></i>) + <p> Protected method to initiate the calculation of the changes. -</p><a NAME="RestructureDialog.on_buttonBox_clicked" ID="RestructureDialog.on_buttonBox_clicked"></a> +</p> +<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> +</p> +<dl> + <dt><i>button</i> (QAbstractButton)</dt> <dd> reference to the button pressed </dd> -</dl><a NAME="RestructureDialog.on_goalEdit_textChanged" ID="RestructureDialog.on_goalEdit_textChanged"></a> +</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> +</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>