Documentation/Source/eric5.UI.UserInterface.html

<?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.UI.UserInterface</title>
<style>
body {
    background: #EDECE6;
    margin: 0em 1em 10em 1em;
    color: black;
}

h1 { color: white; background: #85774A; }
h2 { color: white; background: #85774A; }
h3 { color: white; background: #9D936E; }
h4 { color: white; background: #9D936E; }
    
a { color: #BA6D36; }

</style>
</head>
<body><a NAME="top" ID="top"></a>
<h1>eric5.UI.UserInterface</h1>
<p>
Module implementing the main user interface.
</p>
<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>
<table>
<tr>
<td><a href="#Redirector">Redirector</a></td>
<td>Helper class used to redirect stdout and stderr to the log window</td>
</tr><tr>
<td><a href="#UserInterface">UserInterface</a></td>
<td>Class implementing the main user interface.</td>
</tr>
</table>
<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>
<hr /><hr />
<a NAME="Redirector" ID="Redirector"></a>
<h2>Redirector</h2>
<p>
    Helper class used to redirect stdout and stderr to the log window
</p><h3>Signals</h3>
<dl>
<dt>appendStderr(str)</dt>
<dd>
emitted to write data to stderr logger
</dd><dt>appendStdout(str)</dt>
<dd>
emitted to write data to stdout logger
</dd>
</dl>
<h3>Derived from</h3>
QObject
<h3>Class Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Class Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>
<table>
<tr>
<td><a href="#Redirector.__init__">Redirector</a></td>
<td>Constructor</td>
</tr><tr>
<td><a href="#Redirector.__bufferedWrite">__bufferedWrite</a></td>
<td>Private method returning number of characters to write.</td>
</tr><tr>
<td><a href="#Redirector.__nWrite">__nWrite</a></td>
<td>Private method used to write data.</td>
</tr><tr>
<td><a href="#Redirector.flush">flush</a></td>
<td>Public method used to flush the buffered data.</td>
</tr><tr>
<td><a href="#Redirector.write">write</a></td>
<td>Public method used to write data.</td>
</tr>
</table>
<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<a NAME="Redirector.__init__" ID="Redirector.__init__"></a>
<h4>Redirector (Constructor)</h4>
<b>Redirector</b>(<i>stderr</i>)
<p>
        Constructor
</p><dl>
<dt><i>stderr</i></dt>
<dd>
flag indicating stderr is being redirected
</dd>
</dl><a NAME="Redirector.__bufferedWrite" ID="Redirector.__bufferedWrite"></a>
<h4>Redirector.__bufferedWrite</h4>
<b>__bufferedWrite</b>(<i></i>)
<p>
        Private method returning number of characters to write.
</p><dl>
<dt>Returns:</dt>
<dd>
number of characters buffered or length of buffered line (integer)
</dd>
</dl><a NAME="Redirector.__nWrite" ID="Redirector.__nWrite"></a>
<h4>Redirector.__nWrite</h4>
<b>__nWrite</b>(<i>n</i>)
<p>
        Private method used to write data.
</p><dl>
<dt><i>n</i></dt>
<dd>
max number of bytes to write
</dd>
</dl><a NAME="Redirector.flush" ID="Redirector.flush"></a>
<h4>Redirector.flush</h4>
<b>flush</b>(<i></i>)
<p>
        Public method used to flush the buffered data.
</p><a NAME="Redirector.write" ID="Redirector.write"></a>
<h4>Redirector.write</h4>
<b>write</b>(<i>s</i>)
<p>
        Public method used to write data.
</p><dl>
<dt><i>s</i></dt>
<dd>
data to be written (it must support the str-method)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr /><hr />
<a NAME="UserInterface" ID="UserInterface"></a>
<h2>UserInterface</h2>
<p>
    Class implementing the main user interface.
</p><h3>Signals</h3>
<dl>
<dt>appendStderr(str)</dt>
<dd>
emitted to write data to stderr logger
</dd><dt>appendStdout(str)</dt>
<dd>
emitted to write data to stdout logger
</dd><dt>masterPasswordChanged(str, str)</dt>
<dd>
emitted after the master
            password has been changed with the old and the new password
</dd><dt>preferencesChanged()</dt>
<dd>
emitted after the preferences were changed
</dd><dt>reloadAPIs()</dt>
<dd>
emitted to reload the api information
</dd><dt>showMenu(str, QMenu)</dt>
<dd>
emitted when a menu is about to be shown. The name
            of the menu and a reference to the menu are given.
</dd>
</dl>
<h3>Derived from</h3>
E5MainWindow
<h3>Class Attributes</h3>
<table>
<tr><td>BottomSide</td></tr><tr><td>LeftSide</td></tr><tr><td>RightSide</td></tr><tr><td>maxFilePathLen</td></tr><tr><td>maxMenuFilePathLen</td></tr><tr><td>maxSbFilePathLen</td></tr>
</table>
<h3>Class Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>
<table>
<tr>
<td><a href="#UserInterface.__init__">UserInterface</a></td>
<td>Constructor</td>
</tr><tr>
<td><a href="#UserInterface.__TBMenuTriggered">__TBMenuTriggered</a></td>
<td>Private method to handle the toggle of a toolbar.</td>
</tr><tr>
<td><a href="#UserInterface.__TRPreviewer">__TRPreviewer</a></td>
<td>Private slot to start the Translation Previewer executable.</td>
</tr><tr>
<td><a href="#UserInterface.__UIPreviewer">__UIPreviewer</a></td>
<td>Private slot to start the UI Previewer executable.</td>
</tr><tr>
<td><a href="#UserInterface.__activateBrowser">__activateBrowser</a></td>
<td>Private slot to handle the activation of the file browser.</td>
</tr><tr>
<td><a href="#UserInterface.__activateDebugViewer">__activateDebugViewer</a></td>
<td>Private slot to handle the activation of the debug viewer.</td>
</tr><tr>
<td><a href="#UserInterface.__activateLogViewer">__activateLogViewer</a></td>
<td>Private slot to handle the activation of the Log Viewer.</td>
</tr><tr>
<td><a href="#UserInterface.__activateMultiProjectBrowser">__activateMultiProjectBrowser</a></td>
<td>Private slot to handle the activation of the project browser.</td>
</tr><tr>
<td><a href="#UserInterface.__activateNumbersViewer">__activateNumbersViewer</a></td>
<td>Private slot to handle the activation of the Numbers Viewer.</td>
</tr><tr>
<td><a href="#UserInterface.__activateProjectBrowser">__activateProjectBrowser</a></td>
<td>Private slot to handle the activation of the project browser.</td>
</tr><tr>
<td><a href="#UserInterface.__activateShell">__activateShell</a></td>
<td>Private slot to handle the activation of the Shell window.</td>
</tr><tr>
<td><a href="#UserInterface.__activateSymbolsViewer">__activateSymbolsViewer</a></td>
<td>Private slot to handle the activation of the Symbols Viewer.</td>
</tr><tr>
<td><a href="#UserInterface.__activateTaskViewer">__activateTaskViewer</a></td>
<td>Private slot to handle the activation of the Task Viewer.</td>
</tr><tr>
<td><a href="#UserInterface.__activateTemplateViewer">__activateTemplateViewer</a></td>
<td>Private slot to handle the activation of the Template Viewer.</td>
</tr><tr>
<td><a href="#UserInterface.__activateTerminal">__activateTerminal</a></td>
<td>Private slot to handle the activation of the Terminal window.</td>
</tr><tr>
<td><a href="#UserInterface.__activateViewProfile">__activateViewProfile</a></td>
<td>Private slot to activate a view profile.</td>
</tr><tr>
<td><a href="#UserInterface.__activateViewmanager">__activateViewmanager</a></td>
<td>Private slot to handle the activation of the current editor.</td>
</tr><tr>
<td><a href="#UserInterface.__assistant">__assistant</a></td>
<td>Private slot to start the Qt-Assistant executable.</td>
</tr><tr>
<td><a href="#UserInterface.__assistant4">__assistant4</a></td>
<td>Private slot to start the Qt-Assistant 4 executable.</td>
</tr><tr>
<td><a href="#UserInterface.__checkActions">__checkActions</a></td>
<td>Private slot to check some actions for their enable/disable status.</td>
</tr><tr>
<td><a href="#UserInterface.__chmViewer">__chmViewer</a></td>
<td>Private slot to start the win help viewer to show *.chm files.</td>
</tr><tr>
<td><a href="#UserInterface.__compareFiles">__compareFiles</a></td>
<td>Private slot to handle the Compare Files dialog.</td>
</tr><tr>
<td><a href="#UserInterface.__compareFilesSbs">__compareFilesSbs</a></td>
<td>Private slot to handle the Compare Files dialog.</td>
</tr><tr>
<td><a href="#UserInterface.__configShortcuts">__configShortcuts</a></td>
<td>Private slot to configure the keyboard shortcuts.</td>
</tr><tr>
<td><a href="#UserInterface.__configToolBars">__configToolBars</a></td>
<td>Private slot to configure the various toolbars.</td>
</tr><tr>
<td><a href="#UserInterface.__configViewProfiles">__configViewProfiles</a></td>
<td>Private slot to configure the various view profiles.</td>
</tr><tr>
<td><a href="#UserInterface.__configureDockareaCornerUsage">__configureDockareaCornerUsage</a></td>
<td>Private method to configure the usage of the dockarea corners.</td>
</tr><tr>
<td><a href="#UserInterface.__createDockWindow">__createDockWindow</a></td>
<td>Private method to create a dock window with common properties.</td>
</tr><tr>
<td><a href="#UserInterface.__createLayout">__createLayout</a></td>
<td>Private method to create the layout of the various windows.</td>
</tr><tr>
<td><a href="#UserInterface.__createSidebarsLayout">__createSidebarsLayout</a></td>
<td>Private method to create the Sidebars layout.</td>
</tr><tr>
<td><a href="#UserInterface.__createToolboxesLayout">__createToolboxesLayout</a></td>
<td>Private method to create the Toolboxes layout.</td>
</tr><tr>
<td><a href="#UserInterface.__createUnitTestDialog">__createUnitTestDialog</a></td>
<td>Private slot to generate the unit test dialog on demand.</td>
</tr><tr>
<td><a href="#UserInterface.__customViewer">__customViewer</a></td>
<td>Private slot to start a custom viewer.</td>
</tr><tr>
<td><a href="#UserInterface.__debuggingDone">__debuggingDone</a></td>
<td>Private slot to handle the end of a debugging session.</td>
</tr><tr>
<td><a href="#UserInterface.__debuggingStarted">__debuggingStarted</a></td>
<td>Private slot to handle the start of a debugging session.</td>
</tr><tr>
<td><a href="#UserInterface.__deinstallPlugin">__deinstallPlugin</a></td>
<td>Private slot to show a dialog to uninstall a plugin.</td>
</tr><tr>
<td><a href="#UserInterface.__designer">__designer</a></td>
<td>Private slot to start the Qt-Designer executable.</td>
</tr><tr>
<td><a href="#UserInterface.__designer4">__designer4</a></td>
<td>Private slot to start the Qt-Designer 4 executable.</td>
</tr><tr>
<td><a href="#UserInterface.__editPixmap">__editPixmap</a></td>
<td>Private slot to show a pixmap in a dialog.</td>
</tr><tr>
<td><a href="#UserInterface.__editorOpened">__editorOpened</a></td>
<td>Private slot to handle the editorOpened signal.</td>
</tr><tr>
<td><a href="#UserInterface.__exportPreferences">__exportPreferences</a></td>
<td>Private slot to export the current preferences.</td>
</tr><tr>
<td><a href="#UserInterface.__exportShortcuts">__exportShortcuts</a></td>
<td>Private slot to export the keyboard shortcuts.</td>
</tr><tr>
<td><a href="#UserInterface.__getFloatingGeometry">__getFloatingGeometry</a></td>
<td>Private method to get the geometry of a floating windows.</td>
</tr><tr>
<td><a href="#UserInterface.__helpClosed">__helpClosed</a></td>
<td>Private slot to handle the helpClosed signal of the help window.</td>
</tr><tr>
<td><a href="#UserInterface.__helpViewer">__helpViewer</a></td>
<td>Private slot to start an empty help viewer.</td>
</tr><tr>
<td><a href="#UserInterface.__importPreferences">__importPreferences</a></td>
<td>Private slot to import preferences.</td>
</tr><tr>
<td><a href="#UserInterface.__importShortcuts">__importShortcuts</a></td>
<td>Private slot to import the keyboard shortcuts.</td>
</tr><tr>
<td><a href="#UserInterface.__initActions">__initActions</a></td>
<td>Private method to define the user interface actions.</td>
</tr><tr>
<td><a href="#UserInterface.__initDebugToolbarsLayout">__initDebugToolbarsLayout</a></td>
<td>Private slot to initialize the toolbars layout for the debug profile.</td>
</tr><tr>
<td><a href="#UserInterface.__initEricDocAction">__initEricDocAction</a></td>
<td>Private slot to initialize the action to show the eric5 documentation.</td>
</tr><tr>
<td><a href="#UserInterface.__initExternalToolsActions">__initExternalToolsActions</a></td>
<td>Private slot to create actions for the configured external tools.</td>
</tr><tr>
<td><a href="#UserInterface.__initMenus">__initMenus</a></td>
<td>Private slot to create the menus.</td>
</tr><tr>
<td><a href="#UserInterface.__initPySideDocAction">__initPySideDocAction</a></td>
<td>Private slot to initialize the action to show the PySide documentation.</td>
</tr><tr>
<td><a href="#UserInterface.__initPythonDocActions">__initPythonDocActions</a></td>
<td>Private slot to initialize the actions to show the Python documentation.</td>
</tr><tr>
<td><a href="#UserInterface.__initQtDocActions">__initQtDocActions</a></td>
<td>Private slot to initialize the action to show the Qt documentation.</td>
</tr><tr>
<td><a href="#UserInterface.__initStatusbar">__initStatusbar</a></td>
<td>Private slot to set up the status bar.</td>
</tr><tr>
<td><a href="#UserInterface.__initToolbars">__initToolbars</a></td>
<td>Private slot to create the toolbars.</td>
</tr><tr>
<td><a href="#UserInterface.__installPlugins">__installPlugins</a></td>
<td>Private slot to show a dialog to install a new plugin.</td>
</tr><tr>
<td><a href="#UserInterface.__lastEditorClosed">__lastEditorClosed</a></td>
<td>Private slot to handle the lastEditorClosed signal.</td>
</tr><tr>
<td><a href="#UserInterface.__linguist">__linguist</a></td>
<td>Private slot to start the Qt-Linguist executable.</td>
</tr><tr>
<td><a href="#UserInterface.__linguist4">__linguist4</a></td>
<td>Private slot to start the Qt-Linguist 4 executable.</td>
</tr><tr>
<td><a href="#UserInterface.__masterPasswordChanged">__masterPasswordChanged</a></td>
<td>Private slot to handle the change of the master password.</td>
</tr><tr>
<td><a href="#UserInterface.__newProject">__newProject</a></td>
<td>Private slot to handle the NewProject signal.</td>
</tr><tr>
<td><a href="#UserInterface.__newWindow">__newWindow</a></td>
<td>Private slot to start a new instance of eric5.</td>
</tr><tr>
<td><a href="#UserInterface.__openMiniEditor">__openMiniEditor</a></td>
<td>Private slot to show a mini editor window.</td>
</tr><tr>
<td><a href="#UserInterface.__openOnStartup">__openOnStartup</a></td>
<td>Private method to open the last file, project or multiproject.</td>
</tr><tr>
<td><a href="#UserInterface.__pluginsConfigure">__pluginsConfigure</a></td>
<td>Private slot to show the plugin manager configuration page.</td>
</tr><tr>
<td><a href="#UserInterface.__preferencesChanged">__preferencesChanged</a></td>
<td>Private slot to handle a change of the preferences.</td>
</tr><tr>
<td><a href="#UserInterface.__processToolStderr">__processToolStderr</a></td>
<td>Private slot to handle the readyReadStderr signal of a tool process.</td>
</tr><tr>
<td><a href="#UserInterface.__processToolStdout">__processToolStdout</a></td>
<td>Private slot to handle the readyReadStdout signal of a tool process.</td>
</tr><tr>
<td><a href="#UserInterface.__programChange">__programChange</a></td>
<td>Private slot to handle the programChange signal.</td>
</tr><tr>
<td><a href="#UserInterface.__projectClosed">__projectClosed</a></td>
<td>Private slot to handle the projectClosed signal.</td>
</tr><tr>
<td><a href="#UserInterface.__projectOpened">__projectOpened</a></td>
<td>Private slot to handle the projectOpened signal.</td>
</tr><tr>
<td><a href="#UserInterface.__quit">__quit</a></td>
<td>Private method to quit the application.</td>
</tr><tr>
<td><a href="#UserInterface.__readSession">__readSession</a></td>
<td>Private slot to read in the session file (.e4s)</td>
</tr><tr>
<td><a href="#UserInterface.__readTasks">__readTasks</a></td>
<td>Private slot to read in the tasks file (.e4t)</td>
</tr><tr>
<td><a href="#UserInterface.__reloadAPIs">__reloadAPIs</a></td>
<td>Private slot to reload the api information.</td>
</tr><tr>
<td><a href="#UserInterface.__reportBug">__reportBug</a></td>
<td>Private slot to handle the Report Bug dialog.</td>
</tr><tr>
<td><a href="#UserInterface.__requestFeature">__requestFeature</a></td>
<td>Private slot to handle the Feature Request dialog.</td>
</tr><tr>
<td><a href="#UserInterface.__restart">__restart</a></td>
<td>Private method to restart the application.</td>
</tr><tr>
<td><a href="#UserInterface.__saveCurrentViewProfile">__saveCurrentViewProfile</a></td>
<td>Private slot to save the window geometries of the active profile.</td>
</tr><tr>
<td><a href="#UserInterface.__setEditProfile">__setEditProfile</a></td>
<td>Private slot to activate the edit view profile.</td>
</tr><tr>
<td><a href="#UserInterface.__setWindowCaption">__setWindowCaption</a></td>
<td>Private method to set the caption of the Main Window.</td>
</tr><tr>
<td><a href="#UserInterface.__setupDockWindow">__setupDockWindow</a></td>
<td>Private method to configure the dock window created with __createDockWindow().</td>
</tr><tr>
<td><a href="#UserInterface.__showAvailableVersionInfos">__showAvailableVersionInfos</a></td>
<td>Private method to show the versions available for download.</td>
</tr><tr>
<td><a href="#UserInterface.__showEricDoc">__showEricDoc</a></td>
<td>Private slot to show the Eric documentation.</td>
</tr><tr>
<td><a href="#UserInterface.__showExternalTools">__showExternalTools</a></td>
<td>Private slot to display a dialog show a list of external tools used by eric5.</td>
</tr><tr>
<td><a href="#UserInterface.__showExtrasMenu">__showExtrasMenu</a></td>
<td>Private slot to display the Extras menu.</td>
</tr><tr>
<td><a href="#UserInterface.__showFileMenu">__showFileMenu</a></td>
<td>Private slot to display the File menu.</td>
</tr><tr>
<td><a href="#UserInterface.__showHelpMenu">__showHelpMenu</a></td>
<td>Private slot to display the Help menu.</td>
</tr><tr>
<td><a href="#UserInterface.__showNext">__showNext</a></td>
<td>Private slot used to show the next tab or file.</td>
</tr><tr>
<td><a href="#UserInterface.__showPixmap">__showPixmap</a></td>
<td>Private slot to show a pixmap in a dialog.</td>
</tr><tr>
<td><a href="#UserInterface.__showPluginInfo">__showPluginInfo</a></td>
<td>Private slot to show the plugin info dialog.</td>
</tr><tr>
<td><a href="#UserInterface.__showPluginsAvailable">__showPluginsAvailable</a></td>
<td>Private slot to show the plugins available for download.</td>
</tr><tr>
<td><a href="#UserInterface.__showPrevious">__showPrevious</a></td>
<td>Private slot used to show the previous tab or file.</td>
</tr><tr>
<td><a href="#UserInterface.__showPyQt4Doc">__showPyQt4Doc</a></td>
<td>Private slot to show the PyQt4 documentation.</td>
</tr><tr>
<td><a href="#UserInterface.__showPySideDoc">__showPySideDoc</a></td>
<td>Private slot to show the PySide documentation.</td>
</tr><tr>
<td><a href="#UserInterface.__showPython2Doc">__showPython2Doc</a></td>
<td>Private slot to show the Python 2 documentation.</td>
</tr><tr>
<td><a href="#UserInterface.__showPythonDoc">__showPythonDoc</a></td>
<td>Private slot to show the Python 3 documentation.</td>
</tr><tr>
<td><a href="#UserInterface.__showQt4Doc">__showQt4Doc</a></td>
<td>Private slot to show the Qt4 documentation.</td>
</tr><tr>
<td><a href="#UserInterface.__showSubWindowMenu">__showSubWindowMenu</a></td>
<td>Private slot to display the Window menu of the Window menu.</td>
</tr><tr>
<td><a href="#UserInterface.__showSvg">__showSvg</a></td>
<td>Private slot to show a SVG file in a dialog.</td>
</tr><tr>
<td><a href="#UserInterface.__showSystemEmailClient">__showSystemEmailClient</a></td>
<td>Private slot to show the system email dialog.</td>
</tr><tr>
<td><a href="#UserInterface.__showToolGroupsMenu">__showToolGroupsMenu</a></td>
<td>Private slot to display the Tool Groups menu.</td>
</tr><tr>
<td><a href="#UserInterface.__showToolbarsMenu">__showToolbarsMenu</a></td>
<td>Private slot to display the Toolbars menu.</td>
</tr><tr>
<td><a href="#UserInterface.__showToolsMenu">__showToolsMenu</a></td>
<td>Private slot to display the Tools menu.</td>
</tr><tr>
<td><a href="#UserInterface.__showVersions">__showVersions</a></td>
<td>Private slot to handle the Versions dialog.</td>
</tr><tr>
<td><a href="#UserInterface.__showWindowMenu">__showWindowMenu</a></td>
<td>Private slot to display the Window menu.</td>
</tr><tr>
<td><a href="#UserInterface.__showWizardsMenu">__showWizardsMenu</a></td>
<td>Private slot to display the Wizards menu.</td>
</tr><tr>
<td><a href="#UserInterface.__shutdown">__shutdown</a></td>
<td>Private method to perform all necessary steps to close down the IDE.</td>
</tr><tr>
<td><a href="#UserInterface.__snapshot">__snapshot</a></td>
<td>Private slot to start the snapshot tool.</td>
</tr><tr>
<td><a href="#UserInterface.__sqlBrowser">__sqlBrowser</a></td>
<td>Private slot to start the SQL browser tool.</td>
</tr><tr>
<td><a href="#UserInterface.__sslErrors">__sslErrors</a></td>
<td>Private slot to handle SSL errors.</td>
</tr><tr>
<td><a href="#UserInterface.__startToolProcess">__startToolProcess</a></td>
<td>Private slot to start an external tool process.</td>
</tr><tr>
<td><a href="#UserInterface.__startWebBrowser">__startWebBrowser</a></td>
<td>Private slot to start the eric5 web browser.</td>
</tr><tr>
<td><a href="#UserInterface.__switchTab">__switchTab</a></td>
<td>Private slot used to switch between the current and the previous current tab.</td>
</tr><tr>
<td><a href="#UserInterface.__toggleBottomSidebar">__toggleBottomSidebar</a></td>
<td>Private slot to handle the toggle of the bottom sidebar window.</td>
</tr><tr>
<td><a href="#UserInterface.__toggleHorizontalToolbox">__toggleHorizontalToolbox</a></td>
<td>Private slot to handle the toggle of the Horizontal Toolbox window.</td>
</tr><tr>
<td><a href="#UserInterface.__toggleLeftSidebar">__toggleLeftSidebar</a></td>
<td>Private slot to handle the toggle of the left sidebar window.</td>
</tr><tr>
<td><a href="#UserInterface.__toggleLeftToolbox">__toggleLeftToolbox</a></td>
<td>Private slot to handle the toggle of the Left Toolbox window.</td>
</tr><tr>
<td><a href="#UserInterface.__toggleRightSidebar">__toggleRightSidebar</a></td>
<td>Private slot to handle the toggle of the right sidebar window.</td>
</tr><tr>
<td><a href="#UserInterface.__toggleRightToolbox">__toggleRightToolbox</a></td>
<td>Private slot to handle the toggle of the Right Toolbox window.</td>
</tr><tr>
<td><a href="#UserInterface.__toggleWindow">__toggleWindow</a></td>
<td>Private method to toggle a workspace editor window.</td>
</tr><tr>
<td><a href="#UserInterface.__toolActionTriggered">__toolActionTriggered</a></td>
<td>Private slot called by external tools toolbar actions.</td>
</tr><tr>
<td><a href="#UserInterface.__toolExecute">__toolExecute</a></td>
<td>Private slot to execute a particular tool.</td>
</tr><tr>
<td><a href="#UserInterface.__toolFinished">__toolFinished</a></td>
<td>Private slot to handle the finished signal of a tool process.</td>
</tr><tr>
<td><a href="#UserInterface.__toolGroupSelected">__toolGroupSelected</a></td>
<td>Private slot to set the current tool group.</td>
</tr><tr>
<td><a href="#UserInterface.__toolGroupsConfiguration">__toolGroupsConfiguration</a></td>
<td>Private slot to handle the tool groups configuration menu entry.</td>
</tr><tr>
<td><a href="#UserInterface.__toolsConfiguration">__toolsConfiguration</a></td>
<td>Private slot to handle the tools configuration menu entry.</td>
</tr><tr>
<td><a href="#UserInterface.__unittest">__unittest</a></td>
<td>Private slot for displaying the unittest dialog.</td>
</tr><tr>
<td><a href="#UserInterface.__unittestProject">__unittestProject</a></td>
<td>Private slot for displaying the unittest dialog and run the current project.</td>
</tr><tr>
<td><a href="#UserInterface.__unittestRerunFailed">__unittestRerunFailed</a></td>
<td>Private slot to display the unittest dialog and rerun all failed tests of the last run.</td>
</tr><tr>
<td><a href="#UserInterface.__unittestRestart">__unittestRestart</a></td>
<td>Private slot to display the unittest dialog and rerun the last unit test.</td>
</tr><tr>
<td><a href="#UserInterface.__unittestScript">__unittestScript</a></td>
<td>Private slot for displaying the unittest dialog and run the current script.</td>
</tr><tr>
<td><a href="#UserInterface.__unittestStopped">__unittestStopped</a></td>
<td>Private slot to handle the end of a unit test run.</td>
</tr><tr>
<td><a href="#UserInterface.__updateExternalToolsActions">__updateExternalToolsActions</a></td>
<td>Private method to update the external tools actions for the current tool group.</td>
</tr><tr>
<td><a href="#UserInterface.__updateVersionsUrls">__updateVersionsUrls</a></td>
<td>Private method to update the URLs from which to retrieve the versions file.</td>
</tr><tr>
<td><a href="#UserInterface.__versionCheckResult">__versionCheckResult</a></td>
<td>Private method to show the result of the version check action.</td>
</tr><tr>
<td><a href="#UserInterface.__versionsDownloadCanceled">__versionsDownloadCanceled</a></td>
<td>Private method called to cancel the version check.</td>
</tr><tr>
<td><a href="#UserInterface.__versionsDownloadDone">__versionsDownloadDone</a></td>
<td>Private method called, after the versions file has been downloaded from the internet.</td>
</tr><tr>
<td><a href="#UserInterface.__webBrowser">__webBrowser</a></td>
<td>Private slot to start the eric5 web browser.</td>
</tr><tr>
<td><a href="#UserInterface.__whatsThis">__whatsThis</a></td>
<td>Private slot called in to enter Whats This mode.</td>
</tr><tr>
<td><a href="#UserInterface.__writeSession">__writeSession</a></td>
<td>Private slot to write the session data to an XML file (.e4s).</td>
</tr><tr>
<td><a href="#UserInterface.__writeTasks">__writeTasks</a></td>
<td>Private slot to write the tasks data to an XML file (.e4t).</td>
</tr><tr>
<td><a href="#UserInterface.activateCooperationViewer">activateCooperationViewer</a></td>
<td>Public slot to handle the activation of the cooperation window.</td>
</tr><tr>
<td><a href="#UserInterface.addE5Actions">addE5Actions</a></td>
<td>Public method to add actions to the list of actions.</td>
</tr><tr>
<td><a href="#UserInterface.addSideWidget">addSideWidget</a></td>
<td>Public method to add a widget to the sides.</td>
</tr><tr>
<td><a href="#UserInterface.appendToStderr">appendToStderr</a></td>
<td>Public slot to append text to the stderr log viewer tab.</td>
</tr><tr>
<td><a href="#UserInterface.appendToStdout">appendToStdout</a></td>
<td>Public slot to append text to the stdout log viewer tab.</td>
</tr><tr>
<td><a href="#UserInterface.checkConfigurationStatus">checkConfigurationStatus</a></td>
<td>Public method to check, if eric5 has been configured.</td>
</tr><tr>
<td><a href="#UserInterface.checkForErrorLog">checkForErrorLog</a></td>
<td>Public method to check for the presence of an error log and ask the user, what to do with it.</td>
</tr><tr>
<td><a href="#UserInterface.checkProjectsWorkspace">checkProjectsWorkspace</a></td>
<td>Public method to check, if a projects workspace has been configured.</td>
</tr><tr>
<td><a href="#UserInterface.closeEvent">closeEvent</a></td>
<td>Private event handler for the close event.</td>
</tr><tr>
<td><a href="#UserInterface.dragEnterEvent">dragEnterEvent</a></td>
<td>Protected method to handle the drag enter event.</td>
</tr><tr>
<td><a href="#UserInterface.dragLeaveEvent">dragLeaveEvent</a></td>
<td>Protected method to handle the drag leave event.</td>
</tr><tr>
<td><a href="#UserInterface.dragMoveEvent">dragMoveEvent</a></td>
<td>Protected method to handle the drag move event.</td>
</tr><tr>
<td><a href="#UserInterface.dropEvent">dropEvent</a></td>
<td>Protected method to handle the drop event.</td>
</tr><tr>
<td><a href="#UserInterface.getActions">getActions</a></td>
<td>Public method to get a list of all actions.</td>
</tr><tr>
<td><a href="#UserInterface.getHelpViewer">getHelpViewer</a></td>
<td>Public method to get a reference to the help window instance.</td>
</tr><tr>
<td><a href="#UserInterface.getLocale">getLocale</a></td>
<td>Public method to get the locale of the IDE.</td>
</tr><tr>
<td><a href="#UserInterface.getMenu">getMenu</a></td>
<td>Public method to get a reference to a specific menu.</td>
</tr><tr>
<td><a href="#UserInterface.getMenuAction">getMenuAction</a></td>
<td>Public method to get a reference to an action of a menu.</td>
</tr><tr>
<td><a href="#UserInterface.getMenuBarAction">getMenuBarAction</a></td>
<td>Public method to get a reference to an action of the main menu.</td>
</tr><tr>
<td><a href="#UserInterface.getToolBarIconSize">getToolBarIconSize</a></td>
<td>Public method to get the toolbar icon size.</td>
</tr><tr>
<td><a href="#UserInterface.getToolbar">getToolbar</a></td>
<td>Public method to get a reference to a specific toolbar.</td>
</tr><tr>
<td><a href="#UserInterface.getViewProfile">getViewProfile</a></td>
<td>Public method to get the current view profile.</td>
</tr><tr>
<td><a href="#UserInterface.launchHelpViewer">launchHelpViewer</a></td>
<td>Public slot to start the help viewer.</td>
</tr><tr>
<td><a href="#UserInterface.performVersionCheck">performVersionCheck</a></td>
<td>Public method to check the internet for an eric5 update.</td>
</tr><tr>
<td><a href="#UserInterface.processArgs">processArgs</a></td>
<td>Public method to process the command line args passed to the UI.</td>
</tr><tr>
<td><a href="#UserInterface.registerToolbar">registerToolbar</a></td>
<td>Public method to register a toolbar.</td>
</tr><tr>
<td><a href="#UserInterface.removeE5Actions">removeE5Actions</a></td>
<td>Public method to remove actions from the list of actions.</td>
</tr><tr>
<td><a href="#UserInterface.removeSideWidget">removeSideWidget</a></td>
<td>Public method to remove a widget added using addSideWidget().</td>
</tr><tr>
<td><a href="#UserInterface.reregisterToolbar">reregisterToolbar</a></td>
<td>Public method to change the visible text for the named toolbar.</td>
</tr><tr>
<td><a href="#UserInterface.setDebugProfile">setDebugProfile</a></td>
<td>Public slot to activate the debug view profile.</td>
</tr><tr>
<td><a href="#UserInterface.showAvailableVersionsInfo">showAvailableVersionsInfo</a></td>
<td>Public method to show the eric5 versions available for download.</td>
</tr><tr>
<td><a href="#UserInterface.showEmailDialog">showEmailDialog</a></td>
<td>Public slot to show the email dialog in a given mode.</td>
</tr><tr>
<td><a href="#UserInterface.showEvent">showEvent</a></td>
<td>Protected method to handle the show event.</td>
</tr><tr>
<td><a href="#UserInterface.showFindFileByNameDialog">showFindFileByNameDialog</a></td>
<td>Public slot to show the Find File by Name dialog.</td>
</tr><tr>
<td><a href="#UserInterface.showFindFilesDialog">showFindFilesDialog</a></td>
<td>Public slot to show the Find In Files dialog.</td>
</tr><tr>
<td><a href="#UserInterface.showLogTab">showLogTab</a></td>
<td>Public method to show a particular Log-Viewer tab.</td>
</tr><tr>
<td><a href="#UserInterface.showPreferences">showPreferences</a></td>
<td>Public slot to set the preferences.</td>
</tr><tr>
<td><a href="#UserInterface.showReplaceFilesDialog">showReplaceFilesDialog</a></td>
<td>Public slot to show the Find & Replace In Files dialog.</td>
</tr><tr>
<td><a href="#UserInterface.unregisterToolbar">unregisterToolbar</a></td>
<td>Public method to unregister a toolbar.</td>
</tr><tr>
<td><a href="#UserInterface.versionIsNewer">versionIsNewer</a></td>
<td>Public method to check, if the eric5 version is good compared to the required version.</td>
</tr>
</table>
<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<a NAME="UserInterface.__init__" ID="UserInterface.__init__"></a>
<h4>UserInterface (Constructor)</h4>
<b>UserInterface</b>(<i>app, locale, splash, plugin, noOpenAtStartup, restartArguments</i>)
<p>
        Constructor
</p><dl>
<dt><i>app</i></dt>
<dd>
reference to the application object (E5Application)
</dd><dt><i>locale</i></dt>
<dd>
locale to be used by the UI (string)
</dd><dt><i>splash</i></dt>
<dd>
reference to the splashscreen (UI.SplashScreen.SplashScreen)
</dd><dt><i>plugin</i></dt>
<dd>
filename of a plugin to be loaded (used for plugin development)
</dd><dt><i>noOpenAtStartup</i></dt>
<dd>
flag indicating that the open at startup option
            should not be executed (boolean)
</dd><dt><i>restartArguments</i></dt>
<dd>
list of command line parameters to be used for a
            restart (list of strings)
</dd>
</dl><a NAME="UserInterface.__TBMenuTriggered" ID="UserInterface.__TBMenuTriggered"></a>
<h4>UserInterface.__TBMenuTriggered</h4>
<b>__TBMenuTriggered</b>(<i>act</i>)
<p>
        Private method to handle the toggle of a toolbar.
</p><dl>
<dt><i>act</i></dt>
<dd>
reference to the action that was triggered (QAction)
</dd>
</dl><a NAME="UserInterface.__TRPreviewer" ID="UserInterface.__TRPreviewer"></a>
<h4>UserInterface.__TRPreviewer</h4>
<b>__TRPreviewer</b>(<i>fileNames=None, ignore=False</i>)
<p>
        Private slot to start the Translation Previewer executable.
</p><dl>
<dt><i>fileNames</i></dt>
<dd>
filenames of forms and/or translations to be previewed
            (list of strings)
</dd><dt><i>ignore</i></dt>
<dd>
flag indicating non existing files should be ignored (boolean)
</dd>
</dl><a NAME="UserInterface.__UIPreviewer" ID="UserInterface.__UIPreviewer"></a>
<h4>UserInterface.__UIPreviewer</h4>
<b>__UIPreviewer</b>(<i>fn=None</i>)
<p>
        Private slot to start the UI Previewer executable.
</p><dl>
<dt><i>fn</i></dt>
<dd>
filename of the form to be previewed (string)
</dd>
</dl><a NAME="UserInterface.__activateBrowser" ID="UserInterface.__activateBrowser"></a>
<h4>UserInterface.__activateBrowser</h4>
<b>__activateBrowser</b>(<i></i>)
<p>
        Private slot to handle the activation of the file browser.
</p><a NAME="UserInterface.__activateDebugViewer" ID="UserInterface.__activateDebugViewer"></a>
<h4>UserInterface.__activateDebugViewer</h4>
<b>__activateDebugViewer</b>(<i></i>)
<p>
        Private slot to handle the activation of the debug viewer.
</p><a NAME="UserInterface.__activateLogViewer" ID="UserInterface.__activateLogViewer"></a>
<h4>UserInterface.__activateLogViewer</h4>
<b>__activateLogViewer</b>(<i></i>)
<p>
        Private slot to handle the activation of the Log Viewer.
</p><a NAME="UserInterface.__activateMultiProjectBrowser" ID="UserInterface.__activateMultiProjectBrowser"></a>
<h4>UserInterface.__activateMultiProjectBrowser</h4>
<b>__activateMultiProjectBrowser</b>(<i></i>)
<p>
        Private slot to handle the activation of the project browser.
</p><a NAME="UserInterface.__activateNumbersViewer" ID="UserInterface.__activateNumbersViewer"></a>
<h4>UserInterface.__activateNumbersViewer</h4>
<b>__activateNumbersViewer</b>(<i></i>)
<p>
        Private slot to handle the activation of the Numbers Viewer.
</p><a NAME="UserInterface.__activateProjectBrowser" ID="UserInterface.__activateProjectBrowser"></a>
<h4>UserInterface.__activateProjectBrowser</h4>
<b>__activateProjectBrowser</b>(<i></i>)
<p>
        Private slot to handle the activation of the project browser.
</p><a NAME="UserInterface.__activateShell" ID="UserInterface.__activateShell"></a>
<h4>UserInterface.__activateShell</h4>
<b>__activateShell</b>(<i></i>)
<p>
        Private slot to handle the activation of the Shell window.
</p><a NAME="UserInterface.__activateSymbolsViewer" ID="UserInterface.__activateSymbolsViewer"></a>
<h4>UserInterface.__activateSymbolsViewer</h4>
<b>__activateSymbolsViewer</b>(<i></i>)
<p>
        Private slot to handle the activation of the Symbols Viewer.
</p><a NAME="UserInterface.__activateTaskViewer" ID="UserInterface.__activateTaskViewer"></a>
<h4>UserInterface.__activateTaskViewer</h4>
<b>__activateTaskViewer</b>(<i></i>)
<p>
        Private slot to handle the activation of the Task Viewer.
</p><a NAME="UserInterface.__activateTemplateViewer" ID="UserInterface.__activateTemplateViewer"></a>
<h4>UserInterface.__activateTemplateViewer</h4>
<b>__activateTemplateViewer</b>(<i></i>)
<p>
        Private slot to handle the activation of the Template Viewer.
</p><a NAME="UserInterface.__activateTerminal" ID="UserInterface.__activateTerminal"></a>
<h4>UserInterface.__activateTerminal</h4>
<b>__activateTerminal</b>(<i></i>)
<p>
        Private slot to handle the activation of the Terminal window.
</p><a NAME="UserInterface.__activateViewProfile" ID="UserInterface.__activateViewProfile"></a>
<h4>UserInterface.__activateViewProfile</h4>
<b>__activateViewProfile</b>(<i>name, save=True</i>)
<p>
        Private slot to activate a view profile.
</p><dl>
<dt><i>name</i></dt>
<dd>
name of the profile to be activated (string)
</dd><dt><i>save</i></dt>
<dd>
flag indicating that the current profile should
            be saved (boolean)
</dd>
</dl><a NAME="UserInterface.__activateViewmanager" ID="UserInterface.__activateViewmanager"></a>
<h4>UserInterface.__activateViewmanager</h4>
<b>__activateViewmanager</b>(<i></i>)
<p>
        Private slot to handle the activation of the current editor.
</p><a NAME="UserInterface.__assistant" ID="UserInterface.__assistant"></a>
<h4>UserInterface.__assistant</h4>
<b>__assistant</b>(<i>home=None, version=0</i>)
<p>
        Private slot to start the Qt-Assistant executable.
</p><dl>
<dt><i>home</i></dt>
<dd>
full pathname of a file to display (string)
</dd><dt><i>version</i></dt>
<dd>
indication for the requested version (Qt 4) (integer)
</dd>
</dl><a NAME="UserInterface.__assistant4" ID="UserInterface.__assistant4"></a>
<h4>UserInterface.__assistant4</h4>
<b>__assistant4</b>(<i></i>)
<p>
        Private slot to start the Qt-Assistant 4 executable.
</p><a NAME="UserInterface.__checkActions" ID="UserInterface.__checkActions"></a>
<h4>UserInterface.__checkActions</h4>
<b>__checkActions</b>(<i>editor</i>)
<p>
        Private slot to check some actions for their enable/disable status.
</p><dl>
<dt><i>editor</i></dt>
<dd>
editor window
</dd>
</dl><a NAME="UserInterface.__chmViewer" ID="UserInterface.__chmViewer"></a>
<h4>UserInterface.__chmViewer</h4>
<b>__chmViewer</b>(<i>home=None</i>)
<p>
        Private slot to start the win help viewer to show *.chm files.
</p><dl>
<dt><i>home</i></dt>
<dd>
full pathname of a file to display (string)
</dd>
</dl><a NAME="UserInterface.__compareFiles" ID="UserInterface.__compareFiles"></a>
<h4>UserInterface.__compareFiles</h4>
<b>__compareFiles</b>(<i></i>)
<p>
        Private slot to handle the Compare Files dialog.
</p><a NAME="UserInterface.__compareFilesSbs" ID="UserInterface.__compareFilesSbs"></a>
<h4>UserInterface.__compareFilesSbs</h4>
<b>__compareFilesSbs</b>(<i></i>)
<p>
        Private slot to handle the Compare Files dialog.
</p><a NAME="UserInterface.__configShortcuts" ID="UserInterface.__configShortcuts"></a>
<h4>UserInterface.__configShortcuts</h4>
<b>__configShortcuts</b>(<i></i>)
<p>
        Private slot to configure the keyboard shortcuts.
</p><a NAME="UserInterface.__configToolBars" ID="UserInterface.__configToolBars"></a>
<h4>UserInterface.__configToolBars</h4>
<b>__configToolBars</b>(<i></i>)
<p>
        Private slot to configure the various toolbars.
</p><a NAME="UserInterface.__configViewProfiles" ID="UserInterface.__configViewProfiles"></a>
<h4>UserInterface.__configViewProfiles</h4>
<b>__configViewProfiles</b>(<i></i>)
<p>
        Private slot to configure the various view profiles.
</p><a NAME="UserInterface.__configureDockareaCornerUsage" ID="UserInterface.__configureDockareaCornerUsage"></a>
<h4>UserInterface.__configureDockareaCornerUsage</h4>
<b>__configureDockareaCornerUsage</b>(<i></i>)
<p>
        Private method to configure the usage of the dockarea corners.
</p><a NAME="UserInterface.__createDockWindow" ID="UserInterface.__createDockWindow"></a>
<h4>UserInterface.__createDockWindow</h4>
<b>__createDockWindow</b>(<i>name</i>)
<p>
        Private method to create a dock window with common properties.
</p><dl>
<dt><i>name</i></dt>
<dd>
object name of the new dock window (string)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
the generated dock window (QDockWindow)
</dd>
</dl><a NAME="UserInterface.__createLayout" ID="UserInterface.__createLayout"></a>
<h4>UserInterface.__createLayout</h4>
<b>__createLayout</b>(<i>debugServer</i>)
<p>
        Private method to create the layout of the various windows.
</p><dl>
<dt><i>debugServer</i></dt>
<dd>
reference to the debug server object
</dd>
</dl><a NAME="UserInterface.__createSidebarsLayout" ID="UserInterface.__createSidebarsLayout"></a>
<h4>UserInterface.__createSidebarsLayout</h4>
<b>__createSidebarsLayout</b>(<i>debugServer</i>)
<p>
        Private method to create the Sidebars layout.
</p><dl>
<dt><i>debugServer</i></dt>
<dd>
reference to the debug server object
</dd>
</dl><a NAME="UserInterface.__createToolboxesLayout" ID="UserInterface.__createToolboxesLayout"></a>
<h4>UserInterface.__createToolboxesLayout</h4>
<b>__createToolboxesLayout</b>(<i>debugServer</i>)
<p>
        Private method to create the Toolboxes layout.
</p><dl>
<dt><i>debugServer</i></dt>
<dd>
reference to the debug server object
</dd>
</dl><a NAME="UserInterface.__createUnitTestDialog" ID="UserInterface.__createUnitTestDialog"></a>
<h4>UserInterface.__createUnitTestDialog</h4>
<b>__createUnitTestDialog</b>(<i></i>)
<p>
        Private slot to generate the unit test dialog on demand.
</p><a NAME="UserInterface.__customViewer" ID="UserInterface.__customViewer"></a>
<h4>UserInterface.__customViewer</h4>
<b>__customViewer</b>(<i>home=None</i>)
<p>
        Private slot to start a custom viewer.
</p><dl>
<dt><i>home</i></dt>
<dd>
full pathname of a file to display (string)
</dd>
</dl><a NAME="UserInterface.__debuggingDone" ID="UserInterface.__debuggingDone"></a>
<h4>UserInterface.__debuggingDone</h4>
<b>__debuggingDone</b>(<i></i>)
<p>
        Private slot to handle the end of a debugging session.
</p><a NAME="UserInterface.__debuggingStarted" ID="UserInterface.__debuggingStarted"></a>
<h4>UserInterface.__debuggingStarted</h4>
<b>__debuggingStarted</b>(<i></i>)
<p>
        Private slot to handle the start of a debugging session.
</p><a NAME="UserInterface.__deinstallPlugin" ID="UserInterface.__deinstallPlugin"></a>
<h4>UserInterface.__deinstallPlugin</h4>
<b>__deinstallPlugin</b>(<i></i>)
<p>
        Private slot to show a dialog to uninstall a plugin.
</p><a NAME="UserInterface.__designer" ID="UserInterface.__designer"></a>
<h4>UserInterface.__designer</h4>
<b>__designer</b>(<i>fn=None, version=0</i>)
<p>
        Private slot to start the Qt-Designer executable.
</p><dl>
<dt><i>fn</i></dt>
<dd>
filename of the form to be opened
</dd><dt><i>version</i></dt>
<dd>
indication for the requested version (Qt 4) (integer)
</dd>
</dl><a NAME="UserInterface.__designer4" ID="UserInterface.__designer4"></a>
<h4>UserInterface.__designer4</h4>
<b>__designer4</b>(<i></i>)
<p>
        Private slot to start the Qt-Designer 4 executable.
</p><a NAME="UserInterface.__editPixmap" ID="UserInterface.__editPixmap"></a>
<h4>UserInterface.__editPixmap</h4>
<b>__editPixmap</b>(<i>fn=""</i>)
<p>
        Private slot to show a pixmap in a dialog.
</p><dl>
<dt><i>fn</i></dt>
<dd>
filename of the file to show (string)
</dd>
</dl><a NAME="UserInterface.__editorOpened" ID="UserInterface.__editorOpened"></a>
<h4>UserInterface.__editorOpened</h4>
<b>__editorOpened</b>(<i>fn</i>)
<p>
        Private slot to handle the editorOpened signal.
</p><dl>
<dt><i>fn</i></dt>
<dd>
filename of the opened editor (string)
</dd>
</dl><a NAME="UserInterface.__exportPreferences" ID="UserInterface.__exportPreferences"></a>
<h4>UserInterface.__exportPreferences</h4>
<b>__exportPreferences</b>(<i></i>)
<p>
        Private slot to export the current preferences.
</p><a NAME="UserInterface.__exportShortcuts" ID="UserInterface.__exportShortcuts"></a>
<h4>UserInterface.__exportShortcuts</h4>
<b>__exportShortcuts</b>(<i></i>)
<p>
        Private slot to export the keyboard shortcuts.
</p><a NAME="UserInterface.__getFloatingGeometry" ID="UserInterface.__getFloatingGeometry"></a>
<h4>UserInterface.__getFloatingGeometry</h4>
<b>__getFloatingGeometry</b>(<i>w</i>)
<p>
        Private method to get the geometry of a floating windows.
</p><dl>
<dt><i>w</i></dt>
<dd>
reference to the widget to be saved (QWidget)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
list giving the widget's geometry and it's visibility
</dd>
</dl><a NAME="UserInterface.__helpClosed" ID="UserInterface.__helpClosed"></a>
<h4>UserInterface.__helpClosed</h4>
<b>__helpClosed</b>(<i></i>)
<p>
        Private slot to handle the helpClosed signal of the help window.
</p><a NAME="UserInterface.__helpViewer" ID="UserInterface.__helpViewer"></a>
<h4>UserInterface.__helpViewer</h4>
<b>__helpViewer</b>(<i></i>)
<p>
        Private slot to start an empty help viewer.
</p><a NAME="UserInterface.__importPreferences" ID="UserInterface.__importPreferences"></a>
<h4>UserInterface.__importPreferences</h4>
<b>__importPreferences</b>(<i></i>)
<p>
        Private slot to import preferences.
</p><a NAME="UserInterface.__importShortcuts" ID="UserInterface.__importShortcuts"></a>
<h4>UserInterface.__importShortcuts</h4>
<b>__importShortcuts</b>(<i></i>)
<p>
        Private slot to import the keyboard shortcuts.
</p><a NAME="UserInterface.__initActions" ID="UserInterface.__initActions"></a>
<h4>UserInterface.__initActions</h4>
<b>__initActions</b>(<i></i>)
<p>
        Private method to define the user interface actions.
</p><a NAME="UserInterface.__initDebugToolbarsLayout" ID="UserInterface.__initDebugToolbarsLayout"></a>
<h4>UserInterface.__initDebugToolbarsLayout</h4>
<b>__initDebugToolbarsLayout</b>(<i></i>)
<p>
        Private slot to initialize the toolbars layout for the debug profile.
</p><a NAME="UserInterface.__initEricDocAction" ID="UserInterface.__initEricDocAction"></a>
<h4>UserInterface.__initEricDocAction</h4>
<b>__initEricDocAction</b>(<i></i>)
<p>
        Private slot to initialize the action to show the eric5 documentation.
</p><a NAME="UserInterface.__initExternalToolsActions" ID="UserInterface.__initExternalToolsActions"></a>
<h4>UserInterface.__initExternalToolsActions</h4>
<b>__initExternalToolsActions</b>(<i></i>)
<p>
        Private slot to create actions for the configured external tools.
</p><a NAME="UserInterface.__initMenus" ID="UserInterface.__initMenus"></a>
<h4>UserInterface.__initMenus</h4>
<b>__initMenus</b>(<i></i>)
<p>
        Private slot to create the menus.
</p><a NAME="UserInterface.__initPySideDocAction" ID="UserInterface.__initPySideDocAction"></a>
<h4>UserInterface.__initPySideDocAction</h4>
<b>__initPySideDocAction</b>(<i></i>)
<p>
        Private slot to initialize the action to show the PySide documentation.
</p><a NAME="UserInterface.__initPythonDocActions" ID="UserInterface.__initPythonDocActions"></a>
<h4>UserInterface.__initPythonDocActions</h4>
<b>__initPythonDocActions</b>(<i></i>)
<p>
        Private slot to initialize the actions to show the Python documentation.
</p><a NAME="UserInterface.__initQtDocActions" ID="UserInterface.__initQtDocActions"></a>
<h4>UserInterface.__initQtDocActions</h4>
<b>__initQtDocActions</b>(<i></i>)
<p>
        Private slot to initialize the action to show the Qt documentation.
</p><a NAME="UserInterface.__initStatusbar" ID="UserInterface.__initStatusbar"></a>
<h4>UserInterface.__initStatusbar</h4>
<b>__initStatusbar</b>(<i></i>)
<p>
        Private slot to set up the status bar.
</p><a NAME="UserInterface.__initToolbars" ID="UserInterface.__initToolbars"></a>
<h4>UserInterface.__initToolbars</h4>
<b>__initToolbars</b>(<i></i>)
<p>
        Private slot to create the toolbars.
</p><a NAME="UserInterface.__installPlugins" ID="UserInterface.__installPlugins"></a>
<h4>UserInterface.__installPlugins</h4>
<b>__installPlugins</b>(<i>pluginFileNames=[]</i>)
<p>
        Private slot to show a dialog to install a new plugin.
</p><dl>
<dt><i>pluginFileNames</i></dt>
<dd>
list of plugin files suggested for
            installation list of strings
</dd>
</dl><a NAME="UserInterface.__lastEditorClosed" ID="UserInterface.__lastEditorClosed"></a>
<h4>UserInterface.__lastEditorClosed</h4>
<b>__lastEditorClosed</b>(<i></i>)
<p>
        Private slot to handle the lastEditorClosed signal.
</p><a NAME="UserInterface.__linguist" ID="UserInterface.__linguist"></a>
<h4>UserInterface.__linguist</h4>
<b>__linguist</b>(<i>fn=None, version=0</i>)
<p>
        Private slot to start the Qt-Linguist executable.
</p><dl>
<dt><i>fn</i></dt>
<dd>
filename of the translation file to be opened
</dd><dt><i>version</i></dt>
<dd>
indication for the requested version (Qt 4) (integer)
</dd>
</dl><a NAME="UserInterface.__linguist4" ID="UserInterface.__linguist4"></a>
<h4>UserInterface.__linguist4</h4>
<b>__linguist4</b>(<i>fn=None</i>)
<p>
        Private slot to start the Qt-Linguist 4 executable.
</p><dl>
<dt><i>fn</i></dt>
<dd>
filename of the translation file to be opened
</dd>
</dl><a NAME="UserInterface.__masterPasswordChanged" ID="UserInterface.__masterPasswordChanged"></a>
<h4>UserInterface.__masterPasswordChanged</h4>
<b>__masterPasswordChanged</b>(<i>oldPassword, newPassword</i>)
<p>
        Private slot to handle the change of the master password.
</p><dl>
<dt><i>oldPassword</i></dt>
<dd>
current master password (string)
</dd><dt><i>newPassword</i></dt>
<dd>
new master password (string)
</dd>
</dl><a NAME="UserInterface.__newProject" ID="UserInterface.__newProject"></a>
<h4>UserInterface.__newProject</h4>
<b>__newProject</b>(<i></i>)
<p>
        Private slot to handle the NewProject signal.
</p><a NAME="UserInterface.__newWindow" ID="UserInterface.__newWindow"></a>
<h4>UserInterface.__newWindow</h4>
<b>__newWindow</b>(<i></i>)
<p>
        Private slot to start a new instance of eric5.
</p><a NAME="UserInterface.__openMiniEditor" ID="UserInterface.__openMiniEditor"></a>
<h4>UserInterface.__openMiniEditor</h4>
<b>__openMiniEditor</b>(<i></i>)
<p>
        Private slot to show a mini editor window.
</p><a NAME="UserInterface.__openOnStartup" ID="UserInterface.__openOnStartup"></a>
<h4>UserInterface.__openOnStartup</h4>
<b>__openOnStartup</b>(<i>startupType=None</i>)
<p>
        Private method to open the last file, project or multiproject.
</p><dl>
<dt><i>startupType</i></dt>
<dd>
type of startup requested (string, one of
            "Nothing", "File", "Project", "MultiProject" or "Session")
</dd>
</dl><a NAME="UserInterface.__pluginsConfigure" ID="UserInterface.__pluginsConfigure"></a>
<h4>UserInterface.__pluginsConfigure</h4>
<b>__pluginsConfigure</b>(<i></i>)
<p>
        Private slot to show the plugin manager configuration page.
</p><a NAME="UserInterface.__preferencesChanged" ID="UserInterface.__preferencesChanged"></a>
<h4>UserInterface.__preferencesChanged</h4>
<b>__preferencesChanged</b>(<i></i>)
<p>
        Private slot to handle a change of the preferences.
</p><a NAME="UserInterface.__processToolStderr" ID="UserInterface.__processToolStderr"></a>
<h4>UserInterface.__processToolStderr</h4>
<b>__processToolStderr</b>(<i></i>)
<p>
        Private slot to handle the readyReadStderr signal of a tool process.
</p><a NAME="UserInterface.__processToolStdout" ID="UserInterface.__processToolStdout"></a>
<h4>UserInterface.__processToolStdout</h4>
<b>__processToolStdout</b>(<i></i>)
<p>
        Private slot to handle the readyReadStdout signal of a tool process.
</p><a NAME="UserInterface.__programChange" ID="UserInterface.__programChange"></a>
<h4>UserInterface.__programChange</h4>
<b>__programChange</b>(<i>fn</i>)
<p>
        Private slot to handle the programChange signal.
</p><p>
        This primarily is here to set the currentProg variable.
</p><dl>
<dt><i>fn</i></dt>
<dd>
filename to be set as current prog (string)
</dd>
</dl><a NAME="UserInterface.__projectClosed" ID="UserInterface.__projectClosed"></a>
<h4>UserInterface.__projectClosed</h4>
<b>__projectClosed</b>(<i></i>)
<p>
        Private slot to handle the projectClosed signal.
</p><a NAME="UserInterface.__projectOpened" ID="UserInterface.__projectOpened"></a>
<h4>UserInterface.__projectOpened</h4>
<b>__projectOpened</b>(<i></i>)
<p>
        Private slot to handle the projectOpened signal.
</p><a NAME="UserInterface.__quit" ID="UserInterface.__quit"></a>
<h4>UserInterface.__quit</h4>
<b>__quit</b>(<i></i>)
<p>
        Private method to quit the application.
</p><a NAME="UserInterface.__readSession" ID="UserInterface.__readSession"></a>
<h4>UserInterface.__readSession</h4>
<b>__readSession</b>(<i></i>)
<p>
        Private slot to read in the session file (.e4s)
</p><a NAME="UserInterface.__readTasks" ID="UserInterface.__readTasks"></a>
<h4>UserInterface.__readTasks</h4>
<b>__readTasks</b>(<i></i>)
<p>
        Private slot to read in the tasks file (.e4t)
</p><a NAME="UserInterface.__reloadAPIs" ID="UserInterface.__reloadAPIs"></a>
<h4>UserInterface.__reloadAPIs</h4>
<b>__reloadAPIs</b>(<i></i>)
<p>
        Private slot to reload the api information.
</p><a NAME="UserInterface.__reportBug" ID="UserInterface.__reportBug"></a>
<h4>UserInterface.__reportBug</h4>
<b>__reportBug</b>(<i></i>)
<p>
        Private slot to handle the Report Bug dialog.
</p><a NAME="UserInterface.__requestFeature" ID="UserInterface.__requestFeature"></a>
<h4>UserInterface.__requestFeature</h4>
<b>__requestFeature</b>(<i></i>)
<p>
        Private slot to handle the Feature Request dialog.
</p><a NAME="UserInterface.__restart" ID="UserInterface.__restart"></a>
<h4>UserInterface.__restart</h4>
<b>__restart</b>(<i></i>)
<p>
        Private method to restart the application.
</p><a NAME="UserInterface.__saveCurrentViewProfile" ID="UserInterface.__saveCurrentViewProfile"></a>
<h4>UserInterface.__saveCurrentViewProfile</h4>
<b>__saveCurrentViewProfile</b>(<i>save</i>)
<p>
        Private slot to save the window geometries of the active profile.
</p><dl>
<dt><i>save</i></dt>
<dd>
flag indicating that the current profile should
            be saved (boolean)
</dd>
</dl><a NAME="UserInterface.__setEditProfile" ID="UserInterface.__setEditProfile"></a>
<h4>UserInterface.__setEditProfile</h4>
<b>__setEditProfile</b>(<i>save=True</i>)
<p>
        Private slot to activate the edit view profile.
</p><dl>
<dt><i>save</i></dt>
<dd>
flag indicating that the current profile should
            be saved (boolean)
</dd>
</dl><a NAME="UserInterface.__setWindowCaption" ID="UserInterface.__setWindowCaption"></a>
<h4>UserInterface.__setWindowCaption</h4>
<b>__setWindowCaption</b>(<i>editor=None, project=None</i>)
<p>
        Private method to set the caption of the Main Window.
</p><dl>
<dt><i>editor</i></dt>
<dd>
filename to be displayed (string)
</dd><dt><i>project</i></dt>
<dd>
project name to be displayed (string)
</dd>
</dl><a NAME="UserInterface.__setupDockWindow" ID="UserInterface.__setupDockWindow"></a>
<h4>UserInterface.__setupDockWindow</h4>
<b>__setupDockWindow</b>(<i>dock, where, widget, caption</i>)
<p>
        Private method to configure the dock window created with __createDockWindow().
</p><dl>
<dt><i>dock</i></dt>
<dd>
the dock window (QDockWindow)
</dd><dt><i>where</i></dt>
<dd>
dock area to be docked to (Qt.DockWidgetArea)
</dd><dt><i>widget</i></dt>
<dd>
widget to be shown in the dock window (QWidget)
</dd><dt><i>caption</i></dt>
<dd>
caption of the dock window (string)
</dd>
</dl><a NAME="UserInterface.__showAvailableVersionInfos" ID="UserInterface.__showAvailableVersionInfos"></a>
<h4>UserInterface.__showAvailableVersionInfos</h4>
<b>__showAvailableVersionInfos</b>(<i>versions</i>)
<p>
        Private method to show the versions available for download.
</p><dl>
<dt><i>versions</i></dt>
<dd>
contents of the downloaded versions file (list of strings)
</dd>
</dl><a NAME="UserInterface.__showEricDoc" ID="UserInterface.__showEricDoc"></a>
<h4>UserInterface.__showEricDoc</h4>
<b>__showEricDoc</b>(<i></i>)
<p>
        Private slot to show the Eric documentation.
</p><a NAME="UserInterface.__showExternalTools" ID="UserInterface.__showExternalTools"></a>
<h4>UserInterface.__showExternalTools</h4>
<b>__showExternalTools</b>(<i></i>)
<p>
        Private slot to display a dialog show a list of external tools used by eric5.
</p><a NAME="UserInterface.__showExtrasMenu" ID="UserInterface.__showExtrasMenu"></a>
<h4>UserInterface.__showExtrasMenu</h4>
<b>__showExtrasMenu</b>(<i></i>)
<p>
        Private slot to display the Extras menu.
</p><a NAME="UserInterface.__showFileMenu" ID="UserInterface.__showFileMenu"></a>
<h4>UserInterface.__showFileMenu</h4>
<b>__showFileMenu</b>(<i></i>)
<p>
        Private slot to display the File menu.
</p><a NAME="UserInterface.__showHelpMenu" ID="UserInterface.__showHelpMenu"></a>
<h4>UserInterface.__showHelpMenu</h4>
<b>__showHelpMenu</b>(<i></i>)
<p>
        Private slot to display the Help menu.
</p><a NAME="UserInterface.__showNext" ID="UserInterface.__showNext"></a>
<h4>UserInterface.__showNext</h4>
<b>__showNext</b>(<i></i>)
<p>
        Private slot used to show the next tab or file.
</p><a NAME="UserInterface.__showPixmap" ID="UserInterface.__showPixmap"></a>
<h4>UserInterface.__showPixmap</h4>
<b>__showPixmap</b>(<i>fn</i>)
<p>
        Private slot to show a pixmap in a dialog.
</p><dl>
<dt><i>fn</i></dt>
<dd>
filename of the file to show (string)
</dd>
</dl><a NAME="UserInterface.__showPluginInfo" ID="UserInterface.__showPluginInfo"></a>
<h4>UserInterface.__showPluginInfo</h4>
<b>__showPluginInfo</b>(<i></i>)
<p>
        Private slot to show the plugin info dialog.
</p><a NAME="UserInterface.__showPluginsAvailable" ID="UserInterface.__showPluginsAvailable"></a>
<h4>UserInterface.__showPluginsAvailable</h4>
<b>__showPluginsAvailable</b>(<i></i>)
<p>
        Private slot to show the plugins available for download.
</p><a NAME="UserInterface.__showPrevious" ID="UserInterface.__showPrevious"></a>
<h4>UserInterface.__showPrevious</h4>
<b>__showPrevious</b>(<i></i>)
<p>
        Private slot used to show the previous tab or file.
</p><a NAME="UserInterface.__showPyQt4Doc" ID="UserInterface.__showPyQt4Doc"></a>
<h4>UserInterface.__showPyQt4Doc</h4>
<b>__showPyQt4Doc</b>(<i></i>)
<p>
        Private slot to show the PyQt4 documentation.
</p><a NAME="UserInterface.__showPySideDoc" ID="UserInterface.__showPySideDoc"></a>
<h4>UserInterface.__showPySideDoc</h4>
<b>__showPySideDoc</b>(<i></i>)
<p>
        Private slot to show the PySide documentation.
</p><a NAME="UserInterface.__showPython2Doc" ID="UserInterface.__showPython2Doc"></a>
<h4>UserInterface.__showPython2Doc</h4>
<b>__showPython2Doc</b>(<i></i>)
<p>
        Private slot to show the Python 2 documentation.
</p><a NAME="UserInterface.__showPythonDoc" ID="UserInterface.__showPythonDoc"></a>
<h4>UserInterface.__showPythonDoc</h4>
<b>__showPythonDoc</b>(<i></i>)
<p>
        Private slot to show the Python 3 documentation.
</p><a NAME="UserInterface.__showQt4Doc" ID="UserInterface.__showQt4Doc"></a>
<h4>UserInterface.__showQt4Doc</h4>
<b>__showQt4Doc</b>(<i></i>)
<p>
        Private slot to show the Qt4 documentation.
</p><a NAME="UserInterface.__showSubWindowMenu" ID="UserInterface.__showSubWindowMenu"></a>
<h4>UserInterface.__showSubWindowMenu</h4>
<b>__showSubWindowMenu</b>(<i></i>)
<p>
        Private slot to display the Window menu of the Window menu.
</p><a NAME="UserInterface.__showSvg" ID="UserInterface.__showSvg"></a>
<h4>UserInterface.__showSvg</h4>
<b>__showSvg</b>(<i>fn</i>)
<p>
        Private slot to show a SVG file in a dialog.
</p><dl>
<dt><i>fn</i></dt>
<dd>
filename of the file to show (string)
</dd>
</dl><a NAME="UserInterface.__showSystemEmailClient" ID="UserInterface.__showSystemEmailClient"></a>
<h4>UserInterface.__showSystemEmailClient</h4>
<b>__showSystemEmailClient</b>(<i>mode, attachFile=None, deleteAttachFile=False</i>)
<p>
        Private slot to show the system email dialog.
</p><dl>
<dt><i>mode</i></dt>
<dd>
mode of the email dialog (string, "bug" or "feature")
</dd><dt><i>attachFile</i></dt>
<dd>
name of a file to put into the body of the
            email (string)
</dd><dt><i>deleteAttachFile</i></dt>
<dd>
flag indicating to delete the file after
            it has been read (boolean)
</dd>
</dl><a NAME="UserInterface.__showToolGroupsMenu" ID="UserInterface.__showToolGroupsMenu"></a>
<h4>UserInterface.__showToolGroupsMenu</h4>
<b>__showToolGroupsMenu</b>(<i></i>)
<p>
        Private slot to display the Tool Groups menu.
</p><a NAME="UserInterface.__showToolbarsMenu" ID="UserInterface.__showToolbarsMenu"></a>
<h4>UserInterface.__showToolbarsMenu</h4>
<b>__showToolbarsMenu</b>(<i></i>)
<p>
        Private slot to display the Toolbars menu.
</p><a NAME="UserInterface.__showToolsMenu" ID="UserInterface.__showToolsMenu"></a>
<h4>UserInterface.__showToolsMenu</h4>
<b>__showToolsMenu</b>(<i></i>)
<p>
        Private slot to display the Tools menu.
</p><a NAME="UserInterface.__showVersions" ID="UserInterface.__showVersions"></a>
<h4>UserInterface.__showVersions</h4>
<b>__showVersions</b>(<i></i>)
<p>
        Private slot to handle the Versions dialog.
</p><a NAME="UserInterface.__showWindowMenu" ID="UserInterface.__showWindowMenu"></a>
<h4>UserInterface.__showWindowMenu</h4>
<b>__showWindowMenu</b>(<i></i>)
<p>
        Private slot to display the Window menu.
</p><a NAME="UserInterface.__showWizardsMenu" ID="UserInterface.__showWizardsMenu"></a>
<h4>UserInterface.__showWizardsMenu</h4>
<b>__showWizardsMenu</b>(<i></i>)
<p>
        Private slot to display the Wizards menu.
</p><a NAME="UserInterface.__shutdown" ID="UserInterface.__shutdown"></a>
<h4>UserInterface.__shutdown</h4>
<b>__shutdown</b>(<i></i>)
<p>
        Private method to perform all necessary steps to close down the IDE.
</p><dl>
<dt>Returns:</dt>
<dd>
flag indicating success
</dd>
</dl><a NAME="UserInterface.__snapshot" ID="UserInterface.__snapshot"></a>
<h4>UserInterface.__snapshot</h4>
<b>__snapshot</b>(<i></i>)
<p>
        Private slot to start the snapshot tool.
</p><a NAME="UserInterface.__sqlBrowser" ID="UserInterface.__sqlBrowser"></a>
<h4>UserInterface.__sqlBrowser</h4>
<b>__sqlBrowser</b>(<i></i>)
<p>
        Private slot to start the SQL browser tool.
</p><a NAME="UserInterface.__sslErrors" ID="UserInterface.__sslErrors"></a>
<h4>UserInterface.__sslErrors</h4>
<b>__sslErrors</b>(<i>reply, errors</i>)
<p>
        Private slot to handle SSL errors.
</p><dl>
<dt><i>reply</i></dt>
<dd>
reference to the reply object (QNetworkReply)
</dd><dt><i>errors</i></dt>
<dd>
list of SSL errors (list of QSslError)
</dd>
</dl><a NAME="UserInterface.__startToolProcess" ID="UserInterface.__startToolProcess"></a>
<h4>UserInterface.__startToolProcess</h4>
<b>__startToolProcess</b>(<i>tool</i>)
<p>
        Private slot to start an external tool process.
</p><dl>
<dt><i>tool</i></dt>
<dd>
list of tool entries
</dd>
</dl><a NAME="UserInterface.__startWebBrowser" ID="UserInterface.__startWebBrowser"></a>
<h4>UserInterface.__startWebBrowser</h4>
<b>__startWebBrowser</b>(<i></i>)
<p>
        Private slot to start the eric5 web browser.
</p><a NAME="UserInterface.__switchTab" ID="UserInterface.__switchTab"></a>
<h4>UserInterface.__switchTab</h4>
<b>__switchTab</b>(<i></i>)
<p>
        Private slot used to switch between the current and the previous current tab.
</p><a NAME="UserInterface.__toggleBottomSidebar" ID="UserInterface.__toggleBottomSidebar"></a>
<h4>UserInterface.__toggleBottomSidebar</h4>
<b>__toggleBottomSidebar</b>(<i></i>)
<p>
        Private slot to handle the toggle of the bottom sidebar window.
</p><a NAME="UserInterface.__toggleHorizontalToolbox" ID="UserInterface.__toggleHorizontalToolbox"></a>
<h4>UserInterface.__toggleHorizontalToolbox</h4>
<b>__toggleHorizontalToolbox</b>(<i></i>)
<p>
        Private slot to handle the toggle of the Horizontal Toolbox window.
</p><a NAME="UserInterface.__toggleLeftSidebar" ID="UserInterface.__toggleLeftSidebar"></a>
<h4>UserInterface.__toggleLeftSidebar</h4>
<b>__toggleLeftSidebar</b>(<i></i>)
<p>
        Private slot to handle the toggle of the left sidebar window.
</p><a NAME="UserInterface.__toggleLeftToolbox" ID="UserInterface.__toggleLeftToolbox"></a>
<h4>UserInterface.__toggleLeftToolbox</h4>
<b>__toggleLeftToolbox</b>(<i></i>)
<p>
        Private slot to handle the toggle of the Left Toolbox window.
</p><a NAME="UserInterface.__toggleRightSidebar" ID="UserInterface.__toggleRightSidebar"></a>
<h4>UserInterface.__toggleRightSidebar</h4>
<b>__toggleRightSidebar</b>(<i></i>)
<p>
        Private slot to handle the toggle of the right sidebar window.
</p><a NAME="UserInterface.__toggleRightToolbox" ID="UserInterface.__toggleRightToolbox"></a>
<h4>UserInterface.__toggleRightToolbox</h4>
<b>__toggleRightToolbox</b>(<i></i>)
<p>
        Private slot to handle the toggle of the Right Toolbox window.
</p><a NAME="UserInterface.__toggleWindow" ID="UserInterface.__toggleWindow"></a>
<h4>UserInterface.__toggleWindow</h4>
<b>__toggleWindow</b>(<i>w</i>)
<p>
        Private method to toggle a workspace editor window.
</p><dl>
<dt><i>w</i></dt>
<dd>
reference to the workspace editor window
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
flag indicating, if the window was shown (boolean)
</dd>
</dl><a NAME="UserInterface.__toolActionTriggered" ID="UserInterface.__toolActionTriggered"></a>
<h4>UserInterface.__toolActionTriggered</h4>
<b>__toolActionTriggered</b>(<i></i>)
<p>
        Private slot called by external tools toolbar actions.
</p><a NAME="UserInterface.__toolExecute" ID="UserInterface.__toolExecute"></a>
<h4>UserInterface.__toolExecute</h4>
<b>__toolExecute</b>(<i>act</i>)
<p>
        Private slot to execute a particular tool.
</p><dl>
<dt><i>act</i></dt>
<dd>
reference to the action that was triggered (QAction)
</dd>
</dl><a NAME="UserInterface.__toolFinished" ID="UserInterface.__toolFinished"></a>
<h4>UserInterface.__toolFinished</h4>
<b>__toolFinished</b>(<i>exitCode, exitStatus</i>)
<p>
        Private slot to handle the finished signal of a tool process.
</p><dl>
<dt><i>exitCode</i></dt>
<dd>
exit code of the process (integer)
</dd><dt><i>exitStatus</i></dt>
<dd>
exit status of the process (QProcess.ExitStatus)
</dd>
</dl><a NAME="UserInterface.__toolGroupSelected" ID="UserInterface.__toolGroupSelected"></a>
<h4>UserInterface.__toolGroupSelected</h4>
<b>__toolGroupSelected</b>(<i>act</i>)
<p>
        Private slot to set the current tool group.
</p><dl>
<dt><i>act</i></dt>
<dd>
reference to the action that was triggered (QAction)
</dd>
</dl><a NAME="UserInterface.__toolGroupsConfiguration" ID="UserInterface.__toolGroupsConfiguration"></a>
<h4>UserInterface.__toolGroupsConfiguration</h4>
<b>__toolGroupsConfiguration</b>(<i></i>)
<p>
        Private slot to handle the tool groups configuration menu entry.
</p><a NAME="UserInterface.__toolsConfiguration" ID="UserInterface.__toolsConfiguration"></a>
<h4>UserInterface.__toolsConfiguration</h4>
<b>__toolsConfiguration</b>(<i></i>)
<p>
        Private slot to handle the tools configuration menu entry.
</p><a NAME="UserInterface.__unittest" ID="UserInterface.__unittest"></a>
<h4>UserInterface.__unittest</h4>
<b>__unittest</b>(<i></i>)
<p>
        Private slot for displaying the unittest dialog.
</p><a NAME="UserInterface.__unittestProject" ID="UserInterface.__unittestProject"></a>
<h4>UserInterface.__unittestProject</h4>
<b>__unittestProject</b>(<i></i>)
<p>
        Private slot for displaying the unittest dialog and run the current project.
</p><a NAME="UserInterface.__unittestRerunFailed" ID="UserInterface.__unittestRerunFailed"></a>
<h4>UserInterface.__unittestRerunFailed</h4>
<b>__unittestRerunFailed</b>(<i></i>)
<p>
        Private slot to display the unittest dialog and rerun all failed tests
        of the last run.
</p><a NAME="UserInterface.__unittestRestart" ID="UserInterface.__unittestRestart"></a>
<h4>UserInterface.__unittestRestart</h4>
<b>__unittestRestart</b>(<i></i>)
<p>
        Private slot to display the unittest dialog and rerun the last unit test.
</p><a NAME="UserInterface.__unittestScript" ID="UserInterface.__unittestScript"></a>
<h4>UserInterface.__unittestScript</h4>
<b>__unittestScript</b>(<i>prog=None</i>)
<p>
        Private slot for displaying the unittest dialog and run the current script.
</p><dl>
<dt><i>prog</i></dt>
<dd>
the python program to be opened
</dd>
</dl><a NAME="UserInterface.__unittestStopped" ID="UserInterface.__unittestStopped"></a>
<h4>UserInterface.__unittestStopped</h4>
<b>__unittestStopped</b>(<i></i>)
<p>
        Private slot to handle the end of a unit test run.
</p><a NAME="UserInterface.__updateExternalToolsActions" ID="UserInterface.__updateExternalToolsActions"></a>
<h4>UserInterface.__updateExternalToolsActions</h4>
<b>__updateExternalToolsActions</b>(<i></i>)
<p>
        Private method to update the external tools actions for the current tool group.
</p><a NAME="UserInterface.__updateVersionsUrls" ID="UserInterface.__updateVersionsUrls"></a>
<h4>UserInterface.__updateVersionsUrls</h4>
<b>__updateVersionsUrls</b>(<i>versions</i>)
<p>
        Private method to update the URLs from which to retrieve the versions file.
</p><dl>
<dt><i>versions</i></dt>
<dd>
contents of the downloaded versions file (list of strings)
</dd>
</dl><a NAME="UserInterface.__versionCheckResult" ID="UserInterface.__versionCheckResult"></a>
<h4>UserInterface.__versionCheckResult</h4>
<b>__versionCheckResult</b>(<i>versions</i>)
<p>
        Private method to show the result of the version check action.
</p><dl>
<dt><i>versions</i></dt>
<dd>
contents of the downloaded versions file (list of strings)
</dd>
</dl><a NAME="UserInterface.__versionsDownloadCanceled" ID="UserInterface.__versionsDownloadCanceled"></a>
<h4>UserInterface.__versionsDownloadCanceled</h4>
<b>__versionsDownloadCanceled</b>(<i></i>)
<p>
        Private method called to cancel the version check.
</p><a NAME="UserInterface.__versionsDownloadDone" ID="UserInterface.__versionsDownloadDone"></a>
<h4>UserInterface.__versionsDownloadDone</h4>
<b>__versionsDownloadDone</b>(<i></i>)
<p>
        Private method called, after the versions file has been downloaded
        from the internet.
</p><a NAME="UserInterface.__webBrowser" ID="UserInterface.__webBrowser"></a>
<h4>UserInterface.__webBrowser</h4>
<b>__webBrowser</b>(<i>home=""</i>)
<p>
        Private slot to start the eric5 web browser.
</p><dl>
<dt><i>home</i></dt>
<dd>
full pathname of a file to display (string)
</dd>
</dl><a NAME="UserInterface.__whatsThis" ID="UserInterface.__whatsThis"></a>
<h4>UserInterface.__whatsThis</h4>
<b>__whatsThis</b>(<i></i>)
<p>
        Private slot called in to enter Whats This mode.
</p><a NAME="UserInterface.__writeSession" ID="UserInterface.__writeSession"></a>
<h4>UserInterface.__writeSession</h4>
<b>__writeSession</b>(<i></i>)
<p>
        Private slot to write the session data to an XML file (.e4s).
</p><a NAME="UserInterface.__writeTasks" ID="UserInterface.__writeTasks"></a>
<h4>UserInterface.__writeTasks</h4>
<b>__writeTasks</b>(<i></i>)
<p>
        Private slot to write the tasks data to an XML file (.e4t).
</p><a NAME="UserInterface.activateCooperationViewer" ID="UserInterface.activateCooperationViewer"></a>
<h4>UserInterface.activateCooperationViewer</h4>
<b>activateCooperationViewer</b>(<i></i>)
<p>
        Public slot to handle the activation of the cooperation window.
</p><a NAME="UserInterface.addE5Actions" ID="UserInterface.addE5Actions"></a>
<h4>UserInterface.addE5Actions</h4>
<b>addE5Actions</b>(<i>actions, type</i>)
<p>
        Public method to add actions to the list of actions.
</p><dl>
<dt><i>type</i></dt>
<dd>
string denoting the action set to get.
            It must be one of "ui" or "wizards".
</dd><dt><i>actions</i></dt>
<dd>
list of actions to be added (list of E5Action)
</dd>
</dl><a NAME="UserInterface.addSideWidget" ID="UserInterface.addSideWidget"></a>
<h4>UserInterface.addSideWidget</h4>
<b>addSideWidget</b>(<i>side, widget, icon, label</i>)
<p>
        Public method to add a widget to the sides.
</p><dl>
<dt><i>side</i></dt>
<dd>
side to add the widget to (UserInterface.LeftSide,
            UserInterface.BottomSide)
</dd><dt><i>widget</i></dt>
<dd>
reference to the widget to add (QWidget)
</dd><dt><i>icon</i></dt>
<dd>
icon to be used (QIcon)
</dd><dt><i>label</i></dt>
<dd>
label text to be shown (string)
</dd>
</dl><a NAME="UserInterface.appendToStderr" ID="UserInterface.appendToStderr"></a>
<h4>UserInterface.appendToStderr</h4>
<b>appendToStderr</b>(<i>s</i>)
<p>
        Public slot to append text to the stderr log viewer tab.
</p><dl>
<dt><i>s</i></dt>
<dd>
output to be appended (string)
</dd>
</dl><a NAME="UserInterface.appendToStdout" ID="UserInterface.appendToStdout"></a>
<h4>UserInterface.appendToStdout</h4>
<b>appendToStdout</b>(<i>s</i>)
<p>
        Public slot to append text to the stdout log viewer tab.
</p><dl>
<dt><i>s</i></dt>
<dd>
output to be appended (string)
</dd>
</dl><a NAME="UserInterface.checkConfigurationStatus" ID="UserInterface.checkConfigurationStatus"></a>
<h4>UserInterface.checkConfigurationStatus</h4>
<b>checkConfigurationStatus</b>(<i></i>)
<p>
        Public method to check, if eric5 has been configured. If it is not,
        the configuration dialog is shown.
</p><a NAME="UserInterface.checkForErrorLog" ID="UserInterface.checkForErrorLog"></a>
<h4>UserInterface.checkForErrorLog</h4>
<b>checkForErrorLog</b>(<i></i>)
<p>
        Public method to check for the presence of an error log and ask the user,
        what to do with it.
</p><a NAME="UserInterface.checkProjectsWorkspace" ID="UserInterface.checkProjectsWorkspace"></a>
<h4>UserInterface.checkProjectsWorkspace</h4>
<b>checkProjectsWorkspace</b>(<i></i>)
<p>
        Public method to check, if a projects workspace has been configured. If
        it has not, a dialog is shown.
</p><a NAME="UserInterface.closeEvent" ID="UserInterface.closeEvent"></a>
<h4>UserInterface.closeEvent</h4>
<b>closeEvent</b>(<i>event</i>)
<p>
        Private event handler for the close event.
</p><p>
        This event handler saves the preferences.
</p><dl>
<dt><i>event</i></dt>
<dd>
close event (QCloseEvent)
</dd>
</dl><a NAME="UserInterface.dragEnterEvent" ID="UserInterface.dragEnterEvent"></a>
<h4>UserInterface.dragEnterEvent</h4>
<b>dragEnterEvent</b>(<i>event</i>)
<p>
        Protected method to handle the drag enter event.
</p><dl>
<dt><i>event</i></dt>
<dd>
the drag enter event (QDragEnterEvent)
</dd>
</dl><a NAME="UserInterface.dragLeaveEvent" ID="UserInterface.dragLeaveEvent"></a>
<h4>UserInterface.dragLeaveEvent</h4>
<b>dragLeaveEvent</b>(<i>event</i>)
<p>
        Protected method to handle the drag leave event.
</p><dl>
<dt><i>event</i></dt>
<dd>
the drag leave event (QDragLeaveEvent)
</dd>
</dl><a NAME="UserInterface.dragMoveEvent" ID="UserInterface.dragMoveEvent"></a>
<h4>UserInterface.dragMoveEvent</h4>
<b>dragMoveEvent</b>(<i>event</i>)
<p>
        Protected method to handle the drag move event.
</p><dl>
<dt><i>event</i></dt>
<dd>
the drag move event (QDragMoveEvent)
</dd>
</dl><a NAME="UserInterface.dropEvent" ID="UserInterface.dropEvent"></a>
<h4>UserInterface.dropEvent</h4>
<b>dropEvent</b>(<i>event</i>)
<p>
        Protected method to handle the drop event.
</p><dl>
<dt><i>event</i></dt>
<dd>
the drop event (QDropEvent)
</dd>
</dl><a NAME="UserInterface.getActions" ID="UserInterface.getActions"></a>
<h4>UserInterface.getActions</h4>
<b>getActions</b>(<i>type</i>)
<p>
        Public method to get a list of all actions.
</p><dl>
<dt><i>type</i></dt>
<dd>
string denoting the action set to get.
            It must be one of "ui" or "wizards".
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
list of all actions (list of E5Action)
</dd>
</dl><a NAME="UserInterface.getHelpViewer" ID="UserInterface.getHelpViewer"></a>
<h4>UserInterface.getHelpViewer</h4>
<b>getHelpViewer</b>(<i>preview=False</i>)
<p>
        Public method to get a reference to the help window instance.
</p><dl>
<dt><i>preview=</i></dt>
<dd>
flag indicating to get a help window for preview (boolean)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
reference to the help window instance (HelpWindow)
</dd>
</dl><a NAME="UserInterface.getLocale" ID="UserInterface.getLocale"></a>
<h4>UserInterface.getLocale</h4>
<b>getLocale</b>(<i></i>)
<p>
        Public method to get the locale of the IDE.
</p><dl>
<dt>Returns:</dt>
<dd>
locale of the IDE (string or None)
</dd>
</dl><a NAME="UserInterface.getMenu" ID="UserInterface.getMenu"></a>
<h4>UserInterface.getMenu</h4>
<b>getMenu</b>(<i>name</i>)
<p>
        Public method to get a reference to a specific menu.
</p><dl>
<dt><i>name</i></dt>
<dd>
name of the menu (string)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
reference to the menu (QMenu)
</dd>
</dl><a NAME="UserInterface.getMenuAction" ID="UserInterface.getMenuAction"></a>
<h4>UserInterface.getMenuAction</h4>
<b>getMenuAction</b>(<i>menuName, actionName</i>)
<p>
        Public method to get a reference to an action of a menu.
</p><dl>
<dt><i>menuName</i></dt>
<dd>
name of the menu to search in (string)
</dd><dt><i>actionName</i></dt>
<dd>
object name of the action to search for
            (string)
</dd>
</dl><a NAME="UserInterface.getMenuBarAction" ID="UserInterface.getMenuBarAction"></a>
<h4>UserInterface.getMenuBarAction</h4>
<b>getMenuBarAction</b>(<i>menuName</i>)
<p>
        Public method to get a reference to an action of the main menu.
</p><dl>
<dt><i>menuName</i></dt>
<dd>
name of the menu to search in (string)
</dd>
</dl><a NAME="UserInterface.getToolBarIconSize" ID="UserInterface.getToolBarIconSize"></a>
<h4>UserInterface.getToolBarIconSize</h4>
<b>getToolBarIconSize</b>(<i></i>)
<p>
        Public method to get the toolbar icon size.
</p><dl>
<dt>Returns:</dt>
<dd>
toolbar icon size (QSize)
</dd>
</dl><a NAME="UserInterface.getToolbar" ID="UserInterface.getToolbar"></a>
<h4>UserInterface.getToolbar</h4>
<b>getToolbar</b>(<i>name</i>)
<p>
        Public method to get a reference to a specific toolbar.
</p><dl>
<dt><i>name</i></dt>
<dd>
name of the toolbar (string)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
reference to the toolbar entry (tuple of string and QToolBar)
</dd>
</dl><a NAME="UserInterface.getViewProfile" ID="UserInterface.getViewProfile"></a>
<h4>UserInterface.getViewProfile</h4>
<b>getViewProfile</b>(<i></i>)
<p>
        Public method to get the current view profile.
</p><dl>
<dt>Returns:</dt>
<dd>
the name of the current view profile (string)
</dd>
</dl><a NAME="UserInterface.launchHelpViewer" ID="UserInterface.launchHelpViewer"></a>
<h4>UserInterface.launchHelpViewer</h4>
<b>launchHelpViewer</b>(<i>home, searchWord=None, useSingle=False</i>)
<p>
        Public slot to start the help viewer.
</p><dl>
<dt><i>home</i></dt>
<dd>
filename of file to be shown (string)
</dd><dt><i>searchWord=</i></dt>
<dd>
word to search for (string)
</dd><dt><i>useSingle=</i></dt>
<dd>
flag indicating to use a single browser window (boolean)
</dd>
</dl><a NAME="UserInterface.performVersionCheck" ID="UserInterface.performVersionCheck"></a>
<h4>UserInterface.performVersionCheck</h4>
<b>performVersionCheck</b>(<i>manual=True, alternative=0, showVersions=False</i>)
<p>
        Public method to check the internet for an eric5 update.
</p><dl>
<dt><i>manual</i></dt>
<dd>
flag indicating an invocation via the menu (boolean)
</dd><dt><i>alternative</i></dt>
<dd>
index of server to download from (integer)
</dd><dt><i>showVersion=</i></dt>
<dd>
flag indicating the show versions mode (boolean)
</dd>
</dl><a NAME="UserInterface.processArgs" ID="UserInterface.processArgs"></a>
<h4>UserInterface.processArgs</h4>
<b>processArgs</b>(<i>args</i>)
<p>
        Public method to process the command line args passed to the UI.
</p><dl>
<dt><i>args</i></dt>
<dd>
list of files to open<br />
            The args are processed one at a time. All arguments after a
            '--' option are considered debug arguments to the program
            for the debugger. All files named before the '--' option
            are opened in a text editor, unless the argument ends in
            .e4p, then it is opened as a project file. If it ends in
            .e4m, it is opened as a multiproject.
</dd>
</dl><a NAME="UserInterface.registerToolbar" ID="UserInterface.registerToolbar"></a>
<h4>UserInterface.registerToolbar</h4>
<b>registerToolbar</b>(<i>name, text, toolbar</i>)
<p>
        Public method to register a toolbar.
</p><p>
        This method must be called in order to make a toolbar manageable by the
        UserInterface object.
</p><dl>
<dt><i>name</i></dt>
<dd>
name of the toolbar (string). This is used as the key into
            the dictionary of toolbar references.
</dd><dt><i>text</i></dt>
<dd>
user visible text for the toolbar entry (string)
</dd><dt><i>toolbar</i></dt>
<dd>
reference to the toolbar to be registered (QToolBar)
</dd>
</dl><dl>
<dt>Raises <b>KeyError</b>:</dt>
<dd>
raised, if a toolbar with the given name was
            already registered
</dd>
</dl><a NAME="UserInterface.removeE5Actions" ID="UserInterface.removeE5Actions"></a>
<h4>UserInterface.removeE5Actions</h4>
<b>removeE5Actions</b>(<i>actions, type='ui'</i>)
<p>
        Public method to remove actions from the list of actions.
</p><dl>
<dt><i>type</i></dt>
<dd>
string denoting the action set to get.
            It must be one of "ui" or "wizards".
</dd><dt><i>actions</i></dt>
<dd>
list of actions (list of E5Action)
</dd>
</dl><a NAME="UserInterface.removeSideWidget" ID="UserInterface.removeSideWidget"></a>
<h4>UserInterface.removeSideWidget</h4>
<b>removeSideWidget</b>(<i>widget</i>)
<p>
        Public method to remove a widget added using addSideWidget().
</p><dl>
<dt><i>widget</i></dt>
<dd>
reference to the widget to remove (QWidget)
</dd>
</dl><a NAME="UserInterface.reregisterToolbar" ID="UserInterface.reregisterToolbar"></a>
<h4>UserInterface.reregisterToolbar</h4>
<b>reregisterToolbar</b>(<i>name, text</i>)
<p>
        Public method to change the visible text for the named toolbar.
</p><dl>
<dt><i>name</i></dt>
<dd>
name of the toolbar to be changed (string)
</dd><dt><i>text</i></dt>
<dd>
new user visible text for the toolbar entry (string)
</dd>
</dl><a NAME="UserInterface.setDebugProfile" ID="UserInterface.setDebugProfile"></a>
<h4>UserInterface.setDebugProfile</h4>
<b>setDebugProfile</b>(<i>save=True</i>)
<p>
        Public slot to activate the debug view profile.
</p><dl>
<dt><i>save</i></dt>
<dd>
flag indicating that the current profile should
            be saved (boolean)
</dd>
</dl><a NAME="UserInterface.showAvailableVersionsInfo" ID="UserInterface.showAvailableVersionsInfo"></a>
<h4>UserInterface.showAvailableVersionsInfo</h4>
<b>showAvailableVersionsInfo</b>(<i></i>)
<p>
        Public method to show the eric5 versions available for download.
</p><a NAME="UserInterface.showEmailDialog" ID="UserInterface.showEmailDialog"></a>
<h4>UserInterface.showEmailDialog</h4>
<b>showEmailDialog</b>(<i>mode, attachFile=None, deleteAttachFile=False</i>)
<p>
        Public slot to show the email dialog in a given mode.
</p><dl>
<dt><i>mode</i></dt>
<dd>
mode of the email dialog (string, "bug" or "feature")
</dd><dt><i>attachFile</i></dt>
<dd>
name of a file to attach to the email (string)
</dd><dt><i>deleteAttachFile</i></dt>
<dd>
flag indicating to delete the attached file after
            it has been sent (boolean)
</dd>
</dl><a NAME="UserInterface.showEvent" ID="UserInterface.showEvent"></a>
<h4>UserInterface.showEvent</h4>
<b>showEvent</b>(<i>evt</i>)
<p>
        Protected method to handle the show event.
</p><dl>
<dt><i>evt</i></dt>
<dd>
reference to the show event (QShowEvent)
</dd>
</dl><a NAME="UserInterface.showFindFileByNameDialog" ID="UserInterface.showFindFileByNameDialog"></a>
<h4>UserInterface.showFindFileByNameDialog</h4>
<b>showFindFileByNameDialog</b>(<i></i>)
<p>
        Public slot to show the Find File by Name dialog.
</p><a NAME="UserInterface.showFindFilesDialog" ID="UserInterface.showFindFilesDialog"></a>
<h4>UserInterface.showFindFilesDialog</h4>
<b>showFindFilesDialog</b>(<i>txt="", searchDir=""</i>)
<p>
        Public slot to show the Find In Files dialog.
</p><dl>
<dt><i>txt=</i></dt>
<dd>
text to search for (string)
</dd><dt><i>searchDir=</i></dt>
<dd>
directory to search in (string)
</dd>
</dl><a NAME="UserInterface.showLogTab" ID="UserInterface.showLogTab"></a>
<h4>UserInterface.showLogTab</h4>
<b>showLogTab</b>(<i>tabname</i>)
<p>
        Public method to show a particular Log-Viewer tab.
</p><dl>
<dt><i>tabname</i></dt>
<dd>
string naming the tab to be shown (string)
</dd>
</dl><a NAME="UserInterface.showPreferences" ID="UserInterface.showPreferences"></a>
<h4>UserInterface.showPreferences</h4>
<b>showPreferences</b>(<i>pageName=None</i>)
<p>
        Public slot to set the preferences.
</p><dl>
<dt><i>pageName</i></dt>
<dd>
name of the configuration page to show (string)
</dd>
</dl><a NAME="UserInterface.showReplaceFilesDialog" ID="UserInterface.showReplaceFilesDialog"></a>
<h4>UserInterface.showReplaceFilesDialog</h4>
<b>showReplaceFilesDialog</b>(<i>txt="", searchDir=""</i>)
<p>
        Public slot to show the Find & Replace In Files dialog.
</p><dl>
<dt><i>txt=</i></dt>
<dd>
text to search for (string)
</dd><dt><i>searchDir=</i></dt>
<dd>
directory to search in (string)
</dd>
</dl><a NAME="UserInterface.unregisterToolbar" ID="UserInterface.unregisterToolbar"></a>
<h4>UserInterface.unregisterToolbar</h4>
<b>unregisterToolbar</b>(<i>name</i>)
<p>
        Public method to unregister a toolbar.
</p><dl>
<dt><i>name</i></dt>
<dd>
name of the toolbar (string).
</dd>
</dl><a NAME="UserInterface.versionIsNewer" ID="UserInterface.versionIsNewer"></a>
<h4>UserInterface.versionIsNewer</h4>
<b>versionIsNewer</b>(<i>required, snapshot=None</i>)
<p>
        Public method to check, if the eric5 version is good compared to
        the required version.
</p><dl>
<dt><i>required</i></dt>
<dd>
required version (string)
</dd><dt><i>snapshot</i></dt>
<dd>
required snapshot version (string)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
flag indicating, that the version is newer than the required one
            (boolean)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>