Documentation/Source/index-eric5.Preferences.html

Mon, 17 Mar 2014 20:32:35 +0100

author
T.Rzepka <Tobias.Rzepka@gmail.com>
date
Mon, 17 Mar 2014 20:32:35 +0100
branch
BgService
changeset 3412
9364dab2d472
parent 3018
70924c0bdaf1
permissions
-rw-r--r--

Plug-in docu updated, now the return values of the syntax checker is a dictionary
with the two keys 'error' and 'warnings'.

2387
2d119e79ab54 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 2386
diff changeset
1 <!DOCTYPE html>
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
2 <html><head>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
3 <title>eric5.Preferences</title>
2387
2d119e79ab54 Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 2386
diff changeset
4 <meta charset="UTF-8">
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
5 <style>
21
b88a0e6268bd Fixed a bug in eric5-doc.py and regenerated docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 17
diff changeset
6 body {
440
69ace3e2dcf6 Fine tuned the new default style and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 409
diff changeset
7 background: #EDECE6;
21
b88a0e6268bd Fixed a bug in eric5-doc.py and regenerated docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 17
diff changeset
8 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
9 color: black;
b88a0e6268bd Fixed a bug in eric5-doc.py and regenerated docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 17
diff changeset
10 }
b88a0e6268bd Fixed a bug in eric5-doc.py and regenerated docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 17
diff changeset
11
409
0ea528e80202 Added another style for the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
12 h1 { color: white; background: #85774A; }
0ea528e80202 Added another style for the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
13 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
14 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
15 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
16
440
69ace3e2dcf6 Fine tuned the new default style and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 409
diff changeset
17 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
18
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
19 </style>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
20 </head>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
21 <body>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
22 <h1>eric5.Preferences</h1>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
23 <p>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
24 Package implementing the preferences interface.
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
25 </p><p>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 21
diff changeset
26 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
27 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
28 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
29 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
30 directory. The individual configuration data is accessed by accessor functions
3018
70924c0bdaf1 Corrected some source docu issues and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 2387
diff changeset
31 defined on the module level. The module is simply imported wherever it is
70924c0bdaf1 Corrected some source docu issues and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 2387
diff changeset
32 needed with the statement 'import Preferences'. Do not use
70924c0bdaf1 Corrected some source docu issues and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 2387
diff changeset
33 'from Preferences import *' to import it.
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
34 </p>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
35
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
36 <h3>Packages</h3>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
37 <table>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
38 <tr>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
39 <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
40 <td>Package implementing the various pages of the configuration dialog.</td>
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
41 </tr>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
42 </table>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
43
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
44 <h3>Modules</h3>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
45 <table>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
46 <tr>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
47 <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
48 <td>Module implementing a dialog for the configuration of eric5.</td>
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
49 </tr><tr>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
50 <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
51 <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
52 </tr><tr>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
53 <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
54 <td>Module implementing the Programs page.</td>
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
55 </tr><tr>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
56 <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
57 <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
58 </tr><tr>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
59 <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
60 <td>Module implementing functions dealing with keyboard shortcuts.</td>
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
61 </tr><tr>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
62 <td><a href="eric5.Preferences.ShortcutsDialog.html">ShortcutsDialog</a></td>
3018
70924c0bdaf1 Corrected some source docu issues and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 2387
diff changeset
63 <td>Module implementing a dialog for the configuration of eric5's keyboard shortcuts.</td>
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
64 </tr><tr>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
65 <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
66 <td>Module implementing a configuration dialog for the tools menu.</td>
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
67 </tr><tr>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
68 <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
69 <td>Module implementing a configuration dialog for the tools menu.</td>
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
70 </tr><tr>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
71 <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
72 <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
73 </tr><tr>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
74 <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
75 <td>Package implementing the preferences interface.</td>
17
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
76 </tr>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
77 </table>
edde1fe80b3e Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
78 </body></html>

eric ide

mercurial