Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric6.WebBrowser.AutoScroll.FrameScroller.html
Documentation/Source/eric6.WebBrowser.AutoScroll.FrameScroller.html
- changeset 4958
- ef400197e7d5
equal
deleted
inserted
replaced
| 4957:55c9bb589b0a | 4958:ef400197e7d5 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.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><a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.WebBrowser.AutoScroll.FrameScroller</h1> | |
| 23 <p> | |
| 24 Module implementing an object to scroll a web page. | |
| 25 </p> | |
| 26 <h3>Global Attributes</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <h3>Classes</h3> | |
| 31 <table> | |
| 32 <tr> | |
| 33 <td><a href="#FrameScroller">FrameScroller</a></td> | |
| 34 <td>Class implementing a web page scroller object.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <h3>Functions</h3> | |
| 38 <table> | |
| 39 <tr><td>None</td></tr> | |
| 40 </table> | |
| 41 <hr /><hr /> | |
| 42 <a NAME="FrameScroller" ID="FrameScroller"></a> | |
| 43 <h2>FrameScroller</h2> | |
| 44 <p> | |
| 45 Class implementing a web page scroller object. | |
| 46 </p> | |
| 47 <h3>Derived from</h3> | |
| 48 QObject | |
| 49 <h3>Class Attributes</h3> | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Class Methods</h3> | |
| 54 <table> | |
| 55 <tr><td>None</td></tr> | |
| 56 </table> | |
| 57 <h3>Methods</h3> | |
| 58 <table> | |
| 59 <tr> | |
| 60 <td><a href="#FrameScroller.__init__">FrameScroller</a></td> | |
| 61 <td>Constructor</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#FrameScroller.__scrollStep">__scrollStep</a></td> | |
| 64 <td>Private slot to scroll one step.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#FrameScroller.scrollDivider">scrollDivider</a></td> | |
| 67 <td>Public method to get the current scroll divider value.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#FrameScroller.setPage">setPage</a></td> | |
| 70 <td>Public method to set the web page to be scrolled.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#FrameScroller.setScrollDivider">setScrollDivider</a></td> | |
| 73 <td>Public method to set the scroll divider value.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#FrameScroller.startScrolling">startScrolling</a></td> | |
| 76 <td>Public method to start scrolling.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#FrameScroller.stopScrolling">stopScrolling</a></td> | |
| 79 <td>Public method to stop scrolling.</td> | |
| 80 </tr> | |
| 81 </table> | |
| 82 <h3>Static Methods</h3> | |
| 83 <table> | |
| 84 <tr><td>None</td></tr> | |
| 85 </table> | |
| 86 <a NAME="FrameScroller.__init__" ID="FrameScroller.__init__"></a> | |
| 87 <h4>FrameScroller (Constructor)</h4> | |
| 88 <b>FrameScroller</b>(<i>parent=None</i>) | |
| 89 <p> | |
| 90 Constructor | |
| 91 </p><dl> | |
| 92 <dt><i>parent</i> (QObject)</dt> | |
| 93 <dd> | |
| 94 reference to the parent object | |
| 95 </dd> | |
| 96 </dl><a NAME="FrameScroller.__scrollStep" ID="FrameScroller.__scrollStep"></a> | |
| 97 <h4>FrameScroller.__scrollStep</h4> | |
| 98 <b>__scrollStep</b>(<i></i>) | |
| 99 <p> | |
| 100 Private slot to scroll one step. | |
| 101 </p><a NAME="FrameScroller.scrollDivider" ID="FrameScroller.scrollDivider"></a> | |
| 102 <h4>FrameScroller.scrollDivider</h4> | |
| 103 <b>scrollDivider</b>(<i></i>) | |
| 104 <p> | |
| 105 Public method to get the current scroll divider value. | |
| 106 </p><dl> | |
| 107 <dt>Returns:</dt> | |
| 108 <dd> | |
| 109 scroll divider | |
| 110 </dd> | |
| 111 </dl><dl> | |
| 112 <dt>Return Type:</dt> | |
| 113 <dd> | |
| 114 float | |
| 115 </dd> | |
| 116 </dl><a NAME="FrameScroller.setPage" ID="FrameScroller.setPage"></a> | |
| 117 <h4>FrameScroller.setPage</h4> | |
| 118 <b>setPage</b>(<i>page</i>) | |
| 119 <p> | |
| 120 Public method to set the web page to be scrolled. | |
| 121 </p><dl> | |
| 122 <dt><i>page</i> (WebBrowserPage)</dt> | |
| 123 <dd> | |
| 124 page to be scrolled | |
| 125 </dd> | |
| 126 </dl><a NAME="FrameScroller.setScrollDivider" ID="FrameScroller.setScrollDivider"></a> | |
| 127 <h4>FrameScroller.setScrollDivider</h4> | |
| 128 <b>setScrollDivider</b>(<i>divider</i>) | |
| 129 <p> | |
| 130 Public method to set the scroll divider value. | |
| 131 </p><dl> | |
| 132 <dt><i>divider</i> (float)</dt> | |
| 133 <dd> | |
| 134 scroll divider | |
| 135 </dd> | |
| 136 </dl><a NAME="FrameScroller.startScrolling" ID="FrameScroller.startScrolling"></a> | |
| 137 <h4>FrameScroller.startScrolling</h4> | |
| 138 <b>startScrolling</b>(<i>lengthX, lengthY</i>) | |
| 139 <p> | |
| 140 Public method to start scrolling. | |
| 141 </p><dl> | |
| 142 <dt><i>lengthX</i> (int)</dt> | |
| 143 <dd> | |
| 144 X distance from scroll indicator | |
| 145 </dd><dt><i>lengthY</i> (int)</dt> | |
| 146 <dd> | |
| 147 Y distance from scroll indicator | |
| 148 </dd> | |
| 149 </dl><a NAME="FrameScroller.stopScrolling" ID="FrameScroller.stopScrolling"></a> | |
| 150 <h4>FrameScroller.stopScrolling</h4> | |
| 151 <b>stopScrolling</b>(<i></i>) | |
| 152 <p> | |
| 153 Public method to stop scrolling. | |
| 154 </p> | |
| 155 <div align="right"><a href="#top">Up</a></div> | |
| 156 <hr /> | |
| 157 </body></html> |
