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