carb::dictionary::OnTreeChangeEventFn

Defined in carb/dictionary/IDictionary.h

using carb::dictionary::OnTreeChangeEventFn = void (*)(const Item *treeItem, const Item *changedItem, ChangeEventType eventType, void *userData)

A callback that, once registered with subscribeToTreeChangeEvents(), receives callbacks when Items change.

Note

The callbacks happen in the context of the thread performing the change. It is safe to call back into the IDictionary and unsubscribe or otherwise make changes. For ChangeEventType::eCreated and ChangeEventType::eChanged types, no internal locks are held; for ChangeEventType::eDestroyed internal locks are held which can cause thread-synchronization issues with locking order.

Param treeItem

The tree Item given to IDictionary::subscribeToTreeChangeEvents()

Param changedItem

The Item that is changing. May be treeItem or a descendant,

Param eventType

The event occurring on changedItem

Param userData

The user data given to IDictionary::subscribeToTreeChangeEvents()