ChangeEventType#

Fully qualified name: carb::dictionary::ChangeEventType

Defined in carb/dictionary/IDictionary.h

enum class carb::dictionary::ChangeEventType#

Type of a change passed to a subscription callback.

A change callback can be queued for a lot of different dictionary operations, basically anything that is not a ‘get’ type operation. Multiple callbacks can be queued for what seems like a single operation on a dictionary as well. For example, creating and setting an item’s value in an IDictionary::make*AtPath() can both create an item and modify its value. Operations such as IDictionary::update() can also trigger a lot of change notifications since it can create, modify, and delete items a lot of items in a dictionary.

See also

IDictionary::subscribeToNodeChangeEvents(), IDictionary::subscribeToTreeChangeEvents(), OnNodeChangeEventFn, OnTreeChangeEventFn.

Values:

enumerator eCreated#

A new item was created under the dictionary.

This may also be accompanied by an eChanged event if an initial value is also set for the new item through an operation such as IDictionary::makeIntAtPath(). This type of callback will be performed after the new item is created.

enumerator eChanged#

The value or type of an existing item in the dictionary has changed.

This can be triggered by operations such as IDictionary::set*() that can modify both the item’s type and value, or by operations such as IDictionary::createItem() which can potentially change an item’s type if one already exists at the given path. This type of callback will be performed after the new value has been set in the item.

enumerator eDestroyed#

An item was destroyed in the dictionary.

This can be triggered by explicit calls to IDictionary::destroyItem() or by operations that could implicitly delete an item’s subtree such as IDictionary::update() or IDictionary::set*(). This type of callback will be performed just before the given item is destroyed.