Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric4.Preferences.ConfigurationDialog.html

Documentation/Source/eric4.Preferences.ConfigurationDialog.html

changeset 3
0d9daebf5b8c
equal deleted inserted replaced
2:bc6196164237 3:0d9daebf5b8c
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
4 <html><head>
5 <title>eric4.Preferences.ConfigurationDialog</title>
6 <style>
7 body {
8 background:white;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #4FA4FF; }
14 h2 { color: white; background: #4FA4FF; }
15 h3 { color: white; background: #00557F; }
16 h4 { color: white; background: #00557F; }
17
18 a { color: #AA5500; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>eric4.Preferences.ConfigurationDialog</h1>
24 <p>
25 Module implementing a dialog for the configuration of eric4.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <tr><td>None</td></tr>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#ConfigurationDialog">ConfigurationDialog</a></td>
35 <td>Class for the dialog variant.</td>
36 </tr><tr>
37 <td><a href="#ConfigurationPageItem">ConfigurationPageItem</a></td>
38 <td>Class implementing a QTreeWidgetItem holding the configuration page data.</td>
39 </tr><tr>
40 <td><a href="#ConfigurationWidget">ConfigurationWidget</a></td>
41 <td>Class implementing a dialog for the configuration of eric4.</td>
42 </tr><tr>
43 <td><a href="#ConfigurationWindow">ConfigurationWindow</a></td>
44 <td>Main window class for the standalone dialog.</td>
45 </tr>
46 </table>
47 <h3>Functions</h3>
48 <table>
49 <tr><td>None</td></tr>
50 </table>
51 <hr /><hr />
52 <a NAME="ConfigurationDialog" ID="ConfigurationDialog"></a>
53 <h2>ConfigurationDialog</h2>
54 <p>
55 Class for the dialog variant.
56 </p><h4>Signals</h4>
57 <dl>
58 <dt>preferencesChanged</dt>
59 <dd>
60 emitted after settings have been changed
61 </dd>
62 </dl>
63 <h3>Derived from</h3>
64 QDialog
65 <h3>Class Attributes</h3>
66 <table>
67 <tr><td>None</td></tr>
68 </table>
69 <h3>Methods</h3>
70 <table>
71 <tr>
72 <td><a href="#ConfigurationDialog.__init__">ConfigurationDialog</a></td>
73 <td>Constructor</td>
74 </tr><tr>
75 <td><a href="#ConfigurationDialog.__preferencesChanged">__preferencesChanged</a></td>
76 <td>Private slot to handle a change of the preferences.</td>
77 </tr><tr>
78 <td><a href="#ConfigurationDialog.setPreferences">setPreferences</a></td>
79 <td>Public method called to store the selected values into the preferences storage.</td>
80 </tr><tr>
81 <td><a href="#ConfigurationDialog.showConfigurationPageByName">showConfigurationPageByName</a></td>
82 <td>Public slot to show a named configuration page.</td>
83 </tr>
84 </table>
85 <a NAME="ConfigurationDialog.__init__" ID="ConfigurationDialog.__init__"></a>
86 <h4>ConfigurationDialog (Constructor)</h4>
87 <b>ConfigurationDialog</b>(<i>parent = None, name = None, modal = False, fromEric = True, helpBrowserMode = False</i>)
88 <p>
89 Constructor
90 </p><dl>
91 <dt><i>parent</i></dt>
92 <dd>
93 The parent widget of this dialog. (QWidget)
94 </dd><dt><i>name</i></dt>
95 <dd>
96 The name of this dialog. string
97 </dd><dt><i>modal</i></dt>
98 <dd>
99 Flag indicating a modal dialog. (boolean)
100 </dd><dt><i>fromEric=</i></dt>
101 <dd>
102 flag indicating a dialog generation from within the
103 eric4 ide (boolean)
104 </dd><dt><i>helpBrowserMode=</i></dt>
105 <dd>
106 flag indicating to show only help pages
107 for entries related to the help browser (boolean)
108 </dd>
109 </dl><a NAME="ConfigurationDialog.__preferencesChanged" ID="ConfigurationDialog.__preferencesChanged"></a>
110 <h4>ConfigurationDialog.__preferencesChanged</h4>
111 <b>__preferencesChanged</b>(<i></i>)
112 <p>
113 Private slot to handle a change of the preferences.
114 </p><a NAME="ConfigurationDialog.setPreferences" ID="ConfigurationDialog.setPreferences"></a>
115 <h4>ConfigurationDialog.setPreferences</h4>
116 <b>setPreferences</b>(<i></i>)
117 <p>
118 Public method called to store the selected values into the preferences storage.
119 </p><a NAME="ConfigurationDialog.showConfigurationPageByName" ID="ConfigurationDialog.showConfigurationPageByName"></a>
120 <h4>ConfigurationDialog.showConfigurationPageByName</h4>
121 <b>showConfigurationPageByName</b>(<i>pageName</i>)
122 <p>
123 Public slot to show a named configuration page.
124 </p><dl>
125 <dt><i>pageName</i></dt>
126 <dd>
127 name of the configuration page to show (string)
128 </dd>
129 </dl>
130 <div align="right"><a href="#top">Up</a></div>
131 <hr /><hr />
132 <a NAME="ConfigurationPageItem" ID="ConfigurationPageItem"></a>
133 <h2>ConfigurationPageItem</h2>
134 <p>
135 Class implementing a QTreeWidgetItem holding the configuration page data.
136 </p>
137 <h3>Derived from</h3>
138 QTreeWidgetItem
139 <h3>Class Attributes</h3>
140 <table>
141 <tr><td>None</td></tr>
142 </table>
143 <h3>Methods</h3>
144 <table>
145 <tr>
146 <td><a href="#ConfigurationPageItem.__init__">ConfigurationPageItem</a></td>
147 <td>Constructor</td>
148 </tr><tr>
149 <td><a href="#ConfigurationPageItem.getPageName">getPageName</a></td>
150 <td>Public method to get the name of the associated configuration page.</td>
151 </tr>
152 </table>
153 <a NAME="ConfigurationPageItem.__init__" ID="ConfigurationPageItem.__init__"></a>
154 <h4>ConfigurationPageItem (Constructor)</h4>
155 <b>ConfigurationPageItem</b>(<i>parent, text, pageName, iconFile</i>)
156 <p>
157 Constructor
158 </p><dl>
159 <dt><i>parent</i></dt>
160 <dd>
161 parent widget of the item (QTreeWidget or QTreeWidgetItem)
162 </dd><dt><i>text</i></dt>
163 <dd>
164 text to be displayed (string)
165 </dd><dt><i>pageName</i></dt>
166 <dd>
167 name of the configuration page (string)
168 </dd><dt><i>iconFile</i></dt>
169 <dd>
170 file name of the icon to be shown (string)
171 </dd>
172 </dl><a NAME="ConfigurationPageItem.getPageName" ID="ConfigurationPageItem.getPageName"></a>
173 <h4>ConfigurationPageItem.getPageName</h4>
174 <b>getPageName</b>(<i></i>)
175 <p>
176 Public method to get the name of the associated configuration page.
177 </p><dl>
178 <dt>Returns:</dt>
179 <dd>
180 name of the configuration page (string)
181 </dd>
182 </dl>
183 <div align="right"><a href="#top">Up</a></div>
184 <hr /><hr />
185 <a NAME="ConfigurationWidget" ID="ConfigurationWidget"></a>
186 <h2>ConfigurationWidget</h2>
187 <p>
188 Class implementing a dialog for the configuration of eric4.
189 </p><h4>Signals</h4>
190 <dl>
191 <dt>preferencesChanged</dt>
192 <dd>
193 emitted after settings have been changed
194 </dd>
195 </dl>
196 <h3>Derived from</h3>
197 QWidget
198 <h3>Class Attributes</h3>
199 <table>
200 <tr><td>None</td></tr>
201 </table>
202 <h3>Methods</h3>
203 <table>
204 <tr>
205 <td><a href="#ConfigurationWidget.__init__">ConfigurationWidget</a></td>
206 <td>Constructor</td>
207 </tr><tr>
208 <td><a href="#ConfigurationWidget.__importConfigurationPage">__importConfigurationPage</a></td>
209 <td>Private method to import a configuration page module.</td>
210 </tr><tr>
211 <td><a href="#ConfigurationWidget.__initLexers">__initLexers</a></td>
212 <td>Private method to initialize the dictionary of preferences lexers.</td>
213 </tr><tr>
214 <td><a href="#ConfigurationWidget.__initPage">__initPage</a></td>
215 <td>Private method to initialize a configuration page.</td>
216 </tr><tr>
217 <td><a href="#ConfigurationWidget.__setupUi">__setupUi</a></td>
218 <td>Private method to perform the general setup of the configuration widget.</td>
219 </tr><tr>
220 <td><a href="#ConfigurationWidget.__showConfigurationPage">__showConfigurationPage</a></td>
221 <td>Private slot to show a selected configuration page.</td>
222 </tr><tr>
223 <td><a href="#ConfigurationWidget.calledFromEric">calledFromEric</a></td>
224 <td>Public method to check, if invoked from within eric.</td>
225 </tr><tr>
226 <td><a href="#ConfigurationWidget.getLexers">getLexers</a></td>
227 <td>Public method to get a reference to the lexers dictionary.</td>
228 </tr><tr>
229 <td><a href="#ConfigurationWidget.getPage">getPage</a></td>
230 <td>Public method to get a reference to the named page.</td>
231 </tr><tr>
232 <td><a href="#ConfigurationWidget.on_applyButton_clicked">on_applyButton_clicked</a></td>
233 <td>Private slot called to apply the settings of the current page.</td>
234 </tr><tr>
235 <td><a href="#ConfigurationWidget.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
236 <td>Private slot called by a button of the button box clicked.</td>
237 </tr><tr>
238 <td><a href="#ConfigurationWidget.on_resetButton_clicked">on_resetButton_clicked</a></td>
239 <td>Private slot called to reset the settings of the current page.</td>
240 </tr><tr>
241 <td><a href="#ConfigurationWidget.setPreferences">setPreferences</a></td>
242 <td>Public method called to store the selected values into the preferences storage.</td>
243 </tr><tr>
244 <td><a href="#ConfigurationWidget.showConfigurationPageByName">showConfigurationPageByName</a></td>
245 <td>Public slot to show a named configuration page.</td>
246 </tr>
247 </table>
248 <a NAME="ConfigurationWidget.__init__" ID="ConfigurationWidget.__init__"></a>
249 <h4>ConfigurationWidget (Constructor)</h4>
250 <b>ConfigurationWidget</b>(<i>parent = None, fromEric = True, helpBrowserMode = False</i>)
251 <p>
252 Constructor
253 </p><dl>
254 <dt><i>parent</i></dt>
255 <dd>
256 The parent widget of this dialog. (QWidget)
257 </dd><dt><i>fromEric=</i></dt>
258 <dd>
259 flag indicating a dialog generation from within the
260 eric4 ide (boolean)
261 </dd><dt><i>helpBrowserMode=</i></dt>
262 <dd>
263 flag indicating to show only help pages
264 for entries related to the help browser (boolean)
265 </dd>
266 </dl><a NAME="ConfigurationWidget.__importConfigurationPage" ID="ConfigurationWidget.__importConfigurationPage"></a>
267 <h4>ConfigurationWidget.__importConfigurationPage</h4>
268 <b>__importConfigurationPage</b>(<i>name</i>)
269 <p>
270 Private method to import a configuration page module.
271 </p><dl>
272 <dt><i>name</i></dt>
273 <dd>
274 name of the configuration page module (string)
275 </dd>
276 </dl><dl>
277 <dt>Returns:</dt>
278 <dd>
279 reference to the configuration page module
280 </dd>
281 </dl><a NAME="ConfigurationWidget.__initLexers" ID="ConfigurationWidget.__initLexers"></a>
282 <h4>ConfigurationWidget.__initLexers</h4>
283 <b>__initLexers</b>(<i></i>)
284 <p>
285 Private method to initialize the dictionary of preferences lexers.
286 </p><a NAME="ConfigurationWidget.__initPage" ID="ConfigurationWidget.__initPage"></a>
287 <h4>ConfigurationWidget.__initPage</h4>
288 <b>__initPage</b>(<i>pageData</i>)
289 <p>
290 Private method to initialize a configuration page.
291 </p><dl>
292 <dt><i>pageData</i></dt>
293 <dd>
294 data structure for the page to initialize
295 </dd>
296 </dl><dl>
297 <dt>Returns:</dt>
298 <dd>
299 reference to the initialized page
300 </dd>
301 </dl><a NAME="ConfigurationWidget.__setupUi" ID="ConfigurationWidget.__setupUi"></a>
302 <h4>ConfigurationWidget.__setupUi</h4>
303 <b>__setupUi</b>(<i></i>)
304 <p>
305 Private method to perform the general setup of the configuration widget.
306 </p><a NAME="ConfigurationWidget.__showConfigurationPage" ID="ConfigurationWidget.__showConfigurationPage"></a>
307 <h4>ConfigurationWidget.__showConfigurationPage</h4>
308 <b>__showConfigurationPage</b>(<i>itm, column</i>)
309 <p>
310 Private slot to show a selected configuration page.
311 </p><dl>
312 <dt><i>itm</i></dt>
313 <dd>
314 reference to the selected item (QTreeWidgetItem)
315 </dd><dt><i>column</i></dt>
316 <dd>
317 column that was selected (integer) (ignored)
318 </dd>
319 </dl><a NAME="ConfigurationWidget.calledFromEric" ID="ConfigurationWidget.calledFromEric"></a>
320 <h4>ConfigurationWidget.calledFromEric</h4>
321 <b>calledFromEric</b>(<i></i>)
322 <p>
323 Public method to check, if invoked from within eric.
324 </p><dl>
325 <dt>Returns:</dt>
326 <dd>
327 flag indicating invocation from within eric (boolean)
328 </dd>
329 </dl><a NAME="ConfigurationWidget.getLexers" ID="ConfigurationWidget.getLexers"></a>
330 <h4>ConfigurationWidget.getLexers</h4>
331 <b>getLexers</b>(<i></i>)
332 <p>
333 Public method to get a reference to the lexers dictionary.
334 </p><dl>
335 <dt>Returns:</dt>
336 <dd>
337 reference to the lexers dictionary
338 </dd>
339 </dl><a NAME="ConfigurationWidget.getPage" ID="ConfigurationWidget.getPage"></a>
340 <h4>ConfigurationWidget.getPage</h4>
341 <b>getPage</b>(<i>pageName</i>)
342 <p>
343 Public method to get a reference to the named page.
344 </p><dl>
345 <dt><i>pageName</i></dt>
346 <dd>
347 name of the configuration page (string)
348 </dd>
349 </dl><dl>
350 <dt>Returns:</dt>
351 <dd>
352 reference to the page or None, indicating page was
353 not loaded yet
354 </dd>
355 </dl><a NAME="ConfigurationWidget.on_applyButton_clicked" ID="ConfigurationWidget.on_applyButton_clicked"></a>
356 <h4>ConfigurationWidget.on_applyButton_clicked</h4>
357 <b>on_applyButton_clicked</b>(<i></i>)
358 <p>
359 Private slot called to apply the settings of the current page.
360 </p><a NAME="ConfigurationWidget.on_buttonBox_clicked" ID="ConfigurationWidget.on_buttonBox_clicked"></a>
361 <h4>ConfigurationWidget.on_buttonBox_clicked</h4>
362 <b>on_buttonBox_clicked</b>(<i>button</i>)
363 <p>
364 Private slot called by a button of the button box clicked.
365 </p><dl>
366 <dt><i>button</i></dt>
367 <dd>
368 button that was clicked (QAbstractButton)
369 </dd>
370 </dl><a NAME="ConfigurationWidget.on_resetButton_clicked" ID="ConfigurationWidget.on_resetButton_clicked"></a>
371 <h4>ConfigurationWidget.on_resetButton_clicked</h4>
372 <b>on_resetButton_clicked</b>(<i></i>)
373 <p>
374 Private slot called to reset the settings of the current page.
375 </p><a NAME="ConfigurationWidget.setPreferences" ID="ConfigurationWidget.setPreferences"></a>
376 <h4>ConfigurationWidget.setPreferences</h4>
377 <b>setPreferences</b>(<i></i>)
378 <p>
379 Public method called to store the selected values into the preferences storage.
380 </p><a NAME="ConfigurationWidget.showConfigurationPageByName" ID="ConfigurationWidget.showConfigurationPageByName"></a>
381 <h4>ConfigurationWidget.showConfigurationPageByName</h4>
382 <b>showConfigurationPageByName</b>(<i>pageName</i>)
383 <p>
384 Public slot to show a named configuration page.
385 </p><dl>
386 <dt><i>pageName</i></dt>
387 <dd>
388 name of the configuration page to show (string)
389 </dd>
390 </dl>
391 <div align="right"><a href="#top">Up</a></div>
392 <hr /><hr />
393 <a NAME="ConfigurationWindow" ID="ConfigurationWindow"></a>
394 <h2>ConfigurationWindow</h2>
395 <p>
396 Main window class for the standalone dialog.
397 </p>
398 <h3>Derived from</h3>
399 QMainWindow
400 <h3>Class Attributes</h3>
401 <table>
402 <tr><td>None</td></tr>
403 </table>
404 <h3>Methods</h3>
405 <table>
406 <tr>
407 <td><a href="#ConfigurationWindow.__init__">ConfigurationWindow</a></td>
408 <td>Constructor</td>
409 </tr><tr>
410 <td><a href="#ConfigurationWindow.accept">accept</a></td>
411 <td>Protected slot called by the Ok button.</td>
412 </tr><tr>
413 <td><a href="#ConfigurationWindow.showConfigurationPageByName">showConfigurationPageByName</a></td>
414 <td>Public slot to show a named configuration page.</td>
415 </tr>
416 </table>
417 <a NAME="ConfigurationWindow.__init__" ID="ConfigurationWindow.__init__"></a>
418 <h4>ConfigurationWindow (Constructor)</h4>
419 <b>ConfigurationWindow</b>(<i>parent = None</i>)
420 <p>
421 Constructor
422 </p><dl>
423 <dt><i>parent</i></dt>
424 <dd>
425 reference to the parent widget (QWidget)
426 </dd>
427 </dl><a NAME="ConfigurationWindow.accept" ID="ConfigurationWindow.accept"></a>
428 <h4>ConfigurationWindow.accept</h4>
429 <b>accept</b>(<i></i>)
430 <p>
431 Protected slot called by the Ok button.
432 </p><a NAME="ConfigurationWindow.showConfigurationPageByName" ID="ConfigurationWindow.showConfigurationPageByName"></a>
433 <h4>ConfigurationWindow.showConfigurationPageByName</h4>
434 <b>showConfigurationPageByName</b>(<i>pageName</i>)
435 <p>
436 Public slot to show a named configuration page.
437 </p><dl>
438 <dt><i>pageName</i></dt>
439 <dd>
440 name of the configuration page to show (string)
441 </dd>
442 </dl>
443 <div align="right"><a href="#top">Up</a></div>
444 <hr />
445 </body></html>

Mercurial Repository: eric

eric ide

mercurial