diff -r 91b171fdd85f -r d51e810107ec RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.ChangesPreviewDialog.html --- a/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.ChangesPreviewDialog.html Fri Oct 11 19:05:23 2019 +0200 +++ b/RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.ChangesPreviewDialog.html Fri Oct 11 19:05:59 2019 +0200 @@ -18,82 +18,107 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<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 /> +<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>Class Methods</h3> + <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> + <table> + <tr> <td><a href="#ChangesPreviewDialog.__init__">ChangesPreviewDialog</a></td> <td>Constructor</td> -</tr><tr> +</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> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="ChangesPreviewDialog.__init__" ID="ChangesPreviewDialog.__init__"></a> <h4>ChangesPreviewDialog (Constructor)</h4> <b>ChangesPreviewDialog</b>(<i>description, changes, parent</i>) + <p> Constructor -</p><dl> +</p> +<dl> + <dt><i>description</i> (str)</dt> <dd> description of the changes -</dd><dt><i>changes</i> (list of list of (str, str))</dt> +</dd> +<dt><i>changes</i> (list of list of (str, str))</dt> <dd> list of lists containing the change data -</dd><dt><i>parent</i> (QWidget)</dt> +</dd> +<dt><i>parent</i> (QWidget)</dt> <dd> reference to the parent widget </dd> -</dl><a NAME="ChangesPreviewDialog.on_changesList_currentItemChanged" ID="ChangesPreviewDialog.on_changesList_currentItemChanged"></a> +</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> +</p> +<dl> + <dt><i>current</i> (QListWidgetItem)</dt> <dd> reference to the new current item -</dd><dt><i>previous</i> (QListWidgetItem)</dt> +</dd> +<dt><i>previous</i> (QListWidgetItem)</dt> <dd> reference to the old current item </dd>