<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"> <head> <title>Plasma.Animation</title> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta http-equiv="Content-Style-Type" content="text/css" /> <link rel="stylesheet" type="text/css" href="../common/doxygen.css" /> <link rel="stylesheet" media="screen" type="text/css" title="KDE Colors" href="../common/kde.css" /> </head> <body> <div id="container"> <div id="header"> <div id="header_top"> <div> <div> <img alt ="" src="../common/top-kde.jpg"/> KDE 4.9 PyKDE API Reference </div> </div> </div> <div id="header_bottom"> <div id="location"> <ul> <li>KDE's Python API</li> </ul> </div> <div id="menu"> <ul> <li><a href="../modules.html">Overview</a></li> <li><a href="http://techbase.kde.org/Development/Languages/Python">PyKDE Home</a></li> <li><a href="http://kde.org/family/">Sitemap</a></li> <li><a href="http://kde.org/contact/">Contact Us</a></li> </ul> </div> </div> </div> <div id="body_wrapper"> <div id="body"> <div id="right"> <div class="content"> <div id="main"> <div class="clearer"> </div> <h1>Animation Class Reference</h1> <code>from PyKDE4.plasma import *</code> <p> Inherits: QAbstractAnimation → QObject<br /> Namespace: <a href="../plasma/Plasma.html">Plasma</a><br /> <h2>Detailed Description</h2> <p>Abstract representation of a single animation. <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.4 </dd></dl> </p> <table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Enumerations</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#MovementDirectionFlag">MovementDirectionFlag</a> </td><td class="memItemRight" valign="bottom">{ MoveAny, MoveUp, MoveRight, MoveDown, MoveLeft }</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#ReferenceFlag">ReferenceFlag</a> </td><td class="memItemRight" valign="bottom">{ Center, Up, Down, Left, Right }</td></tr> <tr><td colspan="2"><br><h2>Methods</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#Animation">__init__</a> (self, QObject parent=0)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#duration">duration</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QEasingCurve </td><td class="memItemRight" valign="bottom"><a class="el" href="#easingCurve">easingCurve</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setDuration">setDuration</a> (self, int duration=250)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setEasingCurve">setEasingCurve</a> (self, QEasingCurve curve)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setTargetWidget">setTargetWidget</a> (self, QGraphicsWidget widget)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QGraphicsWidget </td><td class="memItemRight" valign="bottom"><a class="el" href="#targetWidget">targetWidget</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#updateCurrentTime">updateCurrentTime</a> (self, int currentTime)</td></tr> </table> <hr><h2>Method Documentation</h2><a class="anchor" name="Animation"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">__init__</td> <td>(</td> <td class="paramtype"> <em>self</em>, </td> <td class="paramname"></td> </tr><tr> <td class="memname"></td> <td></td> <td class="paramtype">QObject </td> <td class="paramname"><em>parent=0</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Default constructor. </p> <p> </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>parent</em> </td><td> Object parent (might be set when using </td></tr> </table></dl> <p> Animator.create factory). </p></div></div><a class="anchor" name="duration"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">int duration</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname"><em>self</em> )</td> <td width="100%"> </td> </tr> </table> </div> <div class="memdoc"><p>Get the animation duration. It can be set using the property duration. <dl class="return" compact><dt><b>Returns:</b></dt><dd> duration in ms. </dd></dl> </p></div></div><a class="anchor" name="easingCurve"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">QEasingCurve easingCurve</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname"><em>self</em> )</td> <td width="100%"> </td> </tr> </table> </div> <div class="memdoc"><p>Get the animation easing curve type </p></div></div><a class="anchor" name="setDuration"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> setDuration</td> <td>(</td> <td class="paramtype"> <em>self</em>, </td> <td class="paramname"></td> </tr><tr> <td class="memname"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>duration=250</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Change the animation duration. Default is 250ms. </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>duration</em> </td><td> The new duration of the animation. </td></tr> </table></dl> <p> </p></div></div><a class="anchor" name="setEasingCurve"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> setEasingCurve</td> <td>(</td> <td class="paramtype"> <em>self</em>, </td> <td class="paramname"></td> </tr><tr> <td class="memname"></td> <td></td> <td class="paramtype">QEasingCurve </td> <td class="paramname"><em>curve</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Set the animation easing curve type </p></div></div><a class="anchor" name="setTargetWidget"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> setTargetWidget</td> <td>(</td> <td class="paramtype"> <em>self</em>, </td> <td class="paramname"></td> </tr><tr> <td class="memname"></td> <td></td> <td class="paramtype">QGraphicsWidget </td> <td class="paramname"><em>widget</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Set the widget on which the animation is to be performed. </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>widget</em> </td><td> The QGraphicsWidget to be animated. </td></tr> </table></dl> <p> </p></div></div><a class="anchor" name="targetWidget"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">QGraphicsWidget targetWidget</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname"><em>self</em> )</td> <td width="100%"> </td> </tr> </table> </div> <div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> The widget that the animation will be performed upon </dd></dl> </p></div></div><a class="anchor" name="updateCurrentTime"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> updateCurrentTime</td> <td>(</td> <td class="paramtype"> <em>self</em>, </td> <td class="paramname"></td> </tr><tr> <td class="memname"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>currentTime</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>QAbstractAnimation will call this method while the animation is running. Each specialized animation class should implement the correct behavior for it. </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>currentTime</em> </td><td> Slapsed time using the duration as reference (it will be from duration up to zero if the animation is running backwards). </td></tr> </table></dl> <p> </p></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="MovementDirectionFlag"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr><td class="memname">MovementDirectionFlag</td> </tr> </table> </div> <div class="memdoc"><p>Animation movement direction. </p><dl compact><dt><b>Enumerator: </b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>MoveAny</em> = 0</td><td><tr><td valign="top"><em>MoveUp</em> = 0x1</td><td><tr><td valign="top"><em>MoveRight</em> = 0x2</td><td><tr><td valign="top"><em>MoveDown</em> = 0x4</td><td><tr><td valign="top"><em>MoveLeft</em> = 0x8</td><td></table> </dl> </div></div><p><a class="anchor" name="ReferenceFlag"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr><td class="memname">ReferenceFlag</td> </tr> </table> </div> <div class="memdoc"><p>Animation movement reference (used by RotationAnimation). </p><dl compact><dt><b>Enumerator: </b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>Center</em> = 0</td><td><tr><td valign="top"><em>Up</em> = 0x1</td><td><tr><td valign="top"><em>Down</em> = 0x2</td><td><tr><td valign="top"><em>Left</em> = 0x4</td><td><tr><td valign="top"><em>Right</em> = 0x8</td><td></table> </dl> </div></div><p> </div> </div> </div> <div id="left"> <div class="menu_box"> <div class="nav_list"> <ul> <li><a href="../allclasses.html">Full Index</a></li> </ul> </div> <a name="cp-menu" /><div class="menutitle"><div> <h2 id="cp-menu-project">Modules</h2> </div></div> <div class="nav_list"> <ul><li><a href="../akonadi/index.html">akonadi</a></li> <li><a href="../dnssd/index.html">dnssd</a></li> <li><a href="../kdecore/index.html">kdecore</a></li> <li><a href="../kdeui/index.html">kdeui</a></li> <li><a href="../khtml/index.html">khtml</a></li> <li><a href="../kio/index.html">kio</a></li> <li><a href="../knewstuff/index.html">knewstuff</a></li> <li><a href="../kparts/index.html">kparts</a></li> <li><a href="../kutils/index.html">kutils</a></li> <li><a href="../nepomuk/index.html">nepomuk</a></li> <li><a href="../phonon/index.html">phonon</a></li> <li><a href="../plasma/index.html">plasma</a></li> <li><a href="../polkitqt/index.html">polkitqt</a></li> <li><a href="../solid/index.html">solid</a></li> <li><a href="../soprano/index.html">soprano</a></li> </ul></div></div> </div> </div> <div class="clearer"/> </div> <div id="end_body"></div> </div> <div id="footer"><div id="footer_text"> This documentation is maintained by <a href="mailto:simon@simonzone.com">Simon Edwards</a>.<br /> KDE<sup>®</sup> and <a href="../images/kde_gear_black.png">the K Desktop Environment<sup>®</sup> logo</a> are registered trademarks of <a href="http://ev.kde.org/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> | <a href="http://www.kde.org/contact/impressum.php">Legal</a> </div></div> </body> </html>