eric7.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 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.

Global Attributes

QWebEngineSettings
_Migrations

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.
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.


Prefs

A class to hold all configuration items for the application.

Derived from

None

Class Attributes

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

Class Methods

initWebEngineSettingsDefaults Class method to initialize the web engine settings related defaults.

Methods

None

Static Methods

None

Prefs.initWebEngineSettingsDefaults (class method)

initWebEngineSettingsDefaults()

Class method to initialize the web engine settings related defaults.

Up


convertPasswords

convertPasswords(oldPassword, newPassword)

Module function to convert all passwords.

oldPassword (str)
current password
newPassword (str)
new password
Up


exportPreferences

exportPreferences()

Module function to export the current preferences.

Up


getConda

getConda(key)

Module function to retrieve the conda related settings.

key (str)
the key of the value to get
Return:
the requested conda value
Return Type:
Any
Up


getCooperation

getCooperation(key)

Module function to retrieve the various Cooperation settings.

key (str)
the key of the value to get
Return:
the requested UI setting
Return Type:
Any
Up


getDebugger

getDebugger(key)

Module function to retrieve the debugger settings.

key (str)
the key of the value to get
Return:
the requested debugger setting
Return Type:
Any
Up


getDiffColour

getDiffColour(key)

Module function to retrieve the colours for the diff highlighter.

key (str)
the key of the value to get
Return:
the requested diff colour
Return Type:
QColor
Up


getDocuViewer

getDocuViewer(key)

Module function to retrieve the Code Documentation Viewer related settings.

key (str)
the key of the value to get
Return:
the requested Code Documentation Viewer value
Return Type:
Any
Up


getEditor

getEditor(key)

Module function to retrieve the various editor settings.

key (str)
the key of the value to get
Return:
the requested editor setting
Return Type:
Any
Up


getEditorAPI

getEditorAPI(language, projectType="")

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
Return:
requested list of API files
Return Type:
list of str
Up


getEditorColour

getEditorColour(key)

Module function to retrieve the various editor marker colours.

key (str)
the key of the value to get
Return:
the requested editor colour
Return Type:
QColor
Up


getEditorExporter

getEditorExporter(key)

Module function to retrieve the various editor exporters settings.

key (str)
the key of the value to get
Return:
the requested editor setting
Return Type:
Any
Up


getEditorKeywords

getEditorKeywords(key)

Module function to retrieve the various lists of language keywords.

key (str)
the key of the value to get
Return:
the requested list of language keywords
Return Type:
list of str
Up


getEditorLexerAssoc

getEditorLexerAssoc(filename)

Module function to retrieve a lexer association.

filename (str)
filename used to determine the associated lexer language
Return:
the requested lexer language
Return Type:
str
Up


getEditorLexerAssocs

getEditorLexerAssocs()

Module function to retrieve all lexer associations.

Return:
a reference to the list of lexer associations
Return Type:
dict of str
Up


getEditorOtherFonts

getEditorOtherFonts(key)

Module function to retrieve the various editor fonts except the lexer fonts.

key (str)
the key of the value to get
Return:
the requested editor font
Return Type:
QFont
Up


getEditorTyping

getEditorTyping(key)

Module function to retrieve the various editor typing settings.

key (str)
the key of the value to get
Return:
the requested editor setting
Return Type:
Any
Up


getFlakes

getFlakes(key)

Module function to retrieve the pyflakes related settings.

key (str)
the key of the value to get
Return:
the requested user setting
Return Type:
Any
Up


getGeometry

getGeometry(key)

Module function to retrieve the display geometry.

key (str)
the key of the value to get
Return:
the requested geometry setting
Return Type:
Any
Up


getGraphics

getGraphics(key)

Module function to retrieve the Graphics related settings.

key (str)
the key of the value to get
Return:
the requested user setting
Return Type:
Any
Up


getHelp

getHelp(key)

Module function to retrieve the various help settings.

key (str)
the key of the value to get
Return:
the requested help setting
Return Type:
Any
Up


getHexEditor

getHexEditor(key)

Module function to retrieve the Hex Editor related settings.

key (str)
the key of the value to get
Return:
the requested user setting
Return Type:
Any
Up


getIconEditor

getIconEditor(key)

Module function to retrieve the Icon Editor related settings.

key (str)
the key of the value to get
Return:
the requested user setting
Return Type:
Any
Up


getIcons

getIcons(key)

Module function to retrieve the various Icons settings.

key (str)
the key of the value to get
Return:
the requested Icons setting
Return Type:
Any
Up


getIrc

getIrc(key)

Module function to retrieve the IRC related settings.

key (str)
the key of the value to get
Return:
the requested user setting
Return Type:
Any
Up


getJedi

getJedi(key)

Function to retrieve the Jedi Assistant related settings.

key (str)
the key of the value to get
Return:
the requested jedi assistant setting
Return Type:
Any
Up


getMicroPython

getMicroPython(key)

Module function to retrieve the MicroPython related settings.

key (str)
the key of the value to get
Return:
the requested MicroPython value
Return Type:
Any
Up


getMultiProject

getMultiProject(key)

Module function to retrieve the various project handling settings.

key (str)
the key of the value to get
Return:
the requested project setting
Return Type:
Any
Up


getPdfViewer

getPdfViewer(key)

Module function to retrieve the Pdf Viewer related settings.

key (str)
the key of the value to get
Return:
the requested user setting
Return Type:
Any
Up


getPip

getPip(key)

Module function to retrieve the pip related settings.

key (str)
the key of the value to get
Return:
the requested pip value
Return Type:
Any
Up


getPluginManager

getPluginManager(key)

Module function to retrieve the plugin manager related settings.

key (str)
the key of the value to get
Return:
the requested user setting
Return Type:
Any
Up


getPrinter

getPrinter(key)

Module function to retrieve the various printer settings.

key (str)
the key of the value to get
Return:
the requested printer setting
Return Type:
Any
Up


getProject

getProject(key)

Module function to retrieve the various project handling settings.

key (str)
the key of the value to get
Return:
the requested project setting
Return Type:
Any
Up


getProjectBrowserColour

getProjectBrowserColour(key)

Module function to retrieve the various project browser colours.

key (str)
the key of the value to get
Return:
the requested project browser colour
Return Type:
Any
Up


getProjectBrowsers

getProjectBrowsers(key)

Function to retrieve the enabled project browsers per project type.

key (str)
project type
Return:
list of enabled project browsers
Return Type:
list of str
Up


getPython

getPython(key)

Module function to retrieve the Python settings.

key (str)
the key of the value to get
Return:
the requested debugger setting
Return Type:
Any
Up


getQt

getQt(key)

Module function to retrieve the various Qt settings.

key (str)
the key of the value to get
Return:
the requested Qt setting
Return Type:
Any
Up


getQtDocDir

getQtDocDir(version)

Module function to retrieve the Qt5DocDir/Qt6DocDir setting.

version (int)
Qt version to get documentation directory for
Return:
the requested Qt5DocDir/Qt6DocDir setting
Return Type:
str
Up


getQtTranslationsDir

getQtTranslationsDir()

Module function to retrieve the Qt6TranslationsDir setting depending on the current Qt version.

Return:
the requested setting
Return Type:
str
Up


getSettings

getSettings()

Function to get a reference to the settings object.

Return:
reference to the settings object
Return Type:
QSettings
Up


getShell

getShell(key)

Module function to retrieve the various shell settings.

key (str)
the key of the value to get
Return:
the requested shell setting
Return Type:
Any
Up


getSystem

getSystem(key)

Module function to retrieve the various system settings.

key (str)
the key of the value to get
Return:
the requested system setting
Return Type:
Any
Up


getTasks

getTasks(key)

Module function to retrieve the Tasks related settings.

key (str)
the key of the value to get
Return:
the requested user setting
Return Type:
Any
Up


getTemplates

getTemplates(key)

Module function to retrieve the Templates related settings.

key (str)
the key of the value to get
Return:
the requested user setting
Return Type:
Any
Up


getTrayStarter

getTrayStarter(key)

Module function to retrieve the tray starter related settings.

key (str)
the key of the value to get
Return:
the requested user setting
Return Type:
Any
Up


getUI

getUI(key)

Module function to retrieve the various UI settings.

key (str)
the key of the value to get
Return:
the requested UI setting
Return Type:
Any
Up


getUILanguage

getUILanguage()

Module function to retrieve the language for the user interface.

Return:
the language for the UI
Return Type:
str
Up


getUser

getUser(key)

Module function to retrieve the various user settings.

key (str)
the key of the value to get
Return:
the requested user setting
Return Type:
Any
Up


getVCS

getVCS(key)

Module function to retrieve the VCS related settings.

key (str)
the key of the value to get
Return:
the requested user setting
Return Type:
Any
Up


getVarFilters

getVarFilters()

Module function to retrieve the variables filter settings.

Return:
a tuple defining the variables filter
Return Type:
tuple of (list, list)
Up


getViewManager

getViewManager()

Module function to retrieve the selected viewmanager type.

Return:
the viewmanager type
Return Type:
str
Up


getWebBrowser

getWebBrowser(key)

Module function to retrieve the various web browser settings.

key (str)
the key of the value to get
Return:
the requested help setting
Return Type:
Any
Up


importPreferences

importPreferences()

Module function to from eric7 import Preferences from a file previously saved by the export function.

Up


initPreferences

initPreferences(withMigration=False)

Function to initialize the central configuration store.

withMigration (bool (optional))
flag indicating to migrate old keys to new ones (defaults to False)
Up


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.

Up


isConfigured

isConfigured()

Module function to check, if the the application has been configured.

Return:
flag indicating the configured status
Return Type:
bool
Up


readToolGroups

readToolGroups()

Module function to read the tool groups configuration.

Return:
list of tuples defing the tool groups
Return Type:
list of tuple
Up


removeProjectBrowsers

removeProjectBrowsers(key)

Function to remove the browsers list of the given project type.

key (str)
project type
Up


resetLayout

resetLayout()

Module function to set a flag not storing the current layout.

Up


saveResetLayout

saveResetLayout()

Module function to save the reset layout.

Up


saveToolGroups

saveToolGroups(toolGroups, currentGroup)

Module function to write the tool groups configuration.

toolGroups (list)
reference to the list of tool groups
currentGroup (int)
index of the currently selected tool group
Up


setConda

setConda(key, value)

Module function to store the conda related settings.

key (str)
the key of the setting to be set
value (Any)
the value to be set
Up


setConfigured

setConfigured()

Function to set the configured flag.

Up


setCooperation

setCooperation(key, value)

Module function to store the various Cooperation settings.

key (str)
the key of the setting to be set
value (Any)
the value to be set
Up


setDebugger

setDebugger(key, value)

Module function to store the debugger settings.

key (str)
the key of the setting to be set
value (Any)
the value to be set
Up


setDiffColour

setDiffColour(key, value)

Module function to store the diff highlighter colours.

key (str)
the key of the colour to be set
value (QColor)
the colour to be set
Up


setDocuViewer

setDocuViewer(key, value)

Module function to store the Code Documentation Viewer related settings.

key (str)
the key of the setting to be set
value (Any)
the value to be set
Up


setEditor

setEditor(key, value)

Module function to store the various editor settings.

key (str)
the key of the setting to be set
value (Any)
the value to be set
Up


setEditorAPI

setEditorAPI(language, projectType, apilist)

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
Up


setEditorColour

setEditorColour(key, value)

Module function to store the various editor marker colours.

key (str)
the key of the colour to be set
value (QColor)
the colour to be set
Up


setEditorExporter

setEditorExporter(key, value)

Module function to store the various editor exporters settings.

key (str)
the key of the setting to be set
value (Any)
the value to be set
Up


setEditorKeywords

setEditorKeywords(key, keywordsLists)

Module function to store the various lists of language keywords.

key (str)
the key of the api to be set
keywordsLists (list of str)
the list of language keywords
Up


setEditorLexerAssocs

setEditorLexerAssocs(assocs)

Module function to retrieve all lexer associations.

assocs (dict)
dictionary of lexer associations to be set
Up


setEditorOtherFonts

setEditorOtherFonts(key, font)

Module function to store the various editor fonts except the lexer fonts.

key (str)
the key of the font to be set
font (QFont)
the font to be set
Up


setEditorTyping

setEditorTyping(key, value)

Module function to store the various editor typing settings.

key (str)
the key of the setting to be set
value (Any)
the value to be set
Up


setFlakes

setFlakes(key, value)

Module function to store the pyflakes related settings.

key (str)
the key of the setting to be set
value (Any)
the value to be set
Up


setGeometry

setGeometry(key, value)

Module function to store the display geometry.

key (str)
the key of the setting to be set
value (Any)
the geometry to be set
Up


setGraphics

setGraphics(key, value)

Module function to store the Graphics related settings.

key (str)
the key of the setting to be set
value (Any)
the value to be set
Up


setHelp

setHelp(key, value)

Module function to store the various help settings.

key (str)
the key of the setting to be set
value (Any)
the value to be set
Up


setHexEditor

setHexEditor(key, value)

Module function to store the Hex Editor related settings.

key (str)
the key of the setting to be set
value (Any)
the value to be set
Up


setIconEditor

setIconEditor(key, value)

Module function to store the Icon Editor related settings.

key (str)
the key of the setting to be set
value (Any)
the value to be set
Up


setIcons

setIcons(key, value)

Module function to store the various Icons settings.

key (str)
the key of the setting to be set
value (Any)
the value to be set
Up


setIrc

setIrc(key, value)

Module function to store the IRC related settings.

key (str)
the key of the setting to be set
value (Any)
the value to be set
Up


setJedi

setJedi(key, value)

Public method to store the various refactoring settings.

key (str)
the key of the setting to be set
value (Any)
the value to be set
Up


setMicroPython

setMicroPython(key, value)

Module function to store the MicroPython settings.

key (str)
the key of the setting to be set
value (Any)
the value to be set
Up


setMultiProject

setMultiProject(key, value)

Module function to store the various project handling settings.

key (str)
the key of the setting to be set
value (Any)
the value to be set
Up


setPdfViewer

setPdfViewer(key, value)

Module function to store the Pdf Viewer related settings.

key (str)
the key of the setting to be set
value (Any)
the value to be set
Up


setPip

setPip(key, value)

Module function to store the pip related settings.

key (str)
the key of the setting to be set
value (Any)
the value to be set
Up


setPluginManager

setPluginManager(key, value)

Module function to store the plugin manager related settings.

key (str)
the key of the setting to be set
value (Any)
the value to be set
Up


setPrinter

setPrinter(key, value)

Module function to store the various printer settings.

key (str)
the key of the setting to be set
value (Any)
the value to be set
Up


setProject

setProject(key, value)

Module function to store the various project handling settings.

key (str)
the key of the setting to be set
value (Any)
the value to be set
Up


setProjectBrowserColour

setProjectBrowserColour(key, value)

Module function to store the various project browser colours.

key (str)
the key of the colour to be set
value (Any)
the colour to be set
Up


setProjectBrowsers

setProjectBrowsers(key, value)

Function to store the enabled project browsers per project type.

key (str)
project type
value (list of str)
list of enabled project browsers
Up


setProjectBrowsersDefault

setProjectBrowsersDefault(projectType, browsersList)

Function to store the given project browser list to the list of defaults.

projectType (str)
project type
browsersList (list of str or tuple of str)
default list of browsers for the project type
Up


setPython

setPython(key, value)

Module function to store the Python settings.

key (str)
the key of the setting to be set
value (Any)
the value to be set
Up


setQt

setQt(key, value)

Module function to store the various Qt settings.

key (str)
the key of the setting to be set
value (Any)
the value to be set
Up


setShell

setShell(key, value)

Module function to store the various shell settings.

key (str)
the key of the setting to be set
value (Any)
the value to be set
Up


setSystem

setSystem(key, value)

Module function to store the various system settings.

key (str)
the key of the setting to be set
value (Any)
the value to be set
Up


setTasks

setTasks(key, value)

Module function to store the Tasks related settings.

key (str)
the key of the setting to be set
value (Any)
the value to be set
Up


setTemplates

setTemplates(key, value)

Module function to store the Templates related settings.

key (str)
the key of the setting to be set
value (Any)
the value to be set
Up


setTrayStarter

setTrayStarter(key, value)

Module function to store the tray starter related settings.

key (str)
the key of the setting to be set
value (Any)
the value to be set
Up


setUI

setUI(key, value)

Module function to store the various UI settings.

key (str)
the key of the setting to be set
value (Any)
the value to be set
Up


setUILanguage

setUILanguage(lang)

Module function to store the language for the user interface.

lang (str)
the language
Up


setUser

setUser(key, value)

Module function to store the various user settings.

key (str)
the key of the setting to be set
value (Any)
the value to be set
Up


setVCS

setVCS(key, value)

Module function to store the VCS related settings.

key (str)
the key of the setting to be set
value (Any)
the value to be set
Up


setVarFilters

setVarFilters(filters)

Module function to store the variables filter settings.

filters (list)
variable filters to set
Up


setViewManager

setViewManager(vm)

Module function to store the selected viewmanager type.

vm (str)
the viewmanager type
Up


setWebBrowser

setWebBrowser(key, value)

Module function to store the various web browser settings.

key (str)
the key of the setting to be set
value (Any)
the value to be set
Up


shouldResetLayout

shouldResetLayout()

Module function to indicate a reset of the layout.

Return:
flag indicating a reset of the layout
Return Type:
bool
Up


syncPreferences

syncPreferences()

Module function to sync the preferences to disk.

In addition to syncing, the central configuration store is reinitialized as well.

Up


toBool

toBool(value)

Module function to convert a value to bool.

value (Any)
value to be converted
Return:
converted data
Return Type:
bool
Up


toByteArray

toByteArray(value)

Module function to convert a value to a byte array.

value (QByteArray or None)
value to be converted
Return:
converted data
Return Type:
QByteArray
Up


toDict

toDict(value)

Module function to convert a value to a dictionary.

value (dict or None)
value to be converted
Return:
converted data
Return Type:
dict
Up


toList

toList(value)

Module function to convert a value to a list.

value (list, None or Any)
value to be converted
Return:
converted data
Return Type:
list
Up