Public Member Functions | List of all members
ComboBoxParameterAttachment Class Reference

An object of this class maintains a connection between a ComboBox and a plug-in parameter. More...

Inheritance diagram for ComboBoxParameterAttachment:

Public Member Functions

 ComboBoxParameterAttachment (RangedAudioParameter &parameter, ComboBox &combo, UndoManager *undoManager=nullptr)
 Creates a connection between a plug-in parameter and a ComboBox. More...
 
 ~ComboBoxParameterAttachment () override
 Destructor. More...
 
void sendInitialUpdate ()
 Call this after setting up your combo box in the case where you need to do extra setup after constructing this attachment. More...
 

Detailed Description

An object of this class maintains a connection between a ComboBox and a plug-in parameter.

ComboBox items will be spaced linearly across the range of the parameter. For example if the range is specified by NormalisableRange<float> (-0.5f, 0.5f, 0.5f) and you add three items then the first will be mapped to a value of -0.5, the second to 0, and the third to 0.5.

During the lifetime of this object it keeps the two things in sync, making it easy to connect a combo box to a parameter. When this object is deleted, the connection is broken. Make sure that your parameter and ComboBox are not deleted before this object!

Constructor & Destructor Documentation

◆ ComboBoxParameterAttachment()

ComboBoxParameterAttachment::ComboBoxParameterAttachment ( RangedAudioParameter parameter,
ComboBox combo,
UndoManager undoManager = nullptr 
)

Creates a connection between a plug-in parameter and a ComboBox.

Parameters
parameterThe parameter to use
comboThe ComboBox to use
undoManagerAn optional UndoManager

◆ ~ComboBoxParameterAttachment()

ComboBoxParameterAttachment::~ComboBoxParameterAttachment ( )
override

Destructor.

Member Function Documentation

◆ sendInitialUpdate()

void ComboBoxParameterAttachment::sendInitialUpdate ( )

Call this after setting up your combo box in the case where you need to do extra setup after constructing this attachment.


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