ProjectDjango/Documentation/source/Plugin_Project_Django.ProjectDjango.DjangoCheckOptionsDialog.html

branch
eric7
changeset 198
dd36f90e77ee
parent 176
1395e0583f4e
equal deleted inserted replaced
197:2667e16a3379 198:dd36f90e77ee
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>Plugin_Project_Django.ProjectDjango.DjangoCheckOptionsDialog</h1> 9 <h1>Plugin_Project_Django.ProjectDjango.DjangoCheckOptionsDialog</h1>
10
11 <p> 10 <p>
12 Module implementing a dialog to enter the options for a check operation. 11 Module implementing a dialog to enter the options for a check operation.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15 15 <table>
16 <table> 16 <tr><td>None</td></tr>
17 <tr><td>None</td></tr> 17 </table>
18 </table> 18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#DjangoCheckOptionsDialog">DjangoCheckOptionsDialog</a></td> 22 <td><a href="#DjangoCheckOptionsDialog">DjangoCheckOptionsDialog</a></td>
25 <td>Class implementing a dialog to enter the options for a check operation.</td> 23 <td>Class implementing a dialog to enter the options for a check operation.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29 28 <table>
30 <table> 29 <tr><td>None</td></tr>
31 <tr><td>None</td></tr> 30 </table>
32 </table> 31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="DjangoCheckOptionsDialog" ID="DjangoCheckOptionsDialog"></a> 34 <a NAME="DjangoCheckOptionsDialog" ID="DjangoCheckOptionsDialog"></a>
36 <h2>DjangoCheckOptionsDialog</h2> 35 <h2>DjangoCheckOptionsDialog</h2>
37
38 <p> 36 <p>
39 Class implementing a dialog to enter the options for a check operation. 37 Class implementing a dialog to enter the options for a check operation.
40 </p> 38 </p>
39
41 <h3>Derived from</h3> 40 <h3>Derived from</h3>
42 QDialog, Ui_DjangoCheckOptionsDialog 41 QDialog, Ui_DjangoCheckOptionsDialog
43 <h3>Class Attributes</h3> 42 <h3>Class Attributes</h3>
44 43 <table>
45 <table> 44 <tr><td>None</td></tr>
46 <tr><td>None</td></tr> 45 </table>
47 </table> 46
48 <h3>Class Methods</h3> 47 <h3>Class Methods</h3>
49 48 <table>
50 <table> 49 <tr><td>None</td></tr>
51 <tr><td>None</td></tr> 50 </table>
52 </table> 51
53 <h3>Methods</h3> 52 <h3>Methods</h3>
54 53 <table>
55 <table>
56
57 <tr> 54 <tr>
58 <td><a href="#DjangoCheckOptionsDialog.__init__">DjangoCheckOptionsDialog</a></td> 55 <td><a href="#DjangoCheckOptionsDialog.__init__">DjangoCheckOptionsDialog</a></td>
59 <td>Constructor</td> 56 <td>Constructor</td>
60 </tr> 57 </tr>
61 <tr> 58 <tr>
81 <tr> 78 <tr>
82 <td><a href="#DjangoCheckOptionsDialog.on_settingsFileButton_clicked">on_settingsFileButton_clicked</a></td> 79 <td><a href="#DjangoCheckOptionsDialog.on_settingsFileButton_clicked">on_settingsFileButton_clicked</a></td>
83 <td>Private slot to select a settings file via a file selection dialog.</td> 80 <td>Private slot to select a settings file via a file selection dialog.</td>
84 </tr> 81 </tr>
85 </table> 82 </table>
83
86 <h3>Static Methods</h3> 84 <h3>Static Methods</h3>
87 85 <table>
88 <table> 86 <tr><td>None</td></tr>
89 <tr><td>None</td></tr> 87 </table>
90 </table> 88
91 89
92 <a NAME="DjangoCheckOptionsDialog.__init__" ID="DjangoCheckOptionsDialog.__init__"></a> 90 <a NAME="DjangoCheckOptionsDialog.__init__" ID="DjangoCheckOptionsDialog.__init__"></a>
93 <h4>DjangoCheckOptionsDialog (Constructor)</h4> 91 <h4>DjangoCheckOptionsDialog (Constructor)</h4>
94 <b>DjangoCheckOptionsDialog</b>(<i>python, path, apps, deployMode, parent=None</i>) 92 <b>DjangoCheckOptionsDialog</b>(<i>python, path, apps, deployMode, parent=None</i>)
95
96 <p> 93 <p>
97 Constructor 94 Constructor
98 </p> 95 </p>
96
99 <dl> 97 <dl>
100 98
101 <dt><i>python</i> (str)</dt> 99 <dt><i>python</i> (str)</dt>
102 <dd> 100 <dd>
103 path of the Python executable 101 path of the Python executable
120 </dd> 118 </dd>
121 </dl> 119 </dl>
122 <a NAME="DjangoCheckOptionsDialog.__moduleToPath" ID="DjangoCheckOptionsDialog.__moduleToPath"></a> 120 <a NAME="DjangoCheckOptionsDialog.__moduleToPath" ID="DjangoCheckOptionsDialog.__moduleToPath"></a>
123 <h4>DjangoCheckOptionsDialog.__moduleToPath</h4> 121 <h4>DjangoCheckOptionsDialog.__moduleToPath</h4>
124 <b>__moduleToPath</b>(<i>moduleName</i>) 122 <b>__moduleToPath</b>(<i>moduleName</i>)
125
126 <p> 123 <p>
127 Private method to convert a module name to an file path. 124 Private method to convert a module name to an file path.
128 </p> 125 </p>
126
129 <dl> 127 <dl>
130 128
131 <dt><i>moduleName</i> (str)</dt> 129 <dt><i>moduleName</i> (str)</dt>
132 <dd> 130 <dd>
133 module name to be converted 131 module name to be converted
146 </dd> 144 </dd>
147 </dl> 145 </dl>
148 <a NAME="DjangoCheckOptionsDialog.__pathToModule" ID="DjangoCheckOptionsDialog.__pathToModule"></a> 146 <a NAME="DjangoCheckOptionsDialog.__pathToModule" ID="DjangoCheckOptionsDialog.__pathToModule"></a>
149 <h4>DjangoCheckOptionsDialog.__pathToModule</h4> 147 <h4>DjangoCheckOptionsDialog.__pathToModule</h4>
150 <b>__pathToModule</b>(<i>path</i>) 148 <b>__pathToModule</b>(<i>path</i>)
151
152 <p> 149 <p>
153 Private method to convert a file path including a .py extension to a 150 Private method to convert a file path including a .py extension to a
154 module name. 151 module name.
155 </p> 152 </p>
153
156 <dl> 154 <dl>
157 155
158 <dt><i>path</i> (str)</dt> 156 <dt><i>path</i> (str)</dt>
159 <dd> 157 <dd>
160 file path to be converted 158 file path to be converted
173 </dd> 171 </dd>
174 </dl> 172 </dl>
175 <a NAME="DjangoCheckOptionsDialog.__populateTagsList" ID="DjangoCheckOptionsDialog.__populateTagsList"></a> 173 <a NAME="DjangoCheckOptionsDialog.__populateTagsList" ID="DjangoCheckOptionsDialog.__populateTagsList"></a>
176 <h4>DjangoCheckOptionsDialog.__populateTagsList</h4> 174 <h4>DjangoCheckOptionsDialog.__populateTagsList</h4>
177 <b>__populateTagsList</b>(<i>deployMode</i>) 175 <b>__populateTagsList</b>(<i>deployMode</i>)
178
179 <p> 176 <p>
180 Private slot to populate the tags list. 177 Private slot to populate the tags list.
181 </p> 178 </p>
179
182 <dl> 180 <dl>
183 181
184 <dt><i>deployMode</i> (bool)</dt> 182 <dt><i>deployMode</i> (bool)</dt>
185 <dd> 183 <dd>
186 flag indicating the deployment mode 184 flag indicating the deployment mode
187 </dd> 185 </dd>
188 </dl> 186 </dl>
189 <a NAME="DjangoCheckOptionsDialog.getData" ID="DjangoCheckOptionsDialog.getData"></a> 187 <a NAME="DjangoCheckOptionsDialog.getData" ID="DjangoCheckOptionsDialog.getData"></a>
190 <h4>DjangoCheckOptionsDialog.getData</h4> 188 <h4>DjangoCheckOptionsDialog.getData</h4>
191 <b>getData</b>(<i></i>) 189 <b>getData</b>(<i></i>)
192
193 <p> 190 <p>
194 Public method to get the options for the check operation. 191 Public method to get the options for the check operation.
195 </p> 192 </p>
193
196 <dl> 194 <dl>
197 <dt>Return:</dt> 195 <dt>Return:</dt>
198 <dd> 196 <dd>
199 tuple containing the deployment flag, list of selected tags, 197 tuple containing the deployment flag, list of selected tags,
200 applications string and the settings file 198 applications string and the settings file
207 </dd> 205 </dd>
208 </dl> 206 </dl>
209 <a NAME="DjangoCheckOptionsDialog.on_deployCheckBox_toggled" ID="DjangoCheckOptionsDialog.on_deployCheckBox_toggled"></a> 207 <a NAME="DjangoCheckOptionsDialog.on_deployCheckBox_toggled" ID="DjangoCheckOptionsDialog.on_deployCheckBox_toggled"></a>
210 <h4>DjangoCheckOptionsDialog.on_deployCheckBox_toggled</h4> 208 <h4>DjangoCheckOptionsDialog.on_deployCheckBox_toggled</h4>
211 <b>on_deployCheckBox_toggled</b>(<i>checked</i>) 209 <b>on_deployCheckBox_toggled</b>(<i>checked</i>)
212
213 <p> 210 <p>
214 Private slot handling a change of the deploy check box. 211 Private slot handling a change of the deploy check box.
215 </p> 212 </p>
213
216 <dl> 214 <dl>
217 215
218 <dt><i>checked</i> (bool)</dt> 216 <dt><i>checked</i> (bool)</dt>
219 <dd> 217 <dd>
220 state of the check box 218 state of the check box
221 </dd> 219 </dd>
222 </dl> 220 </dl>
223 <a NAME="DjangoCheckOptionsDialog.on_settingsFileButton_clicked" ID="DjangoCheckOptionsDialog.on_settingsFileButton_clicked"></a> 221 <a NAME="DjangoCheckOptionsDialog.on_settingsFileButton_clicked" ID="DjangoCheckOptionsDialog.on_settingsFileButton_clicked"></a>
224 <h4>DjangoCheckOptionsDialog.on_settingsFileButton_clicked</h4> 222 <h4>DjangoCheckOptionsDialog.on_settingsFileButton_clicked</h4>
225 <b>on_settingsFileButton_clicked</b>(<i></i>) 223 <b>on_settingsFileButton_clicked</b>(<i></i>)
226
227 <p> 224 <p>
228 Private slot to select a settings file via a file selection dialog. 225 Private slot to select a settings file via a file selection dialog.
229 </p> 226 </p>
227
230 <div align="right"><a href="#top">Up</a></div> 228 <div align="right"><a href="#top">Up</a></div>
231 <hr /> 229 <hr />
232 </body></html> 230 </body></html>

eric ide

mercurial