# eric4.UI.UserInterface

Module implementing the main user interface.

### Global Attributes

None

### Classes

Redirector | Helper class used to redirect stdout and stderr to the log window
UserInterface | Class implementing the main user interface.

### Functions

None

## Redirector

Helper class used to redirect stdout and stderr to the log window

### Signals

appendStderr(string)
  emitted to write data to stderr logger
appendStdout(string)
  emitted to write data to stdout logger

### Derived from

QObject

### Class Attributes

None

### Class Methods

None

### Methods

Redirector | Constructor
__bufferedWrite | Private method returning number of characters to write.
__nWrite | Private method used to write data.
flush | Public method used to flush the buffered data.
write | Public method used to write data.

### Static Methods

None

#### Redirector (Constructor)

Redirector(stderr)

Constructor

stderr
  flag indicating stderr is being redirected

#### Redirector.__bufferedWrite

__bufferedWrite()

Private method returning number of characters to write.

Returns:
  number of characters buffered or length of buffered line

#### Redirector.__nWrite

__nWrite(n)

Private method used to write data.

n
  max number of bytes to write

#### Redirector.flush

flush()

Public method used to flush the buffered data.

#### Redirector.write

write(s)

Public method used to write data.

s
  data to be written (it must support the str-method)

Up

## UserInterface

Class implementing the main user interface.

### Signals

appendStderr(QString)
  emitted to write data to stderr logger
appendStdout(QString)
  emitted to write data to stdout logger
preferencesChanged()
  emitted after the preferences were changed
reloadAPIs()
  emitted to reload the api information
showMenu(string, QMenu)
  emitted when a menu is about to be shown. The name of the menu and a reference to the menu are given.

### Derived from

KQMainWindow

### Class Attributes

maxFilePathLen
maxMenuFilePathLen
maxSbFilePathLen

### Class Methods

None

### Methods

UserInterface | Constructor
__TBMenuTriggered | Private method to handle the toggle of a toolbar.
__TRPreviewer | Private slot to start the Translation Previewer executable.
__UIPreviewer | Private slot to start the UI Previewer executable.
__activateBrowser | Private slot to handle the activation of the file browser.
__activateDebugViewer | Private slot to handle the activation of the debug browser.
__activateLogViewer | Private slot to handle the activation of the Log Viewer.
__activateMultiProjectBrowser | Private slot to handle the activation of the project browser.
__activateProjectBrowser | Private slot to handle the activation of the project browser.
__activateShell | Private slot to handle the activation of the Shell window.
__activateTaskViewer | Private slot to handle the activation of the Task Viewer.
__activateTemplateViewer | Private slot to handle the activation of the Template Viewer.
__activateViewProfile | Private slot to activate a view profile.
__activateViewmanager | Private slot to handle the activation of the current editor.
__assistant | Private slot to start the Qt-Assistant executable.
__assistant4 | Private slot to start the Qt-Assistant 4 executable.
__checkActions | Private slot to check some actions for their enable/disable status.
__chmViewer | Private slot to start the win help viewer to show *.chm files.
__compareFiles | Private slot to handle the Compare Files dialog.
__compareFilesSbs | Private slot to handle the Compare Files dialog.
__configShortcuts | Private slot to configure the keyboard shortcuts.
__configToolBars | Private slot to configure the various toolbars.
__configViewProfiles | Private slot to configure the various view profiles.
__configureDockareaCornerUsage | Private method to configure the usage of the dockarea corners.
__createDockWindow | Private method to create a dock window with common properties.
__createDockWindowsLayout | Private method to create the DockWindows layout.
__createFloatingWindowsLayout | Private method to create the FloatingWindows layout.
__createLayout | Private method to create the layout of the various windows.
__createSidebarsLayout | Private method to create the Sidebars layout.
__createToolboxesLayout | Private method to create the Toolboxes layout.
__customViewer | Private slot to start a custom viewer.
__debuggingStarted | Private slot to handle the start of a debugging session.
__deinstallPlugin | Private slot to show a dialog to uninstall a plugin.
__designer | Private slot to start the Qt-Designer executable.
__designer4 | Private slot to start the Qt-Designer 4 executable.
__editPixmap | Private slot to show a pixmap in a dialog.
__editorOpened | Private slot to handle the editorOpened signal.
__exportPreferences | Private slot to export the current preferences.
__exportShortcuts | Private slot to export the keyboard shortcuts.
__getFloatingGeometry | Private method to get the geometry of a floating windows.
__helpClosed | Private slot to handle the helpClosed signal of the help window.
__helpViewer | Private slot to start an empty help viewer.
__importPreferences | Private slot to import preferences.
__importShortcuts | Private slot to import the keyboard shortcuts.
__initActions | Private method to define the user interface actions.
__initDebugToolbarsLayout | Private slot to initialize the toolbars layout for the debug profile.
__initEricDocAction | Private slot to initialize the action to show the eric4 documentation.
__initExternalToolsActions | Private slot to create actions for the configured external tools.
__initKdeDocActions | Private slot to initilize the action to show the KDE4 documentation.
__initMenus | Private slot to create the menus.
__initPySideDocActions | Private slot to initilize the action to show the PySide documentation.
__initPythonDocAction | Private slot to initilize the action to show the Python documentation.
__initQtDocActions | Private slot to initilize the action to show the Qt documentation.
__initStatusbar | Private slot to set up the status bar.
__initToolbars | Private slot to create the toolbars.
__installPlugins | Private slot to show a dialog to install a new plugin.
__lastEditorClosed | Private slot to handle the lastEditorClosed signal.
__linguist | Private slot to start the Qt-Linguist executable.
__linguist4 | Private slot to start the Qt-Linguist 4 executable.
__newProject | Private slot to handle the NewProject signal.
__newWindow | Private slot to start a new instance of eric4.
__openMiniEditor | Private slot to show a mini editor window.
__openOnStartup | Private method to open the last file, project or multiproject.
__pluginsConfigure | Private slot to show the plugin manager configuration page.
__preferencesChanged | Private slot to handle a change of the preferences.
__processToolStderr | Private slot to handle the readyReadStderr signal of a tool process.
__processToolStdout | Private slot to handle the readyReadStdout signal of a tool process.
__programChange | Private slot to handle the programChange signal.
__projectClosed | Private slot to handle the projectClosed signal.
__projectOpened | Private slot to handle the projectOpened signal.
__proxyAuthenticationRequired | Private slot to handle a proxy authentication request.
__quit | Private method to quit the application.
__readSession | Private slot to read in the session file (.e4s)
__readTasks | Private slot to read in the tasks file (.e4t)
__reloadAPIs | Private slot to reload the api information.
__reportBug | Private slot to handle the Report Bug dialog.
__requestFeature | Private slot to handle the Feature Request dialog.
__restart | Private method to restart the application.
__saveCurrentViewProfile | Private slot to save the window geometries of the active profile.
__setEditProfile | Private slot to activate the edit view profile.
__setStyle | Private slot to set the style of the interface.
__setWindowCaption | Private method to set the caption of the Main Window.
__setupDockWindow | Private method to configure the dock window created with __createDockWindow().
__showAvailableVersionInfos | Private method to show the versions available for download.
__showEricDoc | Private slot to show the Eric documentation.
__showExternalTools | Private slot to display a dialog show a list of external tools used by eric4.
__showExtrasMenu | Private slot to display the Extras menu.
__showFileMenu | Private slot to display the File menu.
__showHelpMenu | Private slot to display the Help menu.
__showNext | Private slot used to show the next tab or file.
__showPixmap | Private slot to show a pixmap in a dialog.
__showPluginInfo | Private slot to show the plugin info dialog.
__showPluginsAvailable | Private slot to show the plugins available for download.
__showPrevious | Private slot used to show the previous tab or file.
__showPyKDE4Doc | Private slot to show the PyKDE4 documentation.
__showPyQt4Doc | Private slot to show the PyQt4 documentation.
__showPySideDoc | Private slot to show the PySide documentation.
__showPythonDoc | Private slot to show the Python documentation.
__showQt4Doc | Private slot to show the Qt4 documentation.
__showSvg | Private slot to show a SVG file in a dialog.
__showSystemEmailClient | Private slot to show the system email dialog.
__showToolGroupsMenu | Private slot to display the Tool Groups menu.
__showToolbarsMenu | Private slot to display the Toolbars menu.
__showToolsMenu | Private slot to display the Tools menu.
__showVersions | Private slot to handle the Versions dialog.
__showWindowMenu | Private slot to display the Window menu.
__showWizardsMenu | Private slot to display the Wizards menu.
__shutdown | Private method to perform all necessary steps to close down the IDE.
__sqlBrowser | Private slot to start the SQL browser tool.
__sslErrors | Private slot to handle SSL errors.
__startToolProcess | Private slot to start an external tool process.
__startWebBrowser | Private slot to start the eric4 web browser.
__switchTab | Private slot used to switch between the current and the previous current tab.
__toggleBottomSidebar | Private slot to handle the toggle of the bottom sidebar window.
__toggleBrowser | Private slot to handle the toggle of the File Browser window.
__toggleDebugViewer | Private slot to handle the toggle of the debug viewer.
__toggleHorizontalToolbox | Private slot to handle the toggle of the Horizontal Toolbox window.
__toggleLeftSidebar | Private slot to handle the toggle of the left sidebar window.
__toggleLogViewer | Private slot to handle the toggle of the Log Viewer window.
__toggleMultiProjectBrowser | Private slot to handle the toggle of the Project Browser window.
__toggleProjectBrowser | Private slot to handle the toggle of the Project Browser window.
__toggleShell | Private slot to handle the toggle of the Shell window .
__toggleTaskViewer | Private slot to handle the toggle of the Task Viewer window.
__toggleTemplateViewer | Private slot to handle the toggle of the Template Viewer window.
__toggleVerticalToolbox | Private slot to handle the toggle of the Vertical Toolbox window.
__toggleWindow | Private method to toggle a workspace editor window.
__toolActionTriggered | Private slot called by external tools toolbar actions.
__toolExecute | Private slot to execute a particular tool.
__toolFinished | Private slot to handle the finished signal of a tool process.
__toolGroupSelected | Private slot to set the current tool group.
__toolGroupsConfiguration | Private slot to handle the tool groups configuration menu entry.
__toolsConfiguration | Private slot to handle the tools configuration menu entry.
__unittest | Private slot for displaying the unittest dialog.
__unittestProject | Private slot for displaying the unittest dialog and run the current project.
__unittestRestart | Private slot to display the unittest dialog and rerun the last test.
__unittestScript | Private slot for displaying the unittest dialog and run the current script.
__updateExternalToolsActions | Private method to update the external tools actions for the current tool group.
__updateVersionsUrls | Private method to update the URLs from which to retrieve the versions file.
__versionCheckResult | Private method to show the result of the version check action.
__versionsDownloadCanceled | Private method called to cancel the version check.
__versionsDownloadDone | Private method called, after the versions file has been downloaded from the internet.
__webBrowser | Private slot to start a web browser executable.
__whatsThis | Private slot called in to enter Whats This mode.
__writeSession | Private slot to write the session data to an XML file (.e4s).
__writeTasks | Private slot to write the tasks data to an XML file (.e4t).
addE4Actions | Public method to add actions to the list of actions.
appendToStderr | Public slot to append text to the stderr log viewer tab.
appendToStdout | Public slot to append text to the stdout log viewer tab.
checkConfigurationStatus | Public method to check, if eric4 has been configured.
checkForErrorLog | Public method to check for the presence of an error log and ask the user, what to do with it.
checkProjectsWorkspace | Public method to check, if a projects workspace has been configured.
closeEvent | Private event handler for the close event.
dragEnterEvent | Protected method to handle the drag enter event.
dragLeaveEvent | Protected method to handle the drag leave event.
dragMoveEvent | Protected method to handle the drag move event.
dropEvent | Protected method to handle the drop event.
getActions | Public method to get a list of all actions.
getLocale | Public method to get the locale of the IDE.
getMenu | Public method to get a reference to a specific menu.
getMenuAction | Public method to get a reference to an action of a menu.
getMenuBarAction | Public method to get a reference to an action of the main menu.
getToolBarIconSize | Public method to get the toolbar icon size.
getToolbar | Public method to get a reference to a specific toolbar.
getViewProfile | Public method to get the current view profile.
launchHelpViewer | Public slot to start the help viewer.
performVersionCheck | Public method to check the internet for an eric4 update.
processArgs | Public method to process the command line args passed to the UI.
registerToolbar | Public method to register a toolbar.
removeE4Actions | Public method to remove actions from the list of actions.
reregisterToolbar | Public method to change the visible text for the named toolbar.
setDebugProfile | Public slot to activate the debug view profile.
showAvailableVersionsInfo | Public method to show the eric4 versions available for download.
showEmailDialog | Private slot to show the email dialog in a given mode.
showEvent | Protected method to handle the show event.
showLogTab | Public method to show a particular Log-Viewer tab.
showPreferences | Public slot to set the preferences.
unregisterToolbar | Public method to unregister a toolbar.
versionIsNewer | Public method to check, if the eric4 version is good compared to the required version.

### Static Methods

None

#### UserInterface (Constructor)

UserInterface(app, locale, splash, plugin, noOpenAtStartup, restartArguments)

Constructor

app
  reference to the application object (KQApplication)
locale
  locale to be used by the UI (string)
splash
  reference to the splashscreen (UI.SplashScreen.SplashScreen)
plugin
  filename of a plugin to be loaded (used for plugin development)
noOpenAtStartup
  flag indicating that the open at startup option should not be executed (boolean)
restartArguments
  list of command line parameters to be used for a restart (list of strings)

#### UserInterface.__TBMenuTriggered

__TBMenuTriggered(act)

Private method to handle the toggle of a toolbar.

act
  reference to the action that was triggered (QAction)

#### UserInterface.__TRPreviewer

__TRPreviewer(fileNames = None, ignore = False)

Private slot to start the Translation Previewer executable.

fileNames
  filenames of forms and/or translations to be previewed
ignore
  flag indicating non existing files should be ignored (boolean)

#### UserInterface.__UIPreviewer

__UIPreviewer(fn=None)

Private slot to start the UI Previewer executable.

fn
  filename of the form to be previewed

#### UserInterface.__activateBrowser

__activateBrowser()

Private slot to handle the activation of the file browser.

#### UserInterface.__activateDebugViewer

__activateDebugViewer()

Private slot to handle the activation of the debug browser.

#### UserInterface.__activateLogViewer

__activateLogViewer()

Private slot to handle the activation of the Log Viewer.

#### UserInterface.__activateMultiProjectBrowser

__activateMultiProjectBrowser()

Private slot to handle the activation of the project browser.

#### UserInterface.__activateProjectBrowser

__activateProjectBrowser()

Private slot to handle the activation of the project browser.

#### UserInterface.__activateShell

__activateShell()

Private slot to handle the activation of the Shell window.

#### UserInterface.__activateTaskViewer

__activateTaskViewer()

Private slot to handle the activation of the Task Viewer.

#### UserInterface.__activateTemplateViewer

__activateTemplateViewer()

Private slot to handle the activation of the Template Viewer.

#### UserInterface.__activateViewProfile

__activateViewProfile(name, save = True)

Private slot to activate a view profile.

name
  name of the profile to be activated (string)
save
  flag indicating that the current profile should be saved (boolean)

#### UserInterface.__activateViewmanager

__activateViewmanager()

Private slot to handle the activation of the current editor.

#### UserInterface.__assistant

__assistant(home = None, version = 0)

Private slot to start the Qt-Assistant executable.

home
  full pathname of a file to display (string or QString)
version
  indication for the requested version (Qt 4) (integer)

#### UserInterface.__assistant4

__assistant4()

Private slot to start the Qt-Assistant 4 executable.

#### UserInterface.__checkActions

__checkActions(editor)

Private slot to check some actions for their enable/disable status.

editor
  editor window

#### UserInterface.__chmViewer

__chmViewer(home=None)

Private slot to start the win help viewer to show *.chm files.

home
  full pathname of a file to display (string or QString)

#### UserInterface.__compareFiles

__compareFiles()

Private slot to handle the Compare Files dialog.

#### UserInterface.__compareFilesSbs

__compareFilesSbs()

Private slot to handle the Compare Files dialog.

#### UserInterface.__configShortcuts

__configShortcuts()

Private slot to configure the keyboard shortcuts.

#### UserInterface.__configToolBars

__configToolBars()

Private slot to configure the various toolbars.

#### UserInterface.__configViewProfiles

__configViewProfiles()

Private slot to configure the various view profiles.

#### UserInterface.__configureDockareaCornerUsage

__configureDockareaCornerUsage()

Private method to configure the usage of the dockarea corners.

#### UserInterface.__createDockWindow

__createDockWindow(name)

Private method to create a dock window with common properties.

name
  object name of the new dock window (string or QString)

Returns:
  the generated dock window (QDockWindow)

#### UserInterface.__createDockWindowsLayout

__createDockWindowsLayout(debugServer)

Private method to create the DockWindows layout.

debugServer
  reference to the debug server object

#### UserInterface.__createFloatingWindowsLayout

__createFloatingWindowsLayout(debugServer)

Private method to create the FloatingWindows layout.

debugServer
  reference to the debug server object

#### UserInterface.__createLayout

__createLayout(debugServer)

Private method to create the layout of the various windows.

debugServer
  reference to the debug server object

#### UserInterface.__createSidebarsLayout

__createSidebarsLayout(debugServer)

Private method to create the Sidebars layout.

debugServer
  reference to the debug server object

#### UserInterface.__createToolboxesLayout

__createToolboxesLayout(debugServer)

Private method to create the Toolboxes layout.

debugServer
  reference to the debug server object

#### UserInterface.__customViewer

__customViewer(home = None)

Private slot to start a custom viewer.

home
  full pathname of a file to display (string or QString)

#### UserInterface.__debuggingStarted

__debuggingStarted()

Private slot to handle the start of a debugging session.

#### UserInterface.__deinstallPlugin

__deinstallPlugin()

Private slot to show a dialog to uninstall a plugin.

#### UserInterface.__designer

__designer(fn = None, version = 0)

Private slot to start the Qt-Designer executable.

fn
  filename of the form to be opened
version
  indication for the requested version (Qt 4) (integer)

#### UserInterface.__designer4

__designer4()

Private slot to start the Qt-Designer 4 executable.

#### UserInterface.__editPixmap

__editPixmap(fn = "")

Private slot to show a pixmap in a dialog.

fn
  filename of the file to show (string or QString)

#### UserInterface.__editorOpened

__editorOpened(fn)

Private slot to handle the editorOpened signal.

fn
  filename of the opened editor (QString)

#### UserInterface.__exportPreferences

__exportPreferences()

Private slot to export the current preferences.

#### UserInterface.__exportShortcuts

__exportShortcuts()

Private slot to export the keyboard shortcuts.

#### UserInterface.__getFloatingGeometry

__getFloatingGeometry(w)

Private method to get the geometry of a floating windows.

w
  reference to the widget to be saved (QWidget)

Returns:
  list giving the widget's geometry and its visibility

#### UserInterface.__helpClosed

__helpClosed()

Private slot to handle the helpClosed signal of the help window.

#### UserInterface.__helpViewer

__helpViewer()

Private slot to start an empty help viewer.

#### UserInterface.__importPreferences

__importPreferences()

Private slot to import preferences.

#### UserInterface.__importShortcuts

__importShortcuts()

Private slot to import the keyboard shortcuts.

#### UserInterface.__initActions

__initActions()

Private method to define the user interface actions.

#### UserInterface.__initDebugToolbarsLayout

__initDebugToolbarsLayout()

Private slot to initialize the toolbars layout for the debug profile.

#### UserInterface.__initEricDocAction

__initEricDocAction()

Private slot to initialize the action to show the eric4 documentation.

#### UserInterface.__initExternalToolsActions

__initExternalToolsActions()

Private slot to create actions for the configured external tools.

#### UserInterface.__initKdeDocActions

__initKdeDocActions()

Private slot to initilize the action to show the KDE4 documentation.

#### UserInterface.__initMenus

__initMenus()

Private slot to create the menus.

#### UserInterface.__initPySideDocActions

__initPySideDocActions()

Private slot to initilize the action to show the PySide documentation.

#### UserInterface.__initPythonDocAction

__initPythonDocAction()

Private slot to initilize the action to show the Python documentation.

#### UserInterface.__initQtDocActions

__initQtDocActions()

Private slot to initilize the action to show the Qt documentation.

#### UserInterface.__initStatusbar

__initStatusbar()

Private slot to set up the status bar.

#### UserInterface.__initToolbars

__initToolbars()

Private slot to create the toolbars.

#### UserInterface.__installPlugins

__installPlugins(pluginFileNames = QStringList())

Private slot to show a dialog to install a new plugin.

pluginFileNames
  list of plugin files suggested for installation (QStringList)

#### UserInterface.__lastEditorClosed

__lastEditorClosed()

Private slot to handle the lastEditorClosed signal.

#### UserInterface.__linguist

__linguist(fn = None, version = 0)

Private slot to start the Qt-Linguist executable.

fn
  filename of the translation file to be opened
version
  indication for the requested version (Qt 4) (integer)

#### UserInterface.__linguist4

__linguist4(fn = None)

Private slot to start the Qt-Linguist 4 executable.

fn
  filename of the translation file to be opened

#### UserInterface.__newProject

__newProject()

Private slot to handle the NewProject signal.

#### UserInterface.__newWindow

__newWindow()

Private slot to start a new instance of eric4.

#### UserInterface.__openMiniEditor

__openMiniEditor()

Private slot to show a mini editor window.

#### UserInterface.__openOnStartup

__openOnStartup(startupType = None)

Private method to open the last file, project or multiproject.

startupType
  type of startup requested (string, one of "Nothing", "File", "Project", "MultiProject" or "Session")

#### UserInterface.__pluginsConfigure

__pluginsConfigure()

Private slot to show the plugin manager configuration page.

#### UserInterface.__preferencesChanged

__preferencesChanged()

Private slot to handle a change of the preferences.

#### UserInterface.__processToolStderr

__processToolStderr()

Private slot to handle the readyReadStderr signal of a tool process.

#### UserInterface.__processToolStdout

__processToolStdout()

Private slot to handle the readyReadStdout signal of a tool process.

#### UserInterface.__programChange

__programChange(fn)

Private slot to handle the programChange signal.

This primarily is here to set the currentProg variable.

fn
  filename to be set as current prog (QString)

#### UserInterface.__projectClosed

__projectClosed()

Private slot to handle the projectClosed signal.

#### UserInterface.__projectOpened

__projectOpened()

Private slot to handle the projectOpened signal.

#### UserInterface.__proxyAuthenticationRequired

__proxyAuthenticationRequired(proxy, auth)

Private slot to handle a proxy authentication request.

proxy
  reference to the proxy object (QNetworkProxy)
auth
  reference to the authenticator object (QAuthenticator)

#### UserInterface.__quit

__quit()

Private method to quit the application.

#### UserInterface.__readSession

__readSession()

Private slot to read in the session file (.e4s)

#### UserInterface.__readTasks

__readTasks()

Private slot to read in the tasks file (.e4t)

#### UserInterface.__reloadAPIs

__reloadAPIs()

Private slot to reload the api information.

#### UserInterface.__reportBug

__reportBug()

Private slot to handle the Report Bug dialog.

#### UserInterface.__requestFeature

__requestFeature()

Private slot to handle the Feature Request dialog.

#### UserInterface.__restart

__restart()

Private method to restart the application.

#### UserInterface.__saveCurrentViewProfile

__saveCurrentViewProfile(save)

Private slot to save the window geometries of the active profile.

save
  flag indicating that the current profile should be saved (boolean)

#### UserInterface.__setEditProfile

__setEditProfile(save = True)

Private slot to activate the edit view profile.

save
  flag indicating that the current profile should be saved (boolean)

#### UserInterface.__setStyle

__setStyle()

Private slot to set the style of the interface.

#### UserInterface.__setWindowCaption

__setWindowCaption(editor = None, project = None)

Private method to set the caption of the Main Window.

editor
  filename to be displayed (string or QString)
project
  project name to be displayed (string or QString)

#### UserInterface.__setupDockWindow

__setupDockWindow(dock, where, widget, caption)

Private method to configure the dock window created with __createDockWindow().

dock
  the dock window (QDockWindow)
where
  dock area to be docked to (Qt.DockWidgetArea)
widget
  widget to be shown in the dock window (QWidget)
caption
  caption of the dock window (string or QString)

#### UserInterface.__showAvailableVersionInfos

__showAvailableVersionInfos(versions)

Private method to show the versions available for download.

versions
  contents of the downloaded versions file (list of strings)

#### UserInterface.__showEricDoc

__showEricDoc()

Private slot to show the Eric documentation.

#### UserInterface.__showExternalTools

__showExternalTools()

Private slot to display a dialog show a list of external tools used by eric4.

#### UserInterface.__showExtrasMenu

__showExtrasMenu()

Private slot to display the Extras menu.

#### UserInterface.__showFileMenu

__showFileMenu()

Private slot to display the File menu.

#### UserInterface.__showHelpMenu

__showHelpMenu()

Private slot to display the Help menu.

#### UserInterface.__showNext

__showNext()

Private slot used to show the next tab or file.

#### UserInterface.__showPixmap

__showPixmap(fn)

Private slot to show a pixmap in a dialog.

fn
  filename of the file to show (string or QString)

#### UserInterface.__showPluginInfo

__showPluginInfo()

Private slot to show the plugin info dialog.

#### UserInterface.__showPluginsAvailable

__showPluginsAvailable()

Private slot to show the plugins available for download.

#### UserInterface.__showPrevious

__showPrevious()

Private slot used to show the previous tab or file.

#### UserInterface.__showPyKDE4Doc

__showPyKDE4Doc()

Private slot to show the PyKDE4 documentation.

#### UserInterface.__showPyQt4Doc

__showPyQt4Doc()

Private slot to show the PyQt4 documentation.

#### UserInterface.__showPySideDoc

__showPySideDoc()

Private slot to show the PySide documentation.

#### UserInterface.__showPythonDoc

__showPythonDoc()

Private slot to show the Python documentation.

#### UserInterface.__showQt4Doc

__showQt4Doc()

Private slot to show the Qt4 documentation.

#### UserInterface.__showSvg

__showSvg(fn)

Private slot to show a SVG file in a dialog.

fn
  filename of the file to show (string or QString)

#### UserInterface.__showSystemEmailClient

__showSystemEmailClient(mode, attachFile = None, deleteAttachFile = False)

Private slot to show the system email dialog.

mode
  mode of the email dialog (string, "bug" or "feature")
attachFile
  name of a file to put into the body of the email (string or QString)
deleteAttachFile
  flag indicating to delete the file after it has been read (boolean)

#### UserInterface.__showToolGroupsMenu

__showToolGroupsMenu()

Private slot to display the Tool Groups menu.

#### UserInterface.__showToolbarsMenu

__showToolbarsMenu()

Private slot to display the Toolbars menu.

#### UserInterface.__showToolsMenu

__showToolsMenu()

Private slot to display the Tools menu.

#### UserInterface.__showVersions

__showVersions()

Private slot to handle the Versions dialog.

#### UserInterface.__showWindowMenu

__showWindowMenu()

Private slot to display the Window menu.

#### UserInterface.__showWizardsMenu

__showWizardsMenu()

Private slot to display the Wizards menu.

#### UserInterface.__shutdown

__shutdown()

Private method to perform all necessary steps to close down the IDE.

Returns:
  flag indicating success

#### UserInterface.__sqlBrowser

__sqlBrowser()

Private slot to start the SQL browser tool.

#### UserInterface.__sslErrors

__sslErrors(reply, errors)

Private slot to handle SSL errors.

reply
  reference to the reply object (QNetworkReply)
errors
  list of SSL errors (list of QSslError)

#### UserInterface.__startToolProcess

__startToolProcess(tool)

Private slot to start an external tool process.

tool
  list of tool entries

#### UserInterface.__startWebBrowser

__startWebBrowser()

Private slot to start the eric4 web browser.

#### UserInterface.__switchTab

__switchTab()

Private slot used to switch between the current and the previous current tab.

#### UserInterface.__toggleBottomSidebar

__toggleBottomSidebar()

Private slot to handle the toggle of the bottom sidebar window.

#### UserInterface.__toggleBrowser

__toggleBrowser()

Private slot to handle the toggle of the File Browser window.

#### UserInterface.__toggleDebugViewer

__toggleDebugViewer()

Private slot to handle the toggle of the debug viewer.

#### UserInterface.__toggleHorizontalToolbox

__toggleHorizontalToolbox()

Private slot to handle the toggle of the Horizontal Toolbox window.

#### UserInterface.__toggleLeftSidebar

__toggleLeftSidebar()

Private slot to handle the toggle of the left sidebar window.

#### UserInterface.__toggleLogViewer

__toggleLogViewer()

Private slot to handle the toggle of the Log Viewer window.

#### UserInterface.__toggleMultiProjectBrowser

__toggleMultiProjectBrowser()

Private slot to handle the toggle of the Project Browser window.

#### UserInterface.__toggleProjectBrowser

__toggleProjectBrowser()

Private slot to handle the toggle of the Project Browser window.

#### UserInterface.__toggleShell

__toggleShell()

Private slot to handle the toggle of the Shell window .

#### UserInterface.__toggleTaskViewer

__toggleTaskViewer()

Private slot to handle the toggle of the Task Viewer window.

#### UserInterface.__toggleTemplateViewer

__toggleTemplateViewer()

Private slot to handle the toggle of the Template Viewer window.

#### UserInterface.__toggleVerticalToolbox

__toggleVerticalToolbox()

Private slot to handle the toggle of the Vertical Toolbox window.

#### UserInterface.__toggleWindow

__toggleWindow(w)

Private method to toggle a workspace editor window.

w
  reference to the workspace editor window

Returns:
  flag indicating, if the window was shown (boolean)

#### UserInterface.__toolActionTriggered

__toolActionTriggered()

Private slot called by external tools toolbar actions.

#### UserInterface.__toolExecute

__toolExecute(act)

Private slot to execute a particular tool.

act
  reference to the action that was triggered (QAction)

#### UserInterface.__toolFinished

__toolFinished(exitCode, exitStatus)

Private slot to handle the finished signal of a tool process.

exitCode
  exit code of the process (integer)
exitStatus
  exit status of the process (QProcess.ExitStatus)

#### UserInterface.__toolGroupSelected

__toolGroupSelected(act)

Private slot to set the current tool group.

act
  reference to the action that was triggered (QAction)

#### UserInterface.__toolGroupsConfiguration

__toolGroupsConfiguration()

Private slot to handle the tool groups configuration menu entry.

#### UserInterface.__toolsConfiguration

__toolsConfiguration()

Private slot to handle the tools configuration menu entry.

#### UserInterface.__unittest

__unittest()

Private slot for displaying the unittest dialog.

#### UserInterface.__unittestProject

__unittestProject()

Private slot for displaying the unittest dialog and run the current project.

#### UserInterface.__unittestRestart

__unittestRestart()

Private slot to display the unittest dialog and rerun the last test.

#### UserInterface.__unittestScript

__unittestScript(prog = None)

Private slot for displaying the unittest dialog and run the current script.

prog
  the python program to be opened

#### UserInterface.__updateExternalToolsActions

__updateExternalToolsActions()

Private method to update the external tools actions for the current tool group.

#### UserInterface.__updateVersionsUrls

__updateVersionsUrls(versions)

Private method to update the URLs from which to retrieve the versions file.

versions
  contents of the downloaded versions file (list of strings)

#### UserInterface.__versionCheckResult

__versionCheckResult(versions)

Private method to show the result of the version check action.

versions
  contents of the downloaded versions file (list of strings)

#### UserInterface.__versionsDownloadCanceled

__versionsDownloadCanceled()

Private method called to cancel the version check.

#### UserInterface.__versionsDownloadDone

__versionsDownloadDone()

Private method called, after the versions file has been downloaded from the internet.

#### UserInterface.__webBrowser

__webBrowser(home = None)

Private slot to start a web browser executable.

home
  full pathname of a file to display (string or QString)

#### UserInterface.__whatsThis

__whatsThis()

Private slot called in to enter Whats This mode.

#### UserInterface.__writeSession

__writeSession()

Private slot to write the session data to an XML file (.e4s).

#### UserInterface.__writeTasks

__writeTasks()

Private slot to write the tasks data to an XML file (.e4t).

#### UserInterface.addE4Actions

addE4Actions(actions, type)

Public method to add actions to the list of actions.

type
  string denoting the action set to get. It must be one of "ui" or "wizards".
actions
  list of actions to be added (list of E4Action)

#### UserInterface.appendToStderr

appendToStderr(s)

Public slot to append text to the stderr log viewer tab.

s
  output to be appended (string or QString)

#### UserInterface.appendToStdout

appendToStdout(s)

Public slot to append text to the stdout log viewer tab.

s
  output to be appended (string or QString)

#### UserInterface.checkConfigurationStatus

checkConfigurationStatus()

Public method to check, if eric4 has been configured. If it is not, the configuration dialog is shown.

#### UserInterface.checkForErrorLog

checkForErrorLog()

Public method to check for the presence of an error log and ask the user, what to do with it.

#### UserInterface.checkProjectsWorkspace

checkProjectsWorkspace()

Public method to check, if a projects workspace has been configured. If it has not, a dialog is shown.

#### UserInterface.closeEvent

closeEvent(event)

Private event handler for the close event.

This event handler saves the preferences.

event
  close event (QCloseEvent)

#### UserInterface.dragEnterEvent

dragEnterEvent(event)

Protected method to handle the drag enter event.

event
  the drag enter event (QDragEnterEvent)

#### UserInterface.dragLeaveEvent

dragLeaveEvent(event)

Protected method to handle the drag leave event.

event
  the drag leave event (QDragLeaveEvent)

#### UserInterface.dragMoveEvent

dragMoveEvent(event)

Protected method to handle the drag move event.

event
  the drag move event (QDragMoveEvent)

#### UserInterface.dropEvent

dropEvent(event)

Protected method to handle the drop event.

event
  the drop event (QDropEvent)

#### UserInterface.getActions

getActions(type)

Public method to get a list of all actions.

type
  string denoting the action set to get. It must be one of "ui" or "wizards".

Returns:
  list of all actions (list of E4Action)

#### UserInterface.getLocale

getLocale()

Public method to get the locale of the IDE.

Returns:
  locale of the IDE (string or None)

#### UserInterface.getMenu

getMenu(name)

Public method to get a reference to a specific menu.

name
  name of the menu (string)

Returns:
  reference to the menu (QMenu)

#### UserInterface.getMenuAction

getMenuAction(menuName, actionName)

Public method to get a reference to an action of a menu.

menuName
  name of the menu to search in (string)
actionName
  object name of the action to search for (string or QString)

#### UserInterface.getMenuBarAction

getMenuBarAction(menuName)

Public method to get a reference to an action of the main menu.

menuName
  name of the menu to search in (string)

#### UserInterface.getToolBarIconSize

getToolBarIconSize()

Public method to get the toolbar icon size.

Returns:
  toolbar icon size (QSize)

#### UserInterface.getToolbar

getToolbar(name)

Public method to get a reference to a specific toolbar.

name
  name of the toolbar (string)

Returns:
  reference to the toolbar entry (tuple of QString and QToolBar)

#### UserInterface.getViewProfile

getViewProfile()

Public method to get the current view profile.

Returns:
  the name of the current view profile (string)

#### UserInterface.launchHelpViewer

launchHelpViewer(home, searchWord = None)

Public slot to start the help viewer.

home
  filename of file to be shown (string or QString)
searchWord=
  word to search for (string or QString)

#### UserInterface.performVersionCheck

performVersionCheck(manual = True, alternative = 0, showVersions = False)

Public method to check the internet for an eric4 update.

manual
  flag indicating an invocation via the menu (boolean)
alternative
  index of server to download from (integer)
showVersion=
  flag indicating the show versions mode (boolean)

#### UserInterface.processArgs

processArgs(args)

Public method to process the command line args passed to the UI.

args
  list of files to open
  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 .e3p, .e3pz, .e4p or .e4pz, then it is opened as a project file. If it ends in .e4m or .e4mz, it is opened as a multiproject.

#### UserInterface.registerToolbar

registerToolbar(name, text, toolbar)

Public method to register a toolbar.

This method must be called in order to make a toolbar manageable by the UserInterface object.

name
  name of the toolbar (string). This is used as the key into the dictionary of toolbar references.
text
  user visible text for the toolbar entry (QString)
toolbar
  reference to the toolbar to be registered (QToolBar)

Raises KeyError:
  raised, if a toolbar with the given name was already registered

#### UserInterface.removeE4Actions

removeE4Actions(actions, type = 'ui')

Public method to remove actions from the list of actions.

type
  string denoting the action set to get. It must be one of "ui" or "wizards".
actions
  list of actions (list of E4Action)

#### UserInterface.reregisterToolbar

reregisterToolbar(name, text)

Public method to change the visible text for the named toolbar.

name
  name of the toolbar to be changed (string)
text
  new user visible text for the toolbar entry (QString)

#### UserInterface.setDebugProfile

setDebugProfile(save = True)

Public slot to activate the debug view profile.

save
  flag indicating that the current profile should be saved (boolean)

#### UserInterface.showAvailableVersionsInfo

showAvailableVersionsInfo()

Public method to show the eric4 versions available for download.

#### UserInterface.showEmailDialog

showEmailDialog(mode, attachFile = None, deleteAttachFile = False)

Private slot to show the email dialog in a given mode.

mode
  mode of the email dialog (string, "bug" or "feature")
attachFile
  name of a file to attach to the email (string or QString)
deleteAttachFile
  flag indicating to delete the attached file after it has been sent (boolean)

#### UserInterface.showEvent

showEvent(evt)

Protected method to handle the show event.

evt
  reference to the show event (QShowEvent)

#### UserInterface.showLogTab

showLogTab(tabname)

Public method to show a particular Log-Viewer tab.

tabname
  string naming the tab to be shown (string)

#### UserInterface.showPreferences

showPreferences(pageName = None)

Public slot to set the preferences.

pageName
  name of the configuration page to show (string or QString)

#### UserInterface.unregisterToolbar

unregisterToolbar(name)

Public method to unregister a toolbar.

name
  name of the toolbar (string).

#### UserInterface.versionIsNewer

versionIsNewer(required, snapshot = None)

Public method to check, if the eric4 version is good compared to the required version.

required
  required version (string or QString)
snapshot
  required snapshot version (string or QString)

Returns:
  flag indicating, that the version is newer than the required one (boolean)

Up