|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric7.WebBrowser.AdBlock.AdBlockTreeWidget</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.AdBlockTreeWidget</h1> |
|
10 |
|
11 <p> |
|
12 Module implementing a tree widget for 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="#AdBlockTreeWidget">AdBlockTreeWidget</a></td> |
|
25 <td>Class implementing a tree widget for 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="AdBlockTreeWidget" ID="AdBlockTreeWidget"></a> |
|
36 <h2>AdBlockTreeWidget</h2> |
|
37 |
|
38 <p> |
|
39 Class implementing a tree widget for the AdBlock configuration dialog. |
|
40 </p> |
|
41 <h3>Derived from</h3> |
|
42 EricTreeWidget |
|
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="#AdBlockTreeWidget.__init__">AdBlockTreeWidget</a></td> |
|
59 <td>Constructor</td> |
|
60 </tr> |
|
61 <tr> |
|
62 <td><a href="#AdBlockTreeWidget.__adjustItemFeatures">__adjustItemFeatures</a></td> |
|
63 <td>Private method to adjust an item.</td> |
|
64 </tr> |
|
65 <tr> |
|
66 <td><a href="#AdBlockTreeWidget.__contextMenuRequested">__contextMenuRequested</a></td> |
|
67 <td>Private slot to show the context menu.</td> |
|
68 </tr> |
|
69 <tr> |
|
70 <td><a href="#AdBlockTreeWidget.__copyFilter">__copyFilter</a></td> |
|
71 <td>Private slot to copy the current filter to the clipboard.</td> |
|
72 </tr> |
|
73 <tr> |
|
74 <td><a href="#AdBlockTreeWidget.__itemChanged">__itemChanged</a></td> |
|
75 <td>Private slot to handle the change of an item.</td> |
|
76 </tr> |
|
77 <tr> |
|
78 <td><a href="#AdBlockTreeWidget.__subscriptionChanged">__subscriptionChanged</a></td> |
|
79 <td>Private slot handling a subscription change.</td> |
|
80 </tr> |
|
81 <tr> |
|
82 <td><a href="#AdBlockTreeWidget.addRule">addRule</a></td> |
|
83 <td>Public slot to add a new rule.</td> |
|
84 </tr> |
|
85 <tr> |
|
86 <td><a href="#AdBlockTreeWidget.keyPressEvent">keyPressEvent</a></td> |
|
87 <td>Protected method handling key presses.</td> |
|
88 </tr> |
|
89 <tr> |
|
90 <td><a href="#AdBlockTreeWidget.refresh">refresh</a></td> |
|
91 <td>Public method to refresh the tree.</td> |
|
92 </tr> |
|
93 <tr> |
|
94 <td><a href="#AdBlockTreeWidget.removeRule">removeRule</a></td> |
|
95 <td>Public slot to remove the current rule.</td> |
|
96 </tr> |
|
97 <tr> |
|
98 <td><a href="#AdBlockTreeWidget.showRule">showRule</a></td> |
|
99 <td>Public method to highlight the given rule.</td> |
|
100 </tr> |
|
101 <tr> |
|
102 <td><a href="#AdBlockTreeWidget.subscription">subscription</a></td> |
|
103 <td>Public method to get a reference to the subscription.</td> |
|
104 </tr> |
|
105 </table> |
|
106 <h3>Static Methods</h3> |
|
107 |
|
108 <table> |
|
109 <tr><td>None</td></tr> |
|
110 </table> |
|
111 |
|
112 <a NAME="AdBlockTreeWidget.__init__" ID="AdBlockTreeWidget.__init__"></a> |
|
113 <h4>AdBlockTreeWidget (Constructor)</h4> |
|
114 <b>AdBlockTreeWidget</b>(<i>subscription, parent=None</i>) |
|
115 |
|
116 <p> |
|
117 Constructor |
|
118 </p> |
|
119 <dl> |
|
120 |
|
121 <dt><i>subscription</i> (AdBlockSubscription)</dt> |
|
122 <dd> |
|
123 reference to the subscription |
|
124 </dd> |
|
125 <dt><i>parent</i> (QWidget)</dt> |
|
126 <dd> |
|
127 reference to the parent widget |
|
128 </dd> |
|
129 </dl> |
|
130 <a NAME="AdBlockTreeWidget.__adjustItemFeatures" ID="AdBlockTreeWidget.__adjustItemFeatures"></a> |
|
131 <h4>AdBlockTreeWidget.__adjustItemFeatures</h4> |
|
132 <b>__adjustItemFeatures</b>(<i>itm, rule</i>) |
|
133 |
|
134 <p> |
|
135 Private method to adjust an item. |
|
136 </p> |
|
137 <dl> |
|
138 |
|
139 <dt><i>itm</i> (QTreeWidgetItem)</dt> |
|
140 <dd> |
|
141 item to be adjusted |
|
142 </dd> |
|
143 <dt><i>rule</i> (AdBlockRule)</dt> |
|
144 <dd> |
|
145 rule for the adjustment |
|
146 </dd> |
|
147 </dl> |
|
148 <a NAME="AdBlockTreeWidget.__contextMenuRequested" ID="AdBlockTreeWidget.__contextMenuRequested"></a> |
|
149 <h4>AdBlockTreeWidget.__contextMenuRequested</h4> |
|
150 <b>__contextMenuRequested</b>(<i>pos</i>) |
|
151 |
|
152 <p> |
|
153 Private slot to show the context menu. |
|
154 </p> |
|
155 <dl> |
|
156 |
|
157 <dt><i>pos</i> (QPoint)</dt> |
|
158 <dd> |
|
159 position for the menu |
|
160 </dd> |
|
161 </dl> |
|
162 <a NAME="AdBlockTreeWidget.__copyFilter" ID="AdBlockTreeWidget.__copyFilter"></a> |
|
163 <h4>AdBlockTreeWidget.__copyFilter</h4> |
|
164 <b>__copyFilter</b>(<i></i>) |
|
165 |
|
166 <p> |
|
167 Private slot to copy the current filter to the clipboard. |
|
168 </p> |
|
169 <a NAME="AdBlockTreeWidget.__itemChanged" ID="AdBlockTreeWidget.__itemChanged"></a> |
|
170 <h4>AdBlockTreeWidget.__itemChanged</h4> |
|
171 <b>__itemChanged</b>(<i>itm</i>) |
|
172 |
|
173 <p> |
|
174 Private slot to handle the change of an item. |
|
175 </p> |
|
176 <dl> |
|
177 |
|
178 <dt><i>itm</i> (QTreeWidgetItem)</dt> |
|
179 <dd> |
|
180 changed item |
|
181 </dd> |
|
182 </dl> |
|
183 <a NAME="AdBlockTreeWidget.__subscriptionChanged" ID="AdBlockTreeWidget.__subscriptionChanged"></a> |
|
184 <h4>AdBlockTreeWidget.__subscriptionChanged</h4> |
|
185 <b>__subscriptionChanged</b>(<i></i>) |
|
186 |
|
187 <p> |
|
188 Private slot handling a subscription change. |
|
189 </p> |
|
190 <a NAME="AdBlockTreeWidget.addRule" ID="AdBlockTreeWidget.addRule"></a> |
|
191 <h4>AdBlockTreeWidget.addRule</h4> |
|
192 <b>addRule</b>(<i>filterRule=""</i>) |
|
193 |
|
194 <p> |
|
195 Public slot to add a new rule. |
|
196 </p> |
|
197 <dl> |
|
198 |
|
199 <dt><i>filterRule</i> (str)</dt> |
|
200 <dd> |
|
201 filter to be added |
|
202 </dd> |
|
203 </dl> |
|
204 <a NAME="AdBlockTreeWidget.keyPressEvent" ID="AdBlockTreeWidget.keyPressEvent"></a> |
|
205 <h4>AdBlockTreeWidget.keyPressEvent</h4> |
|
206 <b>keyPressEvent</b>(<i>evt</i>) |
|
207 |
|
208 <p> |
|
209 Protected method handling key presses. |
|
210 </p> |
|
211 <dl> |
|
212 |
|
213 <dt><i>evt</i> (QKeyEvent)</dt> |
|
214 <dd> |
|
215 key press event |
|
216 </dd> |
|
217 </dl> |
|
218 <a NAME="AdBlockTreeWidget.refresh" ID="AdBlockTreeWidget.refresh"></a> |
|
219 <h4>AdBlockTreeWidget.refresh</h4> |
|
220 <b>refresh</b>(<i></i>) |
|
221 |
|
222 <p> |
|
223 Public method to refresh the tree. |
|
224 </p> |
|
225 <a NAME="AdBlockTreeWidget.removeRule" ID="AdBlockTreeWidget.removeRule"></a> |
|
226 <h4>AdBlockTreeWidget.removeRule</h4> |
|
227 <b>removeRule</b>(<i></i>) |
|
228 |
|
229 <p> |
|
230 Public slot to remove the current rule. |
|
231 </p> |
|
232 <a NAME="AdBlockTreeWidget.showRule" ID="AdBlockTreeWidget.showRule"></a> |
|
233 <h4>AdBlockTreeWidget.showRule</h4> |
|
234 <b>showRule</b>(<i>rule</i>) |
|
235 |
|
236 <p> |
|
237 Public method to highlight the given rule. |
|
238 </p> |
|
239 <dl> |
|
240 |
|
241 <dt><i>rule</i> (AdBlockRule)</dt> |
|
242 <dd> |
|
243 AdBlock rule to be shown |
|
244 </dd> |
|
245 </dl> |
|
246 <a NAME="AdBlockTreeWidget.subscription" ID="AdBlockTreeWidget.subscription"></a> |
|
247 <h4>AdBlockTreeWidget.subscription</h4> |
|
248 <b>subscription</b>(<i></i>) |
|
249 |
|
250 <p> |
|
251 Public method to get a reference to the subscription. |
|
252 </p> |
|
253 <dl> |
|
254 <dt>Return:</dt> |
|
255 <dd> |
|
256 reference to the subscription |
|
257 </dd> |
|
258 </dl> |
|
259 <dl> |
|
260 <dt>Return Type:</dt> |
|
261 <dd> |
|
262 AdBlockSubscription |
|
263 </dd> |
|
264 </dl> |
|
265 <div align="right"><a href="#top">Up</a></div> |
|
266 <hr /> |
|
267 </body></html> |