Mercurial Repositories > eric / file comparison

comparison: eric7/Documentation/Source/eric7.Project.IdlCompilerOptionsDialog.html

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

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

Mercurial Repository: eric

eric ide

mercurial