JUCE-7.0.12-0-g4f43011b96 JUCE-7.0.12-0-g4f43011b96
JUCE — C++ application framework with suport for VST, VST3, LV2 audio plug-ins

« « « Anklang Documentation
Loading...
Searching...
No Matches
Public Member Functions | Protected Types | Protected Attributes | List of all members
Steinberg::Vst::ProgramListWithPitchNames Class Reference

ProgramListWithPitchNames element. More...

#include "vsteditcontroller.h"

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

Public Member Functions

 ProgramListWithPitchNames (const String128 name, ProgramListID listId, UnitID unitId)
 
bool setPitchName (int32 programIndex, int16 pitch, const String128 pitchName)
 Sets a name for the given program index and a given pitch.
 
bool removePitchName (int32 programIndex, int16 pitch)
 Removes the PitchName entry for the given program index and a given pitch.
 
int32 addProgram (const String128 name) SMTG_OVERRIDE
 Adds a program to the end of the list.
 
tresult hasPitchNames (int32 programIndex) SMTG_OVERRIDE
 
tresult getPitchName (int32 programIndex, int16 midiPitch, String128 name) SMTG_OVERRIDE
 
- Public Member Functions inherited from Steinberg::Vst::ProgramList
 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 bool setProgramInfo (int32 programIndex, CString attributeId, const String128 value)
 Sets a program attribute value.
 
virtual ParametergetParameter ()
 Creates and returns the program parameter.
 
- Public Member Functions inherited from Steinberg::FObject
 FObject ()=default
 default constructor...
 
 FObject (const FObject &)
 
FObjectoperator= (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
 
FUnknownunknownCast ()
 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 PitchNameMap = std::map< int16, std::u16string >
 
using PitchNamesVector = std::vector< PitchNameMap >
 
- Protected Types inherited from Steinberg::Vst::ProgramList
using StringMap = std::map< std::string, std::u16string >
 
using StringVector = std::vector< std::u16string >
 
using ProgramInfoVector = std::vector< StringMap >
 

Protected Attributes

PitchNamesVector pitchNames
 
- Protected Attributes inherited from Steinberg::Vst::ProgramList
ProgramListInfo info
 
UnitID unitId
 
StringVector programNames
 
ProgramInfoVector programInfos
 
Parameterparameter
 
- 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 IUpdateHandlergetUpdateHandler ()
 get method for the local attribute
 
static bool classIDsEqual (FClassID ci1, FClassID ci2)
 compares (evaluates) 2 class IDs
 
static FObjectunknownToObject (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 IUpdateHandlergUpdateHandler
 

Detailed Description

ProgramListWithPitchNames element.

Definition at line 258 of file vsteditcontroller.h.

Member Typedef Documentation

◆ PitchNameMap

Definition at line 278 of file vsteditcontroller.h.

◆ PitchNamesVector

Definition at line 279 of file vsteditcontroller.h.

Constructor & Destructor Documentation

◆ ProgramListWithPitchNames()

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

Definition at line 623 of file vsteditcontroller.cpp.

Member Function Documentation

◆ addProgram()

int32 Steinberg::Vst::ProgramListWithPitchNames::addProgram ( const String128  name)
virtual

Adds a program to the end of the list.

returns the index of the program.

Reimplemented from Steinberg::Vst::ProgramList.

Definition at line 630 of file vsteditcontroller.cpp.

◆ getPitchName()

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

Reimplemented from Steinberg::Vst::ProgramList.

Definition at line 683 of file vsteditcontroller.cpp.

◆ hasPitchNames()

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

Reimplemented from Steinberg::Vst::ProgramList.

Definition at line 675 of file vsteditcontroller.cpp.

◆ removePitchName()

bool Steinberg::Vst::ProgramListWithPitchNames::removePitchName ( int32  programIndex,
int16  pitch 
)

Removes the PitchName entry for the given program index and a given pitch.

Returns true if it was found and removed.

Definition at line 662 of file vsteditcontroller.cpp.

◆ setPitchName()

bool Steinberg::Vst::ProgramListWithPitchNames::setPitchName ( int32  programIndex,
int16  pitch,
const String128  pitchName 
)

Sets a name for the given program index and a given pitch.

Definition at line 639 of file vsteditcontroller.cpp.

Member Data Documentation

◆ pitchNames

PitchNamesVector Steinberg::Vst::ProgramListWithPitchNames::pitchNames
protected

Definition at line 280 of file vsteditcontroller.h.


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