Mercurial Repositories > eric / file comparison
comparison: eric7/Documentation/Source/eric7.WebBrowser.AutoScroll.FrameScroller.html
eric7/Documentation/Source/eric7.WebBrowser.AutoScroll.FrameScroller.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.FrameScroller</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.FrameScroller</h1> | |
| 24 | |
| 25 <p> | |
| 26 Module implementing an object to scroll a web page. | |
| 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="#FrameScroller">FrameScroller</a></td> | |
| 39 <td>Class implementing a web page scroller object.</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="FrameScroller" ID="FrameScroller"></a> | |
| 50 <h2>FrameScroller</h2> | |
| 51 | |
| 52 <p> | |
| 53 Class implementing a web page scroller object. | |
| 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="#FrameScroller.__init__">FrameScroller</a></td> | |
| 73 <td>Constructor</td> | |
| 74 </tr> | |
| 75 <tr> | |
| 76 <td><a href="#FrameScroller.__scrollStep">__scrollStep</a></td> | |
| 77 <td>Private slot to scroll one step.</td> | |
| 78 </tr> | |
| 79 <tr> | |
| 80 <td><a href="#FrameScroller.scrollDivider">scrollDivider</a></td> | |
| 81 <td>Public method to get the current scroll divider value.</td> | |
| 82 </tr> | |
| 83 <tr> | |
| 84 <td><a href="#FrameScroller.setPage">setPage</a></td> | |
| 85 <td>Public method to set the web page to be scrolled.</td> | |
| 86 </tr> | |
| 87 <tr> | |
| 88 <td><a href="#FrameScroller.setScrollDivider">setScrollDivider</a></td> | |
| 89 <td>Public method to set the scroll divider value.</td> | |
| 90 </tr> | |
| 91 <tr> | |
| 92 <td><a href="#FrameScroller.startScrolling">startScrolling</a></td> | |
| 93 <td>Public method to start scrolling.</td> | |
| 94 </tr> | |
| 95 <tr> | |
| 96 <td><a href="#FrameScroller.stopScrolling">stopScrolling</a></td> | |
| 97 <td>Public method to stop scrolling.</td> | |
| 98 </tr> | |
| 99 </table> | |
| 100 <h3>Static Methods</h3> | |
| 101 | |
| 102 <table> | |
| 103 <tr><td>None</td></tr> | |
| 104 </table> | |
| 105 | |
| 106 <a NAME="FrameScroller.__init__" ID="FrameScroller.__init__"></a> | |
| 107 <h4>FrameScroller (Constructor)</h4> | |
| 108 <b>FrameScroller</b>(<i>parent=None</i>) | |
| 109 | |
| 110 <p> | |
| 111 Constructor | |
| 112 </p> | |
| 113 <dl> | |
| 114 | |
| 115 <dt><i>parent</i> (QObject)</dt> | |
| 116 <dd> | |
| 117 reference to the parent object | |
| 118 </dd> | |
| 119 </dl> | |
| 120 <a NAME="FrameScroller.__scrollStep" ID="FrameScroller.__scrollStep"></a> | |
| 121 <h4>FrameScroller.__scrollStep</h4> | |
| 122 <b>__scrollStep</b>(<i></i>) | |
| 123 | |
| 124 <p> | |
| 125 Private slot to scroll one step. | |
| 126 </p> | |
| 127 <a NAME="FrameScroller.scrollDivider" ID="FrameScroller.scrollDivider"></a> | |
| 128 <h4>FrameScroller.scrollDivider</h4> | |
| 129 <b>scrollDivider</b>(<i></i>) | |
| 130 | |
| 131 <p> | |
| 132 Public method to get the current scroll divider value. | |
| 133 </p> | |
| 134 <dl> | |
| 135 <dt>Return:</dt> | |
| 136 <dd> | |
| 137 scroll divider | |
| 138 </dd> | |
| 139 </dl> | |
| 140 <dl> | |
| 141 <dt>Return Type:</dt> | |
| 142 <dd> | |
| 143 float | |
| 144 </dd> | |
| 145 </dl> | |
| 146 <a NAME="FrameScroller.setPage" ID="FrameScroller.setPage"></a> | |
| 147 <h4>FrameScroller.setPage</h4> | |
| 148 <b>setPage</b>(<i>page</i>) | |
| 149 | |
| 150 <p> | |
| 151 Public method to set the web page to be scrolled. | |
| 152 </p> | |
| 153 <dl> | |
| 154 | |
| 155 <dt><i>page</i> (WebBrowserPage)</dt> | |
| 156 <dd> | |
| 157 page to be scrolled | |
| 158 </dd> | |
| 159 </dl> | |
| 160 <a NAME="FrameScroller.setScrollDivider" ID="FrameScroller.setScrollDivider"></a> | |
| 161 <h4>FrameScroller.setScrollDivider</h4> | |
| 162 <b>setScrollDivider</b>(<i>divider</i>) | |
| 163 | |
| 164 <p> | |
| 165 Public method to set the scroll divider value. | |
| 166 </p> | |
| 167 <dl> | |
| 168 | |
| 169 <dt><i>divider</i> (float)</dt> | |
| 170 <dd> | |
| 171 scroll divider | |
| 172 </dd> | |
| 173 </dl> | |
| 174 <a NAME="FrameScroller.startScrolling" ID="FrameScroller.startScrolling"></a> | |
| 175 <h4>FrameScroller.startScrolling</h4> | |
| 176 <b>startScrolling</b>(<i>lengthX, lengthY</i>) | |
| 177 | |
| 178 <p> | |
| 179 Public method to start scrolling. | |
| 180 </p> | |
| 181 <dl> | |
| 182 | |
| 183 <dt><i>lengthX</i> (int)</dt> | |
| 184 <dd> | |
| 185 X distance from scroll indicator | |
| 186 </dd> | |
| 187 <dt><i>lengthY</i> (int)</dt> | |
| 188 <dd> | |
| 189 Y distance from scroll indicator | |
| 190 </dd> | |
| 191 </dl> | |
| 192 <a NAME="FrameScroller.stopScrolling" ID="FrameScroller.stopScrolling"></a> | |
| 193 <h4>FrameScroller.stopScrolling</h4> | |
| 194 <b>stopScrolling</b>(<i></i>) | |
| 195 | |
| 196 <p> | |
| 197 Public method to stop scrolling. | |
| 198 </p> | |
| 199 <div align="right"><a href="#top">Up</a></div> | |
| 200 <hr /> | |
| 201 </body></html> |
