src/eric7/Documentation/Source/eric7.EricWidgets.EricAnimatedLabel.html

<!DOCTYPE html>
<html><head>
<title>eric7.EricWidgets.EricAnimatedLabel</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.EricWidgets.EricAnimatedLabel</h1>
<p>
Module implementing a label widget showing an animated pixmap.
</p>

<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Classes</h3>
<table>
<tr>
<td><a href="#EricAnimatedLabel">EricAnimatedLabel</a></td>
<td>Class implementing a label widget showing an animated pixmap.</td>
</tr>
</table>

<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>

<hr />
<hr />
<a NAME="EricAnimatedLabel" ID="EricAnimatedLabel"></a>
<h2>EricAnimatedLabel</h2>
<p>
    Class implementing a label widget showing an animated pixmap.
</p>

<h3>Derived from</h3>
QLabel
<h3>Class Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Class Methods</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Methods</h3>
<table>
<tr>
<td><a href="#EricAnimatedLabel.__init__">EricAnimatedLabel</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#EricAnimatedLabel.__animate">__animate</a></td>
<td>Private slot to animate the pixmap.</td>
</tr>
<tr>
<td><a href="#EricAnimatedLabel.__loadAnimationFile">__loadAnimationFile</a></td>
<td>Private method to load an animation file.</td>
</tr>
<tr>
<td><a href="#EricAnimatedLabel.getAnimationFile">getAnimationFile</a></td>
<td>Public method to get the name of the animation file.</td>
</tr>
<tr>
<td><a href="#EricAnimatedLabel.getInterval">getInterval</a></td>
<td>Public method to get the interval between the animated frames.</td>
</tr>
<tr>
<td><a href="#EricAnimatedLabel.isActive">isActive</a></td>
<td>Public method to check, if the animation is active.</td>
</tr>
<tr>
<td><a href="#EricAnimatedLabel.isAnimationFileLoaded">isAnimationFileLoaded</a></td>
<td>Public method to check, if the animation file was loaded.</td>
</tr>
<tr>
<td><a href="#EricAnimatedLabel.reset">reset</a></td>
<td>Public slot to reset the animation.</td>
</tr>
<tr>
<td><a href="#EricAnimatedLabel.setAnimationFile">setAnimationFile</a></td>
<td>Public method to set the name of the animation file.</td>
</tr>
<tr>
<td><a href="#EricAnimatedLabel.setInterval">setInterval</a></td>
<td>Public method to set the interval between the animated frames.</td>
</tr>
<tr>
<td><a href="#EricAnimatedLabel.setPixmap">setPixmap</a></td>
<td>Public slot to set the pixmap of the label.</td>
</tr>
<tr>
<td><a href="#EricAnimatedLabel.start">start</a></td>
<td>Public slot to start the animation.</td>
</tr>
<tr>
<td><a href="#EricAnimatedLabel.stop">stop</a></td>
<td>Public slot to stop the animation.</td>
</tr>
</table>

<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>


<a NAME="EricAnimatedLabel.__init__" ID="EricAnimatedLabel.__init__"></a>
<h4>EricAnimatedLabel (Constructor)</h4>
<b>EricAnimatedLabel</b>(<i>parent=None, *, animationFile="", interval=100</i>)
<p>
        Constructor
</p>

<dl>

<dt><i>parent</i> (QWidget)</dt>
<dd>
reference to the parent window
</dd>
<dt><i>animationFile=</i> (str)</dt>
<dd>
path to the file containing the animation data
</dd>
<dt><i>interval=</i> (int)</dt>
<dd>
interval in milliseconds between animation frames
</dd>
</dl>
<a NAME="EricAnimatedLabel.__animate" ID="EricAnimatedLabel.__animate"></a>
<h4>EricAnimatedLabel.__animate</h4>
<b>__animate</b>(<i></i>)
<p>
        Private slot to animate the pixmap.
</p>

<a NAME="EricAnimatedLabel.__loadAnimationFile" ID="EricAnimatedLabel.__loadAnimationFile"></a>
<h4>EricAnimatedLabel.__loadAnimationFile</h4>
<b>__loadAnimationFile</b>(<i>animationFile</i>)
<p>
        Private method to load an animation file.
</p>

<dl>

<dt><i>animationFile</i> (str)</dt>
<dd>
path to the file containing the animation data
</dd>
</dl>
<a NAME="EricAnimatedLabel.getAnimationFile" ID="EricAnimatedLabel.getAnimationFile"></a>
<h4>EricAnimatedLabel.getAnimationFile</h4>
<b>getAnimationFile</b>(<i></i>)
<p>
        Public method to get the name of the animation file.
</p>

<dl>
<dt>Return:</dt>
<dd>
path to the file containing the animation data
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<a NAME="EricAnimatedLabel.getInterval" ID="EricAnimatedLabel.getInterval"></a>
<h4>EricAnimatedLabel.getInterval</h4>
<b>getInterval</b>(<i></i>)
<p>
        Public method to get the interval between the animated frames.
</p>

<dl>
<dt>Return:</dt>
<dd>
interval in milliseconds between animation frames
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
int
</dd>
</dl>
<a NAME="EricAnimatedLabel.isActive" ID="EricAnimatedLabel.isActive"></a>
<h4>EricAnimatedLabel.isActive</h4>
<b>isActive</b>(<i></i>)
<p>
        Public method to check, if the animation is active.
</p>

<dl>
<dt>Return:</dt>
<dd>
flag indicating an active animation
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<a NAME="EricAnimatedLabel.isAnimationFileLoaded" ID="EricAnimatedLabel.isAnimationFileLoaded"></a>
<h4>EricAnimatedLabel.isAnimationFileLoaded</h4>
<b>isAnimationFileLoaded</b>(<i></i>)
<p>
        Public method to check, if the animation file was loaded.
</p>

<dl>
<dt>Return:</dt>
<dd>
flag indicating a successfully loaded animation file
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<a NAME="EricAnimatedLabel.reset" ID="EricAnimatedLabel.reset"></a>
<h4>EricAnimatedLabel.reset</h4>
<b>reset</b>(<i></i>)
<p>
        Public slot to reset the animation.
</p>

<a NAME="EricAnimatedLabel.setAnimationFile" ID="EricAnimatedLabel.setAnimationFile"></a>
<h4>EricAnimatedLabel.setAnimationFile</h4>
<b>setAnimationFile</b>(<i>animationFile</i>)
<p>
        Public method to set the name of the animation file.
</p>

<dl>

<dt><i>animationFile</i> (str)</dt>
<dd>
path to the file containing the animation data
</dd>
</dl>
<a NAME="EricAnimatedLabel.setInterval" ID="EricAnimatedLabel.setInterval"></a>
<h4>EricAnimatedLabel.setInterval</h4>
<b>setInterval</b>(<i>interval</i>)
<p>
        Public method to set the interval between the animated frames.
</p>

<dl>

<dt><i>interval</i> (int)</dt>
<dd>
interval in milliseconds between animation frames
</dd>
</dl>
<a NAME="EricAnimatedLabel.setPixmap" ID="EricAnimatedLabel.setPixmap"></a>
<h4>EricAnimatedLabel.setPixmap</h4>
<b>setPixmap</b>(<i>pixmap</i>)
<p>
        Public slot to set the pixmap of the label.
</p>
<p>
        Setting a standard pixmap will stop the animation and set the given
        pixmap without animating it. Thereafter the animation has to be
        restarted with the start() method.
</p>

<dl>

<dt><i>pixmap</i> (QPixmap)</dt>
<dd>
pixmap to be set
</dd>
</dl>
<a NAME="EricAnimatedLabel.start" ID="EricAnimatedLabel.start"></a>
<h4>EricAnimatedLabel.start</h4>
<b>start</b>(<i></i>)
<p>
        Public slot to start the animation.
</p>

<a NAME="EricAnimatedLabel.stop" ID="EricAnimatedLabel.stop"></a>
<h4>EricAnimatedLabel.stop</h4>
<b>stop</b>(<i></i>)
<p>
        Public slot to stop the animation.
</p>

<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>