Documentation/Source/eric6.WebBrowser.AdBlock.AdBlockDialog.html

changeset 4918
71caf42a13d8
child 5606
da305d172769
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric6.WebBrowser.AdBlock.AdBlockDialog.html	Sun Apr 03 17:10:43 2016 +0200
@@ -0,0 +1,284 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric6.WebBrowser.AdBlock.AdBlockDialog</title>
+<meta charset="UTF-8">
+<style>
+body {
+    background: #EDECE6;
+    margin: 0em 1em 10em 1em;
+    color: black;
+}
+
+h1 { color: white; background: #85774A; }
+h2 { color: white; background: #85774A; }
+h3 { color: white; background: #9D936E; }
+h4 { color: white; background: #9D936E; }
+    
+a { color: #BA6D36; }
+
+</style>
+</head>
+<body><a NAME="top" ID="top"></a>
+<h1>eric6.WebBrowser.AdBlock.AdBlockDialog</h1>
+<p>
+Module implementing the AdBlock configuration dialog.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#AdBlockDialog">AdBlockDialog</a></td>
+<td>Class implementing the AdBlock configuration dialog.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr /><hr />
+<a NAME="AdBlockDialog" ID="AdBlockDialog"></a>
+<h2>AdBlockDialog</h2>
+<p>
+    Class implementing the AdBlock configuration dialog.
+</p>
+<h3>Derived from</h3>
+QDialog, Ui_AdBlockDialog
+<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="#AdBlockDialog.__init__">AdBlockDialog</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#AdBlockDialog.__aboutToShowActionMenu">__aboutToShowActionMenu</a></td>
+<td>Private slot to show the actions menu.</td>
+</tr><tr>
+<td><a href="#AdBlockDialog.__addCustomRule">__addCustomRule</a></td>
+<td>Private slot to add a custom AdBlock rule.</td>
+</tr><tr>
+<td><a href="#AdBlockDialog.__browseSubscriptions">__browseSubscriptions</a></td>
+<td>Private slot to browse the list of available AdBlock subscriptions.</td>
+</tr><tr>
+<td><a href="#AdBlockDialog.__learnAboutWritingFilters">__learnAboutWritingFilters</a></td>
+<td>Private slot to show the web page about how to write filters.</td>
+</tr><tr>
+<td><a href="#AdBlockDialog.__load">__load</a></td>
+<td>Private slot to populate the tab widget with subscriptions.</td>
+</tr><tr>
+<td><a href="#AdBlockDialog.__loadSubscriptions">__loadSubscriptions</a></td>
+<td>Private slot to load the AdBlock subscription rules.</td>
+</tr><tr>
+<td><a href="#AdBlockDialog.__removeCustomRule">__removeCustomRule</a></td>
+<td>Private slot to remove a custom AdBlock rule.</td>
+</tr><tr>
+<td><a href="#AdBlockDialog.__removeSubscription">__removeSubscription</a></td>
+<td>Private slot to remove the selected subscription.</td>
+</tr><tr>
+<td><a href="#AdBlockDialog.__setSubscriptionEnabled">__setSubscriptionEnabled</a></td>
+<td>Private slot to set the enabled state of a subscription.</td>
+</tr><tr>
+<td><a href="#AdBlockDialog.__switchSubscriptionEnabled">__switchSubscriptionEnabled</a></td>
+<td>Private slot to switch the enabled state of the selected subscription.</td>
+</tr><tr>
+<td><a href="#AdBlockDialog.__updateAllSubscriptions">__updateAllSubscriptions</a></td>
+<td>Private slot to update all subscriptions.</td>
+</tr><tr>
+<td><a href="#AdBlockDialog.__updateSubscription">__updateSubscription</a></td>
+<td>Private slot to update the selected subscription.</td>
+</tr><tr>
+<td><a href="#AdBlockDialog.addCustomRule">addCustomRule</a></td>
+<td>Public slot to add a custom AdBlock rule.</td>
+</tr><tr>
+<td><a href="#AdBlockDialog.addSubscription">addSubscription</a></td>
+<td>Public slot adding a subscription to the list.</td>
+</tr><tr>
+<td><a href="#AdBlockDialog.on_adBlockGroup_toggled">on_adBlockGroup_toggled</a></td>
+<td>Private slot handling the enabling/disabling of AdBlock.</td>
+</tr><tr>
+<td><a href="#AdBlockDialog.on_searchEdit_textChanged">on_searchEdit_textChanged</a></td>
+<td>Private slot to set a new filter on the current widget.</td>
+</tr><tr>
+<td><a href="#AdBlockDialog.on_subscriptionsTabWidget_currentChanged">on_subscriptionsTabWidget_currentChanged</a></td>
+<td>Private slot handling the selection of another tab.</td>
+</tr><tr>
+<td><a href="#AdBlockDialog.on_updateSpinBox_valueChanged">on_updateSpinBox_valueChanged</a></td>
+<td>Private slot to handle changes of the update period.</td>
+</tr><tr>
+<td><a href="#AdBlockDialog.on_useLimitedEasyListCheckBox_clicked">on_useLimitedEasyListCheckBox_clicked</a></td>
+<td>Private slot handling the selection of the limited EasyList.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<a NAME="AdBlockDialog.__init__" ID="AdBlockDialog.__init__"></a>
+<h4>AdBlockDialog (Constructor)</h4>
+<b>AdBlockDialog</b>(<i>manager, parent=None</i>)
+<p>
+        Constructor
+</p><dl>
+<dt><i>manager</i></dt>
+<dd>
+reference to the AdBlock manager (AdBlockManager)
+</dd><dt><i>parent</i></dt>
+<dd>
+reference to the parent object (QWidget)
+</dd>
+</dl><a NAME="AdBlockDialog.__aboutToShowActionMenu" ID="AdBlockDialog.__aboutToShowActionMenu"></a>
+<h4>AdBlockDialog.__aboutToShowActionMenu</h4>
+<b>__aboutToShowActionMenu</b>(<i></i>)
+<p>
+        Private slot to show the actions menu.
+</p><a NAME="AdBlockDialog.__addCustomRule" ID="AdBlockDialog.__addCustomRule"></a>
+<h4>AdBlockDialog.__addCustomRule</h4>
+<b>__addCustomRule</b>(<i></i>)
+<p>
+        Private slot to add a custom AdBlock rule.
+</p><a NAME="AdBlockDialog.__browseSubscriptions" ID="AdBlockDialog.__browseSubscriptions"></a>
+<h4>AdBlockDialog.__browseSubscriptions</h4>
+<b>__browseSubscriptions</b>(<i></i>)
+<p>
+        Private slot to browse the list of available AdBlock subscriptions.
+</p><a NAME="AdBlockDialog.__learnAboutWritingFilters" ID="AdBlockDialog.__learnAboutWritingFilters"></a>
+<h4>AdBlockDialog.__learnAboutWritingFilters</h4>
+<b>__learnAboutWritingFilters</b>(<i></i>)
+<p>
+        Private slot to show the web page about how to write filters.
+</p><a NAME="AdBlockDialog.__load" ID="AdBlockDialog.__load"></a>
+<h4>AdBlockDialog.__load</h4>
+<b>__load</b>(<i></i>)
+<p>
+        Private slot to populate the tab widget with subscriptions.
+</p><a NAME="AdBlockDialog.__loadSubscriptions" ID="AdBlockDialog.__loadSubscriptions"></a>
+<h4>AdBlockDialog.__loadSubscriptions</h4>
+<b>__loadSubscriptions</b>(<i></i>)
+<p>
+        Private slot to load the AdBlock subscription rules.
+</p><a NAME="AdBlockDialog.__removeCustomRule" ID="AdBlockDialog.__removeCustomRule"></a>
+<h4>AdBlockDialog.__removeCustomRule</h4>
+<b>__removeCustomRule</b>(<i></i>)
+<p>
+        Private slot to remove a custom AdBlock rule.
+</p><a NAME="AdBlockDialog.__removeSubscription" ID="AdBlockDialog.__removeSubscription"></a>
+<h4>AdBlockDialog.__removeSubscription</h4>
+<b>__removeSubscription</b>(<i></i>)
+<p>
+        Private slot to remove the selected subscription.
+</p><a NAME="AdBlockDialog.__setSubscriptionEnabled" ID="AdBlockDialog.__setSubscriptionEnabled"></a>
+<h4>AdBlockDialog.__setSubscriptionEnabled</h4>
+<b>__setSubscriptionEnabled</b>(<i>subscription, enable</i>)
+<p>
+        Private slot to set the enabled state of a subscription.
+</p><dl>
+<dt><i>subscription</i></dt>
+<dd>
+subscription to set the state for
+            (AdBlockSubscription)
+</dd><dt><i>enable</i></dt>
+<dd>
+state to set to (boolean)
+</dd>
+</dl><a NAME="AdBlockDialog.__switchSubscriptionEnabled" ID="AdBlockDialog.__switchSubscriptionEnabled"></a>
+<h4>AdBlockDialog.__switchSubscriptionEnabled</h4>
+<b>__switchSubscriptionEnabled</b>(<i></i>)
+<p>
+        Private slot to switch the enabled state of the selected subscription.
+</p><a NAME="AdBlockDialog.__updateAllSubscriptions" ID="AdBlockDialog.__updateAllSubscriptions"></a>
+<h4>AdBlockDialog.__updateAllSubscriptions</h4>
+<b>__updateAllSubscriptions</b>(<i></i>)
+<p>
+        Private slot to update all subscriptions.
+</p><a NAME="AdBlockDialog.__updateSubscription" ID="AdBlockDialog.__updateSubscription"></a>
+<h4>AdBlockDialog.__updateSubscription</h4>
+<b>__updateSubscription</b>(<i></i>)
+<p>
+        Private slot to update the selected subscription.
+</p><a NAME="AdBlockDialog.addCustomRule" ID="AdBlockDialog.addCustomRule"></a>
+<h4>AdBlockDialog.addCustomRule</h4>
+<b>addCustomRule</b>(<i>filter</i>)
+<p>
+        Public slot to add a custom AdBlock rule.
+</p><dl>
+<dt><i>filter</i></dt>
+<dd>
+filter to be added (string)
+</dd>
+</dl><a NAME="AdBlockDialog.addSubscription" ID="AdBlockDialog.addSubscription"></a>
+<h4>AdBlockDialog.addSubscription</h4>
+<b>addSubscription</b>(<i>subscription, refresh=True</i>)
+<p>
+        Public slot adding a subscription to the list.
+</p><dl>
+<dt><i>subscription</i></dt>
+<dd>
+reference to the subscription to be
+            added (AdBlockSubscription)
+</dd><dt><i>refresh</i></dt>
+<dd>
+flag indicating to refresh the tree (boolean)
+</dd>
+</dl><a NAME="AdBlockDialog.on_adBlockGroup_toggled" ID="AdBlockDialog.on_adBlockGroup_toggled"></a>
+<h4>AdBlockDialog.on_adBlockGroup_toggled</h4>
+<b>on_adBlockGroup_toggled</b>(<i>state</i>)
+<p>
+        Private slot handling the enabling/disabling of AdBlock.
+</p><dl>
+<dt><i>state</i></dt>
+<dd>
+state of the toggle (boolean)
+</dd>
+</dl><a NAME="AdBlockDialog.on_searchEdit_textChanged" ID="AdBlockDialog.on_searchEdit_textChanged"></a>
+<h4>AdBlockDialog.on_searchEdit_textChanged</h4>
+<b>on_searchEdit_textChanged</b>(<i>filter</i>)
+<p>
+        Private slot to set a new filter on the current widget.
+</p><dl>
+<dt><i>filter</i></dt>
+<dd>
+filter to be set (string)
+</dd>
+</dl><a NAME="AdBlockDialog.on_subscriptionsTabWidget_currentChanged" ID="AdBlockDialog.on_subscriptionsTabWidget_currentChanged"></a>
+<h4>AdBlockDialog.on_subscriptionsTabWidget_currentChanged</h4>
+<b>on_subscriptionsTabWidget_currentChanged</b>(<i>index</i>)
+<p>
+        Private slot handling the selection of another tab.
+</p><dl>
+<dt><i>index</i></dt>
+<dd>
+index of the new current tab (integer)
+</dd>
+</dl><a NAME="AdBlockDialog.on_updateSpinBox_valueChanged" ID="AdBlockDialog.on_updateSpinBox_valueChanged"></a>
+<h4>AdBlockDialog.on_updateSpinBox_valueChanged</h4>
+<b>on_updateSpinBox_valueChanged</b>(<i>value</i>)
+<p>
+        Private slot to handle changes of the update period.
+</p><dl>
+<dt><i>value</i></dt>
+<dd>
+update period (integer)
+</dd>
+</dl><a NAME="AdBlockDialog.on_useLimitedEasyListCheckBox_clicked" ID="AdBlockDialog.on_useLimitedEasyListCheckBox_clicked"></a>
+<h4>AdBlockDialog.on_useLimitedEasyListCheckBox_clicked</h4>
+<b>on_useLimitedEasyListCheckBox_clicked</b>(<i>checked</i>)
+<p>
+        Private slot handling the selection of the limited EasyList.
+</p><dl>
+<dt><i>checked</i> (bool)</dt>
+<dd>
+flag indicating the state of the check box
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial