--- a/src/eric7/Documentation/Source/eric7.Preferences.__init__.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.Preferences.__init__.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,7 +7,6 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Preferences.__init__</h1>
-
<p>
Package implementing the preferences interface.
</p>
@@ -21,24 +20,22 @@
needed with the statement 'from eric7 import Preferences'. Do not use
'from eric7.Preferences import *' to import it.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>QWebEngineSettings</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#Prefs">Prefs</a></td>
<td>A class to hold all configuration items for the application.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
-
<tr>
<td><a href="#convertPasswords">convertPasswords</a></td>
<td>Module function to convert all passwords.</td>
@@ -504,58 +501,99 @@
<td>Module function to convert a value to a list.</td>
</tr>
</table>
+
<hr />
<hr />
<a NAME="Prefs" ID="Prefs"></a>
<h2>Prefs</h2>
-
<p>
A class to hold all configuration items for the application.
</p>
+
<h3>Derived from</h3>
None
<h3>Class Attributes</h3>
-
<table>
-<tr><td>condaDefaults</td></tr><tr><td>cooperationDefaults</td></tr><tr><td>debuggerDefaults</td></tr><tr><td>diffColourDefaults</td></tr><tr><td>docuViewerDefaults</td></tr><tr><td>editorColourDefaults</td></tr><tr><td>editorDefaults</td></tr><tr><td>editorExporterDefaults</td></tr><tr><td>editorOtherFontsDefaults</td></tr><tr><td>editorTypingDefaults</td></tr><tr><td>geometryDefaults</td></tr><tr><td>graphicsDefaults</td></tr><tr><td>helpDefaults</td></tr><tr><td>hexEditorDefaults</td></tr><tr><td>iconEditorDefaults</td></tr><tr><td>iconsDefaults</td></tr><tr><td>ircDefaults</td></tr><tr><td>jediDefaults</td></tr><tr><td>microPythonDefaults</td></tr><tr><td>multiProjectDefaults</td></tr><tr><td>pdfViewerDefaults</td></tr><tr><td>pipDefaults</td></tr><tr><td>pluginManagerDefaults</td></tr><tr><td>printerDefaults</td></tr><tr><td>projectBrowserColourDefaults</td></tr><tr><td>projectBrowsersDefaults</td></tr><tr><td>projectDefaults</td></tr><tr><td>pyflakesDefaults</td></tr><tr><td>pythonDefaults</td></tr><tr><td>qtDefaults</td></tr><tr><td>resetLayout</td></tr><tr><td>shellDefaults</td></tr><tr><td>sysDefaults</td></tr><tr><td>tasksDefaults</td></tr><tr><td>templatesDefaults</td></tr><tr><td>trayStarterDefaults</td></tr><tr><td>uiDefaults</td></tr><tr><td>userDefaults</td></tr><tr><td>varDefaults</td></tr><tr><td>vcsDefaults</td></tr><tr><td>webBrowserDefaults</td></tr><tr><td>webEngineSettingsIntitialized</td></tr>
+<tr><td>condaDefaults</td></tr>
+<tr><td>cooperationDefaults</td></tr>
+<tr><td>debuggerDefaults</td></tr>
+<tr><td>diffColourDefaults</td></tr>
+<tr><td>docuViewerDefaults</td></tr>
+<tr><td>editorColourDefaults</td></tr>
+<tr><td>editorDefaults</td></tr>
+<tr><td>editorExporterDefaults</td></tr>
+<tr><td>editorOtherFontsDefaults</td></tr>
+<tr><td>editorTypingDefaults</td></tr>
+<tr><td>geometryDefaults</td></tr>
+<tr><td>graphicsDefaults</td></tr>
+<tr><td>helpDefaults</td></tr>
+<tr><td>hexEditorDefaults</td></tr>
+<tr><td>iconEditorDefaults</td></tr>
+<tr><td>iconsDefaults</td></tr>
+<tr><td>ircDefaults</td></tr>
+<tr><td>jediDefaults</td></tr>
+<tr><td>microPythonDefaults</td></tr>
+<tr><td>multiProjectDefaults</td></tr>
+<tr><td>pdfViewerDefaults</td></tr>
+<tr><td>pipDefaults</td></tr>
+<tr><td>pluginManagerDefaults</td></tr>
+<tr><td>printerDefaults</td></tr>
+<tr><td>projectBrowserColourDefaults</td></tr>
+<tr><td>projectBrowsersDefaults</td></tr>
+<tr><td>projectDefaults</td></tr>
+<tr><td>pyflakesDefaults</td></tr>
+<tr><td>pythonDefaults</td></tr>
+<tr><td>qtDefaults</td></tr>
+<tr><td>resetLayout</td></tr>
+<tr><td>shellDefaults</td></tr>
+<tr><td>sysDefaults</td></tr>
+<tr><td>tasksDefaults</td></tr>
+<tr><td>templatesDefaults</td></tr>
+<tr><td>trayStarterDefaults</td></tr>
+<tr><td>uiDefaults</td></tr>
+<tr><td>userDefaults</td></tr>
+<tr><td>varDefaults</td></tr>
+<tr><td>vcsDefaults</td></tr>
+<tr><td>webBrowserDefaults</td></tr>
+<tr><td>webEngineSettingsIntitialized</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
-
<tr>
<td><a href="#Prefs.initWebEngineSettingsDefaults">initWebEngineSettingsDefaults</a></td>
<td>Class method to initialize the web engine settings related defaults.</td>
</tr>
</table>
+
<h3>Methods</h3>
-
-<table>
-<tr><td>None</td></tr>
-</table>
-<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+
<a NAME="Prefs.initWebEngineSettingsDefaults" ID="Prefs.initWebEngineSettingsDefaults"></a>
<h4>Prefs.initWebEngineSettingsDefaults (class method)</h4>
<b>initWebEngineSettingsDefaults</b>(<i></i>)
-
<p>
Class method to initialize the web engine settings related defaults.
</p>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="convertPasswords" ID="convertPasswords"></a>
<h2>convertPasswords</h2>
<b>convertPasswords</b>(<i>oldPassword, newPassword</i>)
-
<p>
Module function to convert all passwords.
</p>
+
<dl>
<dt><i>oldPassword</i> (str)</dt>
@@ -573,10 +611,10 @@
<a NAME="eric6SettingsName" ID="eric6SettingsName"></a>
<h2>eric6SettingsName</h2>
<b>eric6SettingsName</b>(<i></i>)
-
<p>
Function to generate the settings file name for eric6.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -595,20 +633,20 @@
<a NAME="exportPreferences" ID="exportPreferences"></a>
<h2>exportPreferences</h2>
<b>exportPreferences</b>(<i></i>)
-
<p>
Module function to export the current preferences.
</p>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="getConda" ID="getConda"></a>
<h2>getConda</h2>
<b>getConda</b>(<i>key</i>)
-
<p>
Module function to retrieve the conda related settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -634,10 +672,10 @@
<a NAME="getCooperation" ID="getCooperation"></a>
<h2>getCooperation</h2>
<b>getCooperation</b>(<i>key</i>)
-
<p>
Module function to retrieve the various Cooperation settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -663,10 +701,10 @@
<a NAME="getDebugger" ID="getDebugger"></a>
<h2>getDebugger</h2>
<b>getDebugger</b>(<i>key</i>)
-
<p>
Module function to retrieve the debugger settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -692,10 +730,10 @@
<a NAME="getDiffColour" ID="getDiffColour"></a>
<h2>getDiffColour</h2>
<b>getDiffColour</b>(<i>key</i>)
-
<p>
Module function to retrieve the colours for the diff highlighter.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -721,10 +759,10 @@
<a NAME="getDocuViewer" ID="getDocuViewer"></a>
<h2>getDocuViewer</h2>
<b>getDocuViewer</b>(<i>key</i>)
-
<p>
Module function to retrieve the Code Documentation Viewer related settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -750,10 +788,10 @@
<a NAME="getEditor" ID="getEditor"></a>
<h2>getEditor</h2>
<b>getEditor</b>(<i>key</i>)
-
<p>
Module function to retrieve the various editor settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -779,10 +817,10 @@
<a NAME="getEditorAPI" ID="getEditorAPI"></a>
<h2>getEditorAPI</h2>
<b>getEditorAPI</b>(<i>language, projectType=""</i>)
-
<p>
Module function to retrieve the various lists of API files.
</p>
+
<dl>
<dt><i>language</i> (str)</dt>
@@ -812,10 +850,10 @@
<a NAME="getEditorColour" ID="getEditorColour"></a>
<h2>getEditorColour</h2>
<b>getEditorColour</b>(<i>key</i>)
-
<p>
Module function to retrieve the various editor marker colours.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -841,10 +879,10 @@
<a NAME="getEditorExporter" ID="getEditorExporter"></a>
<h2>getEditorExporter</h2>
<b>getEditorExporter</b>(<i>key</i>)
-
<p>
Module function to retrieve the various editor exporters settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -870,10 +908,10 @@
<a NAME="getEditorKeywords" ID="getEditorKeywords"></a>
<h2>getEditorKeywords</h2>
<b>getEditorKeywords</b>(<i>key</i>)
-
<p>
Module function to retrieve the various lists of language keywords.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -899,10 +937,10 @@
<a NAME="getEditorLexerAssoc" ID="getEditorLexerAssoc"></a>
<h2>getEditorLexerAssoc</h2>
<b>getEditorLexerAssoc</b>(<i>filename</i>)
-
<p>
Module function to retrieve a lexer association.
</p>
+
<dl>
<dt><i>filename</i> (str)</dt>
@@ -928,10 +966,10 @@
<a NAME="getEditorLexerAssocs" ID="getEditorLexerAssocs"></a>
<h2>getEditorLexerAssocs</h2>
<b>getEditorLexerAssocs</b>(<i></i>)
-
<p>
Module function to retrieve all lexer associations.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -950,11 +988,11 @@
<a NAME="getEditorOtherFonts" ID="getEditorOtherFonts"></a>
<h2>getEditorOtherFonts</h2>
<b>getEditorOtherFonts</b>(<i>key</i>)
-
<p>
Module function to retrieve the various editor fonts except the lexer
fonts.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -980,10 +1018,10 @@
<a NAME="getEditorTyping" ID="getEditorTyping"></a>
<h2>getEditorTyping</h2>
<b>getEditorTyping</b>(<i>key</i>)
-
<p>
Module function to retrieve the various editor typing settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -1009,10 +1047,10 @@
<a NAME="getFlakes" ID="getFlakes"></a>
<h2>getFlakes</h2>
<b>getFlakes</b>(<i>key</i>)
-
<p>
Module function to retrieve the pyflakes related settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -1038,10 +1076,10 @@
<a NAME="getGeometry" ID="getGeometry"></a>
<h2>getGeometry</h2>
<b>getGeometry</b>(<i>key</i>)
-
<p>
Module function to retrieve the display geometry.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -1067,10 +1105,10 @@
<a NAME="getGraphics" ID="getGraphics"></a>
<h2>getGraphics</h2>
<b>getGraphics</b>(<i>key</i>)
-
<p>
Module function to retrieve the Graphics related settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -1096,10 +1134,10 @@
<a NAME="getHelp" ID="getHelp"></a>
<h2>getHelp</h2>
<b>getHelp</b>(<i>key</i>)
-
<p>
Module function to retrieve the various help settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -1125,10 +1163,10 @@
<a NAME="getHexEditor" ID="getHexEditor"></a>
<h2>getHexEditor</h2>
<b>getHexEditor</b>(<i>key</i>)
-
<p>
Module function to retrieve the Hex Editor related settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -1154,10 +1192,10 @@
<a NAME="getIconEditor" ID="getIconEditor"></a>
<h2>getIconEditor</h2>
<b>getIconEditor</b>(<i>key</i>)
-
<p>
Module function to retrieve the Icon Editor related settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -1183,10 +1221,10 @@
<a NAME="getIcons" ID="getIcons"></a>
<h2>getIcons</h2>
<b>getIcons</b>(<i>key</i>)
-
<p>
Module function to retrieve the various Icons settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -1212,10 +1250,10 @@
<a NAME="getIrc" ID="getIrc"></a>
<h2>getIrc</h2>
<b>getIrc</b>(<i>key</i>)
-
<p>
Module function to retrieve the IRC related settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -1241,10 +1279,10 @@
<a NAME="getJedi" ID="getJedi"></a>
<h2>getJedi</h2>
<b>getJedi</b>(<i>key</i>)
-
<p>
Function to retrieve the Jedi Assistant related settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -1270,10 +1308,10 @@
<a NAME="getMicroPython" ID="getMicroPython"></a>
<h2>getMicroPython</h2>
<b>getMicroPython</b>(<i>key</i>)
-
<p>
Module function to retrieve the MicroPython related settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -1299,10 +1337,10 @@
<a NAME="getMultiProject" ID="getMultiProject"></a>
<h2>getMultiProject</h2>
<b>getMultiProject</b>(<i>key</i>)
-
<p>
Module function to retrieve the various project handling settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -1328,10 +1366,10 @@
<a NAME="getPdfViewer" ID="getPdfViewer"></a>
<h2>getPdfViewer</h2>
<b>getPdfViewer</b>(<i>key</i>)
-
<p>
Module function to retrieve the Pdf Viewer related settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -1357,10 +1395,10 @@
<a NAME="getPip" ID="getPip"></a>
<h2>getPip</h2>
<b>getPip</b>(<i>key</i>)
-
<p>
Module function to retrieve the pip related settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -1386,10 +1424,10 @@
<a NAME="getPluginManager" ID="getPluginManager"></a>
<h2>getPluginManager</h2>
<b>getPluginManager</b>(<i>key</i>)
-
<p>
Module function to retrieve the plugin manager related settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -1415,10 +1453,10 @@
<a NAME="getPrinter" ID="getPrinter"></a>
<h2>getPrinter</h2>
<b>getPrinter</b>(<i>key</i>)
-
<p>
Module function to retrieve the various printer settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -1444,10 +1482,10 @@
<a NAME="getProject" ID="getProject"></a>
<h2>getProject</h2>
<b>getProject</b>(<i>key</i>)
-
<p>
Module function to retrieve the various project handling settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -1473,10 +1511,10 @@
<a NAME="getProjectBrowserColour" ID="getProjectBrowserColour"></a>
<h2>getProjectBrowserColour</h2>
<b>getProjectBrowserColour</b>(<i>key</i>)
-
<p>
Module function to retrieve the various project browser colours.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -1502,10 +1540,10 @@
<a NAME="getProjectBrowsers" ID="getProjectBrowsers"></a>
<h2>getProjectBrowsers</h2>
<b>getProjectBrowsers</b>(<i>key</i>)
-
<p>
Function to retrieve the enabled project browsers per project type.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -1531,10 +1569,10 @@
<a NAME="getPython" ID="getPython"></a>
<h2>getPython</h2>
<b>getPython</b>(<i>key</i>)
-
<p>
Module function to retrieve the Python settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -1560,10 +1598,10 @@
<a NAME="getQt" ID="getQt"></a>
<h2>getQt</h2>
<b>getQt</b>(<i>key</i>)
-
<p>
Module function to retrieve the various Qt settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -1589,10 +1627,10 @@
<a NAME="getQtDocDir" ID="getQtDocDir"></a>
<h2>getQtDocDir</h2>
<b>getQtDocDir</b>(<i>version</i>)
-
<p>
Module function to retrieve the Qt5DocDir/Qt6DocDir setting.
</p>
+
<dl>
<dt><i>version</i> (int)</dt>
@@ -1618,11 +1656,11 @@
<a NAME="getQtTranslationsDir" ID="getQtTranslationsDir"></a>
<h2>getQtTranslationsDir</h2>
<b>getQtTranslationsDir</b>(<i></i>)
-
<p>
Module function to retrieve the Qt6TranslationsDir
setting depending on the current Qt version.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1641,10 +1679,10 @@
<a NAME="getSettings" ID="getSettings"></a>
<h2>getSettings</h2>
<b>getSettings</b>(<i></i>)
-
<p>
Function to get a reference to the settings object.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1663,10 +1701,10 @@
<a NAME="getShell" ID="getShell"></a>
<h2>getShell</h2>
<b>getShell</b>(<i>key</i>)
-
<p>
Module function to retrieve the various shell settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -1692,10 +1730,10 @@
<a NAME="getSystem" ID="getSystem"></a>
<h2>getSystem</h2>
<b>getSystem</b>(<i>key</i>)
-
<p>
Module function to retrieve the various system settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -1721,10 +1759,10 @@
<a NAME="getTasks" ID="getTasks"></a>
<h2>getTasks</h2>
<b>getTasks</b>(<i>key</i>)
-
<p>
Module function to retrieve the Tasks related settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -1750,10 +1788,10 @@
<a NAME="getTemplates" ID="getTemplates"></a>
<h2>getTemplates</h2>
<b>getTemplates</b>(<i>key</i>)
-
<p>
Module function to retrieve the Templates related settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -1779,10 +1817,10 @@
<a NAME="getTrayStarter" ID="getTrayStarter"></a>
<h2>getTrayStarter</h2>
<b>getTrayStarter</b>(<i>key</i>)
-
<p>
Module function to retrieve the tray starter related settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -1808,10 +1846,10 @@
<a NAME="getUI" ID="getUI"></a>
<h2>getUI</h2>
<b>getUI</b>(<i>key</i>)
-
<p>
Module function to retrieve the various UI settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -1837,10 +1875,10 @@
<a NAME="getUILanguage" ID="getUILanguage"></a>
<h2>getUILanguage</h2>
<b>getUILanguage</b>(<i></i>)
-
<p>
Module function to retrieve the language for the user interface.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1859,10 +1897,10 @@
<a NAME="getUser" ID="getUser"></a>
<h2>getUser</h2>
<b>getUser</b>(<i>key</i>)
-
<p>
Module function to retrieve the various user settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -1888,10 +1926,10 @@
<a NAME="getVCS" ID="getVCS"></a>
<h2>getVCS</h2>
<b>getVCS</b>(<i>key</i>)
-
<p>
Module function to retrieve the VCS related settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -1917,10 +1955,10 @@
<a NAME="getVarFilters" ID="getVarFilters"></a>
<h2>getVarFilters</h2>
<b>getVarFilters</b>(<i></i>)
-
<p>
Module function to retrieve the variables filter settings.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1939,10 +1977,10 @@
<a NAME="getViewManager" ID="getViewManager"></a>
<h2>getViewManager</h2>
<b>getViewManager</b>(<i></i>)
-
<p>
Module function to retrieve the selected viewmanager type.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1961,10 +1999,10 @@
<a NAME="getWebBrowser" ID="getWebBrowser"></a>
<h2>getWebBrowser</h2>
<b>getWebBrowser</b>(<i>key</i>)
-
<p>
Module function to retrieve the various web browser settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -1990,10 +2028,10 @@
<a NAME="hasEric6Configuration" ID="hasEric6Configuration"></a>
<h2>hasEric6Configuration</h2>
<b>hasEric6Configuration</b>(<i></i>)
-
<p>
Function to check, if there is an old eric6 configuration.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -2012,38 +2050,37 @@
<a NAME="importEric6Configuration" ID="importEric6Configuration"></a>
<h2>importEric6Configuration</h2>
<b>importEric6Configuration</b>(<i></i>)
-
<p>
Function to import an old eric6 configuration.
</p>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="importPreferences" ID="importPreferences"></a>
<h2>importPreferences</h2>
<b>importPreferences</b>(<i></i>)
-
<p>
Module function to from eric7 import Preferences from a file previously saved by
the export function.
</p>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="initPreferences" ID="initPreferences"></a>
<h2>initPreferences</h2>
<b>initPreferences</b>(<i></i>)
-
<p>
Module function to initialize the central configuration store.
</p>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="initRecentSettings" ID="initRecentSettings"></a>
<h2>initRecentSettings</h2>
<b>initRecentSettings</b>(<i></i>)
-
<p>
Module function to initialize the central configuration store for recently
opened files and projects.
@@ -2051,16 +2088,17 @@
<p>
This function is called once upon import of the module.
</p>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="isConfigured" ID="isConfigured"></a>
<h2>isConfigured</h2>
<b>isConfigured</b>(<i></i>)
-
<p>
Module function to check, if the the application has been configured.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -2079,10 +2117,10 @@
<a NAME="readToolGroups" ID="readToolGroups"></a>
<h2>readToolGroups</h2>
<b>readToolGroups</b>(<i></i>)
-
<p>
Module function to read the tool groups configuration.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -2101,10 +2139,10 @@
<a NAME="removeProjectBrowsers" ID="removeProjectBrowsers"></a>
<h2>removeProjectBrowsers</h2>
<b>removeProjectBrowsers</b>(<i>key</i>)
-
<p>
Function to remove the browsers list of the given project type.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -2118,30 +2156,30 @@
<a NAME="resetLayout" ID="resetLayout"></a>
<h2>resetLayout</h2>
<b>resetLayout</b>(<i></i>)
-
<p>
Module function to set a flag not storing the current layout.
</p>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="saveResetLayout" ID="saveResetLayout"></a>
<h2>saveResetLayout</h2>
<b>saveResetLayout</b>(<i></i>)
-
<p>
Module function to save the reset layout.
</p>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="saveToolGroups" ID="saveToolGroups"></a>
<h2>saveToolGroups</h2>
<b>saveToolGroups</b>(<i>toolGroups, currentGroup</i>)
-
<p>
Module function to write the tool groups configuration.
</p>
+
<dl>
<dt><i>toolGroups</i> (list)</dt>
@@ -2159,10 +2197,10 @@
<a NAME="setConda" ID="setConda"></a>
<h2>setConda</h2>
<b>setConda</b>(<i>key, value</i>)
-
<p>
Module function to store the conda related settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -2180,20 +2218,20 @@
<a NAME="setConfigured" ID="setConfigured"></a>
<h2>setConfigured</h2>
<b>setConfigured</b>(<i></i>)
-
<p>
Function to set the configured flag.
</p>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="setCooperation" ID="setCooperation"></a>
<h2>setCooperation</h2>
<b>setCooperation</b>(<i>key, value</i>)
-
<p>
Module function to store the various Cooperation settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -2211,10 +2249,10 @@
<a NAME="setDebugger" ID="setDebugger"></a>
<h2>setDebugger</h2>
<b>setDebugger</b>(<i>key, value</i>)
-
<p>
Module function to store the debugger settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -2232,10 +2270,10 @@
<a NAME="setDiffColour" ID="setDiffColour"></a>
<h2>setDiffColour</h2>
<b>setDiffColour</b>(<i>key, value</i>)
-
<p>
Module function to store the diff highlighter colours.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -2253,10 +2291,10 @@
<a NAME="setDocuViewer" ID="setDocuViewer"></a>
<h2>setDocuViewer</h2>
<b>setDocuViewer</b>(<i>key, value</i>)
-
<p>
Module function to store the Code Documentation Viewer related settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -2274,10 +2312,10 @@
<a NAME="setEditor" ID="setEditor"></a>
<h2>setEditor</h2>
<b>setEditor</b>(<i>key, value</i>)
-
<p>
Module function to store the various editor settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -2295,10 +2333,10 @@
<a NAME="setEditorAPI" ID="setEditorAPI"></a>
<h2>setEditorAPI</h2>
<b>setEditorAPI</b>(<i>language, projectType, apilist</i>)
-
<p>
Module function to store the various lists of API files.
</p>
+
<dl>
<dt><i>language</i> (str)</dt>
@@ -2320,10 +2358,10 @@
<a NAME="setEditorColour" ID="setEditorColour"></a>
<h2>setEditorColour</h2>
<b>setEditorColour</b>(<i>key, value</i>)
-
<p>
Module function to store the various editor marker colours.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -2341,10 +2379,10 @@
<a NAME="setEditorExporter" ID="setEditorExporter"></a>
<h2>setEditorExporter</h2>
<b>setEditorExporter</b>(<i>key, value</i>)
-
<p>
Module function to store the various editor exporters settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -2362,10 +2400,10 @@
<a NAME="setEditorKeywords" ID="setEditorKeywords"></a>
<h2>setEditorKeywords</h2>
<b>setEditorKeywords</b>(<i>key, keywordsLists</i>)
-
<p>
Module function to store the various lists of language keywords.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -2383,10 +2421,10 @@
<a NAME="setEditorLexerAssocs" ID="setEditorLexerAssocs"></a>
<h2>setEditorLexerAssocs</h2>
<b>setEditorLexerAssocs</b>(<i>assocs</i>)
-
<p>
Module function to retrieve all lexer associations.
</p>
+
<dl>
<dt><i>assocs</i> (dict)</dt>
@@ -2400,10 +2438,10 @@
<a NAME="setEditorOtherFonts" ID="setEditorOtherFonts"></a>
<h2>setEditorOtherFonts</h2>
<b>setEditorOtherFonts</b>(<i>key, font</i>)
-
<p>
Module function to store the various editor fonts except the lexer fonts.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -2421,10 +2459,10 @@
<a NAME="setEditorTyping" ID="setEditorTyping"></a>
<h2>setEditorTyping</h2>
<b>setEditorTyping</b>(<i>key, value</i>)
-
<p>
Module function to store the various editor typing settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -2442,10 +2480,10 @@
<a NAME="setFlakes" ID="setFlakes"></a>
<h2>setFlakes</h2>
<b>setFlakes</b>(<i>key, value</i>)
-
<p>
Module function to store the pyflakes related settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -2463,10 +2501,10 @@
<a NAME="setGeometry" ID="setGeometry"></a>
<h2>setGeometry</h2>
<b>setGeometry</b>(<i>key, value</i>)
-
<p>
Module function to store the display geometry.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -2484,10 +2522,10 @@
<a NAME="setGraphics" ID="setGraphics"></a>
<h2>setGraphics</h2>
<b>setGraphics</b>(<i>key, value</i>)
-
<p>
Module function to store the Graphics related settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -2505,10 +2543,10 @@
<a NAME="setHelp" ID="setHelp"></a>
<h2>setHelp</h2>
<b>setHelp</b>(<i>key, value</i>)
-
<p>
Module function to store the various help settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -2526,10 +2564,10 @@
<a NAME="setHexEditor" ID="setHexEditor"></a>
<h2>setHexEditor</h2>
<b>setHexEditor</b>(<i>key, value</i>)
-
<p>
Module function to store the Hex Editor related settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -2547,10 +2585,10 @@
<a NAME="setIconEditor" ID="setIconEditor"></a>
<h2>setIconEditor</h2>
<b>setIconEditor</b>(<i>key, value</i>)
-
<p>
Module function to store the Icon Editor related settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -2568,10 +2606,10 @@
<a NAME="setIcons" ID="setIcons"></a>
<h2>setIcons</h2>
<b>setIcons</b>(<i>key, value</i>)
-
<p>
Module function to store the various Icons settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -2589,10 +2627,10 @@
<a NAME="setIrc" ID="setIrc"></a>
<h2>setIrc</h2>
<b>setIrc</b>(<i>key, value</i>)
-
<p>
Module function to store the IRC related settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -2610,10 +2648,10 @@
<a NAME="setJedi" ID="setJedi"></a>
<h2>setJedi</h2>
<b>setJedi</b>(<i>key, value</i>)
-
<p>
Public method to store the various refactoring settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -2631,10 +2669,10 @@
<a NAME="setMicroPython" ID="setMicroPython"></a>
<h2>setMicroPython</h2>
<b>setMicroPython</b>(<i>key, value</i>)
-
<p>
Module function to store the MicroPython settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -2652,10 +2690,10 @@
<a NAME="setMultiProject" ID="setMultiProject"></a>
<h2>setMultiProject</h2>
<b>setMultiProject</b>(<i>key, value</i>)
-
<p>
Module function to store the various project handling settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -2673,10 +2711,10 @@
<a NAME="setPdfViewer" ID="setPdfViewer"></a>
<h2>setPdfViewer</h2>
<b>setPdfViewer</b>(<i>key, value</i>)
-
<p>
Module function to store the Pdf Viewer related settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -2694,10 +2732,10 @@
<a NAME="setPip" ID="setPip"></a>
<h2>setPip</h2>
<b>setPip</b>(<i>key, value</i>)
-
<p>
Module function to store the pip related settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -2715,10 +2753,10 @@
<a NAME="setPluginManager" ID="setPluginManager"></a>
<h2>setPluginManager</h2>
<b>setPluginManager</b>(<i>key, value</i>)
-
<p>
Module function to store the plugin manager related settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -2736,10 +2774,10 @@
<a NAME="setPrinter" ID="setPrinter"></a>
<h2>setPrinter</h2>
<b>setPrinter</b>(<i>key, value</i>)
-
<p>
Module function to store the various printer settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -2757,10 +2795,10 @@
<a NAME="setProject" ID="setProject"></a>
<h2>setProject</h2>
<b>setProject</b>(<i>key, value</i>)
-
<p>
Module function to store the various project handling settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -2778,10 +2816,10 @@
<a NAME="setProjectBrowserColour" ID="setProjectBrowserColour"></a>
<h2>setProjectBrowserColour</h2>
<b>setProjectBrowserColour</b>(<i>key, value</i>)
-
<p>
Module function to store the various project browser colours.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -2799,10 +2837,10 @@
<a NAME="setProjectBrowsers" ID="setProjectBrowsers"></a>
<h2>setProjectBrowsers</h2>
<b>setProjectBrowsers</b>(<i>key, value</i>)
-
<p>
Function to store the enabled project browsers per project type.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -2820,10 +2858,10 @@
<a NAME="setProjectBrowsersDefault" ID="setProjectBrowsersDefault"></a>
<h2>setProjectBrowsersDefault</h2>
<b>setProjectBrowsersDefault</b>(<i>projectType, browsersList</i>)
-
<p>
Function to store the given project browser list to the list of defaults.
</p>
+
<dl>
<dt><i>projectType</i> (str)</dt>
@@ -2841,10 +2879,10 @@
<a NAME="setPython" ID="setPython"></a>
<h2>setPython</h2>
<b>setPython</b>(<i>key, value</i>)
-
<p>
Module function to store the Python settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -2862,10 +2900,10 @@
<a NAME="setQt" ID="setQt"></a>
<h2>setQt</h2>
<b>setQt</b>(<i>key, value</i>)
-
<p>
Module function to store the various Qt settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -2883,10 +2921,10 @@
<a NAME="setShell" ID="setShell"></a>
<h2>setShell</h2>
<b>setShell</b>(<i>key, value</i>)
-
<p>
Module function to store the various shell settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -2904,10 +2942,10 @@
<a NAME="setSystem" ID="setSystem"></a>
<h2>setSystem</h2>
<b>setSystem</b>(<i>key, value</i>)
-
<p>
Module function to store the various system settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -2925,10 +2963,10 @@
<a NAME="setTasks" ID="setTasks"></a>
<h2>setTasks</h2>
<b>setTasks</b>(<i>key, value</i>)
-
<p>
Module function to store the Tasks related settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -2946,10 +2984,10 @@
<a NAME="setTemplates" ID="setTemplates"></a>
<h2>setTemplates</h2>
<b>setTemplates</b>(<i>key, value</i>)
-
<p>
Module function to store the Templates related settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -2967,10 +3005,10 @@
<a NAME="setTrayStarter" ID="setTrayStarter"></a>
<h2>setTrayStarter</h2>
<b>setTrayStarter</b>(<i>key, value</i>)
-
<p>
Module function to store the tray starter related settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -2988,10 +3026,10 @@
<a NAME="setUI" ID="setUI"></a>
<h2>setUI</h2>
<b>setUI</b>(<i>key, value</i>)
-
<p>
Module function to store the various UI settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -3009,10 +3047,10 @@
<a NAME="setUILanguage" ID="setUILanguage"></a>
<h2>setUILanguage</h2>
<b>setUILanguage</b>(<i>lang</i>)
-
<p>
Module function to store the language for the user interface.
</p>
+
<dl>
<dt><i>lang</i> (str)</dt>
@@ -3026,10 +3064,10 @@
<a NAME="setUser" ID="setUser"></a>
<h2>setUser</h2>
<b>setUser</b>(<i>key, value</i>)
-
<p>
Module function to store the various user settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -3047,10 +3085,10 @@
<a NAME="setVCS" ID="setVCS"></a>
<h2>setVCS</h2>
<b>setVCS</b>(<i>key, value</i>)
-
<p>
Module function to store the VCS related settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -3068,10 +3106,10 @@
<a NAME="setVarFilters" ID="setVarFilters"></a>
<h2>setVarFilters</h2>
<b>setVarFilters</b>(<i>filters</i>)
-
<p>
Module function to store the variables filter settings.
</p>
+
<dl>
<dt><i>filters</i> (list)</dt>
@@ -3085,10 +3123,10 @@
<a NAME="setViewManager" ID="setViewManager"></a>
<h2>setViewManager</h2>
<b>setViewManager</b>(<i>vm</i>)
-
<p>
Module function to store the selected viewmanager type.
</p>
+
<dl>
<dt><i>vm</i> (str)</dt>
@@ -3102,10 +3140,10 @@
<a NAME="setWebBrowser" ID="setWebBrowser"></a>
<h2>setWebBrowser</h2>
<b>setWebBrowser</b>(<i>key, value</i>)
-
<p>
Module function to store the various web browser settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -3123,10 +3161,10 @@
<a NAME="shouldResetLayout" ID="shouldResetLayout"></a>
<h2>shouldResetLayout</h2>
<b>shouldResetLayout</b>(<i></i>)
-
<p>
Module function to indicate a reset of the layout.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -3145,7 +3183,6 @@
<a NAME="syncPreferences" ID="syncPreferences"></a>
<h2>syncPreferences</h2>
<b>syncPreferences</b>(<i></i>)
-
<p>
Module function to sync the preferences to disk.
</p>
@@ -3153,16 +3190,17 @@
In addition to syncing, the central configuration store is reinitialized
as well.
</p>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="toBool" ID="toBool"></a>
<h2>toBool</h2>
<b>toBool</b>(<i>value</i>)
-
<p>
Module function to convert a value to bool.
</p>
+
<dl>
<dt><i>value</i> (Any)</dt>
@@ -3188,10 +3226,10 @@
<a NAME="toByteArray" ID="toByteArray"></a>
<h2>toByteArray</h2>
<b>toByteArray</b>(<i>value</i>)
-
<p>
Module function to convert a value to a byte array.
</p>
+
<dl>
<dt><i>value</i> (QByteArray or None)</dt>
@@ -3217,10 +3255,10 @@
<a NAME="toDict" ID="toDict"></a>
<h2>toDict</h2>
<b>toDict</b>(<i>value</i>)
-
<p>
Module function to convert a value to a dictionary.
</p>
+
<dl>
<dt><i>value</i> (dict or None)</dt>
@@ -3246,10 +3284,10 @@
<a NAME="toList" ID="toList"></a>
<h2>toList</h2>
<b>toList</b>(<i>value</i>)
-
<p>
Module function to convert a value to a list.
</p>
+
<dl>
<dt><i>value</i> (list, None or Any)</dt>
@@ -3271,4 +3309,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
