diff -r 1779dc278077 -r 391d6b7b1eff eric6/Documentation/Source/eric6.WebBrowser.AdBlock.AdBlockTreeWidget.html --- a/eric6/Documentation/Source/eric6.WebBrowser.AdBlock.AdBlockTreeWidget.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.WebBrowser.AdBlock.AdBlockTreeWidget.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,193 +18,259 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.WebBrowser.AdBlock.AdBlockTreeWidget</h1> + <p> Module implementing a tree widget for the AdBlock configuration dialog. </p> <h3>Global Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#AdBlockTreeWidget">AdBlockTreeWidget</a></td> <td>Class implementing a tree widget for the AdBlock configuration dialog.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="AdBlockTreeWidget" ID="AdBlockTreeWidget"></a> <h2>AdBlockTreeWidget</h2> + <p> Class implementing a tree widget for the AdBlock configuration dialog. </p> <h3>Derived from</h3> E5TreeWidget <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="#AdBlockTreeWidget.__init__">AdBlockTreeWidget</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#AdBlockTreeWidget.__adjustItemFeatures">__adjustItemFeatures</a></td> <td>Private method to adjust an item.</td> -</tr><tr> +</tr> +<tr> <td><a href="#AdBlockTreeWidget.__contextMenuRequested">__contextMenuRequested</a></td> <td>Private slot to show the context menu.</td> -</tr><tr> +</tr> +<tr> <td><a href="#AdBlockTreeWidget.__copyFilter">__copyFilter</a></td> <td>Private slot to copy the current filter to the clipboard.</td> -</tr><tr> +</tr> +<tr> <td><a href="#AdBlockTreeWidget.__itemChanged">__itemChanged</a></td> <td>Private slot to handle the change of an item.</td> -</tr><tr> +</tr> +<tr> <td><a href="#AdBlockTreeWidget.__subscriptionChanged">__subscriptionChanged</a></td> <td>Private slot handling a subscription change.</td> -</tr><tr> +</tr> +<tr> <td><a href="#AdBlockTreeWidget.addRule">addRule</a></td> <td>Public slot to add a new rule.</td> -</tr><tr> +</tr> +<tr> <td><a href="#AdBlockTreeWidget.keyPressEvent">keyPressEvent</a></td> <td>Protected method handling key presses.</td> -</tr><tr> +</tr> +<tr> <td><a href="#AdBlockTreeWidget.refresh">refresh</a></td> <td>Public method to refresh the tree.</td> -</tr><tr> +</tr> +<tr> <td><a href="#AdBlockTreeWidget.removeRule">removeRule</a></td> <td>Public slot to remove the current rule.</td> -</tr><tr> +</tr> +<tr> <td><a href="#AdBlockTreeWidget.showRule">showRule</a></td> <td>Public method to highlight the given rule.</td> -</tr><tr> +</tr> +<tr> <td><a href="#AdBlockTreeWidget.subscription">subscription</a></td> <td>Public method to get a reference to the subscription.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="AdBlockTreeWidget.__init__" ID="AdBlockTreeWidget.__init__"></a> <h4>AdBlockTreeWidget (Constructor)</h4> <b>AdBlockTreeWidget</b>(<i>subscription, parent=None</i>) + <p> Constructor -</p><dl> +</p> +<dl> + <dt><i>subscription</i> (AdBlockSubscription)</dt> <dd> reference to the subscription -</dd><dt><i>parent</i> (QWidget)</dt> +</dd> +<dt><i>parent</i> (QWidget)</dt> <dd> reference to the parent widget </dd> -</dl><a NAME="AdBlockTreeWidget.__adjustItemFeatures" ID="AdBlockTreeWidget.__adjustItemFeatures"></a> +</dl> +<a NAME="AdBlockTreeWidget.__adjustItemFeatures" ID="AdBlockTreeWidget.__adjustItemFeatures"></a> <h4>AdBlockTreeWidget.__adjustItemFeatures</h4> <b>__adjustItemFeatures</b>(<i>itm, rule</i>) + <p> Private method to adjust an item. -</p><dl> +</p> +<dl> + <dt><i>itm</i> (QTreeWidgetItem)</dt> <dd> item to be adjusted -</dd><dt><i>rule</i> (AdBlockRule)</dt> +</dd> +<dt><i>rule</i> (AdBlockRule)</dt> <dd> rule for the adjustment </dd> -</dl><a NAME="AdBlockTreeWidget.__contextMenuRequested" ID="AdBlockTreeWidget.__contextMenuRequested"></a> +</dl> +<a NAME="AdBlockTreeWidget.__contextMenuRequested" ID="AdBlockTreeWidget.__contextMenuRequested"></a> <h4>AdBlockTreeWidget.__contextMenuRequested</h4> <b>__contextMenuRequested</b>(<i>pos</i>) + <p> Private slot to show the context menu. -</p><dl> +</p> +<dl> + <dt><i>pos</i> (QPoint)</dt> <dd> position for the menu </dd> -</dl><a NAME="AdBlockTreeWidget.__copyFilter" ID="AdBlockTreeWidget.__copyFilter"></a> +</dl> +<a NAME="AdBlockTreeWidget.__copyFilter" ID="AdBlockTreeWidget.__copyFilter"></a> <h4>AdBlockTreeWidget.__copyFilter</h4> <b>__copyFilter</b>(<i></i>) + <p> Private slot to copy the current filter to the clipboard. -</p><a NAME="AdBlockTreeWidget.__itemChanged" ID="AdBlockTreeWidget.__itemChanged"></a> +</p> +<a NAME="AdBlockTreeWidget.__itemChanged" ID="AdBlockTreeWidget.__itemChanged"></a> <h4>AdBlockTreeWidget.__itemChanged</h4> <b>__itemChanged</b>(<i>itm</i>) + <p> Private slot to handle the change of an item. -</p><dl> +</p> +<dl> + <dt><i>itm</i> (QTreeWidgetItem)</dt> <dd> changed item </dd> -</dl><a NAME="AdBlockTreeWidget.__subscriptionChanged" ID="AdBlockTreeWidget.__subscriptionChanged"></a> +</dl> +<a NAME="AdBlockTreeWidget.__subscriptionChanged" ID="AdBlockTreeWidget.__subscriptionChanged"></a> <h4>AdBlockTreeWidget.__subscriptionChanged</h4> <b>__subscriptionChanged</b>(<i></i>) + <p> Private slot handling a subscription change. -</p><a NAME="AdBlockTreeWidget.addRule" ID="AdBlockTreeWidget.addRule"></a> +</p> +<a NAME="AdBlockTreeWidget.addRule" ID="AdBlockTreeWidget.addRule"></a> <h4>AdBlockTreeWidget.addRule</h4> <b>addRule</b>(<i>filterRule=""</i>) + <p> Public slot to add a new rule. -</p><dl> +</p> +<dl> + <dt><i>filterRule</i> (str)</dt> <dd> filter to be added </dd> -</dl><a NAME="AdBlockTreeWidget.keyPressEvent" ID="AdBlockTreeWidget.keyPressEvent"></a> +</dl> +<a NAME="AdBlockTreeWidget.keyPressEvent" ID="AdBlockTreeWidget.keyPressEvent"></a> <h4>AdBlockTreeWidget.keyPressEvent</h4> <b>keyPressEvent</b>(<i>evt</i>) + <p> Protected method handling key presses. -</p><dl> +</p> +<dl> + <dt><i>evt</i> (QKeyEvent)</dt> <dd> key press event </dd> -</dl><a NAME="AdBlockTreeWidget.refresh" ID="AdBlockTreeWidget.refresh"></a> +</dl> +<a NAME="AdBlockTreeWidget.refresh" ID="AdBlockTreeWidget.refresh"></a> <h4>AdBlockTreeWidget.refresh</h4> <b>refresh</b>(<i></i>) + <p> Public method to refresh the tree. -</p><a NAME="AdBlockTreeWidget.removeRule" ID="AdBlockTreeWidget.removeRule"></a> +</p> +<a NAME="AdBlockTreeWidget.removeRule" ID="AdBlockTreeWidget.removeRule"></a> <h4>AdBlockTreeWidget.removeRule</h4> <b>removeRule</b>(<i></i>) + <p> Public slot to remove the current rule. -</p><a NAME="AdBlockTreeWidget.showRule" ID="AdBlockTreeWidget.showRule"></a> +</p> +<a NAME="AdBlockTreeWidget.showRule" ID="AdBlockTreeWidget.showRule"></a> <h4>AdBlockTreeWidget.showRule</h4> <b>showRule</b>(<i>rule</i>) + <p> Public method to highlight the given rule. -</p><dl> +</p> +<dl> + <dt><i>rule</i> (AdBlockRule)</dt> <dd> AdBlock rule to be shown </dd> -</dl><a NAME="AdBlockTreeWidget.subscription" ID="AdBlockTreeWidget.subscription"></a> +</dl> +<a NAME="AdBlockTreeWidget.subscription" ID="AdBlockTreeWidget.subscription"></a> <h4>AdBlockTreeWidget.subscription</h4> <b>subscription</b>(<i></i>) + <p> Public method to get a reference to the subscription. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> reference to the subscription </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> AdBlockSubscription