Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric6.WebBrowser.AutoScroll.AutoScroller.html

Documentation/Source/eric6.WebBrowser.AutoScroll.AutoScroller.html

changeset 4958
ef400197e7d5
equal deleted inserted replaced
4957:55c9bb589b0a 4958:ef400197e7d5
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.WebBrowser.AutoScroll.AutoScroller</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.AutoScroller</h1>
23 <p>
24 Module implementing the automatic scroller.
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="#AutoScroller">AutoScroller</a></td>
34 <td>Class implementing the automatic scroller.</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="AutoScroller" ID="AutoScroller"></a>
43 <h2>AutoScroller</h2>
44 <p>
45 Class implementing the automatic scroller.
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="#AutoScroller.__init__">AutoScroller</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#AutoScroller.__indicatorGlobalRect">__indicatorGlobalRect</a></td>
64 <td>Private method to calculate the global indicator parameters.</td>
65 </tr><tr>
66 <td><a href="#AutoScroller.__showIndicator">__showIndicator</a></td>
67 <td>Private method to show the auto scroll indicator.</td>
68 </tr><tr>
69 <td><a href="#AutoScroller.__stopScrolling">__stopScrolling</a></td>
70 <td>Private method to stop scrolling.</td>
71 </tr><tr>
72 <td><a href="#AutoScroller.eventFilter">eventFilter</a></td>
73 <td>Public method to handle event for an object.</td>
74 </tr><tr>
75 <td><a href="#AutoScroller.isEnabled">isEnabled</a></td>
76 <td>Public method to get the enabled state.</td>
77 </tr><tr>
78 <td><a href="#AutoScroller.mouseMove">mouseMove</a></td>
79 <td>Public method to handle mouse move events.</td>
80 </tr><tr>
81 <td><a href="#AutoScroller.mousePress">mousePress</a></td>
82 <td>Public method to handle mouse button presses.</td>
83 </tr><tr>
84 <td><a href="#AutoScroller.mouseRelease">mouseRelease</a></td>
85 <td>Public method to handle mouse button releases.</td>
86 </tr><tr>
87 <td><a href="#AutoScroller.preferencesChanged">preferencesChanged</a></td>
88 <td>Public method to handle a change of the settings.</td>
89 </tr><tr>
90 <td><a href="#AutoScroller.wheel">wheel</a></td>
91 <td>Public method to handle a mouse wheel event.</td>
92 </tr>
93 </table>
94 <h3>Static Methods</h3>
95 <table>
96 <tr><td>None</td></tr>
97 </table>
98 <a NAME="AutoScroller.__init__" ID="AutoScroller.__init__"></a>
99 <h4>AutoScroller (Constructor)</h4>
100 <b>AutoScroller</b>(<i>parent=None</i>)
101 <p>
102 Constructor
103 </p><dl>
104 <dt><i>parent</i> (QObject)</dt>
105 <dd>
106 reference to the parent object
107 </dd>
108 </dl><a NAME="AutoScroller.__indicatorGlobalRect" ID="AutoScroller.__indicatorGlobalRect"></a>
109 <h4>AutoScroller.__indicatorGlobalRect</h4>
110 <b>__indicatorGlobalRect</b>(<i></i>)
111 <p>
112 Private method to calculate the global indicator parameters.
113 </p><dl>
114 <dt>Returns:</dt>
115 <dd>
116 global indicator parameters
117 </dd>
118 </dl><dl>
119 <dt>Return Type:</dt>
120 <dd>
121 QRect
122 </dd>
123 </dl><a NAME="AutoScroller.__showIndicator" ID="AutoScroller.__showIndicator"></a>
124 <h4>AutoScroller.__showIndicator</h4>
125 <b>__showIndicator</b>(<i>view, pos</i>)
126 <p>
127 Private method to show the auto scroll indicator.
128 </p><dl>
129 <dt><i>view</i> (WebBrowserView)</dt>
130 <dd>
131 reference to the view to show the indicator on
132 </dd><dt><i>pos</i> (QPoint)</dt>
133 <dd>
134 position to show the indicator at
135 </dd>
136 </dl><dl>
137 <dt>Returns:</dt>
138 <dd>
139 flag indicating, that the indicator is shown
140 </dd>
141 </dl><dl>
142 <dt>Return Type:</dt>
143 <dd>
144 bool
145 </dd>
146 </dl><a NAME="AutoScroller.__stopScrolling" ID="AutoScroller.__stopScrolling"></a>
147 <h4>AutoScroller.__stopScrolling</h4>
148 <b>__stopScrolling</b>(<i></i>)
149 <p>
150 Private method to stop scrolling.
151 </p><a NAME="AutoScroller.eventFilter" ID="AutoScroller.eventFilter"></a>
152 <h4>AutoScroller.eventFilter</h4>
153 <b>eventFilter</b>(<i>obj, evt</i>)
154 <p>
155 Public method to handle event for an object.
156 </p><dl>
157 <dt><i>obj</i> (QObject)</dt>
158 <dd>
159 refernce to the object sending the event
160 </dd><dt><i>evt</i> (QEvent)</dt>
161 <dd>
162 reference to the event to be handled
163 </dd>
164 </dl><dl>
165 <dt>Returns:</dt>
166 <dd>
167 flag indicating, that the event was handled
168 </dd>
169 </dl><dl>
170 <dt>Return Type:</dt>
171 <dd>
172 bool
173 </dd>
174 </dl><a NAME="AutoScroller.isEnabled" ID="AutoScroller.isEnabled"></a>
175 <h4>AutoScroller.isEnabled</h4>
176 <b>isEnabled</b>(<i></i>)
177 <p>
178 Public method to get the enabled state.
179 </p><dl>
180 <dt>Returns:</dt>
181 <dd>
182 enabled state
183 </dd>
184 </dl><dl>
185 <dt>Return Type:</dt>
186 <dd>
187 bool
188 </dd>
189 </dl><a NAME="AutoScroller.mouseMove" ID="AutoScroller.mouseMove"></a>
190 <h4>AutoScroller.mouseMove</h4>
191 <b>mouseMove</b>(<i>evt</i>)
192 <p>
193 Public method to handle mouse move events.
194 </p><dl>
195 <dt><i>evt</i> (QMouseEvent)</dt>
196 <dd>
197 reference to the mouse move event
198 </dd>
199 </dl><dl>
200 <dt>Returns:</dt>
201 <dd>
202 flag indicating, that the event was handled
203 </dd>
204 </dl><dl>
205 <dt>Return Type:</dt>
206 <dd>
207 bool
208 </dd>
209 </dl><a NAME="AutoScroller.mousePress" ID="AutoScroller.mousePress"></a>
210 <h4>AutoScroller.mousePress</h4>
211 <b>mousePress</b>(<i>view, evt</i>)
212 <p>
213 Public method to handle mouse button presses.
214 </p><dl>
215 <dt><i>view</i> (WebBrowserView)</dt>
216 <dd>
217 reference to the web view the button was pressed on
218 </dd><dt><i>evt</i> (QMouseEvent)</dt>
219 <dd>
220 reference to the mouse button press event
221 </dd>
222 </dl><dl>
223 <dt>Returns:</dt>
224 <dd>
225 flag indicating, that the event was handled
226 </dd>
227 </dl><dl>
228 <dt>Return Type:</dt>
229 <dd>
230 bool
231 </dd>
232 </dl><a NAME="AutoScroller.mouseRelease" ID="AutoScroller.mouseRelease"></a>
233 <h4>AutoScroller.mouseRelease</h4>
234 <b>mouseRelease</b>(<i>evt</i>)
235 <p>
236 Public method to handle mouse button releases.
237 </p><dl>
238 <dt><i>evt</i> (QMouseEvent)</dt>
239 <dd>
240 reference to the mouse button release event
241 </dd>
242 </dl><dl>
243 <dt>Returns:</dt>
244 <dd>
245 flag indicating, that the event was handled
246 </dd>
247 </dl><dl>
248 <dt>Return Type:</dt>
249 <dd>
250 bool
251 </dd>
252 </dl><a NAME="AutoScroller.preferencesChanged" ID="AutoScroller.preferencesChanged"></a>
253 <h4>AutoScroller.preferencesChanged</h4>
254 <b>preferencesChanged</b>(<i></i>)
255 <p>
256 Public method to handle a change of the settings.
257 </p><a NAME="AutoScroller.wheel" ID="AutoScroller.wheel"></a>
258 <h4>AutoScroller.wheel</h4>
259 <b>wheel</b>(<i></i>)
260 <p>
261 Public method to handle a mouse wheel event.
262 </p><dl>
263 <dt>Returns:</dt>
264 <dd>
265 flag indicating, that the event was handled
266 </dd>
267 </dl><dl>
268 <dt>Return Type:</dt>
269 <dd>
270 bool
271 </dd>
272 </dl>
273 <div align="right"><a href="#top">Up</a></div>
274 <hr />
275 </body></html>

Mercurial Repository: eric

eric ide

mercurial