pongasoft::VST::GUI::Params::GUIRawVstParameter::Editor Class Reference

#include <GUIRawVstParameter.h>

Public Member Functions
tresult	commit ()
tresult	commit (ParamValue iValue)
	Editor (ParamID iParamID, VstParametersSPtr iVstParameters)
	Editor (Editor const &)=delete
Editor &	operator= (Editor const &)=delete
tresult	rollback ()
tresult	setValue (ParamValue iValue)
	~Editor ()

Private Attributes
ParamValue	fInitialParamValue
bool	fIsEditing
ParamID	fParamID
VstParametersSPtr	fVstParameters

Detailed Description

Wrapper to edit a single parameter. Usage:

// from a CView::onMouseDown callback fMyParamEditor = fParameter.edit(myParamID); fParamEditor->setValue(myValue);

// from a CView::onMouseMoved callback fParamEditor->setValue(myValue);

// from a CView::onMouseUp/onMouseCancelled callback fMyParamEditor->commit();

Constructor & Destructor Documentation

Editor() [1/2]

pongasoft::VST::GUI::Params::GUIRawVstParameter::Editor::Editor	(	ParamID	iParamID,
		VstParametersSPtr	iVstParameters
	)

Editor() [2/2]

pongasoft::VST::GUI::Params::GUIRawVstParameter::Editor::Editor ( Editor const &  )

delete

~Editor()

pongasoft::VST::GUI::Params::GUIRawVstParameter::Editor::~Editor ( )

inline

Destructor which calls rollback by default

Member Function Documentation

commit() [1/2]

tresult pongasoft::VST::GUI::Params::GUIRawVstParameter::Editor::commit

(

)

commit() [2/2]

tresult pongasoft::VST::GUI::Params::GUIRawVstParameter::Editor::commit ( ParamValue  iValue )

inline

operator=()

Editor& pongasoft::VST::GUI::Params::GUIRawVstParameter::Editor::operator= ( Editor const &  )

delete

rollback()

tresult pongasoft::VST::GUI::Params::GUIRawVstParameter::Editor::rollback

(

)

Call this if you want to revert to the original value of the parameter (when the editor is created). This has no effect if commit() has already been called

setValue()

tresult pongasoft::VST::GUI::Params::GUIRawVstParameter::Editor::setValue

(

ParamValue

iValue

)

Change the value of the parameter. Note that nothing happens if you have called commit or rollback already

Member Data Documentation

fInitialParamValue

ParamValue pongasoft::VST::GUI::Params::GUIRawVstParameter::Editor::fInitialParamValue

private

fIsEditing

bool pongasoft::VST::GUI::Params::GUIRawVstParameter::Editor::fIsEditing

private

fParamID

ParamID pongasoft::VST::GUI::Params::GUIRawVstParameter::Editor::fParamID

private

fVstParameters

VstParametersSPtr pongasoft::VST::GUI::Params::GUIRawVstParameter::Editor::fVstParameters

private

---

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

• pongasoft/VST/GUI/Params/GUIRawVstParameter.h
• pongasoft/VST/GUI/Params/GUIRawVstParameter.cpp