VST 3 SDK VST 3.7
SDK for developing VST plug-in
Loading...
Searching...
No Matches
ProgramList Class Reference

ProgramList element. More...

#include <vsteditcontroller.h>

+ Inheritance diagram for ProgramList:

Public Types

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

Public Member Functions

 ProgramList (const String128 name, ProgramListID listId, UnitID unitId)
 
 ProgramList (const ProgramList &programList)
 
const ProgramListInfogetInfo () const
 
ProgramListID getID () const
 
const TChargetName () 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 ParametergetParameter ()
 Creates and returns the program parameter.
 
virtual void clearPrograms ()
 Clear all programs.
 

Public Attributes

ProgramListInfo info {}
 
UnitID unitId
 
StringVector programNames
 
ProgramInfoVector programInfos
 
Parameterparameter {nullptr}
 

Detailed Description

ProgramList element.

Member Typedef Documentation

◆ StringVector

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

◆ ProgramInfoVector

using ProgramInfoVector = std::vector<StringMap>

Constructor & Destructor Documentation

◆ ProgramList() [1/2]

ProgramList ( const String128 name,
ProgramListID listId,
UnitID unitId )

◆ ProgramList() [2/2]

ProgramList ( const ProgramList & programList)

Member Function Documentation

◆ getInfo()

const ProgramListInfo & getInfo ( ) const
inline

◆ getID()

ProgramListID getID ( ) const
inline

◆ getName()

const TChar * getName ( ) const
inline

◆ getCount()

int32 getCount ( ) const
inline

◆ getProgramName()

tresult getProgramName ( int32 programIndex,
String128 name )
virtual

◆ setProgramName()

tresult setProgramName ( int32 programIndex,
const String128 name )
virtual

◆ getProgramInfo()

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

◆ hasPitchNames()

virtual tresult hasPitchNames ( int32 programIndex)
inlinevirtual

Reimplemented in ProgramListWithPitchNames.

◆ getPitchName()

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

Reimplemented in ProgramListWithPitchNames.

◆ addProgram()

int32 addProgram ( const String128 name)
virtual

Adds a program to the end of the list.

returns the index of the program.

Reimplemented in ProgramListWithPitchNames.

◆ setProgramInfo()

bool setProgramInfo ( int32 programIndex,
CString attributeId,
const String128 value )
virtual

Sets a program attribute value.

◆ getParameter()

Parameter * getParameter ( )
virtual

Creates and returns the program parameter.

◆ clearPrograms()

void clearPrograms ( )
virtual

Clear all programs.

Member Data Documentation

◆ info

ProgramListInfo info {}

◆ unitId

UnitID unitId

◆ programNames

StringVector programNames

◆ programInfos

ProgramInfoVector programInfos

◆ parameter

Parameter* parameter {nullptr}
Empty

Copyright © Steinberg Media Technologies GmbH. All Rights Reserved. This documentation is under this license.