synthclone::Component Class Reference

Base class for synthclone components. More...

#include <synthclone/component.h>

Inheritance diagram for synthclone::Component:

Collaboration diagram for synthclone::Component:

Public Slots
void	setName (const QString &name)
	Sets the name of this Component.

Signals
void	nameChanged (const QString &name)
	Emitted when the Component name is changed.
void	progressChanged (float progress)
	Emitted by the Component to indicate progress in whatever operation the Component is performing.
void	statusChanged (const QString &status)
	Emitted when the Component object's status changes.

Public Member Functions
QString	getName () const
	Gets the Component name.

Protected Member Functions
	Component (const QString &name, QObject *parent=0)
	Constructs a new Component object.
virtual	~Component ()
	Destroys a Component object.

Detailed Description

Base class for synthclone components.

This includes Effect, Sampler, and Target objects.

Constructor & Destructor Documentation

Component()

synthclone::Component::Component ( const QString & name, QObject * parent = 0 )

explicitprotected

Constructs a new Component object.

This constructor shouldn't be called directly; instead, one of the Component subclasses should be used.

Parameters

name	The initial component name.
parent	The parent object of the component.

See also

Effect, Sampler, Target

~Component()

virtual synthclone::Component::~Component ( )

protectedvirtual

Destroys a Component object.

Member Function Documentation

getName()

QString synthclone::Component::getName

(

)

const

Gets the Component name.

Returns

The name of this component.

nameChanged

void synthclone::Component::nameChanged ( const QString & name )

signal

Emitted when the Component name is changed.

Subclasses do not need to worry about this signal.

Parameters

name	The new name.

progressChanged

void synthclone::Component::progressChanged ( float progress )

signal

Emitted by the Component to indicate progress in whatever operation the Component is performing.

Parameters

progress

The 'progress' amount, which must be in the range [0.0, 1.0], where 0.0 and 1.0 are roughly equivalent to "just starting" and "finished".

See also

Effect::process, Sampler::startJob, Target::build

setName

void synthclone::Component::setName ( const QString & name )

slot

Sets the name of this Component.

Parameters

name	The component name.

statusChanged

void synthclone::Component::statusChanged ( const QString & status )

signal

Emitted when the Component object's status changes.

Parameters

status

The new status.

---

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

• component.h