Participants objects interact with synthclone
.
More...
#include <synthclone/participant.h>
|
| Participant (const QString &name, int majorVersion, int minorVersion, int revision, const QString &author, const QString &summary, QObject *parent=0) |
| Constructs a new participant. More...
|
|
virtual | ~Participant () |
| Destroys a participant. More...
|
|
Participants objects interact with synthclone
.
Interaction takes place through the Context object that is passed with activate().
synthclone::Participant::Participant |
( |
const QString & |
name, |
|
|
int |
majorVersion, |
|
|
int |
minorVersion, |
|
|
int |
revision, |
|
|
const QString & |
author, |
|
|
const QString & |
summary, |
|
|
QObject * |
parent = 0 |
|
) |
| |
|
protected |
Constructs a new participant.
This constructor should not be called directly; instead, Participant subclasses should call this constructor in their constructors.
- Parameters
-
name | The translated participant name. |
majorVersion | The major version of the participant. |
minorVersion | The minor version of the participant. |
revision | The revision portion of the version of the participant. |
author | The author of the participant. |
summary | A translated summary for the participant. |
parent | The parent object of the new participant. |
virtual synthclone::Participant::~Participant |
( |
| ) |
|
|
protectedvirtual |
virtual void synthclone::Participant::activate |
( |
Context & |
context, |
|
|
const QVariant & |
state = QVariant() |
|
) |
| |
|
virtual |
Links the Participant with the application.
- Parameters
-
context | A context object specific to this participant. The context object serves as a mediator between this participant and synthclone . |
state | If a session is being restored, then the state argument will contain the return value of getState(), called when the session was previously loaded; otherwise, the argument is an invalid QVariant. |
virtual void synthclone::Participant::deactivate |
( |
Context & |
context | ) |
|
|
virtual |
Unlinks the Participant from the application.
After returning from this method, the Context object will be destroyed.
- Parameters
-
context | The Context object that was passed to activate(). This object will be destroyed some time after this call returns. |
QString synthclone::Participant::getAuthor |
( |
| ) |
const |
Gets the author of this Participant.
- Returns
- The author.
int synthclone::Participant::getMajorVersion |
( |
| ) |
const |
Gets the major version for this Participant.
- Returns
- The major version.
int synthclone::Participant::getMinorVersion |
( |
| ) |
const |
Gets the minor version for this Participant.
- Returns
- The minor version.
QString synthclone::Participant::getName |
( |
| ) |
const |
Gets the translated name for this Participant.
- Returns
- The translated name.
int synthclone::Participant::getRevision |
( |
| ) |
const |
Gets the revision portion of the Participant version.
- Returns
- The revision.
virtual QVariant synthclone::Participant::getState |
( |
| ) |
const |
|
virtual |
Gets the state of the Participant.
The state will be passed to the activate() method if the current session is reloaded. The default implementation returns an invalid QVariant.
- Returns
- The participant state.
virtual QVariant synthclone::Participant::getState |
( |
const synthclone::Effect * |
effect | ) |
const |
|
virtual |
Gets the state of an Effect created by this Participant.
The state should contain all the details necessary to recreate the Effect. The state will be passed to the restoreEffect() method if the current session is reloaded.
- Parameters
-
effect | An effect created by this participant. |
- Returns
- The effect state.
virtual QVariant synthclone::Participant::getState |
( |
const synthclone::Sampler * |
sampler | ) |
const |
|
virtual |
Gets the state of a Sampler created by this Participant.
The state should contain all the details necessary to recreate the Sampler. The state will be passed to the restoreSampler() method if the current session is reloaded.
- Parameters
-
sampler | A sampler created by this participant. |
- Returns
- The sampler state.
virtual QVariant synthclone::Participant::getState |
( |
const synthclone::Target * |
target | ) |
const |
|
virtual |
Gets the state of a Target created by this Participant.
The state should contain all the details necessary to recreate the Target. The state will be passed to the restoreTarget() method if the current session is reloaded.
- Parameters
-
target | A target created by this participant. |
- Returns
- The target state.
QString synthclone::Participant::getSummary |
( |
| ) |
const |
Gets the translated summary for this participant.
- Returns
- The translated summary.
virtual void synthclone::Participant::restoreEffect |
( |
const QVariant & |
state | ) |
|
|
virtual |
Called to restore an Effect.
The Participant should create the Effect specified by the given state, and append the effect to the session's Effect list using the Context object.
- Parameters
-
state | The state of the effect. |
virtual void synthclone::Participant::restoreSampler |
( |
const QVariant & |
state | ) |
|
|
virtual |
virtual void synthclone::Participant::restoreTarget |
( |
const QVariant & |
state | ) |
|
|
virtual |
Called to restore a Target.
The Participant should create the Target specified by the given state, and append the Target to the session's Target list using the Context object.
- Parameters
-
state | The state of the target. |
The documentation for this class was generated from the following file: