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