Jamba C++ API  5.1.1
GUIParamCx Class Reference

Wrapper class which maintains the connection between a parameter and its listener. More...

#include <GUIParamCx.h>

Inherits FObjectCx.

Public Member Functions

void close () override
 Call to stop listening for changes. More...
 
 GUIParamCx (ParamID iParamID, FObject *iParameter, Parameters::IChangeListener *iChangeListener)
 
 GUIParamCx (GUIParamCx const &)=delete
 
void onTargetChange () override
 Called when the target changes (by default does nothing) More...
 
GUIParamCxoperator= (GUIParamCx const &)=delete
 
- Public Member Functions inherited from FObjectCx
 FObjectCx (FObject *iTarget)
 
 FObjectCx (FObjectCx const &)=delete
 
FObjectCxoperator= (FObjectCx const &)=delete
 
 ~FObjectCx () override
 Automatically closes the connection and stops listening. More...
 

Protected Attributes

Parameters::IChangeListenerfChangeListener
 
ParamID fParamID
 
- Protected Attributes inherited from FObjectCx
bool fIsConnected
 
FObject * fTarget
 

Additional Inherited Members

- Protected Member Functions inherited from FObjectCx
void PLUGIN_API update (FUnknown *iChangedUnknown, Steinberg::int32 iMessage) SMTG_OVERRIDE
 This is being called when fTarget sends a message to this object. More...
 

Detailed Description

Wrapper class which maintains the connection between a parameter and its listener.

The connection will be terminated if close() is called or automatically when the destructor is called.

Constructor & Destructor Documentation

◆ GUIParamCx() [1/2]

GUIParamCx ( ParamID  iParamID,
FObject *  iParameter,
Parameters::IChangeListener iChangeListener 
)

◆ GUIParamCx() [2/2]

GUIParamCx ( GUIParamCx const &  )
delete

Member Function Documentation

◆ close()

void close ( )
overridevirtual

Call to stop listening for changes.

Also called automatically from the destructor.

Reimplemented from FObjectCx.

◆ onTargetChange()

void onTargetChange ( )
overridevirtual

Called when the target changes (by default does nothing)

Reimplemented from FObjectCx.

◆ operator=()

GUIParamCx& operator= ( GUIParamCx const &  )
delete

Member Data Documentation

◆ fChangeListener

Parameters::IChangeListener* fChangeListener
protected

◆ fParamID

ParamID fParamID
protected

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