participant.h

Go to the documentation of this file.

/*
 * libsynthclone - a plugin API for `synthclone`
 * Copyright (C) 2011 Devin Anderson
 *
 * This library is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by the
 * Free Software Foundation; either version 2.1 of the License, or (at your
 * option) any later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
 
#ifndef __SYNTHCLONE_PARTICIPANT_H__
#define __SYNTHCLONE_PARTICIPANT_H__
 
#include <QtCore/QVariant>
 
#include <synthclone/context.h>
 
namespace synthclone {
 
    class Participant: public QObject {
 
        Q_OBJECT
 
    public:
 
        virtual void
        activate(Context &context, const QVariant &state=QVariant());
 
        virtual void
        deactivate(Context &context);
 
        QString
        getAuthor() const;
 
        int
        getMajorVersion() const;
 
        int
        getMinorVersion() const;
 
        QString
        getName() const;
 
        int
        getRevision() const;
 
        virtual QVariant
        getState() const;
 
        virtual QVariant
        getState(const synthclone::Effect *effect) const;
 
        virtual QVariant
        getState(const synthclone::Sampler *sampler) const;
 
        virtual QVariant
        getState(const synthclone::Target *target) const;
 
        QString
        getSummary() const;
 
        virtual void
        restoreEffect(const QVariant &state);
 
        virtual void
        restoreSampler(const QVariant &state);
 
        virtual void
        restoreTarget(const QVariant &state);
 
    protected:
 
        Participant(const QString &name, int majorVersion, int minorVersion,
                    int revision, const QString &author,
                    const QString &summary, QObject *parent=0);
 
        virtual
        ~Participant();
 
    private:
 
        QString author;
        int majorVersion;
        int minorVersion;
        QString name;
        int revision;
        QString summary;
 
    };
 
}
 
#endif