Steinberg::IUpdateHandler Class Reference

Host implements dependency handling for plugins. More...

#include "iupdatehandler.h"

Inheritance diagram for Steinberg::IUpdateHandler:

Public Member Functions
virtual tresult PLUGIN_API	addDependent (FUnknown *object, IDependent *dependent)=0
	Install update notification for given object.
virtual tresult PLUGIN_API	removeDependent (FUnknown *object, IDependent *dependent)=0
	Remove a previously installed dependency.
virtual tresult PLUGIN_API	triggerUpdates (FUnknown *object, int32 message)=0
	Inform all dependents, that object has changed.
virtual tresult PLUGIN_API	deferUpdates (FUnknown *object, int32 message)=0
	Same as triggerUpdates, but delivered in idle (usefull to collect updates).
Public Member Functions inherited from Steinberg::FUnknown
virtual tresult PLUGIN_API	queryInterface (const TUID _iid, void **obj)=0
	Query for a pointer to the specified interface.
virtual uint32 PLUGIN_API	addRef ()=0
	Adds a reference and returns the new reference count.
virtual uint32 PLUGIN_API	release ()=0
	Releases a reference and returns the new reference count.

Static Public Attributes
static const FUID	iid
Static Public Attributes inherited from Steinberg::FUnknown
static const FUID	iid

Detailed Description

Host implements dependency handling for plugins.

• [host imp]
• [get this interface from IHostClasses]
• [released N3.1]
• Install/Remove change notifications
• Trigger updates when an object has changed

Can be used between host-objects and the Plug-In or inside the Plug-In to handle internal updates!

See also

IDependent

Definition at line 40 of file iupdatehandler.h.

Member Function Documentation

addDependent()

virtual tresult PLUGIN_API Steinberg::IUpdateHandler::addDependent ( FUnknown *  object, IDependent *  dependent  )

pure virtual

Install update notification for given object.

It is essential to remove all dependencies again using 'removeDependent'! Dependencies are not removed automatically when the 'object' is released!

Parameters

object	: interface to object that sends change notifications
dependent	: interface through which the update is passed

Implemented in Steinberg::UpdateHandler.

deferUpdates()

virtual tresult PLUGIN_API Steinberg::IUpdateHandler::deferUpdates ( FUnknown *  object, int32  message  )

pure virtual

Same as triggerUpdates, but delivered in idle (usefull to collect updates).

Implemented in Steinberg::UpdateHandler.

removeDependent()

virtual tresult PLUGIN_API Steinberg::IUpdateHandler::removeDependent ( FUnknown *  object, IDependent *  dependent  )

pure virtual

Remove a previously installed dependency.

Implemented in Steinberg::UpdateHandler.

triggerUpdates()

virtual tresult PLUGIN_API Steinberg::IUpdateHandler::triggerUpdates ( FUnknown *  object, int32  message  )

pure virtual

Inform all dependents, that object has changed.

Parameters

object	is the object that has changed
message	is a value of enum IDependent::ChangeMessage, usually IDependent::kChanged - can be a private message as well (only known to sender and dependent)

Implemented in Steinberg::UpdateHandler.

Member Data Documentation

iid

const FUID Steinberg::IUpdateHandler::iid

static

Definition at line 62 of file iupdatehandler.h.

---

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

• juce_audio_processors/format_types/VST3_SDK/pluginterfaces/base/iupdatehandler.h