Mercurial Repositories > Rope Refactoring / file comparison
comparison: RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.ChangeSignatureDialog.html
RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.ChangeSignatureDialog.html
- changeset 17
- a0fac63ef73f
- child 44
- 8aa985c8dee5
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.ChangeSignatureDialog</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.ChangeSignatureDialog</h1> | |
| 24 <p> | |
| 25 Module implementing the Change Signature dialog. | |
| 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="#ChangeSignatureDialog">ChangeSignatureDialog</a></td> | |
| 35 <td>Class implementing the Change Signature dialog.</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="ChangeSignatureDialog" ID="ChangeSignatureDialog"></a> | |
| 44 <h2>ChangeSignatureDialog</h2> | |
| 45 <p> | |
| 46 Class implementing the Change Signature dialog. | |
| 47 </p> | |
| 48 <h3>Derived from</h3> | |
| 49 RefactoringDialogBase, Ui_ChangeSignatureDialog | |
| 50 <h3>Class Attributes</h3> | |
| 51 <table> | |
| 52 <tr><td>DefaultRole</td></tr><tr><td>IsAddedRole</td></tr><tr><td>NameRole</td></tr><tr><td>ValueRole</td></tr> | |
| 53 </table> | |
| 54 <h3>Methods</h3> | |
| 55 <table> | |
| 56 <tr> | |
| 57 <td><a href="#ChangeSignatureDialog.__init__">ChangeSignatureDialog</a></td> | |
| 58 <td>Constructor</td> | |
| 59 </tr><tr> | |
| 60 <td><a href="#ChangeSignatureDialog.__getParameterIndex">__getParameterIndex</a></td> | |
| 61 <td>Private method to calculate the index of the given paramter.</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#ChangeSignatureDialog._calculateChanges">_calculateChanges</a></td> | |
| 64 <td>Protected method to calculate the changes.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#ChangeSignatureDialog.on_addButton_clicked">on_addButton_clicked</a></td> | |
| 67 <td>Private slot to add a new parameter.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#ChangeSignatureDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | |
| 70 <td>Private slot to act on the button pressed.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#ChangeSignatureDialog.on_downButton_clicked">on_downButton_clicked</a></td> | |
| 73 <td>Private slot called to move the selected item down in the list.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#ChangeSignatureDialog.on_parameterList_currentRowChanged">on_parameterList_currentRowChanged</a></td> | |
| 76 <td>Private slot called, when the current row is changed.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#ChangeSignatureDialog.on_removeButton_clicked">on_removeButton_clicked</a></td> | |
| 79 <td>Private slot to remove a parameter.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#ChangeSignatureDialog.on_upButton_clicked">on_upButton_clicked</a></td> | |
| 82 <td>Private slot called to move the selected item up in the list.</td> | |
| 83 </tr> | |
| 84 </table> | |
| 85 <a NAME="ChangeSignatureDialog.__init__" ID="ChangeSignatureDialog.__init__"></a> | |
| 86 <h4>ChangeSignatureDialog (Constructor)</h4> | |
| 87 <b>ChangeSignatureDialog</b>(<i>refactoring, title, changer, parent=None</i>) | |
| 88 <p> | |
| 89 Constructor | |
| 90 </p><dl> | |
| 91 <dt><i>refactoring</i></dt> | |
| 92 <dd> | |
| 93 reference to the main refactoring object | |
| 94 (Refactoring) | |
| 95 </dd><dt><i>title</i></dt> | |
| 96 <dd> | |
| 97 title of the dialog (string) | |
| 98 </dd><dt><i>changer</i></dt> | |
| 99 <dd> | |
| 100 reference to the signature changer object | |
| 101 (rope.refactor.change_signature.ChangeSignature) | |
| 102 </dd><dt><i>parent</i></dt> | |
| 103 <dd> | |
| 104 reference to the parent widget (QWidget) | |
| 105 </dd> | |
| 106 </dl><a NAME="ChangeSignatureDialog.__getParameterIndex" ID="ChangeSignatureDialog.__getParameterIndex"></a> | |
| 107 <h4>ChangeSignatureDialog.__getParameterIndex</h4> | |
| 108 <b>__getParameterIndex</b>(<i>definition_info, name</i>) | |
| 109 <p> | |
| 110 Private method to calculate the index of the given paramter. | |
| 111 </p><dl> | |
| 112 <dt><i>definition_info</i></dt> | |
| 113 <dd> | |
| 114 object containing the method definition | |
| 115 </dd><dt><i>name</i></dt> | |
| 116 <dd> | |
| 117 parameter name (string) | |
| 118 </dd> | |
| 119 </dl><dl> | |
| 120 <dt>Returns:</dt> | |
| 121 <dd> | |
| 122 index of the parameter (integer) | |
| 123 </dd> | |
| 124 </dl><a NAME="ChangeSignatureDialog._calculateChanges" ID="ChangeSignatureDialog._calculateChanges"></a> | |
| 125 <h4>ChangeSignatureDialog._calculateChanges</h4> | |
| 126 <b>_calculateChanges</b>(<i>handle</i>) | |
| 127 <p> | |
| 128 Protected method to calculate the changes. | |
| 129 </p><dl> | |
| 130 <dt><i>handle</i></dt> | |
| 131 <dd> | |
| 132 reference to the task handle | |
| 133 (rope.base.taskhandle.TaskHandle) | |
| 134 </dd> | |
| 135 </dl><dl> | |
| 136 <dt>Returns:</dt> | |
| 137 <dd> | |
| 138 reference to the Changes object (rope.base.change.ChangeSet) | |
| 139 </dd> | |
| 140 </dl><a NAME="ChangeSignatureDialog.on_addButton_clicked" ID="ChangeSignatureDialog.on_addButton_clicked"></a> | |
| 141 <h4>ChangeSignatureDialog.on_addButton_clicked</h4> | |
| 142 <b>on_addButton_clicked</b>(<i></i>) | |
| 143 <p> | |
| 144 Private slot to add a new parameter. | |
| 145 </p><a NAME="ChangeSignatureDialog.on_buttonBox_clicked" ID="ChangeSignatureDialog.on_buttonBox_clicked"></a> | |
| 146 <h4>ChangeSignatureDialog.on_buttonBox_clicked</h4> | |
| 147 <b>on_buttonBox_clicked</b>(<i>button</i>) | |
| 148 <p> | |
| 149 Private slot to act on the button pressed. | |
| 150 </p><dl> | |
| 151 <dt><i>button</i></dt> | |
| 152 <dd> | |
| 153 reference to the button pressed (QAbstractButton) | |
| 154 </dd> | |
| 155 </dl><a NAME="ChangeSignatureDialog.on_downButton_clicked" ID="ChangeSignatureDialog.on_downButton_clicked"></a> | |
| 156 <h4>ChangeSignatureDialog.on_downButton_clicked</h4> | |
| 157 <b>on_downButton_clicked</b>(<i></i>) | |
| 158 <p> | |
| 159 Private slot called to move the selected item down in the list. | |
| 160 </p><a NAME="ChangeSignatureDialog.on_parameterList_currentRowChanged" ID="ChangeSignatureDialog.on_parameterList_currentRowChanged"></a> | |
| 161 <h4>ChangeSignatureDialog.on_parameterList_currentRowChanged</h4> | |
| 162 <b>on_parameterList_currentRowChanged</b>(<i>currentRow</i>) | |
| 163 <p> | |
| 164 Private slot called, when the current row is changed. | |
| 165 </p><dl> | |
| 166 <dt><i>currentRow</i></dt> | |
| 167 <dd> | |
| 168 index of the current row (integer) | |
| 169 </dd> | |
| 170 </dl><a NAME="ChangeSignatureDialog.on_removeButton_clicked" ID="ChangeSignatureDialog.on_removeButton_clicked"></a> | |
| 171 <h4>ChangeSignatureDialog.on_removeButton_clicked</h4> | |
| 172 <b>on_removeButton_clicked</b>(<i></i>) | |
| 173 <p> | |
| 174 Private slot to remove a parameter. | |
| 175 </p><a NAME="ChangeSignatureDialog.on_upButton_clicked" ID="ChangeSignatureDialog.on_upButton_clicked"></a> | |
| 176 <h4>ChangeSignatureDialog.on_upButton_clicked</h4> | |
| 177 <b>on_upButton_clicked</b>(<i></i>) | |
| 178 <p> | |
| 179 Private slot called to move the selected item up in the list. | |
| 180 </p> | |
| 181 <div align="right"><a href="#top">Up</a></div> | |
| 182 <hr /> | |
| 183 </body></html> |
