KDE 4.0 API Reference Phonon
EffectParameter Class Reference
[Effects]
#include <Phonon/EffectParameter>
Detailed Description
This class describes one parameter of an effect.
- See also:
- Effect
Public Types | |
| enum | Hint { ToggledHint = 0x04, LogarithmicHint = 0x10, IntegerHint = 0x20 } |
Public Member Functions | |
| const QString & | name () const |
| const QString & | description () const |
| QVariant::Type | type () const |
| bool | isLogarithmicControl () const |
| QVariant | minimumValue () const |
| QVariant | maximumValue () const |
| QVariant | defaultValue () const |
| QVariantList | possibleValues () const |
| EffectParameter (int parameterId, const QString &name, EffectParameter::Hints hints, const QVariant &defaultValue, const QVariant &min=QVariant(), const QVariant &max=QVariant(), const QVariantList &values=QVariantList(), const QString &description=QString()) | |
Member Enumeration Documentation
| enum Hint |
Only for backend developers:.
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.
- Enumerator:
-
ToggledHint If this hint is set it means that the the control has only two states: zero and non-zero. - See also:
- isToggleControl()
LogarithmicHint - See also:
- isLogarithmicControl()
IntegerHint - See also:
- isIntegerControl
Constructor & Destructor Documentation
| EffectParameter | ( | int | parameterId, | |
| const QString & | name, | |||
| EffectParameter::Hints | hints, | |||
| const QVariant & | defaultValue, | |||
| const QVariant & | min = QVariant(), |
|||
| const QVariant & | max = QVariant(), |
|||
| const QVariantList & | values = QVariantList(), |
|||
| const QString & | description = QString() | |||
| ) |
Only to be used by backend implementations:.
Creates a new effect parameter.
- Parameters:
-
parameterId This is a number to uniquely identify the parameter. The id is used for value() and setValue(). name The name/label for this parameter. hints Sets the hints for the type of parameter. defaultValue The value that should be used as a default. min The minium value allowed for this parameter. You only need to set this if the BoundedBelowHint is set. max The maxium value allowed for this parameter. You only need to set this if the BoundedAboveHint is set. description A descriptive text for the parameter (explaining what it controls) to be used as a tooltip or WhatsThis help.
Member Function Documentation
| const QString& name | ( | ) | const |
The name of the parameter.
Can be used as the label.
- Returns:
- A label for the parameter.
| const QString& description | ( | ) | const |
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.
| QVariant::Type type | ( | ) | const |
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.
| bool isLogarithmicControl | ( | ) | const |
Returns whether the parameter should be displayed using a logarithmic scale.
This is particularly useful for frequencies and gains.
| QVariant minimumValue | ( | ) | const |
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.
| QVariant maximumValue | ( | ) | const |
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 defaultValue | ( | ) | const |
The default value.
| QVariantList possibleValues | ( | ) | const |
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).
The documentation for this class was generated from the following file:
- effectparameter.h
