Mercurial Repositories > Rope Refactoring / file comparison
comparison: RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.RenameDialog.html
RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.RenameDialog.html
- changeset 321
- d51e810107ec
- parent 204
- b4bf79b956bc
- child 375
- c61a2f18ed78
equal
deleted
inserted
replaced
| 320:91b171fdd85f | 321:d51e810107ec |
|---|---|
| 16 | 16 |
| 17 a { color: #BA6D36; } | 17 a { color: #BA6D36; } |
| 18 | 18 |
| 19 </style> | 19 </style> |
| 20 </head> | 20 </head> |
| 21 <body><a NAME="top" ID="top"></a> | 21 <body> |
| 22 <a NAME="top" ID="top"></a> | |
| 22 <h1>Plugin_Refactoring_Rope.RefactoringRope.RenameDialog</h1> | 23 <h1>Plugin_Refactoring_Rope.RefactoringRope.RenameDialog</h1> |
| 24 | |
| 23 <p> | 25 <p> |
| 24 Module implementing the Rename dialog. | 26 Module implementing the Rename dialog. |
| 25 </p> | 27 </p> |
| 26 <h3>Global Attributes</h3> | 28 <h3>Global Attributes</h3> |
| 29 | |
| 27 <table> | 30 <table> |
| 28 <tr><td>None</td></tr> | 31 <tr><td>None</td></tr> |
| 29 </table> | 32 </table> |
| 30 <h3>Classes</h3> | 33 <h3>Classes</h3> |
| 31 <table> | 34 |
| 35 <table> | |
| 36 | |
| 32 <tr> | 37 <tr> |
| 33 <td><a href="#RenameDialog">RenameDialog</a></td> | 38 <td><a href="#RenameDialog">RenameDialog</a></td> |
| 34 <td>Class implementing the Rename dialog.</td> | 39 <td>Class implementing the Rename dialog.</td> |
| 35 </tr> | 40 </tr> |
| 36 </table> | 41 </table> |
| 37 <h3>Functions</h3> | 42 <h3>Functions</h3> |
| 38 <table> | 43 |
| 39 <tr><td>None</td></tr> | 44 <table> |
| 40 </table> | 45 <tr><td>None</td></tr> |
| 41 <hr /><hr /> | 46 </table> |
| 47 <hr /> | |
| 48 <hr /> | |
| 42 <a NAME="RenameDialog" ID="RenameDialog"></a> | 49 <a NAME="RenameDialog" ID="RenameDialog"></a> |
| 43 <h2>RenameDialog</h2> | 50 <h2>RenameDialog</h2> |
| 51 | |
| 44 <p> | 52 <p> |
| 45 Class implementing the Rename dialog. | 53 Class implementing the Rename dialog. |
| 46 </p> | 54 </p> |
| 47 <h3>Derived from</h3> | 55 <h3>Derived from</h3> |
| 48 RefactoringDialogBase, Ui_RenameDialog | 56 RefactoringDialogBase, Ui_RenameDialog |
| 49 <h3>Class Attributes</h3> | 57 <h3>Class Attributes</h3> |
| 58 | |
| 50 <table> | 59 <table> |
| 51 <tr><td>None</td></tr> | 60 <tr><td>None</td></tr> |
| 52 </table> | 61 </table> |
| 53 <h3>Class Methods</h3> | 62 <h3>Class Methods</h3> |
| 63 | |
| 54 <table> | 64 <table> |
| 55 <tr><td>None</td></tr> | 65 <tr><td>None</td></tr> |
| 56 </table> | 66 </table> |
| 57 <h3>Methods</h3> | 67 <h3>Methods</h3> |
| 58 <table> | 68 |
| 69 <table> | |
| 70 | |
| 59 <tr> | 71 <tr> |
| 60 <td><a href="#RenameDialog.__init__">RenameDialog</a></td> | 72 <td><a href="#RenameDialog.__init__">RenameDialog</a></td> |
| 61 <td>Constructor</td> | 73 <td>Constructor</td> |
| 62 </tr><tr> | 74 </tr> |
| 75 <tr> | |
| 63 <td><a href="#RenameDialog.__confirmUnsure">__confirmUnsure</a></td> | 76 <td><a href="#RenameDialog.__confirmUnsure">__confirmUnsure</a></td> |
| 64 <td>Private method to confirm unsure occurrences.</td> | 77 <td>Private method to confirm unsure occurrences.</td> |
| 65 </tr><tr> | 78 </tr> |
| 79 <tr> | |
| 66 <td><a href="#RenameDialog._calculateChanges">_calculateChanges</a></td> | 80 <td><a href="#RenameDialog._calculateChanges">_calculateChanges</a></td> |
| 67 <td>Protected method to initiate the calculation of the changes.</td> | 81 <td>Protected method to initiate the calculation of the changes.</td> |
| 68 </tr><tr> | 82 </tr> |
| 83 <tr> | |
| 69 <td><a href="#RenameDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | 84 <td><a href="#RenameDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> |
| 70 <td>Private slot to act on the button pressed.</td> | 85 <td>Private slot to act on the button pressed.</td> |
| 71 </tr><tr> | 86 </tr> |
| 87 <tr> | |
| 72 <td><a href="#RenameDialog.on_newNameEdit_textChanged">on_newNameEdit_textChanged</a></td> | 88 <td><a href="#RenameDialog.on_newNameEdit_textChanged">on_newNameEdit_textChanged</a></td> |
| 73 <td>Private slot to react to changes of the new name.</td> | 89 <td>Private slot to react to changes of the new name.</td> |
| 74 </tr><tr> | 90 </tr> |
| 91 <tr> | |
| 75 <td><a href="#RenameDialog.processChangeData">processChangeData</a></td> | 92 <td><a href="#RenameDialog.processChangeData">processChangeData</a></td> |
| 76 <td>Public method to process the change data sent by the refactoring client.</td> | 93 <td>Public method to process the change data sent by the refactoring client.</td> |
| 77 </tr> | 94 </tr> |
| 78 </table> | 95 </table> |
| 79 <h3>Static Methods</h3> | 96 <h3>Static Methods</h3> |
| 80 <table> | 97 |
| 81 <tr><td>None</td></tr> | 98 <table> |
| 82 </table> | 99 <tr><td>None</td></tr> |
| 100 </table> | |
| 101 | |
| 83 <a NAME="RenameDialog.__init__" ID="RenameDialog.__init__"></a> | 102 <a NAME="RenameDialog.__init__" ID="RenameDialog.__init__"></a> |
| 84 <h4>RenameDialog (Constructor)</h4> | 103 <h4>RenameDialog (Constructor)</h4> |
| 85 <b>RenameDialog</b>(<i>refactoring, title, filename, offset, isLocal, selectedText='', parent=None</i>) | 104 <b>RenameDialog</b>(<i>refactoring, title, filename, offset, isLocal, selectedText='', parent=None</i>) |
| 105 | |
| 86 <p> | 106 <p> |
| 87 Constructor | 107 Constructor |
| 88 </p><dl> | 108 </p> |
| 109 <dl> | |
| 110 | |
| 89 <dt><i>refactoring</i> (RefactoringServer)</dt> | 111 <dt><i>refactoring</i> (RefactoringServer)</dt> |
| 90 <dd> | 112 <dd> |
| 91 reference to the main refactoring object | 113 reference to the main refactoring object |
| 92 </dd><dt><i>title</i> (str)</dt> | 114 </dd> |
| 115 <dt><i>title</i> (str)</dt> | |
| 93 <dd> | 116 <dd> |
| 94 title of the dialog | 117 title of the dialog |
| 95 </dd><dt><i>filename</i> (str)</dt> | 118 </dd> |
| 119 <dt><i>filename</i> (str)</dt> | |
| 96 <dd> | 120 <dd> |
| 97 file name to be worked on | 121 file name to be worked on |
| 98 </dd><dt><i>offset</i> (int or None)</dt> | 122 </dd> |
| 123 <dt><i>offset</i> (int or None)</dt> | |
| 99 <dd> | 124 <dd> |
| 100 offset within file | 125 offset within file |
| 101 </dd><dt><i>isLocal</i> (bool)</dt> | 126 </dd> |
| 127 <dt><i>isLocal</i> (bool)</dt> | |
| 102 <dd> | 128 <dd> |
| 103 flag indicating to restrict refactoring to | 129 flag indicating to restrict refactoring to |
| 104 the local file | 130 the local file |
| 105 </dd><dt><i>selectedText</i> (str)</dt> | 131 </dd> |
| 132 <dt><i>selectedText</i> (str)</dt> | |
| 106 <dd> | 133 <dd> |
| 107 selected text to rename | 134 selected text to rename |
| 108 </dd><dt><i>parent</i> (QWidget)</dt> | 135 </dd> |
| 136 <dt><i>parent</i> (QWidget)</dt> | |
| 109 <dd> | 137 <dd> |
| 110 reference to the parent widget | 138 reference to the parent widget |
| 111 </dd> | 139 </dd> |
| 112 </dl><a NAME="RenameDialog.__confirmUnsure" ID="RenameDialog.__confirmUnsure"></a> | 140 </dl> |
| 141 <a NAME="RenameDialog.__confirmUnsure" ID="RenameDialog.__confirmUnsure"></a> | |
| 113 <h4>RenameDialog.__confirmUnsure</h4> | 142 <h4>RenameDialog.__confirmUnsure</h4> |
| 114 <b>__confirmUnsure</b>(<i>data</i>) | 143 <b>__confirmUnsure</b>(<i>data</i>) |
| 144 | |
| 115 <p> | 145 <p> |
| 116 Private method to confirm unsure occurrences. | 146 Private method to confirm unsure occurrences. |
| 117 </p><dl> | 147 </p> |
| 148 <dl> | |
| 149 | |
| 118 <dt><i>data</i> (dict)</dt> | 150 <dt><i>data</i> (dict)</dt> |
| 119 <dd> | 151 <dd> |
| 120 dictionary containing the change data | 152 dictionary containing the change data |
| 121 </dd> | 153 </dd> |
| 122 </dl><a NAME="RenameDialog._calculateChanges" ID="RenameDialog._calculateChanges"></a> | 154 </dl> |
| 155 <a NAME="RenameDialog._calculateChanges" ID="RenameDialog._calculateChanges"></a> | |
| 123 <h4>RenameDialog._calculateChanges</h4> | 156 <h4>RenameDialog._calculateChanges</h4> |
| 124 <b>_calculateChanges</b>(<i></i>) | 157 <b>_calculateChanges</b>(<i></i>) |
| 158 | |
| 125 <p> | 159 <p> |
| 126 Protected method to initiate the calculation of the changes. | 160 Protected method to initiate the calculation of the changes. |
| 127 </p><a NAME="RenameDialog.on_buttonBox_clicked" ID="RenameDialog.on_buttonBox_clicked"></a> | 161 </p> |
| 162 <a NAME="RenameDialog.on_buttonBox_clicked" ID="RenameDialog.on_buttonBox_clicked"></a> | |
| 128 <h4>RenameDialog.on_buttonBox_clicked</h4> | 163 <h4>RenameDialog.on_buttonBox_clicked</h4> |
| 129 <b>on_buttonBox_clicked</b>(<i>button</i>) | 164 <b>on_buttonBox_clicked</b>(<i>button</i>) |
| 165 | |
| 130 <p> | 166 <p> |
| 131 Private slot to act on the button pressed. | 167 Private slot to act on the button pressed. |
| 132 </p><dl> | 168 </p> |
| 169 <dl> | |
| 170 | |
| 133 <dt><i>button</i> (QAbstractButton)</dt> | 171 <dt><i>button</i> (QAbstractButton)</dt> |
| 134 <dd> | 172 <dd> |
| 135 reference to the button pressed | 173 reference to the button pressed |
| 136 </dd> | 174 </dd> |
| 137 </dl><a NAME="RenameDialog.on_newNameEdit_textChanged" ID="RenameDialog.on_newNameEdit_textChanged"></a> | 175 </dl> |
| 176 <a NAME="RenameDialog.on_newNameEdit_textChanged" ID="RenameDialog.on_newNameEdit_textChanged"></a> | |
| 138 <h4>RenameDialog.on_newNameEdit_textChanged</h4> | 177 <h4>RenameDialog.on_newNameEdit_textChanged</h4> |
| 139 <b>on_newNameEdit_textChanged</b>(<i>text</i>) | 178 <b>on_newNameEdit_textChanged</b>(<i>text</i>) |
| 179 | |
| 140 <p> | 180 <p> |
| 141 Private slot to react to changes of the new name. | 181 Private slot to react to changes of the new name. |
| 142 </p><dl> | 182 </p> |
| 183 <dl> | |
| 184 | |
| 143 <dt><i>text</i> (str)</dt> | 185 <dt><i>text</i> (str)</dt> |
| 144 <dd> | 186 <dd> |
| 145 text entered into the edit | 187 text entered into the edit |
| 146 </dd> | 188 </dd> |
| 147 </dl><a NAME="RenameDialog.processChangeData" ID="RenameDialog.processChangeData"></a> | 189 </dl> |
| 190 <a NAME="RenameDialog.processChangeData" ID="RenameDialog.processChangeData"></a> | |
| 148 <h4>RenameDialog.processChangeData</h4> | 191 <h4>RenameDialog.processChangeData</h4> |
| 149 <b>processChangeData</b>(<i>data</i>) | 192 <b>processChangeData</b>(<i>data</i>) |
| 193 | |
| 150 <p> | 194 <p> |
| 151 Public method to process the change data sent by the refactoring | 195 Public method to process the change data sent by the refactoring |
| 152 client. | 196 client. |
| 153 </p><dl> | 197 </p> |
| 198 <dl> | |
| 199 | |
| 154 <dt><i>data</i> (dict)</dt> | 200 <dt><i>data</i> (dict)</dt> |
| 155 <dd> | 201 <dd> |
| 156 dictionary containing the change data | 202 dictionary containing the change data |
| 157 </dd> | 203 </dd> |
| 158 </dl> | 204 </dl> |
