nf_hist

Types

Name

Description

editor

rendered_action

A reasonably user‐friendly rendering of an action

simple_tracked

simple_tracked

tracked

The parent class for your tracked type, stores your source data class, provides const ref access to it, and capabilities to make tracked changes to all members/sub‐elements, as well as the ability to undo/redo, traverse and manage history

tracked

The parent class for your tracked type, stores your source data class, provides const ref access to it, and capabilities to make tracked changes to all members/sub‐elements, as well as the ability to undo/redo, traverse and manage history

tracked_element

Extended to provide mutable/returnable tracked sub‐elements from your source data

make_path

Used to create a path to some element within the source data class, typically used for creating notification methods or tracked sub‐elements e.g. using my_path = nf::make_path<decltype(root‐>my_collection[0].my_field)>; or... using my_path = NF_PATH(root‐>my_collection[0].my_field);

Enums

Functions

Variables

Name

Description

attach_data

Optional annotation specifying that a collection of the supplied type should be maintained as a parallel array to the type annotated e.g. NOTE(my_units, nf::attach_data<my_graphics>) std::vector<my_unit> my_units;

index_size

Optional annotation used to specify the index size type used in serialized history, specifying an index size smaller than std::size_t reduces history size, appropriate when there's a known limit to a given containers size e.g. NOTE(my_vec, nf::index_size<uint16_t>) std::vector<int> my_vec;

Created with MrDocs