NvUIReaction Struct Reference

A structure holding some 'reaction' to a given user input event. More...

#include <NvUI.h>

List of all members.

Public Attributes

uint32_t uid
 This is the NvUIElement.uiuid member of the element 'raising' the reaction.
uint32_t code
 This is the app/element specific 'reaction code'.
uint32_t state
 This is other reaction state, generally used for visual widgets like buttons to track or pass current draw state.
NvGestureKind::Enum causeKind
 Copying the 'cause' of the reaction.
uint8_t causeIndex
 For input-related reactions, this could be mouse button, gamepad button, or key identifier.
NvReactFlag::Enum flags
 Any particular extra flags about this reaction.
float fval
 This is a floating point value from data-related widgets.
uint32_t ival
 This is an integer value from data-related widgets.

Detailed Description

A structure holding some 'reaction' to a given user input event.

When a UI element handles an input event, it might have a side-effect it wants to occur (an NvUIReaction) in the UI hierarchy/system. This simple structure allows for noting who kicked off the reaction, the 'type' of Reaction (that is usually a unique identifier code), and any secondary state that might be useful to the future-handling element.

Member Data Documentation

uint8_t NvUIReaction::causeIndex

For input-related reactions, this could be mouse button, gamepad button, or key identifier.

NvGestureKind::Enum NvUIReaction::causeKind

Copying the 'cause' of the reaction.

If kind is none, it's not input/gesture related.

uint32_t NvUIReaction::code

This is the app/element specific 'reaction code'.

NvReactFlag::Enum NvUIReaction::flags

Any particular extra flags about this reaction.

float NvUIReaction::fval

This is a floating point value from data-related widgets.

uint32_t NvUIReaction::ival

This is an integer value from data-related widgets.

uint32_t NvUIReaction::state

This is other reaction state, generally used for visual widgets like buttons to track or pass current draw state.

uint32_t NvUIReaction::uid

This is the NvUIElement.uiuid member of the element 'raising' the reaction.

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