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 eric7 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 'from eric7 import Preferences'. Do not use 'from eric7.Preferences import *' to import it.
QWebEngineSettings |
_Migrations |
Prefs | A class to hold all configuration items for the application. |
convertPasswords | Module function to convert all passwords. |
exportPreferences | Module function to export the current preferences. |
getConda | Module function to retrieve the conda related settings. |
getCooperation | Module function to retrieve the various Cooperation settings. |
getDebugger | Module function to retrieve the debugger settings. |
getDiffColour | Module function to retrieve the colours for the diff highlighter. |
getDocuViewer | Module function to retrieve the Code Documentation Viewer related settings. |
getEditor | Module function to retrieve the various editor settings. |
getEditorAPI | Module function to retrieve the various lists of API files. |
getEditorColour | Module function to retrieve the various editor marker colours. |
getEditorExporter | Module function to retrieve the various editor exporters settings. |
getEditorKeywords | Module function to retrieve the various lists of language keywords. |
getEditorLexerAssoc | Module function to retrieve a lexer association. |
getEditorLexerAssocs | Module function to retrieve all lexer associations. |
getEditorOtherFonts | Module function to retrieve the various editor fonts except the lexer fonts. |
getEditorTyping | Module function to retrieve the various editor typing settings. |
getFlakes | Module function to retrieve the pyflakes related settings. |
getGeometry | Module function to retrieve the display geometry. |
getGraphics | Module function to retrieve the Graphics related settings. |
getHelp | Module function to retrieve the various help settings. |
getHexEditor | Module function to retrieve the Hex Editor related settings. |
getIconEditor | Module function to retrieve the Icon Editor related settings. |
getIcons | Module function to retrieve the various Icons settings. |
getIrc | Module function to retrieve the IRC related settings. |
getJedi | Function to retrieve the Jedi Assistant related settings. |
getMicroPython | Module function to retrieve the MicroPython related settings. |
getMultiProject | Module function to retrieve the various project handling settings. |
getPdfViewer | Module function to retrieve the Pdf Viewer related settings. |
getPip | Module function to retrieve the pip related settings. |
getPluginManager | Module function to retrieve the plugin manager related settings. |
getPrinter | Module function to retrieve the various printer settings. |
getProject | Module function to retrieve the various project handling settings. |
getProjectBrowserColour | Module function to retrieve the various project browser colours. |
getProjectBrowsers | Function to retrieve the enabled project browsers per project type. |
getPython | Module function to retrieve the Python settings. |
getQt | Module function to retrieve the various Qt settings. |
getQtDocDir | Module function to retrieve the Qt5DocDir/Qt6DocDir setting. |
getQtTranslationsDir | Module function to retrieve the Qt6TranslationsDir setting depending on the current Qt version. |
getSettings | Function to get a reference to the settings object. |
getShell | Module function to retrieve the various shell settings. |
getSystem | Module function to retrieve the various system settings. |
getTasks | Module function to retrieve the Tasks related settings. |
getTemplates | Module function to retrieve the Templates related settings. |
getTrayStarter | Module function to retrieve the tray starter related settings. |
getUI | Module function to retrieve the various UI settings. |
getUILanguage | Module function to retrieve the language for the user interface. |
getUser | Module function to retrieve the various user settings. |
getVCS | Module function to retrieve the VCS related settings. |
getVarFilters | Module function to retrieve the variables filter settings. |
getViewManager | Module function to retrieve the selected viewmanager type. |
getWebBrowser | Module function to retrieve the various web browser settings. |
importPreferences | Module function to from eric7 import Preferences from a file previously saved by the export function. |
initPreferences | Function to initialize the central configuration store. |
initRecentSettings | Module function to initialize the central configuration store for recently opened files and projects. |
isConfigured | Module function to check, if the the application has been configured. |
readToolGroups | Module function to read the tool groups configuration. |
removeProjectBrowsers | Function to remove the browsers list of the given project type. |
resetLayout | Module function to set a flag not storing the current layout. |
saveResetLayout | Module function to save the reset layout. |
saveToolGroups | Module function to write the tool groups configuration. |
setConda | Module function to store the conda related settings. |
setConfigured | Function to set the configured flag. |
setCooperation | Module function to store the various Cooperation settings. |
setDebugger | Module function to store the debugger settings. |
setDiffColour | Module function to store the diff highlighter colours. |
setDocuViewer | Module function to store the Code Documentation Viewer related settings. |
setEditor | Module function to store the various editor settings. |
setEditorAPI | Module function to store the various lists of API files. |
setEditorColour | Module function to store the various editor marker colours. |
setEditorExporter | Module function to store the various editor exporters settings. |
setEditorKeywords | Module function to store the various lists of language keywords. |
setEditorLexerAssocs | Module function to retrieve all lexer associations. |
setEditorOtherFonts | Module function to store the various editor fonts except the lexer fonts. |
setEditorTyping | Module function to store the various editor typing settings. |
setFlakes | Module function to store the pyflakes related settings. |
setGeometry | Module function to store the display geometry. |
setGraphics | Module function to store the Graphics related settings. |
setHelp | Module function to store the various help settings. |
setHexEditor | Module function to store the Hex Editor related settings. |
setIconEditor | Module function to store the Icon Editor related settings. |
setIcons | Module function to store the various Icons settings. |
setIrc | Module function to store the IRC related settings. |
setJedi | Public method to store the various refactoring settings. |
setMicroPython | Module function to store the MicroPython settings. |
setMultiProject | Module function to store the various project handling settings. |
setPdfViewer | Module function to store the Pdf Viewer related settings. |
setPip | Module function to store the pip related settings. |
setPluginManager | Module function to store the plugin manager related settings. |
setPrinter | Module function to store the various printer settings. |
setProject | Module function to store the various project handling settings. |
setProjectBrowserColour | Module function to store the various project browser colours. |
setProjectBrowsers | Function to store the enabled project browsers per project type. |
setProjectBrowsersDefault | Function to store the given project browser list to the list of defaults. |
setPython | Module function to store the Python settings. |
setQt | Module function to store the various Qt settings. |
setShell | Module function to store the various shell settings. |
setSystem | Module function to store the various system settings. |
setTasks | Module function to store the Tasks related settings. |
setTemplates | Module function to store the Templates related settings. |
setTrayStarter | Module function to store the tray starter related settings. |
setUI | Module function to store the various UI settings. |
setUILanguage | Module function to store the language for the user interface. |
setUser | Module function to store the various user settings. |
setVCS | Module function to store the VCS related settings. |
setVarFilters | Module function to store the variables filter settings. |
setViewManager | Module function to store the selected viewmanager type. |
setWebBrowser | Module function to store the various web browser settings. |
shouldResetLayout | Module function to indicate a reset of the layout. |
syncPreferences | Module function to sync the preferences to disk. |
toBool | Module function to convert a value to bool. |
toByteArray | Module function to convert a value to a byte array. |
toDict | Module function to convert a value to a dictionary. |
toList | Module function to convert a value to a list. |
A class to hold all configuration items for the application.
condaDefaults |
cooperationDefaults |
debuggerDefaults |
diffColourDefaults |
docuViewerDefaults |
editorColourDefaults |
editorDefaults |
editorExporterDefaults |
editorOtherFontsDefaults |
editorTypingDefaults |
geometryDefaults |
graphicsDefaults |
helpDefaults |
hexEditorDefaults |
iconEditorDefaults |
iconsDefaults |
ircDefaults |
jediDefaults |
microPythonDefaults |
multiProjectDefaults |
pdfViewerDefaults |
pipDefaults |
pluginManagerDefaults |
printerDefaults |
projectBrowserColourDefaults |
projectBrowsersDefaults |
projectDefaults |
pyflakesDefaults |
pythonDefaults |
qtDefaults |
resetLayout |
shellDefaults |
sysDefaults |
tasksDefaults |
templatesDefaults |
trayStarterDefaults |
uiDefaults |
userDefaults |
varDefaults |
vcsDefaults |
webBrowserDefaults |
webEngineSettingsIntitialized |
initWebEngineSettingsDefaults | Class method to initialize the web engine settings related defaults. |
None |
None |
Class method to initialize the web engine settings related defaults.
Module function to convert all passwords.
Module function to export the current preferences.
Module function to retrieve the conda related settings.
Module function to retrieve the various Cooperation settings.
Module function to retrieve the debugger settings.
Module function to retrieve the colours for the diff highlighter.
Module function to retrieve the Code Documentation Viewer related settings.
Module function to retrieve the various editor settings.
Module function to retrieve the various lists of API files.
Module function to retrieve the various editor marker colours.
Module function to retrieve the various editor exporters settings.
Module function to retrieve the various lists of language keywords.
Module function to retrieve a lexer association.
Module function to retrieve all lexer associations.
Module function to retrieve the various editor fonts except the lexer fonts.
Module function to retrieve the various editor typing settings.
Module function to retrieve the pyflakes related settings.
Module function to retrieve the display geometry.
Module function to retrieve the Graphics related settings.
Module function to retrieve the various help settings.
Module function to retrieve the Hex Editor related settings.
Module function to retrieve the Icon Editor related settings.
Module function to retrieve the various Icons settings.
Module function to retrieve the IRC related settings.
Function to retrieve the Jedi Assistant related settings.
Module function to retrieve the MicroPython related settings.
Module function to retrieve the various project handling settings.
Module function to retrieve the Pdf Viewer related settings.
Module function to retrieve the pip related settings.
Module function to retrieve the plugin manager related settings.
Module function to retrieve the various printer settings.
Module function to retrieve the various project handling settings.
Module function to retrieve the various project browser colours.
Function to retrieve the enabled project browsers per project type.
Module function to retrieve the Python settings.
Module function to retrieve the various Qt settings.
Module function to retrieve the Qt5DocDir/Qt6DocDir setting.
Module function to retrieve the Qt6TranslationsDir setting depending on the current Qt version.
Function to get a reference to the settings object.
Module function to retrieve the various shell settings.
Module function to retrieve the various system settings.
Module function to retrieve the Tasks related settings.
Module function to retrieve the Templates related settings.
Module function to retrieve the tray starter related settings.
Module function to retrieve the various UI settings.
Module function to retrieve the language for the user interface.
Module function to retrieve the various user settings.
Module function to retrieve the VCS related settings.
Module function to retrieve the variables filter settings.
Module function to retrieve the selected viewmanager type.
Module function to retrieve the various web browser settings.
Module function to from eric7 import Preferences from a file previously saved by the export function.
Function to initialize the central configuration store.
Module function to initialize the central configuration store for recently opened files and projects.
This function is called once upon import of the module.
Module function to check, if the the application has been configured.
Module function to read the tool groups configuration.
Function to remove the browsers list of the given project type.
Module function to set a flag not storing the current layout.
Module function to save the reset layout.
Module function to write the tool groups configuration.
Module function to store the conda related settings.
Function to set the configured flag.
Module function to store the various Cooperation settings.
Module function to store the debugger settings.
Module function to store the diff highlighter colours.
Module function to store the Code Documentation Viewer related settings.
Module function to store the various editor settings.
Module function to store the various lists of API files.
Module function to store the various editor marker colours.
Module function to store the various editor exporters settings.
Module function to store the various lists of language keywords.
Module function to retrieve all lexer associations.
Module function to store the various editor fonts except the lexer fonts.
Module function to store the various editor typing settings.
Module function to store the pyflakes related settings.
Module function to store the display geometry.
Module function to store the Graphics related settings.
Module function to store the various help settings.
Module function to store the Hex Editor related settings.
Module function to store the Icon Editor related settings.
Module function to store the various Icons settings.
Module function to store the IRC related settings.
Public method to store the various refactoring settings.
Module function to store the MicroPython settings.
Module function to store the various project handling settings.
Module function to store the Pdf Viewer related settings.
Module function to store the pip related settings.
Module function to store the plugin manager related settings.
Module function to store the various printer settings.
Module function to store the various project handling settings.
Module function to store the various project browser colours.
Function to store the enabled project browsers per project type.
Function to store the given project browser list to the list of defaults.
Module function to store the Python settings.
Module function to store the various Qt settings.
Module function to store the various shell settings.
Module function to store the various system settings.
Module function to store the Tasks related settings.
Module function to store the Templates related settings.
Module function to store the tray starter related settings.
Module function to store the various UI settings.
Module function to store the language for the user interface.
Module function to store the various user settings.
Module function to store the VCS related settings.
Module function to store the variables filter settings.
Module function to store the selected viewmanager type.
Module function to store the various web browser settings.
Module function to indicate a reset of the layout.
Module function to sync the preferences to disk.
In addition to syncing, the central configuration store is reinitialized as well.
Module function to convert a value to bool.
Module function to convert a value to a byte array.
Module function to convert a value to a dictionary.
Module function to convert a value to a list.