RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.ConfirmationDialog.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.ConfirmationDialog</h1> 23 <h1>Plugin_Refactoring_Rope.RefactoringRope.ConfirmationDialog</h1>
24
23 <p> 25 <p>
24 Module implementing the Confirmation dialog. 26 Module implementing the Confirmation 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="#ConfirmationDialog">ConfirmationDialog</a></td> 38 <td><a href="#ConfirmationDialog">ConfirmationDialog</a></td>
34 <td>Class implementing the Confirmation dialog.</td> 39 <td>Class implementing the Confirmation 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="ConfirmationDialog" ID="ConfirmationDialog"></a> 49 <a NAME="ConfirmationDialog" ID="ConfirmationDialog"></a>
43 <h2>ConfirmationDialog</h2> 50 <h2>ConfirmationDialog</h2>
51
44 <p> 52 <p>
45 Class implementing the Confirmation dialog. 53 Class implementing the Confirmation dialog.
46 </p> 54 </p>
47 <h3>Derived from</h3> 55 <h3>Derived from</h3>
48 RefactoringDialogBase, Ui_ConfirmationDialog 56 RefactoringDialogBase, Ui_ConfirmationDialog
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="#ConfirmationDialog.__init__">ConfirmationDialog</a></td> 72 <td><a href="#ConfirmationDialog.__init__">ConfirmationDialog</a></td>
61 <td>Constructor</td> 73 <td>Constructor</td>
62 </tr><tr> 74 </tr>
75 <tr>
63 <td><a href="#ConfirmationDialog.__processChangeDescription">__processChangeDescription</a></td> 76 <td><a href="#ConfirmationDialog.__processChangeDescription">__processChangeDescription</a></td>
64 <td>Private method to process the change description data sent by the refactoring client in order to polish the dialog.</td> 77 <td>Private method to process the change description data sent by the refactoring client in order to polish the dialog.</td>
65 </tr><tr> 78 </tr>
79 <tr>
66 <td><a href="#ConfirmationDialog._calculateChanges">_calculateChanges</a></td> 80 <td><a href="#ConfirmationDialog._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="#ConfirmationDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> 84 <td><a href="#ConfirmationDialog.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="#ConfirmationDialog.processChangeData">processChangeData</a></td> 88 <td><a href="#ConfirmationDialog.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="ConfirmationDialog.__init__" ID="ConfirmationDialog.__init__"></a> 98 <a NAME="ConfirmationDialog.__init__" ID="ConfirmationDialog.__init__"></a>
81 <h4>ConfirmationDialog (Constructor)</h4> 99 <h4>ConfirmationDialog (Constructor)</h4>
82 <b>ConfirmationDialog</b>(<i>refactoring, title, changeGroupName, method, parameters, parent=None</i>) 100 <b>ConfirmationDialog</b>(<i>refactoring, title, changeGroupName, method, parameters, 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>changeGroupName</i> (str)</dt> 114 </dd>
115 <dt><i>changeGroupName</i> (str)</dt>
93 <dd> 116 <dd>
94 name of the change group 117 name of the change group
95 </dd><dt><i>method</i> (str)</dt> 118 </dd>
119 <dt><i>method</i> (str)</dt>
96 <dd> 120 <dd>
97 method to produce the refactoring changes 121 method to produce the refactoring changes
98 </dd><dt><i>parameters</i> (dict)</dt> 122 </dd>
123 <dt><i>parameters</i> (dict)</dt>
99 <dd> 124 <dd>
100 dictionary containing the method parameters 125 dictionary containing the method parameters
101 </dd><dt><i>parent</i> (QWidget)</dt> 126 </dd>
127 <dt><i>parent</i> (QWidget)</dt>
102 <dd> 128 <dd>
103 reference to the parent widget 129 reference to the parent widget
104 </dd> 130 </dd>
105 </dl><a NAME="ConfirmationDialog.__processChangeDescription" ID="ConfirmationDialog.__processChangeDescription"></a> 131 </dl>
132 <a NAME="ConfirmationDialog.__processChangeDescription" ID="ConfirmationDialog.__processChangeDescription"></a>
106 <h4>ConfirmationDialog.__processChangeDescription</h4> 133 <h4>ConfirmationDialog.__processChangeDescription</h4>
107 <b>__processChangeDescription</b>(<i>data</i>) 134 <b>__processChangeDescription</b>(<i>data</i>)
135
108 <p> 136 <p>
109 Private method to process the change description data sent by the 137 Private method to process the change description data sent by the
110 refactoring client in order to polish the dialog. 138 refactoring client in order to polish the dialog.
111 </p><dl> 139 </p>
140 <dl>
141
112 <dt><i>data</i> (dict)</dt> 142 <dt><i>data</i> (dict)</dt>
113 <dd> 143 <dd>
114 dictionary containing the data 144 dictionary containing the data
115 </dd> 145 </dd>
116 </dl><a NAME="ConfirmationDialog._calculateChanges" ID="ConfirmationDialog._calculateChanges"></a> 146 </dl>
147 <a NAME="ConfirmationDialog._calculateChanges" ID="ConfirmationDialog._calculateChanges"></a>
117 <h4>ConfirmationDialog._calculateChanges</h4> 148 <h4>ConfirmationDialog._calculateChanges</h4>
118 <b>_calculateChanges</b>(<i></i>) 149 <b>_calculateChanges</b>(<i></i>)
150
119 <p> 151 <p>
120 Protected method to initiate the calculation of the changes. 152 Protected method to initiate the calculation of the changes.
121 </p><a NAME="ConfirmationDialog.on_buttonBox_clicked" ID="ConfirmationDialog.on_buttonBox_clicked"></a> 153 </p>
154 <a NAME="ConfirmationDialog.on_buttonBox_clicked" ID="ConfirmationDialog.on_buttonBox_clicked"></a>
122 <h4>ConfirmationDialog.on_buttonBox_clicked</h4> 155 <h4>ConfirmationDialog.on_buttonBox_clicked</h4>
123 <b>on_buttonBox_clicked</b>(<i>button</i>) 156 <b>on_buttonBox_clicked</b>(<i>button</i>)
157
124 <p> 158 <p>
125 Private slot to act on the button pressed. 159 Private slot to act on the button pressed.
126 </p><dl> 160 </p>
161 <dl>
162
127 <dt><i>button</i> (QAbstractButton)</dt> 163 <dt><i>button</i> (QAbstractButton)</dt>
128 <dd> 164 <dd>
129 reference to the button pressed 165 reference to the button pressed
130 </dd> 166 </dd>
131 </dl><a NAME="ConfirmationDialog.processChangeData" ID="ConfirmationDialog.processChangeData"></a> 167 </dl>
168 <a NAME="ConfirmationDialog.processChangeData" ID="ConfirmationDialog.processChangeData"></a>
132 <h4>ConfirmationDialog.processChangeData</h4> 169 <h4>ConfirmationDialog.processChangeData</h4>
133 <b>processChangeData</b>(<i>data</i>) 170 <b>processChangeData</b>(<i>data</i>)
171
134 <p> 172 <p>
135 Public method to process the change data sent by the refactoring 173 Public method to process the change data sent by the refactoring
136 client. 174 client.
137 </p><dl> 175 </p>
176 <dl>
177
138 <dt><i>data</i> (dict)</dt> 178 <dt><i>data</i> (dict)</dt>
139 <dd> 179 <dd>
140 dictionary containing the change data 180 dictionary containing the change data
141 </dd> 181 </dd>
142 </dl> 182 </dl>

eric ide

mercurial