src/eric7/Documentation/Source/eric7.Project.IdlCompilerOptionsDialog.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 9236
db53a9efe7ef
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Project.IdlCompilerOptionsDialog</title>
4 <meta charset="UTF-8">
5 <link rel="stylesheet" href="styles.css">
6 </head>
7 <body>
8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Project.IdlCompilerOptionsDialog</h1>
10
11 <p>
12 Module implementing a dialog to enter some IDL compiler options.
13 </p>
14 <h3>Global Attributes</h3>
15
16 <table>
17 <tr><td>None</td></tr>
18 </table>
19 <h3>Classes</h3>
20
21 <table>
22
23 <tr>
24 <td><a href="#IdlCompilerOptionsDialog">IdlCompilerOptionsDialog</a></td>
25 <td>Class implementing a dialog to enter some IDL compiler options.</td>
26 </tr>
27 </table>
28 <h3>Functions</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <hr />
34 <hr />
35 <a NAME="IdlCompilerOptionsDialog" ID="IdlCompilerOptionsDialog"></a>
36 <h2>IdlCompilerOptionsDialog</h2>
37
38 <p>
39 Class implementing a dialog to enter some IDL compiler options.
40 </p>
41 <h3>Derived from</h3>
42 QDialog, Ui_IdlCompilerOptionsDialog
43 <h3>Class Attributes</h3>
44
45 <table>
46 <tr><td>None</td></tr>
47 </table>
48 <h3>Class Methods</h3>
49
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <h3>Methods</h3>
54
55 <table>
56
57 <tr>
58 <td><a href="#IdlCompilerOptionsDialog.__init__">IdlCompilerOptionsDialog</a></td>
59 <td>Constructor</td>
60 </tr>
61 <tr>
62 <td><a href="#IdlCompilerOptionsDialog.__definedNamesContain">__definedNamesContain</a></td>
63 <td>Private method to test, if the currently defined 'Defined Names' contain a given one.</td>
64 </tr>
65 <tr>
66 <td><a href="#IdlCompilerOptionsDialog.__generateDefinedNamesList">__generateDefinedNamesList</a></td>
67 <td>Private method to prepare the list of 'Defined Names'.</td>
68 </tr>
69 <tr>
70 <td><a href="#IdlCompilerOptionsDialog.__generateIncludeDirectoriesList">__generateIncludeDirectoriesList</a></td>
71 <td>Private method to prepare the list of 'Include Directories'.</td>
72 </tr>
73 <tr>
74 <td><a href="#IdlCompilerOptionsDialog.__generateUndefinedNamesList">__generateUndefinedNamesList</a></td>
75 <td>Private method to prepare the list of 'Undefined Names'.</td>
76 </tr>
77 <tr>
78 <td><a href="#IdlCompilerOptionsDialog.__includeDirectoriesContain">__includeDirectoriesContain</a></td>
79 <td>Private method to test, if the currently defined 'Include Directories' contain a given one.</td>
80 </tr>
81 <tr>
82 <td><a href="#IdlCompilerOptionsDialog.__populateDefineNamesList">__populateDefineNamesList</a></td>
83 <td>Private method to populate the list of defined names.</td>
84 </tr>
85 <tr>
86 <td><a href="#IdlCompilerOptionsDialog.__populateIncludeDirectoriesList">__populateIncludeDirectoriesList</a></td>
87 <td>Private method to populate the 'Include Directories' list.</td>
88 </tr>
89 <tr>
90 <td><a href="#IdlCompilerOptionsDialog.__undefinedNamesContain">__undefinedNamesContain</a></td>
91 <td>Private method to test, if the currently defined 'Undefined Names' contain a given one.</td>
92 </tr>
93 <tr>
94 <td><a href="#IdlCompilerOptionsDialog.__updateDefineNameButtons">__updateDefineNameButtons</a></td>
95 <td>Private method to set the state of the 'Define Name' buttons.</td>
96 </tr>
97 <tr>
98 <td><a href="#IdlCompilerOptionsDialog.__updateIncludeDirectoryButtons">__updateIncludeDirectoryButtons</a></td>
99 <td>Private method to set the state of the 'Include Directory' buttons.</td>
100 </tr>
101 <tr>
102 <td><a href="#IdlCompilerOptionsDialog.__updateUndefineNameButtons">__updateUndefineNameButtons</a></td>
103 <td>Private method to set the state of the 'Undefine Name' buttons.</td>
104 </tr>
105 <tr>
106 <td><a href="#IdlCompilerOptionsDialog.getData">getData</a></td>
107 <td>Public method to return the data entered by the user.</td>
108 </tr>
109 <tr>
110 <td><a href="#IdlCompilerOptionsDialog.on_dnAddButton_clicked">on_dnAddButton_clicked</a></td>
111 <td>Private slot to add a 'Define Name' entry.</td>
112 </tr>
113 <tr>
114 <td><a href="#IdlCompilerOptionsDialog.on_dnDeleteButton_clicked">on_dnDeleteButton_clicked</a></td>
115 <td>Private slot to delete the selected 'Define Name' entry.</td>
116 </tr>
117 <tr>
118 <td><a href="#IdlCompilerOptionsDialog.on_dnEditButton_clicked">on_dnEditButton_clicked</a></td>
119 <td>Private slot to edit the selected 'Define Name' entry.</td>
120 </tr>
121 <tr>
122 <td><a href="#IdlCompilerOptionsDialog.on_dnList_itemSelectionChanged">on_dnList_itemSelectionChanged</a></td>
123 <td>Private slot handling the selection of a 'Define Name' entry.</td>
124 </tr>
125 <tr>
126 <td><a href="#IdlCompilerOptionsDialog.on_idAddButton_clicked">on_idAddButton_clicked</a></td>
127 <td>Private slot to add an 'Include Directory'.</td>
128 </tr>
129 <tr>
130 <td><a href="#IdlCompilerOptionsDialog.on_idDeleteButton_clicked">on_idDeleteButton_clicked</a></td>
131 <td>Private slot to delete the selected 'Include Directory' entry.</td>
132 </tr>
133 <tr>
134 <td><a href="#IdlCompilerOptionsDialog.on_idEditButton_clicked">on_idEditButton_clicked</a></td>
135 <td>Private slot to edit the selected 'Include Directory' entry.</td>
136 </tr>
137 <tr>
138 <td><a href="#IdlCompilerOptionsDialog.on_idList_itemSelectionChanged">on_idList_itemSelectionChanged</a></td>
139 <td>Private slot handling the selection of an 'Include Directory' entry.</td>
140 </tr>
141 <tr>
142 <td><a href="#IdlCompilerOptionsDialog.on_unAddButton_clicked">on_unAddButton_clicked</a></td>
143 <td>Private slot to add a 'Undefine Name' entry.</td>
144 </tr>
145 <tr>
146 <td><a href="#IdlCompilerOptionsDialog.on_unDeleteButton_clicked">on_unDeleteButton_clicked</a></td>
147 <td>Private slot to delete the selected 'Undefine Name' entry.</td>
148 </tr>
149 <tr>
150 <td><a href="#IdlCompilerOptionsDialog.on_unEditButton_clicked">on_unEditButton_clicked</a></td>
151 <td>Private slot to edit the selected 'Undefine Name' entry.</td>
152 </tr>
153 <tr>
154 <td><a href="#IdlCompilerOptionsDialog.on_unList_itemSelectionChanged">on_unList_itemSelectionChanged</a></td>
155 <td>Private slot handling the selection of a 'Undefine Name' entry.</td>
156 </tr>
157 </table>
158 <h3>Static Methods</h3>
159
160 <table>
161 <tr><td>None</td></tr>
162 </table>
163
164 <a NAME="IdlCompilerOptionsDialog.__init__" ID="IdlCompilerOptionsDialog.__init__"></a>
165 <h4>IdlCompilerOptionsDialog (Constructor)</h4>
166 <b>IdlCompilerOptionsDialog</b>(<i>includeDirectories, definedNames, undefinedNames, project=None, parent=None</i>)
167
168 <p>
169 Constructor
170 </p>
171 <dl>
172
173 <dt><i>includeDirectories</i> (list of str)</dt>
174 <dd>
175 list of include directories
176 </dd>
177 <dt><i>definedNames</i> (list of str)</dt>
178 <dd>
179 list of defined variables with name and value
180 separated by '='
181 </dd>
182 <dt><i>undefinedNames</i> (list of str)</dt>
183 <dd>
184 list of undefined names
185 </dd>
186 <dt><i>project</i> (Project)</dt>
187 <dd>
188 reference to the project object
189 </dd>
190 <dt><i>parent</i> (QWidget)</dt>
191 <dd>
192 reference to the parent widget
193 </dd>
194 </dl>
195 <a NAME="IdlCompilerOptionsDialog.__definedNamesContain" ID="IdlCompilerOptionsDialog.__definedNamesContain"></a>
196 <h4>IdlCompilerOptionsDialog.__definedNamesContain</h4>
197 <b>__definedNamesContain</b>(<i>name</i>)
198
199 <p>
200 Private method to test, if the currently defined 'Defined Names'
201 contain a given one.
202 </p>
203 <dl>
204
205 <dt><i>name</i> (str)</dt>
206 <dd>
207 variable name to be tested
208 </dd>
209 </dl>
210 <dl>
211 <dt>Return:</dt>
212 <dd>
213 flag indicating that the given name is already included
214 </dd>
215 </dl>
216 <dl>
217 <dt>Return Type:</dt>
218 <dd>
219 bool
220 </dd>
221 </dl>
222 <a NAME="IdlCompilerOptionsDialog.__generateDefinedNamesList" ID="IdlCompilerOptionsDialog.__generateDefinedNamesList"></a>
223 <h4>IdlCompilerOptionsDialog.__generateDefinedNamesList</h4>
224 <b>__generateDefinedNamesList</b>(<i></i>)
225
226 <p>
227 Private method to prepare the list of 'Defined Names'.
228 </p>
229 <dl>
230 <dt>Return:</dt>
231 <dd>
232 list of 'Defined Names'
233 </dd>
234 </dl>
235 <dl>
236 <dt>Return Type:</dt>
237 <dd>
238 list of str
239 </dd>
240 </dl>
241 <a NAME="IdlCompilerOptionsDialog.__generateIncludeDirectoriesList" ID="IdlCompilerOptionsDialog.__generateIncludeDirectoriesList"></a>
242 <h4>IdlCompilerOptionsDialog.__generateIncludeDirectoriesList</h4>
243 <b>__generateIncludeDirectoriesList</b>(<i></i>)
244
245 <p>
246 Private method to prepare the list of 'Include Directories'.
247 </p>
248 <dl>
249 <dt>Return:</dt>
250 <dd>
251 list of 'Include Directories'
252 </dd>
253 </dl>
254 <dl>
255 <dt>Return Type:</dt>
256 <dd>
257 list of str
258 </dd>
259 </dl>
260 <a NAME="IdlCompilerOptionsDialog.__generateUndefinedNamesList" ID="IdlCompilerOptionsDialog.__generateUndefinedNamesList"></a>
261 <h4>IdlCompilerOptionsDialog.__generateUndefinedNamesList</h4>
262 <b>__generateUndefinedNamesList</b>(<i></i>)
263
264 <p>
265 Private method to prepare the list of 'Undefined Names'.
266 </p>
267 <dl>
268 <dt>Return:</dt>
269 <dd>
270 list of 'Undefined Names'
271 </dd>
272 </dl>
273 <dl>
274 <dt>Return Type:</dt>
275 <dd>
276 list of str
277 </dd>
278 </dl>
279 <a NAME="IdlCompilerOptionsDialog.__includeDirectoriesContain" ID="IdlCompilerOptionsDialog.__includeDirectoriesContain"></a>
280 <h4>IdlCompilerOptionsDialog.__includeDirectoriesContain</h4>
281 <b>__includeDirectoriesContain</b>(<i>directory</i>)
282
283 <p>
284 Private method to test, if the currently defined 'Include Directories'
285 contain a given one.
286 </p>
287 <dl>
288
289 <dt><i>directory</i> (str)</dt>
290 <dd>
291 directory name to be tested
292 </dd>
293 </dl>
294 <dl>
295 <dt>Return:</dt>
296 <dd>
297 flag indicating that the given directory is already included
298 </dd>
299 </dl>
300 <dl>
301 <dt>Return Type:</dt>
302 <dd>
303 bool
304 </dd>
305 </dl>
306 <a NAME="IdlCompilerOptionsDialog.__populateDefineNamesList" ID="IdlCompilerOptionsDialog.__populateDefineNamesList"></a>
307 <h4>IdlCompilerOptionsDialog.__populateDefineNamesList</h4>
308 <b>__populateDefineNamesList</b>(<i>definedNames</i>)
309
310 <p>
311 Private method to populate the list of defined names.
312 </p>
313 <dl>
314
315 <dt><i>definedNames</i> (list of str)</dt>
316 <dd>
317 list of defined variables with name and value
318 separated by '='
319 </dd>
320 </dl>
321 <a NAME="IdlCompilerOptionsDialog.__populateIncludeDirectoriesList" ID="IdlCompilerOptionsDialog.__populateIncludeDirectoriesList"></a>
322 <h4>IdlCompilerOptionsDialog.__populateIncludeDirectoriesList</h4>
323 <b>__populateIncludeDirectoriesList</b>(<i>includeDirectories</i>)
324
325 <p>
326 Private method to populate the 'Include Directories' list.
327 </p>
328 <dl>
329
330 <dt><i>includeDirectories</i> (list of str)</dt>
331 <dd>
332 list of include directories
333 </dd>
334 </dl>
335 <a NAME="IdlCompilerOptionsDialog.__undefinedNamesContain" ID="IdlCompilerOptionsDialog.__undefinedNamesContain"></a>
336 <h4>IdlCompilerOptionsDialog.__undefinedNamesContain</h4>
337 <b>__undefinedNamesContain</b>(<i>name</i>)
338
339 <p>
340 Private method to test, if the currently defined 'Undefined Names'
341 contain a given one.
342 </p>
343 <dl>
344
345 <dt><i>name</i> (str)</dt>
346 <dd>
347 variable name to be tested
348 </dd>
349 </dl>
350 <dl>
351 <dt>Return:</dt>
352 <dd>
353 flag indicating that the given name is already included
354 </dd>
355 </dl>
356 <dl>
357 <dt>Return Type:</dt>
358 <dd>
359 bool
360 </dd>
361 </dl>
362 <a NAME="IdlCompilerOptionsDialog.__updateDefineNameButtons" ID="IdlCompilerOptionsDialog.__updateDefineNameButtons"></a>
363 <h4>IdlCompilerOptionsDialog.__updateDefineNameButtons</h4>
364 <b>__updateDefineNameButtons</b>(<i></i>)
365
366 <p>
367 Private method to set the state of the 'Define Name' buttons.
368 </p>
369 <a NAME="IdlCompilerOptionsDialog.__updateIncludeDirectoryButtons" ID="IdlCompilerOptionsDialog.__updateIncludeDirectoryButtons"></a>
370 <h4>IdlCompilerOptionsDialog.__updateIncludeDirectoryButtons</h4>
371 <b>__updateIncludeDirectoryButtons</b>(<i></i>)
372
373 <p>
374 Private method to set the state of the 'Include Directory' buttons.
375 </p>
376 <a NAME="IdlCompilerOptionsDialog.__updateUndefineNameButtons" ID="IdlCompilerOptionsDialog.__updateUndefineNameButtons"></a>
377 <h4>IdlCompilerOptionsDialog.__updateUndefineNameButtons</h4>
378 <b>__updateUndefineNameButtons</b>(<i></i>)
379
380 <p>
381 Private method to set the state of the 'Undefine Name' buttons.
382 </p>
383 <a NAME="IdlCompilerOptionsDialog.getData" ID="IdlCompilerOptionsDialog.getData"></a>
384 <h4>IdlCompilerOptionsDialog.getData</h4>
385 <b>getData</b>(<i></i>)
386
387 <p>
388 Public method to return the data entered by the user.
389 </p>
390 <dl>
391 <dt>Return:</dt>
392 <dd>
393 tuple containing the list of include directories, list of
394 defined names and list of undefined names
395 </dd>
396 </dl>
397 <dl>
398 <dt>Return Type:</dt>
399 <dd>
400 tuple of (list of str, list of str, list of str)
401 </dd>
402 </dl>
403 <a NAME="IdlCompilerOptionsDialog.on_dnAddButton_clicked" ID="IdlCompilerOptionsDialog.on_dnAddButton_clicked"></a>
404 <h4>IdlCompilerOptionsDialog.on_dnAddButton_clicked</h4>
405 <b>on_dnAddButton_clicked</b>(<i></i>)
406
407 <p>
408 Private slot to add a 'Define Name' entry.
409 </p>
410 <a NAME="IdlCompilerOptionsDialog.on_dnDeleteButton_clicked" ID="IdlCompilerOptionsDialog.on_dnDeleteButton_clicked"></a>
411 <h4>IdlCompilerOptionsDialog.on_dnDeleteButton_clicked</h4>
412 <b>on_dnDeleteButton_clicked</b>(<i></i>)
413
414 <p>
415 Private slot to delete the selected 'Define Name' entry.
416 </p>
417 <a NAME="IdlCompilerOptionsDialog.on_dnEditButton_clicked" ID="IdlCompilerOptionsDialog.on_dnEditButton_clicked"></a>
418 <h4>IdlCompilerOptionsDialog.on_dnEditButton_clicked</h4>
419 <b>on_dnEditButton_clicked</b>(<i></i>)
420
421 <p>
422 Private slot to edit the selected 'Define Name' entry.
423 </p>
424 <a NAME="IdlCompilerOptionsDialog.on_dnList_itemSelectionChanged" ID="IdlCompilerOptionsDialog.on_dnList_itemSelectionChanged"></a>
425 <h4>IdlCompilerOptionsDialog.on_dnList_itemSelectionChanged</h4>
426 <b>on_dnList_itemSelectionChanged</b>(<i></i>)
427
428 <p>
429 Private slot handling the selection of a 'Define Name' entry.
430 </p>
431 <a NAME="IdlCompilerOptionsDialog.on_idAddButton_clicked" ID="IdlCompilerOptionsDialog.on_idAddButton_clicked"></a>
432 <h4>IdlCompilerOptionsDialog.on_idAddButton_clicked</h4>
433 <b>on_idAddButton_clicked</b>(<i></i>)
434
435 <p>
436 Private slot to add an 'Include Directory'.
437 </p>
438 <a NAME="IdlCompilerOptionsDialog.on_idDeleteButton_clicked" ID="IdlCompilerOptionsDialog.on_idDeleteButton_clicked"></a>
439 <h4>IdlCompilerOptionsDialog.on_idDeleteButton_clicked</h4>
440 <b>on_idDeleteButton_clicked</b>(<i></i>)
441
442 <p>
443 Private slot to delete the selected 'Include Directory' entry.
444 </p>
445 <a NAME="IdlCompilerOptionsDialog.on_idEditButton_clicked" ID="IdlCompilerOptionsDialog.on_idEditButton_clicked"></a>
446 <h4>IdlCompilerOptionsDialog.on_idEditButton_clicked</h4>
447 <b>on_idEditButton_clicked</b>(<i></i>)
448
449 <p>
450 Private slot to edit the selected 'Include Directory' entry.
451 </p>
452 <a NAME="IdlCompilerOptionsDialog.on_idList_itemSelectionChanged" ID="IdlCompilerOptionsDialog.on_idList_itemSelectionChanged"></a>
453 <h4>IdlCompilerOptionsDialog.on_idList_itemSelectionChanged</h4>
454 <b>on_idList_itemSelectionChanged</b>(<i></i>)
455
456 <p>
457 Private slot handling the selection of an 'Include Directory' entry.
458 </p>
459 <a NAME="IdlCompilerOptionsDialog.on_unAddButton_clicked" ID="IdlCompilerOptionsDialog.on_unAddButton_clicked"></a>
460 <h4>IdlCompilerOptionsDialog.on_unAddButton_clicked</h4>
461 <b>on_unAddButton_clicked</b>(<i></i>)
462
463 <p>
464 Private slot to add a 'Undefine Name' entry.
465 </p>
466 <a NAME="IdlCompilerOptionsDialog.on_unDeleteButton_clicked" ID="IdlCompilerOptionsDialog.on_unDeleteButton_clicked"></a>
467 <h4>IdlCompilerOptionsDialog.on_unDeleteButton_clicked</h4>
468 <b>on_unDeleteButton_clicked</b>(<i></i>)
469
470 <p>
471 Private slot to delete the selected 'Undefine Name' entry.
472 </p>
473 <a NAME="IdlCompilerOptionsDialog.on_unEditButton_clicked" ID="IdlCompilerOptionsDialog.on_unEditButton_clicked"></a>
474 <h4>IdlCompilerOptionsDialog.on_unEditButton_clicked</h4>
475 <b>on_unEditButton_clicked</b>(<i></i>)
476
477 <p>
478 Private slot to edit the selected 'Undefine Name' entry.
479 </p>
480 <a NAME="IdlCompilerOptionsDialog.on_unList_itemSelectionChanged" ID="IdlCompilerOptionsDialog.on_unList_itemSelectionChanged"></a>
481 <h4>IdlCompilerOptionsDialog.on_unList_itemSelectionChanged</h4>
482 <b>on_unList_itemSelectionChanged</b>(<i></i>)
483
484 <p>
485 Private slot handling the selection of a 'Undefine Name' entry.
486 </p>
487 <div align="right"><a href="#top">Up</a></div>
488 <hr />
489 </body></html>

eric ide

mercurial