synthclone  0.3.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
synthclone::IPlugin Class Referenceabstract

This interface is implemented by synthclone plugins. More...

#include <synthclone/iplugin.h>

Public Member Functions

virtual ~IPlugin ()
 
virtual QByteArray getId () const =0
 Gets the root Participant id. More...
 
virtual ParticipantgetParticipant ()=0
 Gets the root Participant for this plugin. More...
 

Detailed Description

This interface is implemented by synthclone plugins.

Constructor & Destructor Documentation

virtual synthclone::IPlugin::~IPlugin ( )
inlinevirtual

Member Function Documentation

virtual QByteArray synthclone::IPlugin::getId ( ) const
pure virtual

Gets the root Participant id.

The id is used to identify Participant objects, to create child Participant ids, and to save/load Participant and Component data.

Valid Participant Identifiers
A valid Participant id is a dot-delimited string containing one or more sub-id parts. Each sub-id part must start and end with a number or letter, and contain only numbers, letters, and hyphens.
The following ids are considered valid:
  • a
  • a.b
  • a.bc
  • a.b-c
  • a.b–c
The following ids are considered invalid:
  • a.
  • .a.b
  • a..b
  • a.b.
  • a.-b
  • a.-
  • -
Identifier Recommendations
Ids should be formatted using the following sub-ids:
  1. A top-level domain appropriate to the plugin distributor.
  2. A sub-domain appropriate to the plugin distributor.
  3. The sub-id 'synthclone'.
  4. The sub-id 'plugins'.
  5. A sub-id containing the name of the plugin.
For example, a plugin named 'test' created by a developer from 'example.com' would have the id 'com.example.synthclone.plugins.test'.
Ids of plugins distributed within synthclone will take the form 'com.googlecode.synthclone.plugins.[name]'.
Ids of the form 'com.googlecode.synthclone.*' are reserved for future use.
Returns
The root Participant id.
virtual Participant* synthclone::IPlugin::getParticipant ( )
pure virtual

Gets the root Participant for this plugin.

The root Participant will be registered with the application.

Returns
The root participant.

The documentation for this class was generated from the following file: