--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Documentation/Source/eric5.Preferences.__init__.html Sat Jan 02 18:19:35 2010 +0000 @@ -0,0 +1,1928 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' +'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> +<html><head> +<title>eric5.Preferences.__init__</title> +<style> +b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' +</style> +</head> +<body><a NAME="top" ID="top"></a> +<h1>eric5.Preferences.__init__</h1> +<p> +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. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</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="#exportPreferences">exportPreferences</a></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> +</tr><tr> +<td><a href="#getDebugger">getDebugger</a></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> +</tr><tr> +<td><a href="#getEditorAPI">getEditorAPI</a></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> +</tr><tr> +<td><a href="#getEditorExporter">getEditorExporter</a></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> +</tr><tr> +<td><a href="#getEditorLexerAssocs">getEditorLexerAssocs</a></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> +</tr><tr> +<td><a href="#getEditorTyping">getEditorTyping</a></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> +</tr><tr> +<td><a href="#getGraphics">getGraphics</a></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> +</tr><tr> +<td><a href="#getIconEditor">getIconEditor</a></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> +</tr><tr> +<td><a href="#getMultiProject">getMultiProject</a></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> +</tr><tr> +<td><a href="#getPrinter">getPrinter</a></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> +</tr><tr> +<td><a href="#getProjectBrowserColour">getProjectBrowserColour</a></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> +</tr><tr> +<td><a href="#getPython">getPython</a></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> +</tr><tr> +<td><a href="#getQt4DocDir">getQt4DocDir</a></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> +</tr><tr> +<td><a href="#getShell">getShell</a></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> +</tr><tr> +<td><a href="#getTasks">getTasks</a></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> +</tr><tr> +<td><a href="#getTerminal">getTerminal</a></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> +</tr><tr> +<td><a href="#getUILanguage">getUILanguage</a></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> +</tr><tr> +<td><a href="#getUser">getUser</a></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> +</tr><tr> +<td><a href="#getVarFilters">getVarFilters</a></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> +</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> +</tr><tr> +<td><a href="#initPreferences">initPreferences</a></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> +</tr><tr> +<td><a href="#isConfigured">isConfigured</a></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> +</tr><tr> +<td><a href="#removeProjectBrowserFlags">removeProjectBrowserFlags</a></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> +</tr><tr> +<td><a href="#saveResetLayout">saveResetLayout</a></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> +</tr><tr> +<td><a href="#setCorba">setCorba</a></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> +</tr><tr> +<td><a href="#setEditor">setEditor</a></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> +</tr><tr> +<td><a href="#setEditorColour">setEditorColour</a></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> +</tr><tr> +<td><a href="#setEditorLexerAssocs">setEditorLexerAssocs</a></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> +</tr><tr> +<td><a href="#setEditorTyping">setEditorTyping</a></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> +</tr><tr> +<td><a href="#setGraphics">setGraphics</a></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> +</tr><tr> +<td><a href="#setIconEditor">setIconEditor</a></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> +</tr><tr> +<td><a href="#setMultiProject">setMultiProject</a></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> +</tr><tr> +<td><a href="#setPrinter">setPrinter</a></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> +</tr><tr> +<td><a href="#setProjectBrowserColour">setProjectBrowserColour</a></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> +</tr><tr> +<td><a href="#setProjectBrowserFlagsDefault">setProjectBrowserFlagsDefault</a></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> +</tr><tr> +<td><a href="#setQt">setQt</a></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> +</tr><tr> +<td><a href="#setSystem">setSystem</a></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> +</tr><tr> +<td><a href="#setTemplates">setTemplates</a></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> +</tr><tr> +<td><a href="#setUI">setUI</a></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> +</tr><tr> +<td><a href="#setUILayout">setUILayout</a></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> +</tr><tr> +<td><a href="#setVCS">setVCS</a></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> +</tr><tr> +<td><a href="#setViewManager">setViewManager</a></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> +</tr><tr> +<td><a href="#syncPreferences">syncPreferences</a></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> +</tr><tr> +<td><a href="#toList">toList</a></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. +</p> +<h3>Derived from</h3> +object +<h3>Class Attributes</h3> +<table> +<tr><td>corbaDefaults</td></tr><tr><td>debuggerDefaults</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>fontFamily</td></tr><tr><td>fontSize</td></tr><tr><td>geometryDefaults</td></tr><tr><td>graphicsDefaults</td></tr><tr><td>helpDefaults</td></tr><tr><td>iconEditorDefaults</td></tr><tr><td>iconsDefaults</td></tr><tr><td>multiProjectDefaults</td></tr><tr><td>pluginManagerDefaults</td></tr><tr><td>printerDefaults</td></tr><tr><td>projectBrowserColourDefaults</td></tr><tr><td>projectBrowserFlagsDefaults</td></tr><tr><td>projectDefaults</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>terminalDefaults</td></tr><tr><td>uiDefaults</td></tr><tr><td>userDefaults</td></tr><tr><td>varDefaults</td></tr><tr><td>vcsDefaults</td></tr><tr><td>viewProfilesLength</td></tr><tr><td>websettings</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr><td>None</td></tr> +</table> + +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="exportPreferences" ID="exportPreferences"></a> +<h2>exportPreferences</h2> +<b>exportPreferences</b>(<i>prefClass = Prefs</i>) +<p> + Module function to export the current preferences. +</p><dl> +<dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="getCorba" ID="getCorba"></a> +<h2>getCorba</h2> +<b>getCorba</b>(<i>key, prefClass = Prefs</i>) +<p> + Module function to retrieve the various corba settings. +</p><dl> +<dt><i>key</i></dt> +<dd> +the key of the value to get +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +the requested corba setting +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="getDebugger" ID="getDebugger"></a> +<h2>getDebugger</h2> +<b>getDebugger</b>(<i>key, prefClass = Prefs</i>) +<p> + Module function to retrieve the debugger settings. +</p><dl> +<dt><i>key</i></dt> +<dd> +the key of the value to get +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +the requested debugger setting +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="getEditor" ID="getEditor"></a> +<h2>getEditor</h2> +<b>getEditor</b>(<i>key, prefClass = Prefs</i>) +<p> + Module function to retrieve the various editor settings. +</p><dl> +<dt><i>key</i></dt> +<dd> +the key of the value to get +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +the requested editor setting +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="getEditorAPI" ID="getEditorAPI"></a> +<h2>getEditorAPI</h2> +<b>getEditorAPI</b>(<i>key, prefClass = Prefs</i>) +<p> + 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 +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +the requested list of api files (list of strings) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="getEditorColour" ID="getEditorColour"></a> +<h2>getEditorColour</h2> +<b>getEditorColour</b>(<i>key, prefClass = Prefs</i>) +<p> + Module function to retrieve the various editor marker colours. +</p><dl> +<dt><i>key</i></dt> +<dd> +the key of the value to get +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +the requested editor colour +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="getEditorExporter" ID="getEditorExporter"></a> +<h2>getEditorExporter</h2> +<b>getEditorExporter</b>(<i>key, prefClass = Prefs</i>) +<p> + Module function to retrieve the various editor exporters settings. +</p><dl> +<dt><i>key</i></dt> +<dd> +the key of the value to get +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +the requested editor setting +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="getEditorLexerAssoc" ID="getEditorLexerAssoc"></a> +<h2>getEditorLexerAssoc</h2> +<b>getEditorLexerAssoc</b>(<i>filename, prefClass = Prefs</i>) +<p> + Module function to retrieve a lexer association. +</p><dl> +<dt><i>filename</i></dt> +<dd> +filename used to determine the associated lexer language (string) +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +the requested lexer language (string) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="getEditorLexerAssocs" ID="getEditorLexerAssocs"></a> +<h2>getEditorLexerAssocs</h2> +<b>getEditorLexerAssocs</b>(<i>prefClass = Prefs</i>) +<p> + Module function to retrieve all lexer associations. +</p><dl> +<dt><i>prefClass</i></dt> +<dd> +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) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="getEditorOtherFonts" ID="getEditorOtherFonts"></a> +<h2>getEditorOtherFonts</h2> +<b>getEditorOtherFonts</b>(<i>key, prefClass = Prefs</i>) +<p> + 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 +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +the requested editor font (QFont) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="getEditorTyping" ID="getEditorTyping"></a> +<h2>getEditorTyping</h2> +<b>getEditorTyping</b>(<i>key, prefClass = Prefs</i>) +<p> + Module function to retrieve the various editor typing settings. +</p><dl> +<dt><i>key</i></dt> +<dd> +the key of the value to get +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +the requested editor setting +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="getGeometry" ID="getGeometry"></a> +<h2>getGeometry</h2> +<b>getGeometry</b>(<i>key, prefClass = Prefs</i>) +<p> + Module function to retrieve the display geometry. +</p><dl> +<dt><i>key</i></dt> +<dd> +the key of the value to get +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +the requested geometry setting +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="getGraphics" ID="getGraphics"></a> +<h2>getGraphics</h2> +<b>getGraphics</b>(<i>key, prefClass = Prefs</i>) +<p> + Module function to retrieve the Graphics related settings. +</p><dl> +<dt><i>key</i></dt> +<dd> +the key of the value to get +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +the requested user setting +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="getHelp" ID="getHelp"></a> +<h2>getHelp</h2> +<b>getHelp</b>(<i>key, prefClass = Prefs</i>) +<p> + Module function to retrieve the various help settings. +</p><dl> +<dt><i>key</i></dt> +<dd> +the key of the value to get +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +the requested help setting +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="getIconEditor" ID="getIconEditor"></a> +<h2>getIconEditor</h2> +<b>getIconEditor</b>(<i>key, prefClass = Prefs</i>) +<p> + Module function to retrieve the Icon Editor related settings. +</p><dl> +<dt><i>key</i></dt> +<dd> +the key of the value to get +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +the requested user setting +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="getIcons" ID="getIcons"></a> +<h2>getIcons</h2> +<b>getIcons</b>(<i>key, prefClass = Prefs</i>) +<p> + Module function to retrieve the various Icons settings. +</p><dl> +<dt><i>key</i></dt> +<dd> +the key of the value to get +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +the requested Icons setting +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="getMultiProject" ID="getMultiProject"></a> +<h2>getMultiProject</h2> +<b>getMultiProject</b>(<i>key, prefClass = Prefs</i>) +<p> + Module function to retrieve the various project handling settings. +</p><dl> +<dt><i>key</i></dt> +<dd> +the key of the value to get +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +the requested project setting +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="getPluginManager" ID="getPluginManager"></a> +<h2>getPluginManager</h2> +<b>getPluginManager</b>(<i>key, prefClass = Prefs</i>) +<p> + Module function to retrieve the plugin manager related settings. +</p><dl> +<dt><i>key</i></dt> +<dd> +the key of the value to get +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +the requested user setting +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="getPrinter" ID="getPrinter"></a> +<h2>getPrinter</h2> +<b>getPrinter</b>(<i>key, prefClass = Prefs</i>) +<p> + Module function to retrieve the various printer settings. +</p><dl> +<dt><i>key</i></dt> +<dd> +the key of the value to get +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +the requested printer setting +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="getProject" ID="getProject"></a> +<h2>getProject</h2> +<b>getProject</b>(<i>key, prefClass = Prefs</i>) +<p> + Module function to retrieve the various project handling settings. +</p><dl> +<dt><i>key</i></dt> +<dd> +the key of the value to get +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +the requested project setting +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="getProjectBrowserColour" ID="getProjectBrowserColour"></a> +<h2>getProjectBrowserColour</h2> +<b>getProjectBrowserColour</b>(<i>key, prefClass = Prefs</i>) +<p> + Module function to retrieve the various project browser colours. +</p><dl> +<dt><i>key</i></dt> +<dd> +the key of the value to get +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +the requested project browser colour +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="getProjectBrowserFlags" ID="getProjectBrowserFlags"></a> +<h2>getProjectBrowserFlags</h2> +<b>getProjectBrowserFlags</b>(<i>key, prefClass = Prefs</i>) +<p> + 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 +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +the requested project setting +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="getPython" ID="getPython"></a> +<h2>getPython</h2> +<b>getPython</b>(<i>key, prefClass = Prefs</i>) +<p> + Module function to retrieve the Python settings. +</p><dl> +<dt><i>key</i></dt> +<dd> +the key of the value to get +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +the requested debugger setting +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="getQt" ID="getQt"></a> +<h2>getQt</h2> +<b>getQt</b>(<i>key, prefClass = Prefs</i>) +<p> + Module function to retrieve the various Qt settings. +</p><dl> +<dt><i>key</i></dt> +<dd> +the key of the value to get +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +the requested Qt setting +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="getQt4DocDir" ID="getQt4DocDir"></a> +<h2>getQt4DocDir</h2> +<b>getQt4DocDir</b>(<i>prefClass = Prefs</i>) +<p> + Module function to retrieve the Qt4DocDir setting. +</p><dl> +<dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +the requested Qt4DocDir setting (string) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="getQt4TranslationsDir" ID="getQt4TranslationsDir"></a> +<h2>getQt4TranslationsDir</h2> +<b>getQt4TranslationsDir</b>(<i>prefClass = Prefs</i>) +<p> + Module function to retrieve the Qt4TranslationsDir setting. +</p><dl> +<dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +the requested Qt4TranslationsDir setting (string) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="getShell" ID="getShell"></a> +<h2>getShell</h2> +<b>getShell</b>(<i>key, prefClass = Prefs</i>) +<p> + Module function to retrieve the various shell settings. +</p><dl> +<dt><i>key</i></dt> +<dd> +the key of the value to get +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +the requested shell setting +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="getSystem" ID="getSystem"></a> +<h2>getSystem</h2> +<b>getSystem</b>(<i>key, prefClass = Prefs</i>) +<p> + Module function to retrieve the various system settings. +</p><dl> +<dt><i>key</i></dt> +<dd> +the key of the value to get +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +the requested system setting +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="getTasks" ID="getTasks"></a> +<h2>getTasks</h2> +<b>getTasks</b>(<i>key, prefClass = Prefs</i>) +<p> + Module function to retrieve the Tasks related settings. +</p><dl> +<dt><i>key</i></dt> +<dd> +the key of the value to get +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +the requested user setting +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="getTemplates" ID="getTemplates"></a> +<h2>getTemplates</h2> +<b>getTemplates</b>(<i>key, prefClass = Prefs</i>) +<p> + Module function to retrieve the Templates related settings. +</p><dl> +<dt><i>key</i></dt> +<dd> +the key of the value to get +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +the requested user setting +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="getTerminal" ID="getTerminal"></a> +<h2>getTerminal</h2> +<b>getTerminal</b>(<i>key, prefClass = Prefs</i>) +<p> + Module function to retrieve the various terminal settings. +</p><dl> +<dt><i>key</i></dt> +<dd> +the key of the value to get +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +the requested shell setting +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="getUI" ID="getUI"></a> +<h2>getUI</h2> +<b>getUI</b>(<i>key, prefClass = Prefs</i>) +<p> + Module function to retrieve the various UI settings. +</p><dl> +<dt><i>key</i></dt> +<dd> +the key of the value to get +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +the requested UI setting +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="getUILanguage" ID="getUILanguage"></a> +<h2>getUILanguage</h2> +<b>getUILanguage</b>(<i>prefClass = Prefs</i>) +<p> + 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 +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +the language for the UI +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="getUILayout" ID="getUILayout"></a> +<h2>getUILayout</h2> +<b>getUILayout</b>(<i>prefClass = Prefs</i>) +<p> + 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 +</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 +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="getUser" ID="getUser"></a> +<h2>getUser</h2> +<b>getUser</b>(<i>key, prefClass = Prefs</i>) +<p> + Module function to retrieve the various user settings. +</p><dl> +<dt><i>key</i></dt> +<dd> +the key of the value to get +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +the requested user setting +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="getVCS" ID="getVCS"></a> +<h2>getVCS</h2> +<b>getVCS</b>(<i>key, prefClass = Prefs</i>) +<p> + Module function to retrieve the VCS related settings. +</p><dl> +<dt><i>key</i></dt> +<dd> +the key of the value to get +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +the requested user setting +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="getVarFilters" ID="getVarFilters"></a> +<h2>getVarFilters</h2> +<b>getVarFilters</b>(<i>prefClass = Prefs</i>) +<p> + Module function to retrieve the variables filter settings. +</p><dl> +<dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +a tuple defing the variables filter +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="getViewManager" ID="getViewManager"></a> +<h2>getViewManager</h2> +<b>getViewManager</b>(<i>prefClass = Prefs</i>) +<p> + Module function to retrieve the selected viewmanager type. +</p><dl> +<dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +the viewmanager type +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="importPreferences" ID="importPreferences"></a> +<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. +</p><dl> +<dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl> +<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. +</p><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>prefClass = Prefs</i>) +<p> + 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 +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +flag indicating the configured status (boolean) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="readToolGroups" ID="readToolGroups"></a> +<h2>readToolGroups</h2> +<b>readToolGroups</b>(<i>prefClass = Prefs</i>) +<p> + Module function to read the tool groups configuration. +</p><dl> +<dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +list of tuples defing the tool groups +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="removeProjectBrowserFlags" ID="removeProjectBrowserFlags"></a> +<h2>removeProjectBrowserFlags</h2> +<b>removeProjectBrowserFlags</b>(<i>key, prefClass = Prefs</i>) +<p> + 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 +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="resetLayout" ID="resetLayout"></a> +<h2>resetLayout</h2> +<b>resetLayout</b>(<i>prefClass = Prefs</i>) +<p> + 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 +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="saveResetLayout" ID="saveResetLayout"></a> +<h2>saveResetLayout</h2> +<b>saveResetLayout</b>(<i>prefClass = Prefs</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, prefClass = Prefs</i>) +<p> + Module function to write the tool groups configuration. +</p><dl> +<dt><i>toolGroups</i></dt> +<dd> +reference to the list of tool groups +</dd><dt><i>currentGroup</i></dt> +<dd> +index of the currently selected tool group (integer) +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="setCorba" ID="setCorba"></a> +<h2>setCorba</h2> +<b>setCorba</b>(<i>key, value, prefClass = Prefs</i>) +<p> + Module function to store the various corba settings. +</p><dl> +<dt><i>key</i></dt> +<dd> +the key of the setting to be set +</dd><dt><i>value</i></dt> +<dd> +the value to be set +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="setDebugger" ID="setDebugger"></a> +<h2>setDebugger</h2> +<b>setDebugger</b>(<i>key, value, prefClass = Prefs</i>) +<p> + Module function to store the debugger settings. +</p><dl> +<dt><i>key</i></dt> +<dd> +the key of the setting to be set +</dd><dt><i>value</i></dt> +<dd> +the value to be set +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="setEditor" ID="setEditor"></a> +<h2>setEditor</h2> +<b>setEditor</b>(<i>key, value, prefClass = Prefs</i>) +<p> + Module function to store the various editor settings. +</p><dl> +<dt><i>key</i></dt> +<dd> +the key of the setting to be set +</dd><dt><i>value</i></dt> +<dd> +the value to be set +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="setEditorAPI" ID="setEditorAPI"></a> +<h2>setEditorAPI</h2> +<b>setEditorAPI</b>(<i>key, apilist, prefClass = Prefs</i>) +<p> + 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 +</dd><dt><i>apilist</i></dt> +<dd> +the list of api files (list of strings) +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="setEditorColour" ID="setEditorColour"></a> +<h2>setEditorColour</h2> +<b>setEditorColour</b>(<i>key, value, prefClass = Prefs</i>) +<p> + 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 +</dd><dt><i>value</i></dt> +<dd> +the colour to be set +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="setEditorExporter" ID="setEditorExporter"></a> +<h2>setEditorExporter</h2> +<b>setEditorExporter</b>(<i>key, value, prefClass = Prefs</i>) +<p> + 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 +</dd><dt><i>value</i></dt> +<dd> +the value to be set +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="setEditorLexerAssocs" ID="setEditorLexerAssocs"></a> +<h2>setEditorLexerAssocs</h2> +<b>setEditorLexerAssocs</b>(<i>assocs, prefClass = Prefs</i>) +<p> + Module function to retrieve all lexer associations. +</p><dl> +<dt><i>assocs</i></dt> +<dd> +dictionary of lexer associations to be set +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="setEditorOtherFonts" ID="setEditorOtherFonts"></a> +<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. +</p><dl> +<dt><i>key</i></dt> +<dd> +the key of the font to be set +</dd><dt><i>font</i></dt> +<dd> +the font to be set (QFont) +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="setEditorTyping" ID="setEditorTyping"></a> +<h2>setEditorTyping</h2> +<b>setEditorTyping</b>(<i>key, value, prefClass = Prefs</i>) +<p> + 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 +</dd><dt><i>value</i></dt> +<dd> +the value to be set +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="setGeometry" ID="setGeometry"></a> +<h2>setGeometry</h2> +<b>setGeometry</b>(<i>key, value, prefClass = Prefs</i>) +<p> + Module function to store the display geometry. +</p><dl> +<dt><i>key</i></dt> +<dd> +the key of the setting to be set +</dd><dt><i>value</i></dt> +<dd> +the geometry to be set +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="setGraphics" ID="setGraphics"></a> +<h2>setGraphics</h2> +<b>setGraphics</b>(<i>key, value, prefClass = Prefs</i>) +<p> + Module function to store the Graphics related settings. +</p><dl> +<dt><i>key</i></dt> +<dd> +the key of the setting to be set +</dd><dt><i>value</i></dt> +<dd> +the value to be set +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="setHelp" ID="setHelp"></a> +<h2>setHelp</h2> +<b>setHelp</b>(<i>key, value, prefClass = Prefs</i>) +<p> + Module function to store the various help settings. +</p><dl> +<dt><i>key</i></dt> +<dd> +the key of the setting to be set +</dd><dt><i>value</i></dt> +<dd> +the value to be set +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="setIconEditor" ID="setIconEditor"></a> +<h2>setIconEditor</h2> +<b>setIconEditor</b>(<i>key, value, prefClass = Prefs</i>) +<p> + 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 +</dd><dt><i>value</i></dt> +<dd> +the value to be set +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="setIcons" ID="setIcons"></a> +<h2>setIcons</h2> +<b>setIcons</b>(<i>key, value, prefClass = Prefs</i>) +<p> + Module function to store the various Icons settings. +</p><dl> +<dt><i>key</i></dt> +<dd> +the key of the setting to be set +</dd><dt><i>value</i></dt> +<dd> +the value to be set +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="setMultiProject" ID="setMultiProject"></a> +<h2>setMultiProject</h2> +<b>setMultiProject</b>(<i>key, value, prefClass = Prefs</i>) +<p> + 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 +</dd><dt><i>value</i></dt> +<dd> +the value to be set +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="setPluginManager" ID="setPluginManager"></a> +<h2>setPluginManager</h2> +<b>setPluginManager</b>(<i>key, value, prefClass = Prefs</i>) +<p> + 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 +</dd><dt><i>value</i></dt> +<dd> +the value to be set +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="setPrinter" ID="setPrinter"></a> +<h2>setPrinter</h2> +<b>setPrinter</b>(<i>key, value, prefClass = Prefs</i>) +<p> + Module function to store the various printer settings. +</p><dl> +<dt><i>key</i></dt> +<dd> +the key of the setting to be set +</dd><dt><i>value</i></dt> +<dd> +the value to be set +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="setProject" ID="setProject"></a> +<h2>setProject</h2> +<b>setProject</b>(<i>key, value, prefClass = Prefs</i>) +<p> + 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 +</dd><dt><i>value</i></dt> +<dd> +the value to be set +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="setProjectBrowserColour" ID="setProjectBrowserColour"></a> +<h2>setProjectBrowserColour</h2> +<b>setProjectBrowserColour</b>(<i>key, value, prefClass = Prefs</i>) +<p> + 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 +</dd><dt><i>value</i></dt> +<dd> +the colour to be set +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="setProjectBrowserFlags" ID="setProjectBrowserFlags"></a> +<h2>setProjectBrowserFlags</h2> +<b>setProjectBrowserFlags</b>(<i>key, value, prefClass = Prefs</i>) +<p> + 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 +</dd><dt><i>value</i></dt> +<dd> +the value to be set +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="setProjectBrowserFlagsDefault" ID="setProjectBrowserFlagsDefault"></a> +<h2>setProjectBrowserFlagsDefault</h2> +<b>setProjectBrowserFlagsDefault</b>(<i>key, value, prefClass = Prefs</i>) +<p> + 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 +</dd><dt><i>value</i></dt> +<dd> +the value to be set +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="setPython" ID="setPython"></a> +<h2>setPython</h2> +<b>setPython</b>(<i>key, value, prefClass = Prefs</i>) +<p> + Module function to store the Python settings. +</p><dl> +<dt><i>key</i></dt> +<dd> +the key of the setting to be set +</dd><dt><i>value</i></dt> +<dd> +the value to be set +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="setQt" ID="setQt"></a> +<h2>setQt</h2> +<b>setQt</b>(<i>key, value, prefClass = Prefs</i>) +<p> + Module function to store the various Qt settings. +</p><dl> +<dt><i>key</i></dt> +<dd> +the key of the setting to be set +</dd><dt><i>value</i></dt> +<dd> +the value to be set +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="setShell" ID="setShell"></a> +<h2>setShell</h2> +<b>setShell</b>(<i>key, value, prefClass = Prefs</i>) +<p> + Module function to store the various shell settings. +</p><dl> +<dt><i>key</i></dt> +<dd> +the key of the setting to be set +</dd><dt><i>value</i></dt> +<dd> +the value to be set +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="setSystem" ID="setSystem"></a> +<h2>setSystem</h2> +<b>setSystem</b>(<i>key, value, prefClass = Prefs</i>) +<p> + Module function to store the various system settings. +</p><dl> +<dt><i>key</i></dt> +<dd> +the key of the setting to be set +</dd><dt><i>value</i></dt> +<dd> +the value to be set +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="setTasks" ID="setTasks"></a> +<h2>setTasks</h2> +<b>setTasks</b>(<i>key, value, prefClass = Prefs</i>) +<p> + Module function to store the Tasks related settings. +</p><dl> +<dt><i>key</i></dt> +<dd> +the key of the setting to be set +</dd><dt><i>value</i></dt> +<dd> +the value to be set +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="setTemplates" ID="setTemplates"></a> +<h2>setTemplates</h2> +<b>setTemplates</b>(<i>key, value, prefClass = Prefs</i>) +<p> + Module function to store the Templates related settings. +</p><dl> +<dt><i>key</i></dt> +<dd> +the key of the setting to be set +</dd><dt><i>value</i></dt> +<dd> +the value to be set +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="setTerminal" ID="setTerminal"></a> +<h2>setTerminal</h2> +<b>setTerminal</b>(<i>key, value, prefClass = Prefs</i>) +<p> + Module function to store the various terminal settings. +</p><dl> +<dt><i>key</i></dt> +<dd> +the key of the setting to be set +</dd><dt><i>value</i></dt> +<dd> +the value to be set +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="setUI" ID="setUI"></a> +<h2>setUI</h2> +<b>setUI</b>(<i>key, value, prefClass = Prefs</i>) +<p> + Module function to store the various UI settings. +</p><dl> +<dt><i>key</i></dt> +<dd> +the key of the setting to be set +</dd><dt><i>value</i></dt> +<dd> +the value to be set +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="setUILanguage" ID="setUILanguage"></a> +<h2>setUILanguage</h2> +<b>setUILanguage</b>(<i>lang, prefClass = Prefs</i>) +<p> + Module function to store the language for the user interface. +</p><dl> +<dt><i>lang</i></dt> +<dd> +the language +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="setUILayout" ID="setUILayout"></a> +<h2>setUILayout</h2> +<b>setUILayout</b>(<i>layout, prefClass = Prefs</i>) +<p> + Module function to store the layout for the user interface. +</p><dl> +<dt><i>layout</i></dt> +<dd> +the layout type +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="setUser" ID="setUser"></a> +<h2>setUser</h2> +<b>setUser</b>(<i>key, value, prefClass = Prefs</i>) +<p> + Module function to store the various user settings. +</p><dl> +<dt><i>key</i></dt> +<dd> +the key of the setting to be set +</dd><dt><i>value</i></dt> +<dd> +the value to be set +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="setVCS" ID="setVCS"></a> +<h2>setVCS</h2> +<b>setVCS</b>(<i>key, value, prefClass = Prefs</i>) +<p> + Module function to store the VCS related settings. +</p><dl> +<dt><i>key</i></dt> +<dd> +the key of the setting to be set +</dd><dt><i>value</i></dt> +<dd> +the value to be set +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="setVarFilters" ID="setVarFilters"></a> +<h2>setVarFilters</h2> +<b>setVarFilters</b>(<i>filters, prefClass = Prefs</i>) +<p> + Module function to store the variables filter settings. +</p><dl> +<dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="setViewManager" ID="setViewManager"></a> +<h2>setViewManager</h2> +<b>setViewManager</b>(<i>vm, prefClass = Prefs</i>) +<p> + Module function to store the selected viewmanager type. +</p><dl> +<dt><i>vm</i></dt> +<dd> +the viewmanager type +</dd><dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="shouldResetLayout" ID="shouldResetLayout"></a> +<h2>shouldResetLayout</h2> +<b>shouldResetLayout</b>(<i>prefClass = Prefs</i>) +<p> + Module function to indicate a reset of the layout. +</p><dl> +<dt><i>prefClass</i></dt> +<dd> +preferences class used as the storage area +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +flag indicating a reset of the layout (boolean) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="syncPreferences" ID="syncPreferences"></a> +<h2>syncPreferences</h2> +<b>syncPreferences</b>(<i>prefClass = Prefs</i>) +<p> + Module function to sync the preferences to disk. +</p><p> + 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 +</dd> +</dl> +<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></dt> +<dd> +value to be converted +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +converted data +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<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></dt> +<dd> +value to be converted +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +converted data +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file