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

changeset 6942
2602857055c5
parent 6028
859f6894eed9
child 7273
391d6b7b1eff
equal deleted inserted replaced
6941:f99d60d6b59b 6942:2602857055c5
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.WebBrowser.AdBlock.AdBlockDialog</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body><a NAME="top" ID="top"></a>
22 <h1>eric6.WebBrowser.AdBlock.AdBlockDialog</h1>
23 <p>
24 Module implementing the AdBlock configuration dialog.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#AdBlockDialog">AdBlockDialog</a></td>
34 <td>Class implementing the AdBlock configuration dialog.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="AdBlockDialog" ID="AdBlockDialog"></a>
43 <h2>AdBlockDialog</h2>
44 <p>
45 Class implementing the AdBlock configuration dialog.
46 </p>
47 <h3>Derived from</h3>
48 QDialog, Ui_AdBlockDialog
49 <h3>Class Attributes</h3>
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <h3>Class Methods</h3>
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Methods</h3>
58 <table>
59 <tr>
60 <td><a href="#AdBlockDialog.__init__">AdBlockDialog</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#AdBlockDialog.__aboutToShowActionMenu">__aboutToShowActionMenu</a></td>
64 <td>Private slot to show the actions menu.</td>
65 </tr><tr>
66 <td><a href="#AdBlockDialog.__addCustomRule">__addCustomRule</a></td>
67 <td>Private slot to add a custom AdBlock rule.</td>
68 </tr><tr>
69 <td><a href="#AdBlockDialog.__browseSubscriptions">__browseSubscriptions</a></td>
70 <td>Private slot to browse the list of available AdBlock subscriptions.</td>
71 </tr><tr>
72 <td><a href="#AdBlockDialog.__learnAboutWritingFilters">__learnAboutWritingFilters</a></td>
73 <td>Private slot to show the web page about how to write filters.</td>
74 </tr><tr>
75 <td><a href="#AdBlockDialog.__load">__load</a></td>
76 <td>Private slot to populate the tab widget with subscriptions.</td>
77 </tr><tr>
78 <td><a href="#AdBlockDialog.__loadSubscriptions">__loadSubscriptions</a></td>
79 <td>Private slot to load the AdBlock subscription rules.</td>
80 </tr><tr>
81 <td><a href="#AdBlockDialog.__managerEnabledChanged">__managerEnabledChanged</a></td>
82 <td>Private slot handling a change of the AdBlock manager enabled state.</td>
83 </tr><tr>
84 <td><a href="#AdBlockDialog.__removeCustomRule">__removeCustomRule</a></td>
85 <td>Private slot to remove a custom AdBlock rule.</td>
86 </tr><tr>
87 <td><a href="#AdBlockDialog.__removeSubscription">__removeSubscription</a></td>
88 <td>Private slot to remove the selected subscription.</td>
89 </tr><tr>
90 <td><a href="#AdBlockDialog.__setSubscriptionEnabled">__setSubscriptionEnabled</a></td>
91 <td>Private slot to set the enabled state of a subscription.</td>
92 </tr><tr>
93 <td><a href="#AdBlockDialog.__switchSubscriptionEnabled">__switchSubscriptionEnabled</a></td>
94 <td>Private slot to switch the enabled state of the selected subscription.</td>
95 </tr><tr>
96 <td><a href="#AdBlockDialog.__updateAllSubscriptions">__updateAllSubscriptions</a></td>
97 <td>Private slot to update all subscriptions.</td>
98 </tr><tr>
99 <td><a href="#AdBlockDialog.__updateSubscription">__updateSubscription</a></td>
100 <td>Private slot to update the selected subscription.</td>
101 </tr><tr>
102 <td><a href="#AdBlockDialog.addCustomRule">addCustomRule</a></td>
103 <td>Public slot to add a custom AdBlock rule.</td>
104 </tr><tr>
105 <td><a href="#AdBlockDialog.addSubscription">addSubscription</a></td>
106 <td>Public slot adding a subscription to the list.</td>
107 </tr><tr>
108 <td><a href="#AdBlockDialog.on_adBlockGroup_toggled">on_adBlockGroup_toggled</a></td>
109 <td>Private slot handling the enabling/disabling of AdBlock.</td>
110 </tr><tr>
111 <td><a href="#AdBlockDialog.on_searchEdit_textChanged">on_searchEdit_textChanged</a></td>
112 <td>Private slot to set a new filter on the current widget.</td>
113 </tr><tr>
114 <td><a href="#AdBlockDialog.on_subscriptionsTabWidget_currentChanged">on_subscriptionsTabWidget_currentChanged</a></td>
115 <td>Private slot handling the selection of another tab.</td>
116 </tr><tr>
117 <td><a href="#AdBlockDialog.on_updateSpinBox_valueChanged">on_updateSpinBox_valueChanged</a></td>
118 <td>Private slot to handle changes of the update period.</td>
119 </tr><tr>
120 <td><a href="#AdBlockDialog.on_useLimitedEasyListCheckBox_clicked">on_useLimitedEasyListCheckBox_clicked</a></td>
121 <td>Private slot handling the selection of the limited EasyList.</td>
122 </tr>
123 </table>
124 <h3>Static Methods</h3>
125 <table>
126 <tr><td>None</td></tr>
127 </table>
128 <a NAME="AdBlockDialog.__init__" ID="AdBlockDialog.__init__"></a>
129 <h4>AdBlockDialog (Constructor)</h4>
130 <b>AdBlockDialog</b>(<i>manager, parent=None</i>)
131 <p>
132 Constructor
133 </p><dl>
134 <dt><i>manager</i> (AdBlockManager)</dt>
135 <dd>
136 reference to the AdBlock manager
137 </dd><dt><i>parent</i> (QWidget)</dt>
138 <dd>
139 reference to the parent object
140 </dd>
141 </dl><a NAME="AdBlockDialog.__aboutToShowActionMenu" ID="AdBlockDialog.__aboutToShowActionMenu"></a>
142 <h4>AdBlockDialog.__aboutToShowActionMenu</h4>
143 <b>__aboutToShowActionMenu</b>(<i></i>)
144 <p>
145 Private slot to show the actions menu.
146 </p><a NAME="AdBlockDialog.__addCustomRule" ID="AdBlockDialog.__addCustomRule"></a>
147 <h4>AdBlockDialog.__addCustomRule</h4>
148 <b>__addCustomRule</b>(<i></i>)
149 <p>
150 Private slot to add a custom AdBlock rule.
151 </p><a NAME="AdBlockDialog.__browseSubscriptions" ID="AdBlockDialog.__browseSubscriptions"></a>
152 <h4>AdBlockDialog.__browseSubscriptions</h4>
153 <b>__browseSubscriptions</b>(<i></i>)
154 <p>
155 Private slot to browse the list of available AdBlock subscriptions.
156 </p><a NAME="AdBlockDialog.__learnAboutWritingFilters" ID="AdBlockDialog.__learnAboutWritingFilters"></a>
157 <h4>AdBlockDialog.__learnAboutWritingFilters</h4>
158 <b>__learnAboutWritingFilters</b>(<i></i>)
159 <p>
160 Private slot to show the web page about how to write filters.
161 </p><a NAME="AdBlockDialog.__load" ID="AdBlockDialog.__load"></a>
162 <h4>AdBlockDialog.__load</h4>
163 <b>__load</b>(<i></i>)
164 <p>
165 Private slot to populate the tab widget with subscriptions.
166 </p><a NAME="AdBlockDialog.__loadSubscriptions" ID="AdBlockDialog.__loadSubscriptions"></a>
167 <h4>AdBlockDialog.__loadSubscriptions</h4>
168 <b>__loadSubscriptions</b>(<i></i>)
169 <p>
170 Private slot to load the AdBlock subscription rules.
171 </p><a NAME="AdBlockDialog.__managerEnabledChanged" ID="AdBlockDialog.__managerEnabledChanged"></a>
172 <h4>AdBlockDialog.__managerEnabledChanged</h4>
173 <b>__managerEnabledChanged</b>(<i>enabled</i>)
174 <p>
175 Private slot handling a change of the AdBlock manager enabled state.
176 </p><dl>
177 <dt><i>enabled</i> (bool)</dt>
178 <dd>
179 flag indicating the enabled state
180 </dd>
181 </dl><a NAME="AdBlockDialog.__removeCustomRule" ID="AdBlockDialog.__removeCustomRule"></a>
182 <h4>AdBlockDialog.__removeCustomRule</h4>
183 <b>__removeCustomRule</b>(<i></i>)
184 <p>
185 Private slot to remove a custom AdBlock rule.
186 </p><a NAME="AdBlockDialog.__removeSubscription" ID="AdBlockDialog.__removeSubscription"></a>
187 <h4>AdBlockDialog.__removeSubscription</h4>
188 <b>__removeSubscription</b>(<i></i>)
189 <p>
190 Private slot to remove the selected subscription.
191 </p><a NAME="AdBlockDialog.__setSubscriptionEnabled" ID="AdBlockDialog.__setSubscriptionEnabled"></a>
192 <h4>AdBlockDialog.__setSubscriptionEnabled</h4>
193 <b>__setSubscriptionEnabled</b>(<i>subscription, enable</i>)
194 <p>
195 Private slot to set the enabled state of a subscription.
196 </p><dl>
197 <dt><i>subscription</i> (AdBlockSubscription)</dt>
198 <dd>
199 subscription to set the state for
200 </dd><dt><i>enable</i> (bool)</dt>
201 <dd>
202 state to set to
203 </dd>
204 </dl><a NAME="AdBlockDialog.__switchSubscriptionEnabled" ID="AdBlockDialog.__switchSubscriptionEnabled"></a>
205 <h4>AdBlockDialog.__switchSubscriptionEnabled</h4>
206 <b>__switchSubscriptionEnabled</b>(<i></i>)
207 <p>
208 Private slot to switch the enabled state of the selected subscription.
209 </p><a NAME="AdBlockDialog.__updateAllSubscriptions" ID="AdBlockDialog.__updateAllSubscriptions"></a>
210 <h4>AdBlockDialog.__updateAllSubscriptions</h4>
211 <b>__updateAllSubscriptions</b>(<i></i>)
212 <p>
213 Private slot to update all subscriptions.
214 </p><a NAME="AdBlockDialog.__updateSubscription" ID="AdBlockDialog.__updateSubscription"></a>
215 <h4>AdBlockDialog.__updateSubscription</h4>
216 <b>__updateSubscription</b>(<i></i>)
217 <p>
218 Private slot to update the selected subscription.
219 </p><a NAME="AdBlockDialog.addCustomRule" ID="AdBlockDialog.addCustomRule"></a>
220 <h4>AdBlockDialog.addCustomRule</h4>
221 <b>addCustomRule</b>(<i>filterRule</i>)
222 <p>
223 Public slot to add a custom AdBlock rule.
224 </p><dl>
225 <dt><i>filterRule</i> (string)</dt>
226 <dd>
227 filter to be added
228 </dd>
229 </dl><a NAME="AdBlockDialog.addSubscription" ID="AdBlockDialog.addSubscription"></a>
230 <h4>AdBlockDialog.addSubscription</h4>
231 <b>addSubscription</b>(<i>subscription, refresh=True</i>)
232 <p>
233 Public slot adding a subscription to the list.
234 </p><dl>
235 <dt><i>subscription</i> (AdBlockSubscription)</dt>
236 <dd>
237 reference to the subscription to be
238 added
239 </dd><dt><i>refresh</i> (bool)</dt>
240 <dd>
241 flag indicating to refresh the tree
242 </dd>
243 </dl><a NAME="AdBlockDialog.on_adBlockGroup_toggled" ID="AdBlockDialog.on_adBlockGroup_toggled"></a>
244 <h4>AdBlockDialog.on_adBlockGroup_toggled</h4>
245 <b>on_adBlockGroup_toggled</b>(<i>state</i>)
246 <p>
247 Private slot handling the enabling/disabling of AdBlock.
248 </p><dl>
249 <dt><i>state</i> (bool)</dt>
250 <dd>
251 state of the toggle
252 </dd>
253 </dl><a NAME="AdBlockDialog.on_searchEdit_textChanged" ID="AdBlockDialog.on_searchEdit_textChanged"></a>
254 <h4>AdBlockDialog.on_searchEdit_textChanged</h4>
255 <b>on_searchEdit_textChanged</b>(<i>filterRule</i>)
256 <p>
257 Private slot to set a new filter on the current widget.
258 </p><dl>
259 <dt><i>filterRule</i> (str)</dt>
260 <dd>
261 filter to be set
262 </dd>
263 </dl><a NAME="AdBlockDialog.on_subscriptionsTabWidget_currentChanged" ID="AdBlockDialog.on_subscriptionsTabWidget_currentChanged"></a>
264 <h4>AdBlockDialog.on_subscriptionsTabWidget_currentChanged</h4>
265 <b>on_subscriptionsTabWidget_currentChanged</b>(<i>index</i>)
266 <p>
267 Private slot handling the selection of another tab.
268 </p><dl>
269 <dt><i>index</i> (int)</dt>
270 <dd>
271 index of the new current tab
272 </dd>
273 </dl><a NAME="AdBlockDialog.on_updateSpinBox_valueChanged" ID="AdBlockDialog.on_updateSpinBox_valueChanged"></a>
274 <h4>AdBlockDialog.on_updateSpinBox_valueChanged</h4>
275 <b>on_updateSpinBox_valueChanged</b>(<i>value</i>)
276 <p>
277 Private slot to handle changes of the update period.
278 </p><dl>
279 <dt><i>value</i> (int)</dt>
280 <dd>
281 update period
282 </dd>
283 </dl><a NAME="AdBlockDialog.on_useLimitedEasyListCheckBox_clicked" ID="AdBlockDialog.on_useLimitedEasyListCheckBox_clicked"></a>
284 <h4>AdBlockDialog.on_useLimitedEasyListCheckBox_clicked</h4>
285 <b>on_useLimitedEasyListCheckBox_clicked</b>(<i>checked</i>)
286 <p>
287 Private slot handling the selection of the limited EasyList.
288 </p><dl>
289 <dt><i>checked</i> (bool)</dt>
290 <dd>
291 flag indicating the state of the check box
292 </dd>
293 </dl>
294 <div align="right"><a href="#top">Up</a></div>
295 <hr />
296 </body></html>

eric ide

mercurial