Steinberg::Vst::Unit Class Reference

#include <vsteditcontroller.h>

Inheritance diagram for Steinberg::Vst::Unit:

Public Member Functions
	Unit (const String128 name, UnitID unitId, UnitID parentUnitId=kRootUnitId, ProgramListID programListId=kNoProgramListId)
	Unit (const UnitInfo &unit)
const UnitInfo &	getInfo () const
UnitID	getID () const
void	setID (UnitID newID)
const TChar *	getName () const
void	setName (const String128 newName)
ProgramListID	getProgramListID () const
void	setProgramListID (ProgramListID newID)
Public Member Functions inherited from Steinberg::FObject
	FObject ()
	default constructor...
	FObject (const FObject &)
	overloaded constructor...
virtual	~FObject ()
	destructor...
FObject &	operator= (const FObject &)
	overloads operator "=" as the reference assignment
virtual FClassID	isA () const
	a local alternative to getFClassID ()
virtual bool	isA (FClassID s) const
	evaluates if the passed ID is of the FObject type
virtual bool	isTypeOf (FClassID s, bool=true) const
	evaluates if the passed ID is of the FObject type
int32	getRefCount ()
	returns the current interface reference count
FUnknown *	unknownCast ()
	get FUnknown interface from object
tresult PLUGIN_API	queryInterface (const TUID _iid, void **obj) SMTG_OVERRIDE
	please refer to FUnknown::queryInterface ()
uint32 PLUGIN_API	addRef () SMTG_OVERRIDE
	please refer to FUnknown::addref ()
uint32 PLUGIN_API	release () SMTG_OVERRIDE
	please refer to FUnknown::release ()
void PLUGIN_API	update (FUnknown *, int32) SMTG_OVERRIDE
	empty virtual method that should be overridden by derived classes for data updates upon changes
virtual void	addDependent (IDependent *dep)
	adds dependency to the object
virtual void	removeDependent (IDependent *dep)
	removes dependency from the object
virtual void	changed (int32 msg=kChanged)
	Inform all dependents, that the object has changed.
virtual void	deferUpdate (int32 msg=kChanged)
	Similar to triggerUpdates, except only delivered in idle (usefull in collecting updates).
virtual void	updateDone (int32)
	empty virtual method that should be overridden by derived classes
virtual bool	isEqualInstance (FUnknown *d)

Protected Member Functions
	Unit ()

Protected Attributes
UnitInfo	info
Protected Attributes inherited from Steinberg::FObject
int32	refCount
	COM-model local reference count.

Additional Inherited Members
Public Types inherited from Steinberg::IDependent
enum	ChangeMessage {   kWillChange , kChanged , kDestroyed , kWillDestroy ,   kStdChangeMessageLast = kWillDestroy }
Static Public Member Functions inherited from Steinberg::FObject
static FClassID	getFClassID ()
	return Class ID as an ASCII string (statically)
static void	setUpdateHandler (IUpdateHandler *handler)
	set method for the local attribute
static IUpdateHandler *	getUpdateHandler ()
	get method for the local attribute
static bool	classIDsEqual (FClassID ci1, FClassID ci2)
	compares (evaluates) 2 class IDs
static FObject *	unknownToObject (FUnknown *unknown)
	pointer conversion from FUnknown to FObject
Static Public Attributes inherited from Steinberg::FObject
static const FUID	iid
Static Public Attributes inherited from Steinberg::IDependent
static const FUID	iid
Static Public Attributes inherited from Steinberg::FUnknown
static const FUID	iid
Static Protected Attributes inherited from Steinberg::FObject
static IUpdateHandler *	gUpdateHandler = nullptr

Detailed Description

Unit element.

Constructor & Destructor Documentation

Unit() [1/3]

Steinberg::Vst::Unit::Unit	(	const String128	name,
		UnitID	unitId,
		UnitID	parentUnitId = kRootUnitId,
		ProgramListID	programListId = kNoProgramListId )

Unit() [2/3]

Steinberg::Vst::Unit::Unit

(

const UnitInfo &

unit

)

Unit() [3/3]

Steinberg::Vst::Unit::Unit ( )

protected

Member Function Documentation

getID()

UnitID Steinberg::Vst::Unit::getID ( ) const

inline

Returns its Unit ID.

getInfo()

const UnitInfo & Steinberg::Vst::Unit::getInfo ( ) const

inline

Returns its info.

getName()

const TChar * Steinberg::Vst::Unit::getName ( ) const

inline

Returns its Unit Name.

getProgramListID()

ProgramListID Steinberg::Vst::Unit::getProgramListID ( ) const

inline

Returns its ProgramList ID.

setID()

void Steinberg::Vst::Unit::setID ( UnitID newID )

inline

Sets a new Unit ID.

setName()

void Steinberg::Vst::Unit::setName

(

const String128

newName

)

Sets a new Unit Name.

setProgramListID()

void Steinberg::Vst::Unit::setProgramListID ( ProgramListID newID )

inline

Sets a new ProgramList ID.

Member Data Documentation

info

UnitInfo Steinberg::Vst::Unit::info

protected

---

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

• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/includes/vst3sdk/public.sdk/source/vst/vsteditcontroller.h
• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/includes/vst3sdk/public.sdk/source/vst/vsteditcontroller.cpp