--- a/Documentation/Source/eric5.Helpviewer.AdBlock.AdBlockDialog.html Mon Jul 30 19:19:29 2012 +0200 +++ b/Documentation/Source/eric5.Helpviewer.AdBlock.AdBlockDialog.html Sat Aug 04 13:30:04 2012 +0200 @@ -64,30 +64,54 @@ <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> +<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.model">model</a></td> -<td>Public method to return a reference to the subscriptions tree model.</td> +<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.setCurrentIndex">setCurrentIndex</a></td> -<td>Private slot to set the current index of the subscriptions tree.</td> -</tr><tr> <td><a href="#AdBlockDialog.showRule">showRule</a></td> <td>Public slot to show the given rule.</td> </tr> @@ -106,6 +130,11 @@ <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>) @@ -116,32 +145,99 @@ <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>rule=""</i>) +</p><a NAME="AdBlockDialog.addSubscription" ID="AdBlockDialog.addSubscription"></a> +<h4>AdBlockDialog.addSubscription</h4> +<b>addSubscription</b>(<i>subscription, refresh=True</i>) <p> - Public slot to add a custom AdBlock rule. + Public slot adding a subscription to the list. </p><dl> -<dt><i>rule</i></dt> +<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> -string defining the rule to be added (string) +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.model" ID="AdBlockDialog.model"></a> -<h4>AdBlockDialog.model</h4> -<b>model</b>(<i></i>) +</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> - Public method to return a reference to the subscriptions tree model. -</p><a NAME="AdBlockDialog.on_updateSpinBox_valueChanged" ID="AdBlockDialog.on_updateSpinBox_valueChanged"></a> + 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> @@ -151,16 +247,6 @@ <dd> update period (integer) </dd> -</dl><a NAME="AdBlockDialog.setCurrentIndex" ID="AdBlockDialog.setCurrentIndex"></a> -<h4>AdBlockDialog.setCurrentIndex</h4> -<b>setCurrentIndex</b>(<i>index</i>) -<p> - Private slot to set the current index of the subscriptions tree. -</p><dl> -<dt><i>index</i></dt> -<dd> -index to be set (QModelIndex) -</dd> </dl><a NAME="AdBlockDialog.showRule" ID="AdBlockDialog.showRule"></a> <h4>AdBlockDialog.showRule</h4> <b>showRule</b>(<i>rule</i>)