ledger-secure-sdk/nbgl__flow_8h_source.html

 #ifndef NBGL_FLOW_H

 #define NBGL_FLOW_H


 #ifdef __cplusplus

 extern "C" {

 #endif


 /*********************

  *      INCLUDES

  *********************/


 #include "nbgl_step.h"

 #include "nbgl_obj.h"

 #include "nbgl_types.h"


 /*********************

  *      DEFINES

  *********************/


 /**********************

  *      TYPEDEFS

  **********************/

 typedef void *nbgl_flow_t;


 typedef void (*nbgl_stepCallback_t)(void);


 typedef struct nbgl_stepDesc_s {

     nbgl_stepCallback_t init;

     nbgl_stepCallback_t callback;

     const char         *text;

     const char         *subText;

     const nbgl_icon_details_t *icon;

 #ifdef HAVE_LANGUAGE_PACK

     UX_LOC_STRINGS_INDEX textId;

 #endif                            // HAVE_LANGUAGE_PACK

 } nbgl_stepDesc_t;


 typedef nbgl_stepDesc_t nbgl_pageContent_t;


 /**********************

  * GLOBAL PROTOTYPES

  **********************/


 nbgl_flow_t nbgl_flowDraw(const nbgl_stepDesc_t *steps,

                           uint8_t                nbSteps,

                           uint8_t                initStep,

                           bool                   loop,

                           bool                   modal);

 void        nbgl_flowRelease(nbgl_flow_t flow);


 /**********************

  *      MACROS

  **********************/


 #ifdef __cplusplus

 } /* extern "C" */

 #endif


 #endif /* NBGL_FLOW_H */

nbgl_stepCallback_t
void(* nbgl_stepCallback_t)(void)
prototype of function to be called when a step is using a callback on "double-key" action
Definition: nbgl_flow.h:38

nbgl_pageContent_t
nbgl_stepDesc_t nbgl_pageContent_t
Definition: nbgl_flow.h:54

nbgl_flowRelease
void nbgl_flowRelease(nbgl_flow_t flow)

nbgl_stepDesc_t
struct nbgl_stepDesc_s nbgl_stepDesc_t
Structure containing all specific information when creating a NBGL step.

nbgl_flow_t
void * nbgl_flow_t
type shared externally
Definition: nbgl_flow.h:33

nbgl_flowDraw
nbgl_flow_t nbgl_flowDraw(const nbgl_stepDesc_t *steps, uint8_t nbSteps, uint8_t initStep, bool loop, bool modal)

nbgl_obj.h
API to draw all basic graphic objects.

nbgl_step.h
Step construction API of NBGL.

nbgl_types.h
common types for Graphical Library

nbgl_icon_details_t
struct PACKED__ nbgl_icon_details_s nbgl_icon_details_t
Represents all information about an icon.

nbgl_stepDesc_s
Structure containing all specific information when creating a NBGL step.
Definition: nbgl_flow.h:43

nbgl_stepDesc_s::subText
const char * subText
sub-text to display in step (NULL most of the time)
Definition: nbgl_flow.h:47

nbgl_stepDesc_s::callback
nbgl_stepCallback_t callback
if not NULL, function to be called on "double-key" action
Definition: nbgl_flow.h:45

nbgl_stepDesc_s::icon
const nbgl_icon_details_t * icon
icon to display in step (text must be single-page)
Definition: nbgl_flow.h:48

nbgl_stepDesc_s::init
nbgl_stepCallback_t init
if not NULL, function to be called when the step is entered
Definition: nbgl_flow.h:44

nbgl_stepDesc_s::text
const char * text
text to display in step (can be multi-pages if icon == NULL)
Definition: nbgl_flow.h:46

uint8_t
unsigned char uint8_t
Definition: usbd_conf.h:53

UX_LOC_STRINGS_INDEX
BOLOS_UX_LOC_STRINGS UX_LOC_STRINGS_INDEX
Definition: ux_loc_layouts.h:25