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
- branch
- server_client_variant
- changeset 204
- b4bf79b956bc
- parent 44
- 8aa985c8dee5
- child 321
- d51e810107ec
equal
deleted
inserted
replaced
| 203:c38750e1bafd | 204:b4bf79b956bc |
|---|---|
| 19 </style> | 19 </style> |
| 20 </head> | 20 </head> |
| 21 <body><a NAME="top" ID="top"></a> | 21 <body><a NAME="top" ID="top"></a> |
| 22 <h1>Plugin_Refactoring_Rope.RefactoringRope.UseFunctionDialog</h1> | 22 <h1>Plugin_Refactoring_Rope.RefactoringRope.UseFunctionDialog</h1> |
| 23 <p> | 23 <p> |
| 24 Module implementing the Inline dialog. | 24 Module implementing the Use Function dialog. |
| 25 </p> | 25 </p> |
| 26 <h3>Global Attributes</h3> | 26 <h3>Global Attributes</h3> |
| 27 <table> | 27 <table> |
| 28 <tr><td>None</td></tr> | 28 <tr><td>None</td></tr> |
| 29 </table> | 29 </table> |
| 30 <h3>Classes</h3> | 30 <h3>Classes</h3> |
| 31 <table> | 31 <table> |
| 32 <tr> | 32 <tr> |
| 33 <td><a href="#UseFunctionDialog">UseFunctionDialog</a></td> | 33 <td><a href="#UseFunctionDialog">UseFunctionDialog</a></td> |
| 34 <td>Class implementing the Inline dialog.</td> | 34 <td>Class implementing the Use Function dialog.</td> |
| 35 </tr> | 35 </tr> |
| 36 </table> | 36 </table> |
| 37 <h3>Functions</h3> | 37 <h3>Functions</h3> |
| 38 <table> | 38 <table> |
| 39 <tr><td>None</td></tr> | 39 <tr><td>None</td></tr> |
| 40 </table> | 40 </table> |
| 41 <hr /><hr /> | 41 <hr /><hr /> |
| 42 <a NAME="UseFunctionDialog" ID="UseFunctionDialog"></a> | 42 <a NAME="UseFunctionDialog" ID="UseFunctionDialog"></a> |
| 43 <h2>UseFunctionDialog</h2> | 43 <h2>UseFunctionDialog</h2> |
| 44 <p> | 44 <p> |
| 45 Class implementing the Inline dialog. | 45 Class implementing the Use Function dialog. |
| 46 </p> | 46 </p> |
| 47 <h3>Derived from</h3> | 47 <h3>Derived from</h3> |
| 48 RefactoringDialogBase, Ui_UseFunctionDialog | 48 RefactoringDialogBase, Ui_UseFunctionDialog |
| 49 <h3>Class Attributes</h3> | 49 <h3>Class Attributes</h3> |
| 50 <table> | 50 <table> |
| 58 <table> | 58 <table> |
| 59 <tr> | 59 <tr> |
| 60 <td><a href="#UseFunctionDialog.__init__">UseFunctionDialog</a></td> | 60 <td><a href="#UseFunctionDialog.__init__">UseFunctionDialog</a></td> |
| 61 <td>Constructor</td> | 61 <td>Constructor</td> |
| 62 </tr><tr> | 62 </tr><tr> |
| 63 <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> | |
| 65 </tr><tr> | |
| 63 <td><a href="#UseFunctionDialog._calculateChanges">_calculateChanges</a></td> | 66 <td><a href="#UseFunctionDialog._calculateChanges">_calculateChanges</a></td> |
| 64 <td>Protected method to calculate the changes.</td> | 67 <td>Protected method to initiate the calculation of the changes.</td> |
| 65 </tr><tr> | 68 </tr><tr> |
| 66 <td><a href="#UseFunctionDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | 69 <td><a href="#UseFunctionDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> |
| 67 <td>Private slot to act on the button pressed.</td> | 70 <td>Private slot to act on the button pressed.</td> |
| 71 </tr><tr> | |
| 72 <td><a href="#UseFunctionDialog.processChangeData">processChangeData</a></td> | |
| 73 <td>Public method to process the change data sent by the refactoring client.</td> | |
| 68 </tr> | 74 </tr> |
| 69 </table> | 75 </table> |
| 70 <h3>Static Methods</h3> | 76 <h3>Static Methods</h3> |
| 71 <table> | 77 <table> |
| 72 <tr><td>None</td></tr> | 78 <tr><td>None</td></tr> |
| 73 </table> | 79 </table> |
| 74 <a NAME="UseFunctionDialog.__init__" ID="UseFunctionDialog.__init__"></a> | 80 <a NAME="UseFunctionDialog.__init__" ID="UseFunctionDialog.__init__"></a> |
| 75 <h4>UseFunctionDialog (Constructor)</h4> | 81 <h4>UseFunctionDialog (Constructor)</h4> |
| 76 <b>UseFunctionDialog</b>(<i>refactoring, title, user, parent=None</i>) | 82 <b>UseFunctionDialog</b>(<i>refactoring, title, filename, offset, parent=None</i>) |
| 77 <p> | 83 <p> |
| 78 Constructor | 84 Constructor |
| 79 </p><dl> | 85 </p><dl> |
| 80 <dt><i>refactoring</i></dt> | 86 <dt><i>refactoring</i> (RefactoringServer)</dt> |
| 81 <dd> | 87 <dd> |
| 82 reference to the main refactoring object | 88 reference to the main refactoring object |
| 83 (Refactoring) | 89 </dd><dt><i>title</i> (str)</dt> |
| 84 </dd><dt><i>title</i></dt> | |
| 85 <dd> | 90 <dd> |
| 86 title of the dialog (string) | 91 title of the dialog |
| 87 </dd><dt><i>user</i></dt> | 92 </dd><dt><i>filename</i> (str)</dt> |
| 88 <dd> | 93 <dd> |
| 89 reference to the usefunction object | 94 file name to be worked on |
| 90 (rope.refactor.usefunction.UseFunction) | 95 </dd><dt><i>offset</i> (int or None)</dt> |
| 91 </dd><dt><i>parent</i></dt> | |
| 92 <dd> | 96 <dd> |
| 93 reference to the parent widget (QWidget) | 97 offset within file |
| 98 </dd><dt><i>parent</i> (QWidget)</dt> | |
| 99 <dd> | |
| 100 reference to the parent widget | |
| 101 </dd> | |
| 102 </dl><a NAME="UseFunctionDialog.__processUseFunctionName" ID="UseFunctionDialog.__processUseFunctionName"></a> | |
| 103 <h4>UseFunctionDialog.__processUseFunctionName</h4> | |
| 104 <b>__processUseFunctionName</b>(<i>data</i>) | |
| 105 <p> | |
| 106 Private method to process the function name data sent by the | |
| 107 refactoring client in order to polish the dialog. | |
| 108 </p><dl> | |
| 109 <dt><i>data</i> (dict)</dt> | |
| 110 <dd> | |
| 111 dictionary containing the inline type data | |
| 94 </dd> | 112 </dd> |
| 95 </dl><a NAME="UseFunctionDialog._calculateChanges" ID="UseFunctionDialog._calculateChanges"></a> | 113 </dl><a NAME="UseFunctionDialog._calculateChanges" ID="UseFunctionDialog._calculateChanges"></a> |
| 96 <h4>UseFunctionDialog._calculateChanges</h4> | 114 <h4>UseFunctionDialog._calculateChanges</h4> |
| 97 <b>_calculateChanges</b>(<i>handle</i>) | 115 <b>_calculateChanges</b>(<i></i>) |
| 98 <p> | 116 <p> |
| 99 Protected method to calculate the changes. | 117 Protected method to initiate the calculation of the changes. |
| 100 </p><dl> | 118 </p><a NAME="UseFunctionDialog.on_buttonBox_clicked" ID="UseFunctionDialog.on_buttonBox_clicked"></a> |
| 101 <dt><i>handle</i></dt> | |
| 102 <dd> | |
| 103 reference to the task handle | |
| 104 (rope.base.taskhandle.TaskHandle) | |
| 105 </dd> | |
| 106 </dl><dl> | |
| 107 <dt>Returns:</dt> | |
| 108 <dd> | |
| 109 reference to the Changes object (rope.base.change.ChangeSet) | |
| 110 </dd> | |
| 111 </dl><a NAME="UseFunctionDialog.on_buttonBox_clicked" ID="UseFunctionDialog.on_buttonBox_clicked"></a> | |
| 112 <h4>UseFunctionDialog.on_buttonBox_clicked</h4> | 119 <h4>UseFunctionDialog.on_buttonBox_clicked</h4> |
| 113 <b>on_buttonBox_clicked</b>(<i>button</i>) | 120 <b>on_buttonBox_clicked</b>(<i>button</i>) |
| 114 <p> | 121 <p> |
| 115 Private slot to act on the button pressed. | 122 Private slot to act on the button pressed. |
| 116 </p><dl> | 123 </p><dl> |
| 117 <dt><i>button</i></dt> | 124 <dt><i>button</i> (QAbstractButton)</dt> |
| 118 <dd> | 125 <dd> |
| 119 reference to the button pressed (QAbstractButton) | 126 reference to the button pressed |
| 127 </dd> | |
| 128 </dl><a NAME="UseFunctionDialog.processChangeData" ID="UseFunctionDialog.processChangeData"></a> | |
| 129 <h4>UseFunctionDialog.processChangeData</h4> | |
| 130 <b>processChangeData</b>(<i>data</i>) | |
| 131 <p> | |
| 132 Public method to process the change data sent by the refactoring | |
| 133 client. | |
| 134 </p><dl> | |
| 135 <dt><i>data</i> (dict)</dt> | |
| 136 <dd> | |
| 137 dictionary containing the change data | |
| 120 </dd> | 138 </dd> |
| 121 </dl> | 139 </dl> |
| 122 <div align="right"><a href="#top">Up</a></div> | 140 <div align="right"><a href="#top">Up</a></div> |
| 123 <hr /> | 141 <hr /> |
| 124 </body></html> | 142 </body></html> |
