Documentation/Source/index-eric5.Preferences.html

Fri, 11 Mar 2011 16:51:57 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Fri, 11 Mar 2011 16:51:57 +0100
changeset 945
8cd4d08fa9f6
parent 440
69ace3e2dcf6
child 2367
78f6c8193d37
permissions
-rw-r--r--

Made code mostly PEP 8 compliant (except all whitespace and line length).

17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
1 <?xml version="1.0" encoding="utf-8"?>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
4 <html><head>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
5 <title>eric5.Preferences</title>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
6 <style>
21
b88a0e6268bd Fixed a bug in eric5-doc.py and regenerated docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 17
diff changeset
7 body {
440
69ace3e2dcf6 Fine tuned the new default style and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 409
diff changeset
8 background: #EDECE6;
21
b88a0e6268bd Fixed a bug in eric5-doc.py and regenerated docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 17
diff changeset
9 margin: 0em 1em 10em 1em;
b88a0e6268bd Fixed a bug in eric5-doc.py and regenerated docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 17
diff changeset
10 color: black;
b88a0e6268bd Fixed a bug in eric5-doc.py and regenerated docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 17
diff changeset
11 }
b88a0e6268bd Fixed a bug in eric5-doc.py and regenerated docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 17
diff changeset
12
409
0ea528e80202 Added another style for the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
13 h1 { color: white; background: #85774A; }
0ea528e80202 Added another style for the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
14 h2 { color: white; background: #85774A; }
440
69ace3e2dcf6 Fine tuned the new default style and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 409
diff changeset
15 h3 { color: white; background: #9D936E; }
69ace3e2dcf6 Fine tuned the new default style and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 409
diff changeset
16 h4 { color: white; background: #9D936E; }
21
b88a0e6268bd Fixed a bug in eric5-doc.py and regenerated docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 17
diff changeset
17
440
69ace3e2dcf6 Fine tuned the new default style and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 409
diff changeset
18 a { color: #BA6D36; }
21
b88a0e6268bd Fixed a bug in eric5-doc.py and regenerated docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 17
diff changeset
19
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
20 </style>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
21 </head>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
22 <body>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
23 <h1>eric5.Preferences</h1>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
24 <p>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
25 Package implementing the preferences interface.
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
26 </p><p>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
27 The preferences interface consists of a class, which defines the default
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
28 values for all configuration items and stores the actual values. These
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
29 values are read and written to the eric5 preferences file by module
945
8cd4d08fa9f6 Made code mostly PEP 8 compliant (except all whitespace and line length).
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 440
diff changeset
30 functions. The data is stored in a file in a subdirectory of the users home
8cd4d08fa9f6 Made code mostly PEP 8 compliant (except all whitespace and line length).
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 440
diff changeset
31 directory. The individual configuration data is accessed by accessor functions
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
32 defined on the module level. The module is simply imported wherever it is needed
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
33 with the statement 'import Preferences'. Do not use 'from Preferences import *'
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
34 to import it.
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
35 </p>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
36
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
37 <h3>Packages</h3>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
38 <table>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
39 <tr>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
40 <td><a href="index-eric5.Preferences.ConfigurationPages.html">ConfigurationPages</a></td>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
41 <td>Package implementing the various pages of the configuration dialog.</td>
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
42 </tr>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
43 </table>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
44
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
45 <h3>Modules</h3>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
46 <table>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
47 <tr>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
48 <td><a href="eric5.Preferences.ConfigurationDialog.html">ConfigurationDialog</a></td>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
49 <td>Module implementing a dialog for the configuration of eric5.</td>
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
50 </tr><tr>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
51 <td><a href="eric5.Preferences.PreferencesLexer.html">PreferencesLexer</a></td>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
52 <td>Module implementing a special QextScintilla lexer to handle the preferences.</td>
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
53 </tr><tr>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
54 <td><a href="eric5.Preferences.ProgramsDialog.html">ProgramsDialog</a></td>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
55 <td>Module implementing the Programs page.</td>
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
56 </tr><tr>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
57 <td><a href="eric5.Preferences.ShortcutDialog.html">ShortcutDialog</a></td>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
58 <td>Module implementing a dialog for the configuration of a keyboard shortcut.</td>
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
59 </tr><tr>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
60 <td><a href="eric5.Preferences.Shortcuts.html">Shortcuts</a></td>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
61 <td>Module implementing functions dealing with keyboard shortcuts.</td>
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
62 </tr><tr>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
63 <td><a href="eric5.Preferences.ShortcutsDialog.html">ShortcutsDialog</a></td>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
64 <td>Module implementing a dialog for the configuration of eric5s keyboard shortcuts.</td>
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
65 </tr><tr>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
66 <td><a href="eric5.Preferences.ToolConfigurationDialog.html">ToolConfigurationDialog</a></td>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
67 <td>Module implementing a configuration dialog for the tools menu.</td>
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
68 </tr><tr>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
69 <td><a href="eric5.Preferences.ToolGroupConfigurationDialog.html">ToolGroupConfigurationDialog</a></td>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
70 <td>Module implementing a configuration dialog for the tools menu.</td>
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
71 </tr><tr>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
72 <td><a href="eric5.Preferences.ViewProfileDialog.html">ViewProfileDialog</a></td>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
73 <td>Module implementing a dialog to configure the various view profiles.</td>
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
74 </tr><tr>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
75 <td><a href="eric5.Preferences.__init__.html">Preferences</a></td>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
76 <td>Package implementing the preferences interface.</td>
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
77 </tr>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
78 </table>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
79 </body></html>

eric ide

mercurial