nbgl_obj.h

Go to the documentation of this file.

 
#ifndef NBGL_OBJ_H
#define NBGL_OBJ_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "nbgl_types.h"
#include "nbgl_fonts.h"
#include "nbgl_icons.h"
#include "ux_loc.h"
 
/*********************
 *      INCLUDES
 *********************/
 
/*********************
 *      DEFINES
 *********************/
// Keypad special key values
#define BACKSPACE_KEY 8
#define VALIDATE_KEY  '\r'
 
// for Keyboard
#ifdef NBGL_KEYBOARD
#ifdef SCREEN_SIZE_WALLET
#if defined(TARGET_STAX)
#define KEYBOARD_KEY_HEIGHT 60
#elif defined(TARGET_FLEX)
#define KEYBOARD_KEY_HEIGHT 72
#elif defined(TARGET_APEX)
#define KEYBOARD_KEY_HEIGHT 51
#endif  // TARGETS
 
// index of keys for keyMask field of nbgl_keyboard_t
#define SHIFT_KEY_INDEX         26
#define DIGITS_SWITCH_KEY_INDEX 27
#define BACKSPACE_KEY_INDEX     28
#define SPACE_KEY_INDEX         29
#define SPECIAL_KEYS_INDEX      30
 
#else  // SCREEN_SIZE_WALLET
#define KEYBOARD_KEY_WIDTH  14
#define KEYBOARD_KEY_HEIGHT 14
#define KEYBOARD_WIDTH      (5 * KEYBOARD_KEY_WIDTH)
 
#define BACKSPACE_KEY_INDEX 26
#define VALIDATE_INDEX      27
#define SHIFT_KEY_INDEX     28
#define KEYBOARD_MAX_TITLE  20
#endif  // SCREEN_SIZE_WALLET
#endif  // NBGL_KEYBOARD
 
// for Keypad
#ifdef SCREEN_SIZE_WALLET
#if defined(TARGET_STAX)
#define KEYPAD_KEY_HEIGHT 104
#elif defined(TARGET_FLEX)
#define KEYPAD_KEY_HEIGHT 88
#elif defined(TARGET_APEX)
#define KEYPAD_KEY_HEIGHT 60
#endif  // TARGETS
#else   // SCREEN_SIZE_WALLET
#define KEYPAD_WIDTH  114
#define KEYPAD_HEIGHT 18
#endif  // SCREEN_SIZE_WALLET
#define KEYPAD_MAX_DIGITS 12
 
#ifdef SCREEN_SIZE_WALLET
// external margin in pixels
#if defined(TARGET_STAX)
#define BORDER_MARGIN          24
#define VERTICAL_BORDER_MARGIN 24
#elif defined(TARGET_FLEX)
#define BORDER_MARGIN          32
#define VERTICAL_BORDER_MARGIN 24
#elif defined(TARGET_APEX)
#define BORDER_MARGIN          16
#define VERTICAL_BORDER_MARGIN 24
#endif  // TARGETS
 
// Back button header height
#if defined(TARGET_STAX)
#define BACK_BUTTON_HEADER_HEIGHT 88
#elif defined(TARGET_FLEX)
#define BACK_BUTTON_HEADER_HEIGHT 96
#elif defined(TARGET_APEX)
#define BACK_BUTTON_HEADER_HEIGHT 60
#endif  // TARGETS
 
// common dimensions for buttons
#if COMMON_RADIUS == 40
#define BUTTON_RADIUS RADIUS_40_PIXELS
#elif COMMON_RADIUS == 44
#define BUTTON_RADIUS RADIUS_44_PIXELS
#elif COMMON_RADIUS == 28
#define BUTTON_RADIUS RADIUS_28_PIXELS
#endif  // COMMON_RADIUS
#define BUTTON_DIAMETER (COMMON_RADIUS * 2)
// on Apex, "round" buttons are not exactly round
#if defined(TARGET_APEX)
#define BUTTON_WIDTH (BUTTON_DIAMETER - 2)
#else
#define BUTTON_WIDTH BUTTON_DIAMETER
#endif
 
// width & height for spinner
#if defined(TARGET_STAX)
#define SPINNER_WIDTH  60
#define SPINNER_HEIGHT 44
#elif defined(TARGET_FLEX)
#define SPINNER_WIDTH  64
#define SPINNER_HEIGHT 48
#elif defined(TARGET_APEX)
#define SPINNER_WIDTH  40
#define SPINNER_HEIGHT 32
#endif  // TARGETS
 
// width for indicator
#if defined(TARGET_STAX)
#define STEPPER_2_PAGES_WIDTH 136
#define STEPPER_N_PAGES_WIDTH 184
#elif defined(TARGET_FLEX)
#define STEPPER_2_PAGES_WIDTH 136
#define STEPPER_N_PAGES_WIDTH 184
#elif defined(TARGET_APEX)
#define STEPPER_2_PAGES_WIDTH 108
#define STEPPER_N_PAGES_WIDTH 104
#endif  // TARGETS
 
// width & height for radio button
#if defined(TARGET_STAX)
#define RADIO_WIDTH  32
#define RADIO_HEIGHT 32
#elif defined(TARGET_FLEX)
#define RADIO_WIDTH  40
#define RADIO_HEIGHT 40
#elif defined(TARGET_APEX)
#define RADIO_WIDTH  24
#define RADIO_HEIGHT 24
#endif  // TARGETS
 
// Icon defines are in nbgl_icons.h (included above)
 
// max number of pages when nbgl_page_indicator_t uses dashes (above, it uses n / nb_pages)
#define NB_MAX_PAGES_WITH_DASHES 6
 
// number of spinner positions
#define NB_SPINNER_POSITIONS 4
#endif  // SCREEN_SIZE_WALLET
 
#if NB_COLOR_BITS == 1
#define INACTIVE_COLOR       WHITE
#define INACTIVE_TEXT_COLOR  BLACK
#define INACTIVE_ARROW_COLOR WHITE
#define INACTIVE_SMALL_FONT  SMALL_REGULAR_FONT
#define LIGHT_TEXT_COLOR     BLACK
#define BUTTON_STROKE        1
#else
#define INACTIVE_COLOR       LIGHT_GRAY
#define INACTIVE_TEXT_COLOR  LIGHT_GRAY
#define INACTIVE_ARROW_COLOR LIGHT_GRAY
#define INACTIVE_SMALL_FONT  SMALL_BOLD_FONT
#define LIGHT_TEXT_COLOR     DARK_GRAY
#define BUTTON_STROKE        2
#endif
 
#define KEYPAD_REINIT_KEYS 0x1F
 
/**********************
 *      TYPEDEFS
 **********************/
 
#define SWIPE_MASK \
    ((1 << SWIPED_UP) | (1 << SWIPED_DOWN) | (1 << SWIPED_LEFT) | (1 << SWIPED_RIGHT))
 
#define LEFT_BUTTON     0x01  
#define RIGHT_BUTTON    0x02  
#define BOTH_BUTTONS    0x03  
#define RELEASED_MASK   0x80  
#define CONTINUOUS_MASK 0x40  
 
typedef enum {
    BUTTON_LEFT_PRESSED = 0,          
    BUTTON_RIGHT_PRESSED,             
    BUTTON_LEFT_CONTINUOUS_PRESSED,   
    BUTTON_RIGHT_CONTINUOUS_PRESSED,  
    BUTTON_BOTH_PRESSED,              
    BUTTON_BOTH_TOUCHED,              
    INVALID_BUTTON_EVENT
} nbgl_buttonEvent_t;
 
typedef void (*nbgl_buttonCallback_t)(void *obj, nbgl_buttonEvent_t buttonEvent);
 
typedef struct {
    nbgl_touchState_t state;  
#ifdef HAVE_HW_TOUCH_SWIPE
    nbgl_hardwareSwipe_t swipe;  
#endif                           // HAVE_HW_TOUCH_SWIPE
    int16_t
        x;  
    int16_t y;  
} nbgl_touchStatePosition_t;
 
typedef void (*nbgl_touchCallback_t)(void *obj, nbgl_touchType_t eventType);
 
typedef struct PACKED__ nbgl_obj_s {
    nbgl_area_t area;  
    nbgl_obj_type_t    type;              
    nbgl_aligment_t    alignment;         
    struct nbgl_obj_s *parent;            
    struct nbgl_obj_s *alignTo;           
    int16_t            alignmentMarginX;  
    int16_t            alignmentMarginY;  
    uint16_t touchMask;  
    uint8_t  touchId;  
    uint8_t objId;     
} nbgl_obj_t;
 
typedef struct PACKED__ nbgl_container_s {
    nbgl_obj_t       obj;       
    nbgl_obj_t     **children;  
    nbgl_direction_t layout;    
    uint8_t          nbChildren;
    bool             forceClean;  
} nbgl_container_t;
 
typedef struct PACKED__ nbgl_line_s {
    nbgl_obj_t       obj;        
    nbgl_direction_t direction;  
    color_t          lineColor;  
    uint8_t thickness;  
    uint8_t offset;  
} nbgl_line_t;
 
typedef nbgl_icon_details_t *(*onImageDrawCallback_t)(uint8_t token);
 
typedef struct PACKED__ nbgl_image_s {
    nbgl_obj_t                 obj;        // common part
    const nbgl_icon_details_t *buffer;     
    onImageDrawCallback_t onDrawCallback;  
    color_t foregroundColor;  
    nbgl_transformation_t transformation;  
    uint8_t               token;           
} nbgl_image_t;
 
typedef struct PACKED__ nbgl_image_file_s {
    nbgl_obj_t     obj;     // common part
    const uint8_t *buffer;  
} nbgl_image_file_t;
 
typedef struct PACKED__ nbgl_qrcode_s {
    nbgl_obj_t  obj;          // common part
    const char *text;         
    color_t foregroundColor;  
    nbgl_qrcode_version_t version;  
} nbgl_qrcode_t;
 
typedef struct PACKED__ nbgl_radio_s {
    nbgl_obj_t   obj;          // common part
    color_t      activeColor;  
    color_t      borderColor;  
    nbgl_state_t state;        
} nbgl_radio_t;
 
typedef struct PACKED__ nbgl_switch_s {
    nbgl_obj_t   obj;       // common part
    color_t      onColor;   
    color_t      offColor;  
    nbgl_state_t state;     
} nbgl_switch_t;
 
typedef struct PACKED__ nbgl_progress_bar_s {
    nbgl_obj_t obj;  // common part
    uint16_t   previousWidth;
    uint8_t    state;           
    uint8_t partialRedraw : 1;  
    uint8_t withBorder : 1;     
    uint8_t resetIfOverriden : 1;  
    color_t foregroundColor;       
} nbgl_progress_bar_t;
 
typedef enum {
    PROGRESSIVE_INDICATOR = 0,  
    CURRENT_INDICATOR           
} nbgl_page_indicator_style_t;
 
typedef struct PACKED__ nbgl_navigation_bar_s {
    nbgl_obj_t                  obj;         
    uint8_t                     nbPages;     
    uint8_t                     activePage;  
    nbgl_page_indicator_style_t style;       
} nbgl_page_indicator_t;
 
typedef char *(*onTextDrawCallback_t)(uint8_t token);
 
typedef struct PACKED__ nbgl_button_s {
    nbgl_obj_t           obj;             
    const char          *text;            
    onTextDrawCallback_t onDrawCallback;  
    const nbgl_icon_details_t *icon;  
    color_t                    innerColor;   
    color_t                    borderColor;  
    color_t foregroundColor;   
    nbgl_radius_t  radius;     
    nbgl_font_id_e fontId;     
    bool           localized;  
    uint8_t token;             
} nbgl_button_t;
 
typedef struct PACKED__ nbgl_text_area_s {
    nbgl_obj_t obj;        
    color_t    textColor;  
    nbgl_aligment_t textAlignment;  
    nbgl_style_t    style;          
    nbgl_font_id_e  fontId;         
    bool autoHideLongLine;          
    uint8_t wrapping : 1;           
    uint8_t hideEndOfLastLine : 1;  
    uint8_t nbMaxLines;             
    const char *text;               
    uint16_t    len;  
    onTextDrawCallback_t
            onDrawCallback;  
    uint8_t token;           
    bool    obfuscated;
} nbgl_text_area_t;
 
typedef struct PACKED__ nbgl_text_entry_s {
    nbgl_obj_t     obj;      
    const char    *text;     
    nbgl_font_id_e fontId;   
    uint8_t        nbChars;  
} nbgl_text_entry_t;
 
typedef struct PACKED__ nbgl_mask_control_s {
    nbgl_obj_t obj;            
    bool       enableMasking;  
    uint8_t    maskIndex;      
} nbgl_mask_control_t;
 
typedef struct PACKED__ nbgl_spinner_s {
    nbgl_obj_t obj;       
    uint8_t    position;  
} nbgl_spinner_t;
 
typedef void (*keyboardCallback_t)(char touchedKey);
 
typedef enum {
#ifdef HAVE_SE_TOUCH
    MODE_LETTERS = 0,  
    MODE_DIGITS,       
    MODE_SPECIAL       
#else                  // HAVE_SE_TOUCH
    MODE_LOWER_LETTERS,        
    MODE_UPPER_LETTERS,        
    MODE_DIGITS_AND_SPECIALS,  
    MODE_NONE                  
#endif                 // HAVE_SE_TOUCH
} keyboardMode_t;
 
typedef enum {
    LOWER_CASE = 0,    
    UPPER_CASE,        
    LOCKED_UPPER_CASE  
} keyboardCase_t;
 
typedef struct PACKED__ nbgl_keyboard_s {
    nbgl_obj_t obj;          
    color_t    textColor;    
    color_t    borderColor;  
    bool       lettersOnly;  
#ifdef SCREEN_SIZE_WALLET
    bool needsRefresh;  
    keyboardCase_t casing;  
#else                       // SCREEN_SIZE_WALLET
    bool    enableBackspace;   
    bool    enableValidate;    
    bool    obfuscated;
    uint8_t selectedCharIndex;
#endif                      // SCREEN_SIZE_WALLET
    keyboardMode_t mode;    
    uint32_t keyMask;  
    keyboardCallback_t callback;  
} nbgl_keyboard_t;
 
typedef struct PACKED__ nbgl_keypad_s {
    nbgl_obj_t         obj;       
    keyboardCallback_t callback;  
#ifdef SCREEN_SIZE_WALLET
    uint8_t softValidation : 1;   
    uint8_t enableDigits : 1;     
    uint8_t digitsChanged : 1;    
    uint8_t validateChanged : 1;  
    uint8_t enableBackspace : 1;  
    uint8_t enableValidate : 1;   
    uint8_t shuffled : 1;         
    uint8_t digitIndexes[5];      
#else                             // SCREEN_SIZE_WALLET
    uint8_t selectedKey : 5;      
    uint8_t enableBackspace : 1;  
    uint8_t enableValidate : 1;   
    uint8_t shuffled : 1;         
#endif                            // SCREEN_SIZE_WALLET
} nbgl_keypad_t;
 
enum {
    BOTTOM_BUTTON_ID = 1,
    LEFT_BUTTON_ID,
    RIGHT_BUTTON_ID,
    WHOLE_SCREEN_ID,
    TOP_RIGHT_BUTTON_ID,
    BACK_BUTTON_ID,
    SINGLE_BUTTON_ID,
    EXTRA_BUTTON_ID,
    CHOICE_1_ID,
    CHOICE_2_ID,
    CHOICE_3_ID,
    KEYPAD_ID,
    KEYBOARD_ID,
    ENTERED_TEXT_ID,
    VALUE_BUTTON_1_ID,
    VALUE_BUTTON_2_ID,
    VALUE_BUTTON_3_ID,
    LONG_PRESS_BUTTON_ID,
    TIP_BOX_ID,
    CONTROLS_ID,  // when multiple controls in the same pages (buttons, switches, radios)
    NB_CONTROL_IDS
};
 
/**********************
 *  GLOBAL VARIABLES
 **********************/
 
extern uint8_t ramBuffer[];
 
/**********************
 * GLOBAL PROTOTYPES
 **********************/
 
void nbgl_refresh(void);
void nbgl_refreshSpecial(nbgl_refresh_mode_t mode);
void nbgl_refreshSpecialWithPostRefresh(nbgl_refresh_mode_t mode, nbgl_post_refresh_t post_refresh);
bool nbgl_refreshIsNeeded(void);
void nbgl_refreshReset(void);
 
void     nbgl_objInit(void);
void     nbgl_objDraw(nbgl_obj_t *obj);
void     nbgl_objAllowDrawing(bool enable);
uint8_t *nbgl_objGetRAMBuffer(void);
bool     nbgl_objIsUx(nbgl_obj_t *obj);
 
void         nbgl_objPoolRelease(uint8_t layer);
nbgl_obj_t  *nbgl_objPoolGet(nbgl_obj_type_t type, uint8_t layer);
uint8_t      nbgl_objPoolGetId(nbgl_obj_t *obj);
int          nbgl_objPoolGetArray(nbgl_obj_type_t type,
                                  uint8_t         nbObjs,
                                  uint8_t         layer,
                                  nbgl_obj_t    **objArray);
uint8_t      nbgl_objPoolGetNbUsed(uint8_t layer);
void         nbgl_containerPoolRelease(uint8_t layer);
nbgl_obj_t **nbgl_containerPoolGet(uint8_t nbObjs, uint8_t layer);
uint8_t      nbgl_containerPoolGetNbUsed(uint8_t layer);
 
// for internal use
void nbgl_objDrawKeyboard(nbgl_keyboard_t *kbd);
void nbgl_objDrawKeypad(nbgl_keypad_t *kbd);
#ifdef HAVE_SE_TOUCH
void nbgl_keyboardTouchCallback(nbgl_obj_t *obj, nbgl_touchType_t eventType);
void nbgl_keypadTouchCallback(nbgl_obj_t *obj, nbgl_touchType_t eventType);
 
bool nbgl_keyboardGetPosition(nbgl_keyboard_t *kbd, char index, uint16_t *x, uint16_t *y);
bool nbgl_keypadGetPosition(nbgl_keypad_t *kbd, char index, uint16_t *x, uint16_t *y);
#else   // HAVE_SE_TOUCH
void nbgl_keyboardCallback(nbgl_obj_t *obj, nbgl_buttonEvent_t buttonEvent);
void nbgl_keypadCallback(nbgl_obj_t *obj, nbgl_buttonEvent_t buttonEvent);
#endif  // HAVE_SE_TOUCH
 
/**********************
 *      MACROS
 **********************/
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* NBGL_OBJ_H */