Jamba C++ API  4.0.0
IGUIParameter::Editor Class Referenceabstract

Defines the basic and common API of all parameter editors (allow to commit/rollback) More...

#include <IGUIParameter.h>

Inherited by ITGUIParameter< T >::ITEditor.

Public Member Functions

virtual tresult commit ()=0
 Commits all the changes applied to the parameter. More...
 
virtual tresult rollback ()=0
 Rollback all the changes that were made to this parameter (since this editor was created). More...
 
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... More...
 

Detailed Description

Defines the basic and common API of all parameter editors (allow to commit/rollback)

Constructor & Destructor Documentation

◆ ~Editor()

virtual ~Editor ( )
virtualdefault

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...

Member Function Documentation

◆ commit()

virtual tresult commit ( )
pure virtual

Commits all the changes applied to the parameter.

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

Implemented in DefaultEditorImpl< T >.

◆ rollback()

virtual tresult rollback ( )
pure virtual

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.

Implemented in DefaultEditorImpl< T >.


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