ProjectFlask/Documentation/source/Plugin_Project_Flask.ProjectFlask.FlaskMigrateExtension.MigrateSummaryDialog.html

changeset 37
1bd8d19a3aa7
child 39
120f30d7b949
equal deleted inserted replaced
36:548dea93941c 37:1bd8d19a3aa7
1 <!DOCTYPE html>
2 <html><head>
3 <title>Plugin_Project_Flask.ProjectFlask.FlaskMigrateExtension.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_Flask.ProjectFlask.FlaskMigrateExtension.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.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
85 <td>Private slot handling a button press of the button box.</td>
86 </tr>
87 <tr>
88 <td><a href="#MigrateSummaryDialog.on_downgradeButton_clicked">on_downgradeButton_clicked</a></td>
89 <td>Private slot to downgrade to the selected revision.</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_upgradeButton_clicked">on_upgradeButton_clicked</a></td>
97 <td>Private slot to upgrade 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, migrateProject, migrations="", 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>migrateProject</i> (MigrateProject)</dt>
124 <dd>
125 reference to the migrate project extension
126 </dd>
127 <dt><i>migrations</i> (str)</dt>
128 <dd>
129 directory path containing the migrations
130 </dd>
131 <dt><i>parent</i> (QWidget)</dt>
132 <dd>
133 reference to the parent widget
134 </dd>
135 </dl>
136 <a NAME="MigrateSummaryDialog.__cancelProcess" ID="MigrateSummaryDialog.__cancelProcess"></a>
137 <h4>MigrateSummaryDialog.__cancelProcess</h4>
138 <b>__cancelProcess</b>(<i></i>)
139
140 <p>
141 Private slot to terminate the current process.
142 </p>
143 <a NAME="MigrateSummaryDialog.__processOutput" ID="MigrateSummaryDialog.__processOutput"></a>
144 <h4>MigrateSummaryDialog.__processOutput</h4>
145 <b>__processOutput</b>(<i>output</i>)
146
147 <p>
148 Private method to process the flask output and populate the summary
149 list.
150 </p>
151 <dl>
152
153 <dt><i>output</i> (str)</dt>
154 <dd>
155 output of the flask process
156 </dd>
157 </dl>
158 <a NAME="MigrateSummaryDialog.on_buttonBox_clicked" ID="MigrateSummaryDialog.on_buttonBox_clicked"></a>
159 <h4>MigrateSummaryDialog.on_buttonBox_clicked</h4>
160 <b>on_buttonBox_clicked</b>(<i>button</i>)
161
162 <p>
163 Private slot handling a button press of the button box.
164 </p>
165 <dl>
166
167 <dt><i>button</i> (QAbstractButton)</dt>
168 <dd>
169 reference to the pressed button
170 </dd>
171 </dl>
172 <a NAME="MigrateSummaryDialog.on_downgradeButton_clicked" ID="MigrateSummaryDialog.on_downgradeButton_clicked"></a>
173 <h4>MigrateSummaryDialog.on_downgradeButton_clicked</h4>
174 <b>on_downgradeButton_clicked</b>(<i></i>)
175
176 <p>
177 Private slot to downgrade to the selected revision.
178 </p>
179 <a NAME="MigrateSummaryDialog.on_summaryWidget_itemSelectionChanged" ID="MigrateSummaryDialog.on_summaryWidget_itemSelectionChanged"></a>
180 <h4>MigrateSummaryDialog.on_summaryWidget_itemSelectionChanged</h4>
181 <b>on_summaryWidget_itemSelectionChanged</b>(<i></i>)
182
183 <p>
184 Private slot to handle the selection of an entry.
185 </p>
186 <a NAME="MigrateSummaryDialog.on_upgradeButton_clicked" ID="MigrateSummaryDialog.on_upgradeButton_clicked"></a>
187 <h4>MigrateSummaryDialog.on_upgradeButton_clicked</h4>
188 <b>on_upgradeButton_clicked</b>(<i></i>)
189
190 <p>
191 Private slot to upgrade to the selected revision.
192 </p>
193 <a NAME="MigrateSummaryDialog.showSummary" ID="MigrateSummaryDialog.showSummary"></a>
194 <h4>MigrateSummaryDialog.showSummary</h4>
195 <b>showSummary</b>(<i></i>)
196
197 <p>
198 Public method to show the migrations summary.
199 </p>
200 <div align="right"><a href="#top">Up</a></div>
201 <hr />
202 </body></html>

eric ide

mercurial