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 "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
#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)
#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
#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 BOTTOM_BORDER_MARGIN 24
#elif defined(TARGET_FLEX)
#define BORDER_MARGIN        32
#define BOTTOM_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
#endif  // TARGETS
 
// common dimensions for buttons
#if COMMON_RADIUS == 40
#define BUTTON_RADIUS   RADIUS_40_PIXELS
#define BUTTON_DIAMETER (COMMON_RADIUS * 2)
#elif COMMON_RADIUS == 44
#define BUTTON_RADIUS   RADIUS_44_PIXELS
#define BUTTON_DIAMETER (COMMON_RADIUS * 2)
#endif  // COMMON_RADIUS
 
// 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
#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
#endif  // TARGETS
 
// common small icons
#if SMALL_ICON_SIZE == 32
#define SPACE_ICON        C_Space_32px
#define BACKSPACE_ICON    C_Erase_32px
#define SHIFT_ICON        C_Maj_32px
#define SHIFT_LOCKED_ICON C_Maj_Lock_32px
#define VALIDATE_ICON     C_Check_32px
#define RADIO_OFF_ICON    C_radio_inactive_32px
#define RADIO_ON_ICON     C_radio_active_32px
#define PUSH_ICON         C_Chevron_32px
#define LEFT_ARROW_ICON   C_Back_32px
#define RIGHT_ARROW_ICON  C_Next_32px
#define CHEVRON_BACK_ICON C_Chevron_Back_32px
#define CHEVRON_NEXT_ICON C_Chevron_Next_32px
#define CLOSE_ICON        C_Close_32px
#define WHEEL_ICON        C_Settings_32px
#define INFO_I_ICON       C_Info_32px
#define QRCODE_ICON       C_QRCode_32px
#define MINI_PUSH_ICON    C_Mini_Push_32px
#define WARNING_ICON      C_Warning_32px
#define ROUND_WARN_ICON   C_Important_Circle_32px
#define PRIVACY_ICON      C_Privacy_32px
#define EXCLAMATION_ICON  C_Exclamation_32px
#define DIGIT_ICON        C_round_24px
#elif SMALL_ICON_SIZE == 40
#define SPACE_ICON        C_Space_40px
#define BACKSPACE_ICON    C_Erase_40px
#define SHIFT_ICON        C_Maj_40px
#define SHIFT_LOCKED_ICON C_Maj_Lock_40px
#define VALIDATE_ICON     C_Check_40px
#define RADIO_OFF_ICON    C_radio_inactive_40px
#define RADIO_ON_ICON     C_radio_active_40px
#define PUSH_ICON         C_Chevron_40px
#define LEFT_ARROW_ICON   C_Back_40px
#define RIGHT_ARROW_ICON  C_Next_40px
#define CHEVRON_BACK_ICON C_Chevron_Back_40px
#define CHEVRON_NEXT_ICON C_Chevron_Next_40px
#define CLOSE_ICON        C_Close_40px
#define WHEEL_ICON        C_Settings_40px
#define INFO_I_ICON       C_Info_40px
#define QRCODE_ICON       C_QRCode_40px
#define MINI_PUSH_ICON    C_Mini_Push_40px
#define WARNING_ICON      C_Warning_40px
#define ROUND_WARN_ICON   C_Important_Circle_40px
#define PRIVACY_ICON      C_Privacy_40px
#define EXCLAMATION_ICON  C_Exclamation_40px
#define DIGIT_ICON        C_pin_24
#endif  // SMALL_ICON_SIZE
 
// common large icons
#if LARGE_ICON_SIZE == 64
#define CHECK_CIRCLE_ICON     C_Check_Circle_64px
#define DENIED_CIRCLE_ICON    C_Denied_Circle_64px
#define IMPORTANT_CIRCLE_ICON C_Important_Circle_64px
#define LARGE_WARNING_ICON    C_Warning_64px
#else  // LARGE_ICON_SIZE
#error Undefined LARGE_ICON_SIZE
#endif  // LARGE_ICON_SIZE
 
// For backward compatibility, to be remove later
#define C_warning64px        _Pragma("GCC warning \"Deprecated constant!\"") C_Warning_64px
#define C_round_warning_64px _Pragma("GCC warning \"Deprecated constant!\"") C_Important_Circle_64px
#define C_round_check_64px   _Pragma("GCC warning \"Deprecated constant!\"") C_Check_Circle_64px
#define C_Message_64px       _Pragma("GCC warning \"Deprecated constant!\"") C_Review_64px
#define C_leftArrow32px      _Pragma("GCC warning \"Deprecated constant!\"") C_Back_32px
#define C_Next32px           _Pragma("GCC warning \"Deprecated constant!\"") C_Next_32px
#define C_round_cross_64px   _Pragma("GCC warning \"Deprecated constant!\"") C_Denied_Circle_64px
 
// 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
 
/**********************
 *      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;  
    int16_t
        rel_x0;  
    int16_t rel_y0;  
    struct nbgl_obj_s *parent;            
    struct nbgl_obj_s *alignTo;           
    nbgl_aligment_t    alignment;         
    int16_t            alignmentMarginX;  
    int16_t            alignmentMarginY;  
    nbgl_obj_type_t    type;              
    uint16_t touchMask;  
    uint8_t  touchId;  
} nbgl_obj_t;
 
typedef struct PACKED__ nbgl_container_s {
    nbgl_obj_t          obj;     
    nbgl_direction_t    layout;  
    uint8_t             nbChildren;
    bool                forceClean;  
    struct nbgl_obj_s **children;    
} 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
    color_t foregroundColor;  
    nbgl_transformation_t      transformation;  
    const nbgl_icon_details_t *buffer;     
    onImageDrawCallback_t onDrawCallback;  
    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
    color_t foregroundColor;  
    nbgl_qrcode_version_t version;  
    const char *text;               
} 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
    bool       withBorder;     
    uint8_t    state;          
    bool       partialRedraw;  
    uint16_t   previousWidth;
    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;                  
    color_t    innerColor;           
    color_t    borderColor;          
    color_t    foregroundColor;      
    nbgl_radius_t        radius;     
    nbgl_font_id_e       fontId;     
    bool                 localized;  
    const char          *text;       
    onTextDrawCallback_t onDrawCallback;  
    uint8_t                    token;     
    const nbgl_icon_details_t *icon;  
} 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;  
    bool    wrapping;       
    uint8_t nbMaxLines;  
    const char *text;    
    uint16_t    len;     
    onTextDrawCallback_t
            onDrawCallback;  
    uint8_t token;           
} nbgl_text_area_t;
 
typedef struct PACKED__ nbgl_text_entry_s {
    nbgl_obj_t     obj;      
    nbgl_font_id_e fontId;   
    uint8_t        nbChars;  
    const char    *text;     
} 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;    
    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;  
#ifdef SCREEN_SIZE_WALLET
    color_t borderColor;                 
    bool    softValidation;              
    bool    enableDigits;                
    bool    partial;                     
    uint8_t digitIndexes[5];             
#else                                    // SCREEN_SIZE_WALLET
    uint8_t selectedKey;  
#endif                                   // SCREEN_SIZE_WALLET
    bool               enableBackspace;  
    bool               enableValidate;   
    bool               shuffled;         
    keyboardCallback_t callback;         
} 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 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);
nbgl_obj_t  *nbgl_objPoolGetPrevious(nbgl_obj_t *obj, 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 */