An interface to create and manage multiple options to use for a NodeValue. Once the list has been created the user will be able to select a specific option that will, in turn, be assigned to the variable maintained by the NodeValue.

See Also

Static Variables

Name	Description
`item_selection`	Active selection of the NodeList.
Declaration int item_selection
`item_count`	Current amount of NodeListItem stored in the NodeList.
Declaration unsigned char item_count

Functions

Name	Description
`AddItem`	Add a new item to the NodeList.
Declaration NodeListItem AddItem( const char name, const char value ) `name`: Option name to display. `value`: Internal value to use when selecting the option. Return Value* A new NodeListItem reference.
`GetItemAt`	Retrieve a specific NodeListItem from the active NodeList.
Declaration NodeListItem GetItemAt( const unsigned char item_index ) `item_index`: The item index of the NodeListItem to retrieve. Return Value* The NodeListItem reference located at the item index; `nil` if the item index does not exists.
`GetItemIndex`	Get the internal list item of a specific NodeListItem.
Declaration int GetItemIndex( const NodeListItem item ) `item`: A valid NodeListItem reference. Return Value* `-1` of the item is not found; else the function returns the internal index of the item.
`RemoveItem`	Remove a specific NodeListItem.
Declaration bool RemoveItem( const NodeListItem item ) `item`: The NodeListItem reference to remove. Return Value* `true` on success; `false` if the item is not managed by the active NodeList.
`RemoveItemAt`	Remove a specific NodeListItem using its index as key.
Declaration bool RemoveItemAt( const unsigned char item_index ) `item_index`: The NodeListItem index to remove. Return Value `true` on success; `false` if the index is out of bounds.
`SetItemSelection`	Set the item selection index.
Declaration void SetItemSelection( unsigned char item_selection ) `item_selection`: Index within the NodeList of the NodeBlock to retrieve. Remarks The item selection index is clamped to the maximum number of NodeListItem the NodeList contains.
`SetItemMask`	If the NodeList is a bit mask this helper will add or remove a specific cap bit to the `item_selection`.
Declaration void SetItemMask( int cap ) `cap`: The cap value to append or remove from the current `item_selection`.

NodeListItem

A single entry part of an existing NodeList.

Static Variables

Name	Description
`name`	Name of the entry.
Declaration char *name
`value`	Internal value to use when the entry is selected.
Declaration char *value