Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.WebBrowser.AutoScroll.AutoScroller.html

eric6/Documentation/Source/eric6.WebBrowser.AutoScroll.AutoScroller.html

changeset 7273
391d6b7b1eff
parent 6942
2602857055c5
child 7989
a21d673a8f99
equal deleted inserted replaced
7272:1779dc278077 7273:391d6b7b1eff
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>eric6.WebBrowser.AutoScroll.AutoScroller</h1> 23 <h1>eric6.WebBrowser.AutoScroll.AutoScroller</h1>
24
23 <p> 25 <p>
24 Module implementing the automatic scroller. 26 Module implementing the automatic scroller.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>None</td></tr> 31 <tr><td>None</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
31 <table> 34
35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#AutoScroller">AutoScroller</a></td> 38 <td><a href="#AutoScroller">AutoScroller</a></td>
34 <td>Class implementing the automatic scroller.</td> 39 <td>Class implementing the automatic scroller.</td>
35 </tr> 40 </tr>
36 </table> 41 </table>
37 <h3>Functions</h3> 42 <h3>Functions</h3>
38 <table> 43
39 <tr><td>None</td></tr> 44 <table>
40 </table> 45 <tr><td>None</td></tr>
41 <hr /><hr /> 46 </table>
47 <hr />
48 <hr />
42 <a NAME="AutoScroller" ID="AutoScroller"></a> 49 <a NAME="AutoScroller" ID="AutoScroller"></a>
43 <h2>AutoScroller</h2> 50 <h2>AutoScroller</h2>
51
44 <p> 52 <p>
45 Class implementing the automatic scroller. 53 Class implementing the automatic scroller.
46 </p> 54 </p>
47 <h3>Derived from</h3> 55 <h3>Derived from</h3>
48 QObject 56 QObject
49 <h3>Class Attributes</h3> 57 <h3>Class Attributes</h3>
58
50 <table> 59 <table>
51 <tr><td>None</td></tr> 60 <tr><td>None</td></tr>
52 </table> 61 </table>
53 <h3>Class Methods</h3> 62 <h3>Class Methods</h3>
63
54 <table> 64 <table>
55 <tr><td>None</td></tr> 65 <tr><td>None</td></tr>
56 </table> 66 </table>
57 <h3>Methods</h3> 67 <h3>Methods</h3>
58 <table> 68
69 <table>
70
59 <tr> 71 <tr>
60 <td><a href="#AutoScroller.__init__">AutoScroller</a></td> 72 <td><a href="#AutoScroller.__init__">AutoScroller</a></td>
61 <td>Constructor</td> 73 <td>Constructor</td>
62 </tr><tr> 74 </tr>
75 <tr>
63 <td><a href="#AutoScroller.__indicatorGlobalRect">__indicatorGlobalRect</a></td> 76 <td><a href="#AutoScroller.__indicatorGlobalRect">__indicatorGlobalRect</a></td>
64 <td>Private method to calculate the global indicator parameters.</td> 77 <td>Private method to calculate the global indicator parameters.</td>
65 </tr><tr> 78 </tr>
79 <tr>
66 <td><a href="#AutoScroller.__showIndicator">__showIndicator</a></td> 80 <td><a href="#AutoScroller.__showIndicator">__showIndicator</a></td>
67 <td>Private method to show the auto scroll indicator.</td> 81 <td>Private method to show the auto scroll indicator.</td>
68 </tr><tr> 82 </tr>
83 <tr>
69 <td><a href="#AutoScroller.__stopScrolling">__stopScrolling</a></td> 84 <td><a href="#AutoScroller.__stopScrolling">__stopScrolling</a></td>
70 <td>Private method to stop scrolling.</td> 85 <td>Private method to stop scrolling.</td>
71 </tr><tr> 86 </tr>
87 <tr>
72 <td><a href="#AutoScroller.eventFilter">eventFilter</a></td> 88 <td><a href="#AutoScroller.eventFilter">eventFilter</a></td>
73 <td>Public method to handle event for an object.</td> 89 <td>Public method to handle event for an object.</td>
74 </tr><tr> 90 </tr>
91 <tr>
75 <td><a href="#AutoScroller.isEnabled">isEnabled</a></td> 92 <td><a href="#AutoScroller.isEnabled">isEnabled</a></td>
76 <td>Public method to get the enabled state.</td> 93 <td>Public method to get the enabled state.</td>
77 </tr><tr> 94 </tr>
95 <tr>
78 <td><a href="#AutoScroller.mouseMove">mouseMove</a></td> 96 <td><a href="#AutoScroller.mouseMove">mouseMove</a></td>
79 <td>Public method to handle mouse move events.</td> 97 <td>Public method to handle mouse move events.</td>
80 </tr><tr> 98 </tr>
99 <tr>
81 <td><a href="#AutoScroller.mousePress">mousePress</a></td> 100 <td><a href="#AutoScroller.mousePress">mousePress</a></td>
82 <td>Public method to handle mouse button presses.</td> 101 <td>Public method to handle mouse button presses.</td>
83 </tr><tr> 102 </tr>
103 <tr>
84 <td><a href="#AutoScroller.mouseRelease">mouseRelease</a></td> 104 <td><a href="#AutoScroller.mouseRelease">mouseRelease</a></td>
85 <td>Public method to handle mouse button releases.</td> 105 <td>Public method to handle mouse button releases.</td>
86 </tr><tr> 106 </tr>
107 <tr>
87 <td><a href="#AutoScroller.preferencesChanged">preferencesChanged</a></td> 108 <td><a href="#AutoScroller.preferencesChanged">preferencesChanged</a></td>
88 <td>Public method to handle a change of the settings.</td> 109 <td>Public method to handle a change of the settings.</td>
89 </tr><tr> 110 </tr>
111 <tr>
90 <td><a href="#AutoScroller.wheel">wheel</a></td> 112 <td><a href="#AutoScroller.wheel">wheel</a></td>
91 <td>Public method to handle a mouse wheel event.</td> 113 <td>Public method to handle a mouse wheel event.</td>
92 </tr> 114 </tr>
93 </table> 115 </table>
94 <h3>Static Methods</h3> 116 <h3>Static Methods</h3>
95 <table> 117
96 <tr><td>None</td></tr> 118 <table>
97 </table> 119 <tr><td>None</td></tr>
120 </table>
121
98 <a NAME="AutoScroller.__init__" ID="AutoScroller.__init__"></a> 122 <a NAME="AutoScroller.__init__" ID="AutoScroller.__init__"></a>
99 <h4>AutoScroller (Constructor)</h4> 123 <h4>AutoScroller (Constructor)</h4>
100 <b>AutoScroller</b>(<i>parent=None</i>) 124 <b>AutoScroller</b>(<i>parent=None</i>)
125
101 <p> 126 <p>
102 Constructor 127 Constructor
103 </p><dl> 128 </p>
129 <dl>
130
104 <dt><i>parent</i> (QObject)</dt> 131 <dt><i>parent</i> (QObject)</dt>
105 <dd> 132 <dd>
106 reference to the parent object 133 reference to the parent object
107 </dd> 134 </dd>
108 </dl><a NAME="AutoScroller.__indicatorGlobalRect" ID="AutoScroller.__indicatorGlobalRect"></a> 135 </dl>
136 <a NAME="AutoScroller.__indicatorGlobalRect" ID="AutoScroller.__indicatorGlobalRect"></a>
109 <h4>AutoScroller.__indicatorGlobalRect</h4> 137 <h4>AutoScroller.__indicatorGlobalRect</h4>
110 <b>__indicatorGlobalRect</b>(<i></i>) 138 <b>__indicatorGlobalRect</b>(<i></i>)
139
111 <p> 140 <p>
112 Private method to calculate the global indicator parameters. 141 Private method to calculate the global indicator parameters.
113 </p><dl> 142 </p>
143 <dl>
114 <dt>Returns:</dt> 144 <dt>Returns:</dt>
115 <dd> 145 <dd>
116 global indicator parameters 146 global indicator parameters
117 </dd> 147 </dd>
118 </dl><dl> 148 </dl>
149 <dl>
119 <dt>Return Type:</dt> 150 <dt>Return Type:</dt>
120 <dd> 151 <dd>
121 QRect 152 QRect
122 </dd> 153 </dd>
123 </dl><a NAME="AutoScroller.__showIndicator" ID="AutoScroller.__showIndicator"></a> 154 </dl>
155 <a NAME="AutoScroller.__showIndicator" ID="AutoScroller.__showIndicator"></a>
124 <h4>AutoScroller.__showIndicator</h4> 156 <h4>AutoScroller.__showIndicator</h4>
125 <b>__showIndicator</b>(<i>view, pos</i>) 157 <b>__showIndicator</b>(<i>view, pos</i>)
158
126 <p> 159 <p>
127 Private method to show the auto scroll indicator. 160 Private method to show the auto scroll indicator.
128 </p><dl> 161 </p>
162 <dl>
163
129 <dt><i>view</i> (WebBrowserView)</dt> 164 <dt><i>view</i> (WebBrowserView)</dt>
130 <dd> 165 <dd>
131 reference to the view to show the indicator on 166 reference to the view to show the indicator on
132 </dd><dt><i>pos</i> (QPoint)</dt> 167 </dd>
168 <dt><i>pos</i> (QPoint)</dt>
133 <dd> 169 <dd>
134 position to show the indicator at 170 position to show the indicator at
135 </dd> 171 </dd>
136 </dl><dl> 172 </dl>
173 <dl>
137 <dt>Returns:</dt> 174 <dt>Returns:</dt>
138 <dd> 175 <dd>
139 flag indicating, that the indicator is shown 176 flag indicating, that the indicator is shown
140 </dd> 177 </dd>
141 </dl><dl> 178 </dl>
142 <dt>Return Type:</dt> 179 <dl>
143 <dd> 180 <dt>Return Type:</dt>
144 bool 181 <dd>
145 </dd> 182 bool
146 </dl><a NAME="AutoScroller.__stopScrolling" ID="AutoScroller.__stopScrolling"></a> 183 </dd>
184 </dl>
185 <a NAME="AutoScroller.__stopScrolling" ID="AutoScroller.__stopScrolling"></a>
147 <h4>AutoScroller.__stopScrolling</h4> 186 <h4>AutoScroller.__stopScrolling</h4>
148 <b>__stopScrolling</b>(<i></i>) 187 <b>__stopScrolling</b>(<i></i>)
188
149 <p> 189 <p>
150 Private method to stop scrolling. 190 Private method to stop scrolling.
151 </p><a NAME="AutoScroller.eventFilter" ID="AutoScroller.eventFilter"></a> 191 </p>
192 <a NAME="AutoScroller.eventFilter" ID="AutoScroller.eventFilter"></a>
152 <h4>AutoScroller.eventFilter</h4> 193 <h4>AutoScroller.eventFilter</h4>
153 <b>eventFilter</b>(<i>obj, evt</i>) 194 <b>eventFilter</b>(<i>obj, evt</i>)
195
154 <p> 196 <p>
155 Public method to handle event for an object. 197 Public method to handle event for an object.
156 </p><dl> 198 </p>
199 <dl>
200
157 <dt><i>obj</i> (QObject)</dt> 201 <dt><i>obj</i> (QObject)</dt>
158 <dd> 202 <dd>
159 refernce to the object sending the event 203 refernce to the object sending the event
160 </dd><dt><i>evt</i> (QEvent)</dt> 204 </dd>
205 <dt><i>evt</i> (QEvent)</dt>
161 <dd> 206 <dd>
162 reference to the event to be handled 207 reference to the event to be handled
163 </dd> 208 </dd>
164 </dl><dl> 209 </dl>
165 <dt>Returns:</dt> 210 <dl>
166 <dd> 211 <dt>Returns:</dt>
167 flag indicating, that the event was handled 212 <dd>
168 </dd> 213 flag indicating, that the event was handled
169 </dl><dl> 214 </dd>
170 <dt>Return Type:</dt> 215 </dl>
171 <dd> 216 <dl>
172 bool 217 <dt>Return Type:</dt>
173 </dd> 218 <dd>
174 </dl><a NAME="AutoScroller.isEnabled" ID="AutoScroller.isEnabled"></a> 219 bool
220 </dd>
221 </dl>
222 <a NAME="AutoScroller.isEnabled" ID="AutoScroller.isEnabled"></a>
175 <h4>AutoScroller.isEnabled</h4> 223 <h4>AutoScroller.isEnabled</h4>
176 <b>isEnabled</b>(<i></i>) 224 <b>isEnabled</b>(<i></i>)
225
177 <p> 226 <p>
178 Public method to get the enabled state. 227 Public method to get the enabled state.
179 </p><dl> 228 </p>
229 <dl>
180 <dt>Returns:</dt> 230 <dt>Returns:</dt>
181 <dd> 231 <dd>
182 enabled state 232 enabled state
183 </dd> 233 </dd>
184 </dl><dl> 234 </dl>
185 <dt>Return Type:</dt> 235 <dl>
186 <dd> 236 <dt>Return Type:</dt>
187 bool 237 <dd>
188 </dd> 238 bool
189 </dl><a NAME="AutoScroller.mouseMove" ID="AutoScroller.mouseMove"></a> 239 </dd>
240 </dl>
241 <a NAME="AutoScroller.mouseMove" ID="AutoScroller.mouseMove"></a>
190 <h4>AutoScroller.mouseMove</h4> 242 <h4>AutoScroller.mouseMove</h4>
191 <b>mouseMove</b>(<i>evt</i>) 243 <b>mouseMove</b>(<i>evt</i>)
244
192 <p> 245 <p>
193 Public method to handle mouse move events. 246 Public method to handle mouse move events.
194 </p><dl> 247 </p>
248 <dl>
249
195 <dt><i>evt</i> (QMouseEvent)</dt> 250 <dt><i>evt</i> (QMouseEvent)</dt>
196 <dd> 251 <dd>
197 reference to the mouse move event 252 reference to the mouse move event
198 </dd> 253 </dd>
199 </dl><dl> 254 </dl>
200 <dt>Returns:</dt> 255 <dl>
201 <dd> 256 <dt>Returns:</dt>
202 flag indicating, that the event was handled 257 <dd>
203 </dd> 258 flag indicating, that the event was handled
204 </dl><dl> 259 </dd>
205 <dt>Return Type:</dt> 260 </dl>
206 <dd> 261 <dl>
207 bool 262 <dt>Return Type:</dt>
208 </dd> 263 <dd>
209 </dl><a NAME="AutoScroller.mousePress" ID="AutoScroller.mousePress"></a> 264 bool
265 </dd>
266 </dl>
267 <a NAME="AutoScroller.mousePress" ID="AutoScroller.mousePress"></a>
210 <h4>AutoScroller.mousePress</h4> 268 <h4>AutoScroller.mousePress</h4>
211 <b>mousePress</b>(<i>view, evt</i>) 269 <b>mousePress</b>(<i>view, evt</i>)
270
212 <p> 271 <p>
213 Public method to handle mouse button presses. 272 Public method to handle mouse button presses.
214 </p><dl> 273 </p>
274 <dl>
275
215 <dt><i>view</i> (WebBrowserView)</dt> 276 <dt><i>view</i> (WebBrowserView)</dt>
216 <dd> 277 <dd>
217 reference to the web view the button was pressed on 278 reference to the web view the button was pressed on
218 </dd><dt><i>evt</i> (QMouseEvent)</dt> 279 </dd>
280 <dt><i>evt</i> (QMouseEvent)</dt>
219 <dd> 281 <dd>
220 reference to the mouse button press event 282 reference to the mouse button press event
221 </dd> 283 </dd>
222 </dl><dl> 284 </dl>
223 <dt>Returns:</dt> 285 <dl>
224 <dd> 286 <dt>Returns:</dt>
225 flag indicating, that the event was handled 287 <dd>
226 </dd> 288 flag indicating, that the event was handled
227 </dl><dl> 289 </dd>
228 <dt>Return Type:</dt> 290 </dl>
229 <dd> 291 <dl>
230 bool 292 <dt>Return Type:</dt>
231 </dd> 293 <dd>
232 </dl><a NAME="AutoScroller.mouseRelease" ID="AutoScroller.mouseRelease"></a> 294 bool
295 </dd>
296 </dl>
297 <a NAME="AutoScroller.mouseRelease" ID="AutoScroller.mouseRelease"></a>
233 <h4>AutoScroller.mouseRelease</h4> 298 <h4>AutoScroller.mouseRelease</h4>
234 <b>mouseRelease</b>(<i>evt</i>) 299 <b>mouseRelease</b>(<i>evt</i>)
300
235 <p> 301 <p>
236 Public method to handle mouse button releases. 302 Public method to handle mouse button releases.
237 </p><dl> 303 </p>
304 <dl>
305
238 <dt><i>evt</i> (QMouseEvent)</dt> 306 <dt><i>evt</i> (QMouseEvent)</dt>
239 <dd> 307 <dd>
240 reference to the mouse button release event 308 reference to the mouse button release event
241 </dd> 309 </dd>
242 </dl><dl> 310 </dl>
243 <dt>Returns:</dt> 311 <dl>
244 <dd> 312 <dt>Returns:</dt>
245 flag indicating, that the event was handled 313 <dd>
246 </dd> 314 flag indicating, that the event was handled
247 </dl><dl> 315 </dd>
248 <dt>Return Type:</dt> 316 </dl>
249 <dd> 317 <dl>
250 bool 318 <dt>Return Type:</dt>
251 </dd> 319 <dd>
252 </dl><a NAME="AutoScroller.preferencesChanged" ID="AutoScroller.preferencesChanged"></a> 320 bool
321 </dd>
322 </dl>
323 <a NAME="AutoScroller.preferencesChanged" ID="AutoScroller.preferencesChanged"></a>
253 <h4>AutoScroller.preferencesChanged</h4> 324 <h4>AutoScroller.preferencesChanged</h4>
254 <b>preferencesChanged</b>(<i></i>) 325 <b>preferencesChanged</b>(<i></i>)
326
255 <p> 327 <p>
256 Public method to handle a change of the settings. 328 Public method to handle a change of the settings.
257 </p><a NAME="AutoScroller.wheel" ID="AutoScroller.wheel"></a> 329 </p>
330 <a NAME="AutoScroller.wheel" ID="AutoScroller.wheel"></a>
258 <h4>AutoScroller.wheel</h4> 331 <h4>AutoScroller.wheel</h4>
259 <b>wheel</b>(<i></i>) 332 <b>wheel</b>(<i></i>)
333
260 <p> 334 <p>
261 Public method to handle a mouse wheel event. 335 Public method to handle a mouse wheel event.
262 </p><dl> 336 </p>
263 <dt>Returns:</dt> 337 <dl>
264 <dd> 338 <dt>Returns:</dt>
265 flag indicating, that the event was handled 339 <dd>
266 </dd> 340 flag indicating, that the event was handled
267 </dl><dl> 341 </dd>
342 </dl>
343 <dl>
268 <dt>Return Type:</dt> 344 <dt>Return Type:</dt>
269 <dd> 345 <dd>
270 bool 346 bool
271 </dd> 347 </dd>
272 </dl> 348 </dl>

Mercurial Repository: eric

eric ide

mercurial