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

<!DOCTYPE html>
<html><head>
<title>eric7.EricWidgets.EricAnimatedWidget</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.EricWidgets.EricAnimatedWidget</h1>

<p>
Module implementing an animated widget.
</p>
<h3>Global Attributes</h3>

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

<table>

<tr>
<td><a href="#EricAnimatedWidget">EricAnimatedWidget</a></td>
<td>Class implementing an animated widget.</td>
</tr>
<tr>
<td><a href="#EricAnimationDirection">EricAnimationDirection</a></td>
<td>Class defining the animation directions.</td>
</tr>
</table>
<h3>Functions</h3>

<table>
<tr><td>None</td></tr>
</table>
<hr />
<hr />
<a NAME="EricAnimatedWidget" ID="EricAnimatedWidget"></a>
<h2>EricAnimatedWidget</h2>

<p>
    Class implementing an animated widget.
</p>
<h3>Derived from</h3>
QWidget
<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="#EricAnimatedWidget.__init__">EricAnimatedWidget</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#EricAnimatedWidget.__animateFrame">__animateFrame</a></td>
<td>Private slot to animate the next frame.</td>
</tr>
<tr>
<td><a href="#EricAnimatedWidget.hide">hide</a></td>
<td>Public slot to hide the animated widget.</td>
</tr>
<tr>
<td><a href="#EricAnimatedWidget.resizeEvent">resizeEvent</a></td>
<td>Protected method to handle a resize event.</td>
</tr>
<tr>
<td><a href="#EricAnimatedWidget.startAnimation">startAnimation</a></td>
<td>Public slot to start the animation.</td>
</tr>
<tr>
<td><a href="#EricAnimatedWidget.widget">widget</a></td>
<td>Public method to get a reference to the animated widget.</td>
</tr>
</table>
<h3>Static Methods</h3>

<table>
<tr><td>None</td></tr>
</table>

<a NAME="EricAnimatedWidget.__init__" ID="EricAnimatedWidget.__init__"></a>
<h4>EricAnimatedWidget (Constructor)</h4>
<b>EricAnimatedWidget</b>(<i>direction=EricAnimationDirection.Down, duration=300, parent=None</i>)

<p>
        Constructor
</p>
<dl>

<dt><i>direction</i> (EricAnimationDirection)</dt>
<dd>
direction of the animation
</dd>
<dt><i>duration</i> (int)</dt>
<dd>
duration of the animation
</dd>
<dt><i>parent</i> (QWidget)</dt>
<dd>
reference to the parent widget
</dd>
</dl>
<a NAME="EricAnimatedWidget.__animateFrame" ID="EricAnimatedWidget.__animateFrame"></a>
<h4>EricAnimatedWidget.__animateFrame</h4>
<b>__animateFrame</b>(<i>frame</i>)

<p>
        Private slot to animate the next frame.
</p>
<dl>

<dt><i>frame</i> (int)</dt>
<dd>
frame number
</dd>
</dl>
<a NAME="EricAnimatedWidget.hide" ID="EricAnimatedWidget.hide"></a>
<h4>EricAnimatedWidget.hide</h4>
<b>hide</b>(<i></i>)

<p>
        Public slot to hide the animated widget.
</p>
<a NAME="EricAnimatedWidget.resizeEvent" ID="EricAnimatedWidget.resizeEvent"></a>
<h4>EricAnimatedWidget.resizeEvent</h4>
<b>resizeEvent</b>(<i>evt</i>)

<p>
        Protected method to handle a resize event.
</p>
<dl>

<dt><i>evt</i> (QResizeEvent)</dt>
<dd>
reference to the event object
</dd>
</dl>
<a NAME="EricAnimatedWidget.startAnimation" ID="EricAnimatedWidget.startAnimation"></a>
<h4>EricAnimatedWidget.startAnimation</h4>
<b>startAnimation</b>(<i></i>)

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

<p>
        Public method to get a reference to the animated widget.
</p>
<dl>
<dt>Return:</dt>
<dd>
reference to the animated widget
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
QWidget
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="EricAnimationDirection" ID="EricAnimationDirection"></a>
<h2>EricAnimationDirection</h2>

<p>
    Class defining the animation directions.
</p>
<h3>Derived from</h3>
enum.Enum
<h3>Class Attributes</h3>

<table>
<tr><td>Down</td></tr><tr><td>Up</td></tr>
</table>
<h3>Class Methods</h3>

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

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

<table>
<tr><td>None</td></tr>
</table>

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