src/eric7/Documentation/Source/eric7.WebBrowser.AutoScroll.FrameScroller.html

branch
eric7
changeset 10479
856476537696
parent 9209
b99e7fd55fd3
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.WebBrowser.AutoScroll.FrameScroller</h1> 9 <h1>eric7.WebBrowser.AutoScroll.FrameScroller</h1>
10
11 <p> 10 <p>
12 Module implementing an object to scroll a web page. 11 Module implementing an object to scroll a web page.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15
16 <table> 15 <table>
17 <tr><td>None</td></tr> 16 <tr><td>None</td></tr>
18 </table> 17 </table>
18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20
21 <table> 20 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#FrameScroller">FrameScroller</a></td> 22 <td><a href="#FrameScroller">FrameScroller</a></td>
25 <td>Class implementing a web page scroller object.</td> 23 <td>Class implementing a web page scroller object.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29
30 <table> 28 <table>
31 <tr><td>None</td></tr> 29 <tr><td>None</td></tr>
32 </table> 30 </table>
31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="FrameScroller" ID="FrameScroller"></a> 34 <a NAME="FrameScroller" ID="FrameScroller"></a>
36 <h2>FrameScroller</h2> 35 <h2>FrameScroller</h2>
37
38 <p> 36 <p>
39 Class implementing a web page scroller object. 37 Class implementing a web page scroller object.
40 </p> 38 </p>
39
41 <h3>Derived from</h3> 40 <h3>Derived from</h3>
42 QObject 41 QObject
43 <h3>Class Attributes</h3> 42 <h3>Class Attributes</h3>
44
45 <table> 43 <table>
46 <tr><td>None</td></tr> 44 <tr><td>None</td></tr>
47 </table> 45 </table>
46
48 <h3>Class Methods</h3> 47 <h3>Class Methods</h3>
49
50 <table> 48 <table>
51 <tr><td>None</td></tr> 49 <tr><td>None</td></tr>
52 </table> 50 </table>
51
53 <h3>Methods</h3> 52 <h3>Methods</h3>
54
55 <table> 53 <table>
56
57 <tr> 54 <tr>
58 <td><a href="#FrameScroller.__init__">FrameScroller</a></td> 55 <td><a href="#FrameScroller.__init__">FrameScroller</a></td>
59 <td>Constructor</td> 56 <td>Constructor</td>
60 </tr> 57 </tr>
61 <tr> 58 <tr>
81 <tr> 78 <tr>
82 <td><a href="#FrameScroller.stopScrolling">stopScrolling</a></td> 79 <td><a href="#FrameScroller.stopScrolling">stopScrolling</a></td>
83 <td>Public method to stop scrolling.</td> 80 <td>Public method to stop scrolling.</td>
84 </tr> 81 </tr>
85 </table> 82 </table>
83
86 <h3>Static Methods</h3> 84 <h3>Static Methods</h3>
87
88 <table> 85 <table>
89 <tr><td>None</td></tr> 86 <tr><td>None</td></tr>
90 </table> 87 </table>
91 88
89
92 <a NAME="FrameScroller.__init__" ID="FrameScroller.__init__"></a> 90 <a NAME="FrameScroller.__init__" ID="FrameScroller.__init__"></a>
93 <h4>FrameScroller (Constructor)</h4> 91 <h4>FrameScroller (Constructor)</h4>
94 <b>FrameScroller</b>(<i>parent=None</i>) 92 <b>FrameScroller</b>(<i>parent=None</i>)
95
96 <p> 93 <p>
97 Constructor 94 Constructor
98 </p> 95 </p>
96
99 <dl> 97 <dl>
100 98
101 <dt><i>parent</i> (QObject)</dt> 99 <dt><i>parent</i> (QObject)</dt>
102 <dd> 100 <dd>
103 reference to the parent object 101 reference to the parent object
104 </dd> 102 </dd>
105 </dl> 103 </dl>
106 <a NAME="FrameScroller.__scrollStep" ID="FrameScroller.__scrollStep"></a> 104 <a NAME="FrameScroller.__scrollStep" ID="FrameScroller.__scrollStep"></a>
107 <h4>FrameScroller.__scrollStep</h4> 105 <h4>FrameScroller.__scrollStep</h4>
108 <b>__scrollStep</b>(<i></i>) 106 <b>__scrollStep</b>(<i></i>)
109
110 <p> 107 <p>
111 Private slot to scroll one step. 108 Private slot to scroll one step.
112 </p> 109 </p>
110
113 <a NAME="FrameScroller.scrollDivider" ID="FrameScroller.scrollDivider"></a> 111 <a NAME="FrameScroller.scrollDivider" ID="FrameScroller.scrollDivider"></a>
114 <h4>FrameScroller.scrollDivider</h4> 112 <h4>FrameScroller.scrollDivider</h4>
115 <b>scrollDivider</b>(<i></i>) 113 <b>scrollDivider</b>(<i></i>)
116
117 <p> 114 <p>
118 Public method to get the current scroll divider value. 115 Public method to get the current scroll divider value.
119 </p> 116 </p>
117
120 <dl> 118 <dl>
121 <dt>Return:</dt> 119 <dt>Return:</dt>
122 <dd> 120 <dd>
123 scroll divider 121 scroll divider
124 </dd> 122 </dd>
130 </dd> 128 </dd>
131 </dl> 129 </dl>
132 <a NAME="FrameScroller.setPage" ID="FrameScroller.setPage"></a> 130 <a NAME="FrameScroller.setPage" ID="FrameScroller.setPage"></a>
133 <h4>FrameScroller.setPage</h4> 131 <h4>FrameScroller.setPage</h4>
134 <b>setPage</b>(<i>page</i>) 132 <b>setPage</b>(<i>page</i>)
135
136 <p> 133 <p>
137 Public method to set the web page to be scrolled. 134 Public method to set the web page to be scrolled.
138 </p> 135 </p>
136
139 <dl> 137 <dl>
140 138
141 <dt><i>page</i> (WebBrowserPage)</dt> 139 <dt><i>page</i> (WebBrowserPage)</dt>
142 <dd> 140 <dd>
143 page to be scrolled 141 page to be scrolled
144 </dd> 142 </dd>
145 </dl> 143 </dl>
146 <a NAME="FrameScroller.setScrollDivider" ID="FrameScroller.setScrollDivider"></a> 144 <a NAME="FrameScroller.setScrollDivider" ID="FrameScroller.setScrollDivider"></a>
147 <h4>FrameScroller.setScrollDivider</h4> 145 <h4>FrameScroller.setScrollDivider</h4>
148 <b>setScrollDivider</b>(<i>divider</i>) 146 <b>setScrollDivider</b>(<i>divider</i>)
149
150 <p> 147 <p>
151 Public method to set the scroll divider value. 148 Public method to set the scroll divider value.
152 </p> 149 </p>
150
153 <dl> 151 <dl>
154 152
155 <dt><i>divider</i> (float)</dt> 153 <dt><i>divider</i> (float)</dt>
156 <dd> 154 <dd>
157 scroll divider 155 scroll divider
158 </dd> 156 </dd>
159 </dl> 157 </dl>
160 <a NAME="FrameScroller.startScrolling" ID="FrameScroller.startScrolling"></a> 158 <a NAME="FrameScroller.startScrolling" ID="FrameScroller.startScrolling"></a>
161 <h4>FrameScroller.startScrolling</h4> 159 <h4>FrameScroller.startScrolling</h4>
162 <b>startScrolling</b>(<i>lengthX, lengthY</i>) 160 <b>startScrolling</b>(<i>lengthX, lengthY</i>)
163
164 <p> 161 <p>
165 Public method to start scrolling. 162 Public method to start scrolling.
166 </p> 163 </p>
164
167 <dl> 165 <dl>
168 166
169 <dt><i>lengthX</i> (int)</dt> 167 <dt><i>lengthX</i> (int)</dt>
170 <dd> 168 <dd>
171 X distance from scroll indicator 169 X distance from scroll indicator
176 </dd> 174 </dd>
177 </dl> 175 </dl>
178 <a NAME="FrameScroller.stopScrolling" ID="FrameScroller.stopScrolling"></a> 176 <a NAME="FrameScroller.stopScrolling" ID="FrameScroller.stopScrolling"></a>
179 <h4>FrameScroller.stopScrolling</h4> 177 <h4>FrameScroller.stopScrolling</h4>
180 <b>stopScrolling</b>(<i></i>) 178 <b>stopScrolling</b>(<i></i>)
181
182 <p> 179 <p>
183 Public method to stop scrolling. 180 Public method to stop scrolling.
184 </p> 181 </p>
182
185 <div align="right"><a href="#top">Up</a></div> 183 <div align="right"><a href="#top">Up</a></div>
186 <hr /> 184 <hr />
187 </body></html> 185 </body></html>

eric ide

mercurial