<?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>Phonon.EffectParameter</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.7 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>EffectParameter Class Reference</h1> <code>from PyKDE4.phonon import *</code> <p> Namespace: <a href="../phonon/Phonon.html">Phonon</a><br /> <h2>Detailed Description</h2> <p>\class EffectParameter effectparameter.h phonon/EffectParameter This class describes one parameter of an effect. </p> <p> <dl class="author" compact><dt><b>Author:</b></dt><dd> Matthias Kretz <kretz@kde.org> </dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> Effect </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="#Hint">Hint</a> </td><td class="memItemRight" valign="bottom">{ ToggledHint, LogarithmicHint, IntegerHint }</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="#EffectParameter">__init__</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#EffectParameter">__init__</a> (self, <a href="../phonon/Phonon.EffectParameter.html">Phonon.EffectParameter</a> rhs)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#EffectParameter">__init__</a> (self, int parameterId, QString name, <a href="../phonon/Phonon.EffectParameter.html">Phonon.EffectParameter.Hints</a> hints, QVariant defaultValue, QVariant min=QVariant(), QVariant max=QVariant(), [QVariant] values=QVariantList(), QString description=QString())</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QVariant </td><td class="memItemRight" valign="bottom"><a class="el" href="#defaultValue">defaultValue</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#description">description</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#id">id</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isLogarithmicControl">isLogarithmicControl</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QVariant </td><td class="memItemRight" valign="bottom"><a class="el" href="#maximumValue">maximumValue</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QVariant </td><td class="memItemRight" valign="bottom"><a class="el" href="#minimumValue">minimumValue</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#name">name</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#operator <">operator <</a> (self, <a href="../phonon/Phonon.EffectParameter.html">Phonon.EffectParameter</a> rhs)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#operator ==">operator ==</a> (self, <a href="../phonon/Phonon.EffectParameter.html">Phonon.EffectParameter</a> rhs)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#operator >">operator ></a> (self, <a href="../phonon/Phonon.EffectParameter.html">Phonon.EffectParameter</a> rhs)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">[QVariant] </td><td class="memItemRight" valign="bottom"><a class="el" href="#possibleValues">possibleValues</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QVariant::Type </td><td class="memItemRight" valign="bottom"><a class="el" href="#type">type</a> (self)</td></tr> </table> <hr><h2>Method Documentation</h2><a class="anchor" name="EffectParameter"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">__init__</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="internal" compact><dt><b>Internal:</b></dt><dd> </dd></dl> </p> <p> Creates an invalid effect parameter. </p></div></div><a class="anchor" name="EffectParameter"></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"><a href="../phonon/Phonon.EffectParameter.html">Phonon.EffectParameter</a> </td> <td class="paramname"><em>rhs</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"></div></div><a class="anchor" name="EffectParameter"></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">int </td> <td class="paramname"><em>parameterId</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">QString </td> <td class="paramname"><em>name</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../phonon/Phonon.EffectParameter.html">Phonon.EffectParameter.Hints</a> </td> <td class="paramname"><em>hints</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">QVariant </td> <td class="paramname"><em>defaultValue</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">QVariant </td> <td class="paramname"><em>min=QVariant()</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">QVariant </td> <td class="paramname"><em>max=QVariant()</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">[QVariant] </td> <td class="paramname"><em>values=QVariantList()</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">QString </td> <td class="paramname"><em>description=QString()</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Only to be used by backend implementations: </p> <p> Creates a new effect parameter. </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>parameterId</em> </td><td> This is a number to uniquely identify the parameter. The id is used for value() and setValue(). </td></tr> </table></dl> <p> </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>name</em> </td><td> The name/label for this parameter. </td></tr> </table></dl> <p> </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>hints</em> </td><td> Sets the hints for the type of parameter. </td></tr> </table></dl> <p> </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>defaultValue</em> </td><td> The value that should be used as a default. </td></tr> </table></dl> <p> </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>min</em> </td><td> The minimum value allowed for this parameter. You only need to set this if the BoundedBelowHint is set. </td></tr> </table></dl> <p> </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>max</em> </td><td> The maximum value allowed for this parameter. You only need to set this if the BoundedAboveHint is set. </td></tr> </table></dl> <p> </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>description</em> </td><td> A descriptive text for the parameter (explaining what it controls) to be used as a tooltip or WhatsThis help. </td></tr> </table></dl> <p> </p></div></div><a class="anchor" name="defaultValue"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">QVariant defaultValue</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>The default value. </p></div></div><a class="anchor" name="description"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">QString description</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>The parameter may come with a description (LADSPA doesn't have a field for this, so don't expect many effects to provide a description). </p> <p> The description can be used for a tooltip or WhatsThis help. </p> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> A text describing the parameter. </dd></dl> </p></div></div><a class="anchor" name="id"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">int id</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="internal" compact><dt><b>Internal:</b></dt><dd> </dd></dl> </p> <p> Returns the parameter's id. </p></div></div><a class="anchor" name="isLogarithmicControl"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">bool isLogarithmicControl</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>Returns whether the parameter should be displayed using a logarithmic scale. This is particularly useful for frequencies and gains. </p></div></div><a class="anchor" name="maximumValue"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">QVariant maximumValue</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>The maximum value to be used for the control to edit the parameter. </p> <p> If the returned QVariant is invalid the value is not bounded from above. </p></div></div><a class="anchor" name="minimumValue"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">QVariant minimumValue</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>The minimum value to be used for the control to edit the parameter. </p> <p> If the returned QVariant is invalid the value is not bounded from below. </p></div></div><a class="anchor" name="name"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">QString name</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>The name of the parameter. Can be used as the label. </p> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> A label for the parameter. </dd></dl> </p></div></div><a class="anchor" name="operator <"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">bool operator <</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"><a href="../phonon/Phonon.EffectParameter.html">Phonon.EffectParameter</a> </td> <td class="paramname"><em>rhs</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p><dl class="internal" compact><dt><b>Internal:</b></dt><dd> compares the ids of the parameters </dd></dl> </p></div></div><a class="anchor" name="operator =="></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">bool operator ==</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"><a href="../phonon/Phonon.EffectParameter.html">Phonon.EffectParameter</a> </td> <td class="paramname"><em>rhs</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p><dl class="internal" compact><dt><b>Internal:</b></dt><dd> compares the ids of the parameters </dd></dl> </p></div></div><a class="anchor" name="operator >"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">bool operator ></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"><a href="../phonon/Phonon.EffectParameter.html">Phonon.EffectParameter</a> </td> <td class="paramname"><em>rhs</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p><dl class="internal" compact><dt><b>Internal:</b></dt><dd> compares the ids of the parameters </dd></dl> </p></div></div><a class="anchor" name="possibleValues"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">[QVariant] possibleValues</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>The possible values to be used for the control to edit the parameter. </p> <p> if the value of this parameter is to be picked from predefined values this returns the list (otherwise it returns an empty QVariantList). </p></div></div><a class="anchor" name="type"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">QVariant::Type type</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>Returns the parameter type. </p> <p> Common types are QVariant.Int, QVariant.Double, QVariant.Bool and QVariant.String. When QVariant.String is returned you get the possible values from possibleValues. </p></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="Hint"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr><td class="memname">Hint</td> </tr> </table> </div> <div class="memdoc"><p>Only for backend developers: </p> <p> Flags to set the return values of isToggleControl(), isLogarithmicControl(), isIntegerControl(), isBoundedBelow() and isBoundedAbove(). The values of the flags correspond to the values used for LADSPA effects. </p><dl compact><dt><b>Enumerator: </b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>ToggledHint</em> = 0x04</td><td><tr><td valign="top"><em>LogarithmicHint</em> = 0x10</td><td><tr><td valign="top"><em>IntegerHint</em> = 0x20</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>