diff -r 1779dc278077 -r 391d6b7b1eff eric6/Documentation/Source/eric6.Debugger.CallTraceViewer.html --- a/eric6/Documentation/Source/eric6.Debugger.CallTraceViewer.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.Debugger.CallTraceViewer.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,33 +18,43 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.Debugger.CallTraceViewer</h1> + <p> Module implementing the Call Trace viewer widget. </p> <h3>Global Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#CallTraceViewer">CallTraceViewer</a></td> <td>Class implementing the Call Trace viewer widget.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="CallTraceViewer" ID="CallTraceViewer"></a> <h2>CallTraceViewer</h2> + <p> Class implementing the Call Trace viewer widget. -</p><h3>Signals</h3> +</p> +<h3>Signals</h3> <dl> + <dt>sourceFile(str, int)</dt> <dd> emitted to show the source of a call/return @@ -54,191 +64,259 @@ <h3>Derived from</h3> QWidget, Ui_CallTraceViewer <h3>Class Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Class Methods</h3> + <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> + <table> + <tr> <td><a href="#CallTraceViewer.__init__">CallTraceViewer</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#CallTraceViewer.__addCallTraceInfo">__addCallTraceInfo</a></td> <td>Private method to add an entry to the call trace viewer.</td> -</tr><tr> +</tr> +<tr> <td><a href="#CallTraceViewer.__clientExit">__clientExit</a></td> <td>Private slot handling a client exiting.</td> -</tr><tr> +</tr> +<tr> <td><a href="#CallTraceViewer.__setCallTraceEnabled">__setCallTraceEnabled</a></td> <td>Private slot to set the call trace enabled status.</td> -</tr><tr> +</tr> +<tr> <td><a href="#CallTraceViewer.clear">clear</a></td> <td>Public slot to clear the call trace info.</td> -</tr><tr> +</tr> +<tr> <td><a href="#CallTraceViewer.isCallTraceEnabled">isCallTraceEnabled</a></td> <td>Public method to get the state of the call trace function.</td> -</tr><tr> +</tr> +<tr> <td><a href="#CallTraceViewer.on_callTrace_itemDoubleClicked">on_callTrace_itemDoubleClicked</a></td> <td>Private slot to open the double clicked file in an editor.</td> -</tr><tr> +</tr> +<tr> <td><a href="#CallTraceViewer.on_clearButton_clicked">on_clearButton_clicked</a></td> <td>Private slot to clear the call trace.</td> -</tr><tr> +</tr> +<tr> <td><a href="#CallTraceViewer.on_resizeButton_clicked">on_resizeButton_clicked</a></td> <td>Private slot to resize the columns of the call trace to their contents.</td> -</tr><tr> +</tr> +<tr> <td><a href="#CallTraceViewer.on_saveButton_clicked">on_saveButton_clicked</a></td> <td>Private slot to save the call trace info to a file.</td> -</tr><tr> +</tr> +<tr> <td><a href="#CallTraceViewer.on_startTraceButton_clicked">on_startTraceButton_clicked</a></td> <td>Private slot to start call tracing.</td> -</tr><tr> +</tr> +<tr> <td><a href="#CallTraceViewer.on_stopCheckBox_clicked">on_stopCheckBox_clicked</a></td> <td>Private slot to handle a click on the stop check box.</td> -</tr><tr> +</tr> +<tr> <td><a href="#CallTraceViewer.on_stopTraceButton_clicked">on_stopTraceButton_clicked</a></td> <td>Private slot to start call tracing.</td> -</tr><tr> +</tr> +<tr> <td><a href="#CallTraceViewer.setProjectMode">setProjectMode</a></td> <td>Public slot to set the call trace viewer to project mode.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="CallTraceViewer.__init__" ID="CallTraceViewer.__init__"></a> <h4>CallTraceViewer (Constructor)</h4> <b>CallTraceViewer</b>(<i>debugServer, parent=None</i>) + <p> Constructor -</p><dl> +</p> +<dl> + <dt><i>debugServer</i></dt> <dd> reference to the debug server object (DebugServer) -</dd><dt><i>parent</i></dt> +</dd> +<dt><i>parent</i></dt> <dd> reference to the parent widget (QWidget) </dd> -</dl><a NAME="CallTraceViewer.__addCallTraceInfo" ID="CallTraceViewer.__addCallTraceInfo"></a> +</dl> +<a NAME="CallTraceViewer.__addCallTraceInfo" ID="CallTraceViewer.__addCallTraceInfo"></a> <h4>CallTraceViewer.__addCallTraceInfo</h4> <b>__addCallTraceInfo</b>(<i>isCall, fromFile, fromLine, fromFunction, toFile, toLine, toFunction</i>) + <p> Private method to add an entry to the call trace viewer. -</p><dl> +</p> +<dl> + <dt><i>isCall</i></dt> <dd> flag indicating a 'call' (boolean) -</dd><dt><i>fromFile</i></dt> +</dd> +<dt><i>fromFile</i></dt> <dd> name of the originating file (string) -</dd><dt><i>fromLine</i></dt> +</dd> +<dt><i>fromLine</i></dt> <dd> line number in the originating file (string) -</dd><dt><i>fromFunction</i></dt> +</dd> +<dt><i>fromFunction</i></dt> <dd> name of the originating function (string) -</dd><dt><i>toFile</i></dt> +</dd> +<dt><i>toFile</i></dt> <dd> name of the target file (string) -</dd><dt><i>toLine</i></dt> +</dd> +<dt><i>toLine</i></dt> <dd> line number in the target file (string) -</dd><dt><i>toFunction</i></dt> +</dd> +<dt><i>toFunction</i></dt> <dd> name of the target function (string) </dd> -</dl><a NAME="CallTraceViewer.__clientExit" ID="CallTraceViewer.__clientExit"></a> +</dl> +<a NAME="CallTraceViewer.__clientExit" ID="CallTraceViewer.__clientExit"></a> <h4>CallTraceViewer.__clientExit</h4> <b>__clientExit</b>(<i></i>) + <p> Private slot handling a client exiting. -</p><a NAME="CallTraceViewer.__setCallTraceEnabled" ID="CallTraceViewer.__setCallTraceEnabled"></a> +</p> +<a NAME="CallTraceViewer.__setCallTraceEnabled" ID="CallTraceViewer.__setCallTraceEnabled"></a> <h4>CallTraceViewer.__setCallTraceEnabled</h4> <b>__setCallTraceEnabled</b>(<i>enabled</i>) + <p> Private slot to set the call trace enabled status. -</p><dl> +</p> +<dl> + <dt><i>enabled</i></dt> <dd> flag indicating the new state (boolean) </dd> -</dl><a NAME="CallTraceViewer.clear" ID="CallTraceViewer.clear"></a> +</dl> +<a NAME="CallTraceViewer.clear" ID="CallTraceViewer.clear"></a> <h4>CallTraceViewer.clear</h4> <b>clear</b>(<i></i>) + <p> Public slot to clear the call trace info. -</p><a NAME="CallTraceViewer.isCallTraceEnabled" ID="CallTraceViewer.isCallTraceEnabled"></a> +</p> +<a NAME="CallTraceViewer.isCallTraceEnabled" ID="CallTraceViewer.isCallTraceEnabled"></a> <h4>CallTraceViewer.isCallTraceEnabled</h4> <b>isCallTraceEnabled</b>(<i></i>) + <p> Public method to get the state of the call trace function. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> flag indicating the state of the call trace function (boolean) </dd> -</dl><a NAME="CallTraceViewer.on_callTrace_itemDoubleClicked" ID="CallTraceViewer.on_callTrace_itemDoubleClicked"></a> +</dl> +<a NAME="CallTraceViewer.on_callTrace_itemDoubleClicked" ID="CallTraceViewer.on_callTrace_itemDoubleClicked"></a> <h4>CallTraceViewer.on_callTrace_itemDoubleClicked</h4> <b>on_callTrace_itemDoubleClicked</b>(<i>item, column</i>) + <p> Private slot to open the double clicked file in an editor. -</p><dl> +</p> +<dl> + <dt><i>item</i></dt> <dd> reference to the double clicked item (QTreeWidgetItem) -</dd><dt><i>column</i></dt> +</dd> +<dt><i>column</i></dt> <dd> column that was double clicked (integer) </dd> -</dl><a NAME="CallTraceViewer.on_clearButton_clicked" ID="CallTraceViewer.on_clearButton_clicked"></a> +</dl> +<a NAME="CallTraceViewer.on_clearButton_clicked" ID="CallTraceViewer.on_clearButton_clicked"></a> <h4>CallTraceViewer.on_clearButton_clicked</h4> <b>on_clearButton_clicked</b>(<i></i>) + <p> Private slot to clear the call trace. -</p><a NAME="CallTraceViewer.on_resizeButton_clicked" ID="CallTraceViewer.on_resizeButton_clicked"></a> +</p> +<a NAME="CallTraceViewer.on_resizeButton_clicked" ID="CallTraceViewer.on_resizeButton_clicked"></a> <h4>CallTraceViewer.on_resizeButton_clicked</h4> <b>on_resizeButton_clicked</b>(<i></i>) + <p> Private slot to resize the columns of the call trace to their contents. -</p><a NAME="CallTraceViewer.on_saveButton_clicked" ID="CallTraceViewer.on_saveButton_clicked"></a> +</p> +<a NAME="CallTraceViewer.on_saveButton_clicked" ID="CallTraceViewer.on_saveButton_clicked"></a> <h4>CallTraceViewer.on_saveButton_clicked</h4> <b>on_saveButton_clicked</b>(<i></i>) + <p> Private slot to save the call trace info to a file. -</p><a NAME="CallTraceViewer.on_startTraceButton_clicked" ID="CallTraceViewer.on_startTraceButton_clicked"></a> +</p> +<a NAME="CallTraceViewer.on_startTraceButton_clicked" ID="CallTraceViewer.on_startTraceButton_clicked"></a> <h4>CallTraceViewer.on_startTraceButton_clicked</h4> <b>on_startTraceButton_clicked</b>(<i></i>) + <p> Private slot to start call tracing. -</p><a NAME="CallTraceViewer.on_stopCheckBox_clicked" ID="CallTraceViewer.on_stopCheckBox_clicked"></a> +</p> +<a NAME="CallTraceViewer.on_stopCheckBox_clicked" ID="CallTraceViewer.on_stopCheckBox_clicked"></a> <h4>CallTraceViewer.on_stopCheckBox_clicked</h4> <b>on_stopCheckBox_clicked</b>(<i>checked</i>) + <p> Private slot to handle a click on the stop check box. -</p><dl> +</p> +<dl> + <dt><i>checked</i> (bool)</dt> <dd> state of the check box </dd> -</dl><a NAME="CallTraceViewer.on_stopTraceButton_clicked" ID="CallTraceViewer.on_stopTraceButton_clicked"></a> +</dl> +<a NAME="CallTraceViewer.on_stopTraceButton_clicked" ID="CallTraceViewer.on_stopTraceButton_clicked"></a> <h4>CallTraceViewer.on_stopTraceButton_clicked</h4> <b>on_stopTraceButton_clicked</b>(<i></i>) + <p> Private slot to start call tracing. -</p><a NAME="CallTraceViewer.setProjectMode" ID="CallTraceViewer.setProjectMode"></a> +</p> +<a NAME="CallTraceViewer.setProjectMode" ID="CallTraceViewer.setProjectMode"></a> <h4>CallTraceViewer.setProjectMode</h4> <b>setProjectMode</b>(<i>enabled</i>) + <p> Public slot to set the call trace viewer to project mode. -</p><p> +</p> +<p> In project mode the call trace info is shown with project relative path names. -</p><dl> +</p> +<dl> + <dt><i>enabled</i></dt> <dd> flag indicating to enable the project mode (boolean)