Mercurial Repositories > eric / file comparison

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

Documentation/Source/eric6.Project.IdlCompilerOptionsDialog.html

branch
corba_options
changeset 6447
6d85c56508e7
child 6466
dac80ad0de75
equal deleted inserted replaced
6446:806446f3cf03 6447:6d85c56508e7
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.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><a NAME="top" ID="top"></a>
22 <h1>eric6.Project.IdlCompilerOptionsDialog</h1>
23 <p>
24 Module implementing a dialog to enter some IDL compiler options.
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="#IdlCompilerOptionsDialog">IdlCompilerOptionsDialog</a></td>
34 <td>Class implementing a dialog to enter some IDL compiler options.</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="IdlCompilerOptionsDialog" ID="IdlCompilerOptionsDialog"></a>
43 <h2>IdlCompilerOptionsDialog</h2>
44 <p>
45 Class implementing a dialog to enter some IDL compiler options.
46 </p>
47 <h3>Derived from</h3>
48 QDialog, Ui_IdlCompilerOptionsDialog
49 <h3>Class Attributes</h3>
50 <table>
51 <tr><td>None</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="#IdlCompilerOptionsDialog.__init__">IdlCompilerOptionsDialog</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#IdlCompilerOptionsDialog.__definedNamesContain">__definedNamesContain</a></td>
64 <td>Private method to test, if the currently defined 'Defined Names' contain a given one.</td>
65 </tr><tr>
66 <td><a href="#IdlCompilerOptionsDialog.__generateDefinedNamesList">__generateDefinedNamesList</a></td>
67 <td>Private method to prepare the list of 'Defined Names'.</td>
68 </tr><tr>
69 <td><a href="#IdlCompilerOptionsDialog.__generateIncludeDirectoriesList">__generateIncludeDirectoriesList</a></td>
70 <td>Private method to prepare the list of 'Include Directories'.</td>
71 </tr><tr>
72 <td><a href="#IdlCompilerOptionsDialog.__generateUndefinedNamesList">__generateUndefinedNamesList</a></td>
73 <td>Private method to prepare the list of 'Undefined Names'.</td>
74 </tr><tr>
75 <td><a href="#IdlCompilerOptionsDialog.__includeDirectoriesContain">__includeDirectoriesContain</a></td>
76 <td>Private method to test, if the currently defined 'Include Directories' contain a given one.</td>
77 </tr><tr>
78 <td><a href="#IdlCompilerOptionsDialog.__populateDefineNamesList">__populateDefineNamesList</a></td>
79 <td>Private method to populate the list of defined names.</td>
80 </tr><tr>
81 <td><a href="#IdlCompilerOptionsDialog.__populateIncludeDirectoriesList">__populateIncludeDirectoriesList</a></td>
82 <td>Private method to populate the 'Include Directories' list.</td>
83 </tr><tr>
84 <td><a href="#IdlCompilerOptionsDialog.__undefinedNamesContain">__undefinedNamesContain</a></td>
85 <td>Private method to test, if the currently defined 'Undefined Names' contain a given one.</td>
86 </tr><tr>
87 <td><a href="#IdlCompilerOptionsDialog.__updateDefineNameButtons">__updateDefineNameButtons</a></td>
88 <td>Private method to set the state of the 'Define Name' buttons.</td>
89 </tr><tr>
90 <td><a href="#IdlCompilerOptionsDialog.__updateIncludeDirectoryButtons">__updateIncludeDirectoryButtons</a></td>
91 <td>Private method to set the state of the 'Include Directory' buttons.</td>
92 </tr><tr>
93 <td><a href="#IdlCompilerOptionsDialog.__updateUndefineNameButtons">__updateUndefineNameButtons</a></td>
94 <td>Private method to set the state of the 'Undefine Name' buttons.</td>
95 </tr><tr>
96 <td><a href="#IdlCompilerOptionsDialog.getData">getData</a></td>
97 <td>Public method to return the data entered by the user.</td>
98 </tr><tr>
99 <td><a href="#IdlCompilerOptionsDialog.on_dnAddButton_clicked">on_dnAddButton_clicked</a></td>
100 <td>Private slot to add a 'Define Name' entry.</td>
101 </tr><tr>
102 <td><a href="#IdlCompilerOptionsDialog.on_dnDeleteButton_clicked">on_dnDeleteButton_clicked</a></td>
103 <td>Private slot to delete the selected 'Define Name' entry.</td>
104 </tr><tr>
105 <td><a href="#IdlCompilerOptionsDialog.on_dnEditButton_clicked">on_dnEditButton_clicked</a></td>
106 <td>Private slot to edit the selected 'Define Name' entry.</td>
107 </tr><tr>
108 <td><a href="#IdlCompilerOptionsDialog.on_dnList_itemSelectionChanged">on_dnList_itemSelectionChanged</a></td>
109 <td>Private slot handling the selection of a 'Define Name' entry.</td>
110 </tr><tr>
111 <td><a href="#IdlCompilerOptionsDialog.on_idAddButton_clicked">on_idAddButton_clicked</a></td>
112 <td>Private slot to add an 'Include Directory'.</td>
113 </tr><tr>
114 <td><a href="#IdlCompilerOptionsDialog.on_idDeleteButton_clicked">on_idDeleteButton_clicked</a></td>
115 <td>Private slot to delete the selected 'Include Directory' entry.</td>
116 </tr><tr>
117 <td><a href="#IdlCompilerOptionsDialog.on_idEditButton_clicked">on_idEditButton_clicked</a></td>
118 <td>Private slot to edit the selected 'Include Directory' entry.</td>
119 </tr><tr>
120 <td><a href="#IdlCompilerOptionsDialog.on_idList_itemSelectionChanged">on_idList_itemSelectionChanged</a></td>
121 <td>Private slot handling the selection of an 'Include Directory' entry.</td>
122 </tr><tr>
123 <td><a href="#IdlCompilerOptionsDialog.on_unAddButton_clicked">on_unAddButton_clicked</a></td>
124 <td>Private slot to add a 'Undefine Name' entry.</td>
125 </tr><tr>
126 <td><a href="#IdlCompilerOptionsDialog.on_unDeleteButton_clicked">on_unDeleteButton_clicked</a></td>
127 <td>Private slot to delete the selected 'Undefine Name' entry.</td>
128 </tr><tr>
129 <td><a href="#IdlCompilerOptionsDialog.on_unEditButton_clicked">on_unEditButton_clicked</a></td>
130 <td>Private slot to edit the selected 'Undefine Name' entry.</td>
131 </tr><tr>
132 <td><a href="#IdlCompilerOptionsDialog.on_unList_itemSelectionChanged">on_unList_itemSelectionChanged</a></td>
133 <td>Private slot handling the selection of a 'Undefine Name' entry.</td>
134 </tr>
135 </table>
136 <h3>Static Methods</h3>
137 <table>
138 <tr><td>None</td></tr>
139 </table>
140 <a NAME="IdlCompilerOptionsDialog.__init__" ID="IdlCompilerOptionsDialog.__init__"></a>
141 <h4>IdlCompilerOptionsDialog (Constructor)</h4>
142 <b>IdlCompilerOptionsDialog</b>(<i>includeDirectories, definedNames, undefinedNames, project=None, parent=None</i>)
143 <p>
144 Constructor
145 </p><dl>
146 <dt><i>includeDirectories</i> (list of str)</dt>
147 <dd>
148 list of include directories
149 </dd><dt><i>definedNames</i> (list of str)</dt>
150 <dd>
151 list of defined variables with name and value
152 separated by '='
153 </dd><dt><i>undefinedNames</i> (list of str)</dt>
154 <dd>
155 list of undefined names
156 </dd><dt><i>projectDirectory</i> (str)</dt>
157 <dd>
158 directory name of the project
159 </dd><dt><i>parent</i> (QWidget)</dt>
160 <dd>
161 reference to the parent widget
162 </dd>
163 </dl><a NAME="IdlCompilerOptionsDialog.__definedNamesContain" ID="IdlCompilerOptionsDialog.__definedNamesContain"></a>
164 <h4>IdlCompilerOptionsDialog.__definedNamesContain</h4>
165 <b>__definedNamesContain</b>(<i>name</i>)
166 <p>
167 Private method to test, if the currently defined 'Defined Names'
168 contain a given one.
169 </p><dl>
170 <dt><i>name</i> (str)</dt>
171 <dd>
172 variable name to be tested
173 </dd>
174 </dl><dl>
175 <dt>Returns:</dt>
176 <dd>
177 flag indicating that the given name is already included
178 </dd>
179 </dl><dl>
180 <dt>Return Type:</dt>
181 <dd>
182 bool
183 </dd>
184 </dl><a NAME="IdlCompilerOptionsDialog.__generateDefinedNamesList" ID="IdlCompilerOptionsDialog.__generateDefinedNamesList"></a>
185 <h4>IdlCompilerOptionsDialog.__generateDefinedNamesList</h4>
186 <b>__generateDefinedNamesList</b>(<i></i>)
187 <p>
188 Private method to prepare the list of 'Defined Names'.
189 </p><dl>
190 <dt>Returns:</dt>
191 <dd>
192 list of 'Defined Names'
193 </dd>
194 </dl><dl>
195 <dt>Return Type:</dt>
196 <dd>
197 list of str
198 </dd>
199 </dl><a NAME="IdlCompilerOptionsDialog.__generateIncludeDirectoriesList" ID="IdlCompilerOptionsDialog.__generateIncludeDirectoriesList"></a>
200 <h4>IdlCompilerOptionsDialog.__generateIncludeDirectoriesList</h4>
201 <b>__generateIncludeDirectoriesList</b>(<i></i>)
202 <p>
203 Private method to prepare the list of 'Include Directories'.
204 </p><dl>
205 <dt>Returns:</dt>
206 <dd>
207 list of 'Include Directories'
208 </dd>
209 </dl><dl>
210 <dt>Return Type:</dt>
211 <dd>
212 list of str
213 </dd>
214 </dl><a NAME="IdlCompilerOptionsDialog.__generateUndefinedNamesList" ID="IdlCompilerOptionsDialog.__generateUndefinedNamesList"></a>
215 <h4>IdlCompilerOptionsDialog.__generateUndefinedNamesList</h4>
216 <b>__generateUndefinedNamesList</b>(<i></i>)
217 <p>
218 Private method to prepare the list of 'Undefined Names'.
219 </p><dl>
220 <dt>Returns:</dt>
221 <dd>
222 list of 'Undefined Names'
223 </dd>
224 </dl><dl>
225 <dt>Return Type:</dt>
226 <dd>
227 list of str
228 </dd>
229 </dl><a NAME="IdlCompilerOptionsDialog.__includeDirectoriesContain" ID="IdlCompilerOptionsDialog.__includeDirectoriesContain"></a>
230 <h4>IdlCompilerOptionsDialog.__includeDirectoriesContain</h4>
231 <b>__includeDirectoriesContain</b>(<i>directory</i>)
232 <p>
233 Private method to test, if the currently defined 'Include Directories'
234 contain a given one.
235 </p><dl>
236 <dt><i>directory</i> (str)</dt>
237 <dd>
238 directory name to be tested
239 </dd>
240 </dl><dl>
241 <dt>Returns:</dt>
242 <dd>
243 flag indicating that the given directory is already included
244 </dd>
245 </dl><dl>
246 <dt>Return Type:</dt>
247 <dd>
248 bool
249 </dd>
250 </dl><a NAME="IdlCompilerOptionsDialog.__populateDefineNamesList" ID="IdlCompilerOptionsDialog.__populateDefineNamesList"></a>
251 <h4>IdlCompilerOptionsDialog.__populateDefineNamesList</h4>
252 <b>__populateDefineNamesList</b>(<i>definedNames</i>)
253 <p>
254 Private method to populate the list of defined names.
255 </p><dl>
256 <dt><i>definedNames</i> (list of str)</dt>
257 <dd>
258 list of defined variables with name and value
259 separated by '='
260 </dd>
261 </dl><a NAME="IdlCompilerOptionsDialog.__populateIncludeDirectoriesList" ID="IdlCompilerOptionsDialog.__populateIncludeDirectoriesList"></a>
262 <h4>IdlCompilerOptionsDialog.__populateIncludeDirectoriesList</h4>
263 <b>__populateIncludeDirectoriesList</b>(<i>includeDirectories</i>)
264 <p>
265 Private method to populate the 'Include Directories' list.
266 </p><dl>
267 <dt><i>includeDirectories</i> (list of str)</dt>
268 <dd>
269 list of include directories
270 </dd>
271 </dl><a NAME="IdlCompilerOptionsDialog.__undefinedNamesContain" ID="IdlCompilerOptionsDialog.__undefinedNamesContain"></a>
272 <h4>IdlCompilerOptionsDialog.__undefinedNamesContain</h4>
273 <b>__undefinedNamesContain</b>(<i>name</i>)
274 <p>
275 Private method to test, if the currently defined 'Undefined Names'
276 contain a given one.
277 </p><dl>
278 <dt><i>name</i> (str)</dt>
279 <dd>
280 variable name to be tested
281 </dd>
282 </dl><dl>
283 <dt>Returns:</dt>
284 <dd>
285 flag indicating that the given name is already included
286 </dd>
287 </dl><dl>
288 <dt>Return Type:</dt>
289 <dd>
290 bool
291 </dd>
292 </dl><a NAME="IdlCompilerOptionsDialog.__updateDefineNameButtons" ID="IdlCompilerOptionsDialog.__updateDefineNameButtons"></a>
293 <h4>IdlCompilerOptionsDialog.__updateDefineNameButtons</h4>
294 <b>__updateDefineNameButtons</b>(<i></i>)
295 <p>
296 Private method to set the state of the 'Define Name' buttons.
297 </p><a NAME="IdlCompilerOptionsDialog.__updateIncludeDirectoryButtons" ID="IdlCompilerOptionsDialog.__updateIncludeDirectoryButtons"></a>
298 <h4>IdlCompilerOptionsDialog.__updateIncludeDirectoryButtons</h4>
299 <b>__updateIncludeDirectoryButtons</b>(<i></i>)
300 <p>
301 Private method to set the state of the 'Include Directory' buttons.
302 </p><a NAME="IdlCompilerOptionsDialog.__updateUndefineNameButtons" ID="IdlCompilerOptionsDialog.__updateUndefineNameButtons"></a>
303 <h4>IdlCompilerOptionsDialog.__updateUndefineNameButtons</h4>
304 <b>__updateUndefineNameButtons</b>(<i></i>)
305 <p>
306 Private method to set the state of the 'Undefine Name' buttons.
307 </p><a NAME="IdlCompilerOptionsDialog.getData" ID="IdlCompilerOptionsDialog.getData"></a>
308 <h4>IdlCompilerOptionsDialog.getData</h4>
309 <b>getData</b>(<i></i>)
310 <p>
311 Public method to return the data entered by the user.
312 </p><dl>
313 <dt>Returns:</dt>
314 <dd>
315 tuple containing the list of include directories, list of
316 defined names and list of undefined names
317 </dd>
318 </dl><dl>
319 <dt>Return Type:</dt>
320 <dd>
321 tuple of (list of str, list of str, list of str)
322 </dd>
323 </dl><a NAME="IdlCompilerOptionsDialog.on_dnAddButton_clicked" ID="IdlCompilerOptionsDialog.on_dnAddButton_clicked"></a>
324 <h4>IdlCompilerOptionsDialog.on_dnAddButton_clicked</h4>
325 <b>on_dnAddButton_clicked</b>(<i></i>)
326 <p>
327 Private slot to add a 'Define Name' entry.
328 </p><a NAME="IdlCompilerOptionsDialog.on_dnDeleteButton_clicked" ID="IdlCompilerOptionsDialog.on_dnDeleteButton_clicked"></a>
329 <h4>IdlCompilerOptionsDialog.on_dnDeleteButton_clicked</h4>
330 <b>on_dnDeleteButton_clicked</b>(<i></i>)
331 <p>
332 Private slot to delete the selected 'Define Name' entry.
333 </p><a NAME="IdlCompilerOptionsDialog.on_dnEditButton_clicked" ID="IdlCompilerOptionsDialog.on_dnEditButton_clicked"></a>
334 <h4>IdlCompilerOptionsDialog.on_dnEditButton_clicked</h4>
335 <b>on_dnEditButton_clicked</b>(<i></i>)
336 <p>
337 Private slot to edit the selected 'Define Name' entry.
338 </p><a NAME="IdlCompilerOptionsDialog.on_dnList_itemSelectionChanged" ID="IdlCompilerOptionsDialog.on_dnList_itemSelectionChanged"></a>
339 <h4>IdlCompilerOptionsDialog.on_dnList_itemSelectionChanged</h4>
340 <b>on_dnList_itemSelectionChanged</b>(<i></i>)
341 <p>
342 Private slot handling the selection of a 'Define Name' entry.
343 </p><a NAME="IdlCompilerOptionsDialog.on_idAddButton_clicked" ID="IdlCompilerOptionsDialog.on_idAddButton_clicked"></a>
344 <h4>IdlCompilerOptionsDialog.on_idAddButton_clicked</h4>
345 <b>on_idAddButton_clicked</b>(<i></i>)
346 <p>
347 Private slot to add an 'Include Directory'.
348 </p><a NAME="IdlCompilerOptionsDialog.on_idDeleteButton_clicked" ID="IdlCompilerOptionsDialog.on_idDeleteButton_clicked"></a>
349 <h4>IdlCompilerOptionsDialog.on_idDeleteButton_clicked</h4>
350 <b>on_idDeleteButton_clicked</b>(<i></i>)
351 <p>
352 Private slot to delete the selected 'Include Directory' entry.
353 </p><a NAME="IdlCompilerOptionsDialog.on_idEditButton_clicked" ID="IdlCompilerOptionsDialog.on_idEditButton_clicked"></a>
354 <h4>IdlCompilerOptionsDialog.on_idEditButton_clicked</h4>
355 <b>on_idEditButton_clicked</b>(<i></i>)
356 <p>
357 Private slot to edit the selected 'Include Directory' entry.
358 </p><a NAME="IdlCompilerOptionsDialog.on_idList_itemSelectionChanged" ID="IdlCompilerOptionsDialog.on_idList_itemSelectionChanged"></a>
359 <h4>IdlCompilerOptionsDialog.on_idList_itemSelectionChanged</h4>
360 <b>on_idList_itemSelectionChanged</b>(<i></i>)
361 <p>
362 Private slot handling the selection of an 'Include Directory' entry.
363 </p><a NAME="IdlCompilerOptionsDialog.on_unAddButton_clicked" ID="IdlCompilerOptionsDialog.on_unAddButton_clicked"></a>
364 <h4>IdlCompilerOptionsDialog.on_unAddButton_clicked</h4>
365 <b>on_unAddButton_clicked</b>(<i></i>)
366 <p>
367 Private slot to add a 'Undefine Name' entry.
368 </p><a NAME="IdlCompilerOptionsDialog.on_unDeleteButton_clicked" ID="IdlCompilerOptionsDialog.on_unDeleteButton_clicked"></a>
369 <h4>IdlCompilerOptionsDialog.on_unDeleteButton_clicked</h4>
370 <b>on_unDeleteButton_clicked</b>(<i></i>)
371 <p>
372 Private slot to delete the selected 'Undefine Name' entry.
373 </p><a NAME="IdlCompilerOptionsDialog.on_unEditButton_clicked" ID="IdlCompilerOptionsDialog.on_unEditButton_clicked"></a>
374 <h4>IdlCompilerOptionsDialog.on_unEditButton_clicked</h4>
375 <b>on_unEditButton_clicked</b>(<i></i>)
376 <p>
377 Private slot to edit the selected 'Undefine Name' entry.
378 </p><a NAME="IdlCompilerOptionsDialog.on_unList_itemSelectionChanged" ID="IdlCompilerOptionsDialog.on_unList_itemSelectionChanged"></a>
379 <h4>IdlCompilerOptionsDialog.on_unList_itemSelectionChanged</h4>
380 <b>on_unList_itemSelectionChanged</b>(<i></i>)
381 <p>
382 Private slot handling the selection of a 'Undefine Name' entry.
383 </p>
384 <div align="right"><a href="#top">Up</a></div>
385 <hr />
386 </body></html>

Mercurial Repository: eric

eric ide

mercurial