nbgl_step.h

Go to the documentation of this file.

 
#ifndef NBGL_STEP_H
#define NBGL_STEP_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*********************
 *      INCLUDES
 *********************/
 
#include "nbgl_layout.h"
#include "nbgl_obj.h"
#include "nbgl_types.h"
 
/*********************
 *      DEFINES
 *********************/
#define GET_POS_OF_STEP(_step, _nb_steps) \
    (_nb_steps < 2)                       \
        ? SINGLE_STEP                     \
        : ((_step == 0) ? FIRST_STEP      \
                        : ((_step == (_nb_steps - 1)) ? LAST_STEP : NEITHER_FIRST_NOR_LAST_STEP))
 
/**********************
 *      TYPEDEFS
 **********************/
 
typedef void *nbgl_step_t;
 
typedef void (*nbgl_stepMenuListCallback_t)(uint8_t choiceIndex);
 
typedef void (*nbgl_stepButtonCallback_t)(nbgl_step_t stepCtx, nbgl_buttonEvent_t event);
 
enum {
    SINGLE_STEP,                  
    FIRST_STEP,                   
    LAST_STEP,                    
    NEITHER_FIRST_NOR_LAST_STEP,  
};
 
#define FORWARD_DIRECTION      0x00
#define BACKWARD_DIRECTION     0x08
#define ACTION_ON_ANY_BUTTON   0x40
#define ACTION_ON_BOTH_BUTTONS 0x00
#define STEP_POSITION_MASK     0x03
 
typedef uint8_t nbgl_stepPosition_t;
 
/**********************
 * GLOBAL PROTOTYPES
 **********************/
 
nbgl_step_t nbgl_stepDrawText(nbgl_stepPosition_t               pos,
                              nbgl_stepButtonCallback_t         onActionCallback,
                              nbgl_screenTickerConfiguration_t *ticker,
                              const char                       *text,
                              const char                       *subText,
                              nbgl_contentCenteredInfoStyle_t   style,
                              bool                              modal);
nbgl_step_t nbgl_stepDrawCenteredInfo(nbgl_stepPosition_t               pos,
                                      nbgl_stepButtonCallback_t         onActionCallback,
                                      nbgl_screenTickerConfiguration_t *ticker,
                                      nbgl_layoutCenteredInfo_t        *info,
                                      bool                              modal);
nbgl_step_t nbgl_stepDrawMenuList(nbgl_stepMenuListCallback_t       onActionCallback,
                                  nbgl_screenTickerConfiguration_t *ticker,
                                  nbgl_layoutMenuList_t            *list,
                                  bool                              modal);
uint8_t     nbgl_stepGetMenuListCurrent(nbgl_step_t step);
nbgl_step_t nbgl_stepDrawSwitch(nbgl_stepPosition_t               pos,
                                nbgl_stepButtonCallback_t         onActionCallback,
                                nbgl_screenTickerConfiguration_t *ticker,
                                nbgl_layoutSwitch_t              *switchInfo,
                                bool                              modal);
int         nbgl_stepRelease(nbgl_step_t step);
 
/**********************
 *      MACROS
 **********************/
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* NBGL_STEP_H */