--- a/src/eric7/Documentation/Source/eric7.Debugger.VariablesViewer.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.Debugger.VariablesViewer.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,19 +7,17 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Debugger.VariablesViewer</h1>
-
<p>
Module implementing the variables viewer view based on QTreeView.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>SORT_ROLE</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#VariableItem">VariableItem</a></td>
<td>Class implementing the data structure for all variable items.</td>
@@ -37,35 +35,36 @@
<td>Class implementing the variables viewer view.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="VariableItem" ID="VariableItem"></a>
<h2>VariableItem</h2>
-
<p>
Class implementing the data structure for all variable items.
</p>
+
<h3>Derived from</h3>
None
<h3>Class Attributes</h3>
+<table>
+<tr><td>noOfItemsStr</td></tr>
+<tr><td>rx_nonprintable</td></tr>
+<tr><td>unsized</td></tr>
+</table>
-<table>
-<tr><td>noOfItemsStr</td></tr><tr><td>rx_nonprintable</td></tr><tr><td>unsized</td></tr>
-</table>
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#VariableItem.__init__">VariableItem</a></td>
<td>Constructor</td>
@@ -83,19 +82,20 @@
<td>Public property to get the total number of children.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="VariableItem.__init__" ID="VariableItem.__init__"></a>
<h4>VariableItem (Constructor)</h4>
<b>VariableItem</b>(<i>parent, dvar, indicator, dtype, hasChildren, length, dvalue</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>parent</i> (VariableItem)</dt>
@@ -131,10 +131,10 @@
<a NAME="VariableItem.__getName" ID="VariableItem.__getName"></a>
<h4>VariableItem.__getName</h4>
<b>__getName</b>(<i>dvar</i>)
-
<p>
Private method to extract the variable name.
</p>
+
<dl>
<dt><i>dvar</i> (str)</dt>
@@ -145,7 +145,6 @@
<a NAME="VariableItem.__getValue" ID="VariableItem.__getValue"></a>
<h4>VariableItem.__getValue</h4>
<b>__getValue</b>(<i>dtype, dvalue, indicator, length</i>)
-
<p>
Private method to process the variables value.
</p>
@@ -153,6 +152,7 @@
Define and limit value, set tooltip text. If type is known to have
children, the corresponding flag is set.
</p>
+
<dl>
<dt><i>dtype</i> (str)</dt>
@@ -176,10 +176,10 @@
<a NAME="VariableItem.absolutCount" ID="VariableItem.absolutCount"></a>
<h4>VariableItem.absolutCount</h4>
<b>absolutCount</b>(<i></i>)
-
<p>
Public property to get the total number of children.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -197,10 +197,10 @@
<hr />
<a NAME="VariablesModel" ID="VariablesModel"></a>
<h2>VariablesModel</h2>
-
<p>
Class implementing the data model for QTreeView.
</p>
+
<h3>Signals</h3>
<dl>
@@ -212,19 +212,17 @@
<h3>Derived from</h3>
QAbstractItemModel
<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="#VariablesModel.__init__">VariablesModel</a></td>
<td>Constructor</td>
@@ -302,19 +300,20 @@
<td>Public method to update the data model of variable in pathlist.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="VariablesModel.__init__" ID="VariablesModel.__init__"></a>
<h4>VariablesModel (Constructor)</h4>
<b>VariablesModel</b>(<i>treeView, globalScope</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>treeView</i> (VariablesViewer)</dt>
@@ -330,10 +329,10 @@
<a NAME="VariablesModel.__buildTreePath" ID="VariablesModel.__buildTreePath"></a>
<h4>VariablesModel.__buildTreePath</h4>
<b>__buildTreePath</b>(<i>parent</i>)
-
<p>
Private method to build up a path from the root to parent.
</p>
+
<dl>
<dt><i>parent</i> (VariableItem)</dt>
@@ -356,11 +355,11 @@
<a NAME="VariablesModel.__cleanupParentList" ID="VariablesModel.__cleanupParentList"></a>
<h4>VariablesModel.__cleanupParentList</h4>
<b>__cleanupParentList</b>(<i>parent, parentIdx</i>)
-
<p>
Private method to remove items which are left over at the end of the
child list.
</p>
+
<dl>
<dt><i>parent</i> (VariableItem)</dt>
@@ -375,10 +374,10 @@
<a NAME="VariablesModel.__findPendingItem" ID="VariablesModel.__findPendingItem"></a>
<h4>VariablesModel.__findPendingItem</h4>
<b>__findPendingItem</b>(<i>parent=None, pathlist=()</i>)
-
<p>
Private method to find the next item to request data from debugger.
</p>
+
<dl>
<dt><i>parent</i> (VariableItem)</dt>
@@ -405,10 +404,10 @@
<a NAME="VariablesModel.__findVariable" ID="VariablesModel.__findVariable"></a>
<h4>VariablesModel.__findVariable</h4>
<b>__findVariable</b>(<i>pathlist</i>)
-
<p>
Private method to get to the given variable.
</p>
+
<dl>
<dt><i>pathlist</i> (list of str)</dt>
@@ -431,10 +430,10 @@
<a NAME="VariablesModel.clear" ID="VariablesModel.clear"></a>
<h4>VariablesModel.clear</h4>
<b>clear</b>(<i>reset=False</i>)
-
<p>
Public method to clear the complete data model.
</p>
+
<dl>
<dt><i>reset</i> (bool)</dt>
@@ -445,10 +444,10 @@
<a NAME="VariablesModel.columnCount" ID="VariablesModel.columnCount"></a>
<h4>VariablesModel.columnCount</h4>
<b>columnCount</b>(<i>parent=QModelIndex()</i>)
-
<p>
Public method to get the column count.
</p>
+
<dl>
<dt><i>parent</i> (QModelIndex)</dt>
@@ -471,10 +470,10 @@
<a NAME="VariablesModel.data" ID="VariablesModel.data"></a>
<h4>VariablesModel.data</h4>
<b>data</b>(<i>index, role=Qt.ItemDataRole.DisplayRole</i>)
-
<p>
Public method get the role data of item.
</p>
+
<dl>
<dt><i>index</i> (QModelIndex)</dt>
@@ -501,10 +500,10 @@
<a NAME="VariablesModel.flags" ID="VariablesModel.flags"></a>
<h4>VariablesModel.flags</h4>
<b>flags</b>(<i>index</i>)
-
<p>
Public method to get the item flags.
</p>
+
<dl>
<dt><i>index</i> (QModelIndex)</dt>
@@ -527,24 +526,24 @@
<a NAME="VariablesModel.getMore" ID="VariablesModel.getMore"></a>
<h4>VariablesModel.getMore</h4>
<b>getMore</b>(<i></i>)
-
<p>
Public method to fetch the next variable from debugger.
</p>
+
<a NAME="VariablesModel.handlePreferencesChanged" ID="VariablesModel.handlePreferencesChanged"></a>
<h4>VariablesModel.handlePreferencesChanged</h4>
<b>handlePreferencesChanged</b>(<i></i>)
-
<p>
Public slot to handle the preferencesChanged signal.
</p>
+
<a NAME="VariablesModel.hasChildren" ID="VariablesModel.hasChildren"></a>
<h4>VariablesModel.hasChildren</h4>
<b>hasChildren</b>(<i>parent=QModelIndex()</i>)
-
<p>
Public method to get a flag if parent has children.
</p>
+
<dl>
<dt><i>parent</i> (QModelIndex)</dt>
@@ -567,10 +566,10 @@
<a NAME="VariablesModel.headerData" ID="VariablesModel.headerData"></a>
<h4>VariablesModel.headerData</h4>
<b>headerData</b>(<i>section, orientation, role=Qt.ItemDataRole.DisplayRole</i>)
-
<p>
Public method get the header names.
</p>
+
<dl>
<dt><i>section</i> (int)</dt>
@@ -601,10 +600,10 @@
<a NAME="VariablesModel.index" ID="VariablesModel.index"></a>
<h4>VariablesModel.index</h4>
<b>index</b>(<i>row, column, parent=QModelIndex()</i>)
-
<p>
Public method to get the index of item at row:column of parent.
</p>
+
<dl>
<dt><i>row</i> (int)</dt>
@@ -635,10 +634,10 @@
<a NAME="VariablesModel.parent" ID="VariablesModel.parent"></a>
<h4>VariablesModel.parent</h4>
<b>parent</b>(<i>child</i>)
-
<p>
Public method to get the parent of the given child.
</p>
+
<dl>
<dt><i>child</i> (QModelIndex)</dt>
@@ -661,10 +660,10 @@
<a NAME="VariablesModel.resetModifiedMarker" ID="VariablesModel.resetModifiedMarker"></a>
<h4>VariablesModel.resetModifiedMarker</h4>
<b>resetModifiedMarker</b>(<i>parentIdx=QModelIndex(), pathlist=()</i>)
-
<p>
Public method to remove the modified marker from changed items.
</p>
+
<dl>
<dt><i>parentIdx</i> (QModelIndex)</dt>
@@ -679,10 +678,10 @@
<a NAME="VariablesModel.rowCount" ID="VariablesModel.rowCount"></a>
<h4>VariablesModel.rowCount</h4>
<b>rowCount</b>(<i>parent=QModelIndex()</i>)
-
<p>
Public method to get the row count.
</p>
+
<dl>
<dt><i>parent</i> (QModelIndex)</dt>
@@ -705,10 +704,10 @@
<a NAME="VariablesModel.setExpanded" ID="VariablesModel.setExpanded"></a>
<h4>VariablesModel.setExpanded</h4>
<b>setExpanded</b>(<i>index, state</i>)
-
<p>
Public method to set the expanded state of item.
</p>
+
<dl>
<dt><i>index</i> (QModelIndex)</dt>
@@ -723,10 +722,10 @@
<a NAME="VariablesModel.showVariables" ID="VariablesModel.showVariables"></a>
<h4>VariablesModel.showVariables</h4>
<b>showVariables</b>(<i>vlist, frmnr, pathlist=None</i>)
-
<p>
Public method to update the data model of variable in pathlist.
</p>
+
<dl>
<dt><i>vlist</i> (list of str)</dt>
@@ -756,26 +755,24 @@
<hr />
<a NAME="VariablesProxyModel" ID="VariablesProxyModel"></a>
<h2>VariablesProxyModel</h2>
-
<p>
Class for handling the sort operations.
</p>
+
<h3>Derived from</h3>
QSortFilterProxyModel
<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="#VariablesProxyModel.__init__">VariablesProxyModel</a></td>
<td>Constructor</td>
@@ -789,19 +786,20 @@
<td>Public slot to get a flag if parent has children.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="VariablesProxyModel.__init__" ID="VariablesProxyModel.__init__"></a>
<h4>VariablesProxyModel (Constructor)</h4>
<b>VariablesProxyModel</b>(<i>parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>parent</i> (QModelIndex)</dt>
@@ -812,7 +810,6 @@
<a NAME="VariablesProxyModel.hasChildren" ID="VariablesProxyModel.hasChildren"></a>
<h4>VariablesProxyModel.hasChildren</h4>
<b>hasChildren</b>(<i>parent</i>)
-
<p>
Public method to get a flag if parent has children.
</p>
@@ -820,6 +817,7 @@
The given model index has to be transformed to the underlying source
model to get the correct result.
</p>
+
<dl>
<dt><i>parent</i> (QModelIndex)</dt>
@@ -842,7 +840,6 @@
<a NAME="VariablesProxyModel.setExpanded" ID="VariablesProxyModel.setExpanded"></a>
<h4>VariablesProxyModel.setExpanded</h4>
<b>setExpanded</b>(<i>index, state</i>)
-
<p>
Public slot to get a flag if parent has children.
</p>
@@ -850,6 +847,7 @@
The given model index has to be transformed to the underlying source
model to get the correct result.
</p>
+
<dl>
<dt><i>index</i> (QModelIndex)</dt>
@@ -866,7 +864,6 @@
<hr />
<a NAME="VariablesViewer" ID="VariablesViewer"></a>
<h2>VariablesViewer</h2>
-
<p>
Class implementing the variables viewer view.
</p>
@@ -884,6 +881,7 @@
This view has two modes for displaying the global and the local
variables.
</p>
+
<h3>Signals</h3>
<dl>
@@ -895,19 +893,17 @@
<h3>Derived from</h3>
QTreeView
<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="#VariablesViewer.__init__">VariablesViewer</a></td>
<td>Constructor</td>
@@ -981,19 +977,20 @@
<td>Public slot informing about the scrollbar change.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="VariablesViewer.__init__" ID="VariablesViewer.__init__"></a>
<h4>VariablesViewer (Constructor)</h4>
<b>VariablesViewer</b>(<i>viewer, globalScope, parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>viewer</i> (DebugViewer)</dt>
@@ -1013,45 +1010,45 @@
<a NAME="VariablesViewer.__collapseChildren" ID="VariablesViewer.__collapseChildren"></a>
<h4>VariablesViewer.__collapseChildren</h4>
<b>__collapseChildren</b>(<i></i>)
-
<p>
Private slot to collapse all child items of current parent.
</p>
+
<a NAME="VariablesViewer.__configure" ID="VariablesViewer.__configure"></a>
<h4>VariablesViewer.__configure</h4>
<b>__configure</b>(<i></i>)
-
<p>
Private method to open the configuration dialog.
</p>
+
<a NAME="VariablesViewer.__configureFilter" ID="VariablesViewer.__configureFilter"></a>
<h4>VariablesViewer.__configureFilter</h4>
<b>__configureFilter</b>(<i></i>)
-
<p>
Private method to open the variables filter dialog.
</p>
+
<a NAME="VariablesViewer.__createPopupMenus" ID="VariablesViewer.__createPopupMenus"></a>
<h4>VariablesViewer.__createPopupMenus</h4>
<b>__createPopupMenus</b>(<i></i>)
-
<p>
Private method to generate the popup menus.
</p>
+
<a NAME="VariablesViewer.__expandChildren" ID="VariablesViewer.__expandChildren"></a>
<h4>VariablesViewer.__expandChildren</h4>
<b>__expandChildren</b>(<i></i>)
-
<p>
Private slot to expand all child items of current parent.
</p>
+
<a NAME="VariablesViewer.__itemDoubleClicked" ID="VariablesViewer.__itemDoubleClicked"></a>
<h4>VariablesViewer.__itemDoubleClicked</h4>
<b>__itemDoubleClicked</b>(<i>index</i>)
-
<p>
Private method called if an item was double clicked.
</p>
+
<dl>
<dt><i>index</i> (QModelIndex)</dt>
@@ -1062,10 +1059,10 @@
<a NAME="VariablesViewer.__mdlRequestExpand" ID="VariablesViewer.__mdlRequestExpand"></a>
<h4>VariablesViewer.__mdlRequestExpand</h4>
<b>__mdlRequestExpand</b>(<i>modelIndex</i>)
-
<p>
Private method to inform the view about items to be expand.
</p>
+
<dl>
<dt><i>modelIndex</i> (QModelIndex)</dt>
@@ -1076,17 +1073,17 @@
<a NAME="VariablesViewer.__refreshView" ID="VariablesViewer.__refreshView"></a>
<h4>VariablesViewer.__refreshView</h4>
<b>__refreshView</b>(<i></i>)
-
<p>
Private slot to refresh the view.
</p>
+
<a NAME="VariablesViewer.__showContextMenu" ID="VariablesViewer.__showContextMenu"></a>
<h4>VariablesViewer.__showContextMenu</h4>
<b>__showContextMenu</b>(<i>coord</i>)
-
<p>
Private slot to show the context menu.
</p>
+
<dl>
<dt><i>coord</i> (QPoint)</dt>
@@ -1097,17 +1094,17 @@
<a NAME="VariablesViewer.__showDetails" ID="VariablesViewer.__showDetails"></a>
<h4>VariablesViewer.__showDetails</h4>
<b>__showDetails</b>(<i></i>)
-
<p>
Private slot to show details about the selected variable.
</p>
+
<a NAME="VariablesViewer.__showVariableDetails" ID="VariablesViewer.__showVariableDetails"></a>
<h4>VariablesViewer.__showVariableDetails</h4>
<b>__showVariableDetails</b>(<i>index</i>)
-
<p>
Private method to show details about a variable.
</p>
+
<dl>
<dt><i>index</i> (QModelIndex)</dt>
@@ -1118,24 +1115,24 @@
<a NAME="VariablesViewer.clear" ID="VariablesViewer.clear"></a>
<h4>VariablesViewer.clear</h4>
<b>clear</b>(<i></i>)
-
<p>
Public method to clear the viewer.
</p>
+
<a NAME="VariablesViewer.handleResetUI" ID="VariablesViewer.handleResetUI"></a>
<h4>VariablesViewer.handleResetUI</h4>
<b>handleResetUI</b>(<i></i>)
-
<p>
Public method to reset the VariablesViewer.
</p>
+
<a NAME="VariablesViewer.resizeEvent" ID="VariablesViewer.resizeEvent"></a>
<h4>VariablesViewer.resizeEvent</h4>
<b>resizeEvent</b>(<i>event</i>)
-
<p>
Protected slot informing about the widget size change.
</p>
+
<dl>
<dt><i>event</i> (QResizeEvent)</dt>
@@ -1146,10 +1143,10 @@
<a NAME="VariablesViewer.showVariable" ID="VariablesViewer.showVariable"></a>
<h4>VariablesViewer.showVariable</h4>
<b>showVariable</b>(<i>vlist</i>)
-
<p>
Public method to show variables in a list.
</p>
+
<dl>
<dt><i>vlist</i> (list)</dt>
@@ -1171,10 +1168,10 @@
<a NAME="VariablesViewer.showVariables" ID="VariablesViewer.showVariables"></a>
<h4>VariablesViewer.showVariables</h4>
<b>showVariables</b>(<i>vlist, frmnr</i>)
-
<p>
Public method to show variables in a list.
</p>
+
<dl>
<dt><i>vlist</i> (list)</dt>
@@ -1198,10 +1195,10 @@
<a NAME="VariablesViewer.verticalScrollbarValueChanged" ID="VariablesViewer.verticalScrollbarValueChanged"></a>
<h4>VariablesViewer.verticalScrollbarValueChanged</h4>
<b>verticalScrollbarValueChanged</b>(<i>value</i>)
-
<p>
Public slot informing about the scrollbar change.
</p>
+
<dl>
<dt><i>value</i> (int)</dt>
@@ -1211,4 +1208,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
