Mercurial Repositories > Rope Refactoring / file comparison
comparison: RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.UseFunctionDialog.html
RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.UseFunctionDialog.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.UseFunctionDialog</h1> | 23 <h1>Plugin_Refactoring_Rope.RefactoringRope.UseFunctionDialog</h1> |
| 24 | |
| 23 <p> | 25 <p> |
| 24 Module implementing the Use Function dialog. | 26 Module implementing the Use Function 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> |
| 34 | |
| 31 <table> | 35 <table> |
| 36 | |
| 32 <tr> | 37 <tr> |
| 33 <td><a href="#UseFunctionDialog">UseFunctionDialog</a></td> | 38 <td><a href="#UseFunctionDialog">UseFunctionDialog</a></td> |
| 34 <td>Class implementing the Use Function dialog.</td> | 39 <td>Class implementing the Use Function dialog.</td> |
| 35 </tr> | 40 </tr> |
| 36 </table> | 41 </table> |
| 37 <h3>Functions</h3> | 42 <h3>Functions</h3> |
| 43 | |
| 38 <table> | 44 <table> |
| 39 <tr><td>None</td></tr> | 45 <tr><td>None</td></tr> |
| 40 </table> | 46 </table> |
| 41 <hr /><hr /> | 47 <hr /> |
| 48 <hr /> | |
| 42 <a NAME="UseFunctionDialog" ID="UseFunctionDialog"></a> | 49 <a NAME="UseFunctionDialog" ID="UseFunctionDialog"></a> |
| 43 <h2>UseFunctionDialog</h2> | 50 <h2>UseFunctionDialog</h2> |
| 51 | |
| 44 <p> | 52 <p> |
| 45 Class implementing the Use Function dialog. | 53 Class implementing the Use Function dialog. |
| 46 </p> | 54 </p> |
| 47 <h3>Derived from</h3> | 55 <h3>Derived from</h3> |
| 48 RefactoringDialogBase, Ui_UseFunctionDialog | 56 RefactoringDialogBase, Ui_UseFunctionDialog |
| 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> |
| 68 | |
| 58 <table> | 69 <table> |
| 70 | |
| 59 <tr> | 71 <tr> |
| 60 <td><a href="#UseFunctionDialog.__init__">UseFunctionDialog</a></td> | 72 <td><a href="#UseFunctionDialog.__init__">UseFunctionDialog</a></td> |
| 61 <td>Constructor</td> | 73 <td>Constructor</td> |
| 62 </tr><tr> | 74 </tr> |
| 75 <tr> | |
| 63 <td><a href="#UseFunctionDialog.__processUseFunctionName">__processUseFunctionName</a></td> | 76 <td><a href="#UseFunctionDialog.__processUseFunctionName">__processUseFunctionName</a></td> |
| 64 <td>Private method to process the function name data sent by the refactoring client in order to polish the dialog.</td> | 77 <td>Private method to process the function name data sent by the refactoring client in order to polish the dialog.</td> |
| 65 </tr><tr> | 78 </tr> |
| 79 <tr> | |
| 66 <td><a href="#UseFunctionDialog._calculateChanges">_calculateChanges</a></td> | 80 <td><a href="#UseFunctionDialog._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="#UseFunctionDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | 84 <td><a href="#UseFunctionDialog.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="#UseFunctionDialog.processChangeData">processChangeData</a></td> | 88 <td><a href="#UseFunctionDialog.processChangeData">processChangeData</a></td> |
| 73 <td>Public method to process the change data sent by the refactoring client.</td> | 89 <td>Public method to process the change data sent by the refactoring client.</td> |
| 74 </tr> | 90 </tr> |
| 75 </table> | 91 </table> |
| 76 <h3>Static Methods</h3> | 92 <h3>Static Methods</h3> |
| 93 | |
| 77 <table> | 94 <table> |
| 78 <tr><td>None</td></tr> | 95 <tr><td>None</td></tr> |
| 79 </table> | 96 </table> |
| 97 | |
| 80 <a NAME="UseFunctionDialog.__init__" ID="UseFunctionDialog.__init__"></a> | 98 <a NAME="UseFunctionDialog.__init__" ID="UseFunctionDialog.__init__"></a> |
| 81 <h4>UseFunctionDialog (Constructor)</h4> | 99 <h4>UseFunctionDialog (Constructor)</h4> |
| 82 <b>UseFunctionDialog</b>(<i>refactoring, title, filename, offset, parent=None</i>) | 100 <b>UseFunctionDialog</b>(<i>refactoring, title, filename, offset, parent=None</i>) |
| 101 | |
| 83 <p> | 102 <p> |
| 84 Constructor | 103 Constructor |
| 85 </p><dl> | 104 </p> |
| 105 <dl> | |
| 106 | |
| 86 <dt><i>refactoring</i> (RefactoringServer)</dt> | 107 <dt><i>refactoring</i> (RefactoringServer)</dt> |
| 87 <dd> | 108 <dd> |
| 88 reference to the main refactoring object | 109 reference to the main refactoring object |
| 89 </dd><dt><i>title</i> (str)</dt> | 110 </dd> |
| 111 <dt><i>title</i> (str)</dt> | |
| 90 <dd> | 112 <dd> |
| 91 title of the dialog | 113 title of the dialog |
| 92 </dd><dt><i>filename</i> (str)</dt> | 114 </dd> |
| 115 <dt><i>filename</i> (str)</dt> | |
| 93 <dd> | 116 <dd> |
| 94 file name to be worked on | 117 file name to be worked on |
| 95 </dd><dt><i>offset</i> (int or None)</dt> | 118 </dd> |
| 119 <dt><i>offset</i> (int or None)</dt> | |
| 96 <dd> | 120 <dd> |
| 97 offset within file | 121 offset within file |
| 98 </dd><dt><i>parent</i> (QWidget)</dt> | 122 </dd> |
| 123 <dt><i>parent</i> (QWidget)</dt> | |
| 99 <dd> | 124 <dd> |
| 100 reference to the parent widget | 125 reference to the parent widget |
| 101 </dd> | 126 </dd> |
| 102 </dl><a NAME="UseFunctionDialog.__processUseFunctionName" ID="UseFunctionDialog.__processUseFunctionName"></a> | 127 </dl> |
| 128 <a NAME="UseFunctionDialog.__processUseFunctionName" ID="UseFunctionDialog.__processUseFunctionName"></a> | |
| 103 <h4>UseFunctionDialog.__processUseFunctionName</h4> | 129 <h4>UseFunctionDialog.__processUseFunctionName</h4> |
| 104 <b>__processUseFunctionName</b>(<i>data</i>) | 130 <b>__processUseFunctionName</b>(<i>data</i>) |
| 131 | |
| 105 <p> | 132 <p> |
| 106 Private method to process the function name data sent by the | 133 Private method to process the function name data sent by the |
| 107 refactoring client in order to polish the dialog. | 134 refactoring client in order to polish the dialog. |
| 108 </p><dl> | 135 </p> |
| 136 <dl> | |
| 137 | |
| 109 <dt><i>data</i> (dict)</dt> | 138 <dt><i>data</i> (dict)</dt> |
| 110 <dd> | 139 <dd> |
| 111 dictionary containing the inline type data | 140 dictionary containing the inline type data |
| 112 </dd> | 141 </dd> |
| 113 </dl><a NAME="UseFunctionDialog._calculateChanges" ID="UseFunctionDialog._calculateChanges"></a> | 142 </dl> |
| 143 <a NAME="UseFunctionDialog._calculateChanges" ID="UseFunctionDialog._calculateChanges"></a> | |
| 114 <h4>UseFunctionDialog._calculateChanges</h4> | 144 <h4>UseFunctionDialog._calculateChanges</h4> |
| 115 <b>_calculateChanges</b>(<i></i>) | 145 <b>_calculateChanges</b>(<i></i>) |
| 146 | |
| 116 <p> | 147 <p> |
| 117 Protected method to initiate the calculation of the changes. | 148 Protected method to initiate the calculation of the changes. |
| 118 </p><a NAME="UseFunctionDialog.on_buttonBox_clicked" ID="UseFunctionDialog.on_buttonBox_clicked"></a> | 149 </p> |
| 150 <a NAME="UseFunctionDialog.on_buttonBox_clicked" ID="UseFunctionDialog.on_buttonBox_clicked"></a> | |
| 119 <h4>UseFunctionDialog.on_buttonBox_clicked</h4> | 151 <h4>UseFunctionDialog.on_buttonBox_clicked</h4> |
| 120 <b>on_buttonBox_clicked</b>(<i>button</i>) | 152 <b>on_buttonBox_clicked</b>(<i>button</i>) |
| 153 | |
| 121 <p> | 154 <p> |
| 122 Private slot to act on the button pressed. | 155 Private slot to act on the button pressed. |
| 123 </p><dl> | 156 </p> |
| 157 <dl> | |
| 158 | |
| 124 <dt><i>button</i> (QAbstractButton)</dt> | 159 <dt><i>button</i> (QAbstractButton)</dt> |
| 125 <dd> | 160 <dd> |
| 126 reference to the button pressed | 161 reference to the button pressed |
| 127 </dd> | 162 </dd> |
| 128 </dl><a NAME="UseFunctionDialog.processChangeData" ID="UseFunctionDialog.processChangeData"></a> | 163 </dl> |
| 164 <a NAME="UseFunctionDialog.processChangeData" ID="UseFunctionDialog.processChangeData"></a> | |
| 129 <h4>UseFunctionDialog.processChangeData</h4> | 165 <h4>UseFunctionDialog.processChangeData</h4> |
| 130 <b>processChangeData</b>(<i>data</i>) | 166 <b>processChangeData</b>(<i>data</i>) |
| 167 | |
| 131 <p> | 168 <p> |
| 132 Public method to process the change data sent by the refactoring | 169 Public method to process the change data sent by the refactoring |
| 133 client. | 170 client. |
| 134 </p><dl> | 171 </p> |
| 172 <dl> | |
| 173 | |
| 135 <dt><i>data</i> (dict)</dt> | 174 <dt><i>data</i> (dict)</dt> |
| 136 <dd> | 175 <dd> |
| 137 dictionary containing the change data | 176 dictionary containing the change data |
| 138 </dd> | 177 </dd> |
| 139 </dl> | 178 </dl> |
