Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.E5Gui.E5AnimatedLabel.html

eric6/Documentation/Source/eric6.E5Gui.E5AnimatedLabel.html

changeset 7515
2d26ec7a563c
child 7989
a21d673a8f99
equal deleted inserted replaced
7514:0960c7c1f497 7515:2d26ec7a563c
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.E5Gui.E5AnimatedLabel</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>
22 <a NAME="top" ID="top"></a>
23 <h1>eric6.E5Gui.E5AnimatedLabel</h1>
24
25 <p>
26 Module implementing a label widget showing an animated pixmap.
27 </p>
28 <h3>Global Attributes</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <h3>Classes</h3>
34
35 <table>
36
37 <tr>
38 <td><a href="#E5AnimatedLabel">E5AnimatedLabel</a></td>
39 <td>Class implementing a label widget showing an animated pixmap.</td>
40 </tr>
41 </table>
42 <h3>Functions</h3>
43
44 <table>
45 <tr><td>None</td></tr>
46 </table>
47 <hr />
48 <hr />
49 <a NAME="E5AnimatedLabel" ID="E5AnimatedLabel"></a>
50 <h2>E5AnimatedLabel</h2>
51
52 <p>
53 Class implementing a label widget showing an animated pixmap.
54 </p>
55 <h3>Derived from</h3>
56 QLabel
57 <h3>Class Attributes</h3>
58
59 <table>
60 <tr><td>None</td></tr>
61 </table>
62 <h3>Class Methods</h3>
63
64 <table>
65 <tr><td>None</td></tr>
66 </table>
67 <h3>Methods</h3>
68
69 <table>
70
71 <tr>
72 <td><a href="#E5AnimatedLabel.__init__">E5AnimatedLabel</a></td>
73 <td>Constructor</td>
74 </tr>
75 <tr>
76 <td><a href="#E5AnimatedLabel.__animate">__animate</a></td>
77 <td>Private slot to animate the pixmap.</td>
78 </tr>
79 <tr>
80 <td><a href="#E5AnimatedLabel.__loadAnimationFile">__loadAnimationFile</a></td>
81 <td>Private method to load an animation file.</td>
82 </tr>
83 <tr>
84 <td><a href="#E5AnimatedLabel.getAnimationFile">getAnimationFile</a></td>
85 <td>Public method to get the name of the animation file.</td>
86 </tr>
87 <tr>
88 <td><a href="#E5AnimatedLabel.getInterval">getInterval</a></td>
89 <td>Public method to get the interval between the animated frames.</td>
90 </tr>
91 <tr>
92 <td><a href="#E5AnimatedLabel.isActive">isActive</a></td>
93 <td>Public method to check, if the animation is active.</td>
94 </tr>
95 <tr>
96 <td><a href="#E5AnimatedLabel.isAnimationFileLoaded">isAnimationFileLoaded</a></td>
97 <td>Public method to check, if the animation file was loaded.</td>
98 </tr>
99 <tr>
100 <td><a href="#E5AnimatedLabel.reset">reset</a></td>
101 <td>Public slot to reset the animation.</td>
102 </tr>
103 <tr>
104 <td><a href="#E5AnimatedLabel.setAnimationFile">setAnimationFile</a></td>
105 <td>Public method to set the name of the animation file.</td>
106 </tr>
107 <tr>
108 <td><a href="#E5AnimatedLabel.setInterval">setInterval</a></td>
109 <td>Public method to set the interval between the animated frames.</td>
110 </tr>
111 <tr>
112 <td><a href="#E5AnimatedLabel.setPixmap">setPixmap</a></td>
113 <td>Public slot to set the pixmap of the label.</td>
114 </tr>
115 <tr>
116 <td><a href="#E5AnimatedLabel.start">start</a></td>
117 <td>Public slot to start the animation.</td>
118 </tr>
119 <tr>
120 <td><a href="#E5AnimatedLabel.stop">stop</a></td>
121 <td>Public slot to stop the animation.</td>
122 </tr>
123 </table>
124 <h3>Static Methods</h3>
125
126 <table>
127 <tr><td>None</td></tr>
128 </table>
129
130 <a NAME="E5AnimatedLabel.__init__" ID="E5AnimatedLabel.__init__"></a>
131 <h4>E5AnimatedLabel (Constructor)</h4>
132 <b>E5AnimatedLabel</b>(<i>parent=None, *, animationFile="", interval=100</i>)
133
134 <p>
135 Constructor
136 </p>
137 <dl>
138
139 <dt><i>parent</i> (QWidget)</dt>
140 <dd>
141 reference to the parent window
142 </dd>
143 <dt><i>animationFile=</i> (str)</dt>
144 <dd>
145 path to the file containing the animation data
146 </dd>
147 <dt><i>interval=</i> (int)</dt>
148 <dd>
149 interval in milliseconds between animation frames
150 </dd>
151 </dl>
152 <a NAME="E5AnimatedLabel.__animate" ID="E5AnimatedLabel.__animate"></a>
153 <h4>E5AnimatedLabel.__animate</h4>
154 <b>__animate</b>(<i></i>)
155
156 <p>
157 Private slot to animate the pixmap.
158 </p>
159 <a NAME="E5AnimatedLabel.__loadAnimationFile" ID="E5AnimatedLabel.__loadAnimationFile"></a>
160 <h4>E5AnimatedLabel.__loadAnimationFile</h4>
161 <b>__loadAnimationFile</b>(<i>animationFile</i>)
162
163 <p>
164 Private method to load an animation file.
165 </p>
166 <dl>
167
168 <dt><i>animationFile</i> (str)</dt>
169 <dd>
170 path to the file containing the animation data
171 </dd>
172 </dl>
173 <a NAME="E5AnimatedLabel.getAnimationFile" ID="E5AnimatedLabel.getAnimationFile"></a>
174 <h4>E5AnimatedLabel.getAnimationFile</h4>
175 <b>getAnimationFile</b>(<i></i>)
176
177 <p>
178 Public method to get the name of the animation file.
179 </p>
180 <dl>
181 <dt>Returns:</dt>
182 <dd>
183 path to the file containing the animation data
184 </dd>
185 </dl>
186 <dl>
187 <dt>Return Type:</dt>
188 <dd>
189 str
190 </dd>
191 </dl>
192 <a NAME="E5AnimatedLabel.getInterval" ID="E5AnimatedLabel.getInterval"></a>
193 <h4>E5AnimatedLabel.getInterval</h4>
194 <b>getInterval</b>(<i></i>)
195
196 <p>
197 Public method to get the interval between the animated frames.
198 </p>
199 <dl>
200 <dt>Returns:</dt>
201 <dd>
202 interval in milliseconds between animation frames
203 </dd>
204 </dl>
205 <dl>
206 <dt>Return Type:</dt>
207 <dd>
208 int
209 </dd>
210 </dl>
211 <a NAME="E5AnimatedLabel.isActive" ID="E5AnimatedLabel.isActive"></a>
212 <h4>E5AnimatedLabel.isActive</h4>
213 <b>isActive</b>(<i></i>)
214
215 <p>
216 Public method to check, if the animation is active.
217 </p>
218 <dl>
219 <dt>Returns:</dt>
220 <dd>
221 flag indicating an active animation
222 </dd>
223 </dl>
224 <dl>
225 <dt>Return Type:</dt>
226 <dd>
227 bool
228 </dd>
229 </dl>
230 <a NAME="E5AnimatedLabel.isAnimationFileLoaded" ID="E5AnimatedLabel.isAnimationFileLoaded"></a>
231 <h4>E5AnimatedLabel.isAnimationFileLoaded</h4>
232 <b>isAnimationFileLoaded</b>(<i></i>)
233
234 <p>
235 Public method to check, if the animation file was loaded.
236 </p>
237 <dl>
238 <dt>Returns:</dt>
239 <dd>
240 flag indicating a successfully loaded animation file
241 </dd>
242 </dl>
243 <dl>
244 <dt>Return Type:</dt>
245 <dd>
246 bool
247 </dd>
248 </dl>
249 <a NAME="E5AnimatedLabel.reset" ID="E5AnimatedLabel.reset"></a>
250 <h4>E5AnimatedLabel.reset</h4>
251 <b>reset</b>(<i></i>)
252
253 <p>
254 Public slot to reset the animation.
255 </p>
256 <a NAME="E5AnimatedLabel.setAnimationFile" ID="E5AnimatedLabel.setAnimationFile"></a>
257 <h4>E5AnimatedLabel.setAnimationFile</h4>
258 <b>setAnimationFile</b>(<i>animationFile</i>)
259
260 <p>
261 Public method to set the name of the animation file.
262 </p>
263 <dl>
264
265 <dt><i>animationFile</i> (str)</dt>
266 <dd>
267 path to the file containing the animation data
268 </dd>
269 </dl>
270 <a NAME="E5AnimatedLabel.setInterval" ID="E5AnimatedLabel.setInterval"></a>
271 <h4>E5AnimatedLabel.setInterval</h4>
272 <b>setInterval</b>(<i>interval</i>)
273
274 <p>
275 Public method to set the interval between the animated frames.
276 </p>
277 <dl>
278
279 <dt><i>interval</i> (int)</dt>
280 <dd>
281 interval in milliseconds between animation frames
282 </dd>
283 </dl>
284 <a NAME="E5AnimatedLabel.setPixmap" ID="E5AnimatedLabel.setPixmap"></a>
285 <h4>E5AnimatedLabel.setPixmap</h4>
286 <b>setPixmap</b>(<i>pixmap</i>)
287
288 <p>
289 Public slot to set the pixmap of the label.
290 </p>
291 <p>
292 Setting a standard pixmap will stop the animation and set the given
293 pixmap without animating it. Thereafter the animation has to be
294 restarted with the start() method.
295 </p>
296 <dl>
297
298 <dt><i>pixmap</i> (QPixmap)</dt>
299 <dd>
300 pixmap to be set
301 </dd>
302 </dl>
303 <a NAME="E5AnimatedLabel.start" ID="E5AnimatedLabel.start"></a>
304 <h4>E5AnimatedLabel.start</h4>
305 <b>start</b>(<i></i>)
306
307 <p>
308 Public slot to start the animation.
309 </p>
310 <a NAME="E5AnimatedLabel.stop" ID="E5AnimatedLabel.stop"></a>
311 <h4>E5AnimatedLabel.stop</h4>
312 <b>stop</b>(<i></i>)
313
314 <p>
315 Public slot to stop the animation.
316 </p>
317 <div align="right"><a href="#top">Up</a></div>
318 <hr />
319 </body></html>

Mercurial Repository: eric

eric ide

mercurial