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

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
equal deleted inserted replaced
8371:d6062691d424 8372:e0227a7c850e
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.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>
22 <a NAME="top" ID="top"></a>
23 <h1>eric7.WebBrowser.AdBlock.AdBlockDialog</h1>
24
25 <p>
26 Module implementing the AdBlock configuration dialog.
27 </p>
28 <h3>Global Attributes</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <h3>Classes</h3>
34
35 <table>
36
37 <tr>
38 <td><a href="#AdBlockDialog">AdBlockDialog</a></td>
39 <td>Class implementing the AdBlock configuration dialog.</td>
40 </tr>
41 </table>
42 <h3>Functions</h3>
43
44 <table>
45 <tr><td>None</td></tr>
46 </table>
47 <hr />
48 <hr />
49 <a NAME="AdBlockDialog" ID="AdBlockDialog"></a>
50 <h2>AdBlockDialog</h2>
51
52 <p>
53 Class implementing the AdBlock configuration dialog.
54 </p>
55 <h3>Derived from</h3>
56 QDialog, Ui_AdBlockDialog
57 <h3>Class Attributes</h3>
58
59 <table>
60 <tr><td>None</td></tr>
61 </table>
62 <h3>Class Methods</h3>
63
64 <table>
65 <tr><td>None</td></tr>
66 </table>
67 <h3>Methods</h3>
68
69 <table>
70
71 <tr>
72 <td><a href="#AdBlockDialog.__init__">AdBlockDialog</a></td>
73 <td>Constructor</td>
74 </tr>
75 <tr>
76 <td><a href="#AdBlockDialog.__aboutToShowActionMenu">__aboutToShowActionMenu</a></td>
77 <td>Private slot to show the actions menu.</td>
78 </tr>
79 <tr>
80 <td><a href="#AdBlockDialog.__addCustomRule">__addCustomRule</a></td>
81 <td>Private slot to add a custom AdBlock rule.</td>
82 </tr>
83 <tr>
84 <td><a href="#AdBlockDialog.__browseSubscriptions">__browseSubscriptions</a></td>
85 <td>Private slot to browse the list of available AdBlock subscriptions.</td>
86 </tr>
87 <tr>
88 <td><a href="#AdBlockDialog.__learnAboutWritingFilters">__learnAboutWritingFilters</a></td>
89 <td>Private slot to show the web page about how to write filters.</td>
90 </tr>
91 <tr>
92 <td><a href="#AdBlockDialog.__load">__load</a></td>
93 <td>Private slot to populate the tab widget with subscriptions.</td>
94 </tr>
95 <tr>
96 <td><a href="#AdBlockDialog.__loadSubscriptions">__loadSubscriptions</a></td>
97 <td>Private slot to load the AdBlock subscription rules.</td>
98 </tr>
99 <tr>
100 <td><a href="#AdBlockDialog.__managerEnabledChanged">__managerEnabledChanged</a></td>
101 <td>Private slot handling a change of the AdBlock manager enabled state.</td>
102 </tr>
103 <tr>
104 <td><a href="#AdBlockDialog.__removeCustomRule">__removeCustomRule</a></td>
105 <td>Private slot to remove a custom AdBlock rule.</td>
106 </tr>
107 <tr>
108 <td><a href="#AdBlockDialog.__removeSubscription">__removeSubscription</a></td>
109 <td>Private slot to remove the selected subscription.</td>
110 </tr>
111 <tr>
112 <td><a href="#AdBlockDialog.__setSubscriptionEnabled">__setSubscriptionEnabled</a></td>
113 <td>Private slot to set the enabled state of a subscription.</td>
114 </tr>
115 <tr>
116 <td><a href="#AdBlockDialog.__switchSubscriptionEnabled">__switchSubscriptionEnabled</a></td>
117 <td>Private slot to switch the enabled state of the selected subscription.</td>
118 </tr>
119 <tr>
120 <td><a href="#AdBlockDialog.__updateAllSubscriptions">__updateAllSubscriptions</a></td>
121 <td>Private slot to update all subscriptions.</td>
122 </tr>
123 <tr>
124 <td><a href="#AdBlockDialog.__updateSubscription">__updateSubscription</a></td>
125 <td>Private slot to update the selected subscription.</td>
126 </tr>
127 <tr>
128 <td><a href="#AdBlockDialog.addCustomRule">addCustomRule</a></td>
129 <td>Public slot to add a custom AdBlock rule.</td>
130 </tr>
131 <tr>
132 <td><a href="#AdBlockDialog.addSubscription">addSubscription</a></td>
133 <td>Public slot adding a subscription to the list.</td>
134 </tr>
135 <tr>
136 <td><a href="#AdBlockDialog.on_adBlockGroup_toggled">on_adBlockGroup_toggled</a></td>
137 <td>Private slot handling the enabling/disabling of AdBlock.</td>
138 </tr>
139 <tr>
140 <td><a href="#AdBlockDialog.on_searchEdit_textChanged">on_searchEdit_textChanged</a></td>
141 <td>Private slot to set a new filter on the current widget.</td>
142 </tr>
143 <tr>
144 <td><a href="#AdBlockDialog.on_subscriptionsTabWidget_currentChanged">on_subscriptionsTabWidget_currentChanged</a></td>
145 <td>Private slot handling the selection of another tab.</td>
146 </tr>
147 <tr>
148 <td><a href="#AdBlockDialog.on_updateSpinBox_valueChanged">on_updateSpinBox_valueChanged</a></td>
149 <td>Private slot to handle changes of the update period.</td>
150 </tr>
151 <tr>
152 <td><a href="#AdBlockDialog.on_useLimitedEasyListCheckBox_clicked">on_useLimitedEasyListCheckBox_clicked</a></td>
153 <td>Private slot handling the selection of the limited EasyList.</td>
154 </tr>
155 </table>
156 <h3>Static Methods</h3>
157
158 <table>
159 <tr><td>None</td></tr>
160 </table>
161
162 <a NAME="AdBlockDialog.__init__" ID="AdBlockDialog.__init__"></a>
163 <h4>AdBlockDialog (Constructor)</h4>
164 <b>AdBlockDialog</b>(<i>manager, parent=None</i>)
165
166 <p>
167 Constructor
168 </p>
169 <dl>
170
171 <dt><i>manager</i> (AdBlockManager)</dt>
172 <dd>
173 reference to the AdBlock manager
174 </dd>
175 <dt><i>parent</i> (QWidget)</dt>
176 <dd>
177 reference to the parent object
178 </dd>
179 </dl>
180 <a NAME="AdBlockDialog.__aboutToShowActionMenu" ID="AdBlockDialog.__aboutToShowActionMenu"></a>
181 <h4>AdBlockDialog.__aboutToShowActionMenu</h4>
182 <b>__aboutToShowActionMenu</b>(<i></i>)
183
184 <p>
185 Private slot to show the actions menu.
186 </p>
187 <a NAME="AdBlockDialog.__addCustomRule" ID="AdBlockDialog.__addCustomRule"></a>
188 <h4>AdBlockDialog.__addCustomRule</h4>
189 <b>__addCustomRule</b>(<i></i>)
190
191 <p>
192 Private slot to add a custom AdBlock rule.
193 </p>
194 <a NAME="AdBlockDialog.__browseSubscriptions" ID="AdBlockDialog.__browseSubscriptions"></a>
195 <h4>AdBlockDialog.__browseSubscriptions</h4>
196 <b>__browseSubscriptions</b>(<i></i>)
197
198 <p>
199 Private slot to browse the list of available AdBlock subscriptions.
200 </p>
201 <a NAME="AdBlockDialog.__learnAboutWritingFilters" ID="AdBlockDialog.__learnAboutWritingFilters"></a>
202 <h4>AdBlockDialog.__learnAboutWritingFilters</h4>
203 <b>__learnAboutWritingFilters</b>(<i></i>)
204
205 <p>
206 Private slot to show the web page about how to write filters.
207 </p>
208 <a NAME="AdBlockDialog.__load" ID="AdBlockDialog.__load"></a>
209 <h4>AdBlockDialog.__load</h4>
210 <b>__load</b>(<i></i>)
211
212 <p>
213 Private slot to populate the tab widget with subscriptions.
214 </p>
215 <a NAME="AdBlockDialog.__loadSubscriptions" ID="AdBlockDialog.__loadSubscriptions"></a>
216 <h4>AdBlockDialog.__loadSubscriptions</h4>
217 <b>__loadSubscriptions</b>(<i></i>)
218
219 <p>
220 Private slot to load the AdBlock subscription rules.
221 </p>
222 <a NAME="AdBlockDialog.__managerEnabledChanged" ID="AdBlockDialog.__managerEnabledChanged"></a>
223 <h4>AdBlockDialog.__managerEnabledChanged</h4>
224 <b>__managerEnabledChanged</b>(<i>enabled</i>)
225
226 <p>
227 Private slot handling a change of the AdBlock manager enabled state.
228 </p>
229 <dl>
230
231 <dt><i>enabled</i> (bool)</dt>
232 <dd>
233 flag indicating the enabled state
234 </dd>
235 </dl>
236 <a NAME="AdBlockDialog.__removeCustomRule" ID="AdBlockDialog.__removeCustomRule"></a>
237 <h4>AdBlockDialog.__removeCustomRule</h4>
238 <b>__removeCustomRule</b>(<i></i>)
239
240 <p>
241 Private slot to remove a custom AdBlock rule.
242 </p>
243 <a NAME="AdBlockDialog.__removeSubscription" ID="AdBlockDialog.__removeSubscription"></a>
244 <h4>AdBlockDialog.__removeSubscription</h4>
245 <b>__removeSubscription</b>(<i></i>)
246
247 <p>
248 Private slot to remove the selected subscription.
249 </p>
250 <a NAME="AdBlockDialog.__setSubscriptionEnabled" ID="AdBlockDialog.__setSubscriptionEnabled"></a>
251 <h4>AdBlockDialog.__setSubscriptionEnabled</h4>
252 <b>__setSubscriptionEnabled</b>(<i>subscription, enable</i>)
253
254 <p>
255 Private slot to set the enabled state of a subscription.
256 </p>
257 <dl>
258
259 <dt><i>subscription</i> (AdBlockSubscription)</dt>
260 <dd>
261 subscription to set the state for
262 </dd>
263 <dt><i>enable</i> (bool)</dt>
264 <dd>
265 state to set to
266 </dd>
267 </dl>
268 <a NAME="AdBlockDialog.__switchSubscriptionEnabled" ID="AdBlockDialog.__switchSubscriptionEnabled"></a>
269 <h4>AdBlockDialog.__switchSubscriptionEnabled</h4>
270 <b>__switchSubscriptionEnabled</b>(<i></i>)
271
272 <p>
273 Private slot to switch the enabled state of the selected subscription.
274 </p>
275 <a NAME="AdBlockDialog.__updateAllSubscriptions" ID="AdBlockDialog.__updateAllSubscriptions"></a>
276 <h4>AdBlockDialog.__updateAllSubscriptions</h4>
277 <b>__updateAllSubscriptions</b>(<i></i>)
278
279 <p>
280 Private slot to update all subscriptions.
281 </p>
282 <a NAME="AdBlockDialog.__updateSubscription" ID="AdBlockDialog.__updateSubscription"></a>
283 <h4>AdBlockDialog.__updateSubscription</h4>
284 <b>__updateSubscription</b>(<i></i>)
285
286 <p>
287 Private slot to update the selected subscription.
288 </p>
289 <a NAME="AdBlockDialog.addCustomRule" ID="AdBlockDialog.addCustomRule"></a>
290 <h4>AdBlockDialog.addCustomRule</h4>
291 <b>addCustomRule</b>(<i>filterRule</i>)
292
293 <p>
294 Public slot to add a custom AdBlock rule.
295 </p>
296 <dl>
297
298 <dt><i>filterRule</i> (string)</dt>
299 <dd>
300 filter to be added
301 </dd>
302 </dl>
303 <a NAME="AdBlockDialog.addSubscription" ID="AdBlockDialog.addSubscription"></a>
304 <h4>AdBlockDialog.addSubscription</h4>
305 <b>addSubscription</b>(<i>subscription, refresh=True</i>)
306
307 <p>
308 Public slot adding a subscription to the list.
309 </p>
310 <dl>
311
312 <dt><i>subscription</i> (AdBlockSubscription)</dt>
313 <dd>
314 reference to the subscription to be
315 added
316 </dd>
317 <dt><i>refresh</i> (bool)</dt>
318 <dd>
319 flag indicating to refresh the tree
320 </dd>
321 </dl>
322 <a NAME="AdBlockDialog.on_adBlockGroup_toggled" ID="AdBlockDialog.on_adBlockGroup_toggled"></a>
323 <h4>AdBlockDialog.on_adBlockGroup_toggled</h4>
324 <b>on_adBlockGroup_toggled</b>(<i>state</i>)
325
326 <p>
327 Private slot handling the enabling/disabling of AdBlock.
328 </p>
329 <dl>
330
331 <dt><i>state</i> (bool)</dt>
332 <dd>
333 state of the toggle
334 </dd>
335 </dl>
336 <a NAME="AdBlockDialog.on_searchEdit_textChanged" ID="AdBlockDialog.on_searchEdit_textChanged"></a>
337 <h4>AdBlockDialog.on_searchEdit_textChanged</h4>
338 <b>on_searchEdit_textChanged</b>(<i>filterRule</i>)
339
340 <p>
341 Private slot to set a new filter on the current widget.
342 </p>
343 <dl>
344
345 <dt><i>filterRule</i> (str)</dt>
346 <dd>
347 filter to be set
348 </dd>
349 </dl>
350 <a NAME="AdBlockDialog.on_subscriptionsTabWidget_currentChanged" ID="AdBlockDialog.on_subscriptionsTabWidget_currentChanged"></a>
351 <h4>AdBlockDialog.on_subscriptionsTabWidget_currentChanged</h4>
352 <b>on_subscriptionsTabWidget_currentChanged</b>(<i>index</i>)
353
354 <p>
355 Private slot handling the selection of another tab.
356 </p>
357 <dl>
358
359 <dt><i>index</i> (int)</dt>
360 <dd>
361 index of the new current tab
362 </dd>
363 </dl>
364 <a NAME="AdBlockDialog.on_updateSpinBox_valueChanged" ID="AdBlockDialog.on_updateSpinBox_valueChanged"></a>
365 <h4>AdBlockDialog.on_updateSpinBox_valueChanged</h4>
366 <b>on_updateSpinBox_valueChanged</b>(<i>value</i>)
367
368 <p>
369 Private slot to handle changes of the update period.
370 </p>
371 <dl>
372
373 <dt><i>value</i> (int)</dt>
374 <dd>
375 update period
376 </dd>
377 </dl>
378 <a NAME="AdBlockDialog.on_useLimitedEasyListCheckBox_clicked" ID="AdBlockDialog.on_useLimitedEasyListCheckBox_clicked"></a>
379 <h4>AdBlockDialog.on_useLimitedEasyListCheckBox_clicked</h4>
380 <b>on_useLimitedEasyListCheckBox_clicked</b>(<i>checked</i>)
381
382 <p>
383 Private slot handling the selection of the limited EasyList.
384 </p>
385 <dl>
386
387 <dt><i>checked</i> (bool)</dt>
388 <dd>
389 flag indicating the state of the check box
390 </dd>
391 </dl>
392 <div align="right"><a href="#top">Up</a></div>
393 <hr />
394 </body></html>

eric ide

mercurial