EffectParameter Class Reference
from PyKDE4.phonon import *
Namespace: Phonon.EffectParameter
Detailed Description
\class EffectParameter effectparameter.h Phonon/EffectParameter This class describes one parameter of an effect.
- See also:
- Effect
Enumerations | |
Hint | { ToggledHint, LogarithmicHint, IntegerHint } |
Methods | |
__init__ (self) | |
__init__ (self, Phonon.EffectParameter rhs) | |
__init__ (self, int parameterId, QString name, Phonon.EffectParameter.Hints hints, QVariant defaultValue, QVariant min=QVariant(), QVariant max=QVariant(), QVariantList values=QVariantList(), QString description=QString()) | |
QVariant | defaultValue (self) |
QString | description (self) |
int | id (self) |
bool | isLogarithmicControl (self) |
QVariant | maximumValue (self) |
QVariant | minimumValue (self) |
QString | name (self) |
bool | operator < (self, Phonon.EffectParameter rhs) |
bool | operator == (self, Phonon.EffectParameter rhs) |
bool | operator > (self, Phonon.EffectParameter rhs) |
QVariantList | possibleValues (self) |
QVariant.Type | type (self) |
Method Documentation
__init__ | ( | self ) |
__init__ | ( | self, | ||
Phonon.EffectParameter | rhs | |||
) |
__init__ | ( | self, | ||
int | parameterId, | |||
QString | name, | |||
Phonon.EffectParameter.Hints | hints, | |||
QVariant | defaultValue, | |||
QVariant | min=QVariant(), | |||
QVariant | max=QVariant(), | |||
QVariantList | values=QVariantList(), | |||
QString | description=QString() | |||
) |
QVariant defaultValue | ( | self ) |
The default value.
QString description | ( | self ) |
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).
The description can be used for a tooltip or WhatsThis help.
- Returns:
- A text describing the parameter.
int id | ( | self ) |
- Internal:
Returns the parameter's id.
bool isLogarithmicControl | ( | self ) |
Returns whether the parameter should be displayed using a logarithmic scale. This is particularly useful for frequencies and gains.
QVariant maximumValue | ( | self ) |
The maximum value to be used for the control to edit the parameter.
If the returned QVariant is invalid the value is not bounded from above.
QVariant minimumValue | ( | self ) |
The minimum value to be used for the control to edit the parameter.
If the returned QVariant is invalid the value is not bounded from below.
QString name | ( | self ) |
The name of the parameter. Can be used as the label.
- Returns:
- A label for the parameter.
bool operator < | ( | self, | ||
Phonon.EffectParameter | rhs | |||
) |
- Internal:
- compares the ids of the parameters
bool operator == | ( | self, | ||
Phonon.EffectParameter | rhs | |||
) |
- Internal:
- compares the ids of the parameters
bool operator > | ( | self, | ||
Phonon.EffectParameter | rhs | |||
) |
- Internal:
- compares the ids of the parameters
QVariantList possibleValues | ( | self ) |
The possible values to be used for the control to edit the parameter.
if the value of this parameter is to be picked from predefined values this returns the list (otherwise it returns an empty QVariantList).
QVariant.Type type | ( | self ) |
Returns the parameter type.
Common types are QVariant.Int, QVariant.Double, QVariant.Bool and QVariant.String. When QVariant.String is returned you get the possible values from possibleValues.
Enumeration Documentation
Hint |
- Enumerator:
-