diff -r 3fc8dfeb6ebe -r b99e7fd55fd3 src/eric7/Documentation/Source/eric7.EricWidgets.EricTreeWidget.html
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/src/eric7/Documentation/Source/eric7.EricWidgets.EricTreeWidget.html Thu Jul 07 11:23:56 2022 +0200
@@ -0,0 +1,437 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.EricWidgets.EricTreeWidget</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.EricWidgets.EricTreeWidget</h1>
+
+<p>
+Module implementing specialized tree views.
+</p>
+<h3>Global Attributes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+
+<table>
+
+<tr>
+<td><a href="#EricTreeWidget">EricTreeWidget</a></td>
+<td>Class implementing an extended tree widget.</td>
+</tr>
+<tr>
+<td><a href="#EricTreeWidgetItemsState">EricTreeWidgetItemsState</a></td>
+<td>Class defining the items expansion state.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr />
+<hr />
+<a NAME="EricTreeWidget" ID="EricTreeWidget"></a>
+<h2>EricTreeWidget</h2>
+
+<p>
+ Class implementing an extended tree widget.
+</p>
+<h3>Signals</h3>
+<dl>
+
+<dt>itemControlClicked(QTreeWidgetItem)</dt>
+<dd>
+emitted after a Ctrl-Click
+ on an item
+</dd>
+<dt>itemMiddleButtonClicked(QTreeWidgetItem)</dt>
+<dd>
+emitted after a click
+ of the middle button on an item
+</dd>
+</dl>
+<h3>Derived from</h3>
+QTreeWidget
+<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="#EricTreeWidget.__init__">EricTreeWidget</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#EricTreeWidget.__iterateAllItems">__iterateAllItems</a></td>
+<td>Private method to iterate over the child items of the parent.</td>
+</tr>
+<tr>
+<td><a href="#EricTreeWidget.__scheduleRefresh">__scheduleRefresh</a></td>
+<td>Private slot to schedule a refresh of the tree.</td>
+</tr>
+<tr>
+<td><a href="#EricTreeWidget.addTopLevelItem">addTopLevelItem</a></td>
+<td>Public method to add a top level item.</td>
+</tr>
+<tr>
+<td><a href="#EricTreeWidget.addTopLevelItems">addTopLevelItems</a></td>
+<td>Public method to add a list of top level items.</td>
+</tr>
+<tr>
+<td><a href="#EricTreeWidget.allItems">allItems</a></td>
+<td>Public method to get a list of all items.</td>
+</tr>
+<tr>
+<td><a href="#EricTreeWidget.appendToParentItem">appendToParentItem</a></td>
+<td>Public method to append an item to a parent item.</td>
+</tr>
+<tr>
+<td><a href="#EricTreeWidget.clear">clear</a></td>
+<td>Public slot to clear the tree.</td>
+</tr>
+<tr>
+<td><a href="#EricTreeWidget.deleteItem">deleteItem</a></td>
+<td>Public method to delete an item.</td>
+</tr>
+<tr>
+<td><a href="#EricTreeWidget.deleteItems">deleteItems</a></td>
+<td>Public method to delete a list of items.</td>
+</tr>
+<tr>
+<td><a href="#EricTreeWidget.filterString">filterString</a></td>
+<td>Public slot to set a new filter.</td>
+</tr>
+<tr>
+<td><a href="#EricTreeWidget.insertTopLevelItem">insertTopLevelItem</a></td>
+<td>Public method to insert a top level item.</td>
+</tr>
+<tr>
+<td><a href="#EricTreeWidget.insertTopLevelItems">insertTopLevelItems</a></td>
+<td>Public method to insert a list of top level items.</td>
+</tr>
+<tr>
+<td><a href="#EricTreeWidget.mousePressEvent">mousePressEvent</a></td>
+<td>Protected method handling mouse press events.</td>
+</tr>
+<tr>
+<td><a href="#EricTreeWidget.prependToParentItem">prependToParentItem</a></td>
+<td>Public method to prepend an item to a parent item.</td>
+</tr>
+<tr>
+<td><a href="#EricTreeWidget.setDefaultItemShowMode">setDefaultItemShowMode</a></td>
+<td>Public method to set the default item show mode.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<a NAME="EricTreeWidget.__init__" ID="EricTreeWidget.__init__"></a>
+<h4>EricTreeWidget (Constructor)</h4>
+<b>EricTreeWidget</b>(<i>parent=None</i>)
+
+<p>
+ Constructor
+</p>
+<dl>
+
+<dt><i>parent</i></dt>
+<dd>
+reference to the parent widget (QWidget)
+</dd>
+</dl>
+<a NAME="EricTreeWidget.__iterateAllItems" ID="EricTreeWidget.__iterateAllItems"></a>
+<h4>EricTreeWidget.__iterateAllItems</h4>
+<b>__iterateAllItems</b>(<i>parent</i>)
+
+<p>
+ Private method to iterate over the child items of the parent.
+</p>
+<dl>
+
+<dt><i>parent</i></dt>
+<dd>
+parent item to iterate (QTreeWidgetItem)
+</dd>
+</dl>
+<a NAME="EricTreeWidget.__scheduleRefresh" ID="EricTreeWidget.__scheduleRefresh"></a>
+<h4>EricTreeWidget.__scheduleRefresh</h4>
+<b>__scheduleRefresh</b>(<i></i>)
+
+<p>
+ Private slot to schedule a refresh of the tree.
+</p>
+<a NAME="EricTreeWidget.addTopLevelItem" ID="EricTreeWidget.addTopLevelItem"></a>
+<h4>EricTreeWidget.addTopLevelItem</h4>
+<b>addTopLevelItem</b>(<i>item</i>)
+
+<p>
+ Public method to add a top level item.
+</p>
+<dl>
+
+<dt><i>item</i></dt>
+<dd>
+item to be added as a top level item (QTreeWidgetItem)
+</dd>
+</dl>
+<a NAME="EricTreeWidget.addTopLevelItems" ID="EricTreeWidget.addTopLevelItems"></a>
+<h4>EricTreeWidget.addTopLevelItems</h4>
+<b>addTopLevelItems</b>(<i>items</i>)
+
+<p>
+ Public method to add a list of top level items.
+</p>
+<dl>
+
+<dt><i>items</i></dt>
+<dd>
+items to be added as top level items
+ (list of QTreeWidgetItem)
+</dd>
+</dl>
+<a NAME="EricTreeWidget.allItems" ID="EricTreeWidget.allItems"></a>
+<h4>EricTreeWidget.allItems</h4>
+<b>allItems</b>(<i></i>)
+
+<p>
+ Public method to get a list of all items.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+list of all items (list of QTreeWidgetItem)
+</dd>
+</dl>
+<a NAME="EricTreeWidget.appendToParentItem" ID="EricTreeWidget.appendToParentItem"></a>
+<h4>EricTreeWidget.appendToParentItem</h4>
+<b>appendToParentItem</b>(<i>parent, item</i>)
+
+<p>
+ Public method to append an item to a parent item.
+</p>
+<dl>
+
+<dt><i>parent</i></dt>
+<dd>
+text of the parent item (string) or
+ the parent item (QTreeWidgetItem)
+</dd>
+<dt><i>item</i></dt>
+<dd>
+item to be appended (QTreeWidgetItem)
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating success (boolean)
+</dd>
+</dl>
+<dl>
+
+<dt>Raises <b>RuntimeError</b>:</dt>
+<dd>
+raised to indicate an illegal type for
+ the parent
+</dd>
+</dl>
+<a NAME="EricTreeWidget.clear" ID="EricTreeWidget.clear"></a>
+<h4>EricTreeWidget.clear</h4>
+<b>clear</b>(<i></i>)
+
+<p>
+ Public slot to clear the tree.
+</p>
+<a NAME="EricTreeWidget.deleteItem" ID="EricTreeWidget.deleteItem"></a>
+<h4>EricTreeWidget.deleteItem</h4>
+<b>deleteItem</b>(<i>item</i>)
+
+<p>
+ Public method to delete an item.
+</p>
+<dl>
+
+<dt><i>item</i></dt>
+<dd>
+item to be deleted (QTreeWidgetItem)
+</dd>
+</dl>
+<a NAME="EricTreeWidget.deleteItems" ID="EricTreeWidget.deleteItems"></a>
+<h4>EricTreeWidget.deleteItems</h4>
+<b>deleteItems</b>(<i>items</i>)
+
+<p>
+ Public method to delete a list of items.
+</p>
+<dl>
+
+<dt><i>items</i></dt>
+<dd>
+items to be deleted (list of QTreeWidgetItem)
+</dd>
+</dl>
+<a NAME="EricTreeWidget.filterString" ID="EricTreeWidget.filterString"></a>
+<h4>EricTreeWidget.filterString</h4>
+<b>filterString</b>(<i>filterStr</i>)
+
+<p>
+ Public slot to set a new filter.
+</p>
+<dl>
+
+<dt><i>filterStr</i></dt>
+<dd>
+filter to be set (string)
+</dd>
+</dl>
+<a NAME="EricTreeWidget.insertTopLevelItem" ID="EricTreeWidget.insertTopLevelItem"></a>
+<h4>EricTreeWidget.insertTopLevelItem</h4>
+<b>insertTopLevelItem</b>(<i>index, item</i>)
+
+<p>
+ Public method to insert a top level item.
+</p>
+<dl>
+
+<dt><i>index</i></dt>
+<dd>
+index for the insertion (integer)
+</dd>
+<dt><i>item</i></dt>
+<dd>
+item to be inserted as a top level item (QTreeWidgetItem)
+</dd>
+</dl>
+<a NAME="EricTreeWidget.insertTopLevelItems" ID="EricTreeWidget.insertTopLevelItems"></a>
+<h4>EricTreeWidget.insertTopLevelItems</h4>
+<b>insertTopLevelItems</b>(<i>index, items</i>)
+
+<p>
+ Public method to insert a list of top level items.
+</p>
+<dl>
+
+<dt><i>index</i></dt>
+<dd>
+index for the insertion (integer)
+</dd>
+<dt><i>items</i></dt>
+<dd>
+items to be inserted as top level items
+ (list of QTreeWidgetItem)
+</dd>
+</dl>
+<a NAME="EricTreeWidget.mousePressEvent" ID="EricTreeWidget.mousePressEvent"></a>
+<h4>EricTreeWidget.mousePressEvent</h4>
+<b>mousePressEvent</b>(<i>evt</i>)
+
+<p>
+ Protected method handling mouse press events.
+</p>
+<dl>
+
+<dt><i>evt</i></dt>
+<dd>
+mouse press event (QMouseEvent)
+</dd>
+</dl>
+<a NAME="EricTreeWidget.prependToParentItem" ID="EricTreeWidget.prependToParentItem"></a>
+<h4>EricTreeWidget.prependToParentItem</h4>
+<b>prependToParentItem</b>(<i>parent, item</i>)
+
+<p>
+ Public method to prepend an item to a parent item.
+</p>
+<dl>
+
+<dt><i>parent</i></dt>
+<dd>
+text of the parent item (string) or
+ the parent item (QTreeWidgetItem)
+</dd>
+<dt><i>item</i></dt>
+<dd>
+item to be prepended (QTreeWidgetItem)
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating success (boolean)
+</dd>
+</dl>
+<dl>
+
+<dt>Raises <b>RuntimeError</b>:</dt>
+<dd>
+raised to indicate an illegal type for
+ the parent
+</dd>
+</dl>
+<a NAME="EricTreeWidget.setDefaultItemShowMode" ID="EricTreeWidget.setDefaultItemShowMode"></a>
+<h4>EricTreeWidget.setDefaultItemShowMode</h4>
+<b>setDefaultItemShowMode</b>(<i>mode</i>)
+
+<p>
+ Public method to set the default item show mode.
+</p>
+<dl>
+
+<dt><i>mode</i> (EricTreeWidgetItemsState)</dt>
+<dd>
+default mode
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="EricTreeWidgetItemsState" ID="EricTreeWidgetItemsState"></a>
+<h2>EricTreeWidgetItemsState</h2>
+
+<p>
+ Class defining the items expansion state.
+</p>
+<h3>Derived from</h3>
+enum.Enum
+<h3>Class Attributes</h3>
+
+<table>
+<tr><td>COLLAPSED</td></tr><tr><td>EXPANDED</td></tr>
+</table>
+<h3>Class Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file
