Mercurial Repositories > eric / file comparison

comparison: src/eric7/Documentation/Source/eric7.Preferences.ConfigurationDialog.html

src/eric7/Documentation/Source/eric7.Preferences.ConfigurationDialog.html

branch
eric7
changeset 10479
856476537696
parent 10428
a071d4065202
child 10518
1682f3203ae5
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
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>eric7.Preferences.ConfigurationDialog</h1> 9 <h1>eric7.Preferences.ConfigurationDialog</h1>
10
11 <p> 10 <p>
12 Module implementing a dialog for the configuration of eric. 11 Module implementing a dialog for the configuration of eric.
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="#ConfigurationDialog">ConfigurationDialog</a></td> 22 <td><a href="#ConfigurationDialog">ConfigurationDialog</a></td>
25 <td>Class for the dialog variant.</td> 23 <td>Class for the dialog variant.</td>
26 </tr> 24 </tr>
27 <tr> 25 <tr>
39 <tr> 37 <tr>
40 <td><a href="#ConfigurationWindow">ConfigurationWindow</a></td> 38 <td><a href="#ConfigurationWindow">ConfigurationWindow</a></td>
41 <td>Main window class for the standalone dialog.</td> 39 <td>Main window class for the standalone dialog.</td>
42 </tr> 40 </tr>
43 </table> 41 </table>
42
44 <h3>Functions</h3> 43 <h3>Functions</h3>
45 44 <table>
46 <table> 45 <tr><td>None</td></tr>
47 <tr><td>None</td></tr> 46 </table>
48 </table> 47
49 <hr /> 48 <hr />
50 <hr /> 49 <hr />
51 <a NAME="ConfigurationDialog" ID="ConfigurationDialog"></a> 50 <a NAME="ConfigurationDialog" ID="ConfigurationDialog"></a>
52 <h2>ConfigurationDialog</h2> 51 <h2>ConfigurationDialog</h2>
53
54 <p> 52 <p>
55 Class for the dialog variant. 53 Class for the dialog variant.
56 </p> 54 </p>
55
57 <h3>Signals</h3> 56 <h3>Signals</h3>
58 <dl> 57 <dl>
59 58
60 <dt>mainPasswordChanged(str, str)</dt> 59 <dt>mainPasswordChanged(str, str)</dt>
61 <dd> 60 <dd>
68 </dd> 67 </dd>
69 </dl> 68 </dl>
70 <h3>Derived from</h3> 69 <h3>Derived from</h3>
71 QDialog 70 QDialog
72 <h3>Class Attributes</h3> 71 <h3>Class Attributes</h3>
73 72 <table>
74 <table> 73 <tr><td>None</td></tr>
75 <tr><td>None</td></tr> 74 </table>
76 </table> 75
77 <h3>Class Methods</h3> 76 <h3>Class Methods</h3>
78 77 <table>
79 <table> 78 <tr><td>None</td></tr>
80 <tr><td>None</td></tr> 79 </table>
81 </table> 80
82 <h3>Methods</h3> 81 <h3>Methods</h3>
83 82 <table>
84 <table>
85
86 <tr> 83 <tr>
87 <td><a href="#ConfigurationDialog.__init__">ConfigurationDialog</a></td> 84 <td><a href="#ConfigurationDialog.__init__">ConfigurationDialog</a></td>
88 <td>Constructor</td> 85 <td>Constructor</td>
89 </tr> 86 </tr>
90 <tr> 87 <tr>
114 <tr> 111 <tr>
115 <td><a href="#ConfigurationDialog.showConfigurationPageByName">showConfigurationPageByName</a></td> 112 <td><a href="#ConfigurationDialog.showConfigurationPageByName">showConfigurationPageByName</a></td>
116 <td>Public slot to show a named configuration page.</td> 113 <td>Public slot to show a named configuration page.</td>
117 </tr> 114 </tr>
118 </table> 115 </table>
116
119 <h3>Static Methods</h3> 117 <h3>Static Methods</h3>
120 118 <table>
121 <table> 119 <tr><td>None</td></tr>
122 <tr><td>None</td></tr> 120 </table>
123 </table> 121
124 122
125 <a NAME="ConfigurationDialog.__init__" ID="ConfigurationDialog.__init__"></a> 123 <a NAME="ConfigurationDialog.__init__" ID="ConfigurationDialog.__init__"></a>
126 <h4>ConfigurationDialog (Constructor)</h4> 124 <h4>ConfigurationDialog (Constructor)</h4>
127 <b>ConfigurationDialog</b>(<i>parent=None, name=None, modal=False, fromEric=True, displayMode=ConfigurationMode.DEFAULTMODE, expandedEntries=None, </i>) 125 <b>ConfigurationDialog</b>(<i>parent=None, name=None, modal=False, fromEric=True, displayMode=ConfigurationMode.DEFAULTMODE, expandedEntries=None, </i>)
128
129 <p> 126 <p>
130 Constructor 127 Constructor
131 </p> 128 </p>
129
132 <dl> 130 <dl>
133 131
134 <dt><i>parent</i> (QWidget (optional))</dt> 132 <dt><i>parent</i> (QWidget (optional))</dt>
135 <dd> 133 <dd>
136 reference to the parent widget (defaults to None) 134 reference to the parent widget (defaults to None)
159 </dd> 157 </dd>
160 </dl> 158 </dl>
161 <a NAME="ConfigurationDialog.__mainPasswordChanged" ID="ConfigurationDialog.__mainPasswordChanged"></a> 159 <a NAME="ConfigurationDialog.__mainPasswordChanged" ID="ConfigurationDialog.__mainPasswordChanged"></a>
162 <h4>ConfigurationDialog.__mainPasswordChanged</h4> 160 <h4>ConfigurationDialog.__mainPasswordChanged</h4>
163 <b>__mainPasswordChanged</b>(<i>oldPassword, newPassword</i>) 161 <b>__mainPasswordChanged</b>(<i>oldPassword, newPassword</i>)
164
165 <p> 162 <p>
166 Private slot to handle the change of the main password. 163 Private slot to handle the change of the main password.
167 </p> 164 </p>
165
168 <dl> 166 <dl>
169 167
170 <dt><i>oldPassword</i> (str)</dt> 168 <dt><i>oldPassword</i> (str)</dt>
171 <dd> 169 <dd>
172 current password 170 current password
177 </dd> 175 </dd>
178 </dl> 176 </dl>
179 <a NAME="ConfigurationDialog.__preferencesChanged" ID="ConfigurationDialog.__preferencesChanged"></a> 177 <a NAME="ConfigurationDialog.__preferencesChanged" ID="ConfigurationDialog.__preferencesChanged"></a>
180 <h4>ConfigurationDialog.__preferencesChanged</h4> 178 <h4>ConfigurationDialog.__preferencesChanged</h4>
181 <b>__preferencesChanged</b>(<i></i>) 179 <b>__preferencesChanged</b>(<i></i>)
182
183 <p> 180 <p>
184 Private slot to handle a change of the preferences. 181 Private slot to handle a change of the preferences.
185 </p> 182 </p>
183
186 <a NAME="ConfigurationDialog.accept" ID="ConfigurationDialog.accept"></a> 184 <a NAME="ConfigurationDialog.accept" ID="ConfigurationDialog.accept"></a>
187 <h4>ConfigurationDialog.accept</h4> 185 <h4>ConfigurationDialog.accept</h4>
188 <b>accept</b>(<i></i>) 186 <b>accept</b>(<i></i>)
189
190 <p> 187 <p>
191 Public method to accept the dialog. 188 Public method to accept the dialog.
192 </p> 189 </p>
190
193 <a NAME="ConfigurationDialog.getConfigurationPageName" ID="ConfigurationDialog.getConfigurationPageName"></a> 191 <a NAME="ConfigurationDialog.getConfigurationPageName" ID="ConfigurationDialog.getConfigurationPageName"></a>
194 <h4>ConfigurationDialog.getConfigurationPageName</h4> 192 <h4>ConfigurationDialog.getConfigurationPageName</h4>
195 <b>getConfigurationPageName</b>(<i></i>) 193 <b>getConfigurationPageName</b>(<i></i>)
196
197 <p> 194 <p>
198 Public method to get the page name of the current page. 195 Public method to get the page name of the current page.
199 </p> 196 </p>
197
200 <dl> 198 <dl>
201 <dt>Return:</dt> 199 <dt>Return:</dt>
202 <dd> 200 <dd>
203 page name of the current page 201 page name of the current page
204 </dd> 202 </dd>
210 </dd> 208 </dd>
211 </dl> 209 </dl>
212 <a NAME="ConfigurationDialog.getExpandedEntries" ID="ConfigurationDialog.getExpandedEntries"></a> 210 <a NAME="ConfigurationDialog.getExpandedEntries" ID="ConfigurationDialog.getExpandedEntries"></a>
213 <h4>ConfigurationDialog.getExpandedEntries</h4> 211 <h4>ConfigurationDialog.getExpandedEntries</h4>
214 <b>getExpandedEntries</b>(<i></i>) 212 <b>getExpandedEntries</b>(<i></i>)
215
216 <p> 213 <p>
217 Public method to get a list of expanded entries. 214 Public method to get a list of expanded entries.
218 </p> 215 </p>
216
219 <dl> 217 <dl>
220 <dt>Return:</dt> 218 <dt>Return:</dt>
221 <dd> 219 <dd>
222 list of expanded entries 220 list of expanded entries
223 </dd> 221 </dd>
229 </dd> 227 </dd>
230 </dl> 228 </dl>
231 <a NAME="ConfigurationDialog.setPreferences" ID="ConfigurationDialog.setPreferences"></a> 229 <a NAME="ConfigurationDialog.setPreferences" ID="ConfigurationDialog.setPreferences"></a>
232 <h4>ConfigurationDialog.setPreferences</h4> 230 <h4>ConfigurationDialog.setPreferences</h4>
233 <b>setPreferences</b>(<i></i>) 231 <b>setPreferences</b>(<i></i>)
234
235 <p> 232 <p>
236 Public method called to store the selected values into the preferences 233 Public method called to store the selected values into the preferences
237 storage. 234 storage.
238 </p> 235 </p>
236
239 <a NAME="ConfigurationDialog.showConfigurationPageByName" ID="ConfigurationDialog.showConfigurationPageByName"></a> 237 <a NAME="ConfigurationDialog.showConfigurationPageByName" ID="ConfigurationDialog.showConfigurationPageByName"></a>
240 <h4>ConfigurationDialog.showConfigurationPageByName</h4> 238 <h4>ConfigurationDialog.showConfigurationPageByName</h4>
241 <b>showConfigurationPageByName</b>(<i>pageName</i>) 239 <b>showConfigurationPageByName</b>(<i>pageName</i>)
242
243 <p> 240 <p>
244 Public slot to show a named configuration page. 241 Public slot to show a named configuration page.
245 </p> 242 </p>
243
246 <dl> 244 <dl>
247 245
248 <dt><i>pageName</i> (str)</dt> 246 <dt><i>pageName</i> (str)</dt>
249 <dd> 247 <dd>
250 name of the configuration page to show 248 name of the configuration page to show
253 <div align="right"><a href="#top">Up</a></div> 251 <div align="right"><a href="#top">Up</a></div>
254 <hr /> 252 <hr />
255 <hr /> 253 <hr />
256 <a NAME="ConfigurationMode" ID="ConfigurationMode"></a> 254 <a NAME="ConfigurationMode" ID="ConfigurationMode"></a>
257 <h2>ConfigurationMode</h2> 255 <h2>ConfigurationMode</h2>
258
259 <p> 256 <p>
260 Class defining the various modes of the configuration widget. 257 Class defining the various modes of the configuration widget.
261 </p> 258 </p>
259
262 <h3>Derived from</h3> 260 <h3>Derived from</h3>
263 enum.Enum 261 enum.Enum
264 <h3>Class Attributes</h3> 262 <h3>Class Attributes</h3>
265 263 <table>
266 <table> 264 <tr><td>DEFAULTMODE</td></tr>
267 <tr><td>DEFAULTMODE</td></tr><tr><td>EDITORMODE</td></tr><tr><td>HEXEDITORMODE</td></tr><tr><td>PDFVIEWERMODE</td></tr><tr><td>PIPMANAGERMODE</td></tr><tr><td>SHELLMODE</td></tr><tr><td>TRAYSTARTERMODE</td></tr><tr><td>WEBBROWSERMODE</td></tr> 265 <tr><td>EDITORMODE</td></tr>
268 </table> 266 <tr><td>HEXEDITORMODE</td></tr>
267 <tr><td>PDFVIEWERMODE</td></tr>
268 <tr><td>PIPMANAGERMODE</td></tr>
269 <tr><td>SHELLMODE</td></tr>
270 <tr><td>TRAYSTARTERMODE</td></tr>
271 <tr><td>WEBBROWSERMODE</td></tr>
272 </table>
273
269 <h3>Class Methods</h3> 274 <h3>Class Methods</h3>
270 275 <table>
271 <table> 276 <tr><td>None</td></tr>
272 <tr><td>None</td></tr> 277 </table>
273 </table> 278
274 <h3>Methods</h3> 279 <h3>Methods</h3>
275 280 <table>
276 <table> 281 <tr><td>None</td></tr>
277 <tr><td>None</td></tr> 282 </table>
278 </table> 283
279 <h3>Static Methods</h3> 284 <h3>Static Methods</h3>
280 285 <table>
281 <table> 286 <tr><td>None</td></tr>
282 <tr><td>None</td></tr> 287 </table>
283 </table> 288
284 289
285 <div align="right"><a href="#top">Up</a></div> 290 <div align="right"><a href="#top">Up</a></div>
286 <hr /> 291 <hr />
287 <hr /> 292 <hr />
288 <a NAME="ConfigurationPageItem" ID="ConfigurationPageItem"></a> 293 <a NAME="ConfigurationPageItem" ID="ConfigurationPageItem"></a>
289 <h2>ConfigurationPageItem</h2> 294 <h2>ConfigurationPageItem</h2>
290
291 <p> 295 <p>
292 Class implementing a QTreeWidgetItem holding the configuration page data. 296 Class implementing a QTreeWidgetItem holding the configuration page data.
293 </p> 297 </p>
298
294 <h3>Derived from</h3> 299 <h3>Derived from</h3>
295 QTreeWidgetItem 300 QTreeWidgetItem
296 <h3>Class Attributes</h3> 301 <h3>Class Attributes</h3>
297 302 <table>
298 <table> 303 <tr><td>None</td></tr>
299 <tr><td>None</td></tr> 304 </table>
300 </table> 305
301 <h3>Class Methods</h3> 306 <h3>Class Methods</h3>
302 307 <table>
303 <table> 308 <tr><td>None</td></tr>
304 <tr><td>None</td></tr> 309 </table>
305 </table> 310
306 <h3>Methods</h3> 311 <h3>Methods</h3>
307 312 <table>
308 <table>
309
310 <tr> 313 <tr>
311 <td><a href="#ConfigurationPageItem.__init__">ConfigurationPageItem</a></td> 314 <td><a href="#ConfigurationPageItem.__init__">ConfigurationPageItem</a></td>
312 <td>Constructor</td> 315 <td>Constructor</td>
313 </tr> 316 </tr>
314 <tr> 317 <tr>
315 <td><a href="#ConfigurationPageItem.getPageName">getPageName</a></td> 318 <td><a href="#ConfigurationPageItem.getPageName">getPageName</a></td>
316 <td>Public method to get the name of the associated configuration page.</td> 319 <td>Public method to get the name of the associated configuration page.</td>
317 </tr> 320 </tr>
318 </table> 321 </table>
322
319 <h3>Static Methods</h3> 323 <h3>Static Methods</h3>
320 324 <table>
321 <table> 325 <tr><td>None</td></tr>
322 <tr><td>None</td></tr> 326 </table>
323 </table> 327
324 328
325 <a NAME="ConfigurationPageItem.__init__" ID="ConfigurationPageItem.__init__"></a> 329 <a NAME="ConfigurationPageItem.__init__" ID="ConfigurationPageItem.__init__"></a>
326 <h4>ConfigurationPageItem (Constructor)</h4> 330 <h4>ConfigurationPageItem (Constructor)</h4>
327 <b>ConfigurationPageItem</b>(<i>parent, text, pageName, iconFile</i>) 331 <b>ConfigurationPageItem</b>(<i>parent, text, pageName, iconFile</i>)
328
329 <p> 332 <p>
330 Constructor 333 Constructor
331 </p> 334 </p>
335
332 <dl> 336 <dl>
333 337
334 <dt><i>parent</i> (QTreeWidget or QTreeWidgetItem)</dt> 338 <dt><i>parent</i> (QTreeWidget or QTreeWidgetItem)</dt>
335 <dd> 339 <dd>
336 parent widget of the item 340 parent widget of the item
349 </dd> 353 </dd>
350 </dl> 354 </dl>
351 <a NAME="ConfigurationPageItem.getPageName" ID="ConfigurationPageItem.getPageName"></a> 355 <a NAME="ConfigurationPageItem.getPageName" ID="ConfigurationPageItem.getPageName"></a>
352 <h4>ConfigurationPageItem.getPageName</h4> 356 <h4>ConfigurationPageItem.getPageName</h4>
353 <b>getPageName</b>(<i></i>) 357 <b>getPageName</b>(<i></i>)
354
355 <p> 358 <p>
356 Public method to get the name of the associated configuration page. 359 Public method to get the name of the associated configuration page.
357 </p> 360 </p>
361
358 <dl> 362 <dl>
359 <dt>Return:</dt> 363 <dt>Return:</dt>
360 <dd> 364 <dd>
361 name of the configuration page 365 name of the configuration page
362 </dd> 366 </dd>
370 <div align="right"><a href="#top">Up</a></div> 374 <div align="right"><a href="#top">Up</a></div>
371 <hr /> 375 <hr />
372 <hr /> 376 <hr />
373 <a NAME="ConfigurationWidget" ID="ConfigurationWidget"></a> 377 <a NAME="ConfigurationWidget" ID="ConfigurationWidget"></a>
374 <h2>ConfigurationWidget</h2> 378 <h2>ConfigurationWidget</h2>
375
376 <p> 379 <p>
377 Class implementing a dialog for the configuration of eric. 380 Class implementing a dialog for the configuration of eric.
378 </p> 381 </p>
382
379 <h3>Signals</h3> 383 <h3>Signals</h3>
380 <dl> 384 <dl>
381 385
382 <dt>accepted()</dt> 386 <dt>accepted()</dt>
383 <dd> 387 <dd>
398 </dd> 402 </dd>
399 </dl> 403 </dl>
400 <h3>Derived from</h3> 404 <h3>Derived from</h3>
401 QWidget 405 QWidget
402 <h3>Class Attributes</h3> 406 <h3>Class Attributes</h3>
403 407 <table>
404 <table> 408 <tr><td>None</td></tr>
405 <tr><td>None</td></tr> 409 </table>
406 </table> 410
407 <h3>Class Methods</h3> 411 <h3>Class Methods</h3>
408 412 <table>
409 <table> 413 <tr><td>None</td></tr>
410 <tr><td>None</td></tr> 414 </table>
411 </table> 415
412 <h3>Methods</h3> 416 <h3>Methods</h3>
413 417 <table>
414 <table>
415
416 <tr> 418 <tr>
417 <td><a href="#ConfigurationWidget.__init__">ConfigurationWidget</a></td> 419 <td><a href="#ConfigurationWidget.__init__">ConfigurationWidget</a></td>
418 <td>Constructor</td> 420 <td>Constructor</td>
419 </tr> 421 </tr>
420 <tr> 422 <tr>
508 <tr> 510 <tr>
509 <td><a href="#ConfigurationWidget.showConfigurationPageByName">showConfigurationPageByName</a></td> 511 <td><a href="#ConfigurationWidget.showConfigurationPageByName">showConfigurationPageByName</a></td>
510 <td>Public slot to show a named configuration page.</td> 512 <td>Public slot to show a named configuration page.</td>
511 </tr> 513 </tr>
512 </table> 514 </table>
515
513 <h3>Static Methods</h3> 516 <h3>Static Methods</h3>
514 517 <table>
515 <table> 518 <tr><td>None</td></tr>
516 <tr><td>None</td></tr> 519 </table>
517 </table> 520
518 521
519 <a NAME="ConfigurationWidget.__init__" ID="ConfigurationWidget.__init__"></a> 522 <a NAME="ConfigurationWidget.__init__" ID="ConfigurationWidget.__init__"></a>
520 <h4>ConfigurationWidget (Constructor)</h4> 523 <h4>ConfigurationWidget (Constructor)</h4>
521 <b>ConfigurationWidget</b>(<i>parent=None, fromEric=True, displayMode=ConfigurationMode.DEFAULTMODE, expandedEntries=None, withApply=True, </i>) 524 <b>ConfigurationWidget</b>(<i>parent=None, fromEric=True, displayMode=ConfigurationMode.DEFAULTMODE, expandedEntries=None, withApply=True, </i>)
522
523 <p> 525 <p>
524 Constructor 526 Constructor
525 </p> 527 </p>
528
526 <dl> 529 <dl>
527 530
528 <dt><i>parent</i> (QWidget (optional))</dt> 531 <dt><i>parent</i> (QWidget (optional))</dt>
529 <dd> 532 <dd>
530 reference to the parent widget (defaults to None) 533 reference to the parent widget (defaults to None)
549 </dd> 552 </dd>
550 </dl> 553 </dl>
551 <a NAME="ConfigurationWidget.__importConfigurationPage" ID="ConfigurationWidget.__importConfigurationPage"></a> 554 <a NAME="ConfigurationWidget.__importConfigurationPage" ID="ConfigurationWidget.__importConfigurationPage"></a>
552 <h4>ConfigurationWidget.__importConfigurationPage</h4> 555 <h4>ConfigurationWidget.__importConfigurationPage</h4>
553 <b>__importConfigurationPage</b>(<i>name</i>) 556 <b>__importConfigurationPage</b>(<i>name</i>)
554
555 <p> 557 <p>
556 Private method to import a configuration page module. 558 Private method to import a configuration page module.
557 </p> 559 </p>
560
558 <dl> 561 <dl>
559 562
560 <dt><i>name</i> (str)</dt> 563 <dt><i>name</i> (str)</dt>
561 <dd> 564 <dd>
562 name of the configuration page module 565 name of the configuration page module
575 </dd> 578 </dd>
576 </dl> 579 </dl>
577 <a NAME="ConfigurationWidget.__initLexers" ID="ConfigurationWidget.__initLexers"></a> 580 <a NAME="ConfigurationWidget.__initLexers" ID="ConfigurationWidget.__initLexers"></a>
578 <h4>ConfigurationWidget.__initLexers</h4> 581 <h4>ConfigurationWidget.__initLexers</h4>
579 <b>__initLexers</b>(<i></i>) 582 <b>__initLexers</b>(<i></i>)
580
581 <p> 583 <p>
582 Private method to initialize the dictionary of preferences lexers. 584 Private method to initialize the dictionary of preferences lexers.
583 </p> 585 </p>
586
584 <a NAME="ConfigurationWidget.__initPage" ID="ConfigurationWidget.__initPage"></a> 587 <a NAME="ConfigurationWidget.__initPage" ID="ConfigurationWidget.__initPage"></a>
585 <h4>ConfigurationWidget.__initPage</h4> 588 <h4>ConfigurationWidget.__initPage</h4>
586 <b>__initPage</b>(<i>pageData</i>) 589 <b>__initPage</b>(<i>pageData</i>)
587
588 <p> 590 <p>
589 Private method to initialize a configuration page. 591 Private method to initialize a configuration page.
590 </p> 592 </p>
593
591 <dl> 594 <dl>
592 595
593 <dt><i>pageData</i> (list)</dt> 596 <dt><i>pageData</i> (list)</dt>
594 <dd> 597 <dd>
595 data structure for the page to initialize 598 data structure for the page to initialize
608 </dd> 611 </dd>
609 </dl> 612 </dl>
610 <a NAME="ConfigurationWidget.__resizeConfigStack" ID="ConfigurationWidget.__resizeConfigStack"></a> 613 <a NAME="ConfigurationWidget.__resizeConfigStack" ID="ConfigurationWidget.__resizeConfigStack"></a>
611 <h4>ConfigurationWidget.__resizeConfigStack</h4> 614 <h4>ConfigurationWidget.__resizeConfigStack</h4>
612 <b>__resizeConfigStack</b>(<i></i>) 615 <b>__resizeConfigStack</b>(<i></i>)
613
614 <p> 616 <p>
615 Private method to resize the stack of configuration pages. 617 Private method to resize the stack of configuration pages.
616 </p> 618 </p>
619
617 <a NAME="ConfigurationWidget.__searchChildItems" ID="ConfigurationWidget.__searchChildItems"></a> 620 <a NAME="ConfigurationWidget.__searchChildItems" ID="ConfigurationWidget.__searchChildItems"></a>
618 <h4>ConfigurationWidget.__searchChildItems</h4> 621 <h4>ConfigurationWidget.__searchChildItems</h4>
619 <b>__searchChildItems</b>(<i>parent, text</i>) 622 <b>__searchChildItems</b>(<i>parent, text</i>)
620
621 <p> 623 <p>
622 Private method to enable child items based on a search string. 624 Private method to enable child items based on a search string.
623 </p> 625 </p>
626
624 <dl> 627 <dl>
625 628
626 <dt><i>parent</i> (QTreeWidgetItem)</dt> 629 <dt><i>parent</i> (QTreeWidgetItem)</dt>
627 <dd> 630 <dd>
628 reference to the parent item 631 reference to the parent item
645 </dd> 648 </dd>
646 </dl> 649 </dl>
647 <a NAME="ConfigurationWidget.__searchTextChanged" ID="ConfigurationWidget.__searchTextChanged"></a> 650 <a NAME="ConfigurationWidget.__searchTextChanged" ID="ConfigurationWidget.__searchTextChanged"></a>
648 <h4>ConfigurationWidget.__searchTextChanged</h4> 651 <h4>ConfigurationWidget.__searchTextChanged</h4>
649 <b>__searchTextChanged</b>(<i>text</i>) 652 <b>__searchTextChanged</b>(<i>text</i>)
650
651 <p> 653 <p>
652 Private slot to handle a change of the search text. 654 Private slot to handle a change of the search text.
653 </p> 655 </p>
656
654 <dl> 657 <dl>
655 658
656 <dt><i>text</i> (str)</dt> 659 <dt><i>text</i> (str)</dt>
657 <dd> 660 <dd>
658 text to search for 661 text to search for
659 </dd> 662 </dd>
660 </dl> 663 </dl>
661 <a NAME="ConfigurationWidget.__setupUi" ID="ConfigurationWidget.__setupUi"></a> 664 <a NAME="ConfigurationWidget.__setupUi" ID="ConfigurationWidget.__setupUi"></a>
662 <h4>ConfigurationWidget.__setupUi</h4> 665 <h4>ConfigurationWidget.__setupUi</h4>
663 <b>__setupUi</b>(<i>withApply=True</i>) 666 <b>__setupUi</b>(<i>withApply=True</i>)
664
665 <p> 667 <p>
666 Private method to perform the general setup of the configuration 668 Private method to perform the general setup of the configuration
667 widget. 669 widget.
668 </p> 670 </p>
671
669 <dl> 672 <dl>
670 673
671 <dt><i>withApply</i> (bool (optional))</dt> 674 <dt><i>withApply</i> (bool (optional))</dt>
672 <dd> 675 <dd>
673 flag indicating to show the 'Apply' button (defaults to True) 676 flag indicating to show the 'Apply' button (defaults to True)
674 </dd> 677 </dd>
675 </dl> 678 </dl>
676 <a NAME="ConfigurationWidget.__showConfigurationPage" ID="ConfigurationWidget.__showConfigurationPage"></a> 679 <a NAME="ConfigurationWidget.__showConfigurationPage" ID="ConfigurationWidget.__showConfigurationPage"></a>
677 <h4>ConfigurationWidget.__showConfigurationPage</h4> 680 <h4>ConfigurationWidget.__showConfigurationPage</h4>
678 <b>__showConfigurationPage</b>(<i>itm</i>) 681 <b>__showConfigurationPage</b>(<i>itm</i>)
679
680 <p> 682 <p>
681 Private slot to show a selected configuration page. 683 Private slot to show a selected configuration page.
682 </p> 684 </p>
685
683 <dl> 686 <dl>
684 687
685 <dt><i>itm</i> (QTreeWidgetItem)</dt> 688 <dt><i>itm</i> (QTreeWidgetItem)</dt>
686 <dd> 689 <dd>
687 reference to the selected item 690 reference to the selected item
688 </dd> 691 </dd>
689 </dl> 692 </dl>
690 <a NAME="ConfigurationWidget.accept" ID="ConfigurationWidget.accept"></a> 693 <a NAME="ConfigurationWidget.accept" ID="ConfigurationWidget.accept"></a>
691 <h4>ConfigurationWidget.accept</h4> 694 <h4>ConfigurationWidget.accept</h4>
692 <b>accept</b>(<i></i>) 695 <b>accept</b>(<i></i>)
693
694 <p> 696 <p>
695 Public slot to accept the buttonBox accept signal. 697 Public slot to accept the buttonBox accept signal.
696 </p> 698 </p>
699
697 <a NAME="ConfigurationWidget.calledFromEric" ID="ConfigurationWidget.calledFromEric"></a> 700 <a NAME="ConfigurationWidget.calledFromEric" ID="ConfigurationWidget.calledFromEric"></a>
698 <h4>ConfigurationWidget.calledFromEric</h4> 701 <h4>ConfigurationWidget.calledFromEric</h4>
699 <b>calledFromEric</b>(<i></i>) 702 <b>calledFromEric</b>(<i></i>)
700
701 <p> 703 <p>
702 Public method to check, if invoked from within eric. 704 Public method to check, if invoked from within eric.
703 </p> 705 </p>
706
704 <dl> 707 <dl>
705 <dt>Return:</dt> 708 <dt>Return:</dt>
706 <dd> 709 <dd>
707 flag indicating invocation from within eric 710 flag indicating invocation from within eric
708 </dd> 711 </dd>
714 </dd> 717 </dd>
715 </dl> 718 </dl>
716 <a NAME="ConfigurationWidget.getConfigurationPageName" ID="ConfigurationWidget.getConfigurationPageName"></a> 719 <a NAME="ConfigurationWidget.getConfigurationPageName" ID="ConfigurationWidget.getConfigurationPageName"></a>
717 <h4>ConfigurationWidget.getConfigurationPageName</h4> 720 <h4>ConfigurationWidget.getConfigurationPageName</h4>
718 <b>getConfigurationPageName</b>(<i></i>) 721 <b>getConfigurationPageName</b>(<i></i>)
719
720 <p> 722 <p>
721 Public method to get the page name of the current page. 723 Public method to get the page name of the current page.
722 </p> 724 </p>
725
723 <dl> 726 <dl>
724 <dt>Return:</dt> 727 <dt>Return:</dt>
725 <dd> 728 <dd>
726 page name of the current page 729 page name of the current page
727 </dd> 730 </dd>
733 </dd> 736 </dd>
734 </dl> 737 </dl>
735 <a NAME="ConfigurationWidget.getExpandedEntries" ID="ConfigurationWidget.getExpandedEntries"></a> 738 <a NAME="ConfigurationWidget.getExpandedEntries" ID="ConfigurationWidget.getExpandedEntries"></a>
736 <h4>ConfigurationWidget.getExpandedEntries</h4> 739 <h4>ConfigurationWidget.getExpandedEntries</h4>
737 <b>getExpandedEntries</b>(<i></i>) 740 <b>getExpandedEntries</b>(<i></i>)
738
739 <p> 741 <p>
740 Public method to get a list of expanded entries. 742 Public method to get a list of expanded entries.
741 </p> 743 </p>
744
742 <dl> 745 <dl>
743 <dt>Return:</dt> 746 <dt>Return:</dt>
744 <dd> 747 <dd>
745 list of expanded entries 748 list of expanded entries
746 </dd> 749 </dd>
752 </dd> 755 </dd>
753 </dl> 756 </dl>
754 <a NAME="ConfigurationWidget.getLexers" ID="ConfigurationWidget.getLexers"></a> 757 <a NAME="ConfigurationWidget.getLexers" ID="ConfigurationWidget.getLexers"></a>
755 <h4>ConfigurationWidget.getLexers</h4> 758 <h4>ConfigurationWidget.getLexers</h4>
756 <b>getLexers</b>(<i></i>) 759 <b>getLexers</b>(<i></i>)
757
758 <p> 760 <p>
759 Public method to get a reference to the lexers dictionary. 761 Public method to get a reference to the lexers dictionary.
760 </p> 762 </p>
763
761 <dl> 764 <dl>
762 <dt>Return:</dt> 765 <dt>Return:</dt>
763 <dd> 766 <dd>
764 reference to the lexers dictionary 767 reference to the lexers dictionary
765 </dd> 768 </dd>
771 </dd> 774 </dd>
772 </dl> 775 </dl>
773 <a NAME="ConfigurationWidget.getPage" ID="ConfigurationWidget.getPage"></a> 776 <a NAME="ConfigurationWidget.getPage" ID="ConfigurationWidget.getPage"></a>
774 <h4>ConfigurationWidget.getPage</h4> 777 <h4>ConfigurationWidget.getPage</h4>
775 <b>getPage</b>(<i>pageName</i>) 778 <b>getPage</b>(<i>pageName</i>)
776
777 <p> 779 <p>
778 Public method to get a reference to the named page. 780 Public method to get a reference to the named page.
779 </p> 781 </p>
782
780 <dl> 783 <dl>
781 784
782 <dt><i>pageName</i> (str)</dt> 785 <dt><i>pageName</i> (str)</dt>
783 <dd> 786 <dd>
784 name of the configuration page 787 name of the configuration page
798 </dd> 801 </dd>
799 </dl> 802 </dl>
800 <a NAME="ConfigurationWidget.isUsingWebEngine" ID="ConfigurationWidget.isUsingWebEngine"></a> 803 <a NAME="ConfigurationWidget.isUsingWebEngine" ID="ConfigurationWidget.isUsingWebEngine"></a>
801 <h4>ConfigurationWidget.isUsingWebEngine</h4> 804 <h4>ConfigurationWidget.isUsingWebEngine</h4>
802 <b>isUsingWebEngine</b>(<i></i>) 805 <b>isUsingWebEngine</b>(<i></i>)
803
804 <p> 806 <p>
805 Public method to get an indication, if QtWebEngine is being used. 807 Public method to get an indication, if QtWebEngine is being used.
806 </p> 808 </p>
809
807 <dl> 810 <dl>
808 <dt>Return:</dt> 811 <dt>Return:</dt>
809 <dd> 812 <dd>
810 flag indicating the use of QtWebEngine 813 flag indicating the use of QtWebEngine
811 </dd> 814 </dd>
817 </dd> 820 </dd>
818 </dl> 821 </dl>
819 <a NAME="ConfigurationWidget.on_applyButton_clicked" ID="ConfigurationWidget.on_applyButton_clicked"></a> 822 <a NAME="ConfigurationWidget.on_applyButton_clicked" ID="ConfigurationWidget.on_applyButton_clicked"></a>
820 <h4>ConfigurationWidget.on_applyButton_clicked</h4> 823 <h4>ConfigurationWidget.on_applyButton_clicked</h4>
821 <b>on_applyButton_clicked</b>(<i></i>) 824 <b>on_applyButton_clicked</b>(<i></i>)
822
823 <p> 825 <p>
824 Private slot called to apply the settings of the current page. 826 Private slot called to apply the settings of the current page.
825 </p> 827 </p>
828
826 <a NAME="ConfigurationWidget.on_buttonBox_clicked" ID="ConfigurationWidget.on_buttonBox_clicked"></a> 829 <a NAME="ConfigurationWidget.on_buttonBox_clicked" ID="ConfigurationWidget.on_buttonBox_clicked"></a>
827 <h4>ConfigurationWidget.on_buttonBox_clicked</h4> 830 <h4>ConfigurationWidget.on_buttonBox_clicked</h4>
828 <b>on_buttonBox_clicked</b>(<i>button</i>) 831 <b>on_buttonBox_clicked</b>(<i>button</i>)
829
830 <p> 832 <p>
831 Private slot called by a button of the button box clicked. 833 Private slot called by a button of the button box clicked.
832 </p> 834 </p>
835
833 <dl> 836 <dl>
834 837
835 <dt><i>button</i> (QAbstractButton)</dt> 838 <dt><i>button</i> (QAbstractButton)</dt>
836 <dd> 839 <dd>
837 button that was clicked 840 button that was clicked
838 </dd> 841 </dd>
839 </dl> 842 </dl>
840 <a NAME="ConfigurationWidget.on_configList_itemCollapsed" ID="ConfigurationWidget.on_configList_itemCollapsed"></a> 843 <a NAME="ConfigurationWidget.on_configList_itemCollapsed" ID="ConfigurationWidget.on_configList_itemCollapsed"></a>
841 <h4>ConfigurationWidget.on_configList_itemCollapsed</h4> 844 <h4>ConfigurationWidget.on_configList_itemCollapsed</h4>
842 <b>on_configList_itemCollapsed</b>(<i>item</i>) 845 <b>on_configList_itemCollapsed</b>(<i>item</i>)
843
844 <p> 846 <p>
845 Private slot handling a list entry being collapsed. 847 Private slot handling a list entry being collapsed.
846 </p> 848 </p>
849
847 <dl> 850 <dl>
848 851
849 <dt><i>item</i> (QTreeWidgetItem)</dt> 852 <dt><i>item</i> (QTreeWidgetItem)</dt>
850 <dd> 853 <dd>
851 reference to the collapsed item 854 reference to the collapsed item
852 </dd> 855 </dd>
853 </dl> 856 </dl>
854 <a NAME="ConfigurationWidget.on_configList_itemExpanded" ID="ConfigurationWidget.on_configList_itemExpanded"></a> 857 <a NAME="ConfigurationWidget.on_configList_itemExpanded" ID="ConfigurationWidget.on_configList_itemExpanded"></a>
855 <h4>ConfigurationWidget.on_configList_itemExpanded</h4> 858 <h4>ConfigurationWidget.on_configList_itemExpanded</h4>
856 <b>on_configList_itemExpanded</b>(<i>item</i>) 859 <b>on_configList_itemExpanded</b>(<i>item</i>)
857
858 <p> 860 <p>
859 Private slot handling a list entry being expanded. 861 Private slot handling a list entry being expanded.
860 </p> 862 </p>
863
861 <dl> 864 <dl>
862 865
863 <dt><i>item</i> (QTreeWidgetItem)</dt> 866 <dt><i>item</i> (QTreeWidgetItem)</dt>
864 <dd> 867 <dd>
865 reference to the expanded item 868 reference to the expanded item
866 </dd> 869 </dd>
867 </dl> 870 </dl>
868 <a NAME="ConfigurationWidget.on_resetButton_clicked" ID="ConfigurationWidget.on_resetButton_clicked"></a> 871 <a NAME="ConfigurationWidget.on_resetButton_clicked" ID="ConfigurationWidget.on_resetButton_clicked"></a>
869 <h4>ConfigurationWidget.on_resetButton_clicked</h4> 872 <h4>ConfigurationWidget.on_resetButton_clicked</h4>
870 <b>on_resetButton_clicked</b>(<i></i>) 873 <b>on_resetButton_clicked</b>(<i></i>)
871
872 <p> 874 <p>
873 Private slot called to reset the settings of the current page. 875 Private slot called to reset the settings of the current page.
874 </p> 876 </p>
877
875 <a NAME="ConfigurationWidget.resizeEvent" ID="ConfigurationWidget.resizeEvent"></a> 878 <a NAME="ConfigurationWidget.resizeEvent" ID="ConfigurationWidget.resizeEvent"></a>
876 <h4>ConfigurationWidget.resizeEvent</h4> 879 <h4>ConfigurationWidget.resizeEvent</h4>
877 <b>resizeEvent</b>(<i>evt</i>) 880 <b>resizeEvent</b>(<i>evt</i>)
878
879 <p> 881 <p>
880 Protected method to handle the resizing of the widget. 882 Protected method to handle the resizing of the widget.
881 </p> 883 </p>
884
882 <dl> 885 <dl>
883 886
884 <dt><i>evt</i> (QResizeEvent)</dt> 887 <dt><i>evt</i> (QResizeEvent)</dt>
885 <dd> 888 <dd>
886 reference to the event object 889 reference to the event object
887 </dd> 890 </dd>
888 </dl> 891 </dl>
889 <a NAME="ConfigurationWidget.setPreferences" ID="ConfigurationWidget.setPreferences"></a> 892 <a NAME="ConfigurationWidget.setPreferences" ID="ConfigurationWidget.setPreferences"></a>
890 <h4>ConfigurationWidget.setPreferences</h4> 893 <h4>ConfigurationWidget.setPreferences</h4>
891 <b>setPreferences</b>(<i></i>) 894 <b>setPreferences</b>(<i></i>)
892
893 <p> 895 <p>
894 Public method called to store the selected values into the preferences 896 Public method called to store the selected values into the preferences
895 storage. 897 storage.
896 </p> 898 </p>
899
897 <a NAME="ConfigurationWidget.showConfigurationPageByName" ID="ConfigurationWidget.showConfigurationPageByName"></a> 900 <a NAME="ConfigurationWidget.showConfigurationPageByName" ID="ConfigurationWidget.showConfigurationPageByName"></a>
898 <h4>ConfigurationWidget.showConfigurationPageByName</h4> 901 <h4>ConfigurationWidget.showConfigurationPageByName</h4>
899 <b>showConfigurationPageByName</b>(<i>pageName, setCurrent=True</i>) 902 <b>showConfigurationPageByName</b>(<i>pageName, setCurrent=True</i>)
900
901 <p> 903 <p>
902 Public slot to show a named configuration page. 904 Public slot to show a named configuration page.
903 </p> 905 </p>
906
904 <dl> 907 <dl>
905 908
906 <dt><i>pageName</i> (str)</dt> 909 <dt><i>pageName</i> (str)</dt>
907 <dd> 910 <dd>
908 name of the configuration page to show 911 name of the configuration page to show
915 <div align="right"><a href="#top">Up</a></div> 918 <div align="right"><a href="#top">Up</a></div>
916 <hr /> 919 <hr />
917 <hr /> 920 <hr />
918 <a NAME="ConfigurationWindow" ID="ConfigurationWindow"></a> 921 <a NAME="ConfigurationWindow" ID="ConfigurationWindow"></a>
919 <h2>ConfigurationWindow</h2> 922 <h2>ConfigurationWindow</h2>
920
921 <p> 923 <p>
922 Main window class for the standalone dialog. 924 Main window class for the standalone dialog.
923 </p> 925 </p>
926
924 <h3>Derived from</h3> 927 <h3>Derived from</h3>
925 EricMainWindow 928 EricMainWindow
926 <h3>Class Attributes</h3> 929 <h3>Class Attributes</h3>
927 930 <table>
928 <table> 931 <tr><td>None</td></tr>
929 <tr><td>None</td></tr> 932 </table>
930 </table> 933
931 <h3>Class Methods</h3> 934 <h3>Class Methods</h3>
932 935 <table>
933 <table> 936 <tr><td>None</td></tr>
934 <tr><td>None</td></tr> 937 </table>
935 </table> 938
936 <h3>Methods</h3> 939 <h3>Methods</h3>
937 940 <table>
938 <table>
939
940 <tr> 941 <tr>
941 <td><a href="#ConfigurationWindow.__init__">ConfigurationWindow</a></td> 942 <td><a href="#ConfigurationWindow.__init__">ConfigurationWindow</a></td>
942 <td>Constructor</td> 943 <td>Constructor</td>
943 </tr> 944 </tr>
944 <tr> 945 <tr>
948 <tr> 949 <tr>
949 <td><a href="#ConfigurationWindow.showConfigurationPageByName">showConfigurationPageByName</a></td> 950 <td><a href="#ConfigurationWindow.showConfigurationPageByName">showConfigurationPageByName</a></td>
950 <td>Public slot to show a named configuration page.</td> 951 <td>Public slot to show a named configuration page.</td>
951 </tr> 952 </tr>
952 </table> 953 </table>
954
953 <h3>Static Methods</h3> 955 <h3>Static Methods</h3>
954 956 <table>
955 <table> 957 <tr><td>None</td></tr>
956 <tr><td>None</td></tr> 958 </table>
957 </table> 959
958 960
959 <a NAME="ConfigurationWindow.__init__" ID="ConfigurationWindow.__init__"></a> 961 <a NAME="ConfigurationWindow.__init__" ID="ConfigurationWindow.__init__"></a>
960 <h4>ConfigurationWindow (Constructor)</h4> 962 <h4>ConfigurationWindow (Constructor)</h4>
961 <b>ConfigurationWindow</b>(<i>parent=None</i>) 963 <b>ConfigurationWindow</b>(<i>parent=None</i>)
962
963 <p> 964 <p>
964 Constructor 965 Constructor
965 </p> 966 </p>
967
966 <dl> 968 <dl>
967 969
968 <dt><i>parent</i> (QWidget)</dt> 970 <dt><i>parent</i> (QWidget)</dt>
969 <dd> 971 <dd>
970 reference to the parent widget 972 reference to the parent widget
971 </dd> 973 </dd>
972 </dl> 974 </dl>
973 <a NAME="ConfigurationWindow.accept" ID="ConfigurationWindow.accept"></a> 975 <a NAME="ConfigurationWindow.accept" ID="ConfigurationWindow.accept"></a>
974 <h4>ConfigurationWindow.accept</h4> 976 <h4>ConfigurationWindow.accept</h4>
975 <b>accept</b>(<i></i>) 977 <b>accept</b>(<i></i>)
976
977 <p> 978 <p>
978 Public slot called by the Ok button. 979 Public slot called by the Ok button.
979 </p> 980 </p>
981
980 <a NAME="ConfigurationWindow.showConfigurationPageByName" ID="ConfigurationWindow.showConfigurationPageByName"></a> 982 <a NAME="ConfigurationWindow.showConfigurationPageByName" ID="ConfigurationWindow.showConfigurationPageByName"></a>
981 <h4>ConfigurationWindow.showConfigurationPageByName</h4> 983 <h4>ConfigurationWindow.showConfigurationPageByName</h4>
982 <b>showConfigurationPageByName</b>(<i>pageName</i>) 984 <b>showConfigurationPageByName</b>(<i>pageName</i>)
983
984 <p> 985 <p>
985 Public slot to show a named configuration page. 986 Public slot to show a named configuration page.
986 </p> 987 </p>
988
987 <dl> 989 <dl>
988 990
989 <dt><i>pageName</i> (str)</dt> 991 <dt><i>pageName</i> (str)</dt>
990 <dd> 992 <dd>
991 name of the configuration page to show 993 name of the configuration page to show

Mercurial Repository: eric

eric ide

mercurial