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