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

changeset 4918
71caf42a13d8
child 5606
da305d172769
equal deleted inserted replaced
4917:682750cc7bd5 4918:71caf42a13d8
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.__removeCustomRule">__removeCustomRule</a></td>
82 <td>Private slot to remove a custom AdBlock rule.</td>
83 </tr><tr>
84 <td><a href="#AdBlockDialog.__removeSubscription">__removeSubscription</a></td>
85 <td>Private slot to remove the selected subscription.</td>
86 </tr><tr>
87 <td><a href="#AdBlockDialog.__setSubscriptionEnabled">__setSubscriptionEnabled</a></td>
88 <td>Private slot to set the enabled state of a subscription.</td>
89 </tr><tr>
90 <td><a href="#AdBlockDialog.__switchSubscriptionEnabled">__switchSubscriptionEnabled</a></td>
91 <td>Private slot to switch the enabled state of the selected subscription.</td>
92 </tr><tr>
93 <td><a href="#AdBlockDialog.__updateAllSubscriptions">__updateAllSubscriptions</a></td>
94 <td>Private slot to update all subscriptions.</td>
95 </tr><tr>
96 <td><a href="#AdBlockDialog.__updateSubscription">__updateSubscription</a></td>
97 <td>Private slot to update the selected subscription.</td>
98 </tr><tr>
99 <td><a href="#AdBlockDialog.addCustomRule">addCustomRule</a></td>
100 <td>Public slot to add a custom AdBlock rule.</td>
101 </tr><tr>
102 <td><a href="#AdBlockDialog.addSubscription">addSubscription</a></td>
103 <td>Public slot adding a subscription to the list.</td>
104 </tr><tr>
105 <td><a href="#AdBlockDialog.on_adBlockGroup_toggled">on_adBlockGroup_toggled</a></td>
106 <td>Private slot handling the enabling/disabling of AdBlock.</td>
107 </tr><tr>
108 <td><a href="#AdBlockDialog.on_searchEdit_textChanged">on_searchEdit_textChanged</a></td>
109 <td>Private slot to set a new filter on the current widget.</td>
110 </tr><tr>
111 <td><a href="#AdBlockDialog.on_subscriptionsTabWidget_currentChanged">on_subscriptionsTabWidget_currentChanged</a></td>
112 <td>Private slot handling the selection of another tab.</td>
113 </tr><tr>
114 <td><a href="#AdBlockDialog.on_updateSpinBox_valueChanged">on_updateSpinBox_valueChanged</a></td>
115 <td>Private slot to handle changes of the update period.</td>
116 </tr><tr>
117 <td><a href="#AdBlockDialog.on_useLimitedEasyListCheckBox_clicked">on_useLimitedEasyListCheckBox_clicked</a></td>
118 <td>Private slot handling the selection of the limited EasyList.</td>
119 </tr>
120 </table>
121 <h3>Static Methods</h3>
122 <table>
123 <tr><td>None</td></tr>
124 </table>
125 <a NAME="AdBlockDialog.__init__" ID="AdBlockDialog.__init__"></a>
126 <h4>AdBlockDialog (Constructor)</h4>
127 <b>AdBlockDialog</b>(<i>manager, parent=None</i>)
128 <p>
129 Constructor
130 </p><dl>
131 <dt><i>manager</i></dt>
132 <dd>
133 reference to the AdBlock manager (AdBlockManager)
134 </dd><dt><i>parent</i></dt>
135 <dd>
136 reference to the parent object (QWidget)
137 </dd>
138 </dl><a NAME="AdBlockDialog.__aboutToShowActionMenu" ID="AdBlockDialog.__aboutToShowActionMenu"></a>
139 <h4>AdBlockDialog.__aboutToShowActionMenu</h4>
140 <b>__aboutToShowActionMenu</b>(<i></i>)
141 <p>
142 Private slot to show the actions menu.
143 </p><a NAME="AdBlockDialog.__addCustomRule" ID="AdBlockDialog.__addCustomRule"></a>
144 <h4>AdBlockDialog.__addCustomRule</h4>
145 <b>__addCustomRule</b>(<i></i>)
146 <p>
147 Private slot to add a custom AdBlock rule.
148 </p><a NAME="AdBlockDialog.__browseSubscriptions" ID="AdBlockDialog.__browseSubscriptions"></a>
149 <h4>AdBlockDialog.__browseSubscriptions</h4>
150 <b>__browseSubscriptions</b>(<i></i>)
151 <p>
152 Private slot to browse the list of available AdBlock subscriptions.
153 </p><a NAME="AdBlockDialog.__learnAboutWritingFilters" ID="AdBlockDialog.__learnAboutWritingFilters"></a>
154 <h4>AdBlockDialog.__learnAboutWritingFilters</h4>
155 <b>__learnAboutWritingFilters</b>(<i></i>)
156 <p>
157 Private slot to show the web page about how to write filters.
158 </p><a NAME="AdBlockDialog.__load" ID="AdBlockDialog.__load"></a>
159 <h4>AdBlockDialog.__load</h4>
160 <b>__load</b>(<i></i>)
161 <p>
162 Private slot to populate the tab widget with subscriptions.
163 </p><a NAME="AdBlockDialog.__loadSubscriptions" ID="AdBlockDialog.__loadSubscriptions"></a>
164 <h4>AdBlockDialog.__loadSubscriptions</h4>
165 <b>__loadSubscriptions</b>(<i></i>)
166 <p>
167 Private slot to load the AdBlock subscription rules.
168 </p><a NAME="AdBlockDialog.__removeCustomRule" ID="AdBlockDialog.__removeCustomRule"></a>
169 <h4>AdBlockDialog.__removeCustomRule</h4>
170 <b>__removeCustomRule</b>(<i></i>)
171 <p>
172 Private slot to remove a custom AdBlock rule.
173 </p><a NAME="AdBlockDialog.__removeSubscription" ID="AdBlockDialog.__removeSubscription"></a>
174 <h4>AdBlockDialog.__removeSubscription</h4>
175 <b>__removeSubscription</b>(<i></i>)
176 <p>
177 Private slot to remove the selected subscription.
178 </p><a NAME="AdBlockDialog.__setSubscriptionEnabled" ID="AdBlockDialog.__setSubscriptionEnabled"></a>
179 <h4>AdBlockDialog.__setSubscriptionEnabled</h4>
180 <b>__setSubscriptionEnabled</b>(<i>subscription, enable</i>)
181 <p>
182 Private slot to set the enabled state of a subscription.
183 </p><dl>
184 <dt><i>subscription</i></dt>
185 <dd>
186 subscription to set the state for
187 (AdBlockSubscription)
188 </dd><dt><i>enable</i></dt>
189 <dd>
190 state to set to (boolean)
191 </dd>
192 </dl><a NAME="AdBlockDialog.__switchSubscriptionEnabled" ID="AdBlockDialog.__switchSubscriptionEnabled"></a>
193 <h4>AdBlockDialog.__switchSubscriptionEnabled</h4>
194 <b>__switchSubscriptionEnabled</b>(<i></i>)
195 <p>
196 Private slot to switch the enabled state of the selected subscription.
197 </p><a NAME="AdBlockDialog.__updateAllSubscriptions" ID="AdBlockDialog.__updateAllSubscriptions"></a>
198 <h4>AdBlockDialog.__updateAllSubscriptions</h4>
199 <b>__updateAllSubscriptions</b>(<i></i>)
200 <p>
201 Private slot to update all subscriptions.
202 </p><a NAME="AdBlockDialog.__updateSubscription" ID="AdBlockDialog.__updateSubscription"></a>
203 <h4>AdBlockDialog.__updateSubscription</h4>
204 <b>__updateSubscription</b>(<i></i>)
205 <p>
206 Private slot to update the selected subscription.
207 </p><a NAME="AdBlockDialog.addCustomRule" ID="AdBlockDialog.addCustomRule"></a>
208 <h4>AdBlockDialog.addCustomRule</h4>
209 <b>addCustomRule</b>(<i>filter</i>)
210 <p>
211 Public slot to add a custom AdBlock rule.
212 </p><dl>
213 <dt><i>filter</i></dt>
214 <dd>
215 filter to be added (string)
216 </dd>
217 </dl><a NAME="AdBlockDialog.addSubscription" ID="AdBlockDialog.addSubscription"></a>
218 <h4>AdBlockDialog.addSubscription</h4>
219 <b>addSubscription</b>(<i>subscription, refresh=True</i>)
220 <p>
221 Public slot adding a subscription to the list.
222 </p><dl>
223 <dt><i>subscription</i></dt>
224 <dd>
225 reference to the subscription to be
226 added (AdBlockSubscription)
227 </dd><dt><i>refresh</i></dt>
228 <dd>
229 flag indicating to refresh the tree (boolean)
230 </dd>
231 </dl><a NAME="AdBlockDialog.on_adBlockGroup_toggled" ID="AdBlockDialog.on_adBlockGroup_toggled"></a>
232 <h4>AdBlockDialog.on_adBlockGroup_toggled</h4>
233 <b>on_adBlockGroup_toggled</b>(<i>state</i>)
234 <p>
235 Private slot handling the enabling/disabling of AdBlock.
236 </p><dl>
237 <dt><i>state</i></dt>
238 <dd>
239 state of the toggle (boolean)
240 </dd>
241 </dl><a NAME="AdBlockDialog.on_searchEdit_textChanged" ID="AdBlockDialog.on_searchEdit_textChanged"></a>
242 <h4>AdBlockDialog.on_searchEdit_textChanged</h4>
243 <b>on_searchEdit_textChanged</b>(<i>filter</i>)
244 <p>
245 Private slot to set a new filter on the current widget.
246 </p><dl>
247 <dt><i>filter</i></dt>
248 <dd>
249 filter to be set (string)
250 </dd>
251 </dl><a NAME="AdBlockDialog.on_subscriptionsTabWidget_currentChanged" ID="AdBlockDialog.on_subscriptionsTabWidget_currentChanged"></a>
252 <h4>AdBlockDialog.on_subscriptionsTabWidget_currentChanged</h4>
253 <b>on_subscriptionsTabWidget_currentChanged</b>(<i>index</i>)
254 <p>
255 Private slot handling the selection of another tab.
256 </p><dl>
257 <dt><i>index</i></dt>
258 <dd>
259 index of the new current tab (integer)
260 </dd>
261 </dl><a NAME="AdBlockDialog.on_updateSpinBox_valueChanged" ID="AdBlockDialog.on_updateSpinBox_valueChanged"></a>
262 <h4>AdBlockDialog.on_updateSpinBox_valueChanged</h4>
263 <b>on_updateSpinBox_valueChanged</b>(<i>value</i>)
264 <p>
265 Private slot to handle changes of the update period.
266 </p><dl>
267 <dt><i>value</i></dt>
268 <dd>
269 update period (integer)
270 </dd>
271 </dl><a NAME="AdBlockDialog.on_useLimitedEasyListCheckBox_clicked" ID="AdBlockDialog.on_useLimitedEasyListCheckBox_clicked"></a>
272 <h4>AdBlockDialog.on_useLimitedEasyListCheckBox_clicked</h4>
273 <b>on_useLimitedEasyListCheckBox_clicked</b>(<i>checked</i>)
274 <p>
275 Private slot handling the selection of the limited EasyList.
276 </p><dl>
277 <dt><i>checked</i> (bool)</dt>
278 <dd>
279 flag indicating the state of the check box
280 </dd>
281 </dl>
282 <div align="right"><a href="#top">Up</a></div>
283 <hr />
284 </body></html>

eric ide

mercurial