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.AutoScroll.AutoScroller</h1> |
9 <h1>eric7.WebBrowser.AutoScroll.AutoScroller</h1> |
10 |
|
11 <p> |
10 <p> |
12 Module implementing the automatic scroller. |
11 Module implementing the automatic scroller. |
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="#AutoScroller">AutoScroller</a></td> |
22 <td><a href="#AutoScroller">AutoScroller</a></td> |
25 <td>Class implementing the automatic scroller.</td> |
23 <td>Class implementing the automatic scroller.</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="AutoScroller" ID="AutoScroller"></a> |
34 <a NAME="AutoScroller" ID="AutoScroller"></a> |
36 <h2>AutoScroller</h2> |
35 <h2>AutoScroller</h2> |
37 |
|
38 <p> |
36 <p> |
39 Class implementing the automatic scroller. |
37 Class implementing the automatic scroller. |
40 </p> |
38 </p> |
|
39 |
41 <h3>Derived from</h3> |
40 <h3>Derived from</h3> |
42 QObject |
41 QObject |
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="#AutoScroller.__init__">AutoScroller</a></td> |
55 <td><a href="#AutoScroller.__init__">AutoScroller</a></td> |
59 <td>Constructor</td> |
56 <td>Constructor</td> |
60 </tr> |
57 </tr> |
61 <tr> |
58 <tr> |
97 <tr> |
94 <tr> |
98 <td><a href="#AutoScroller.wheel">wheel</a></td> |
95 <td><a href="#AutoScroller.wheel">wheel</a></td> |
99 <td>Public method to handle a mouse wheel event.</td> |
96 <td>Public method to handle a mouse wheel event.</td> |
100 </tr> |
97 </tr> |
101 </table> |
98 </table> |
|
99 |
102 <h3>Static Methods</h3> |
100 <h3>Static Methods</h3> |
103 |
101 <table> |
104 <table> |
102 <tr><td>None</td></tr> |
105 <tr><td>None</td></tr> |
103 </table> |
106 </table> |
104 |
107 |
105 |
108 <a NAME="AutoScroller.__init__" ID="AutoScroller.__init__"></a> |
106 <a NAME="AutoScroller.__init__" ID="AutoScroller.__init__"></a> |
109 <h4>AutoScroller (Constructor)</h4> |
107 <h4>AutoScroller (Constructor)</h4> |
110 <b>AutoScroller</b>(<i>parent=None</i>) |
108 <b>AutoScroller</b>(<i>parent=None</i>) |
111 |
|
112 <p> |
109 <p> |
113 Constructor |
110 Constructor |
114 </p> |
111 </p> |
|
112 |
115 <dl> |
113 <dl> |
116 |
114 |
117 <dt><i>parent</i> (QObject)</dt> |
115 <dt><i>parent</i> (QObject)</dt> |
118 <dd> |
116 <dd> |
119 reference to the parent object |
117 reference to the parent object |
120 </dd> |
118 </dd> |
121 </dl> |
119 </dl> |
122 <a NAME="AutoScroller.__indicatorGlobalRect" ID="AutoScroller.__indicatorGlobalRect"></a> |
120 <a NAME="AutoScroller.__indicatorGlobalRect" ID="AutoScroller.__indicatorGlobalRect"></a> |
123 <h4>AutoScroller.__indicatorGlobalRect</h4> |
121 <h4>AutoScroller.__indicatorGlobalRect</h4> |
124 <b>__indicatorGlobalRect</b>(<i></i>) |
122 <b>__indicatorGlobalRect</b>(<i></i>) |
125 |
|
126 <p> |
123 <p> |
127 Private method to calculate the global indicator parameters. |
124 Private method to calculate the global indicator parameters. |
128 </p> |
125 </p> |
|
126 |
129 <dl> |
127 <dl> |
130 <dt>Return:</dt> |
128 <dt>Return:</dt> |
131 <dd> |
129 <dd> |
132 global indicator parameters |
130 global indicator parameters |
133 </dd> |
131 </dd> |
139 </dd> |
137 </dd> |
140 </dl> |
138 </dl> |
141 <a NAME="AutoScroller.__showIndicator" ID="AutoScroller.__showIndicator"></a> |
139 <a NAME="AutoScroller.__showIndicator" ID="AutoScroller.__showIndicator"></a> |
142 <h4>AutoScroller.__showIndicator</h4> |
140 <h4>AutoScroller.__showIndicator</h4> |
143 <b>__showIndicator</b>(<i>view, pos</i>) |
141 <b>__showIndicator</b>(<i>view, pos</i>) |
144 |
|
145 <p> |
142 <p> |
146 Private method to show the auto scroll indicator. |
143 Private method to show the auto scroll indicator. |
147 </p> |
144 </p> |
|
145 |
148 <dl> |
146 <dl> |
149 |
147 |
150 <dt><i>view</i> (WebBrowserView)</dt> |
148 <dt><i>view</i> (WebBrowserView)</dt> |
151 <dd> |
149 <dd> |
152 reference to the view to show the indicator on |
150 reference to the view to show the indicator on |
169 </dd> |
167 </dd> |
170 </dl> |
168 </dl> |
171 <a NAME="AutoScroller.__stopScrolling" ID="AutoScroller.__stopScrolling"></a> |
169 <a NAME="AutoScroller.__stopScrolling" ID="AutoScroller.__stopScrolling"></a> |
172 <h4>AutoScroller.__stopScrolling</h4> |
170 <h4>AutoScroller.__stopScrolling</h4> |
173 <b>__stopScrolling</b>(<i></i>) |
171 <b>__stopScrolling</b>(<i></i>) |
174 |
|
175 <p> |
172 <p> |
176 Private method to stop scrolling. |
173 Private method to stop scrolling. |
177 </p> |
174 </p> |
|
175 |
178 <a NAME="AutoScroller.eventFilter" ID="AutoScroller.eventFilter"></a> |
176 <a NAME="AutoScroller.eventFilter" ID="AutoScroller.eventFilter"></a> |
179 <h4>AutoScroller.eventFilter</h4> |
177 <h4>AutoScroller.eventFilter</h4> |
180 <b>eventFilter</b>(<i>obj, evt</i>) |
178 <b>eventFilter</b>(<i>obj, evt</i>) |
181 |
|
182 <p> |
179 <p> |
183 Public method to handle event for an object. |
180 Public method to handle event for an object. |
184 </p> |
181 </p> |
|
182 |
185 <dl> |
183 <dl> |
186 |
184 |
187 <dt><i>obj</i> (QObject)</dt> |
185 <dt><i>obj</i> (QObject)</dt> |
188 <dd> |
186 <dd> |
189 refernce to the object sending the event |
187 refernce to the object sending the event |
225 </dd> |
223 </dd> |
226 </dl> |
224 </dl> |
227 <a NAME="AutoScroller.mouseMove" ID="AutoScroller.mouseMove"></a> |
225 <a NAME="AutoScroller.mouseMove" ID="AutoScroller.mouseMove"></a> |
228 <h4>AutoScroller.mouseMove</h4> |
226 <h4>AutoScroller.mouseMove</h4> |
229 <b>mouseMove</b>(<i>evt</i>) |
227 <b>mouseMove</b>(<i>evt</i>) |
230 |
|
231 <p> |
228 <p> |
232 Public method to handle mouse move events. |
229 Public method to handle mouse move events. |
233 </p> |
230 </p> |
|
231 |
234 <dl> |
232 <dl> |
235 |
233 |
236 <dt><i>evt</i> (QMouseEvent)</dt> |
234 <dt><i>evt</i> (QMouseEvent)</dt> |
237 <dd> |
235 <dd> |
238 reference to the mouse move event |
236 reference to the mouse move event |
251 </dd> |
249 </dd> |
252 </dl> |
250 </dl> |
253 <a NAME="AutoScroller.mousePress" ID="AutoScroller.mousePress"></a> |
251 <a NAME="AutoScroller.mousePress" ID="AutoScroller.mousePress"></a> |
254 <h4>AutoScroller.mousePress</h4> |
252 <h4>AutoScroller.mousePress</h4> |
255 <b>mousePress</b>(<i>view, evt</i>) |
253 <b>mousePress</b>(<i>view, evt</i>) |
256 |
|
257 <p> |
254 <p> |
258 Public method to handle mouse button presses. |
255 Public method to handle mouse button presses. |
259 </p> |
256 </p> |
|
257 |
260 <dl> |
258 <dl> |
261 |
259 |
262 <dt><i>view</i> (WebBrowserView)</dt> |
260 <dt><i>view</i> (WebBrowserView)</dt> |
263 <dd> |
261 <dd> |
264 reference to the web view the button was pressed on |
262 reference to the web view the button was pressed on |
281 </dd> |
279 </dd> |
282 </dl> |
280 </dl> |
283 <a NAME="AutoScroller.mouseRelease" ID="AutoScroller.mouseRelease"></a> |
281 <a NAME="AutoScroller.mouseRelease" ID="AutoScroller.mouseRelease"></a> |
284 <h4>AutoScroller.mouseRelease</h4> |
282 <h4>AutoScroller.mouseRelease</h4> |
285 <b>mouseRelease</b>(<i>evt</i>) |
283 <b>mouseRelease</b>(<i>evt</i>) |
286 |
|
287 <p> |
284 <p> |
288 Public method to handle mouse button releases. |
285 Public method to handle mouse button releases. |
289 </p> |
286 </p> |
|
287 |
290 <dl> |
288 <dl> |
291 |
289 |
292 <dt><i>evt</i> (QMouseEvent)</dt> |
290 <dt><i>evt</i> (QMouseEvent)</dt> |
293 <dd> |
291 <dd> |
294 reference to the mouse button release event |
292 reference to the mouse button release event |
307 </dd> |
305 </dd> |
308 </dl> |
306 </dl> |
309 <a NAME="AutoScroller.preferencesChanged" ID="AutoScroller.preferencesChanged"></a> |
307 <a NAME="AutoScroller.preferencesChanged" ID="AutoScroller.preferencesChanged"></a> |
310 <h4>AutoScroller.preferencesChanged</h4> |
308 <h4>AutoScroller.preferencesChanged</h4> |
311 <b>preferencesChanged</b>(<i></i>) |
309 <b>preferencesChanged</b>(<i></i>) |
312 |
|
313 <p> |
310 <p> |
314 Public method to handle a change of the settings. |
311 Public method to handle a change of the settings. |
315 </p> |
312 </p> |
|
313 |
316 <a NAME="AutoScroller.wheel" ID="AutoScroller.wheel"></a> |
314 <a NAME="AutoScroller.wheel" ID="AutoScroller.wheel"></a> |
317 <h4>AutoScroller.wheel</h4> |
315 <h4>AutoScroller.wheel</h4> |
318 <b>wheel</b>(<i></i>) |
316 <b>wheel</b>(<i></i>) |
319 |
|
320 <p> |
317 <p> |
321 Public method to handle a mouse wheel event. |
318 Public method to handle a mouse wheel event. |
322 </p> |
319 </p> |
|
320 |
323 <dl> |
321 <dl> |
324 <dt>Return:</dt> |
322 <dt>Return:</dt> |
325 <dd> |
323 <dd> |
326 flag indicating, that the event was handled |
324 flag indicating, that the event was handled |
327 </dd> |
325 </dd> |