nbgl_layout_internal.h

Go to the documentation of this file.

 
#ifndef NBGL_LAYOUT_INTERNAL_H
#define NBGL_LAYOUT_INTERNAL_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "nbgl_layout.h"
 
/*********************
 *      INCLUDES
 *********************/
 
/*********************
 *      DEFINES
 *********************/
// internal margin, between sub-items
#define INTERNAL_MARGIN 8
 
#define SMALL_BUTTON_HEIGHT 64
 
#define LAYOUT_OBJ_POOL_LEN 16
 
#define KEYBOARD_FOOTER_TYPE 99
#define KEYPAD_FOOTER_TYPE   98
 
/**********************
 *      TYPEDEFS
 **********************/
typedef struct {
    nbgl_obj_t  *obj;
    uint8_t      token;   // user token, attached to callback
    uint8_t      index;   // index within the token
    tune_index_e tuneId;  // if not @ref NBGL_NO_TUNE, a tune will be played
} layoutObj_t;
 
typedef enum {
    SWIPE_USAGE_NAVIGATION,
    SWIPE_USAGE_CUSTOM,
    SWIPE_USAGE_SUGGESTIONS,  // for suggestion buttons
    NB_SWIPE_USAGE
} nbgl_swipe_usage_t;
 
// used by screen (top level)
enum {
    HEADER_INDEX = 0,  // For header container
    TOP_RIGHT_BUTTON_INDEX,
    MAIN_CONTAINER_INDEX,
    FOOTER_INDEX,
    UP_FOOTER_INDEX,
    LEFT_BORDER_INDEX,
    NB_MAX_SCREEN_CHILDREN
};
 
typedef struct nbgl_layoutInternal_s {
    bool modal;           
    bool withLeftBorder;  
    uint8_t layer;  
    uint8_t      nbChildren;  
    nbgl_obj_t **children;    
 
    uint8_t                   nbPages;       
    uint8_t                   activePage;    
    nbgl_layoutHeaderType_t   headerType;    
    nbgl_layoutFooterType_t   footerType;    
    nbgl_layoutUpFooterType_t upFooterType;  
    nbgl_container_t
        *headerContainer;  
    nbgl_container_t *footerContainer;    
    nbgl_container_t *upFooterContainer;  
    nbgl_text_area_t          *tapText;
    nbgl_layoutTouchCallback_t callback;  // user callback for all controls
    // This is the pool of callback objects, potentially used by this layout
    layoutObj_t callbackObjPool[LAYOUT_OBJ_POOL_LEN];
    // number of callback objects used by the whole layout in callbackObjPool
    uint8_t nbUsedCallbackObjs;
 
    nbgl_container_t  *container;
    nbgl_swipe_usage_t swipeUsage;
} nbgl_layoutInternal_t;
 
/**********************
 * GLOBAL PROTOTYPES
 **********************/
bool         keyboardSwipeCallback(nbgl_obj_t *obj, nbgl_touchType_t eventType);
void         layoutAddObject(nbgl_layoutInternal_t *layout, nbgl_obj_t *obj);
layoutObj_t *layoutAddCallbackObj(nbgl_layoutInternal_t *layout,
                                  nbgl_obj_t            *obj,
                                  uint8_t                token,
                                  tune_index_e           tuneId);
void         layoutNavigationPopulate(nbgl_container_t                 *navContainer,
                                      const nbgl_layoutNavigationBar_t *navConfig,
                                      uint8_t                           layer);
bool         layoutNavigationCallback(nbgl_obj_t      *obj,
                                      nbgl_touchType_t eventType,
                                      uint8_t          nbPages,
                                      uint8_t         *activePage);
 
/**********************
 *      MACROS
 **********************/
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* NBGL_LAYOUT_INTERNAL_H */