#include <vstparameters.h>

Inheritance diagram for Steinberg::Vst::StringListParameter:

Public Member Functions
	StringListParameter (const ParameterInfo &paramInfo)
	StringListParameter (const TChar title, ParamID tag, const TChar units=nullptr, int32 flags=ParameterInfo::kCanAutomate\|ParameterInfo::kIsList, UnitID unitID=kRootUnitId, const TChar *shortTitle=nullptr)
	~StringListParameter () override
virtual void	appendString (const String128 string)
virtual bool	replaceString (int32 index, const String128 string)
void	toString (ParamValue _valueNormalized, String128 string) const SMTG_OVERRIDE
bool	fromString (const TChar *string, ParamValue &_valueNormalized) const SMTG_OVERRIDE
ParamValue	toPlain (ParamValue _valueNormalized) const SMTG_OVERRIDE
ParamValue	toNormalized (ParamValue plainValue) const SMTG_OVERRIDE
Public Member Functions inherited from Steinberg::Vst::Parameter
	Parameter ()
	Parameter (const ParameterInfo &)
	Parameter (const TChar title, ParamID tag, const TChar units=nullptr, ParamValue defaultValueNormalized=0., int32 stepCount=0, int32 flags=ParameterInfo::kCanAutomate, UnitID unitID=kRootUnitId, const TChar *shortTitle=nullptr)
	~Parameter () override
virtual const ParameterInfo &	getInfo () const
virtual ParameterInfo &	getInfo ()
virtual void	setUnitID (UnitID id)
virtual UnitID	getUnitID ()
ParamValue	getNormalized () const
virtual bool	setNormalized (ParamValue v)
virtual int32	getPrecision () const
virtual void	setPrecision (int32 val)
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 Types
using	StringVector = std::vector<TChar*>

Protected Attributes
StringVector	strings
Protected Attributes inherited from Steinberg::Vst::Parameter
ParameterInfo	info
ParamValue	valueNormalized
int32	precision
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

Description of a StringListParameter.

Member Typedef Documentation

◆ StringVector

using Steinberg::Vst::StringListParameter::StringVector = std::vector<TChar*>

protected

Constructor & Destructor Documentation

◆ StringListParameter() [1/2]

Steinberg::Vst::StringListParameter::StringListParameter ( const ParameterInfo & paramInfo )

◆ StringListParameter() [2/2]

Steinberg::Vst::StringListParameter::StringListParameter	(	const TChar *	title,
		ParamID	tag,
		const TChar *	units = nullptr,
		int32	flags = ParameterInfo::kCanAutomate \| ParameterInfo::kIsList,
		UnitID	unitID = kRootUnitId,
		const TChar *	shortTitle = nullptr )

◆ ~StringListParameter()

Steinberg::Vst::StringListParameter::~StringListParameter ( )

override

Member Function Documentation

◆ appendString()

void Steinberg::Vst::StringListParameter::appendString ( const String128 string )

virtual

Appends a string and increases the stepCount.

◆ fromString()

bool Steinberg::Vst::StringListParameter::fromString	(	const TChar *	string,
		ParamValue &	_valueNormalized ) const

virtual

Converts a string to a normalized value.

Reimplemented from Steinberg::Vst::Parameter.

◆ replaceString()

bool Steinberg::Vst::StringListParameter::replaceString	(	int32	index,
		const String128	string )

virtual

Replaces the string at index. Index must be between 0 and stepCount+1

◆ toNormalized()

ParamValue Steinberg::Vst::StringListParameter::toNormalized ( ParamValue plainValue ) const

virtual

Converts a plain value to a normalized value (e.g. 10000 to 0.5).

Reimplemented from Steinberg::Vst::Parameter.

◆ toPlain()

ParamValue Steinberg::Vst::StringListParameter::toPlain ( ParamValue _valueNormalized ) const

virtual

Converts a normalized value to plain value (e.g. 0.5 to 10000.0Hz).

Reimplemented from Steinberg::Vst::Parameter.

◆ toString()

void Steinberg::Vst::StringListParameter::toString	(	ParamValue	_valueNormalized,
		String128	string ) const

virtual

Converts a normalized value to a string.

Reimplemented from Steinberg::Vst::Parameter.

Member Data Documentation

◆ strings

StringVector Steinberg::Vst::StringListParameter::strings

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/vstparameters.h
/home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/includes/vst3sdk/public.sdk/source/vst/vstparameters.cpp

Public Member Functions

Protected Types

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ StringVector

Constructor & Destructor Documentation

◆ StringListParameter() [1/2]

◆ StringListParameter() [2/2]

◆ ~StringListParameter()

Member Function Documentation

◆ appendString()

◆ fromString()

◆ replaceString()

◆ toNormalized()

◆ toPlain()

◆ toString()

Member Data Documentation

◆ strings