TuttleOFX  1
tuttle::host::ofx::property::OfxhNotifyHook Class Reference

#include <OfxhNotifyHook.hpp>

Inheritance diagram for tuttle::host::ofx::property::OfxhNotifyHook:

Public Member Functions

virtual ~OfxhNotifyHook ()
 dtor
virtual void notify (const std::string &name, bool singleValue, int indexOrN) OFX_EXCEPTION_SPEC=0

Detailed Description

Sits on a property and is called when the local property is being set. It notify or notifyN is called whenever the plugin sets a property Many of these can sit on a property, as various objects will need to know when a property has been changed. On notification you should fetch properties with a 'raw' call, rather than the standard calls, as you may be fetching through a getHook and you won't see the local value that has been shoved into the property.

Definition at line 18 of file OfxhNotifyHook.hpp.


Constructor & Destructor Documentation

virtual tuttle::host::ofx::property::OfxhNotifyHook::~OfxhNotifyHook ( ) [inline, virtual]

dtor

Definition at line 22 of file OfxhNotifyHook.hpp.


Member Function Documentation

virtual void tuttle::host::ofx::property::OfxhNotifyHook::notify ( const std::string &  name,
bool  singleValue,
int  indexOrN 
) [pure virtual]

override this to be notified when a property changes

  • name is the name of the property just set
  • singleValue is whether setProperty on a single index was call, otherwise N properties were set
  • indexOrN is the index if single value is true, or the count if singleValue is false

Implemented in tuttle::host::ofx::attribute::OfxhParam, tuttle::host::ofx::imageEffect::OfxhImageEffectNode, and tuttle::host::ofx::attribute::OfxhClip.


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