eric: Documentation/Source/eric5.UI.UserInterface.html@9a54fec8559d (annotated)

 <?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><h4>Signals</h4>
 <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>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>
 <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><h4>Signals</h4>
 <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>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>
 QMainWindow
 <h3>Class Attributes</h3>
 <table>
 <tr><td>maxFilePathLen</td></tr><tr><td>maxMenuFilePathLen</td></tr><tr><td>maxSbFilePathLen</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.__activateCooperationViewer">__activateCooperationViewer</a></td>
 <td>Private slot to handle the activation of the cooperation window.</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.__createDockWindowsLayout">__createDockWindowsLayout</a></td>
 <td>Private method to create the DockWindows layout.</td>
 </tr><tr>
 <td><a href="#UserInterface.__createFloatingWindowsLayout">__createFloatingWindowsLayout</a></td>
 <td>Private method to create the FloatingWindows layout.</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.__customViewer">__customViewer</a></td>
 <td>Private slot to start a custom viewer.</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.__newProject">__newProject</a></td>
 <td>Private slot to handle the NewProject signal.</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.__setStyle">__setStyle</a></td>
 <td>Private slot to set the style of the interface.</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.__showEmailDialog">__showEmailDialog</a></td>
 <td>Private slot to show the email dialog in a given mode.</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.__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.__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.__toggleBrowser">__toggleBrowser</a></td>
 <td>Private slot to handle the toggle of the File Browser window.</td>
 </tr><tr>
 <td><a href="#UserInterface.__toggleCooperationViewer">__toggleCooperationViewer</a></td>
 <td>Private slot to handle the toggle of the cooperation window.</td>
 </tr><tr>
 <td><a href="#UserInterface.__toggleDebugViewer">__toggleDebugViewer</a></td>
 <td>Private slot to handle the toggle of the debug viewer.</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.__toggleLogViewer">__toggleLogViewer</a></td>
 <td>Private slot to handle the toggle of the Log Viewer window.</td>
 </tr><tr>
 <td><a href="#UserInterface.__toggleMultiProjectBrowser">__toggleMultiProjectBrowser</a></td>
 <td>Private slot to handle the toggle of the Project Browser window.</td>
 </tr><tr>
 <td><a href="#UserInterface.__toggleNumbersViewer">__toggleNumbersViewer</a></td>
 <td>Private slot to handle the toggle of the Numbers Viewer window.</td>
 </tr><tr>
 <td><a href="#UserInterface.__toggleProjectBrowser">__toggleProjectBrowser</a></td>
 <td>Private slot to handle the toggle of the Project Browser window.</td>
 </tr><tr>
 <td><a href="#UserInterface.__toggleShell">__toggleShell</a></td>
 <td>Private slot to handle the toggle of the Shell window .</td>
 </tr><tr>
 <td><a href="#UserInterface.__toggleSymbolsViewer">__toggleSymbolsViewer</a></td>
 <td>Private slot to handle the toggle of the Symbols Viewer window.</td>
 </tr><tr>
 <td><a href="#UserInterface.__toggleTaskViewer">__toggleTaskViewer</a></td>
 <td>Private slot to handle the toggle of the Task Viewer window.</td>
 </tr><tr>
 <td><a href="#UserInterface.__toggleTemplateViewer">__toggleTemplateViewer</a></td>
 <td>Private slot to handle the toggle of the Template Viewer window.</td>
 </tr><tr>
 <td><a href="#UserInterface.__toggleTerminal">__toggleTerminal</a></td>
 <td>Private slot to handle the toggle of the Terminal window .</td>
 </tr><tr>
 <td><a href="#UserInterface.__toggleVerticalToolbox">__toggleVerticalToolbox</a></td>
 <td>Private slot to handle the toggle of the Vertical 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.__unittestRestart">__unittestRestart</a></td>
 <td>Private slot to display the unittest dialog and rerun the last 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.__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.addE5Actions">addE5Actions</a></td>
 <td>Public method to add actions to the list of actions.</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.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.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.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.showEvent">showEvent</a></td>
 <td>Protected method to handle the show event.</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.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>
 <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.__activateCooperationViewer" ID="UserInterface.__activateCooperationViewer"></a>
 <h4>UserInterface.__activateCooperationViewer</h4>
 <b>__activateCooperationViewer</b>(<i></i>)
 <p>
         Private slot to handle the activation of the cooperation window.
 </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.__createDockWindowsLayout" ID="UserInterface.__createDockWindowsLayout"></a>
 <h4>UserInterface.__createDockWindowsLayout</h4>
 <b>__createDockWindowsLayout</b>(<i>debugServer</i>)
 <p>
         Private method to create the DockWindows layout.
 </p><dl>
 <dt><i>debugServer</i></dt>
 <dd>
 reference to the debug server object
 </dd>
 </dl><a NAME="UserInterface.__createFloatingWindowsLayout" ID="UserInterface.__createFloatingWindowsLayout"></a>
 <h4>UserInterface.__createFloatingWindowsLayout</h4>
 <b>__createFloatingWindowsLayout</b>(<i>debugServer</i>)
 <p>
         Private method to create the FloatingWindows layout.
 </p><dl>
 <dt><i>debugServer</i></dt>
 <dd>
 reference to the debug server object
 </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>
 edde1

Mercurial Repositories > eric / annotate

Documentation/Source/eric5.UI.UserInterface.html@9a54fec8559d (annotated)

Documentation/Source/eric5.UI.UserInterface.html