eric6/Documentation/Source/eric6.Debugger.DebugUI.html

changeset 7887
c1588f5a83e9
parent 7707
6abcf4275d0e
child 7898
1bcd6d4df182
diff -r 3e4605cc3541 -r c1588f5a83e9 eric6/Documentation/Source/eric6.Debugger.DebugUI.html
--- a/eric6/Documentation/Source/eric6.Debugger.DebugUI.html	Thu Dec 17 14:30:46 2020 +0100
+++ b/eric6/Documentation/Source/eric6.Debugger.DebugUI.html	Thu Dec 17 14:40:06 2020 +0100
@@ -60,9 +60,10 @@
 emitted when the client program has terminated
         and the display of the termination dialog is suppressed
 </dd>
-<dt>clientStack(stack)</dt>
+<dt>clientStack(stack, debuggerId)</dt>
 <dd>
-emitted at breaking after a reported exception
+emitted at breaking after a reported
+        exception
 </dd>
 <dt>compileForms()</dt>
 <dd>
@@ -254,6 +255,10 @@
 <td>Private method to get the list of threads from the client.</td>
 </tr>
 <tr>
+<td><a href="#DebugUI.__lastClientExited">__lastClientExited</a></td>
+<td>Private slot handling the exit of the last client.</td>
+</tr>
+<tr>
 <td><a href="#DebugUI.__lastEditorClosed">__lastEditorClosed</a></td>
 <td>Private slot to handle the closeProgram signal.</td>
 </tr>
@@ -350,6 +355,14 @@
 <td>Public method to get a list of all actions.</td>
 </tr>
 <tr>
+<td><a href="#DebugUI.getDebuggerData">getDebuggerData</a></td>
+<td>Public method to refresh the debugging data of a specific debugger backend.</td>
+</tr>
+<tr>
+<td><a href="#DebugUI.getSelectedDebuggerId">getSelectedDebuggerId</a></td>
+<td>Public method to get the currently selected debugger ID.</td>
+</tr>
+<tr>
 <td><a href="#DebugUI.initActions">initActions</a></td>
 <td>Public method defining the user interface actions.</td>
 </tr>
@@ -374,6 +387,10 @@
 <td>Public slot to initialize the autoContinue flag.</td>
 </tr>
 <tr>
+<td><a href="#DebugUI.setDebugActionsEnabled">setDebugActionsEnabled</a></td>
+<td>Public method to set the enabled state of the debug actions.</td>
+</tr>
+<tr>
 <td><a href="#DebugUI.setEnvHistory">setEnvHistory</a></td>
 <td>Public slot to initialize the env history.</td>
 </tr>
@@ -390,6 +407,10 @@
 <td>Public slot to initialize the exception reporting flag.</td>
 </tr>
 <tr>
+<td><a href="#DebugUI.setMultiprocessNoDebugHistory">setMultiprocessNoDebugHistory</a></td>
+<td>Public slot to initialize the no debug list history.</td>
+</tr>
+<tr>
 <td><a href="#DebugUI.setTracePython">setTracePython</a></td>
 <td>Public slot to initialize the trace Python flag.</td>
 </tr>
@@ -398,6 +419,10 @@
 <td>Public slot to initialize the wd history.</td>
 </tr>
 <tr>
+<td><a href="#DebugUI.showNotification">showNotification</a></td>
+<td>Public method to show some notification message.</td>
+</tr>
+<tr>
 <td><a href="#DebugUI.shutdown">shutdown</a></td>
 <td>Public method to perform shutdown actions.</td>
 </tr>
@@ -483,53 +508,65 @@
 </p>
 <a NAME="DebugUI.__clientBreakConditionError" ID="DebugUI.__clientBreakConditionError"></a>
 <h4>DebugUI.__clientBreakConditionError</h4>
-<b>__clientBreakConditionError</b>(<i>filename, lineno</i>)
+<b>__clientBreakConditionError</b>(<i>filename, lineno, debuggerId</i>)
 
 <p>
         Private method to handle a condition error of a breakpoint.
 </p>
 <dl>
 
-<dt><i>filename</i></dt>
+<dt><i>filename</i> (str)</dt>
 <dd>
-filename of the breakpoint (string)
+filename of the breakpoint
 </dd>
-<dt><i>lineno</i></dt>
+<dt><i>lineno</i> (int)</dt>
 <dd>
-linenumber of the breakpoint (integer)
+line umber of the breakpoint
+</dd>
+<dt><i>debuggerId</i> (str)</dt>
+<dd>
+ID of the debugger backend
 </dd>
 </dl>
 <a NAME="DebugUI.__clientException" ID="DebugUI.__clientException"></a>
 <h4>DebugUI.__clientException</h4>
-<b>__clientException</b>(<i>exceptionType, exceptionMessage, stackTrace</i>)
+<b>__clientException</b>(<i>exceptionType, exceptionMessage, stackTrace, debuggerId</i>)
 
 <p>
         Private method to handle an exception of the debugged program.
 </p>
 <dl>
 
-<dt><i>exceptionType</i></dt>
+<dt><i>exceptionType</i> (str)</dt>
 <dd>
-type of exception raised (string)
+type of exception raised
 </dd>
-<dt><i>exceptionMessage</i></dt>
+<dt><i>exceptionMessage</i> ((str)</dt>
 <dd>
-message given by the exception (string)
+message given by the exception
 </dd>
-<dt><i>stackTrace</i></dt>
+<dt><i>stackTrace</i> (list of str)</dt>
 <dd>
-list of stack entries (list of string)
+list of stack entries
+</dd>
+<dt><i>debuggerId</i> (str)</dt>
+<dd>
+ID of the debugger backend
 </dd>
 </dl>
 <a NAME="DebugUI.__clientExit" ID="DebugUI.__clientExit"></a>
 <h4>DebugUI.__clientExit</h4>
-<b>__clientExit</b>(<i>status, message, quiet</i>)
+<b>__clientExit</b>(<i>program, status, message, quiet</i>)
 
 <p>
         Private method to handle the debugged program terminating.
 </p>
 <dl>
 
+<dt><i>program</i> (str)</dt>
+<dd>
+name of the exited program
+</dd>
 <dt><i>status</i> (int)</dt>
 <dd>
 exit code of the debugged program
@@ -559,29 +596,33 @@
 </dl>
 <a NAME="DebugUI.__clientLine" ID="DebugUI.__clientLine"></a>
 <h4>DebugUI.__clientLine</h4>
-<b>__clientLine</b>(<i>fn, line, forStack</i>)
+<b>__clientLine</b>(<i>fn, line, debuggerId, forStack</i>)
 
 <p>
         Private method to handle a change to the current line.
 </p>
 <dl>
 
-<dt><i>fn</i></dt>
+<dt><i>fn</i> (str)</dt>
 <dd>
-filename (string)
+filename
 </dd>
-<dt><i>line</i></dt>
+<dt><i>line</i> (int)</dt>
 <dd>
-linenumber (int)
+linenumber
 </dd>
-<dt><i>forStack</i></dt>
+<dt><i>debuggerId</i> (str)</dt>
 <dd>
-flag indicating this is for a stack dump (boolean)
+ID of the debugger backend
+</dd>
+<dt><i>forStack</i> (bool)</dt>
+<dd>
+flag indicating this is for a stack dump
 </dd>
 </dl>
 <a NAME="DebugUI.__clientSignal" ID="DebugUI.__clientSignal"></a>
 <h4>DebugUI.__clientSignal</h4>
-<b>__clientSignal</b>(<i>message, filename, lineNo, funcName, funcArgs</i>)
+<b>__clientSignal</b>(<i>message, filename, lineNo, funcName, funcArgs, debuggerId</i>)
 
 <p>
         Private method to handle a signal generated on the client side.
@@ -608,6 +649,10 @@
 <dd>
 function arguments
 </dd>
+<dt><i>debuggerId</i> (str)</dt>
+<dd>
+ID of the debugger backend
+</dd>
 </dl>
 <a NAME="DebugUI.__clientSyntaxError" ID="DebugUI.__clientSyntaxError"></a>
 <h4>DebugUI.__clientSyntaxError</h4>
@@ -639,14 +684,21 @@
 </dl>
 <a NAME="DebugUI.__clientThreadSet" ID="DebugUI.__clientThreadSet"></a>
 <h4>DebugUI.__clientThreadSet</h4>
-<b>__clientThreadSet</b>(<i></i>)
+<b>__clientThreadSet</b>(<i>debuggerId</i>)
 
 <p>
         Private method to handle a change of the client's current thread.
 </p>
+<dl>
+
+<dt><i>debuggerId</i> (str)</dt>
+<dd>
+ID of the debugger backend
+</dd>
+</dl>
 <a NAME="DebugUI.__clientVariable" ID="DebugUI.__clientVariable"></a>
 <h4>DebugUI.__clientVariable</h4>
-<b>__clientVariable</b>(<i>scope, variables</i>)
+<b>__clientVariable</b>(<i>scope, variables, debuggerId</i>)
 
 <p>
         Private method to write the contents of a clients classvariable to
@@ -654,38 +706,46 @@
 </p>
 <dl>
 
-<dt><i>scope</i></dt>
+<dt><i>scope</i> (int)</dt>
 <dd>
-scope of the variables (-1 = empty global, 1 = global,
+scope of the variables (-1 = empty locals, 1 = global,
             0 = local)
 </dd>
-<dt><i>variables</i></dt>
+<dt><i>variables</i> (list)</dt>
 <dd>
-the list of members of a classvariable from the client
+the list of variables from the client
+</dd>
+<dt><i>debuggerId</i> (str)</dt>
+<dd>
+ID of the debugger backend
 </dd>
 </dl>
 <a NAME="DebugUI.__clientVariables" ID="DebugUI.__clientVariables"></a>
 <h4>DebugUI.__clientVariables</h4>
-<b>__clientVariables</b>(<i>scope, variables</i>)
+<b>__clientVariables</b>(<i>scope, variables, debuggerId</i>)
 
 <p>
         Private method to write the clients variables to the user interface.
 </p>
 <dl>
 
-<dt><i>scope</i></dt>
+<dt><i>scope</i> (int)</dt>
 <dd>
-scope of the variables (-1 = empty global, 1 = global,
+scope of the variables (-1 = empty locals, 1 = global,
             0 = local)
 </dd>
-<dt><i>variables</i></dt>
+<dt><i>variables</i> (list)</dt>
 <dd>
 the list of variables from the client
 </dd>
+<dt><i>debuggerId</i> (str)</dt>
+<dd>
+ID of the debugger backend
+</dd>
 </dl>
 <a NAME="DebugUI.__clientWatchConditionError" ID="DebugUI.__clientWatchConditionError"></a>
 <h4>DebugUI.__clientWatchConditionError</h4>
-<b>__clientWatchConditionError</b>(<i>cond</i>)
+<b>__clientWatchConditionError</b>(<i>cond, debuggerId</i>)
 
 <p>
         Private method to handle a expression error of a watch expression.
@@ -695,9 +755,13 @@
 </p>
 <dl>
 
-<dt><i>cond</i></dt>
+<dt><i>cond</i> (str)</dt>
 <dd>
-expression of the watch expression (string)
+expression of the watch expression
+</dd>
+<dt><i>debuggerId</i> (str)</dt>
+<dd>
+ID of the debugger backend
 </dd>
 </dl>
 <a NAME="DebugUI.__compileChangedProjectFiles" ID="DebugUI.__compileChangedProjectFiles"></a>
@@ -731,11 +795,18 @@
 </p>
 <a NAME="DebugUI.__continue" ID="DebugUI.__continue"></a>
 <h4>DebugUI.__continue</h4>
-<b>__continue</b>(<i></i>)
+<b>__continue</b>(<i>debuggerId=""</i>)
 
 <p>
         Private method to handle the Continue action.
 </p>
+<dl>
+
+<dt><i>debuggerId</i> (str)</dt>
+<dd>
+ID of the debugger backend
+</dd>
+</dl>
 <a NAME="DebugUI.__coverageProject" ID="DebugUI.__coverageProject"></a>
 <h4>DebugUI.__coverageProject</h4>
 <b>__coverageProject</b>(<i></i>)
@@ -880,14 +951,21 @@
 </p>
 <a NAME="DebugUI.__getClientDisassembly" ID="DebugUI.__getClientDisassembly"></a>
 <h4>DebugUI.__getClientDisassembly</h4>
-<b>__getClientDisassembly</b>(<i></i>)
+<b>__getClientDisassembly</b>(<i>debuggerId</i>)
 
 <p>
         Private method to ask the client for the latest traceback disassembly.
 </p>
+<dl>
+
+<dt><i>debuggerId</i> (str)</dt>
+<dd>
+ID of the debugger backend
+</dd>
+</dl>
 <a NAME="DebugUI.__getClientVariables" ID="DebugUI.__getClientVariables"></a>
 <h4>DebugUI.__getClientVariables</h4>
-<b>__getClientVariables</b>(<i></i>)
+<b>__getClientVariables</b>(<i>debuggerId</i>)
 
 <p>
         Private method to request the global and local variables.
@@ -897,13 +975,34 @@
         Once these have been received, the local variables are requested.
         This happens in the method '__clientVariables'.
 </p>
+<dl>
+
+<dt><i>debuggerId</i> (str)</dt>
+<dd>
+ID of the debugger backend
+</dd>
+</dl>
 <a NAME="DebugUI.__getThreadList" ID="DebugUI.__getThreadList"></a>
 <h4>DebugUI.__getThreadList</h4>
-<b>__getThreadList</b>(<i></i>)
+<b>__getThreadList</b>(<i>debuggerId</i>)
 
 <p>
         Private method to get the list of threads from the client.
 </p>
+<dl>
+
+<dt><i>debuggerId</i> (str)</dt>
+<dd>
+ID of the debugger backend
+</dd>
+</dl>
+<a NAME="DebugUI.__lastClientExited" ID="DebugUI.__lastClientExited"></a>
+<h4>DebugUI.__lastClientExited</h4>
+<b>__lastClientExited</b>(<i></i>)
+
+<p>
+        Private slot handling the exit of the last client.
+</p>
 <a NAME="DebugUI.__lastEditorClosed" ID="DebugUI.__lastEditorClosed"></a>
 <h4>DebugUI.__lastEditorClosed</h4>
 <b>__lastEditorClosed</b>(<i></i>)
@@ -913,11 +1012,18 @@
 </p>
 <a NAME="DebugUI.__moveInstructionPointer" ID="DebugUI.__moveInstructionPointer"></a>
 <h4>DebugUI.__moveInstructionPointer</h4>
-<b>__moveInstructionPointer</b>(<i></i>)
+<b>__moveInstructionPointer</b>(<i>debuggerId=""</i>)
 
 <p>
         Private method to move the instruction pointer to a different line.
 </p>
+<dl>
+
+<dt><i>debuggerId</i> (str)</dt>
+<dd>
+ID of the debugger backend
+</dd>
+</dl>
 <a NAME="DebugUI.__nextBreakpoint" ID="DebugUI.__nextBreakpoint"></a>
 <h4>DebugUI.__nextBreakpoint</h4>
 <b>__nextBreakpoint</b>(<i></i>)
@@ -1001,11 +1107,18 @@
 </p>
 <a NAME="DebugUI.__runToCursor" ID="DebugUI.__runToCursor"></a>
 <h4>DebugUI.__runToCursor</h4>
-<b>__runToCursor</b>(<i></i>)
+<b>__runToCursor</b>(<i>debuggerId=""</i>)
 
 <p>
         Private method to handle the Run to Cursor action.
 </p>
+<dl>
+
+<dt><i>debuggerId</i> (str)</dt>
+<dd>
+ID of the debugger backend
+</dd>
+</dl>
 <a NAME="DebugUI.__showBreakpointsMenu" ID="DebugUI.__showBreakpointsMenu"></a>
 <h4>DebugUI.__showBreakpointsMenu</h4>
 <b>__showBreakpointsMenu</b>(<i></i>)
@@ -1022,39 +1135,74 @@
 </p>
 <a NAME="DebugUI.__specialContinue" ID="DebugUI.__specialContinue"></a>
 <h4>DebugUI.__specialContinue</h4>
-<b>__specialContinue</b>(<i></i>)
+<b>__specialContinue</b>(<i>debuggerId=""</i>)
 
 <p>
         Private method to handle the Special Continue action.
 </p>
+<dl>
+
+<dt><i>debuggerId</i> (str)</dt>
+<dd>
+ID of the debugger backend
+</dd>
+</dl>
 <a NAME="DebugUI.__step" ID="DebugUI.__step"></a>
 <h4>DebugUI.__step</h4>
-<b>__step</b>(<i></i>)
+<b>__step</b>(<i>debuggerId=""</i>)
 
 <p>
         Private method to handle the Step action.
 </p>
+<dl>
+
+<dt><i>debuggerId</i> (str)</dt>
+<dd>
+ID of the debugger backend
+</dd>
+</dl>
 <a NAME="DebugUI.__stepOut" ID="DebugUI.__stepOut"></a>
 <h4>DebugUI.__stepOut</h4>
-<b>__stepOut</b>(<i></i>)
+<b>__stepOut</b>(<i>debuggerId=""</i>)
 
 <p>
         Private method to handle the Step Out action.
 </p>
+<dl>
+
+<dt><i>debuggerId</i> (str)</dt>
+<dd>
+ID of the debugger backend
+</dd>
+</dl>
 <a NAME="DebugUI.__stepOver" ID="DebugUI.__stepOver"></a>
 <h4>DebugUI.__stepOver</h4>
-<b>__stepOver</b>(<i></i>)
+<b>__stepOver</b>(<i>debuggerId=""</i>)
 
 <p>
         Private method to handle the Step Over action.
 </p>
+<dl>
+
+<dt><i>debuggerId</i> (str)</dt>
+<dd>
+ID of the debugger backend
+</dd>
+</dl>
 <a NAME="DebugUI.__stepQuit" ID="DebugUI.__stepQuit"></a>
 <h4>DebugUI.__stepQuit</h4>
-<b>__stepQuit</b>(<i></i>)
+<b>__stepQuit</b>(<i>debuggerId=""</i>)
 
 <p>
         Private method to handle the Step Quit action.
 </p>
+<dl>
+
+<dt><i>debuggerId</i> (str)</dt>
+<dd>
+ID of the debugger backend
+</dd>
+</dl>
 <a NAME="DebugUI.__stopScript" ID="DebugUI.__stopScript"></a>
 <h4>DebugUI.__stopScript</h4>
 <b>__stopScript</b>(<i></i>)
@@ -1089,6 +1237,40 @@
 list of all actions (list of E5Action)
 </dd>
 </dl>
+<a NAME="DebugUI.getDebuggerData" ID="DebugUI.getDebuggerData"></a>
+<h4>DebugUI.getDebuggerData</h4>
+<b>getDebuggerData</b>(<i>debuggerId</i>)
+
+<p>
+        Public method to refresh the debugging data of a specific debugger
+        backend.
+</p>
+<dl>
+
+<dt><i>debuggerId</i> (str)</dt>
+<dd>
+ID of the debugger backend
+</dd>
+</dl>
+<a NAME="DebugUI.getSelectedDebuggerId" ID="DebugUI.getSelectedDebuggerId"></a>
+<h4>DebugUI.getSelectedDebuggerId</h4>
+<b>getSelectedDebuggerId</b>(<i></i>)
+
+<p>
+        Public method to get the currently selected debugger ID.
+</p>
+<dl>
+<dt>Returns:</dt>
+<dd>
+selected debugger ID
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
 <a NAME="DebugUI.initActions" ID="DebugUI.initActions"></a>
 <h4>DebugUI.initActions</h4>
 <b>initActions</b>(<i></i>)
@@ -1183,6 +1365,20 @@
             stop at the first executable line (boolean)
 </dd>
 </dl>
+<a NAME="DebugUI.setDebugActionsEnabled" ID="DebugUI.setDebugActionsEnabled"></a>
+<h4>DebugUI.setDebugActionsEnabled</h4>
+<b>setDebugActionsEnabled</b>(<i>enable</i>)
+
+<p>
+        Public method to set the enabled state of the debug actions.
+</p>
+<dl>
+
+<dt><i>enable</i> (bool)</dt>
+<dd>
+enable state to be set
+</dd>
+</dl>
 <a NAME="DebugUI.setEnvHistory" ID="DebugUI.setEnvHistory"></a>
 <h4>DebugUI.setEnvHistory</h4>
 <b>setEnvHistory</b>(<i>envStr, clearHistories=False, history=None</i>)
@@ -1248,6 +1444,29 @@
 flag indicating exception reporting status (boolean)
 </dd>
 </dl>
+<a NAME="DebugUI.setMultiprocessNoDebugHistory" ID="DebugUI.setMultiprocessNoDebugHistory"></a>
+<h4>DebugUI.setMultiprocessNoDebugHistory</h4>
+<b>setMultiprocessNoDebugHistory</b>(<i>noDebugList, clearHistories=False, history=None</i>)
+
+<p>
+        Public slot to initialize the no debug list history.
+</p>
+<dl>
+
+<dt><i>noDebugList</i> (str)</dt>
+<dd>
+whitespace separated list of progframs not to be
+            debugged
+</dd>
+<dt><i>clearHistories</i> (bool)</dt>
+<dd>
+flag indicating, that the list should be cleared
+</dd>
+<dt><i>history</i> (list of str)</dt>
+<dd>
+list of history entries to be set
+</dd>
+</dl>
 <a NAME="DebugUI.setTracePython" ID="DebugUI.setTracePython"></a>
 <h4>DebugUI.setTracePython</h4>
 <b>setTracePython</b>(<i>tracePython</i>)
@@ -1286,6 +1505,20 @@
 list of history entries to be set (list of strings)
 </dd>
 </dl>
+<a NAME="DebugUI.showNotification" ID="DebugUI.showNotification"></a>
+<h4>DebugUI.showNotification</h4>
+<b>showNotification</b>(<i>notification</i>)
+
+<p>
+        Public method to show some notification message.
+</p>
+<dl>
+
+<dt><i>notification</i> (str)</dt>
+<dd>
+meessage to be shown
+</dd>
+</dl>
 <a NAME="DebugUI.shutdown" ID="DebugUI.shutdown"></a>
 <h4>DebugUI.shutdown</h4>
 <b>shutdown</b>(<i></i>)
@@ -1326,7 +1559,13 @@
 <dl>
 <dt>Returns:</dt>
 <dd>
-filters list (list of integers)
+filters list
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>

eric ide

mercurial