--- a/src/eric7/Documentation/Source/eric7.Debugger.DebugViewer.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.Debugger.DebugViewer.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,7 +7,6 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Debugger.DebugViewer</h1>
-
<p>
Module implementing a widget containing various debug related views.
</p>
@@ -26,30 +25,29 @@
<li>viewer for a code disassembly for an exception<li>
</ul>
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#DebugViewer">DebugViewer</a></td>
<td>Class implementing a widget containing various debug related views.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="DebugViewer" ID="DebugViewer"></a>
<h2>DebugViewer</h2>
-
<p>
Class implementing a widget containing various debug related views.
</p>
@@ -59,6 +57,7 @@
(global and local), a breakpoint viewer, a watch expression viewer and
the exception logger. Additionally a list of all threads is shown.
</p>
+
<h3>Signals</h3>
<dl>
@@ -74,19 +73,20 @@
<h3>Derived from</h3>
QWidget
<h3>Class Attributes</h3>
+<table>
+<tr><td>DebuggerStateRole</td></tr>
+<tr><td>StateIcon</td></tr>
+<tr><td>StateMessage</td></tr>
+<tr><td>ThreadIdRole</td></tr>
+</table>
-<table>
-<tr><td>DebuggerStateRole</td></tr><tr><td>StateIcon</td></tr><tr><td>StateMessage</td></tr><tr><td>ThreadIdRole</td></tr>
-</table>
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#DebugViewer.__init__">DebugViewer</a></td>
<td>Constructor</td>
@@ -236,19 +236,20 @@
<td>Public method to make a variables tab visible.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="DebugViewer.__init__" ID="DebugViewer.__init__"></a>
<h4>DebugViewer (Constructor)</h4>
<b>DebugViewer</b>(<i>debugServer, parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>debugServer</i> (DebugServer)</dt>
@@ -263,10 +264,10 @@
<a NAME="DebugViewer.__addThreadList" ID="DebugViewer.__addThreadList"></a>
<h4>DebugViewer.__addThreadList</h4>
<b>__addThreadList</b>(<i>currentID, threadList, debuggerId</i>)
-
<p>
Private method to add the list of threads to a debugger entry.
</p>
+
<dl>
<dt><i>currentID</i> (int)</dt>
@@ -285,11 +286,11 @@
<a NAME="DebugViewer.__callStackFrameSelected" ID="DebugViewer.__callStackFrameSelected"></a>
<h4>DebugViewer.__callStackFrameSelected</h4>
<b>__callStackFrameSelected</b>(<i>frameNo</i>)
-
<p>
Private slot to handle the selection of a call stack entry of the
call stack viewer.
</p>
+
<dl>
<dt><i>frameNo</i> (int)</dt>
@@ -300,10 +301,10 @@
<a NAME="DebugViewer.__clearStackComboBox" ID="DebugViewer.__clearStackComboBox"></a>
<h4>DebugViewer.__clearStackComboBox</h4>
<b>__clearStackComboBox</b>(<i>comboBox</i>)
-
<p>
Private method to clear the given stack combo box.
</p>
+
<dl>
<dt><i>comboBox</i> (QComboBox)</dt>
@@ -314,10 +315,10 @@
<a NAME="DebugViewer.__clientDebuggerId" ID="DebugViewer.__clientDebuggerId"></a>
<h4>DebugViewer.__clientDebuggerId</h4>
<b>__clientDebuggerId</b>(<i>debuggerId</i>)
-
<p>
Private slot to receive the ID of a newly connected debugger backend.
</p>
+
<dl>
<dt><i>debuggerId</i> (str)</dt>
@@ -328,10 +329,10 @@
<a NAME="DebugViewer.__clientException" ID="DebugViewer.__clientException"></a>
<h4>DebugViewer.__clientException</h4>
<b>__clientException</b>(<i>exceptionType, exceptionMessage, stackTrace, debuggerId, threadName, </i>)
-
<p>
Private method to handle an exception of the debugged program.
</p>
+
<dl>
<dt><i>exceptionType</i> (str)</dt>
@@ -358,10 +359,10 @@
<a NAME="DebugViewer.__clientExit" ID="DebugViewer.__clientExit"></a>
<h4>DebugViewer.__clientExit</h4>
<b>__clientExit</b>(<i>program, status, message, quiet, debuggerId</i>)
-
<p>
Private method to handle the debugged program terminating.
</p>
+
<dl>
<dt><i>program</i> (str)</dt>
@@ -388,10 +389,10 @@
<a NAME="DebugViewer.__clientLine" ID="DebugViewer.__clientLine"></a>
<h4>DebugViewer.__clientLine</h4>
<b>__clientLine</b>(<i>fn, line, debuggerId, threadName</i>)
-
<p>
Private method to handle a change to the current line.
</p>
+
<dl>
<dt><i>fn</i> (str)</dt>
@@ -414,10 +415,10 @@
<a NAME="DebugViewer.__clientSyntaxError" ID="DebugViewer.__clientSyntaxError"></a>
<h4>DebugViewer.__clientSyntaxError</h4>
<b>__clientSyntaxError</b>(<i>message, filename, lineNo, characterNo, debuggerId, threadName, </i>)
-
<p>
Private method to handle a syntax error in the debugged program.
</p>
+
<dl>
<dt><i>message</i> (str)</dt>
@@ -448,11 +449,11 @@
<a NAME="DebugViewer.__debuggerSelected" ID="DebugViewer.__debuggerSelected"></a>
<h4>DebugViewer.__debuggerSelected</h4>
<b>__debuggerSelected</b>(<i>current, previous</i>)
-
<p>
Private slot to handle the selection of a debugger backend in the
debuggers list.
</p>
+
<dl>
<dt><i>current</i> (QTreeWidgetItem)</dt>
@@ -467,10 +468,10 @@
<a NAME="DebugViewer.__frameSelected" ID="DebugViewer.__frameSelected"></a>
<h4>DebugViewer.__frameSelected</h4>
<b>__frameSelected</b>(<i>frmnr</i>)
-
<p>
Private slot to handle the selection of a new stack frame number.
</p>
+
<dl>
<dt><i>frmnr</i> (int)</dt>
@@ -481,10 +482,10 @@
<a NAME="DebugViewer.__removeDebugger" ID="DebugViewer.__removeDebugger"></a>
<h4>DebugViewer.__removeDebugger</h4>
<b>__removeDebugger</b>(<i>debuggerId</i>)
-
<p>
Private method to remove a debugger given its ID.
</p>
+
<dl>
<dt><i>debuggerId</i> (str)</dt>
@@ -495,10 +496,10 @@
<a NAME="DebugViewer.__setCurrentDebugger" ID="DebugViewer.__setCurrentDebugger"></a>
<h4>DebugViewer.__setCurrentDebugger</h4>
<b>__setCurrentDebugger</b>(<i>debuggerId</i>)
-
<p>
Private method to set the current debugger based on the given ID.
</p>
+
<dl>
<dt><i>debuggerId</i> (str)</dt>
@@ -509,10 +510,10 @@
<a NAME="DebugViewer.__setDebuggerIconAndState" ID="DebugViewer.__setDebuggerIconAndState"></a>
<h4>DebugViewer.__setDebuggerIconAndState</h4>
<b>__setDebuggerIconAndState</b>(<i>debuggerId, state</i>)
-
<p>
Private method to set the icon for a specific debugger ID.
</p>
+
<dl>
<dt><i>debuggerId</i> (str)</dt>
@@ -528,11 +529,11 @@
<a NAME="DebugViewer.__setThreadIconAndState" ID="DebugViewer.__setThreadIconAndState"></a>
<h4>DebugViewer.__setThreadIconAndState</h4>
<b>__setThreadIconAndState</b>(<i>debuggerId, threadName, state</i>)
-
<p>
Private method to set the icon for a specific thread name and
debugger ID.
</p>
+
<dl>
<dt><i>debuggerId</i> (str)</dt>
@@ -552,25 +553,25 @@
<a NAME="DebugViewer.__showSource" ID="DebugViewer.__showSource"></a>
<h4>DebugViewer.__showSource</h4>
<b>__showSource</b>(<i></i>)
-
<p>
Private slot to handle the source button press to show the selected
file.
</p>
+
<a NAME="DebugViewer.clearCallTrace" ID="DebugViewer.clearCallTrace"></a>
<h4>DebugViewer.clearCallTrace</h4>
<b>clearCallTrace</b>(<i></i>)
-
<p>
Public method to clear the recorded call trace.
</p>
+
<a NAME="DebugViewer.currentWidget" ID="DebugViewer.currentWidget"></a>
<h4>DebugViewer.currentWidget</h4>
<b>currentWidget</b>(<i></i>)
-
<p>
Public method to get a reference to the current widget.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -586,10 +587,10 @@
<a NAME="DebugViewer.getSelectedDebuggerId" ID="DebugViewer.getSelectedDebuggerId"></a>
<h4>DebugViewer.getSelectedDebuggerId</h4>
<b>getSelectedDebuggerId</b>(<i></i>)
-
<p>
Public method to get the currently selected debugger ID.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -605,10 +606,10 @@
<a NAME="DebugViewer.getSelectedDebuggerState" ID="DebugViewer.getSelectedDebuggerState"></a>
<h4>DebugViewer.getSelectedDebuggerState</h4>
<b>getSelectedDebuggerState</b>(<i></i>)
-
<p>
Public method to get the currently selected debugger's state.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -624,10 +625,10 @@
<a NAME="DebugViewer.handleClientStack" ID="DebugViewer.handleClientStack"></a>
<h4>DebugViewer.handleClientStack</h4>
<b>handleClientStack</b>(<i>stack, debuggerId</i>)
-
<p>
Public slot to show the call stack of the program being debugged.
</p>
+
<dl>
<dt><i>stack</i> (list of tuples of (str, str, str, str))</dt>
@@ -643,27 +644,27 @@
<a NAME="DebugViewer.handleDebuggingStarted" ID="DebugViewer.handleDebuggingStarted"></a>
<h4>DebugViewer.handleDebuggingStarted</h4>
<b>handleDebuggingStarted</b>(<i></i>)
-
<p>
Public slot to handle the start of a debugging session.
</p>
<p>
This slot sets the variables filter expressions.
</p>
+
<a NAME="DebugViewer.handlePreferencesChanged" ID="DebugViewer.handlePreferencesChanged"></a>
<h4>DebugViewer.handlePreferencesChanged</h4>
<b>handlePreferencesChanged</b>(<i></i>)
-
<p>
Public slot to handle the preferencesChanged signal.
</p>
+
<a NAME="DebugViewer.handleResetUI" ID="DebugViewer.handleResetUI"></a>
<h4>DebugViewer.handleResetUI</h4>
<b>handleResetUI</b>(<i>fullReset</i>)
-
<p>
Public method to reset the viewer.
</p>
+
<dl>
<dt><i>fullReset</i> (bool)</dt>
@@ -674,10 +675,10 @@
<a NAME="DebugViewer.initCallStackViewer" ID="DebugViewer.initCallStackViewer"></a>
<h4>DebugViewer.initCallStackViewer</h4>
<b>initCallStackViewer</b>(<i>projectMode</i>)
-
<p>
Public method to initialize the call stack viewer.
</p>
+
<dl>
<dt><i>projectMode</i> (bool)</dt>
@@ -688,10 +689,10 @@
<a NAME="DebugViewer.isCallTraceEnabled" ID="DebugViewer.isCallTraceEnabled"></a>
<h4>DebugViewer.isCallTraceEnabled</h4>
<b>isCallTraceEnabled</b>(<i></i>)
-
<p>
Public method to get the state of the call trace function.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -707,10 +708,10 @@
<a NAME="DebugViewer.isOnlyDebugger" ID="DebugViewer.isOnlyDebugger"></a>
<h4>DebugViewer.isOnlyDebugger</h4>
<b>isOnlyDebugger</b>(<i></i>)
-
<p>
Public method to test, if only one debugger is connected.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -726,14 +727,13 @@
<a NAME="DebugViewer.refreshVariablesLists" ID="DebugViewer.refreshVariablesLists"></a>
<h4>DebugViewer.refreshVariablesLists</h4>
<b>refreshVariablesLists</b>(<i></i>)
-
<p>
Public slot to refresh the local and global variables lists.
</p>
+
<a NAME="DebugViewer.setCallTraceToProjectMode" ID="DebugViewer.setCallTraceToProjectMode"></a>
<h4>DebugViewer.setCallTraceToProjectMode</h4>
<b>setCallTraceToProjectMode</b>(<i>enabled</i>)
-
<p>
Public slot to set the call trace viewer to project mode.
</p>
@@ -741,6 +741,7 @@
In project mode the call trace info is shown with project relative
path names.
</p>
+
<dl>
<dt><i>enabled</i> (bool)</dt>
@@ -751,10 +752,10 @@
<a NAME="DebugViewer.setCurrentWidget" ID="DebugViewer.setCurrentWidget"></a>
<h4>DebugViewer.setCurrentWidget</h4>
<b>setCurrentWidget</b>(<i>widget</i>)
-
<p>
Public slot to set the current page based on the given widget.
</p>
+
<dl>
<dt><i>widget</i> (QWidget)</dt>
@@ -765,10 +766,10 @@
<a NAME="DebugViewer.setDebugger" ID="DebugViewer.setDebugger"></a>
<h4>DebugViewer.setDebugger</h4>
<b>setDebugger</b>(<i>debugUI</i>)
-
<p>
Public method to set a reference to the Debug UI.
</p>
+
<dl>
<dt><i>debugUI</i> (DebugUI)</dt>
@@ -779,24 +780,24 @@
<a NAME="DebugViewer.setGlobalsFilter" ID="DebugViewer.setGlobalsFilter"></a>
<h4>DebugViewer.setGlobalsFilter</h4>
<b>setGlobalsFilter</b>(<i></i>)
-
<p>
Public slot to set the global variable filter.
</p>
+
<a NAME="DebugViewer.setLocalsFilter" ID="DebugViewer.setLocalsFilter"></a>
<h4>DebugViewer.setLocalsFilter</h4>
<b>setLocalsFilter</b>(<i></i>)
-
<p>
Public slot to set the local variable filter.
</p>
+
<a NAME="DebugViewer.setVariablesFilter" ID="DebugViewer.setVariablesFilter"></a>
<h4>DebugViewer.setVariablesFilter</h4>
<b>setVariablesFilter</b>(<i>globalsFilter, localsFilter</i>)
-
<p>
Public slot to set the local variables filter.
</p>
+
<dl>
<dt><i>globalsFilter</i> (list of str)</dt>
@@ -811,10 +812,10 @@
<a NAME="DebugViewer.showVariable" ID="DebugViewer.showVariable"></a>
<h4>DebugViewer.showVariable</h4>
<b>showVariable</b>(<i>vlist, showGlobals</i>)
-
<p>
Public method to show the variables in the respective window.
</p>
+
<dl>
<dt><i>vlist</i> (list)</dt>
@@ -829,10 +830,10 @@
<a NAME="DebugViewer.showVariables" ID="DebugViewer.showVariables"></a>
<h4>DebugViewer.showVariables</h4>
<b>showVariables</b>(<i>vlist, showGlobals</i>)
-
<p>
Public method to show the variables in the respective window.
</p>
+
<dl>
<dt><i>vlist</i> (list)</dt>
@@ -847,10 +848,10 @@
<a NAME="DebugViewer.showVariablesTab" ID="DebugViewer.showVariablesTab"></a>
<h4>DebugViewer.showVariablesTab</h4>
<b>showVariablesTab</b>(<i>showGlobals</i>)
-
<p>
Public method to make a variables tab visible.
</p>
+
<dl>
<dt><i>showGlobals</i> (bool)</dt>
@@ -860,4 +861,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
