eric: diff Documentation/Source/index-eric5.Preferences.html

diff -r 81326a94fdca -r 37f0444c3479 Documentation/Source/index-eric5.Preferences.html
--- a/Documentation/Source/index-eric5.Preferences.html	Thu Jan 14 17:27:31 2010 +0000
+++ b/Documentation/Source/index-eric5.Preferences.html	Thu Jan 14 18:35:52 2010 +0000
@@ -22,23 +22,23 @@
 <body>
 <h1>eric5.Preferences</h1>
 <p>
-&#80;&#97;&#99;&#107;&#97;&#103;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#112;&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101;&#115; &#105;&#110;&#116;&#101;&#114;&#102;&#97;&#99;&#101;.
+Package implementing the preferences interface.
 </p><p>
-&#84;&#104;&#101; &#112;&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101;&#115; &#105;&#110;&#116;&#101;&#114;&#102;&#97;&#99;&#101; &#99;&#111;&#110;&#115;&#105;&#115;&#116;&#115; &#111;&#102; &#97; &#99;&#108;&#97;&#115;&#115;, w&#104;&#105;&#99;&#104; &#100;&#101;&#102;&#105;&#110;&#101;&#115; &#116;&#104;&#101; &#100;&#101;&#102;&#97;&#117;&#108;&#116;
-v&#97;&#108;&#117;&#101;&#115; &#102;&#111;&#114; &#97;&#108;&#108; &#99;&#111;&#110;&#102;&#105;&#103;&#117;&#114;&#97;&#116;&#105;&#111;&#110; &#105;&#116;&#101;&#109;&#115; &#97;&#110;&#100; &#115;&#116;&#111;&#114;&#101;&#115; &#116;&#104;&#101; &#97;&#99;&#116;&#117;&#97;&#108; v&#97;&#108;&#117;&#101;&#115;. &#84;&#104;&#101;&#115;&#101;
-v&#97;&#108;&#117;&#101;&#115; &#97;&#114;&#101; &#114;&#101;&#97;&#100; &#97;&#110;&#100; w&#114;&#105;&#116;&#116;&#101;&#110; &#116;&#111; &#116;&#104;&#101; &#101;&#114;&#105;&#99;&#53; &#112;&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101;&#115; &#102;&#105;&#108;&#101; &#98;y &#109;&#111;&#100;&#117;&#108;&#101;
-&#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110;&#115;. &#84;&#104;&#101; &#100;&#97;&#116;&#97; &#105;&#115; &#115;&#116;&#111;&#114;&#101;&#100; &#105;&#110; &#97; &#102;&#105;&#108;&#101; &#105;&#110; &#97; &#115;&#117;&#98;&#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y &#111;&#102; &#116;&#104;&#101; &#117;&#115;&#101;&#114;&#115; &#104;&#111;&#109;&#101;
-&#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y. &#84;&#104;&#101; &#105;&#110;&#100;&#105;v&#105;&#100;&#117;&#97;&#108; &#99;&#111;&#110;&#102;&#105;&#103;&#117;&#114;&#97;&#116;&#105;&#111;&#110; &#100;&#97;&#116;&#97; &#105;&#115; &#97;&#99;&#99;&#101;&#115;&#115;&#101;&#100; &#98;y &#97;&#99;&#99;&#101;&#115;&#115;&#111;&#114; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110;&#115;
-&#100;&#101;&#102;&#105;&#110;&#101;&#100; &#111;&#110; &#116;&#104;&#101; &#109;&#111;&#100;&#117;&#108;&#101; &#108;&#101;v&#101;&#108;. &#84;&#104;&#101; &#109;&#111;&#100;&#117;&#108;&#101; &#105;&#115; &#115;&#105;&#109;&#112;&#108;y &#105;&#109;&#112;&#111;&#114;&#116;&#101;&#100; w&#104;&#101;&#114;&#101;v&#101;&#114; &#105;&#116; &#105;&#115; &#110;&#101;&#101;&#100;&#101;&#100;
-w&#105;&#116;&#104; &#116;&#104;&#101; &#115;&#116;&#97;&#116;&#101;&#109;&#101;&#110;&#116; '&#105;&#109;&#112;&#111;&#114;&#116; &#80;&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101;&#115;'. &#68;&#111; &#110;&#111;&#116; &#117;&#115;&#101; '&#102;&#114;&#111;&#109; &#80;&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101;&#115; &#105;&#109;&#112;&#111;&#114;&#116; *'
-&#116;&#111; &#105;&#109;&#112;&#111;&#114;&#116; &#105;&#116;.
+The preferences interface consists of a class, which defines the default
+values for all configuration items and stores the actual values. These
+values are read and written to the eric5 preferences file by module
+functions. The data is stored in a file in a subdirectory of the users home
+directory. The individual configuration data is accessed by accessor functions
+defined on the module level. The module is simply imported wherever it is needed
+with the statement 'import Preferences'. Do not use 'from Preferences import *'
+to import it.
 </p>

 <h3>Packages</h3>
 <table>
 <tr>
 <td><a href="index-eric5.Preferences.ConfigurationPages.html">ConfigurationPages</a></td>
-<td>&#80;&#97;&#99;&#107;&#97;&#103;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; v&#97;&#114;&#105;&#111;&#117;&#115; &#112;&#97;&#103;&#101;&#115; &#111;&#102; &#116;&#104;&#101; &#99;&#111;&#110;&#102;&#105;&#103;&#117;&#114;&#97;&#116;&#105;&#111;&#110; &#100;&#105;&#97;&#108;&#111;&#103;.</td>
+<td>Package implementing the various pages of the configuration dialog.</td>
 </tr>
 </table>

@@ -46,34 +46,34 @@
 <table>
 <tr>
 <td><a href="eric5.Preferences.ConfigurationDialog.html">ConfigurationDialog</a></td>
-<td>&#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#100;&#105;&#97;&#108;&#111;&#103; &#102;&#111;&#114; &#116;&#104;&#101; &#99;&#111;&#110;&#102;&#105;&#103;&#117;&#114;&#97;&#116;&#105;&#111;&#110; &#111;&#102; &#101;&#114;&#105;&#99;&#53;.</td>
+<td>Module implementing a dialog for the configuration of eric5.</td>
 </tr><tr>
 <td><a href="eric5.Preferences.PreferencesLexer.html">PreferencesLexer</a></td>
-<td>&#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#115;&#112;&#101;&#99;&#105;&#97;&#108; &#81;&#101;x&#116;&#83;&#99;&#105;&#110;&#116;&#105;&#108;&#108;&#97; &#108;&#101;x&#101;&#114; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#112;&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101;&#115;.</td>
+<td>Module implementing a special QextScintilla lexer to handle the preferences.</td>
 </tr><tr>
 <td><a href="eric5.Preferences.ProgramsDialog.html">ProgramsDialog</a></td>
-<td>&#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#80;&#114;&#111;&#103;&#114;&#97;&#109;&#115; &#112;&#97;&#103;&#101;.</td>
+<td>Module implementing the Programs page.</td>
 </tr><tr>
 <td><a href="eric5.Preferences.ShortcutDialog.html">ShortcutDialog</a></td>
-<td>&#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#100;&#105;&#97;&#108;&#111;&#103; &#102;&#111;&#114; &#116;&#104;&#101; &#99;&#111;&#110;&#102;&#105;&#103;&#117;&#114;&#97;&#116;&#105;&#111;&#110; &#111;&#102; &#97; &#107;&#101;y&#98;&#111;&#97;&#114;&#100; &#115;&#104;&#111;&#114;&#116;&#99;&#117;&#116;.</td>
+<td>Module implementing a dialog for the configuration of a keyboard shortcut.</td>
 </tr><tr>
 <td><a href="eric5.Preferences.Shortcuts.html">Shortcuts</a></td>
-<td>&#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110;&#115; &#100;&#101;&#97;&#108;&#105;&#110;&#103; w&#105;&#116;&#104; &#107;&#101;y&#98;&#111;&#97;&#114;&#100; &#115;&#104;&#111;&#114;&#116;&#99;&#117;&#116;&#115;.</td>
+<td>Module implementing functions dealing with keyboard shortcuts.</td>
 </tr><tr>
 <td><a href="eric5.Preferences.ShortcutsDialog.html">ShortcutsDialog</a></td>
-<td>&#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#100;&#105;&#97;&#108;&#111;&#103; &#102;&#111;&#114; &#116;&#104;&#101; &#99;&#111;&#110;&#102;&#105;&#103;&#117;&#114;&#97;&#116;&#105;&#111;&#110; &#111;&#102; &#101;&#114;&#105;&#99;&#53;&#115; &#107;&#101;y&#98;&#111;&#97;&#114;&#100; &#115;&#104;&#111;&#114;&#116;&#99;&#117;&#116;&#115;.</td>
+<td>Module implementing a dialog for the configuration of eric5s keyboard shortcuts.</td>
 </tr><tr>
 <td><a href="eric5.Preferences.ToolConfigurationDialog.html">ToolConfigurationDialog</a></td>
-<td>&#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#99;&#111;&#110;&#102;&#105;&#103;&#117;&#114;&#97;&#116;&#105;&#111;&#110; &#100;&#105;&#97;&#108;&#111;&#103; &#102;&#111;&#114; &#116;&#104;&#101; &#116;&#111;&#111;&#108;&#115; &#109;&#101;&#110;&#117;.</td>
+<td>Module implementing a configuration dialog for the tools menu.</td>
 </tr><tr>
 <td><a href="eric5.Preferences.ToolGroupConfigurationDialog.html">ToolGroupConfigurationDialog</a></td>
-<td>&#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#99;&#111;&#110;&#102;&#105;&#103;&#117;&#114;&#97;&#116;&#105;&#111;&#110; &#100;&#105;&#97;&#108;&#111;&#103; &#102;&#111;&#114; &#116;&#104;&#101; &#116;&#111;&#111;&#108;&#115; &#109;&#101;&#110;&#117;.</td>
+<td>Module implementing a configuration dialog for the tools menu.</td>
 </tr><tr>
 <td><a href="eric5.Preferences.ViewProfileDialog.html">ViewProfileDialog</a></td>
-<td>&#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#100;&#105;&#97;&#108;&#111;&#103; &#116;&#111; &#99;&#111;&#110;&#102;&#105;&#103;&#117;&#114;&#101; &#116;&#104;&#101; v&#97;&#114;&#105;&#111;&#117;&#115; v&#105;&#101;w &#112;&#114;&#111;&#102;&#105;&#108;&#101;&#115;.</td>
+<td>Module implementing a dialog to configure the various view profiles.</td>
 </tr><tr>
 <td><a href="eric5.Preferences.__init__.html">Preferences</a></td>
-<td>&#80;&#97;&#99;&#107;&#97;&#103;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#112;&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101;&#115; &#105;&#110;&#116;&#101;&#114;&#102;&#97;&#99;&#101;.</td>
+<td>Package implementing the preferences interface.</td>
 </tr>
 </table>
 </body></html>
\ No newline at end of file