DefaultEditorImpl< T > Class Template Reference

Default implementation of the editor interface. More...

#include <IGUIParameter.h>

Inherits ITGUIParameter< T >::ITEditor.

Public Member Functions
tresult	commit () override
	Commits all the changes applied to the parameter.
	DefaultEditorImpl (ITGUIParameter< T > *iGUIParameter, T const &iDefaultValue)
tresult	rollback () override
	Rollback all the changes that were made to this parameter (since this editor was created).
tresult	setValue (T const &iValue) override
	Unconditionally sets the value of the parameter to the value provided.
bool	updateValue (T const &iValue) override
	First check if the value provided (iValue) is different from the current value and if that is the case then updates it to the new value.
	~DefaultEditorImpl () override
Public Member Functions inherited from ITGUIParameter< T >::ITEditor
virtual tresult	commit ()=0
	Importing other commit method from superclass.
virtual tresult	commit (ParamType const &iValue)
	Shortcut method which calls setValue(ParamType const &) followed by commit().
Public Member Functions inherited from IGUIParameter::Editor
virtual	~Editor ()=default
	Technically the destructor must only call rollback(), but due to the fact that it is a virtual method, it needs to be implemented by each subclass...

Private Attributes
bool	fDoneEditing {false}
ITGUIParameter< T > *	fGUIParameter
T	fInitialValue

Detailed Description

template<typename T>
class pongasoft::VST::GUI::Params::DefaultEditorImpl< T >

Default implementation of the editor interface.

Simply delegates the calls to the parameter while maintaining an initial value (for rollback()) and state (already completed).

Constructor & Destructor Documentation

DefaultEditorImpl()

template<typename T>

DefaultEditorImpl ( ITGUIParameter< T > * iGUIParameter, T const & iDefaultValue )

inlineexplicit

~DefaultEditorImpl()

template<typename T>

~DefaultEditorImpl ( )

inlineoverride

Member Function Documentation

commit()

template<typename T>

tresult commit ( )

inlineoverridevirtual

Commits all the changes applied to the parameter.

Note

If commit() or rollback() has already been called this method does nothing.

Implements IGUIParameter::Editor.

rollback()

template<typename T>

tresult rollback ( )

inlineoverridevirtual

Rollback all the changes that were made to this parameter (since this editor was created).

Note

If commit() or rollback() has already been called this method does nothing.

Implements IGUIParameter::Editor.

setValue()

template<typename T>

tresult setValue ( T const & iValue )

inlineoverridevirtual

Unconditionally sets the value of the parameter to the value provided.

Parameters

iValue

the value to set

Returns

kResultOk if successful

Implements ITGUIParameter< T >::ITEditor.

updateValue()

template<typename T>

bool updateValue ( T const & iValue )

inlineoverridevirtual

First check if the value provided (iValue) is different from the current value and if that is the case then updates it to the new value.

Note

If the type T does not provide a way to compare the value, then this call will delegate to setValue(ParamType const &) and return true.

Parameters

iValue

the value to update

Returns

true if the value was updated

Implements ITGUIParameter< T >::ITEditor.

Member Data Documentation

fDoneEditing

template<typename T>

bool fDoneEditing {false}

private

fGUIParameter

template<typename T>

ITGUIParameter<T>* fGUIParameter

private

fInitialValue

template<typename T>

T fInitialValue

private

---

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

• pongasoft/VST/GUI/Params/IGUIParameter.h