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

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

eric ide

mercurial