#include <Phonon/EffectParameter>
This class describes one parameter of an effect.
Definition at line 49 of file effectparameter.h.
Public Types | |
| enum | Hint { ToggledHint = 0x04, LogarithmicHint = 0x10, IntegerHint = 0x20 } |
| Only for backend developers: More... | |
Public Member Functions | |
| EffectParameter () | |
| const QString & | name () const |
| The name of the parameter. More... | |
| 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). More... | |
| QVariant::Type | type () const |
| Returns the parameter type. More... | |
| bool | isLogarithmicControl () const |
| Returns whether the parameter should be displayed using a logarithmic scale. More... | |
| QVariant | minimumValue () const |
| The minimum value to be used for the control to edit the parameter. More... | |
| QVariant | maximumValue () const |
| The maximum value to be used for the control to edit the parameter. More... | |
| QVariant | defaultValue () const |
| The default value. More... | |
| QVariantList | possibleValues () const |
| The possible values to be used for the control to edit the parameter. More... | |
| bool | operator< (const EffectParameter &rhs) const |
| bool | operator> (const EffectParameter &rhs) const |
| bool | operator== (const EffectParameter &rhs) const |
| ~EffectParameter () | |
| EffectParameter (const EffectParameter &rhs) | |
| EffectParameter & | operator= (const EffectParameter &rhs) |
| EffectParameter (int parameterId, const QString &name, 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: More... | |
| int | id () const |
Protected Attributes | |
| QExplicitlySharedDataPointer< EffectParameterPrivate > | d |
| The data is implicitly shared. More... | |
Friends | |
| class | BrightnessControl |
| 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.
|
| LogarithmicHint |
|
| IntegerHint |
|
Definition at line 153 of file effectparameter.h.
| EffectParameter | ( | ) |
Creates an invalid effect parameter.
| ~EffectParameter | ( | ) |
| EffectParameter | ( | const EffectParameter & | rhs | ) |
| EffectParameter | ( | int | parameterId, |
| const QString & | name, | ||
| 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.
| 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 minimum value allowed for this parameter. You only need to set this if the BoundedBelowHint is set. |
| max | The maximum 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. |
The name of the parameter.
Can be used as the label.
| 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.
| 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).
| bool operator< | ( | const EffectParameter & | rhs | ) | const |
compares the ids of the parameters
| bool operator> | ( | const EffectParameter & | rhs | ) | const |
compares the ids of the parameters
| bool operator== | ( | const EffectParameter & | rhs | ) | const |
compares the ids of the parameters
| EffectParameter& operator= | ( | const EffectParameter & | rhs | ) |
|
friend |
Definition at line 51 of file effectparameter.h.
|
protected |
The data is implicitly shared.
Definition at line 217 of file effectparameter.h.