|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>Plugin_Project_Pyramid.ProjectPyramid.MigrateSummaryDialog</title> |
|
4 <meta charset="UTF-8"> |
|
5 <style> |
|
6 body { |
|
7 background: #EDECE6; |
|
8 margin: 0em 1em 10em 1em; |
|
9 color: black; |
|
10 } |
|
11 |
|
12 h1 { color: white; background: #85774A; } |
|
13 h2 { color: white; background: #85774A; } |
|
14 h3 { color: white; background: #9D936E; } |
|
15 h4 { color: white; background: #9D936E; } |
|
16 |
|
17 a { color: #BA6D36; } |
|
18 |
|
19 </style> |
|
20 </head> |
|
21 <body> |
|
22 <a NAME="top" ID="top"></a> |
|
23 <h1>Plugin_Project_Pyramid.ProjectPyramid.MigrateSummaryDialog</h1> |
|
24 |
|
25 <p> |
|
26 Module implementing a dialog showing a summary of all created.migrations. |
|
27 </p> |
|
28 <h3>Global Attributes</h3> |
|
29 |
|
30 <table> |
|
31 <tr><td>None</td></tr> |
|
32 </table> |
|
33 <h3>Classes</h3> |
|
34 |
|
35 <table> |
|
36 |
|
37 <tr> |
|
38 <td><a href="#MigrateSummaryDialog">MigrateSummaryDialog</a></td> |
|
39 <td>Class implementing a dialog showing a summary of all created.migrations.</td> |
|
40 </tr> |
|
41 </table> |
|
42 <h3>Functions</h3> |
|
43 |
|
44 <table> |
|
45 <tr><td>None</td></tr> |
|
46 </table> |
|
47 <hr /> |
|
48 <hr /> |
|
49 <a NAME="MigrateSummaryDialog" ID="MigrateSummaryDialog"></a> |
|
50 <h2>MigrateSummaryDialog</h2> |
|
51 |
|
52 <p> |
|
53 Class implementing a dialog showing a summary of all created.migrations. |
|
54 </p> |
|
55 <h3>Derived from</h3> |
|
56 QDialog, Ui_MigrateSummaryDialog |
|
57 <h3>Class Attributes</h3> |
|
58 |
|
59 <table> |
|
60 <tr><td>None</td></tr> |
|
61 </table> |
|
62 <h3>Class Methods</h3> |
|
63 |
|
64 <table> |
|
65 <tr><td>None</td></tr> |
|
66 </table> |
|
67 <h3>Methods</h3> |
|
68 |
|
69 <table> |
|
70 |
|
71 <tr> |
|
72 <td><a href="#MigrateSummaryDialog.__init__">MigrateSummaryDialog</a></td> |
|
73 <td>Constructor</td> |
|
74 </tr> |
|
75 <tr> |
|
76 <td><a href="#MigrateSummaryDialog.__cancelProcess">__cancelProcess</a></td> |
|
77 <td>Private slot to terminate the current process.</td> |
|
78 </tr> |
|
79 <tr> |
|
80 <td><a href="#MigrateSummaryDialog.__processOutput">__processOutput</a></td> |
|
81 <td>Private method to process the flask output and populate the summary list.</td> |
|
82 </tr> |
|
83 <tr> |
|
84 <td><a href="#MigrateSummaryDialog.__selectItem">__selectItem</a></td> |
|
85 <td>Private method to select an item given its revision.</td> |
|
86 </tr> |
|
87 <tr> |
|
88 <td><a href="#MigrateSummaryDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> |
|
89 <td>Private slot handling a button press of the button box.</td> |
|
90 </tr> |
|
91 <tr> |
|
92 <td><a href="#MigrateSummaryDialog.on_summaryWidget_itemSelectionChanged">on_summaryWidget_itemSelectionChanged</a></td> |
|
93 <td>Private slot to handle the selection of an entry.</td> |
|
94 </tr> |
|
95 <tr> |
|
96 <td><a href="#MigrateSummaryDialog.on_upDownButton_clicked">on_upDownButton_clicked</a></td> |
|
97 <td>Private slot to upgrade/downgrade to the selected revision.</td> |
|
98 </tr> |
|
99 <tr> |
|
100 <td><a href="#MigrateSummaryDialog.showSummary">showSummary</a></td> |
|
101 <td>Public method to show the migrations summary.</td> |
|
102 </tr> |
|
103 </table> |
|
104 <h3>Static Methods</h3> |
|
105 |
|
106 <table> |
|
107 <tr><td>None</td></tr> |
|
108 </table> |
|
109 |
|
110 <a NAME="MigrateSummaryDialog.__init__" ID="MigrateSummaryDialog.__init__"></a> |
|
111 <h4>MigrateSummaryDialog (Constructor)</h4> |
|
112 <b>MigrateSummaryDialog</b>(<i>project, parent=None</i>) |
|
113 |
|
114 <p> |
|
115 Constructor |
|
116 </p> |
|
117 <dl> |
|
118 |
|
119 <dt><i>project</i> (Project)</dt> |
|
120 <dd> |
|
121 reference to the project object |
|
122 </dd> |
|
123 <dt><i>parent</i> (QWidget)</dt> |
|
124 <dd> |
|
125 reference to the parent widget |
|
126 </dd> |
|
127 </dl> |
|
128 <a NAME="MigrateSummaryDialog.__cancelProcess" ID="MigrateSummaryDialog.__cancelProcess"></a> |
|
129 <h4>MigrateSummaryDialog.__cancelProcess</h4> |
|
130 <b>__cancelProcess</b>(<i></i>) |
|
131 |
|
132 <p> |
|
133 Private slot to terminate the current process. |
|
134 </p> |
|
135 <a NAME="MigrateSummaryDialog.__processOutput" ID="MigrateSummaryDialog.__processOutput"></a> |
|
136 <h4>MigrateSummaryDialog.__processOutput</h4> |
|
137 <b>__processOutput</b>(<i>output</i>) |
|
138 |
|
139 <p> |
|
140 Private method to process the flask output and populate the summary |
|
141 list. |
|
142 </p> |
|
143 <dl> |
|
144 |
|
145 <dt><i>output</i> (str)</dt> |
|
146 <dd> |
|
147 output of the flask process |
|
148 </dd> |
|
149 </dl> |
|
150 <a NAME="MigrateSummaryDialog.__selectItem" ID="MigrateSummaryDialog.__selectItem"></a> |
|
151 <h4>MigrateSummaryDialog.__selectItem</h4> |
|
152 <b>__selectItem</b>(<i>revision</i>) |
|
153 |
|
154 <p> |
|
155 Private method to select an item given its revision. |
|
156 </p> |
|
157 <dl> |
|
158 |
|
159 <dt><i>revision</i> (str)</dt> |
|
160 <dd> |
|
161 revision of the item to select |
|
162 </dd> |
|
163 </dl> |
|
164 <a NAME="MigrateSummaryDialog.on_buttonBox_clicked" ID="MigrateSummaryDialog.on_buttonBox_clicked"></a> |
|
165 <h4>MigrateSummaryDialog.on_buttonBox_clicked</h4> |
|
166 <b>on_buttonBox_clicked</b>(<i>button</i>) |
|
167 |
|
168 <p> |
|
169 Private slot handling a button press of the button box. |
|
170 </p> |
|
171 <dl> |
|
172 |
|
173 <dt><i>button</i> (QAbstractButton)</dt> |
|
174 <dd> |
|
175 reference to the pressed button |
|
176 </dd> |
|
177 </dl> |
|
178 <a NAME="MigrateSummaryDialog.on_summaryWidget_itemSelectionChanged" ID="MigrateSummaryDialog.on_summaryWidget_itemSelectionChanged"></a> |
|
179 <h4>MigrateSummaryDialog.on_summaryWidget_itemSelectionChanged</h4> |
|
180 <b>on_summaryWidget_itemSelectionChanged</b>(<i></i>) |
|
181 |
|
182 <p> |
|
183 Private slot to handle the selection of an entry. |
|
184 </p> |
|
185 <a NAME="MigrateSummaryDialog.on_upDownButton_clicked" ID="MigrateSummaryDialog.on_upDownButton_clicked"></a> |
|
186 <h4>MigrateSummaryDialog.on_upDownButton_clicked</h4> |
|
187 <b>on_upDownButton_clicked</b>(<i></i>) |
|
188 |
|
189 <p> |
|
190 Private slot to upgrade/downgrade to the selected revision. |
|
191 </p> |
|
192 <a NAME="MigrateSummaryDialog.showSummary" ID="MigrateSummaryDialog.showSummary"></a> |
|
193 <h4>MigrateSummaryDialog.showSummary</h4> |
|
194 <b>showSummary</b>(<i></i>) |
|
195 |
|
196 <p> |
|
197 Public method to show the migrations summary. |
|
198 </p> |
|
199 <div align="right"><a href="#top">Up</a></div> |
|
200 <hr /> |
|
201 </body></html> |