|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>Plugin_Project_Django.ProjectDjango.DjangoMigrationsListDialog</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><a NAME="top" ID="top"></a> |
|
22 <h1>Plugin_Project_Django.ProjectDjango.DjangoMigrationsListDialog</h1> |
|
23 <p> |
|
24 Module implementing a dialog show a list of all available migrations. |
|
25 </p> |
|
26 <h3>Global Attributes</h3> |
|
27 <table> |
|
28 <tr><td>None</td></tr> |
|
29 </table> |
|
30 <h3>Classes</h3> |
|
31 <table> |
|
32 <tr> |
|
33 <td><a href="#DjangoMigrationsListDialog">DjangoMigrationsListDialog</a></td> |
|
34 <td>Class implementing a dialog show a list of all available migrations.</td> |
|
35 </tr> |
|
36 </table> |
|
37 <h3>Functions</h3> |
|
38 <table> |
|
39 <tr><td>None</td></tr> |
|
40 </table> |
|
41 <hr /><hr /> |
|
42 <a NAME="DjangoMigrationsListDialog" ID="DjangoMigrationsListDialog"></a> |
|
43 <h2>DjangoMigrationsListDialog</h2> |
|
44 <p> |
|
45 Class implementing a dialog show a list of all available migrations. |
|
46 </p> |
|
47 <h3>Derived from</h3> |
|
48 QDialog, Ui_DjangoMigrationsListDialog |
|
49 <h3>Class Attributes</h3> |
|
50 <table> |
|
51 <tr><td>MigrationsListMode</td></tr><tr><td>MigrationsPlanMode</td></tr> |
|
52 </table> |
|
53 <h3>Class Methods</h3> |
|
54 <table> |
|
55 <tr><td>None</td></tr> |
|
56 </table> |
|
57 <h3>Methods</h3> |
|
58 <table> |
|
59 <tr> |
|
60 <td><a href="#DjangoMigrationsListDialog.__init__">DjangoMigrationsListDialog</a></td> |
|
61 <td>Constructor</td> |
|
62 </tr><tr> |
|
63 <td><a href="#DjangoMigrationsListDialog.__applyAllMigrations">__applyAllMigrations</a></td> |
|
64 <td>Private slot to apply all migrations.</td> |
|
65 </tr><tr> |
|
66 <td><a href="#DjangoMigrationsListDialog.__applyMigration">__applyMigration</a></td> |
|
67 <td>Private slot to apply the selected migrations.</td> |
|
68 </tr><tr> |
|
69 <td><a href="#DjangoMigrationsListDialog.__createListItem">__createListItem</a></td> |
|
70 <td>Private method to create an item for list mode.</td> |
|
71 </tr><tr> |
|
72 <td><a href="#DjangoMigrationsListDialog.__createPlanItem">__createPlanItem</a></td> |
|
73 <td>Private method to create an item for plan mode.</td> |
|
74 </tr><tr> |
|
75 <td><a href="#DjangoMigrationsListDialog.__finish">__finish</a></td> |
|
76 <td>Private slot called when the process finished or the user pressed the button.</td> |
|
77 </tr><tr> |
|
78 <td><a href="#DjangoMigrationsListDialog.__makeMigrations">__makeMigrations</a></td> |
|
79 <td>Private slot to make migrations for the selected apps.</td> |
|
80 </tr><tr> |
|
81 <td><a href="#DjangoMigrationsListDialog.__procFinished">__procFinished</a></td> |
|
82 <td>Private slot connected to the finished signal.</td> |
|
83 </tr><tr> |
|
84 <td><a href="#DjangoMigrationsListDialog.__readStderr">__readStderr</a></td> |
|
85 <td>Private slot to handle the readyReadStderr signal.</td> |
|
86 </tr><tr> |
|
87 <td><a href="#DjangoMigrationsListDialog.__readStdout">__readStdout</a></td> |
|
88 <td>Private slot to handle the readyReadStdout signal.</td> |
|
89 </tr><tr> |
|
90 <td><a href="#DjangoMigrationsListDialog.__resizeColumns">__resizeColumns</a></td> |
|
91 <td>Private method to resize the list columns.</td> |
|
92 </tr><tr> |
|
93 <td><a href="#DjangoMigrationsListDialog.__unapplyMigration">__unapplyMigration</a></td> |
|
94 <td>Private slot to unapply the selected migrations.</td> |
|
95 </tr><tr> |
|
96 <td><a href="#DjangoMigrationsListDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> |
|
97 <td>Private slot called by a button of the button box clicked.</td> |
|
98 </tr><tr> |
|
99 <td><a href="#DjangoMigrationsListDialog.on_migrationsList_customContextMenuRequested">on_migrationsList_customContextMenuRequested</a></td> |
|
100 <td>Private slot to show the context menu.</td> |
|
101 </tr><tr> |
|
102 <td><a href="#DjangoMigrationsListDialog.on_refreshButton_clicked">on_refreshButton_clicked</a></td> |
|
103 <td>Private slot to refresh the log.</td> |
|
104 </tr><tr> |
|
105 <td><a href="#DjangoMigrationsListDialog.start">start</a></td> |
|
106 <td>Public slot used to start the process.</td> |
|
107 </tr> |
|
108 </table> |
|
109 <h3>Static Methods</h3> |
|
110 <table> |
|
111 <tr><td>None</td></tr> |
|
112 </table> |
|
113 <a NAME="DjangoMigrationsListDialog.__init__" ID="DjangoMigrationsListDialog.__init__"></a> |
|
114 <h4>DjangoMigrationsListDialog (Constructor)</h4> |
|
115 <b>DjangoMigrationsListDialog</b>(<i>mode, django, parent=None</i>) |
|
116 <p> |
|
117 Constructor |
|
118 </p><dl> |
|
119 <dt><i>mode</i> (str)</dt> |
|
120 <dd> |
|
121 mode of the dialog |
|
122 </dd><dt><i>django</i> (Project)</dt> |
|
123 <dd> |
|
124 reference to the Django project object |
|
125 </dd><dt><i>parent</i> (QWidget)</dt> |
|
126 <dd> |
|
127 reference to the parent widget |
|
128 </dd> |
|
129 </dl><a NAME="DjangoMigrationsListDialog.__applyAllMigrations" ID="DjangoMigrationsListDialog.__applyAllMigrations"></a> |
|
130 <h4>DjangoMigrationsListDialog.__applyAllMigrations</h4> |
|
131 <b>__applyAllMigrations</b>(<i></i>) |
|
132 <p> |
|
133 Private slot to apply all migrations. |
|
134 </p><a NAME="DjangoMigrationsListDialog.__applyMigration" ID="DjangoMigrationsListDialog.__applyMigration"></a> |
|
135 <h4>DjangoMigrationsListDialog.__applyMigration</h4> |
|
136 <b>__applyMigration</b>(<i></i>) |
|
137 <p> |
|
138 Private slot to apply the selected migrations. |
|
139 </p><a NAME="DjangoMigrationsListDialog.__createListItem" ID="DjangoMigrationsListDialog.__createListItem"></a> |
|
140 <h4>DjangoMigrationsListDialog.__createListItem</h4> |
|
141 <b>__createListItem</b>(<i>line</i>) |
|
142 <p> |
|
143 Private method to create an item for list mode. |
|
144 </p><dl> |
|
145 <dt><i>line</i> (str)</dt> |
|
146 <dd> |
|
147 line of text |
|
148 </dd> |
|
149 </dl><a NAME="DjangoMigrationsListDialog.__createPlanItem" ID="DjangoMigrationsListDialog.__createPlanItem"></a> |
|
150 <h4>DjangoMigrationsListDialog.__createPlanItem</h4> |
|
151 <b>__createPlanItem</b>(<i>line</i>) |
|
152 <p> |
|
153 Private method to create an item for plan mode. |
|
154 </p><dl> |
|
155 <dt><i>line</i> (str)</dt> |
|
156 <dd> |
|
157 line of text |
|
158 </dd> |
|
159 </dl><a NAME="DjangoMigrationsListDialog.__finish" ID="DjangoMigrationsListDialog.__finish"></a> |
|
160 <h4>DjangoMigrationsListDialog.__finish</h4> |
|
161 <b>__finish</b>(<i></i>) |
|
162 <p> |
|
163 Private slot called when the process finished or the user pressed the |
|
164 button. |
|
165 </p><a NAME="DjangoMigrationsListDialog.__makeMigrations" ID="DjangoMigrationsListDialog.__makeMigrations"></a> |
|
166 <h4>DjangoMigrationsListDialog.__makeMigrations</h4> |
|
167 <b>__makeMigrations</b>(<i>dryRun=False</i>) |
|
168 <p> |
|
169 Private slot to make migrations for the selected apps. |
|
170 </p><dl> |
|
171 <dt><i>dryRun</i> (bool)</dt> |
|
172 <dd> |
|
173 dlag indicating a dry-run |
|
174 </dd> |
|
175 </dl><a NAME="DjangoMigrationsListDialog.__procFinished" ID="DjangoMigrationsListDialog.__procFinished"></a> |
|
176 <h4>DjangoMigrationsListDialog.__procFinished</h4> |
|
177 <b>__procFinished</b>(<i>exitCode, exitStatus</i>) |
|
178 <p> |
|
179 Private slot connected to the finished signal. |
|
180 </p><dl> |
|
181 <dt><i>exitCode</i></dt> |
|
182 <dd> |
|
183 exit code of the process (integer) |
|
184 </dd><dt><i>exitStatus</i></dt> |
|
185 <dd> |
|
186 exit status of the process (QProcess.ExitStatus) |
|
187 </dd> |
|
188 </dl><a NAME="DjangoMigrationsListDialog.__readStderr" ID="DjangoMigrationsListDialog.__readStderr"></a> |
|
189 <h4>DjangoMigrationsListDialog.__readStderr</h4> |
|
190 <b>__readStderr</b>(<i></i>) |
|
191 <p> |
|
192 Private slot to handle the readyReadStderr signal. |
|
193 </p><p> |
|
194 It reads the error output of the process and inserts it into the |
|
195 error pane. |
|
196 </p><a NAME="DjangoMigrationsListDialog.__readStdout" ID="DjangoMigrationsListDialog.__readStdout"></a> |
|
197 <h4>DjangoMigrationsListDialog.__readStdout</h4> |
|
198 <b>__readStdout</b>(<i></i>) |
|
199 <p> |
|
200 Private slot to handle the readyReadStdout signal. |
|
201 </p><p> |
|
202 It reads the output of the process, formats it and inserts it into |
|
203 the contents pane. |
|
204 </p><a NAME="DjangoMigrationsListDialog.__resizeColumns" ID="DjangoMigrationsListDialog.__resizeColumns"></a> |
|
205 <h4>DjangoMigrationsListDialog.__resizeColumns</h4> |
|
206 <b>__resizeColumns</b>(<i></i>) |
|
207 <p> |
|
208 Private method to resize the list columns. |
|
209 </p><a NAME="DjangoMigrationsListDialog.__unapplyMigration" ID="DjangoMigrationsListDialog.__unapplyMigration"></a> |
|
210 <h4>DjangoMigrationsListDialog.__unapplyMigration</h4> |
|
211 <b>__unapplyMigration</b>(<i></i>) |
|
212 <p> |
|
213 Private slot to unapply the selected migrations. |
|
214 </p><a NAME="DjangoMigrationsListDialog.on_buttonBox_clicked" ID="DjangoMigrationsListDialog.on_buttonBox_clicked"></a> |
|
215 <h4>DjangoMigrationsListDialog.on_buttonBox_clicked</h4> |
|
216 <b>on_buttonBox_clicked</b>(<i>button</i>) |
|
217 <p> |
|
218 Private slot called by a button of the button box clicked. |
|
219 </p><dl> |
|
220 <dt><i>button</i> (QAbstractButton)</dt> |
|
221 <dd> |
|
222 button that was clicked |
|
223 </dd> |
|
224 </dl><a NAME="DjangoMigrationsListDialog.on_migrationsList_customContextMenuRequested" ID="DjangoMigrationsListDialog.on_migrationsList_customContextMenuRequested"></a> |
|
225 <h4>DjangoMigrationsListDialog.on_migrationsList_customContextMenuRequested</h4> |
|
226 <b>on_migrationsList_customContextMenuRequested</b>(<i>pos</i>) |
|
227 <p> |
|
228 Private slot to show the context menu. |
|
229 </p><dl> |
|
230 <dt><i>pos</i> (QPoint)</dt> |
|
231 <dd> |
|
232 position the context menu was requested at |
|
233 </dd> |
|
234 </dl><a NAME="DjangoMigrationsListDialog.on_refreshButton_clicked" ID="DjangoMigrationsListDialog.on_refreshButton_clicked"></a> |
|
235 <h4>DjangoMigrationsListDialog.on_refreshButton_clicked</h4> |
|
236 <b>on_refreshButton_clicked</b>(<i></i>) |
|
237 <p> |
|
238 Private slot to refresh the log. |
|
239 </p><a NAME="DjangoMigrationsListDialog.start" ID="DjangoMigrationsListDialog.start"></a> |
|
240 <h4>DjangoMigrationsListDialog.start</h4> |
|
241 <b>start</b>(<i>pythonExecutable, sitePath</i>) |
|
242 <p> |
|
243 Public slot used to start the process. |
|
244 </p><dl> |
|
245 <dt><i>pythonExecutable</i> (str)</dt> |
|
246 <dd> |
|
247 Python executable to be used |
|
248 </dd><dt><i>sitePath</i> (str)</dt> |
|
249 <dd> |
|
250 path of the site |
|
251 </dd> |
|
252 </dl><dl> |
|
253 <dt>Returns:</dt> |
|
254 <dd> |
|
255 flag indicating a successful start of the process (boolean) |
|
256 </dd> |
|
257 </dl> |
|
258 <div align="right"><a href="#top">Up</a></div> |
|
259 <hr /> |
|
260 </body></html> |