diff -r 2fe91fe443dd -r 328f3ec4b77a src/eric7/Documentation/Source/eric7.UI.UserInterface.html
--- a/src/eric7/Documentation/Source/eric7.UI.UserInterface.html Thu Dec 21 15:46:22 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.UI.UserInterface.html Thu Dec 21 19:50:01 2023 +0100
@@ -126,7 +126,12 @@
<dt>Return:</dt>
<dd>
number of characters buffered or length of buffered line
- (integer)
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+int
</dd>
</dl>
<a NAME="Redirector.__nWrite" ID="Redirector.__nWrite"></a>
@@ -138,7 +143,7 @@
</p>
<dl>
-<dt><i>n</i></dt>
+<dt><i>n</i> (int)</dt>
<dd>
max number of bytes to write
</dd>
@@ -159,7 +164,7 @@
</p>
<dl>
-<dt><i>s</i></dt>
+<dt><i>s</i> (Any)</dt>
<dd>
data to be written (it must support the str-method)
</dd>
@@ -1213,9 +1218,9 @@
</p>
<dl>
-<dt><i>act</i></dt>
+<dt><i>act</i> (QAction)</dt>
<dd>
-reference to the action that was triggered (QAction)
+reference to the action that was triggered
</dd>
</dl>
<a NAME="UserInterface.__TBPopupMenuTriggered" ID="UserInterface.__TBPopupMenuTriggered"></a>
@@ -1228,9 +1233,9 @@
</p>
<dl>
-<dt><i>act</i></dt>
+<dt><i>act</i> (QAction)</dt>
<dd>
-reference to the action that was triggered (QAction)
+reference to the action that was triggered
</dd>
</dl>
<a NAME="UserInterface.__TRPreviewer" ID="UserInterface.__TRPreviewer"></a>
@@ -1242,15 +1247,13 @@
</p>
<dl>
-<dt><i>fileNames</i></dt>
+<dt><i>fileNames</i> (list of str)</dt>
<dd>
filenames of forms and/or translations to be previewed
- (list of strings)
</dd>
-<dt><i>ignore</i></dt>
+<dt><i>ignore</i> (bool)</dt>
<dd>
flag indicating non existing files should be ignored
- (boolean)
</dd>
</dl>
<a NAME="UserInterface.__UIPreviewer" ID="UserInterface.__UIPreviewer"></a>
@@ -1262,9 +1265,9 @@
</p>
<dl>
-<dt><i>fn</i></dt>
+<dt><i>fn</i> (str)</dt>
<dd>
-filename of the form to be previewed (string)
+filename of the form to be previewed
</dd>
</dl>
<a NAME="UserInterface.__activateBrowser" ID="UserInterface.__activateBrowser"></a>
@@ -1417,14 +1420,14 @@
</p>
<dl>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
<dd>
-name of the profile to be activated (string)
+name of the profile to be activated
</dd>
-<dt><i>save</i></dt>
+<dt><i>save</i> (bool)</dt>
<dd>
flag indicating that the current profile should
- be saved (boolean)
+ be saved
</dd>
</dl>
<a NAME="UserInterface.__activateViewmanager" ID="UserInterface.__activateViewmanager"></a>
@@ -1457,7 +1460,7 @@
</p>
<dl>
-<dt><i>editor</i></dt>
+<dt><i>editor</i> (Editor)</dt>
<dd>
editor window
</dd>
@@ -1471,9 +1474,9 @@
</p>
<dl>
-<dt><i>home</i></dt>
+<dt><i>home</i> (str)</dt>
<dd>
-full pathname of a file to display (string)
+full pathname of a file to display
</dd>
</dl>
<a NAME="UserInterface.__clearPrivateData" ID="UserInterface.__clearPrivateData"></a>
@@ -1569,15 +1572,21 @@
</p>
<dl>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
<dd>
-object name of the new dock window (string)
+object name of the new dock window
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-the generated dock window (QDockWindow)
+the generated dock window
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QDockWindow
</dd>
</dl>
<a NAME="UserInterface.__createLayout" ID="UserInterface.__createLayout"></a>
@@ -1631,9 +1640,9 @@
</p>
<dl>
-<dt><i>home</i></dt>
+<dt><i>home</i> (str)</dt>
<dd>
-full pathname of a file to display (string)
+full pathname of a file to display
</dd>
</dl>
<a NAME="UserInterface.__debuggingDone" ID="UserInterface.__debuggingDone"></a>
@@ -1701,9 +1710,9 @@
</p>
<dl>
-<dt><i>fn</i></dt>
+<dt><i>fn</i> (str)</dt>
<dd>
-filename of the opened editor (string)
+filename of the opened editor
</dd>
</dl>
<a NAME="UserInterface.__exportPreferences" ID="UserInterface.__exportPreferences"></a>
@@ -1736,9 +1745,9 @@
</p>
<dl>
-<dt><i>w</i></dt>
+<dt><i>w</i> (QWidget)</dt>
<dd>
-reference to the widget to be saved (QWidget)
+reference to the widget to be saved
</dd>
</dl>
<dl>
@@ -1747,6 +1756,12 @@
list giving the widget's geometry and its visibility
</dd>
</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of [int, int, int, int, bool]
+</dd>
+</dl>
<a NAME="UserInterface.__hasErrorLog" ID="UserInterface.__hasErrorLog"></a>
<h4>UserInterface.__hasErrorLog</h4>
<b>__hasErrorLog</b>(<i></i>)
@@ -1757,7 +1772,13 @@
<dl>
<dt>Return:</dt>
<dd>
-flag indicating the existence of an error log file (boolean)
+flag indicating the existence of an error log file
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="UserInterface.__helpViewer" ID="UserInterface.__helpViewer"></a>
@@ -1891,10 +1912,10 @@
</p>
<dl>
-<dt><i>pluginFileNames</i></dt>
+<dt><i>pluginFileNames</i> (list of str)</dt>
<dd>
list of plugin files suggested for
- installation list of strings
+ installation
</dd>
</dl>
<a NAME="UserInterface.__ircAutoConnected" ID="UserInterface.__ircAutoConnected"></a>
@@ -2039,9 +2060,9 @@
</p>
<dl>
-<dt><i>startupType</i></dt>
+<dt><i>startupType</i> (str)</dt>
<dd>
-type of startup requested (string, one of
+type of startup requested (one of
"Nothing", "File", "Project", "MultiProject" or "Session")
</dd>
</dl>
@@ -2102,9 +2123,9 @@
</p>
<dl>
-<dt><i>menu</i></dt>
+<dt><i>menu</i> (QMenu)</dt>
<dd>
-reference to the menu to be populated (QMenu)
+reference to the menu to be populated
</dd>
</dl>
<a NAME="UserInterface.__preferencesChanged" ID="UserInterface.__preferencesChanged"></a>
@@ -2140,9 +2161,9 @@
</p>
<dl>
-<dt><i>fn</i></dt>
+<dt><i>fn</i> (str)</dt>
<dd>
-filename to be set as current prog (string)
+filename to be set as current prog
</dd>
</dl>
<a NAME="UserInterface.__projectClosed" ID="UserInterface.__projectClosed"></a>
@@ -2278,10 +2299,10 @@
</p>
<dl>
-<dt><i>save</i></dt>
+<dt><i>save</i> (bool)</dt>
<dd>
flag indicating that the current profile should
- be saved (boolean)
+ be saved
</dd>
</dl>
<a NAME="UserInterface.__saveSessionToFile" ID="UserInterface.__saveSessionToFile"></a>
@@ -2300,10 +2321,10 @@
</p>
<dl>
-<dt><i>save</i></dt>
+<dt><i>save</i> (bool)</dt>
<dd>
flag indicating that the current profile should
- be saved (boolean)
+ be saved
</dd>
</dl>
<a NAME="UserInterface.__setWindowCaption" ID="UserInterface.__setWindowCaption"></a>
@@ -2315,13 +2336,13 @@
</p>
<dl>
-<dt><i>editor</i></dt>
+<dt><i>editor</i> (str)</dt>
<dd>
-filename to be displayed (string)
+filename to be displayed
</dd>
-<dt><i>project</i></dt>
+<dt><i>project</i> (str)</dt>
<dd>
-project name to be displayed (string)
+project name to be displayed
</dd>
</dl>
<a NAME="UserInterface.__setupDockWindow" ID="UserInterface.__setupDockWindow"></a>
@@ -2334,21 +2355,21 @@
</p>
<dl>
-<dt><i>dock</i></dt>
+<dt><i>dock</i> (QDockWindow)</dt>
<dd>
-the dock window (QDockWindow)
+the dock window
</dd>
-<dt><i>where</i></dt>
+<dt><i>where</i> (Qt.DockWidgetArea)</dt>
<dd>
-dock area to be docked to (Qt.DockWidgetArea)
+dock area to be docked to
</dd>
-<dt><i>widget</i></dt>
+<dt><i>widget</i> (QWidget)</dt>
<dd>
-widget to be shown in the dock window (QWidget)
+widget to be shown in the dock window
</dd>
-<dt><i>caption</i></dt>
+<dt><i>caption</i> (str)</dt>
<dd>
-caption of the dock window (string)
+caption of the dock window
</dd>
</dl>
<a NAME="UserInterface.__showCertificatesDialog" ID="UserInterface.__showCertificatesDialog"></a>
@@ -2530,9 +2551,9 @@
</p>
<dl>
-<dt><i>fn</i></dt>
+<dt><i>fn</i> (str)</dt>
<dd>
-filename of the file to show (string)
+filename of the file to show
</dd>
</dl>
<a NAME="UserInterface.__showSystemEmailClient" ID="UserInterface.__showSystemEmailClient"></a>
@@ -2544,19 +2565,19 @@
</p>
<dl>
-<dt><i>mode</i></dt>
+<dt><i>mode</i> (str)</dt>
<dd>
-mode of the email dialog (string, "bug" or "feature")
+mode of the email dialog ("bug" or "feature")
</dd>
-<dt><i>attachFile</i></dt>
+<dt><i>attachFile</i> (str)</dt>
<dd>
name of a file to put into the body of the
- email (string)
+ email
</dd>
-<dt><i>deleteAttachFile</i></dt>
+<dt><i>deleteAttachFile</i> (bool)</dt>
<dd>
flag indicating to delete the file after
- it has been read (boolean)
+ it has been read
</dd>
</dl>
<a NAME="UserInterface.__showToolGroupsMenu" ID="UserInterface.__showToolGroupsMenu"></a>
@@ -2657,13 +2678,13 @@
</p>
<dl>
-<dt><i>reply</i></dt>
+<dt><i>reply</i> (QNetworkReply)</dt>
<dd>
-reference to the reply object (QNetworkReply)
+reference to the reply object
</dd>
-<dt><i>errors</i></dt>
+<dt><i>errors</i> (list of QSslError)</dt>
<dd>
-list of SSL errors (list of QSslError)
+list of SSL errors
</dd>
</dl>
<a NAME="UserInterface.__startTestProject" ID="UserInterface.__startTestProject"></a>
@@ -2705,9 +2726,9 @@
</p>
<dl>
-<dt><i>tool</i></dt>
+<dt><i>tool</i> (dict)</dt>
<dd>
-list of tool entries
+dictionary of tool entries
</dd>
</dl>
<a NAME="UserInterface.__startWebBrowser" ID="UserInterface.__startWebBrowser"></a>
@@ -2783,7 +2804,7 @@
</p>
<dl>
-<dt><i>w</i></dt>
+<dt><i>w</i> (Editor)</dt>
<dd>
reference to the workspace editor window
</dd>
@@ -2791,7 +2812,13 @@
<dl>
<dt>Return:</dt>
<dd>
-flag indicating, if the window was shown (boolean)
+flag indicating, if the window was shown
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="UserInterface.__toolActionTriggered" ID="UserInterface.__toolActionTriggered"></a>
@@ -2817,9 +2844,9 @@
</p>
<dl>
-<dt><i>act</i></dt>
+<dt><i>act</i> (QAction)</dt>
<dd>
-reference to the action that was triggered (QAction)
+reference to the action that was triggered
</dd>
</dl>
<a NAME="UserInterface.__toolFinished" ID="UserInterface.__toolFinished"></a>
@@ -2831,13 +2858,13 @@
</p>
<dl>
-<dt><i>exitCode</i></dt>
+<dt><i>exitCode</i> (int)</dt>
<dd>
-exit code of the process (integer)
+exit code of the process
</dd>
-<dt><i>exitStatus</i></dt>
+<dt><i>exitStatus</i> (QProcess.ExitStatus)</dt>
<dd>
-exit status of the process (QProcess.ExitStatus)
+exit status of the process
</dd>
</dl>
<a NAME="UserInterface.__toolGroupSelected" ID="UserInterface.__toolGroupSelected"></a>
@@ -2849,9 +2876,9 @@
</p>
<dl>
-<dt><i>act</i></dt>
+<dt><i>act</i> (QAction)</dt>
<dd>
-reference to the action that was triggered (QAction)
+reference to the action that was triggered
</dd>
</dl>
<a NAME="UserInterface.__toolGroupsConfiguration" ID="UserInterface.__toolGroupsConfiguration"></a>
@@ -2885,9 +2912,9 @@
</p>
<dl>
-<dt><i>home</i></dt>
+<dt><i>home</i> (str)</dt>
<dd>
-full pathname of a file to display (string)
+full pathname of a file to display
</dd>
</dl>
<a NAME="UserInterface.__webBrowserFinished" ID="UserInterface.__webBrowserFinished"></a>
@@ -3006,11 +3033,11 @@
</p>
<dl>
-<dt><i>actions</i></dt>
+<dt><i>actions</i> (list of EricAction)</dt>
<dd>
-list of actions to be added (list of EricAction)
+list of actions to be added
</dd>
-<dt><i>actionType</i></dt>
+<dt><i>actionType</i> (str)</dt>
<dd>
string denoting the action set to add to.
It must be one of "ui" or "wizards".
@@ -3052,9 +3079,9 @@
</p>
<dl>
-<dt><i>s</i></dt>
+<dt><i>s</i> (str)</dt>
<dd>
-output to be appended (string)
+output to be appended
</dd>
</dl>
<a NAME="UserInterface.appendToStdout" ID="UserInterface.appendToStdout"></a>
@@ -3066,9 +3093,9 @@
</p>
<dl>
-<dt><i>s</i></dt>
+<dt><i>s</i> (str)</dt>
<dd>
-output to be appended (string)
+output to be appended
</dd>
</dl>
<a NAME="UserInterface.autoConnectIrc" ID="UserInterface.autoConnectIrc"></a>
@@ -3121,9 +3148,9 @@
</p>
<dl>
-<dt><i>event</i></dt>
+<dt><i>event</i> (QCloseEvent)</dt>
<dd>
-close event (QCloseEvent)
+close event
</dd>
</dl>
<a NAME="UserInterface.createPopupMenu" ID="UserInterface.createPopupMenu"></a>
@@ -3136,7 +3163,13 @@
<dl>
<dt>Return:</dt>
<dd>
-toolbars menu (QMenu)
+toolbars menu
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QMenu
</dd>
</dl>
<a NAME="UserInterface.documentationViewer" ID="UserInterface.documentationViewer"></a>
@@ -3167,9 +3200,9 @@
</p>
<dl>
-<dt><i>event</i></dt>
+<dt><i>event</i> (QDragEnterEvent)</dt>
<dd>
-the drag enter event (QDragEnterEvent)
+the drag enter event
</dd>
</dl>
<a NAME="UserInterface.dragLeaveEvent" ID="UserInterface.dragLeaveEvent"></a>
@@ -3181,9 +3214,9 @@
</p>
<dl>
-<dt><i>event</i></dt>
+<dt><i>event</i> (QDragLeaveEvent)</dt>
<dd>
-the drag leave event (QDragLeaveEvent)
+the drag leave event
</dd>
</dl>
<a NAME="UserInterface.dragMoveEvent" ID="UserInterface.dragMoveEvent"></a>
@@ -3195,9 +3228,9 @@
</p>
<dl>
-<dt><i>event</i></dt>
+<dt><i>event</i> (QDragMoveEvent)</dt>
<dd>
-the drag move event (QDragMoveEvent)
+the drag move event
</dd>
</dl>
<a NAME="UserInterface.dropEvent" ID="UserInterface.dropEvent"></a>
@@ -3209,9 +3242,9 @@
</p>
<dl>
-<dt><i>event</i></dt>
+<dt><i>event</i> (QDropEvent)</dt>
<dd>
-the drop event (QDropEvent)
+the drop event
</dd>
</dl>
<a NAME="UserInterface.getActions" ID="UserInterface.getActions"></a>
@@ -3223,7 +3256,7 @@
</p>
<dl>
-<dt><i>actionType</i></dt>
+<dt><i>actionType</i> (str)</dt>
<dd>
string denoting the action set to get.
It must be one of "ui" or "wizards".
@@ -3232,7 +3265,13 @@
<dl>
<dt>Return:</dt>
<dd>
-list of all actions (list of EricAction)
+list of all actions
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of EricAction
</dd>
</dl>
<a NAME="UserInterface.getLayoutType" ID="UserInterface.getLayoutType"></a>
@@ -3264,7 +3303,13 @@
<dl>
<dt>Return:</dt>
<dd>
-locale of the IDE (string or None)
+locale of the IDE
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<a NAME="UserInterface.getMenu" ID="UserInterface.getMenu"></a>
@@ -3276,15 +3321,21 @@
</p>
<dl>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
<dd>
-name of the menu (string)
+name of the menu
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-reference to the menu (QMenu)
+reference to the menu
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QMenu
</dd>
</dl>
<a NAME="UserInterface.getMenuAction" ID="UserInterface.getMenuAction"></a>
@@ -3296,20 +3347,25 @@
</p>
<dl>
-<dt><i>menuName</i></dt>
+<dt><i>menuName</i> (str)</dt>
<dd>
-name of the menu to search in (string)
+name of the menu to search in
</dd>
-<dt><i>actionName</i></dt>
+<dt><i>actionName</i> (str)</dt>
<dd>
object name of the action to search for
- (string)
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-reference to the menu action (QAction)
+reference to the menu action
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QAction
</dd>
</dl>
<a NAME="UserInterface.getMenuBarAction" ID="UserInterface.getMenuBarAction"></a>
@@ -3321,15 +3377,21 @@
</p>
<dl>
-<dt><i>menuName</i></dt>
+<dt><i>menuName</i> (str)</dt>
<dd>
-name of the menu to search in (string)
+name of the menu to search in
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-reference to the menu bar action (QAction)
+reference to the menu bar action
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QAction
</dd>
</dl>
<a NAME="UserInterface.getOriginalPathString" ID="UserInterface.getOriginalPathString"></a>
@@ -3361,15 +3423,21 @@
</p>
<dl>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
<dd>
-name of the toolbar (string)
+name of the toolbar
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-reference to the toolbar entry (tuple of string and QToolBar)
+reference to the toolbar entry
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (str, QToolBar)
</dd>
</dl>
<a NAME="UserInterface.getToolbarsByCategory" ID="UserInterface.getToolbarsByCategory"></a>
@@ -3409,7 +3477,13 @@
<dl>
<dt>Return:</dt>
<dd>
-the name of the current view profile (string)
+the name of the current view profile
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<a NAME="UserInterface.handleUrl" ID="UserInterface.handleUrl"></a>
@@ -3559,11 +3633,11 @@
</p>
<dl>
-<dt><i>actions</i></dt>
+<dt><i>actions</i> (list of EricActio)</dt>
<dd>
-list of actions (list of EricAction)
+list of actions
</dd>
-<dt><i>actionType</i></dt>
+<dt><i>actionType</i> (str)</dt>
<dd>
string denoting the action set to remove from.
It must be one of "ui" or "wizards".
@@ -3614,10 +3688,10 @@
</p>
<dl>
-<dt><i>save</i></dt>
+<dt><i>save</i> (bool)</dt>
<dd>
flag indicating that the current profile should
- be saved (boolean)
+ be saved
</dd>
</dl>
<a NAME="UserInterface.showEmailDialog" ID="UserInterface.showEmailDialog"></a>
@@ -3629,18 +3703,18 @@
</p>
<dl>
-<dt><i>mode</i></dt>
+<dt><i>mode</i> (str)</dt>
<dd>
-mode of the email dialog (string, "bug" or "feature")
+mode of the email dialog ("bug" or "feature")
</dd>
-<dt><i>attachFile</i></dt>
+<dt><i>attachFile</i> (str)</dt>
<dd>
-name of a file to attach to the email (string)
+name of a file to attach to the email
</dd>
-<dt><i>deleteAttachFile</i></dt>
+<dt><i>deleteAttachFile</i> (bool)</dt>
<dd>
flag indicating to delete the attached file
- after it has been sent (boolean)
+ after it has been sent
</dd>
</dl>
<a NAME="UserInterface.showEvent" ID="UserInterface.showEvent"></a>
@@ -3652,9 +3726,9 @@
</p>
<dl>
-<dt><i>evt</i></dt>
+<dt><i>evt</i> (QShowEvent)</dt>
<dd>
-reference to the show event (QShowEvent)
+reference to the show event
</dd>
</dl>
<a NAME="UserInterface.showFindFileByNameDialog" ID="UserInterface.showFindFileByNameDialog"></a>
@@ -3741,9 +3815,9 @@
</p>
<dl>
-<dt><i>pageName</i></dt>
+<dt><i>pageName</i> (str)</dt>
<dd>
-name of the configuration page to show (string)
+name of the configuration page to show
</dd>
</dl>
<a NAME="UserInterface.showReplaceFilesWidget" ID="UserInterface.showReplaceFilesWidget"></a>
@@ -3792,9 +3866,9 @@
</p>
<dl>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
<dd>
-name of the toolbar (string).
+name of the toolbar
</dd>
</dl>
<a NAME="UserInterface.upgradeEric" ID="UserInterface.upgradeEric"></a>
@@ -3865,20 +3939,25 @@
</p>
<dl>
-<dt><i>required</i></dt>
+<dt><i>required</i> (str)</dt>
<dd>
-required version (string)
+required version
</dd>
-<dt><i>snapshot</i></dt>
+<dt><i>snapshot</i> (str)</dt>
<dd>
-required snapshot version (string)
+required snapshot version
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-flag indicating, that the version is newer than the required
- one (boolean)
+flag indicating, that the version is newer than the required one
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
