Documentation/Source/eric4.Helpviewer.AdBlock.AdBlockManager.html

changeset 3
0d9daebf5b8c
equal deleted inserted replaced
2:bc6196164237 3:0d9daebf5b8c
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
4 <html><head>
5 <title>eric4.Helpviewer.AdBlock.AdBlockManager</title>
6 <style>
7 body {
8 background:white;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #4FA4FF; }
14 h2 { color: white; background: #4FA4FF; }
15 h3 { color: white; background: #00557F; }
16 h4 { color: white; background: #00557F; }
17
18 a { color: #AA5500; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>eric4.Helpviewer.AdBlock.AdBlockManager</h1>
24 <p>
25 Module implementing the AdBlock manager.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <tr><td>None</td></tr>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#AdBlockManager">AdBlockManager</a></td>
35 <td>Class implementing the AdBlock manager.</td>
36 </tr>
37 </table>
38 <h3>Functions</h3>
39 <table>
40 <tr><td>None</td></tr>
41 </table>
42 <hr /><hr />
43 <a NAME="AdBlockManager" ID="AdBlockManager"></a>
44 <h2>AdBlockManager</h2>
45 <p>
46 Class implementing the AdBlock manager.
47 </p><h4>Signals</h4>
48 <dl>
49 <dt>rulesChanged()</dt>
50 <dd>
51 emitted after some rule has changed
52 </dd>
53 </dl>
54 <h3>Derived from</h3>
55 QObject
56 <h3>Class Attributes</h3>
57 <table>
58 <tr><td>None</td></tr>
59 </table>
60 <h3>Methods</h3>
61 <table>
62 <tr>
63 <td><a href="#AdBlockManager.__init__">AdBlockManager</a></td>
64 <td>Constructor</td>
65 </tr><tr>
66 <td><a href="#AdBlockManager.__customSubscriptionLocation">__customSubscriptionLocation</a></td>
67 <td>Private method to generate the path for custom subscriptions.</td>
68 </tr><tr>
69 <td><a href="#AdBlockManager.__customSubscriptionUrl">__customSubscriptionUrl</a></td>
70 <td>Private method to generate the URL for custom subscriptions.</td>
71 </tr><tr>
72 <td><a href="#AdBlockManager.addSubscription">addSubscription</a></td>
73 <td>Public method to add an AdBlock subscription.</td>
74 </tr><tr>
75 <td><a href="#AdBlockManager.close">close</a></td>
76 <td>Public method to close the open search engines manager.</td>
77 </tr><tr>
78 <td><a href="#AdBlockManager.customRules">customRules</a></td>
79 <td>Public method to get a subscription for custom rules.</td>
80 </tr><tr>
81 <td><a href="#AdBlockManager.isEnabled">isEnabled</a></td>
82 <td>Public method to check, if blocking ads is enabled.</td>
83 </tr><tr>
84 <td><a href="#AdBlockManager.load">load</a></td>
85 <td>Public method to load the AdBlock subscriptions.</td>
86 </tr><tr>
87 <td><a href="#AdBlockManager.network">network</a></td>
88 <td>Public method to get a reference to the network block object.</td>
89 </tr><tr>
90 <td><a href="#AdBlockManager.page">page</a></td>
91 <td>Public method to get a reference to the page block object.</td>
92 </tr><tr>
93 <td><a href="#AdBlockManager.removeSubscription">removeSubscription</a></td>
94 <td>Public method to remove an AdBlock subscription.</td>
95 </tr><tr>
96 <td><a href="#AdBlockManager.save">save</a></td>
97 <td>Public method to save the AdBlock subscriptions.</td>
98 </tr><tr>
99 <td><a href="#AdBlockManager.setEnabled">setEnabled</a></td>
100 <td>Public slot to set the enabled state.</td>
101 </tr><tr>
102 <td><a href="#AdBlockManager.showDialog">showDialog</a></td>
103 <td>Public slot to show the AdBlock subscription management dialog.</td>
104 </tr><tr>
105 <td><a href="#AdBlockManager.subscriptions">subscriptions</a></td>
106 <td>Public method to get all subscriptions.</td>
107 </tr>
108 </table>
109 <a NAME="AdBlockManager.__init__" ID="AdBlockManager.__init__"></a>
110 <h4>AdBlockManager (Constructor)</h4>
111 <b>AdBlockManager</b>(<i>parent = None</i>)
112 <p>
113 Constructor
114 </p><dl>
115 <dt><i>parent</i></dt>
116 <dd>
117 reference to the parent object (QObject)
118 </dd>
119 </dl><a NAME="AdBlockManager.__customSubscriptionLocation" ID="AdBlockManager.__customSubscriptionLocation"></a>
120 <h4>AdBlockManager.__customSubscriptionLocation</h4>
121 <b>__customSubscriptionLocation</b>(<i></i>)
122 <p>
123 Private method to generate the path for custom subscriptions.
124 </p><dl>
125 <dt>Returns:</dt>
126 <dd>
127 URL for custom subscriptions (QUrl)
128 </dd>
129 </dl><a NAME="AdBlockManager.__customSubscriptionUrl" ID="AdBlockManager.__customSubscriptionUrl"></a>
130 <h4>AdBlockManager.__customSubscriptionUrl</h4>
131 <b>__customSubscriptionUrl</b>(<i></i>)
132 <p>
133 Private method to generate the URL for custom subscriptions.
134 </p><dl>
135 <dt>Returns:</dt>
136 <dd>
137 URL for custom subscriptions (QUrl)
138 </dd>
139 </dl><a NAME="AdBlockManager.addSubscription" ID="AdBlockManager.addSubscription"></a>
140 <h4>AdBlockManager.addSubscription</h4>
141 <b>addSubscription</b>(<i>subscription</i>)
142 <p>
143 Public method to add an AdBlock subscription.
144 </p><dl>
145 <dt><i>subscription</i></dt>
146 <dd>
147 AdBlock subscription to be added (AdBlockSubscription)
148 </dd>
149 </dl><a NAME="AdBlockManager.close" ID="AdBlockManager.close"></a>
150 <h4>AdBlockManager.close</h4>
151 <b>close</b>(<i></i>)
152 <p>
153 Public method to close the open search engines manager.
154 </p><a NAME="AdBlockManager.customRules" ID="AdBlockManager.customRules"></a>
155 <h4>AdBlockManager.customRules</h4>
156 <b>customRules</b>(<i></i>)
157 <p>
158 Public method to get a subscription for custom rules.
159 </p><dl>
160 <dt>Returns:</dt>
161 <dd>
162 subscription object for custom rules (AdBlockSubscription)
163 </dd>
164 </dl><a NAME="AdBlockManager.isEnabled" ID="AdBlockManager.isEnabled"></a>
165 <h4>AdBlockManager.isEnabled</h4>
166 <b>isEnabled</b>(<i></i>)
167 <p>
168 Public method to check, if blocking ads is enabled.
169 </p><dl>
170 <dt>Returns:</dt>
171 <dd>
172 flag indicating the enabled state (boolean)
173 </dd>
174 </dl><a NAME="AdBlockManager.load" ID="AdBlockManager.load"></a>
175 <h4>AdBlockManager.load</h4>
176 <b>load</b>(<i></i>)
177 <p>
178 Public method to load the AdBlock subscriptions.
179 </p><a NAME="AdBlockManager.network" ID="AdBlockManager.network"></a>
180 <h4>AdBlockManager.network</h4>
181 <b>network</b>(<i></i>)
182 <p>
183 Public method to get a reference to the network block object.
184 </p><dl>
185 <dt>Returns:</dt>
186 <dd>
187 reference to the network block object (AdBlockNetwork)
188 </dd>
189 </dl><a NAME="AdBlockManager.page" ID="AdBlockManager.page"></a>
190 <h4>AdBlockManager.page</h4>
191 <b>page</b>(<i></i>)
192 <p>
193 Public method to get a reference to the page block object.
194 </p><dl>
195 <dt>Returns:</dt>
196 <dd>
197 reference to the page block object (AdBlockPage)
198 </dd>
199 </dl><a NAME="AdBlockManager.removeSubscription" ID="AdBlockManager.removeSubscription"></a>
200 <h4>AdBlockManager.removeSubscription</h4>
201 <b>removeSubscription</b>(<i>subscription</i>)
202 <p>
203 Public method to remove an AdBlock subscription.
204 </p><dl>
205 <dt><i>subscription</i></dt>
206 <dd>
207 AdBlock subscription to be removed (AdBlockSubscription)
208 </dd>
209 </dl><a NAME="AdBlockManager.save" ID="AdBlockManager.save"></a>
210 <h4>AdBlockManager.save</h4>
211 <b>save</b>(<i></i>)
212 <p>
213 Public method to save the AdBlock subscriptions.
214 </p><a NAME="AdBlockManager.setEnabled" ID="AdBlockManager.setEnabled"></a>
215 <h4>AdBlockManager.setEnabled</h4>
216 <b>setEnabled</b>(<i>enabled</i>)
217 <p>
218 Public slot to set the enabled state.
219 </p><dl>
220 <dt><i>enabled</i></dt>
221 <dd>
222 flag indicating the enabled state (boolean)
223 </dd>
224 </dl><a NAME="AdBlockManager.showDialog" ID="AdBlockManager.showDialog"></a>
225 <h4>AdBlockManager.showDialog</h4>
226 <b>showDialog</b>(<i></i>)
227 <p>
228 Public slot to show the AdBlock subscription management dialog.
229 </p><a NAME="AdBlockManager.subscriptions" ID="AdBlockManager.subscriptions"></a>
230 <h4>AdBlockManager.subscriptions</h4>
231 <b>subscriptions</b>(<i></i>)
232 <p>
233 Public method to get all subscriptions.
234 </p><dl>
235 <dt>Returns:</dt>
236 <dd>
237 list of subscriptions (list of AdBlockSubscription)
238 </dd>
239 </dl>
240 <div align="right"><a href="#top">Up</a></div>
241 <hr />
242 </body></html>

eric ide

mercurial