Mercurial Repositories > eric / file diff

--- a/src/eric7/Documentation/Source/eric7.Debugger.DebugUI.html	Sat Dec 16 17:52:02 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.Debugger.DebugUI.html	Sun Dec 17 17:15:19 2023 +0100
@@ -459,23 +459,23 @@
 </p>
 <dl>
 
-<dt><i>ui</i></dt>
+<dt><i>ui</i> (UserInterface)</dt>
 <dd>
 reference to the main UI
 </dd>
-<dt><i>vm</i></dt>
+<dt><i>vm</i> (ViewManager)</dt>
 <dd>
 reference to the viewmanager
 </dd>
-<dt><i>debugServer</i></dt>
+<dt><i>debugServer</i> (DebugServer)</dt>
 <dd>
 reference to the debug server
 </dd>
-<dt><i>debugViewer</i></dt>
+<dt><i>debugViewer</i> (DebugViewer)</dt>
 <dd>
 reference to the debug viewer widget
 </dd>
-<dt><i>project</i></dt>
+<dt><i>project</i> (Project)</dt>
 <dd>
 reference to the project object
 </dd>
@@ -507,9 +507,9 @@
 </p>
 <dl>
 
-<dt><i>act</i></dt>
+<dt><i>act</i> (QAction)</dt>
 <dd>
-reference to the action that triggered (QAction)
+reference to the action that triggered
 </dd>
 </dl>
 <a NAME="DebugUI.__checkActions" ID="DebugUI.__checkActions"></a>
@@ -521,7 +521,7 @@
 </p>
 <dl>
 
-<dt><i>editor</i></dt>
+<dt><i>editor</i> (Editor)</dt>
 <dd>
 editor window
 </dd>
@@ -649,7 +649,7 @@
 </p>
 <dl>
 
-<dt><i>unplanned</i></dt>
+<dt><i>unplanned</i> (bool)</dt>
 <dd>
 True if the client died, False otherwise
 </dd>
@@ -727,23 +727,21 @@
 </p>
 <dl>
 
-<dt><i>message</i></dt>
+<dt><i>message</i> (str)</dt>
 <dd>
-message of the syntax error (string)
+message of the syntax error
 </dd>
-<dt><i>filename</i></dt>
+<dt><i>filename</i> (str)</dt>
 <dd>
 translated filename of the syntax error position
-            (string)
 </dd>
-<dt><i>lineNo</i></dt>
+<dt><i>lineNo</i> (int)</dt>
 <dd>
-line number of the syntax error position (integer)
+line number of the syntax error position
 </dd>
-<dt><i>characterNo</i></dt>
+<dt><i>characterNo</i> (int)</dt>
 <dd>
 character number of the syntax error position
-            (integer)
 </dd>
 </dl>
 <a NAME="DebugUI.__clientThreadSet" ID="DebugUI.__clientThreadSet"></a>
@@ -886,7 +884,7 @@
 </p>
 <dl>
 
-<dt><i>editor</i></dt>
+<dt><i>editor</i> (Editor)</dt>
 <dd>
 editor window
 </dd>
@@ -929,7 +927,7 @@
 </p>
 <dl>
 
-<dt><i>fn</i></dt>
+<dt><i>fn</i> (str)</dt>
 <dd>
 filename of the opened editor
 </dd>
@@ -1036,13 +1034,13 @@
 </p>
 <dl>
 
-<dt><i>fn</i></dt>
+<dt><i>fn</i> (str)</dt>
 <dd>
 filename of the debugged script
 </dd>
-<dt><i>exc</i></dt>
+<dt><i>exc</i> (bool)</dt>
 <dd>
-flag to enable exception reporting of the IDE (boolean)
+flag to enable exception reporting of the IDE
 </dd>
 </dl>
 <a NAME="DebugUI.__previousBreakpoint" ID="DebugUI.__previousBreakpoint"></a>
@@ -1266,10 +1264,9 @@
 <dd>
 working directory for the script
 </dd>
-<dt><i>environment</i> (str)</dt>
+<dt><i>environment</i> (str or dict)</dt>
 <dd>
-string defining the additional or changed environment
-            variables
+environment parameter override for the debug run
 </dd>
 <dt><i>clientType</i> (str)</dt>
 <dd>
@@ -1366,7 +1363,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="DebugUI.getProjectEnvironmentString" ID="DebugUI.getProjectEnvironmentString"></a>
@@ -1427,6 +1430,12 @@
 the generated menu
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QMenu
+</dd>
+</dl>
 <a NAME="DebugUI.initToolbars" ID="DebugUI.initToolbars"></a>
 <h4>DebugUI.initToolbars</h4>
 <b>initToolbars</b>(<i>toolbarManager</i>)
@@ -1436,16 +1445,21 @@
 </p>
 <dl>
 
-<dt><i>toolbarManager</i></dt>
+<dt><i>toolbarManager</i> (EricToolBarManager)</dt>
 <dd>
 reference to a toolbar manager object
-            (EricToolBarManager)
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-the generated toolbars (list of QToolBar)
+the generated toolbars
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of QToolBar
 </dd>
 </dl>
 <a NAME="DebugUI.setArgvHistory" ID="DebugUI.setArgvHistory"></a>
@@ -1457,18 +1471,17 @@
 </p>
 <dl>
 
-<dt><i>argsStr</i></dt>
+<dt><i>argsStr</i> (str)</dt>
 <dd>
-the commandline arguments (string)
+command line arguments
 </dd>
-<dt><i>clearHistories</i></dt>
+<dt><i>clearHistories</i> (bool)</dt>
 <dd>
-flag indicating, that the list should
-            be cleared (boolean)
+flag indicating, that the list should be cleared
 </dd>
-<dt><i>history</i></dt>
+<dt><i>history</i> (list of str)</dt>
 <dd>
-list of history entries to be set (list of strings)
+list of history entries to be set
 </dd>
 </dl>
 <a NAME="DebugUI.setAutoClearShell" ID="DebugUI.setAutoClearShell"></a>
@@ -1480,10 +1493,10 @@
 </p>
 <dl>
 
-<dt><i>autoClearShell</i></dt>
+<dt><i>autoClearShell</i> (bool)</dt>
 <dd>
 flag indicating, that the interpreter window
-            should be cleared (boolean)
+            should be cleared
 </dd>
 </dl>
 <a NAME="DebugUI.setAutoContinue" ID="DebugUI.setAutoContinue"></a>
@@ -1495,10 +1508,10 @@
 </p>
 <dl>
 
-<dt><i>autoContinue</i></dt>
+<dt><i>autoContinue</i> (bool)</dt>
 <dd>
 flag indicating, that the debugger should not
-            stop at the first executable line (boolean)
+            stop at the first executable line
 </dd>
 </dl>
 <a NAME="DebugUI.setDebugActionsEnabled" ID="DebugUI.setDebugActionsEnabled"></a>
@@ -1555,18 +1568,17 @@
 </p>
 <dl>
 
-<dt><i>envStr</i></dt>
+<dt><i>envStr</i> (str)</dt>
 <dd>
-the environment settings (string)
+the environment settings
 </dd>
-<dt><i>clearHistories</i></dt>
+<dt><i>clearHistories</i> (bool)</dt>
 <dd>
-flag indicating, that the list should
-            be cleared (boolean)
+flag indicating, that the list should be cleared
 </dd>
-<dt><i>history</i></dt>
+<dt><i>history</i> (list of str)</dt>
 <dd>
-list of history entries to be set (list of strings)
+list of history entries to be set
 </dd>
 </dl>
 <a NAME="DebugUI.setExcIgnoreList" ID="DebugUI.setExcIgnoreList"></a>
@@ -1578,9 +1590,9 @@
 </p>
 <dl>
 
-<dt><i>excIgnoreList</i></dt>
+<dt><i>excIgnoreList</i> (list of str)</dt>
 <dd>
-list of ignored exception types (list of strings)
+list of ignored exception types
 </dd>
 </dl>
 <a NAME="DebugUI.setExcList" ID="DebugUI.setExcList"></a>
@@ -1592,9 +1604,9 @@
 </p>
 <dl>
 
-<dt><i>excList</i></dt>
+<dt><i>excList</i> (list of str)</dt>
 <dd>
-list of exception types (list of strings)
+list of exception types
 </dd>
 </dl>
 <a NAME="DebugUI.setExceptionReporting" ID="DebugUI.setExceptionReporting"></a>
@@ -1666,10 +1678,10 @@
 </p>
 <dl>
 
-<dt><i>tracePython</i></dt>
+<dt><i>tracePython</i> (bool)</dt>
 <dd>
 flag indicating if the Python library should be
-            traced as well (boolean)
+            traced as well
 </dd>
 </dl>
 <a NAME="DebugUI.setWdHistory" ID="DebugUI.setWdHistory"></a>
@@ -1681,18 +1693,17 @@
 </p>
 <dl>
 
-<dt><i>wdStr</i></dt>
+<dt><i>wdStr</i> (str)</dt>
 <dd>
-the working directory (string)
+working directory
 </dd>
-<dt><i>clearHistories</i></dt>
+<dt><i>clearHistories</i> (bool)</dt>
 <dd>
-flag indicating, that the list should
-            be cleared (boolean)
+flag indicating, that the list should be cleared
 </dd>
-<dt><i>history</i></dt>
+<dt><i>history</i> (list of str)</dt>
 <dd>
-list of history entries to be set (list of strings)
+list of history entries to be set
 </dd>
 </dl>
 <a NAME="DebugUI.showNotification" ID="DebugUI.showNotification"></a>
@@ -1741,6 +1752,12 @@
 always true
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
 <a NAME="DebugUI.variablesFilter" ID="DebugUI.variablesFilter"></a>
 <h4>DebugUI.variablesFilter</h4>
 <b>variablesFilter</b>(<i>scope</i>)
@@ -1750,7 +1767,7 @@
 </p>
 <dl>
 
-<dt><i>scope</i></dt>
+<dt><i>scope</i> (bool)</dt>
 <dd>
 flag indicating global (True) or local (False) scope
 </dd>