eric6/Documentation/Source/index-eric6.Preferences.html

Wed, 29 Apr 2020 18:36:16 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Wed, 29 Apr 2020 18:36:16 +0200
changeset 7555
24f1bb4c78a3
parent 7273
391d6b7b1eff
child 7960
e8fc383322f7
permissions
-rw-r--r--

Updated source docu.

3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
1 <!DOCTYPE html>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
2 <html><head>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
3 <title>eric6.Preferences</title>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
4 <meta charset="UTF-8">
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
5 <style>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
6 body {
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
7 background: #EDECE6;
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
8 margin: 0em 1em 10em 1em;
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
9 color: black;
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
10 }
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
11
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
12 h1 { color: white; background: #85774A; }
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
13 h2 { color: white; background: #85774A; }
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
14 h3 { color: white; background: #9D936E; }
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
15 h4 { color: white; background: #9D936E; }
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
16
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
17 a { color: #BA6D36; }
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
18
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
19 </style>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
20 </head>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
21 <body>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
22 <h1>eric6.Preferences</h1>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
23
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
24 <p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
25 Package implementing the preferences interface.
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
26 </p>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
27 <p>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
28 The preferences interface consists of a class, which defines the default
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
29 values for all configuration items and stores the actual values. These
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
30 values are read and written to the eric6 preferences file by module
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
31 functions. The data is stored in a file in a subdirectory of the users home
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
32 directory. The individual configuration data is accessed by accessor functions
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
33 defined on the module level. The module is simply imported wherever it is
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
34 needed with the statement 'import Preferences'. Do not use
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
35 'from Preferences import *' to import it.
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
36 </p>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
37
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
38 <h3>Packages</h3>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
39 <table>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
40
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
41 <tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
42 <td><a href="index-eric6.Preferences.ConfigurationPages.html">ConfigurationPages</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
43 <td>Package implementing the various pages of the configuration dialog.</td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
44 </tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
45 </table>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
46
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
47 <h3>Modules</h3>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
48 <table>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
49
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
50 <tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
51 <td><a href="eric6.Preferences.ConfigurationDialog.html">ConfigurationDialog</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
52 <td>Module implementing a dialog for the configuration of eric6.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
53 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
54 <tr>
4291
5f7f8c8d8bc2 Added a dialog to configure a mouse click sequence.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
55 <td><a href="eric6.Preferences.MouseClickDialog.html">MouseClickDialog</a></td>
5f7f8c8d8bc2 Added a dialog to configure a mouse click sequence.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 3673
diff changeset
56 <td>Module implementing a dialog for the configuration of a mouse click sequence.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
57 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
58 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
59 <td><a href="eric6.Preferences.PreferencesLexer.html">PreferencesLexer</a></td>
6866
b792455b35cd Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4291
diff changeset
60 <td>Module implementing a special QScintilla lexer to handle the preferences.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
61 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
62 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
63 <td><a href="eric6.Preferences.ProgramsDialog.html">ProgramsDialog</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
64 <td>Module implementing the Programs page.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
65 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
66 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
67 <td><a href="eric6.Preferences.ShortcutDialog.html">ShortcutDialog</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
68 <td>Module implementing a dialog for the configuration of a keyboard shortcut.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
69 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
70 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
71 <td><a href="eric6.Preferences.Shortcuts.html">Shortcuts</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
72 <td>Module implementing functions dealing with keyboard shortcuts.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
73 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
74 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
75 <td><a href="eric6.Preferences.ShortcutsDialog.html">ShortcutsDialog</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
76 <td>Module implementing a dialog for the configuration of eric6's keyboard shortcuts.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
77 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
78 <tr>
6866
b792455b35cd Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4291
diff changeset
79 <td><a href="eric6.Preferences.SubstyleDefinitionDialog.html">SubstyleDefinitionDialog</a></td>
b792455b35cd Regenerated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4291
diff changeset
80 <td>Module implementing the sub-style definition dialog.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
81 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
82 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
83 <td><a href="eric6.Preferences.ToolConfigurationDialog.html">ToolConfigurationDialog</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
84 <td>Module implementing a configuration dialog for the tools menu.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
85 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
86 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
87 <td><a href="eric6.Preferences.ToolGroupConfigurationDialog.html">ToolGroupConfigurationDialog</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
88 <td>Module implementing a configuration dialog for the tools menu.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
89 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
90 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
91 <td><a href="eric6.Preferences.ViewProfileDialog.html">ViewProfileDialog</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
92 <td>Module implementing a dialog to configure the various view profiles.</td>
7273
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
93 </tr>
391d6b7b1eff Regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
94 <tr>
3673
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
95 <td><a href="eric6.Preferences.__init__.html">Preferences</a></td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
96 <td>Package implementing the preferences interface.</td>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
97 </tr>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
98 </table>
e26d7d0c1088 Generated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
99 </body></html>

eric ide

mercurial