discoverpixy
Data Structures | Typedefs | Functions
NummericUpDown
Collaboration diagram for NummericUpDown:

Data Structures

struct  NUMUPDOWN_STRUCT
 

Typedefs

typedef void(* NUMUPDOWN_CALLBACK) (void *numupdown, int16_t value)
 

Functions

bool gui_numupdown_add (NUMUPDOWN_STRUCT *numupdown)
 
void gui_numupdown_remove (NUMUPDOWN_STRUCT *numupdown)
 
void gui_numupdown_update (NUMUPDOWN_STRUCT *numupdown)
 
void gui_numupdown_redraw (NUMUPDOWN_STRUCT *numupdown)
 

Detailed Description

The NummericUpDown Gui Element

Typedef Documentation

typedef void(* NUMUPDOWN_CALLBACK) (void *numupdown, int16_t value)

Prototype for Event Listeners (called when the NummericUpDown value has changed)

Note
You should NOT execute long running things in this callback nor should you update the gui. But you can call gui_screen_navigate() for instance.
Parameters
numupdownThe pointer to the NUMUPDOWN_STRUCT where to corresponding NummericUpDown has changed it's value
valueThe new value of the NummericUpDown

Function Documentation

bool gui_numupdown_add ( NUMUPDOWN_STRUCT numupdown)

Adds a NummericUpDown. Your Callback will be called from now on, if the numupdown's value changes

Parameters
numupdownA Pointer to the preinitialized NUMUPDOWN_STRUCT
Returns
true on success

Here is the call graph for this function:

Here is the caller graph for this function:

void gui_numupdown_redraw ( NUMUPDOWN_STRUCT numupdown)

Redraws the NummericUpDown. Call this method if you have to redraw the entire screen or if you want to draw a numupdown on top of an image.

Parameters
numupdownA Pointer to the NUMUPDOWN_STRUCT

Here is the call graph for this function:

void gui_numupdown_remove ( NUMUPDOWN_STRUCT numupdown)

Removes the NummericUpDown. You will no longer receive events for this numupdown. This function will not overdraw the region where the numupdown was located.

Parameters
numupdownA Pointer to the NUMUPDOWN_STRUCT

Here is the call graph for this function:

Here is the caller graph for this function:

void gui_numupdown_update ( NUMUPDOWN_STRUCT numupdown)

Updates the NummericUpDown. Call this function when you change the value/min/max of the numupdown through code.

Parameters
numupdownA Pointer to the NUMUPDOWN_STRUCT

Here is the call graph for this function:

Here is the caller graph for this function: