#include "vsteditcontroller.h"

Inheritance diagram for Steinberg::Vst::ProgramList:

Public Member Functions
	ProgramList (const String128 name, ProgramListID listId, UnitID unitId)

	ProgramList (const ProgramList &programList)

const ProgramListInfo &	getInfo () const

ProgramListID	getID () const

const TChar *	getName () const

int32	getCount () const

virtual tresult	getProgramName (int32 programIndex, String128 name)

virtual tresult	setProgramName (int32 programIndex, const String128 name)

virtual tresult	getProgramInfo (int32 programIndex, CString attributeId, String128 value)

virtual tresult	hasPitchNames (int32 programIndex)

virtual tresult	getPitchName (int32 programIndex, int16 midiPitch, String128 name)

virtual int32	addProgram (const String128 name)
	Adds a program to the end of the list.

virtual bool	setProgramInfo (int32 programIndex, CString attributeId, const String128 value)
	Sets a program attribute value.

virtual Parameter *	getParameter ()
	Creates and returns the program parameter.

Public Member Functions inherited from Steinberg::FObject
	FObject ()=default
	default constructor...

	FObject (const FObject &)

FObject &	operator= (const FObject &)
	overloads operator "=" as the reference assignment

virtual	~FObject ()
	destructor...

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 Types
using	StringMap = std::map< std::string, std::u16string >

using	StringVector = std::vector< std::u16string >

using	ProgramInfoVector = std::vector< StringMap >

Protected Attributes
ProgramListInfo	info

UnitID	unitId

StringVector	programNames

ProgramInfoVector	programInfos

Parameter *	parameter

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 }

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
	Special UID that is used to cast an FUnknown pointer to a FObject.

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

Detailed Description

ProgramList element.

Definition at line 203 of file vsteditcontroller.h.

Member Typedef Documentation

◆ ProgramInfoVector

using Steinberg::Vst::ProgramList::ProgramInfoVector = std::vector<StringMap>

protected

Definition at line 246 of file vsteditcontroller.h.

◆ StringMap

using Steinberg::Vst::ProgramList::StringMap = std::map<std::string, std::u16string>

protected

Definition at line 244 of file vsteditcontroller.h.

◆ StringVector

using Steinberg::Vst::ProgramList::StringVector = std::vector<std::u16string>

protected

Definition at line 245 of file vsteditcontroller.h.

Constructor & Destructor Documentation

◆ ProgramList() [1/2]

Steinberg::Vst::ProgramList::ProgramList	(	const String128	name,
		ProgramListID	listId,
		UnitID	unitId
	)

Definition at line 518 of file vsteditcontroller.cpp.

◆ ProgramList() [2/2]

Steinberg::Vst::ProgramList::ProgramList ( const ProgramList & programList )

Definition at line 527 of file vsteditcontroller.cpp.

Member Function Documentation

◆ addProgram()

int32 Steinberg::Vst::ProgramList::addProgram ( const String128 name )

virtual

Adds a program to the end of the list.

returns the index of the program.

Reimplemented in Steinberg::Vst::ProgramListWithPitchNames.

Definition at line 536 of file vsteditcontroller.cpp.

◆ getCount()

int32 Steinberg::Vst::ProgramList::getCount ( ) const

Definition at line 213 of file vsteditcontroller.h.

◆ getID()

ProgramListID Steinberg::Vst::ProgramList::getID ( ) const

Definition at line 211 of file vsteditcontroller.h.

◆ getInfo()

const ProgramListInfo & Steinberg::Vst::ProgramList::getInfo ( ) const

Definition at line 210 of file vsteditcontroller.h.

◆ getName()

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

Definition at line 212 of file vsteditcontroller.h.

◆ getParameter()

Parameter * Steinberg::Vst::ProgramList::getParameter ( )

virtual

Creates and returns the program parameter.

Definition at line 603 of file vsteditcontroller.cpp.

◆ getPitchName()

virtual tresult Steinberg::Vst::ProgramList::getPitchName	(	int32	programIndex,
		int16	midiPitch,
		String128	name
	)

virtual

Definition at line 224 of file vsteditcontroller.h.

◆ getProgramInfo()

tresult Steinberg::Vst::ProgramList::getProgramInfo	(	int32	programIndex,
		CString	attributeId,
		String128	value
	)

virtual

Definition at line 556 of file vsteditcontroller.cpp.

◆ getProgramName()

tresult Steinberg::Vst::ProgramList::getProgramName	(	int32	programIndex,
		String128	name
	)

virtual

Definition at line 576 of file vsteditcontroller.cpp.

◆ hasPitchNames()

virtual tresult Steinberg::Vst::ProgramList::hasPitchNames ( int32 programIndex )

virtual

Definition at line 219 of file vsteditcontroller.h.

◆ setProgramInfo()

bool Steinberg::Vst::ProgramList::setProgramInfo	(	int32	programIndex,
		CString	attributeId,
		const String128	value
	)

virtual

Sets a program attribute value.

Definition at line 545 of file vsteditcontroller.cpp.

◆ setProgramName()

tresult Steinberg::Vst::ProgramList::setProgramName	(	int32	programIndex,
		const String128	name
	)

virtual

Definition at line 588 of file vsteditcontroller.cpp.

Member Data Documentation

◆ info

ProgramListInfo Steinberg::Vst::ProgramList::info

protected

Definition at line 247 of file vsteditcontroller.h.

◆ parameter

Parameter* Steinberg::Vst::ProgramList::parameter

protected

Definition at line 251 of file vsteditcontroller.h.

◆ programInfos

ProgramInfoVector Steinberg::Vst::ProgramList::programInfos

protected

Definition at line 250 of file vsteditcontroller.h.

◆ programNames

StringVector Steinberg::Vst::ProgramList::programNames

protected

Definition at line 249 of file vsteditcontroller.h.

◆ unitId

UnitID Steinberg::Vst::ProgramList::unitId

protected

Definition at line 248 of file vsteditcontroller.h.

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

juce_audio_processors/format_types/VST3_SDK/public.sdk/source/vst/vsteditcontroller.h
juce_audio_processors/format_types/VST3_SDK/public.sdk/source/vst/vsteditcontroller.cpp

Public Member Functions

Protected Types

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ProgramInfoVector

◆ StringMap

◆ StringVector

Constructor & Destructor Documentation

◆ ProgramList() [1/2]

◆ ProgramList() [2/2]

Member Function Documentation

◆ addProgram()

◆ getCount()

◆ getID()

◆ getInfo()

◆ getName()

◆ getParameter()

◆ getPitchName()

◆ getProgramInfo()

◆ getProgramName()

◆ hasPitchNames()

◆ setProgramInfo()

◆ setProgramName()

Member Data Documentation

◆ info

◆ parameter

◆ programInfos

◆ programNames

◆ unitId