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

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

eric ide

mercurial