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