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