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

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10070
9f5758c0fec1
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.WebBrowser.AdBlock.AdBlockIcon</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.AdBlockIcon</h1>
10
11 <p>
12 Module implementing the AdBlock icon for the main window status bar.
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="#AdBlockIcon">AdBlockIcon</a></td>
25 <td>Class implementing the AdBlock icon for the main window status bar.</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="AdBlockIcon" ID="AdBlockIcon"></a>
36 <h2>AdBlockIcon</h2>
37
38 <p>
39 Class implementing the AdBlock icon for the main window status bar.
40 </p>
41 <h3>Derived from</h3>
42 EricClickableLabel
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="#AdBlockIcon.__init__">AdBlockIcon</a></td>
59 <td>Constructor</td>
60 </tr>
61 <tr>
62 <td><a href="#AdBlockIcon.__aboutToShowMenu">__aboutToShowMenu</a></td>
63 <td>Private slot to show the context menu.</td>
64 </tr>
65 <tr>
66 <td><a href="#AdBlockIcon.__enableAdBlock">__enableAdBlock</a></td>
67 <td>Private slot to enable or disable AdBlock.</td>
68 </tr>
69 <tr>
70 <td><a href="#AdBlockIcon.__isCurrentHostExcepted">__isCurrentHostExcepted</a></td>
71 <td>Private method to check, if the host of the current browser is excepted.</td>
72 </tr>
73 <tr>
74 <td><a href="#AdBlockIcon.__setException">__setException</a></td>
75 <td>Private slot to add or remove the current host from the list of exceptions.</td>
76 </tr>
77 <tr>
78 <td><a href="#AdBlockIcon.__showMenu">__showMenu</a></td>
79 <td>Private slot to show the context menu.</td>
80 </tr>
81 <tr>
82 <td><a href="#AdBlockIcon.currentChanged">currentChanged</a></td>
83 <td>Public slot to handle a change of the current browser tab.</td>
84 </tr>
85 <tr>
86 <td><a href="#AdBlockIcon.menu">menu</a></td>
87 <td>Public method to get a reference to the menu.</td>
88 </tr>
89 <tr>
90 <td><a href="#AdBlockIcon.setEnabled">setEnabled</a></td>
91 <td>Public slot to set the enabled state.</td>
92 </tr>
93 <tr>
94 <td><a href="#AdBlockIcon.sourceChanged">sourceChanged</a></td>
95 <td>Public slot to handle URL changes.</td>
96 </tr>
97 </table>
98 <h3>Static Methods</h3>
99
100 <table>
101 <tr><td>None</td></tr>
102 </table>
103
104 <a NAME="AdBlockIcon.__init__" ID="AdBlockIcon.__init__"></a>
105 <h4>AdBlockIcon (Constructor)</h4>
106 <b>AdBlockIcon</b>(<i>parent</i>)
107
108 <p>
109 Constructor
110 </p>
111 <dl>
112
113 <dt><i>parent</i> (WebBrowserWindow)</dt>
114 <dd>
115 reference to the parent widget
116 </dd>
117 </dl>
118 <a NAME="AdBlockIcon.__aboutToShowMenu" ID="AdBlockIcon.__aboutToShowMenu"></a>
119 <h4>AdBlockIcon.__aboutToShowMenu</h4>
120 <b>__aboutToShowMenu</b>(<i></i>)
121
122 <p>
123 Private slot to show the context menu.
124 </p>
125 <a NAME="AdBlockIcon.__enableAdBlock" ID="AdBlockIcon.__enableAdBlock"></a>
126 <h4>AdBlockIcon.__enableAdBlock</h4>
127 <b>__enableAdBlock</b>(<i>enable</i>)
128
129 <p>
130 Private slot to enable or disable AdBlock.
131 </p>
132 <dl>
133
134 <dt><i>enable</i> (bool)</dt>
135 <dd>
136 flag indicating the desired enable state
137 </dd>
138 </dl>
139 <a NAME="AdBlockIcon.__isCurrentHostExcepted" ID="AdBlockIcon.__isCurrentHostExcepted"></a>
140 <h4>AdBlockIcon.__isCurrentHostExcepted</h4>
141 <b>__isCurrentHostExcepted</b>(<i></i>)
142
143 <p>
144 Private method to check, if the host of the current browser is
145 excepted.
146 </p>
147 <dl>
148 <dt>Return:</dt>
149 <dd>
150 flag indicating an exception
151 </dd>
152 </dl>
153 <dl>
154 <dt>Return Type:</dt>
155 <dd>
156 bool
157 </dd>
158 </dl>
159 <a NAME="AdBlockIcon.__setException" ID="AdBlockIcon.__setException"></a>
160 <h4>AdBlockIcon.__setException</h4>
161 <b>__setException</b>(<i>enable</i>)
162
163 <p>
164 Private slot to add or remove the current host from the list of
165 exceptions.
166 </p>
167 <dl>
168
169 <dt><i>enable</i> (bool)</dt>
170 <dd>
171 flag indicating to set or remove an exception
172 </dd>
173 </dl>
174 <a NAME="AdBlockIcon.__showMenu" ID="AdBlockIcon.__showMenu"></a>
175 <h4>AdBlockIcon.__showMenu</h4>
176 <b>__showMenu</b>(<i>pos</i>)
177
178 <p>
179 Private slot to show the context menu.
180 </p>
181 <dl>
182
183 <dt><i>pos</i> (QPoint)</dt>
184 <dd>
185 position the context menu should be shown
186 </dd>
187 </dl>
188 <a NAME="AdBlockIcon.currentChanged" ID="AdBlockIcon.currentChanged"></a>
189 <h4>AdBlockIcon.currentChanged</h4>
190 <b>currentChanged</b>(<i></i>)
191
192 <p>
193 Public slot to handle a change of the current browser tab.
194 </p>
195 <a NAME="AdBlockIcon.menu" ID="AdBlockIcon.menu"></a>
196 <h4>AdBlockIcon.menu</h4>
197 <b>menu</b>(<i></i>)
198
199 <p>
200 Public method to get a reference to the menu.
201 </p>
202 <dl>
203 <dt>Return:</dt>
204 <dd>
205 reference to the menu
206 </dd>
207 </dl>
208 <dl>
209 <dt>Return Type:</dt>
210 <dd>
211 QMenu
212 </dd>
213 </dl>
214 <a NAME="AdBlockIcon.setEnabled" ID="AdBlockIcon.setEnabled"></a>
215 <h4>AdBlockIcon.setEnabled</h4>
216 <b>setEnabled</b>(<i>enabled</i>)
217
218 <p>
219 Public slot to set the enabled state.
220 </p>
221 <dl>
222
223 <dt><i>enabled</i> (bool)</dt>
224 <dd>
225 enabled state
226 </dd>
227 </dl>
228 <a NAME="AdBlockIcon.sourceChanged" ID="AdBlockIcon.sourceChanged"></a>
229 <h4>AdBlockIcon.sourceChanged</h4>
230 <b>sourceChanged</b>(<i>browser, url</i>)
231
232 <p>
233 Public slot to handle URL changes.
234 </p>
235 <dl>
236
237 <dt><i>browser</i> (WebBrowserView)</dt>
238 <dd>
239 reference to the browser
240 </dd>
241 <dt><i>url</i> (QUrl)</dt>
242 <dd>
243 new URL
244 </dd>
245 </dl>
246 <div align="right"><a href="#top">Up</a></div>
247 <hr />
248 </body></html>

eric ide

mercurial