LMMS
Loading...
Searching...
No Matches
Public Member Functions | Protected Types | Protected Attributes | List of all members
Steinberg::Vst::ProgramList Class Reference

#include <vsteditcontroller.h>

Inheritance diagram for Steinberg::Vst::ProgramList:
Steinberg::FObject Steinberg::IDependent Steinberg::FUnknown Steinberg::Vst::ProgramListWithPitchNames

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)
virtual bool setProgramInfo (int32 programIndex, CString attributeId, const String128 value)
virtual Parameter * getParameter ()
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 StringMap = std::map<String, String>
using StringVector = std::vector<String>
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 = 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

ProgramList element.

Member Typedef Documentation

◆ ProgramInfoVector

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

◆ StringMap

using Steinberg::Vst::ProgramList::StringMap = std::map<String, String>
protected

◆ StringVector

using Steinberg::Vst::ProgramList::StringVector = std::vector<String>
protected

Constructor & Destructor Documentation

◆ ProgramList() [1/2]

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

◆ ProgramList() [2/2]

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

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.

◆ getCount()

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

◆ getID()

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

◆ getInfo()

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

◆ getName()

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

◆ getParameter()

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

Creates and returns the program parameter.

◆ getPitchName()

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

Reimplemented in Steinberg::Vst::ProgramListWithPitchNames.

◆ getProgramInfo()

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

◆ getProgramName()

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

◆ hasPitchNames()

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

Reimplemented in Steinberg::Vst::ProgramListWithPitchNames.

◆ setProgramInfo()

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

Sets a program attribute value.

◆ setProgramName()

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

Member Data Documentation

◆ info

ProgramListInfo Steinberg::Vst::ProgramList::info
protected

◆ parameter

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

◆ programInfos

ProgramInfoVector Steinberg::Vst::ProgramList::programInfos
protected

◆ programNames

StringVector Steinberg::Vst::ProgramList::programNames
protected

◆ unitId

UnitID Steinberg::Vst::ProgramList::unitId
protected
The documentation for this class was generated from the following files:
Generated on for LMMS by doxygen 1.16.1