--- a/Documentation/Source/eric5.Preferences.__init__.html Thu Jan 14 17:27:31 2010 +0000
+++ b/Documentation/Source/eric5.Preferences.__init__.html Thu Jan 14 18:35:52 2010 +0000
@@ -22,16 +22,16 @@
<body><a NAME="top" ID="top"></a>
<h1>eric5.Preferences.__init__</h1>
<p>
-Package implementing the preferences interface.
+Package implementing the preferences interface.
</p><p>
-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 eric5 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.
+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 eric5 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.
</p>
<h3>Global Attributes</h3>
<table>
@@ -41,276 +41,276 @@
<table>
<tr>
<td><a href="#Prefs">Prefs</a></td>
-<td>A class to hold all configuration items for the application.</td>
+<td>A class to hold all configuration items for the application.</td>
</tr>
</table>
<h3>Functions</h3>
<table>
<tr>
<td><a href="#exportPreferences">exportPreferences</a></td>
-<td>Module function to export the current preferences.</td>
+<td>Module function to export the current preferences.</td>
</tr><tr>
<td><a href="#getCorba">getCorba</a></td>
-<td>Module function to retrieve the various corba settings.</td>
+<td>Module function to retrieve the various corba settings.</td>
</tr><tr>
<td><a href="#getDebugger">getDebugger</a></td>
-<td>Module function to retrieve the debugger settings.</td>
+<td>Module function to retrieve the debugger settings.</td>
</tr><tr>
<td><a href="#getEditor">getEditor</a></td>
-<td>Module function to retrieve the various editor settings.</td>
+<td>Module function to retrieve the various editor settings.</td>
</tr><tr>
<td><a href="#getEditorAPI">getEditorAPI</a></td>
-<td>Module function to retrieve the various lists of api files.</td>
+<td>Module function to retrieve the various lists of api files.</td>
</tr><tr>
<td><a href="#getEditorColour">getEditorColour</a></td>
-<td>Module function to retrieve the various editor marker colours.</td>
+<td>Module function to retrieve the various editor marker colours.</td>
</tr><tr>
<td><a href="#getEditorExporter">getEditorExporter</a></td>
-<td>Module function to retrieve the various editor exporters settings.</td>
+<td>Module function to retrieve the various editor exporters settings.</td>
</tr><tr>
<td><a href="#getEditorLexerAssoc">getEditorLexerAssoc</a></td>
-<td>Module function to retrieve a lexer association.</td>
+<td>Module function to retrieve a lexer association.</td>
</tr><tr>
<td><a href="#getEditorLexerAssocs">getEditorLexerAssocs</a></td>
-<td>Module function to retrieve all lexer associations.</td>
+<td>Module function to retrieve all lexer associations.</td>
</tr><tr>
<td><a href="#getEditorOtherFonts">getEditorOtherFonts</a></td>
-<td>Module function to retrieve the various editor fonts except the lexer fonts.</td>
+<td>Module function to retrieve the various editor fonts except the lexer fonts.</td>
</tr><tr>
<td><a href="#getEditorTyping">getEditorTyping</a></td>
-<td>Module function to retrieve the various editor typing settings.</td>
+<td>Module function to retrieve the various editor typing settings.</td>
</tr><tr>
<td><a href="#getGeometry">getGeometry</a></td>
-<td>Module function to retrieve the display geometry.</td>
+<td>Module function to retrieve the display geometry.</td>
</tr><tr>
<td><a href="#getGraphics">getGraphics</a></td>
-<td>Module function to retrieve the Graphics related settings.</td>
+<td>Module function to retrieve the Graphics related settings.</td>
</tr><tr>
<td><a href="#getHelp">getHelp</a></td>
-<td>Module function to retrieve the various help settings.</td>
+<td>Module function to retrieve the various help settings.</td>
</tr><tr>
<td><a href="#getIconEditor">getIconEditor</a></td>
-<td>Module function to retrieve the Icon Editor related settings.</td>
+<td>Module function to retrieve the Icon Editor related settings.</td>
</tr><tr>
<td><a href="#getIcons">getIcons</a></td>
-<td>Module function to retrieve the various Icons settings.</td>
+<td>Module function to retrieve the various Icons settings.</td>
</tr><tr>
<td><a href="#getMultiProject">getMultiProject</a></td>
-<td>Module function to retrieve the various project handling settings.</td>
+<td>Module function to retrieve the various project handling settings.</td>
</tr><tr>
<td><a href="#getPluginManager">getPluginManager</a></td>
-<td>Module function to retrieve the plugin manager related settings.</td>
+<td>Module function to retrieve the plugin manager related settings.</td>
</tr><tr>
<td><a href="#getPrinter">getPrinter</a></td>
-<td>Module function to retrieve the various printer settings.</td>
+<td>Module function to retrieve the various printer settings.</td>
</tr><tr>
<td><a href="#getProject">getProject</a></td>
-<td>Module function to retrieve the various project handling settings.</td>
+<td>Module function to retrieve the various project handling settings.</td>
</tr><tr>
<td><a href="#getProjectBrowserColour">getProjectBrowserColour</a></td>
-<td>Module function to retrieve the various project browser colours.</td>
+<td>Module function to retrieve the various project browser colours.</td>
</tr><tr>
<td><a href="#getProjectBrowserFlags">getProjectBrowserFlags</a></td>
-<td>Module function to retrieve the various project browser flags settings.</td>
+<td>Module function to retrieve the various project browser flags settings.</td>
</tr><tr>
<td><a href="#getPython">getPython</a></td>
-<td>Module function to retrieve the Python settings.</td>
+<td>Module function to retrieve the Python settings.</td>
</tr><tr>
<td><a href="#getQt">getQt</a></td>
-<td>Module function to retrieve the various Qt settings.</td>
+<td>Module function to retrieve the various Qt settings.</td>
</tr><tr>
<td><a href="#getQt4DocDir">getQt4DocDir</a></td>
-<td>Module function to retrieve the Qt4DocDir setting.</td>
+<td>Module function to retrieve the Qt4DocDir setting.</td>
</tr><tr>
<td><a href="#getQt4TranslationsDir">getQt4TranslationsDir</a></td>
-<td>Module function to retrieve the Qt4TranslationsDir setting.</td>
+<td>Module function to retrieve the Qt4TranslationsDir setting.</td>
</tr><tr>
<td><a href="#getShell">getShell</a></td>
-<td>Module function to retrieve the various shell settings.</td>
+<td>Module function to retrieve the various shell settings.</td>
</tr><tr>
<td><a href="#getSystem">getSystem</a></td>
-<td>Module function to retrieve the various system settings.</td>
+<td>Module function to retrieve the various system settings.</td>
</tr><tr>
<td><a href="#getTasks">getTasks</a></td>
-<td>Module function to retrieve the Tasks related settings.</td>
+<td>Module function to retrieve the Tasks related settings.</td>
</tr><tr>
<td><a href="#getTemplates">getTemplates</a></td>
-<td>Module function to retrieve the Templates related settings.</td>
+<td>Module function to retrieve the Templates related settings.</td>
</tr><tr>
<td><a href="#getTerminal">getTerminal</a></td>
-<td>Module function to retrieve the various terminal settings.</td>
+<td>Module function to retrieve the various terminal settings.</td>
</tr><tr>
<td><a href="#getUI">getUI</a></td>
-<td>Module function to retrieve the various UI settings.</td>
+<td>Module function to retrieve the various UI settings.</td>
</tr><tr>
<td><a href="#getUILanguage">getUILanguage</a></td>
-<td>Module function to retrieve the language for the user interface.</td>
+<td>Module function to retrieve the language for the user interface.</td>
</tr><tr>
<td><a href="#getUILayout">getUILayout</a></td>
-<td>Module function to retrieve the layout for the user interface.</td>
+<td>Module function to retrieve the layout for the user interface.</td>
</tr><tr>
<td><a href="#getUser">getUser</a></td>
-<td>Module function to retrieve the various user settings.</td>
+<td>Module function to retrieve the various user settings.</td>
</tr><tr>
<td><a href="#getVCS">getVCS</a></td>
-<td>Module function to retrieve the VCS related settings.</td>
+<td>Module function to retrieve the VCS related settings.</td>
</tr><tr>
<td><a href="#getVarFilters">getVarFilters</a></td>
-<td>Module function to retrieve the variables filter settings.</td>
+<td>Module function to retrieve the variables filter settings.</td>
</tr><tr>
<td><a href="#getViewManager">getViewManager</a></td>
-<td>Module function to retrieve the selected viewmanager type.</td>
+<td>Module function to retrieve the selected viewmanager type.</td>
</tr><tr>
<td><a href="#importPreferences">importPreferences</a></td>
-<td>Module function to import preferences from a file previously saved by the export function.</td>
+<td>Module function to import preferences from a file previously saved by the export function.</td>
</tr><tr>
<td><a href="#initPreferences">initPreferences</a></td>
-<td>Module function to initialize the central configuration store.</td>
+<td>Module function to initialize the central configuration store.</td>
</tr><tr>
<td><a href="#initRecentSettings">initRecentSettings</a></td>
-<td>Module function to initialize the central configuration store for recently opened files and projects.</td>
+<td>Module function to initialize the central configuration store for recently opened files and projects.</td>
</tr><tr>
<td><a href="#isConfigured">isConfigured</a></td>
-<td>Module function to check, if the the application has been configured.</td>
+<td>Module function to check, if the the application has been configured.</td>
</tr><tr>
<td><a href="#readToolGroups">readToolGroups</a></td>
-<td>Module function to read the tool groups configuration.</td>
+<td>Module function to read the tool groups configuration.</td>
</tr><tr>
<td><a href="#removeProjectBrowserFlags">removeProjectBrowserFlags</a></td>
-<td>Module function to remove a project browser flags setting.</td>
+<td>Module function to remove a project browser flags setting.</td>
</tr><tr>
<td><a href="#resetLayout">resetLayout</a></td>
-<td>Module function to set a flag not storing the current layout.</td>
+<td>Module function to set a flag not storing the current layout.</td>
</tr><tr>
<td><a href="#saveResetLayout">saveResetLayout</a></td>
-<td>Module function to save the reset layout.</td>
+<td>Module function to save the reset layout.</td>
</tr><tr>
<td><a href="#saveToolGroups">saveToolGroups</a></td>
-<td>Module function to write the tool groups configuration.</td>
+<td>Module function to write the tool groups configuration.</td>
</tr><tr>
<td><a href="#setCorba">setCorba</a></td>
-<td>Module function to store the various corba settings.</td>
+<td>Module function to store the various corba settings.</td>
</tr><tr>
<td><a href="#setDebugger">setDebugger</a></td>
-<td>Module function to store the debugger settings.</td>
+<td>Module function to store the debugger settings.</td>
</tr><tr>
<td><a href="#setEditor">setEditor</a></td>
-<td>Module function to store the various editor settings.</td>
+<td>Module function to store the various editor settings.</td>
</tr><tr>
<td><a href="#setEditorAPI">setEditorAPI</a></td>
-<td>Module function to store the various lists of api files.</td>
+<td>Module function to store the various lists of api files.</td>
</tr><tr>
<td><a href="#setEditorColour">setEditorColour</a></td>
-<td>Module function to store the various editor marker colours.</td>
+<td>Module function to store the various editor marker colours.</td>
</tr><tr>
<td><a href="#setEditorExporter">setEditorExporter</a></td>
-<td>Module function to store the various editor exporters settings.</td>
+<td>Module function to store the various editor exporters settings.</td>
</tr><tr>
<td><a href="#setEditorLexerAssocs">setEditorLexerAssocs</a></td>
-<td>Module function to retrieve all lexer associations.</td>
+<td>Module function to retrieve all lexer associations.</td>
</tr><tr>
<td><a href="#setEditorOtherFonts">setEditorOtherFonts</a></td>
-<td>Module function to store the various editor fonts except the lexer fonts.</td>
+<td>Module function to store the various editor fonts except the lexer fonts.</td>
</tr><tr>
<td><a href="#setEditorTyping">setEditorTyping</a></td>
-<td>Module function to store the various editor typing settings.</td>
+<td>Module function to store the various editor typing settings.</td>
</tr><tr>
<td><a href="#setGeometry">setGeometry</a></td>
-<td>Module function to store the display geometry.</td>
+<td>Module function to store the display geometry.</td>
</tr><tr>
<td><a href="#setGraphics">setGraphics</a></td>
-<td>Module function to store the Graphics related settings.</td>
+<td>Module function to store the Graphics related settings.</td>
</tr><tr>
<td><a href="#setHelp">setHelp</a></td>
-<td>Module function to store the various help settings.</td>
+<td>Module function to store the various help settings.</td>
</tr><tr>
<td><a href="#setIconEditor">setIconEditor</a></td>
-<td>Module function to store the Icon Editor related settings.</td>
+<td>Module function to store the Icon Editor related settings.</td>
</tr><tr>
<td><a href="#setIcons">setIcons</a></td>
-<td>Module function to store the various Icons settings.</td>
+<td>Module function to store the various Icons settings.</td>
</tr><tr>
<td><a href="#setMultiProject">setMultiProject</a></td>
-<td>Module function to store the various project handling settings.</td>
+<td>Module function to store the various project handling settings.</td>
</tr><tr>
<td><a href="#setPluginManager">setPluginManager</a></td>
-<td>Module function to store the plugin manager related settings.</td>
+<td>Module function to store the plugin manager related settings.</td>
</tr><tr>
<td><a href="#setPrinter">setPrinter</a></td>
-<td>Module function to store the various printer settings.</td>
+<td>Module function to store the various printer settings.</td>
</tr><tr>
<td><a href="#setProject">setProject</a></td>
-<td>Module function to store the various project handling settings.</td>
+<td>Module function to store the various project handling settings.</td>
</tr><tr>
<td><a href="#setProjectBrowserColour">setProjectBrowserColour</a></td>
-<td>Module function to store the various project browser colours.</td>
+<td>Module function to store the various project browser colours.</td>
</tr><tr>
<td><a href="#setProjectBrowserFlags">setProjectBrowserFlags</a></td>
-<td>Module function to store the various project browser flags settings.</td>
+<td>Module function to store the various project browser flags settings.</td>
</tr><tr>
<td><a href="#setProjectBrowserFlagsDefault">setProjectBrowserFlagsDefault</a></td>
-<td>Module function to store the various project browser flags settings.</td>
+<td>Module function to store the various project browser flags settings.</td>
</tr><tr>
<td><a href="#setPython">setPython</a></td>
-<td>Module function to store the Python settings.</td>
+<td>Module function to store the Python settings.</td>
</tr><tr>
<td><a href="#setQt">setQt</a></td>
-<td>Module function to store the various Qt settings.</td>
+<td>Module function to store the various Qt settings.</td>
</tr><tr>
<td><a href="#setShell">setShell</a></td>
-<td>Module function to store the various shell settings.</td>
+<td>Module function to store the various shell settings.</td>
</tr><tr>
<td><a href="#setSystem">setSystem</a></td>
-<td>Module function to store the various system settings.</td>
+<td>Module function to store the various system settings.</td>
</tr><tr>
<td><a href="#setTasks">setTasks</a></td>
-<td>Module function to store the Tasks related settings.</td>
+<td>Module function to store the Tasks related settings.</td>
</tr><tr>
<td><a href="#setTemplates">setTemplates</a></td>
-<td>Module function to store the Templates related settings.</td>
+<td>Module function to store the Templates related settings.</td>
</tr><tr>
<td><a href="#setTerminal">setTerminal</a></td>
-<td>Module function to store the various terminal settings.</td>
+<td>Module function to store the various terminal settings.</td>
</tr><tr>
<td><a href="#setUI">setUI</a></td>
-<td>Module function to store the various UI settings.</td>
+<td>Module function to store the various UI settings.</td>
</tr><tr>
<td><a href="#setUILanguage">setUILanguage</a></td>
-<td>Module function to store the language for the user interface.</td>
+<td>Module function to store the language for the user interface.</td>
</tr><tr>
<td><a href="#setUILayout">setUILayout</a></td>
-<td>Module function to store the layout for the user interface.</td>
+<td>Module function to store the layout for the user interface.</td>
</tr><tr>
<td><a href="#setUser">setUser</a></td>
-<td>Module function to store the various user settings.</td>
+<td>Module function to store the various user settings.</td>
</tr><tr>
<td><a href="#setVCS">setVCS</a></td>
-<td>Module function to store the VCS related settings.</td>
+<td>Module function to store the VCS related settings.</td>
</tr><tr>
<td><a href="#setVarFilters">setVarFilters</a></td>
-<td>Module function to store the variables filter settings.</td>
+<td>Module function to store the variables filter settings.</td>
</tr><tr>
<td><a href="#setViewManager">setViewManager</a></td>
-<td>Module function to store the selected viewmanager type.</td>
+<td>Module function to store the selected viewmanager type.</td>
</tr><tr>
<td><a href="#shouldResetLayout">shouldResetLayout</a></td>
-<td>Module function to indicate a reset of the layout.</td>
+<td>Module function to indicate a reset of the layout.</td>
</tr><tr>
<td><a href="#syncPreferences">syncPreferences</a></td>
-<td>Module function to sync the preferences to disk.</td>
+<td>Module function to sync the preferences to disk.</td>
</tr><tr>
<td><a href="#toBool">toBool</a></td>
-<td>Module function to convert a value to bool.</td>
+<td>Module function to convert a value to bool.</td>
</tr><tr>
<td><a href="#toList">toList</a></td>
-<td>Module function to convert a value to a list.</td>
+<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.
+ A class to hold all configuration items for the application.
</p>
<h3>Derived from</h3>
object
@@ -329,11 +329,11 @@
<h2>exportPreferences</h2>
<b>exportPreferences</b>(<i>prefClass = Prefs</i>)
<p>
- Module function to export the current preferences.
+ Module function to export the current preferences.
</p><dl>
<dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -342,19 +342,19 @@
<h2>getCorba</h2>
<b>getCorba</b>(<i>key, prefClass = Prefs</i>)
<p>
- Module function to retrieve the various corba settings.
+ Module function to retrieve the various corba settings.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the value to get
+the key of the value to get
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-the requested corba setting
+the requested corba setting
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -363,19 +363,19 @@
<h2>getDebugger</h2>
<b>getDebugger</b>(<i>key, prefClass = Prefs</i>)
<p>
- Module function to retrieve the debugger settings.
+ Module function to retrieve the debugger settings.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the value to get
+the key of the value to get
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-the requested debugger setting
+the requested debugger setting
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -384,19 +384,19 @@
<h2>getEditor</h2>
<b>getEditor</b>(<i>key, prefClass = Prefs</i>)
<p>
- Module function to retrieve the various editor settings.
+ Module function to retrieve the various editor settings.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the value to get
+the key of the value to get
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-the requested editor setting
+the requested editor setting
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -405,19 +405,19 @@
<h2>getEditorAPI</h2>
<b>getEditorAPI</b>(<i>key, prefClass = Prefs</i>)
<p>
- Module function to retrieve the various lists of api files.
+ Module function to retrieve the various lists of api files.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the value to get
+the key of the value to get
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-the requested list of api files (list of strings)
+the requested list of api files (list of strings)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -426,19 +426,19 @@
<h2>getEditorColour</h2>
<b>getEditorColour</b>(<i>key, prefClass = Prefs</i>)
<p>
- Module function to retrieve the various editor marker colours.
+ Module function to retrieve the various editor marker colours.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the value to get
+the key of the value to get
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-the requested editor colour
+the requested editor colour
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -447,19 +447,19 @@
<h2>getEditorExporter</h2>
<b>getEditorExporter</b>(<i>key, prefClass = Prefs</i>)
<p>
- Module function to retrieve the various editor exporters settings.
+ Module function to retrieve the various editor exporters settings.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the value to get
+the key of the value to get
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-the requested editor setting
+the requested editor setting
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -468,19 +468,19 @@
<h2>getEditorLexerAssoc</h2>
<b>getEditorLexerAssoc</b>(<i>filename, prefClass = Prefs</i>)
<p>
- Module function to retrieve a lexer association.
+ Module function to retrieve a lexer association.
</p><dl>
<dt><i>filename</i></dt>
<dd>
-filename used to determine the associated lexer language (string)
+filename used to determine the associated lexer language (string)
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-the requested lexer language (string)
+the requested lexer language (string)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -489,17 +489,17 @@
<h2>getEditorLexerAssocs</h2>
<b>getEditorLexerAssocs</b>(<i>prefClass = Prefs</i>)
<p>
- Module function to retrieve all lexer associations.
+ Module function to retrieve all lexer associations.
</p><dl>
<dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-a reference to the list of lexer associations
- (dictionary of strings)
+a reference to the list of lexer associations
+ (dictionary of strings)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -508,19 +508,19 @@
<h2>getEditorOtherFonts</h2>
<b>getEditorOtherFonts</b>(<i>key, prefClass = Prefs</i>)
<p>
- Module function to retrieve the various editor fonts except the lexer fonts.
+ Module function to retrieve the various editor fonts except the lexer fonts.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the value to get
+the key of the value to get
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-the requested editor font (QFont)
+the requested editor font (QFont)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -529,19 +529,19 @@
<h2>getEditorTyping</h2>
<b>getEditorTyping</b>(<i>key, prefClass = Prefs</i>)
<p>
- Module function to retrieve the various editor typing settings.
+ Module function to retrieve the various editor typing settings.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the value to get
+the key of the value to get
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-the requested editor setting
+the requested editor setting
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -550,19 +550,19 @@
<h2>getGeometry</h2>
<b>getGeometry</b>(<i>key, prefClass = Prefs</i>)
<p>
- Module function to retrieve the display geometry.
+ Module function to retrieve the display geometry.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the value to get
+the key of the value to get
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-the requested geometry setting
+the requested geometry setting
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -571,19 +571,19 @@
<h2>getGraphics</h2>
<b>getGraphics</b>(<i>key, prefClass = Prefs</i>)
<p>
- Module function to retrieve the Graphics related settings.
+ Module function to retrieve the Graphics related settings.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the value to get
+the key of the value to get
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-the requested user setting
+the requested user setting
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -592,19 +592,19 @@
<h2>getHelp</h2>
<b>getHelp</b>(<i>key, prefClass = Prefs</i>)
<p>
- Module function to retrieve the various help settings.
+ Module function to retrieve the various help settings.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the value to get
+the key of the value to get
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-the requested help setting
+the requested help setting
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -613,19 +613,19 @@
<h2>getIconEditor</h2>
<b>getIconEditor</b>(<i>key, prefClass = Prefs</i>)
<p>
- Module function to retrieve the Icon Editor related settings.
+ Module function to retrieve the Icon Editor related settings.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the value to get
+the key of the value to get
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-the requested user setting
+the requested user setting
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -634,19 +634,19 @@
<h2>getIcons</h2>
<b>getIcons</b>(<i>key, prefClass = Prefs</i>)
<p>
- Module function to retrieve the various Icons settings.
+ Module function to retrieve the various Icons settings.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the value to get
+the key of the value to get
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-the requested Icons setting
+the requested Icons setting
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -655,19 +655,19 @@
<h2>getMultiProject</h2>
<b>getMultiProject</b>(<i>key, prefClass = Prefs</i>)
<p>
- Module function to retrieve the various project handling settings.
+ Module function to retrieve the various project handling settings.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the value to get
+the key of the value to get
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-the requested project setting
+the requested project setting
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -676,19 +676,19 @@
<h2>getPluginManager</h2>
<b>getPluginManager</b>(<i>key, prefClass = Prefs</i>)
<p>
- Module function to retrieve the plugin manager related settings.
+ Module function to retrieve the plugin manager related settings.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the value to get
+the key of the value to get
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-the requested user setting
+the requested user setting
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -697,19 +697,19 @@
<h2>getPrinter</h2>
<b>getPrinter</b>(<i>key, prefClass = Prefs</i>)
<p>
- Module function to retrieve the various printer settings.
+ Module function to retrieve the various printer settings.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the value to get
+the key of the value to get
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-the requested printer setting
+the requested printer setting
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -718,19 +718,19 @@
<h2>getProject</h2>
<b>getProject</b>(<i>key, prefClass = Prefs</i>)
<p>
- Module function to retrieve the various project handling settings.
+ Module function to retrieve the various project handling settings.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the value to get
+the key of the value to get
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-the requested project setting
+the requested project setting
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -739,19 +739,19 @@
<h2>getProjectBrowserColour</h2>
<b>getProjectBrowserColour</b>(<i>key, prefClass = Prefs</i>)
<p>
- Module function to retrieve the various project browser colours.
+ Module function to retrieve the various project browser colours.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the value to get
+the key of the value to get
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-the requested project browser colour
+the requested project browser colour
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -760,19 +760,19 @@
<h2>getProjectBrowserFlags</h2>
<b>getProjectBrowserFlags</b>(<i>key, prefClass = Prefs</i>)
<p>
- Module function to retrieve the various project browser flags settings.
+ Module function to retrieve the various project browser flags settings.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the value to get
+the key of the value to get
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-the requested project setting
+the requested project setting
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -781,19 +781,19 @@
<h2>getPython</h2>
<b>getPython</b>(<i>key, prefClass = Prefs</i>)
<p>
- Module function to retrieve the Python settings.
+ Module function to retrieve the Python settings.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the value to get
+the key of the value to get
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-the requested debugger setting
+the requested debugger setting
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -802,19 +802,19 @@
<h2>getQt</h2>
<b>getQt</b>(<i>key, prefClass = Prefs</i>)
<p>
- Module function to retrieve the various Qt settings.
+ Module function to retrieve the various Qt settings.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the value to get
+the key of the value to get
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-the requested Qt setting
+the requested Qt setting
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -823,16 +823,16 @@
<h2>getQt4DocDir</h2>
<b>getQt4DocDir</b>(<i>prefClass = Prefs</i>)
<p>
- Module function to retrieve the Qt4DocDir setting.
+ Module function to retrieve the Qt4DocDir setting.
</p><dl>
<dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-the requested Qt4DocDir setting (string)
+the requested Qt4DocDir setting (string)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -841,16 +841,16 @@
<h2>getQt4TranslationsDir</h2>
<b>getQt4TranslationsDir</b>(<i>prefClass = Prefs</i>)
<p>
- Module function to retrieve the Qt4TranslationsDir setting.
+ Module function to retrieve the Qt4TranslationsDir setting.
</p><dl>
<dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-the requested Qt4TranslationsDir setting (string)
+the requested Qt4TranslationsDir setting (string)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -859,19 +859,19 @@
<h2>getShell</h2>
<b>getShell</b>(<i>key, prefClass = Prefs</i>)
<p>
- Module function to retrieve the various shell settings.
+ Module function to retrieve the various shell settings.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the value to get
+the key of the value to get
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-the requested shell setting
+the requested shell setting
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -880,19 +880,19 @@
<h2>getSystem</h2>
<b>getSystem</b>(<i>key, prefClass = Prefs</i>)
<p>
- Module function to retrieve the various system settings.
+ Module function to retrieve the various system settings.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the value to get
+the key of the value to get
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-the requested system setting
+the requested system setting
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -901,19 +901,19 @@
<h2>getTasks</h2>
<b>getTasks</b>(<i>key, prefClass = Prefs</i>)
<p>
- Module function to retrieve the Tasks related settings.
+ Module function to retrieve the Tasks related settings.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the value to get
+the key of the value to get
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-the requested user setting
+the requested user setting
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -922,19 +922,19 @@
<h2>getTemplates</h2>
<b>getTemplates</b>(<i>key, prefClass = Prefs</i>)
<p>
- Module function to retrieve the Templates related settings.
+ Module function to retrieve the Templates related settings.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the value to get
+the key of the value to get
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-the requested user setting
+the requested user setting
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -943,19 +943,19 @@
<h2>getTerminal</h2>
<b>getTerminal</b>(<i>key, prefClass = Prefs</i>)
<p>
- Module function to retrieve the various terminal settings.
+ Module function to retrieve the various terminal settings.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the value to get
+the key of the value to get
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-the requested shell setting
+the requested shell setting
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -964,19 +964,19 @@
<h2>getUI</h2>
<b>getUI</b>(<i>key, prefClass = Prefs</i>)
<p>
- Module function to retrieve the various UI settings.
+ Module function to retrieve the various UI settings.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the value to get
+the key of the value to get
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-the requested UI setting
+the requested UI setting
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -985,16 +985,16 @@
<h2>getUILanguage</h2>
<b>getUILanguage</b>(<i>prefClass = Prefs</i>)
<p>
- Module function to retrieve the language for the user interface.
+ Module function to retrieve the language for the user interface.
</p><dl>
<dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-the language for the UI
+the language for the UI
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -1003,17 +1003,17 @@
<h2>getUILayout</h2>
<b>getUILayout</b>(<i>prefClass = Prefs</i>)
<p>
- Module function to retrieve the layout for the user interface.
+ Module function to retrieve the layout for the user interface.
</p><dl>
<dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-the UI layout as a tuple of main layout, flag for
- an embedded shell and a value for an embedded file browser
+the UI layout as a tuple of main layout, flag for
+ an embedded shell and a value for an embedded file browser
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -1022,19 +1022,19 @@
<h2>getUser</h2>
<b>getUser</b>(<i>key, prefClass = Prefs</i>)
<p>
- Module function to retrieve the various user settings.
+ Module function to retrieve the various user settings.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the value to get
+the key of the value to get
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-the requested user setting
+the requested user setting
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -1043,19 +1043,19 @@
<h2>getVCS</h2>
<b>getVCS</b>(<i>key, prefClass = Prefs</i>)
<p>
- Module function to retrieve the VCS related settings.
+ Module function to retrieve the VCS related settings.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the value to get
+the key of the value to get
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-the requested user setting
+the requested user setting
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -1064,16 +1064,16 @@
<h2>getVarFilters</h2>
<b>getVarFilters</b>(<i>prefClass = Prefs</i>)
<p>
- Module function to retrieve the variables filter settings.
+ Module function to retrieve the variables filter settings.
</p><dl>
<dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-a tuple defing the variables filter
+a tuple defing the variables filter
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -1082,16 +1082,16 @@
<h2>getViewManager</h2>
<b>getViewManager</b>(<i>prefClass = Prefs</i>)
<p>
- Module function to retrieve the selected viewmanager type.
+ Module function to retrieve the selected viewmanager type.
</p><dl>
<dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-the viewmanager type
+the viewmanager type
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -1100,12 +1100,12 @@
<h2>importPreferences</h2>
<b>importPreferences</b>(<i>prefClass = Prefs</i>)
<p>
- Module function to import preferences from a file previously saved by
- the export function.
+ Module function to import preferences from a file previously saved by
+ the export function.
</p><dl>
<dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -1114,7 +1114,7 @@
<h2>initPreferences</h2>
<b>initPreferences</b>(<i></i>)
<p>
- Module function to initialize the central configuration store.
+ Module function to initialize the central configuration store.
</p>
<div align="right"><a href="#top">Up</a></div>
<hr /><hr />
@@ -1122,10 +1122,10 @@
<h2>initRecentSettings</h2>
<b>initRecentSettings</b>(<i></i>)
<p>
- Module function to initialize the central configuration store for recently
- opened files and projects.
+ Module function to initialize the central configuration store for recently
+ opened files and projects.
</p><p>
- This function is called once upon import of the module.
+ This function is called once upon import of the module.
</p>
<div align="right"><a href="#top">Up</a></div>
<hr /><hr />
@@ -1133,16 +1133,16 @@
<h2>isConfigured</h2>
<b>isConfigured</b>(<i>prefClass = Prefs</i>)
<p>
- Module function to check, if the the application has been configured.
+ Module function to check, if the the application has been configured.
</p><dl>
<dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-flag indicating the configured status (boolean)
+flag indicating the configured status (boolean)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -1151,16 +1151,16 @@
<h2>readToolGroups</h2>
<b>readToolGroups</b>(<i>prefClass = Prefs</i>)
<p>
- Module function to read the tool groups configuration.
+ Module function to read the tool groups configuration.
</p><dl>
<dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-list of tuples defing the tool groups
+list of tuples defing the tool groups
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -1169,14 +1169,14 @@
<h2>removeProjectBrowserFlags</h2>
<b>removeProjectBrowserFlags</b>(<i>key, prefClass = Prefs</i>)
<p>
- Module function to remove a project browser flags setting.
+ Module function to remove a project browser flags setting.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the setting to be removed
+the key of the setting to be removed
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -1185,11 +1185,11 @@
<h2>resetLayout</h2>
<b>resetLayout</b>(<i>prefClass = Prefs</i>)
<p>
- Module function to set a flag not storing the current layout.
+ Module function to set a flag not storing the current layout.
</p><dl>
<dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -1198,7 +1198,7 @@
<h2>saveResetLayout</h2>
<b>saveResetLayout</b>(<i>prefClass = Prefs</i>)
<p>
- Module function to save the reset layout.
+ Module function to save the reset layout.
</p>
<div align="right"><a href="#top">Up</a></div>
<hr /><hr />
@@ -1206,17 +1206,17 @@
<h2>saveToolGroups</h2>
<b>saveToolGroups</b>(<i>toolGroups, currentGroup, prefClass = Prefs</i>)
<p>
- Module function to write the tool groups configuration.
+ Module function to write the tool groups configuration.
</p><dl>
<dt><i>toolGroups</i></dt>
<dd>
-reference to the list of tool groups
+reference to the list of tool groups
</dd><dt><i>currentGroup</i></dt>
<dd>
-index of the currently selected tool group (integer)
+index of the currently selected tool group (integer)
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -1225,17 +1225,17 @@
<h2>setCorba</h2>
<b>setCorba</b>(<i>key, value, prefClass = Prefs</i>)
<p>
- Module function to store the various corba settings.
+ Module function to store the various corba settings.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the setting to be set
+the key of the setting to be set
</dd><dt><i>value</i></dt>
<dd>
-the value to be set
+the value to be set
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -1244,17 +1244,17 @@
<h2>setDebugger</h2>
<b>setDebugger</b>(<i>key, value, prefClass = Prefs</i>)
<p>
- Module function to store the debugger settings.
+ Module function to store the debugger settings.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the setting to be set
+the key of the setting to be set
</dd><dt><i>value</i></dt>
<dd>
-the value to be set
+the value to be set
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -1263,17 +1263,17 @@
<h2>setEditor</h2>
<b>setEditor</b>(<i>key, value, prefClass = Prefs</i>)
<p>
- Module function to store the various editor settings.
+ Module function to store the various editor settings.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the setting to be set
+the key of the setting to be set
</dd><dt><i>value</i></dt>
<dd>
-the value to be set
+the value to be set
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -1282,17 +1282,17 @@
<h2>setEditorAPI</h2>
<b>setEditorAPI</b>(<i>key, apilist, prefClass = Prefs</i>)
<p>
- Module function to store the various lists of api files.
+ Module function to store the various lists of api files.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the api to be set
+the key of the api to be set
</dd><dt><i>apilist</i></dt>
<dd>
-the list of api files (list of strings)
+the list of api files (list of strings)
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -1301,17 +1301,17 @@
<h2>setEditorColour</h2>
<b>setEditorColour</b>(<i>key, value, prefClass = Prefs</i>)
<p>
- Module function to store the various editor marker colours.
+ Module function to store the various editor marker colours.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the colour to be set
+the key of the colour to be set
</dd><dt><i>value</i></dt>
<dd>
-the colour to be set
+the colour to be set
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -1320,17 +1320,17 @@
<h2>setEditorExporter</h2>
<b>setEditorExporter</b>(<i>key, value, prefClass = Prefs</i>)
<p>
- Module function to store the various editor exporters settings.
+ Module function to store the various editor exporters settings.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the setting to be set
+the key of the setting to be set
</dd><dt><i>value</i></dt>
<dd>
-the value to be set
+the value to be set
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -1339,14 +1339,14 @@
<h2>setEditorLexerAssocs</h2>
<b>setEditorLexerAssocs</b>(<i>assocs, prefClass = Prefs</i>)
<p>
- Module function to retrieve all lexer associations.
+ Module function to retrieve all lexer associations.
</p><dl>
<dt><i>assocs</i></dt>
<dd>
-dictionary of lexer associations to be set
+dictionary of lexer associations to be set
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -1355,17 +1355,17 @@
<h2>setEditorOtherFonts</h2>
<b>setEditorOtherFonts</b>(<i>key, font, prefClass = Prefs</i>)
<p>
- Module function to store the various editor fonts except the lexer fonts.
+ Module function to store the various editor fonts except the lexer fonts.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the font to be set
+the key of the font to be set
</dd><dt><i>font</i></dt>
<dd>
-the font to be set (QFont)
+the font to be set (QFont)
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -1374,17 +1374,17 @@
<h2>setEditorTyping</h2>
<b>setEditorTyping</b>(<i>key, value, prefClass = Prefs</i>)
<p>
- Module function to store the various editor typing settings.
+ Module function to store the various editor typing settings.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the setting to be set
+the key of the setting to be set
</dd><dt><i>value</i></dt>
<dd>
-the value to be set
+the value to be set
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -1393,17 +1393,17 @@
<h2>setGeometry</h2>
<b>setGeometry</b>(<i>key, value, prefClass = Prefs</i>)
<p>
- Module function to store the display geometry.
+ Module function to store the display geometry.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the setting to be set
+the key of the setting to be set
</dd><dt><i>value</i></dt>
<dd>
-the geometry to be set
+the geometry to be set
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -1412,17 +1412,17 @@
<h2>setGraphics</h2>
<b>setGraphics</b>(<i>key, value, prefClass = Prefs</i>)
<p>
- Module function to store the Graphics related settings.
+ Module function to store the Graphics related settings.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the setting to be set
+the key of the setting to be set
</dd><dt><i>value</i></dt>
<dd>
-the value to be set
+the value to be set
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -1431,17 +1431,17 @@
<h2>setHelp</h2>
<b>setHelp</b>(<i>key, value, prefClass = Prefs</i>)
<p>
- Module function to store the various help settings.
+ Module function to store the various help settings.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the setting to be set
+the key of the setting to be set
</dd><dt><i>value</i></dt>
<dd>
-the value to be set
+the value to be set
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -1450,17 +1450,17 @@
<h2>setIconEditor</h2>
<b>setIconEditor</b>(<i>key, value, prefClass = Prefs</i>)
<p>
- Module function to store the Icon Editor related settings.
+ Module function to store the Icon Editor related settings.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the setting to be set
+the key of the setting to be set
</dd><dt><i>value</i></dt>
<dd>
-the value to be set
+the value to be set
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -1469,17 +1469,17 @@
<h2>setIcons</h2>
<b>setIcons</b>(<i>key, value, prefClass = Prefs</i>)
<p>
- Module function to store the various Icons settings.
+ Module function to store the various Icons settings.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the setting to be set
+the key of the setting to be set
</dd><dt><i>value</i></dt>
<dd>
-the value to be set
+the value to be set
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -1488,17 +1488,17 @@
<h2>setMultiProject</h2>
<b>setMultiProject</b>(<i>key, value, prefClass = Prefs</i>)
<p>
- Module function to store the various project handling settings.
+ Module function to store the various project handling settings.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the setting to be set
+the key of the setting to be set
</dd><dt><i>value</i></dt>
<dd>
-the value to be set
+the value to be set
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -1507,17 +1507,17 @@
<h2>setPluginManager</h2>
<b>setPluginManager</b>(<i>key, value, prefClass = Prefs</i>)
<p>
- Module function to store the plugin manager related settings.
+ Module function to store the plugin manager related settings.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the setting to be set
+the key of the setting to be set
</dd><dt><i>value</i></dt>
<dd>
-the value to be set
+the value to be set
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -1526,17 +1526,17 @@
<h2>setPrinter</h2>
<b>setPrinter</b>(<i>key, value, prefClass = Prefs</i>)
<p>
- Module function to store the various printer settings.
+ Module function to store the various printer settings.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the setting to be set
+the key of the setting to be set
</dd><dt><i>value</i></dt>
<dd>
-the value to be set
+the value to be set
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -1545,17 +1545,17 @@
<h2>setProject</h2>
<b>setProject</b>(<i>key, value, prefClass = Prefs</i>)
<p>
- Module function to store the various project handling settings.
+ Module function to store the various project handling settings.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the setting to be set
+the key of the setting to be set
</dd><dt><i>value</i></dt>
<dd>
-the value to be set
+the value to be set
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -1564,17 +1564,17 @@
<h2>setProjectBrowserColour</h2>
<b>setProjectBrowserColour</b>(<i>key, value, prefClass = Prefs</i>)
<p>
- Module function to store the various project browser colours.
+ Module function to store the various project browser colours.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the colour to be set
+the key of the colour to be set
</dd><dt><i>value</i></dt>
<dd>
-the colour to be set
+the colour to be set
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -1583,17 +1583,17 @@
<h2>setProjectBrowserFlags</h2>
<b>setProjectBrowserFlags</b>(<i>key, value, prefClass = Prefs</i>)
<p>
- Module function to store the various project browser flags settings.
+ Module function to store the various project browser flags settings.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the setting to be set
+the key of the setting to be set
</dd><dt><i>value</i></dt>
<dd>
-the value to be set
+the value to be set
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -1602,17 +1602,17 @@
<h2>setProjectBrowserFlagsDefault</h2>
<b>setProjectBrowserFlagsDefault</b>(<i>key, value, prefClass = Prefs</i>)
<p>
- Module function to store the various project browser flags settings.
+ Module function to store the various project browser flags settings.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the setting to be set
+the key of the setting to be set
</dd><dt><i>value</i></dt>
<dd>
-the value to be set
+the value to be set
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -1621,17 +1621,17 @@
<h2>setPython</h2>
<b>setPython</b>(<i>key, value, prefClass = Prefs</i>)
<p>
- Module function to store the Python settings.
+ Module function to store the Python settings.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the setting to be set
+the key of the setting to be set
</dd><dt><i>value</i></dt>
<dd>
-the value to be set
+the value to be set
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -1640,17 +1640,17 @@
<h2>setQt</h2>
<b>setQt</b>(<i>key, value, prefClass = Prefs</i>)
<p>
- Module function to store the various Qt settings.
+ Module function to store the various Qt settings.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the setting to be set
+the key of the setting to be set
</dd><dt><i>value</i></dt>
<dd>
-the value to be set
+the value to be set
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -1659,17 +1659,17 @@
<h2>setShell</h2>
<b>setShell</b>(<i>key, value, prefClass = Prefs</i>)
<p>
- Module function to store the various shell settings.
+ Module function to store the various shell settings.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the setting to be set
+the key of the setting to be set
</dd><dt><i>value</i></dt>
<dd>
-the value to be set
+the value to be set
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -1678,17 +1678,17 @@
<h2>setSystem</h2>
<b>setSystem</b>(<i>key, value, prefClass = Prefs</i>)
<p>
- Module function to store the various system settings.
+ Module function to store the various system settings.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the setting to be set
+the key of the setting to be set
</dd><dt><i>value</i></dt>
<dd>
-the value to be set
+the value to be set
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -1697,17 +1697,17 @@
<h2>setTasks</h2>
<b>setTasks</b>(<i>key, value, prefClass = Prefs</i>)
<p>
- Module function to store the Tasks related settings.
+ Module function to store the Tasks related settings.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the setting to be set
+the key of the setting to be set
</dd><dt><i>value</i></dt>
<dd>
-the value to be set
+the value to be set
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -1716,17 +1716,17 @@
<h2>setTemplates</h2>
<b>setTemplates</b>(<i>key, value, prefClass = Prefs</i>)
<p>
- Module function to store the Templates related settings.
+ Module function to store the Templates related settings.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the setting to be set
+the key of the setting to be set
</dd><dt><i>value</i></dt>
<dd>
-the value to be set
+the value to be set
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -1735,17 +1735,17 @@
<h2>setTerminal</h2>
<b>setTerminal</b>(<i>key, value, prefClass = Prefs</i>)
<p>
- Module function to store the various terminal settings.
+ Module function to store the various terminal settings.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the setting to be set
+the key of the setting to be set
</dd><dt><i>value</i></dt>
<dd>
-the value to be set
+the value to be set
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -1754,17 +1754,17 @@
<h2>setUI</h2>
<b>setUI</b>(<i>key, value, prefClass = Prefs</i>)
<p>
- Module function to store the various UI settings.
+ Module function to store the various UI settings.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the setting to be set
+the key of the setting to be set
</dd><dt><i>value</i></dt>
<dd>
-the value to be set
+the value to be set
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -1773,14 +1773,14 @@
<h2>setUILanguage</h2>
<b>setUILanguage</b>(<i>lang, prefClass = Prefs</i>)
<p>
- Module function to store the language for the user interface.
+ Module function to store the language for the user interface.
</p><dl>
<dt><i>lang</i></dt>
<dd>
-the language
+the language
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -1789,14 +1789,14 @@
<h2>setUILayout</h2>
<b>setUILayout</b>(<i>layout, prefClass = Prefs</i>)
<p>
- Module function to store the layout for the user interface.
+ Module function to store the layout for the user interface.
</p><dl>
<dt><i>layout</i></dt>
<dd>
-the layout type
+the layout type
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -1805,17 +1805,17 @@
<h2>setUser</h2>
<b>setUser</b>(<i>key, value, prefClass = Prefs</i>)
<p>
- Module function to store the various user settings.
+ Module function to store the various user settings.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the setting to be set
+the key of the setting to be set
</dd><dt><i>value</i></dt>
<dd>
-the value to be set
+the value to be set
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -1824,17 +1824,17 @@
<h2>setVCS</h2>
<b>setVCS</b>(<i>key, value, prefClass = Prefs</i>)
<p>
- Module function to store the VCS related settings.
+ Module function to store the VCS related settings.
</p><dl>
<dt><i>key</i></dt>
<dd>
-the key of the setting to be set
+the key of the setting to be set
</dd><dt><i>value</i></dt>
<dd>
-the value to be set
+the value to be set
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -1843,11 +1843,11 @@
<h2>setVarFilters</h2>
<b>setVarFilters</b>(<i>filters, prefClass = Prefs</i>)
<p>
- Module function to store the variables filter settings.
+ Module function to store the variables filter settings.
</p><dl>
<dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -1856,14 +1856,14 @@
<h2>setViewManager</h2>
<b>setViewManager</b>(<i>vm, prefClass = Prefs</i>)
<p>
- Module function to store the selected viewmanager type.
+ Module function to store the selected viewmanager type.
</p><dl>
<dt><i>vm</i></dt>
<dd>
-the viewmanager type
+the viewmanager type
</dd><dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -1872,16 +1872,16 @@
<h2>shouldResetLayout</h2>
<b>shouldResetLayout</b>(<i>prefClass = Prefs</i>)
<p>
- Module function to indicate a reset of the layout.
+ Module function to indicate a reset of the layout.
</p><dl>
<dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-flag indicating a reset of the layout (boolean)
+flag indicating a reset of the layout (boolean)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -1890,13 +1890,13 @@
<h2>syncPreferences</h2>
<b>syncPreferences</b>(<i>prefClass = Prefs</i>)
<p>
- Module function to sync the preferences to disk.
+ Module function to sync the preferences to disk.
</p><p>
- In addition to syncing, the central configuration store is reinitialized as well.
+ In addition to syncing, the central configuration store is reinitialized as well.
</p><dl>
<dt><i>prefClass</i></dt>
<dd>
-preferences class used as the storage area
+preferences class used as the storage area
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -1905,16 +1905,16 @@
<h2>toBool</h2>
<b>toBool</b>(<i>value</i>)
<p>
- Module function to convert a value to bool.
+ Module function to convert a value to bool.
</p><dl>
<dt><i>value</i></dt>
<dd>
-value to be converted
+value to be converted
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-converted data
+converted data
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
@@ -1923,16 +1923,16 @@
<h2>toList</h2>
<b>toList</b>(<i>value</i>)
<p>
- Module function to convert a value to a list.
+ Module function to convert a value to a list.
</p><dl>
<dt><i>value</i></dt>
<dd>
-value to be converted
+value to be converted
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
-converted data
+converted data
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
