Mercurial Repositories > Rope Refactoring / file comparison
comparison: RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.InlineArgumentDefaultDialog.html
RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.InlineArgumentDefaultDialog.html
- changeset 321
- d51e810107ec
- parent 204
- b4bf79b956bc
- child 347
- b5048b5ff454
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.InlineArgumentDefaultDialog</h1> | 23 <h1>Plugin_Refactoring_Rope.RefactoringRope.InlineArgumentDefaultDialog</h1> |
| 24 | |
| 23 <p> | 25 <p> |
| 24 Module implementing the Inline Argument Default dialog. | 26 Module implementing the Inline Argument Default 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="#InlineArgumentDefaultDialog">InlineArgumentDefaultDialog</a></td> | 38 <td><a href="#InlineArgumentDefaultDialog">InlineArgumentDefaultDialog</a></td> |
| 34 <td>Class implementing the Inline Argument Default dialog.</td> | 39 <td>Class implementing the Inline Argument Default 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="InlineArgumentDefaultDialog" ID="InlineArgumentDefaultDialog"></a> | 49 <a NAME="InlineArgumentDefaultDialog" ID="InlineArgumentDefaultDialog"></a> |
| 43 <h2>InlineArgumentDefaultDialog</h2> | 50 <h2>InlineArgumentDefaultDialog</h2> |
| 51 | |
| 44 <p> | 52 <p> |
| 45 Class implementing the Inline Argument Default dialog. | 53 Class implementing the Inline Argument Default dialog. |
| 46 </p> | 54 </p> |
| 47 <h3>Derived from</h3> | 55 <h3>Derived from</h3> |
| 48 RefactoringDialogBase, Ui_InlineArgumentDefaultDialog | 56 RefactoringDialogBase, Ui_InlineArgumentDefaultDialog |
| 49 <h3>Class Attributes</h3> | 57 <h3>Class Attributes</h3> |
| 58 | |
| 50 <table> | 59 <table> |
| 51 <tr><td>NameRole</td></tr> | 60 <tr><td>NameRole</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="#InlineArgumentDefaultDialog.__init__">InlineArgumentDefaultDialog</a></td> | 72 <td><a href="#InlineArgumentDefaultDialog.__init__">InlineArgumentDefaultDialog</a></td> |
| 61 <td>Constructor</td> | 73 <td>Constructor</td> |
| 62 </tr><tr> | 74 </tr> |
| 75 <tr> | |
| 63 <td><a href="#InlineArgumentDefaultDialog.__getParameterIndex">__getParameterIndex</a></td> | 76 <td><a href="#InlineArgumentDefaultDialog.__getParameterIndex">__getParameterIndex</a></td> |
| 64 <td>Private method to calculate the index of the given paramter.</td> | 77 <td>Private method to calculate the index of the given paramter.</td> |
| 65 </tr><tr> | 78 </tr> |
| 79 <tr> | |
| 66 <td><a href="#InlineArgumentDefaultDialog.__processSignature">__processSignature</a></td> | 80 <td><a href="#InlineArgumentDefaultDialog.__processSignature">__processSignature</a></td> |
| 67 <td>Private method to process the inline type data sent by the refactoring client in order to polish the dialog.</td> | 81 <td>Private method to process the inline type data sent by the refactoring client in order to polish the dialog.</td> |
| 68 </tr><tr> | 82 </tr> |
| 83 <tr> | |
| 69 <td><a href="#InlineArgumentDefaultDialog._calculateChanges">_calculateChanges</a></td> | 84 <td><a href="#InlineArgumentDefaultDialog._calculateChanges">_calculateChanges</a></td> |
| 70 <td>Protected method to initiate the calculation of the changes.</td> | 85 <td>Protected method to initiate the calculation of the changes.</td> |
| 71 </tr><tr> | 86 </tr> |
| 87 <tr> | |
| 72 <td><a href="#InlineArgumentDefaultDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | 88 <td><a href="#InlineArgumentDefaultDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> |
| 73 <td>Private slot to act on the button pressed.</td> | 89 <td>Private slot to act on the button pressed.</td> |
| 74 </tr><tr> | 90 </tr> |
| 91 <tr> | |
| 75 <td><a href="#InlineArgumentDefaultDialog.on_parameterList_itemSelectionChanged">on_parameterList_itemSelectionChanged</a></td> | 92 <td><a href="#InlineArgumentDefaultDialog.on_parameterList_itemSelectionChanged">on_parameterList_itemSelectionChanged</a></td> |
| 76 <td>Private slot called, when the selection changes.</td> | 93 <td>Private slot called, when the selection changes.</td> |
| 77 </tr><tr> | 94 </tr> |
| 95 <tr> | |
| 78 <td><a href="#InlineArgumentDefaultDialog.processChangeData">processChangeData</a></td> | 96 <td><a href="#InlineArgumentDefaultDialog.processChangeData">processChangeData</a></td> |
| 79 <td>Public method to process the change data sent by the refactoring client.</td> | 97 <td>Public method to process the change data sent by the refactoring client.</td> |
| 80 </tr> | 98 </tr> |
| 81 </table> | 99 </table> |
| 82 <h3>Static Methods</h3> | 100 <h3>Static Methods</h3> |
| 83 <table> | 101 |
| 84 <tr><td>None</td></tr> | 102 <table> |
| 85 </table> | 103 <tr><td>None</td></tr> |
| 104 </table> | |
| 105 | |
| 86 <a NAME="InlineArgumentDefaultDialog.__init__" ID="InlineArgumentDefaultDialog.__init__"></a> | 106 <a NAME="InlineArgumentDefaultDialog.__init__" ID="InlineArgumentDefaultDialog.__init__"></a> |
| 87 <h4>InlineArgumentDefaultDialog (Constructor)</h4> | 107 <h4>InlineArgumentDefaultDialog (Constructor)</h4> |
| 88 <b>InlineArgumentDefaultDialog</b>(<i>refactoring, title, filename, offset, parent=None</i>) | 108 <b>InlineArgumentDefaultDialog</b>(<i>refactoring, title, filename, offset, parent=None</i>) |
| 109 | |
| 89 <p> | 110 <p> |
| 90 Constructor | 111 Constructor |
| 91 </p><dl> | 112 </p> |
| 113 <dl> | |
| 114 | |
| 92 <dt><i>refactoring</i> (RefactoringServer)</dt> | 115 <dt><i>refactoring</i> (RefactoringServer)</dt> |
| 93 <dd> | 116 <dd> |
| 94 reference to the main refactoring object | 117 reference to the main refactoring object |
| 95 </dd><dt><i>title</i> (str)</dt> | 118 </dd> |
| 119 <dt><i>title</i> (str)</dt> | |
| 96 <dd> | 120 <dd> |
| 97 title of the dialog | 121 title of the dialog |
| 98 </dd><dt><i>filename</i> (str)</dt> | 122 </dd> |
| 123 <dt><i>filename</i> (str)</dt> | |
| 99 <dd> | 124 <dd> |
| 100 file name to be worked on | 125 file name to be worked on |
| 101 </dd><dt><i>offset</i> (int or None)</dt> | 126 </dd> |
| 127 <dt><i>offset</i> (int or None)</dt> | |
| 102 <dd> | 128 <dd> |
| 103 offset within file | 129 offset within file |
| 104 </dd><dt><i>parent</i> (QWidget)</dt> | 130 </dd> |
| 131 <dt><i>parent</i> (QWidget)</dt> | |
| 105 <dd> | 132 <dd> |
| 106 reference to the parent widget | 133 reference to the parent widget |
| 107 </dd> | 134 </dd> |
| 108 </dl><a NAME="InlineArgumentDefaultDialog.__getParameterIndex" ID="InlineArgumentDefaultDialog.__getParameterIndex"></a> | 135 </dl> |
| 136 <a NAME="InlineArgumentDefaultDialog.__getParameterIndex" ID="InlineArgumentDefaultDialog.__getParameterIndex"></a> | |
| 109 <h4>InlineArgumentDefaultDialog.__getParameterIndex</h4> | 137 <h4>InlineArgumentDefaultDialog.__getParameterIndex</h4> |
| 110 <b>__getParameterIndex</b>(<i>definition_info, name</i>) | 138 <b>__getParameterIndex</b>(<i>definition_info, name</i>) |
| 139 | |
| 111 <p> | 140 <p> |
| 112 Private method to calculate the index of the given paramter. | 141 Private method to calculate the index of the given paramter. |
| 113 </p><dl> | 142 </p> |
| 143 <dl> | |
| 144 | |
| 114 <dt><i>definition_info</i> (list of lists of two str)</dt> | 145 <dt><i>definition_info</i> (list of lists of two str)</dt> |
| 115 <dd> | 146 <dd> |
| 116 list of lists containing the method signature | 147 list of lists containing the method signature |
| 117 definition | 148 definition |
| 118 </dd><dt><i>name</i> (str)</dt> | 149 </dd> |
| 150 <dt><i>name</i> (str)</dt> | |
| 119 <dd> | 151 <dd> |
| 120 parameter name | 152 parameter name |
| 121 </dd> | 153 </dd> |
| 122 </dl><dl> | 154 </dl> |
| 155 <dl> | |
| 123 <dt>Returns:</dt> | 156 <dt>Returns:</dt> |
| 124 <dd> | 157 <dd> |
| 125 index of the parameter | 158 index of the parameter |
| 126 </dd> | 159 </dd> |
| 127 </dl><dl> | 160 </dl> |
| 161 <dl> | |
| 128 <dt>Return Type:</dt> | 162 <dt>Return Type:</dt> |
| 129 <dd> | 163 <dd> |
| 130 int | 164 int |
| 131 </dd> | 165 </dd> |
| 132 </dl><a NAME="InlineArgumentDefaultDialog.__processSignature" ID="InlineArgumentDefaultDialog.__processSignature"></a> | 166 </dl> |
| 167 <a NAME="InlineArgumentDefaultDialog.__processSignature" ID="InlineArgumentDefaultDialog.__processSignature"></a> | |
| 133 <h4>InlineArgumentDefaultDialog.__processSignature</h4> | 168 <h4>InlineArgumentDefaultDialog.__processSignature</h4> |
| 134 <b>__processSignature</b>(<i>data</i>) | 169 <b>__processSignature</b>(<i>data</i>) |
| 170 | |
| 135 <p> | 171 <p> |
| 136 Private method to process the inline type data sent by the refactoring | 172 Private method to process the inline type data sent by the refactoring |
| 137 client in order to polish the dialog. | 173 client in order to polish the dialog. |
| 138 </p><dl> | 174 </p> |
| 175 <dl> | |
| 176 | |
| 139 <dt><i>data</i> (dict)</dt> | 177 <dt><i>data</i> (dict)</dt> |
| 140 <dd> | 178 <dd> |
| 141 dictionary containing the inline type data | 179 dictionary containing the inline type data |
| 142 </dd> | 180 </dd> |
| 143 </dl><a NAME="InlineArgumentDefaultDialog._calculateChanges" ID="InlineArgumentDefaultDialog._calculateChanges"></a> | 181 </dl> |
| 182 <a NAME="InlineArgumentDefaultDialog._calculateChanges" ID="InlineArgumentDefaultDialog._calculateChanges"></a> | |
| 144 <h4>InlineArgumentDefaultDialog._calculateChanges</h4> | 183 <h4>InlineArgumentDefaultDialog._calculateChanges</h4> |
| 145 <b>_calculateChanges</b>(<i></i>) | 184 <b>_calculateChanges</b>(<i></i>) |
| 185 | |
| 146 <p> | 186 <p> |
| 147 Protected method to initiate the calculation of the changes. | 187 Protected method to initiate the calculation of the changes. |
| 148 </p><a NAME="InlineArgumentDefaultDialog.on_buttonBox_clicked" ID="InlineArgumentDefaultDialog.on_buttonBox_clicked"></a> | 188 </p> |
| 189 <a NAME="InlineArgumentDefaultDialog.on_buttonBox_clicked" ID="InlineArgumentDefaultDialog.on_buttonBox_clicked"></a> | |
| 149 <h4>InlineArgumentDefaultDialog.on_buttonBox_clicked</h4> | 190 <h4>InlineArgumentDefaultDialog.on_buttonBox_clicked</h4> |
| 150 <b>on_buttonBox_clicked</b>(<i>button</i>) | 191 <b>on_buttonBox_clicked</b>(<i>button</i>) |
| 192 | |
| 151 <p> | 193 <p> |
| 152 Private slot to act on the button pressed. | 194 Private slot to act on the button pressed. |
| 153 </p><dl> | 195 </p> |
| 196 <dl> | |
| 197 | |
| 154 <dt><i>button</i> (QAbstractButton)</dt> | 198 <dt><i>button</i> (QAbstractButton)</dt> |
| 155 <dd> | 199 <dd> |
| 156 reference to the button pressed | 200 reference to the button pressed |
| 157 </dd> | 201 </dd> |
| 158 </dl><a NAME="InlineArgumentDefaultDialog.on_parameterList_itemSelectionChanged" ID="InlineArgumentDefaultDialog.on_parameterList_itemSelectionChanged"></a> | 202 </dl> |
| 203 <a NAME="InlineArgumentDefaultDialog.on_parameterList_itemSelectionChanged" ID="InlineArgumentDefaultDialog.on_parameterList_itemSelectionChanged"></a> | |
| 159 <h4>InlineArgumentDefaultDialog.on_parameterList_itemSelectionChanged</h4> | 204 <h4>InlineArgumentDefaultDialog.on_parameterList_itemSelectionChanged</h4> |
| 160 <b>on_parameterList_itemSelectionChanged</b>(<i></i>) | 205 <b>on_parameterList_itemSelectionChanged</b>(<i></i>) |
| 206 | |
| 161 <p> | 207 <p> |
| 162 Private slot called, when the selection changes. | 208 Private slot called, when the selection changes. |
| 163 </p><a NAME="InlineArgumentDefaultDialog.processChangeData" ID="InlineArgumentDefaultDialog.processChangeData"></a> | 209 </p> |
| 210 <a NAME="InlineArgumentDefaultDialog.processChangeData" ID="InlineArgumentDefaultDialog.processChangeData"></a> | |
| 164 <h4>InlineArgumentDefaultDialog.processChangeData</h4> | 211 <h4>InlineArgumentDefaultDialog.processChangeData</h4> |
| 165 <b>processChangeData</b>(<i>data</i>) | 212 <b>processChangeData</b>(<i>data</i>) |
| 213 | |
| 166 <p> | 214 <p> |
| 167 Public method to process the change data sent by the refactoring | 215 Public method to process the change data sent by the refactoring |
| 168 client. | 216 client. |
| 169 </p><dl> | 217 </p> |
| 218 <dl> | |
| 219 | |
| 170 <dt><i>data</i> (dict)</dt> | 220 <dt><i>data</i> (dict)</dt> |
| 171 <dd> | 221 <dd> |
| 172 dictionary containing the change data | 222 dictionary containing the change data |
| 173 </dd> | 223 </dd> |
| 174 </dl> | 224 </dl> |
