Mercurial Repositories > Rope Refactoring / file comparison
comparison: RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.RefactoringDialogBase.html
RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.RefactoringDialogBase.html
- changeset 17
- a0fac63ef73f
- child 24
- e18b36080a37
equal
deleted
inserted
replaced
| 16:65b340b40844 | 17:a0fac63ef73f |
|---|---|
| 1 <?xml version="1.0" encoding="utf-8"?> | |
| 2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' | |
| 3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> | |
| 4 <html><head> | |
| 5 <title>Plugin_Refactoring_Rope.RefactoringRope.RefactoringDialogBase</title> | |
| 6 <style> | |
| 7 body { | |
| 8 background: #EDECE6; | |
| 9 margin: 0em 1em 10em 1em; | |
| 10 color: black; | |
| 11 } | |
| 12 | |
| 13 h1 { color: white; background: #85774A; } | |
| 14 h2 { color: white; background: #85774A; } | |
| 15 h3 { color: white; background: #9D936E; } | |
| 16 h4 { color: white; background: #9D936E; } | |
| 17 | |
| 18 a { color: #BA6D36; } | |
| 19 | |
| 20 </style> | |
| 21 </head> | |
| 22 <body><a NAME="top" ID="top"></a> | |
| 23 <h1>Plugin_Refactoring_Rope.RefactoringRope.RefactoringDialogBase</h1> | |
| 24 <p> | |
| 25 Module implementing the Refactoring dialog base class. | |
| 26 </p> | |
| 27 <h3>Global Attributes</h3> | |
| 28 <table> | |
| 29 <tr><td>None</td></tr> | |
| 30 </table> | |
| 31 <h3>Classes</h3> | |
| 32 <table> | |
| 33 <tr> | |
| 34 <td><a href="#RefactoringDialogBase">RefactoringDialogBase</a></td> | |
| 35 <td>Class implementing the Refactoring dialog base class.</td> | |
| 36 </tr> | |
| 37 </table> | |
| 38 <h3>Functions</h3> | |
| 39 <table> | |
| 40 <tr><td>None</td></tr> | |
| 41 </table> | |
| 42 <hr /><hr /> | |
| 43 <a NAME="RefactoringDialogBase" ID="RefactoringDialogBase"></a> | |
| 44 <h2>RefactoringDialogBase</h2> | |
| 45 <p> | |
| 46 Class implementing the Refactoring dialog base class. | |
| 47 </p> | |
| 48 <h3>Derived from</h3> | |
| 49 QDialog | |
| 50 <h3>Class Attributes</h3> | |
| 51 <table> | |
| 52 <tr><td>None</td></tr> | |
| 53 </table> | |
| 54 <h3>Methods</h3> | |
| 55 <table> | |
| 56 <tr> | |
| 57 <td><a href="#RefactoringDialogBase.__init__">RefactoringDialogBase</a></td> | |
| 58 <td>Constructor</td> | |
| 59 </tr><tr> | |
| 60 <td><a href="#RefactoringDialogBase.__createProgressHandle">__createProgressHandle</a></td> | |
| 61 <td>Private method to create a TaskHandle to update a progress dialog.</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#RefactoringDialogBase.__getChanges">__getChanges</a></td> | |
| 64 <td>Private method to build the Changes object.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#RefactoringDialogBase._calculateChanges">_calculateChanges</a></td> | |
| 67 <td>Protected method to calculate the changes.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#RefactoringDialogBase.applyChanges">applyChanges</a></td> | |
| 70 <td>Public method to apply the changes.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#RefactoringDialogBase.previewChanges">previewChanges</a></td> | |
| 73 <td>Public method to preview the changes.</td> | |
| 74 </tr> | |
| 75 </table> | |
| 76 <a NAME="RefactoringDialogBase.__init__" ID="RefactoringDialogBase.__init__"></a> | |
| 77 <h4>RefactoringDialogBase (Constructor)</h4> | |
| 78 <b>RefactoringDialogBase</b>(<i>refactoring, title, parent=None</i>) | |
| 79 <p> | |
| 80 Constructor | |
| 81 </p><dl> | |
| 82 <dt><i>refactoring</i></dt> | |
| 83 <dd> | |
| 84 reference to the main refactoring object | |
| 85 (Refactoring) | |
| 86 </dd><dt><i>title</i></dt> | |
| 87 <dd> | |
| 88 title of the dialog (string) | |
| 89 </dd><dt><i>parent</i></dt> | |
| 90 <dd> | |
| 91 reference to the parent widget (QWidget) | |
| 92 </dd> | |
| 93 </dl><a NAME="RefactoringDialogBase.__createProgressHandle" ID="RefactoringDialogBase.__createProgressHandle"></a> | |
| 94 <h4>RefactoringDialogBase.__createProgressHandle</h4> | |
| 95 <b>__createProgressHandle</b>(<i>interruptable=True</i>) | |
| 96 <p> | |
| 97 Private method to create a TaskHandle to update a progress dialog. | |
| 98 </p><dl> | |
| 99 <dt><i>interruptable</i></dt> | |
| 100 <dd> | |
| 101 flag indicating, that the task may be | |
| 102 interrupted (boolean) | |
| 103 </dd> | |
| 104 </dl><a NAME="RefactoringDialogBase.__getChanges" ID="RefactoringDialogBase.__getChanges"></a> | |
| 105 <h4>RefactoringDialogBase.__getChanges</h4> | |
| 106 <b>__getChanges</b>(<i></i>) | |
| 107 <p> | |
| 108 Private method to build the Changes object. | |
| 109 </p><dl> | |
| 110 <dt>Returns:</dt> | |
| 111 <dd> | |
| 112 reference to the Changes object (rope.base.change.ChangeSet) | |
| 113 </dd> | |
| 114 </dl><a NAME="RefactoringDialogBase._calculateChanges" ID="RefactoringDialogBase._calculateChanges"></a> | |
| 115 <h4>RefactoringDialogBase._calculateChanges</h4> | |
| 116 <b>_calculateChanges</b>(<i>handle</i>) | |
| 117 <p> | |
| 118 Protected method to calculate the changes. | |
| 119 </p><dl> | |
| 120 <dt><i>handle</i></dt> | |
| 121 <dd> | |
| 122 reference to the task handle | |
| 123 (rope.base.taskhandle.TaskHandle) | |
| 124 </dd> | |
| 125 </dl><dl> | |
| 126 <dt>Returns:</dt> | |
| 127 <dd> | |
| 128 reference to the Changes object (rope.base.change.ChangeSet) | |
| 129 </dd> | |
| 130 </dl><a NAME="RefactoringDialogBase.applyChanges" ID="RefactoringDialogBase.applyChanges"></a> | |
| 131 <h4>RefactoringDialogBase.applyChanges</h4> | |
| 132 <b>applyChanges</b>(<i>changes = None</i>) | |
| 133 <p> | |
| 134 Public method to apply the changes. | |
| 135 </p><dl> | |
| 136 <dt><i>reference</i></dt> | |
| 137 <dd> | |
| 138 to the Changes object (rope.base.change.ChangeSet) | |
| 139 </dd> | |
| 140 </dl><a NAME="RefactoringDialogBase.previewChanges" ID="RefactoringDialogBase.previewChanges"></a> | |
| 141 <h4>RefactoringDialogBase.previewChanges</h4> | |
| 142 <b>previewChanges</b>(<i></i>) | |
| 143 <p> | |
| 144 Public method to preview the changes. | |
| 145 </p> | |
| 146 <div align="right"><a href="#top">Up</a></div> | |
| 147 <hr /> | |
| 148 </body></html> |
