eric6.Preferences.__init__
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 eric6 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.
Global Attributes
Classes
| Prefs |
A class to hold all configuration items for the application. |
Functions
| 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. |
| getCorba |
Module function to retrieve the various Corba 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. |
| getMicroPython |
Module function to retrieve the MicroPython related settings. |
| getMultiProject |
Module function to retrieve the various project handling 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. |
| getProjectBrowserFlags |
Module function to retrieve the various project browser flags settings. |
| getProtobuf |
Module function to retrieve the various protobuf settings. |
| getPython |
Module function to retrieve the Python settings. |
| getQt |
Module function to retrieve the various Qt settings. |
| getQt5DocDir |
Module function to retrieve the Qt5DocDir setting. |
| getQtTranslationsDir |
Module function to retrieve the Qt5TranslationsDir setting depending on the current Qt version. |
| 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 import preferences from a file previously saved by the export function. |
| initPreferences |
Module 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. |
| removeProjectBrowserFlags |
Module function to remove a project browser flags setting. |
| 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. |
| setCooperation |
Module function to store the various Cooperation settings. |
| setCorba |
Module function to store the various Corba 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. |
| setMicroPython |
Module function to store the pip MicroPython settings. |
| setMultiProject |
Module function to store the various project handling 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. |
| setProjectBrowserFlags |
Module function to store the various project browser flags settings. |
| setProjectBrowserFlagsDefault |
Module function to store the various project browser flags settings. |
| setProtobuf |
Module function to store the various protobuf settings. |
| 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. |
Prefs
A class to hold all configuration items for the application.
Derived from
object
Class Attributes
| condaDefaults |
| cooperationDefaults |
| corbaDefaults |
| debuggerDefaults |
| diffColourDefaults |
| docuViewerDefaults |
| editorColourDefaults |
| editorDefaults |
| editorExporterDefaults |
| editorOtherFontsDefaults |
| editorTypingDefaults |
| geometryDefaults |
| graphicsDefaults |
| helpDefaults |
| hexEditorDefaults |
| iconEditorDefaults |
| iconsDefaults |
| ircDefaults |
| microPythonDefaults |
| multiProjectDefaults |
| pipDefaults |
| pluginManagerDefaults |
| printerDefaults |
| projectBrowserColourDefaults |
| projectBrowserFlagsDefaults |
| projectDefaults |
| protobufDefaults |
| pyflakesDefaults |
| qtDefaults |
| resetLayout |
| shellDefaults |
| sysDefaults |
| tasksDefaults |
| templatesDefaults |
| trayStarterDefaults |
| uiDefaults |
| userDefaults |
| varDefaults |
| vcsDefaults |
| webBrowserDefaults |
| webEngineSettingsIntitialized |
Class Methods
Methods
Static Methods
Prefs.initWebEngineSettingsDefaults (class method)
initWebEngineSettingsDefaults()
Class method to initialize the web engine settings related defaults.
convertPasswords
convertPasswords(oldPassword, newPassword, prefClass=Prefs)
Module function to convert all passwords.
- oldPassword
-
current master password (string)
- newPassword
-
new master password (string)
- prefClass
-
preferences class used as the storage area
exportPreferences
exportPreferences(prefClass=Prefs)
Module function to export the current preferences.
- prefClass
-
preferences class used as the storage area
getConda
getConda(key, prefClass=Prefs)
Module function to retrieve the conda related settings.
- key
-
the key of the value to get
- prefClass
-
preferences class used as the storage area
- Returns:
-
the requested conda value
getCooperation
getCooperation(key, prefClass=Prefs)
Module function to retrieve the various Cooperation settings.
- key
-
the key of the value to get
- prefClass
-
preferences class used as the storage area
- Returns:
-
the requested UI setting
getCorba
getCorba(key, prefClass=Prefs)
Module function to retrieve the various Corba settings.
- key
-
the key of the value to get
- prefClass
-
preferences class used as the storage area
- Returns:
-
the requested corba setting
getDebugger
getDebugger(key, prefClass=Prefs)
Module function to retrieve the debugger settings.
- key
-
the key of the value to get
- prefClass
-
preferences class used as the storage area
- Returns:
-
the requested debugger setting
getDiffColour
getDiffColour(key, prefClass=Prefs)
Module function to retrieve the colours for the diff highlighter.
- key
-
the key of the value to get
- prefClass
-
preferences class used as the storage area
- Returns:
-
the requested diff colour
getDocuViewer
getDocuViewer(key, prefClass=Prefs)
Module function to retrieve the Code Documentation Viewer related settings.
- key
-
the key of the value to get
- prefClass
-
preferences class used as the storage area
- Returns:
-
the requested Code Documentation Viewer value
getEditor
getEditor(key, prefClass=Prefs)
Module function to retrieve the various editor settings.
- key
-
the key of the value to get
- prefClass
-
preferences class used as the storage area
- Returns:
-
the requested editor setting
getEditorAPI
getEditorAPI(language, projectType="", prefClass=Prefs)
Module function to retrieve the various lists of API files.
- language (str)
-
language of the API list
- projectType (str)
-
project type of the API list
- prefClass (Prefs)
-
preferences class used as the storage area
- Returns:
-
requested list of API files
- Return Type:
-
list of str
getEditorColour
getEditorColour(key, prefClass=Prefs)
Module function to retrieve the various editor marker colours.
- key
-
the key of the value to get
- prefClass
-
preferences class used as the storage area
- Returns:
-
the requested editor colour
getEditorExporter
getEditorExporter(key, prefClass=Prefs)
Module function to retrieve the various editor exporters settings.
- key
-
the key of the value to get
- prefClass
-
preferences class used as the storage area
- Returns:
-
the requested editor setting
getEditorKeywords
getEditorKeywords(key, prefClass=Prefs)
Module function to retrieve the various lists of language keywords.
- key
-
the key of the value to get
- prefClass
-
preferences class used as the storage area
- Returns:
-
the requested list of language keywords (list of strings)
getEditorLexerAssoc
getEditorLexerAssoc(filename, prefClass=Prefs)
Module function to retrieve a lexer association.
- filename
-
filename used to determine the associated lexer language
(string)
- prefClass
-
preferences class used as the storage area
- Returns:
-
the requested lexer language (string)
getEditorLexerAssocs
getEditorLexerAssocs(prefClass=Prefs)
Module function to retrieve all lexer associations.
- prefClass
-
preferences class used as the storage area
- Returns:
-
a reference to the list of lexer associations
(dictionary of strings)
getEditorOtherFonts
getEditorOtherFonts(key, prefClass=Prefs)
Module function to retrieve the various editor fonts except the lexer
fonts.
- key
-
the key of the value to get
- prefClass
-
preferences class used as the storage area
- Returns:
-
the requested editor font (QFont)
getEditorTyping
getEditorTyping(key, prefClass=Prefs)
Module function to retrieve the various editor typing settings.
- key
-
the key of the value to get
- prefClass
-
preferences class used as the storage area
- Returns:
-
the requested editor setting
getFlakes
getFlakes(key, prefClass=Prefs)
Module function to retrieve the pyflakes related settings.
- key
-
the key of the value to get
- prefClass
-
preferences class used as the storage area
- Returns:
-
the requested user setting
getGeometry
getGeometry(key, prefClass=Prefs)
Module function to retrieve the display geometry.
- key
-
the key of the value to get
- prefClass
-
preferences class used as the storage area
- Returns:
-
the requested geometry setting
getGraphics
getGraphics(key, prefClass=Prefs)
Module function to retrieve the Graphics related settings.
- key
-
the key of the value to get
- prefClass
-
preferences class used as the storage area
- Returns:
-
the requested user setting
getHelp
getHelp(key, prefClass=Prefs)
Module function to retrieve the various help settings.
- key
-
the key of the value to get
- prefClass
-
preferences class used as the storage area
- Returns:
-
the requested help setting
getHexEditor
getHexEditor(key, prefClass=Prefs)
Module function to retrieve the Hex Editor related settings.
- key
-
the key of the value to get
- prefClass
-
preferences class used as the storage area
- Returns:
-
the requested user setting
getIconEditor
getIconEditor(key, prefClass=Prefs)
Module function to retrieve the Icon Editor related settings.
- key
-
the key of the value to get
- prefClass
-
preferences class used as the storage area
- Returns:
-
the requested user setting
getIcons
getIcons(key, prefClass=Prefs)
Module function to retrieve the various Icons settings.
- key
-
the key of the value to get
- prefClass
-
preferences class used as the storage area
- Returns:
-
the requested Icons setting
getIrc
getIrc(key, prefClass=Prefs)
Module function to retrieve the IRC related settings.
- key
-
the key of the value to get
- prefClass
-
preferences class used as the storage area
- Returns:
-
the requested user setting
getMicroPython
getMicroPython(key, prefClass=Prefs)
Module function to retrieve the MicroPython related settings.
- key
-
the key of the value to get
- prefClass
-
preferences class used as the storage area
- Returns:
-
the requested MicroPython value
getMultiProject
getMultiProject(key, prefClass=Prefs)
Module function to retrieve the various project handling settings.
- key
-
the key of the value to get
- prefClass
-
preferences class used as the storage area
- Returns:
-
the requested project setting
getPip
getPip(key, prefClass=Prefs)
Module function to retrieve the pip related settings.
- key
-
the key of the value to get
- prefClass
-
preferences class used as the storage area
- Returns:
-
the requested pip value
getPluginManager
getPluginManager(key, prefClass=Prefs)
Module function to retrieve the plugin manager related settings.
- key
-
the key of the value to get
- prefClass
-
preferences class used as the storage area
- Returns:
-
the requested user setting
getPrinter
getPrinter(key, prefClass=Prefs)
Module function to retrieve the various printer settings.
- key
-
the key of the value to get
- prefClass
-
preferences 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.
- key
-
the key of the value to get
- prefClass
-
preferences class used as the storage area
- Returns:
-
the requested project setting
getProjectBrowserColour
getProjectBrowserColour(key, prefClass=Prefs)
Module function to retrieve the various project browser colours.
- key
-
the key of the value to get
- prefClass
-
preferences class used as the storage area
- Returns:
-
the requested project browser colour
getProjectBrowserFlags
getProjectBrowserFlags(key, prefClass=Prefs)
Module function to retrieve the various project browser flags settings.
- key
-
the key of the value to get
- prefClass
-
preferences class used as the storage area
- Returns:
-
the requested project setting
getProtobuf
getProtobuf(key, prefClass=Prefs)
Module function to retrieve the various protobuf settings.
- key (str)
-
the key of the value to get
- prefClass (Prefs)
-
preferences class used as the storage area
- Returns:
-
the requested protobuf setting
- Return Type:
-
any
getPython
getPython(key, prefClass=Prefs)
Module function to retrieve the Python settings.
- key
-
the key of the value to get
- prefClass
-
preferences class used as the storage area
- Returns:
-
the requested debugger setting
getQt
getQt(key, prefClass=Prefs)
Module function to retrieve the various Qt settings.
- key
-
the key of the value to get
- prefClass
-
preferences class used as the storage area
- Returns:
-
the requested Qt setting
getQt5DocDir
getQt5DocDir(prefClass=Prefs)
Module function to retrieve the Qt5DocDir setting.
- prefClass
-
preferences class used as the storage area
- Returns:
-
the requested Qt5DocDir setting (string)
getQtTranslationsDir
getQtTranslationsDir(prefClass=Prefs)
Module function to retrieve the Qt5TranslationsDir
setting depending on the current Qt version.
- prefClass
-
preferences class used as the storage area
- Returns:
-
the requested setting (string)
getShell
getShell(key, prefClass=Prefs)
Module function to retrieve the various shell settings.
- key
-
the key of the value to get
- prefClass
-
preferences class used as the storage area
- Returns:
-
the requested shell setting
getSystem
getSystem(key, prefClass=Prefs)
Module function to retrieve the various system settings.
- key
-
the key of the value to get
- prefClass
-
preferences class used as the storage area
- Returns:
-
the requested system setting
getTasks
getTasks(key, prefClass=Prefs)
Module function to retrieve the Tasks related settings.
- key
-
the key of the value to get
- prefClass
-
preferences class used as the storage area
- Returns:
-
the requested user setting
getTemplates
getTemplates(key, prefClass=Prefs)
Module function to retrieve the Templates related settings.
- key
-
the key of the value to get
- prefClass
-
preferences class used as the storage area
- Returns:
-
the requested user setting
getTrayStarter
getTrayStarter(key, prefClass=Prefs)
Module function to retrieve the tray starter related settings.
- key
-
the key of the value to get
- prefClass
-
preferences class used as the storage area
- Returns:
-
the requested user setting
getUI
getUI(key, prefClass=Prefs)
Module function to retrieve the various UI settings.
- key
-
the key of the value to get
- prefClass
-
preferences 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.
- prefClass
-
preferences class used as the storage area
- Returns:
-
the language for the UI
getUser
getUser(key, prefClass=Prefs)
Module function to retrieve the various user settings.
- key
-
the key of the value to get
- prefClass
-
preferences class used as the storage area
- Returns:
-
the requested user setting
getVCS
getVCS(key, prefClass=Prefs)
Module function to retrieve the VCS related settings.
- key
-
the key of the value to get
- prefClass
-
preferences class used as the storage area
- Returns:
-
the requested user setting
getVarFilters
getVarFilters(prefClass=Prefs)
Module function to retrieve the variables filter settings.
- prefClass
-
preferences class used as the storage area
- Returns:
-
a tuple defining the variables filter
getViewManager
getViewManager(prefClass=Prefs)
Module function to retrieve the selected viewmanager type.
- prefClass
-
preferences class used as the storage area
- Returns:
-
the viewmanager type
getWebBrowser
getWebBrowser(key, prefClass=Prefs)
Module function to retrieve the various web browser settings.
- key
-
the key of the value to get
- prefClass
-
preferences class used as the storage area
- Returns:
-
the requested help setting
importPreferences
importPreferences(prefClass=Prefs)
Module function to import preferences from a file previously saved by
the export function.
- prefClass
-
preferences class used as the storage area
initPreferences
initPreferences()
Module function to initialize the central configuration store.
initRecentSettings
initRecentSettings()
Module function to initialize the central configuration store for recently
opened files and projects.
This function is called once upon import of the module.
isConfigured
isConfigured(prefClass=Prefs)
Module function to check, if the the application has been configured.
- prefClass
-
preferences class used as the storage area
- Returns:
-
flag indicating the configured status (boolean)
readToolGroups
readToolGroups(prefClass=Prefs)
Module function to read the tool groups configuration.
- prefClass
-
preferences class used as the storage area
- Returns:
-
list of tuples defing the tool groups
removeProjectBrowserFlags
removeProjectBrowserFlags(key, prefClass=Prefs)
Module function to remove a project browser flags setting.
- key
-
the key of the setting to be removed
- prefClass
-
preferences class used as the storage area
resetLayout
resetLayout(prefClass=Prefs)
Module function to set a flag not storing the current layout.
- prefClass
-
preferences class used as the storage area
saveResetLayout
saveResetLayout(prefClass=Prefs)
Module function to save the reset layout.
- prefClass
-
preferences class used as the storage area
saveToolGroups
saveToolGroups(toolGroups, currentGroup, prefClass=Prefs)
Module function to write the tool groups configuration.
- toolGroups
-
reference to the list of tool groups
- currentGroup
-
index of the currently selected tool group (integer)
- prefClass
-
preferences class used as the storage area
setConda
setConda(key, value, prefClass=Prefs)
Module function to store the conda related settings.
- key
-
the key of the setting to be set
- value
-
the value to be set
- prefClass
-
preferences class used as the storage area
setCooperation
setCooperation(key, value, prefClass=Prefs)
Module function to store the various Cooperation settings.
- key
-
the key of the setting to be set
- value
-
the value to be set
- prefClass
-
preferences class used as the storage area
setCorba
setCorba(key, value, prefClass=Prefs)
Module function to store the various Corba settings.
- key
-
the key of the setting to be set
- value
-
the value to be set
- prefClass
-
preferences class used as the storage area
setDebugger
setDebugger(key, value, prefClass=Prefs)
Module function to store the debugger settings.
- key
-
the key of the setting to be set
- value
-
the value to be set
- prefClass
-
preferences class used as the storage area
setDiffColour
setDiffColour(key, value, prefClass=Prefs)
Module function to store the diff highlighter colours.
- key
-
the key of the colour to be set
- value
-
the colour to be set
- prefClass
-
preferences class used as the storage area
setDocuViewer
setDocuViewer(key, value, prefClass=Prefs)
Module function to store the Code Documentation Viewer related settings.
- key
-
the key of the setting to be set
- value
-
the value to be set
- prefClass
-
preferences class used as the storage area
setEditor
setEditor(key, value, prefClass=Prefs)
Module function to store the various editor settings.
- key
-
the key of the setting to be set
- value
-
the value to be set
- prefClass
-
preferences class used as the storage area
setEditorAPI
setEditorAPI(language, projectType, apilist, prefClass=Prefs)
Module function to store the various lists of API files.
- language (str)
-
language of the API list
- projectType (str)
-
project type of the API list
- apilist (list of str)
-
list of API files
- prefClass (Prefs)
-
preferences class used as the storage area
setEditorColour
setEditorColour(key, value, prefClass=Prefs)
Module function to store the various editor marker colours.
- key
-
the key of the colour to be set
- value
-
the colour to be set
- prefClass
-
preferences class used as the storage area
setEditorExporter
setEditorExporter(key, value, prefClass=Prefs)
Module function to store the various editor exporters settings.
- key
-
the key of the setting to be set
- value
-
the value to be set
- prefClass
-
preferences class used as the storage area
setEditorKeywords
setEditorKeywords(key, keywordsLists, prefClass=Prefs)
Module function to store the various lists of language keywords.
- key
-
the key of the api to be set
- keywordsLists
-
the list of language keywords (list of strings)
- prefClass
-
preferences class used as the storage area
setEditorLexerAssocs
setEditorLexerAssocs(assocs, prefClass=Prefs)
Module function to retrieve all lexer associations.
- assocs
-
dictionary of lexer associations to be set
- prefClass
-
preferences class used as the storage area
setEditorOtherFonts
setEditorOtherFonts(key, font, prefClass=Prefs)
Module function to store the various editor fonts except the lexer fonts.
- key
-
the key of the font to be set
- font
-
the font to be set (QFont)
- prefClass
-
preferences class used as the storage area
setEditorTyping
setEditorTyping(key, value, prefClass=Prefs)
Module function to store the various editor typing settings.
- key
-
the key of the setting to be set
- value
-
the value to be set
- prefClass
-
preferences class used as the storage area
setFlakes
setFlakes(key, value, prefClass=Prefs)
Module function to store the pyflakes related settings.
- key
-
the key of the setting to be set
- value
-
the value to be set
- prefClass
-
preferences class used as the storage area
setGeometry
setGeometry(key, value, prefClass=Prefs)
Module function to store the display geometry.
- key
-
the key of the setting to be set
- value
-
the geometry to be set
- prefClass
-
preferences class used as the storage area
setGraphics
setGraphics(key, value, prefClass=Prefs)
Module function to store the Graphics related settings.
- key
-
the key of the setting to be set
- value
-
the value to be set
- prefClass
-
preferences class used as the storage area
setHelp
setHelp(key, value, prefClass=Prefs)
Module function to store the various help settings.
- key
-
the key of the setting to be set
- value
-
the value to be set
- prefClass
-
preferences class used as the storage area
setHexEditor
setHexEditor(key, value, prefClass=Prefs)
Module function to store the Hex Editor related settings.
- key
-
the key of the setting to be set
- value
-
the value to be set
- prefClass
-
preferences class used as the storage area
setIconEditor
setIconEditor(key, value, prefClass=Prefs)
Module function to store the Icon Editor related settings.
- key
-
the key of the setting to be set
- value
-
the value to be set
- prefClass
-
preferences class used as the storage area
setIcons
setIcons(key, value, prefClass=Prefs)
Module function to store the various Icons settings.
- key
-
the key of the setting to be set
- value
-
the value to be set
- prefClass
-
preferences class used as the storage area
setIrc
setIrc(key, value, prefClass=Prefs)
Module function to store the IRC related settings.
- key
-
the key of the setting to be set
- value
-
the value to be set
- prefClass
-
preferences class used as the storage area
setMicroPython
setMicroPython(key, value, prefClass=Prefs)
Module function to store the pip MicroPython settings.
- key
-
the key of the setting to be set
- value
-
the value to be set
- prefClass
-
preferences class used as the storage area
setMultiProject
setMultiProject(key, value, prefClass=Prefs)
Module function to store the various project handling settings.
- key
-
the key of the setting to be set
- value
-
the value to be set
- prefClass
-
preferences class used as the storage area
setPip
setPip(key, value, prefClass=Prefs)
Module function to store the pip related settings.
- key
-
the key of the setting to be set
- value
-
the value to be set
- prefClass
-
preferences class used as the storage area
setPluginManager
setPluginManager(key, value, prefClass=Prefs)
Module function to store the plugin manager related settings.
- key
-
the key of the setting to be set
- value
-
the value to be set
- prefClass
-
preferences class used as the storage area
setPrinter
setPrinter(key, value, prefClass=Prefs)
Module function to store the various printer settings.
- key
-
the key of the setting to be set
- value
-
the value to be set
- prefClass
-
preferences class used as the storage area
setProject
setProject(key, value, prefClass=Prefs)
Module function to store the various project handling settings.
- key
-
the key of the setting to be set
- value
-
the value to be set
- prefClass
-
preferences class used as the storage area
setProjectBrowserColour
setProjectBrowserColour(key, value, prefClass=Prefs)
Module function to store the various project browser colours.
- key
-
the key of the colour to be set
- value
-
the colour to be set
- prefClass
-
preferences class used as the storage area
setProjectBrowserFlags
setProjectBrowserFlags(key, value, prefClass=Prefs)
Module function to store the various project browser flags settings.
- key
-
the key of the setting to be set
- value
-
the value to be set
- prefClass
-
preferences class used as the storage area
setProjectBrowserFlagsDefault
setProjectBrowserFlagsDefault(key, value, prefClass=Prefs)
Module function to store the various project browser flags settings.
- key
-
the key of the setting to be set
- value
-
the value to be set
- prefClass
-
preferences class used as the storage area
setProtobuf
setProtobuf(key, value, prefClass=Prefs)
Module function to store the various protobuf settings.
- key (str)
-
the key of the setting to be set
- value (any)
-
the value to be set
- prefClass (Prefs)
-
preferences class used as the storage area
setPython
setPython(key, value, prefClass=Prefs)
Module function to store the Python settings.
- key
-
the key of the setting to be set
- value
-
the value to be set
- prefClass
-
preferences class used as the storage area
setQt
setQt(key, value, prefClass=Prefs)
Module function to store the various Qt settings.
- key
-
the key of the setting to be set
- value
-
the value to be set
- prefClass
-
preferences class used as the storage area
setShell
setShell(key, value, prefClass=Prefs)
Module function to store the various shell settings.
- key
-
the key of the setting to be set
- value
-
the value to be set
- prefClass
-
preferences class used as the storage area
setSystem
setSystem(key, value, prefClass=Prefs)
Module function to store the various system settings.
- key
-
the key of the setting to be set
- value
-
the value to be set
- prefClass
-
preferences class used as the storage area
setTasks
setTasks(key, value, prefClass=Prefs)
Module function to store the Tasks related settings.
- key
-
the key of the setting to be set
- value
-
the value to be set
- prefClass
-
preferences class used as the storage area
setTemplates
setTemplates(key, value, prefClass=Prefs)
Module function to store the Templates related settings.
- key
-
the key of the setting to be set
- value
-
the value to be set
- prefClass
-
preferences class used as the storage area
setTrayStarter
setTrayStarter(key, value, prefClass=Prefs)
Module function to store the tray starter related settings.
- key
-
the key of the setting to be set
- value
-
the value to be set
- prefClass
-
preferences class used as the storage area
setUI
setUI(key, value, prefClass=Prefs)
Module function to store the various UI settings.
- key
-
the key of the setting to be set
- value
-
the value to be set
- prefClass
-
preferences class used as the storage area
setUILanguage
setUILanguage(lang, prefClass=Prefs)
Module function to store the language for the user interface.
- lang
-
the language
- prefClass
-
preferences class used as the storage area
setUser
setUser(key, value, prefClass=Prefs)
Module function to store the various user settings.
- key
-
the key of the setting to be set
- value
-
the value to be set
- prefClass
-
preferences class used as the storage area
setVCS
setVCS(key, value, prefClass=Prefs)
Module function to store the VCS related settings.
- key
-
the key of the setting to be set
- value
-
the value to be set
- prefClass
-
preferences class used as the storage area
setVarFilters
setVarFilters(filters, prefClass=Prefs)
Module function to store the variables filter settings.
- filters
-
variable filters to set
- prefClass
-
preferences class used as the storage area
setViewManager
setViewManager(vm, prefClass=Prefs)
Module function to store the selected viewmanager type.
- vm
-
the viewmanager type
- prefClass
-
preferences class used as the storage area
setWebBrowser
setWebBrowser(key, value, prefClass=Prefs)
Module function to store the various web browser settings.
- key
-
the key of the setting to be set
- value
-
the value to be set
- prefClass
-
preferences class used as the storage area
shouldResetLayout
shouldResetLayout(prefClass=Prefs)
Module function to indicate a reset of the layout.
- prefClass
-
preferences class used as the storage area
- Returns:
-
flag indicating a reset of the layout (boolean)
syncPreferences
syncPreferences(prefClass=Prefs)
Module function to sync the preferences to disk.
In addition to syncing, the central configuration store is reinitialized
as well.
- prefClass
-
preferences class used as the storage area
toBool
toBool(value)
Module function to convert a value to bool.
- value
-
value to be converted
- Returns:
-
converted data
toByteArray
toByteArray(value)
Module function to convert a value to a byte array.
- value
-
value to be converted
- Returns:
-
converted data
toDict
toDict(value)
Module function to convert a value to a dictionary.
- value
-
value to be converted
- Returns:
-
converted data
toList
toList(value)
Module function to convert a value to a list.
- value
-
value to be converted
- Returns:
-
converted data