Package implementing the preferences interface.
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 eric3 preferences file by module
functions. On Windows the data is located in the registry, everywhere 
else it 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.
        
            | Imported modules |  | 
        
        | from ViewManager.Config import ConfigViewManagers import os
 from qt import *
 from qtext import QextScintilla
 import sys
 
 | 
        
            | Functions |  | 
        
        |  | 
            |  | getConfigDir | 
        
        | 
getConfigDir ()
 Module function to get the name of the directory storing the config data.    Returns        directory name of the config dir (string) | 
            |  | getCorba | 
        
        | 
getCorba ( key,  prefClass=Prefs )
 Module function to retrieve the various corba settings.    Arguments
        keythe key of the value to get        prefClasspreferences class used as the storage area     Returns        the requested corba setting | 
            |  | getDebugger | 
        
        | 
getDebugger ( key,  prefClass=Prefs )
 Module function to retrieve the debugger settings.    Arguments
        keythe key of the value to get        prefClasspreferences class used as the storage area     Returns        the requested debugger setting | 
            |  | getEditor | 
        
        | 
getEditor ( key,  prefClass=Prefs )
 Module function to retrieve the various editor settings.    Arguments
        keythe key of the value to get        prefClasspreferences class used as the storage area     Returns        the requested editor setting | 
            |  | getEditorAPI | 
        
        | 
getEditorAPI ( key,  prefClass=Prefs )
 Module function to retrieve the various lists of api files.    Arguments
        keythe key of the value to get        prefClasspreferences class used as the storage area     Returns        the requested list of api files (QStringList) | 
            |  | getEditorColour | 
        
        | 
getEditorColour ( key,  prefClass=Prefs )
 Module function to retrieve the various editor marker colours.    Arguments
        keythe key of the value to get        prefClasspreferences class used as the storage area     Returns        the requested editor colour | 
            |  | getEditorOtherFonts | 
        
        | 
getEditorOtherFonts ( key,  prefClass=Prefs )
 Module function to retrieve the various editor fonts except the lexer fonts.    Arguments
        keythe key of the value to get        prefClasspreferences class used as the storage area     Returns        the requested editor font (QFont) | 
            |  | getGeometry | 
        
        | 
getGeometry ( key,  prefClass=Prefs )
 Module function to retrieve the display geometry.    Arguments
        keythe key of the value to get        prefClasspreferences class used as the storage area     Returns        the requested geometry setting | 
            |  | getHelp | 
        
        | 
getHelp ( key,  prefClass=Prefs )
 Module function to retrieve the various help settings.    Arguments
        keythe key of the value to get        prefClasspreferences class used as the storage area     Returns        the requested help setting | 
            |  | getMainDockLayout | 
        
        | 
getMainDockLayout (
        mw,
        which,
        prefClass=Prefs,
        )
Module function to retrieve the layout of the dock windows.    Arguments
        mwreference to the main window (QMainWindow)        whichbasic type of the dock layout (0 or 1)        prefClasspreferences class used as the storage area     Returns        flag indicating success | 
            |  | getPrinter | 
        
        | 
getPrinter ( key,  prefClass=Prefs )
 Module function to retrieve the various printer settings.    Arguments
        keythe key of the value to get        prefClasspreferences class used as the storage area     Returns        the requested printer setting | 
            |  | getProject | 
        
        | 
getProject ( key,  prefClass=Prefs )
 Module function to retrieve the various project handling settings.    Arguments
        keythe key of the value to get        prefClasspreferences class used as the storage area     Returns        the requested project setting | 
            |  | getQt | 
        
        | 
getQt ( key,  prefClass=Prefs )
 Module function to retrieve the various Qt settings.    Arguments
        keythe key of the value to get        prefClasspreferences class used as the storage area     Returns        the requested Qt setting | 
            |  | getQtDir | 
        
        | 
getQtDir ( prefClass=Prefs )
 Module function to retrieve the QtDir setting.    Arguments
        prefClasspreferences class used as the storage area     Returns        the requested QtDir setting (string) | 
            |  | getRefactoring | 
        
        | 
getRefactoring ( key,  prefClass=Prefs )
 Module function to retrieve the various refactoring settings.    Arguments
        keythe key of the value to get        prefClasspreferences class used as the storage area     Returns        the requested refactoring setting | 
            |  | getShell | 
        
        | 
getShell ( key,  prefClass=Prefs )
 Module function to retrieve the various shell settings.    Arguments
        keythe key of the value to get        prefClasspreferences class used as the storage area     Returns        the requested shell setting | 
            |  | getSystem | 
        
        | 
getSystem ( key,  prefClass=Prefs )
 Module function to retrieve the various system settings.    Arguments
        keythe key of the value to get        prefClasspreferences class used as the storage area     Returns        the requested system setting | 
            |  | getUI | 
        
        | 
getUI ( key,  prefClass=Prefs )
 Module function to retrieve the various UI settings.    Arguments
        keythe key of the value to get        prefClasspreferences class used as the storage area     Returns        the requested UI setting | 
            |  | getUILanguage | 
        
        | 
getUILanguage ( prefClass=Prefs )
 Module function to retrieve the language for the user interface.    Arguments
        prefClasspreferences class used as the storage area     Returns        the language for the UI | 
            |  | getUILayout | 
        
        | 
getUILayout ( prefClass=Prefs )
 Module function to retrieve the layout for the user interface.    Arguments
        prefClasspreferences class used as the storage area     Returns        the UI layout | 
            |  | getUser | 
        
        | 
getUser ( key,  prefClass=Prefs )
 Module function to retrieve the various user settings.    Arguments
        keythe key of the value to get        prefClasspreferences class used as the storage area     Returns        the requested user setting | 
            |  | getVarFilters | 
        
        | 
getVarFilters ( prefClass=Prefs )
 Module function to retrieve the variables filter settings.    Arguments
        prefClasspreferences class used as the storage area     Returns        a tuple defing the variables filter | 
            |  | getViewManager | 
        
        | 
getViewManager ( prefClass=Prefs )
 Module function to retrieve the selected viewmanager type.    Arguments
        prefClasspreferences class used as the storage area     Returns        the viewmanager type | 
            |  | initPreferences | 
        
        | 
initPreferences ()
 Module function to initialize the central configuration store.     This function is called once upon import of the module. | 
            |  | readPreferences | 
        
        | 
readPreferences ( prefClass=Prefs )
 Module function to read the preferences and transfer them into the central store.    Arguments
        prefClasspreferences class used as the storage area | 
            |  | readShortcuts | 
        
        | 
readShortcuts ( ui,  prefClass=Prefs )
 Module function to read the keyboard shortcuts for the defined QActions.    Arguments
        uireference to the main widget (UI.UserInterface)        prefClasspreferences class used as the storage area | 
            |  | readToolbarSettings | 
        
        | 
readToolbarSettings (
        mw,
        tbs,
        prefClass=Prefs,
        )
Module function to read the toolbar settings from the central store.    In addition to reading and storing the values, the toolbars are
    set accordingly.     Arguments
        mwreference to the main window (QMainWindow)        tbslist of tuples defining the different toolbars        prefClasspreferences class used as the storage area | 
            |  | readToolsMenu | 
        
        | 
readToolsMenu ( prefClass=Prefs )
 Module function to read the tools menu configuration.    Arguments
        prefClasspreferences class used as the storage area     Returns        list of tuples defing the tools menu entries | 
            |  | resetLayout | 
        
        | 
resetLayout ( which,  prefClass=Prefs )
 Module function to set a flag not storing the current layout. | 
            |  | savePreferences | 
        
        | 
savePreferences ( prefClass=Prefs )
 Module function to write the preferences from the central store.    Arguments
        prefClasspreferences class used as the storage area | 
            |  | saveShortcuts | 
        
        | 
saveShortcuts ( prefClass=Prefs )
 Module function to write the keyboard shortcuts for the defined QActions.    Arguments
        prefClasspreferences class used as the storage area | 
            |  | saveToolbarSettings | 
        
        | 
saveToolbarSettings (
        mw,
        tbs,
        prefClass=Prefs,
        )
Module function to write the toolbar settings to the central store.    Arguments
        prefClasspreferences class used as the storage area | 
            |  | saveToolsMenu | 
        
        | 
saveToolsMenu ( toollist,  prefClass=Prefs )
 Module function to write the tools menu configuration.    Arguments
        prefClasspreferences class used as the storage area | 
            |  | setCorba | 
        
        | 
setCorba (
        key,
        value,
        prefClass=Prefs,
        )
Module function to store the various corba settings.    Arguments
        keythe key of the setting to be set        valuethe value to be set        prefClasspreferences class used as the storage area | 
            |  | setDebugger | 
        
        | 
setDebugger (
        key,
        value,
        prefClass=Prefs,
        )
Module function to store the debugger settings.    Arguments
        keythe key of the setting to be set        valuethe value to be set        prefClasspreferences class used as the storage area | 
            |  | setEditor | 
        
        | 
setEditor (
        key,
        value,
        prefClass=Prefs,
        )
Module function to store the various editor settings.    Arguments
        keythe key of the setting to be set        valuethe value to be set        prefClasspreferences class used as the storage area | 
            |  | setEditorAPI | 
        
        | 
setEditorAPI (
        key,
        apilist,
        prefClass=Prefs,
        )
Module function to store the various lists of api files.    Arguments
        keythe key of the font to be set        apilistthe list of api files (QStringList)        prefClasspreferences class used as the storage area | 
            |  | setEditorColour | 
        
        | 
setEditorColour (
        key,
        value,
        prefClass=Prefs,
        )
Module function to store the various editor marker colours.    Arguments
        keythe key of the colour to be set        valuethe colour to be set        prefClasspreferences class used as the storage area | 
            |  | setEditorOtherFonts | 
        
        | 
setEditorOtherFonts (
        key,
        font,
        prefClass=Prefs,
        )
Module function to store the various editor fonts except the lexer fonts.    Arguments
        keythe key of the font to be set        fontthe font to be set (QFont)        prefClasspreferences class used as the storage area | 
            |  | setGeometry | 
        
        | 
setGeometry (
        key,
        value,
        prefClass=Prefs,
        )
Module function to store the display geometry.    Arguments
        keythe key of the setting to be set        valuethe geometry to be set        prefClasspreferences class used as the storage area | 
            |  | setHelp | 
        
        | 
setHelp (
        key,
        value,
        prefClass=Prefs,
        )
Module function to store the various help settings.    Arguments
        keythe key of the setting to be set        valuethe value to be set        prefClasspreferences class used as the storage area | 
            |  | setMainDockLayout | 
        
        | 
setMainDockLayout (
        mw,
        which,
        prefClass=Prefs,
        )
Module function to store the layout of the dock windows.    Arguments
        mwreference to the main window (QMainWindow)        whichbasic type of the dock layout (0 or 1)        prefClasspreferences class used as the storage area | 
            |  | setPrinter | 
        
        | 
setPrinter (
        key,
        value,
        prefClass=Prefs,
        )
Module function to store the various printer settings.    Arguments
        keythe key of the setting to be set        valuethe value to be set        prefClasspreferences class used as the storage area | 
            |  | setProject | 
        
        | 
setProject (
        key,
        value,
        prefClass=Prefs,
        )
Module function to store the various project handling settings.    Arguments
        keythe key of the setting to be set        valuethe value to be set        prefClasspreferences class used as the storage area | 
            |  | setQt | 
        
        | 
setQt (
        key,
        value,
        prefClass=Prefs,
        )
Module function to store the various Qt settings.    Arguments
        keythe key of the setting to be set        valuethe value to be set        prefClasspreferences class used as the storage area | 
            |  | setRefactoring | 
        
        | 
setRefactoring (
        key,
        value,
        prefClass=Prefs,
        )
Module function to store the various refactoring settings.    Arguments
        keythe key of the setting to be set        valuethe value to be set        prefClasspreferences class used as the storage area | 
            |  | setShell | 
        
        | 
setShell (
        key,
        value,
        prefClass=Prefs,
        )
Module function to store the various shell settings.    Arguments
        keythe key of the setting to be set        valuethe value to be set        prefClasspreferences class used as the storage area | 
            |  | setSystem | 
        
        | 
setSystem (
        key,
        value,
        prefClass=Prefs,
        )
Module function to store the various system settings.    Arguments
        keythe key of the setting to be set        valuethe value to be set        prefClasspreferences class used as the storage area | 
            |  | setUI | 
        
        | 
setUI (
        key,
        value,
        prefClass=Prefs,
        )
Module function to store the various UI settings.    Arguments
        keythe key of the setting to be set        valuethe value to be set        prefClasspreferences class used as the storage area | 
            |  | setUILanguage | 
        
        | 
setUILanguage ( lang,  prefClass=Prefs )
 Module function to store the language for the user interface.    Arguments
        langthe language        prefClasspreferences class used as the storage area | 
            |  | setUILayout | 
        
        | 
setUILayout ( layout,  prefClass=Prefs )
 Module function to store the layout for the user interface.    Arguments
        layoutthe layout type        prefClasspreferences class used as the storage area | 
            |  | setUser | 
        
        | 
setUser (
        key,
        value,
        prefClass=Prefs,
        )
Module function to store the various user settings.    Arguments
        keythe key of the setting to be set        valuethe value to be set        prefClasspreferences class used as the storage area | 
            |  | setVarFilters | 
        
        | 
setVarFilters ( filters,  prefClass=Prefs )
 Module function to store the variables filter settings.    Arguments
        prefClasspreferences class used as the storage area | 
            |  | setViewManager | 
        
        | 
setViewManager ( vm,  prefClass=Prefs )
 Module function to store the selected viewmanager type.    Arguments
        vmthe viewmanager type        prefClasspreferences class used as the storage area | 
            |  | syncPreferences | 
        
        | 
syncPreferences ()
 Module function to sync the preferences to disk.    In addition to synching, the central configuration store is reinitialized as well. | 
        
            | Classes |  | 
        
        | 
| Prefs | A class to hold all configuration items for the application. |  |