nbgl_content.h

Go to the documentation of this file.

 
#ifndef NBGL_CONTENT_H
#define NBGL_CONTENT_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*********************
 *      INCLUDES
 *********************/
#include <stdint.h>
#include <stdbool.h>
 
#include "os_io_seph_cmd.h"
 
#include "nbgl_types.h"
#include "nbgl_obj.h"
 
/**********************
 *      TYPEDEFS
 **********************/
 
typedef enum {
#ifdef HAVE_SE_TOUCH
    LARGE_CASE_INFO,  
    LARGE_CASE_BOLD_INFO,  
    LARGE_CASE_GRAY_INFO,  
    NORMAL_INFO,  
    PLUGIN_INFO   
#else   // HAVE_SE_TOUCH
    REGULAR_INFO = 0,  
    BOLD_TEXT1_INFO,   
    BUTTON_INFO        
#endif  // HAVE_SE_TOUCH
} nbgl_contentCenteredInfoStyle_t;
 
typedef struct {
    const char *text1;  
    const char *text2;  
#ifdef HAVE_SE_TOUCH
    const char *text3;                      
#endif                                      // HAVE_SE_TOUCH
    const nbgl_icon_details_t      *icon;   
    bool                            onTop;  
    nbgl_contentCenteredInfoStyle_t style;  
#ifdef HAVE_SE_TOUCH
    int16_t offsetY;  
#else                 // HAVE_SE_TOUCH
    bool bottomIcon;   
#endif                // HAVE_SE_TOUCH
} nbgl_contentCenteredInfo_t;
 
typedef enum {
    ICON_ILLUSTRATION,  
    ANIM_ILLUSTRATION,  
} nbgl_contentIllustrationType_t;
 
typedef struct {
    nbgl_contentIllustrationType_t illustrType;
    const nbgl_icon_details_t     *icon;  
    const nbgl_animation_t
        *animation;  
    uint16_t animOffsetX;  
    uint16_t animOffsetY;  
    const char *title;     
    const char *smallTitle;   
    const char *description;  
    const char *subText;      
    uint16_t    iconHug;      
    bool        padding;      
} nbgl_contentCenter_t;
 
typedef struct {
    const char                *text;           
    const nbgl_icon_details_t *icon;           
    const char                *longPressText;  
    uint8_t longPressToken;  
    tune_index_e
        tuneId;  
} nbgl_contentInfoLongPress_t;
 
typedef struct {
    const char                *text;        
    const nbgl_icon_details_t *icon;        
    const char                *buttonText;  
    uint8_t buttonToken;  
    tune_index_e
        tuneId;  
#ifndef HAVE_SE_TOUCH
    bool bottomIcon;  
#endif                // HAVE_SE_TOUCH
} nbgl_contentInfoButton_t;
 
typedef enum {
    NO_ALIAS_TYPE = 0,
    ENS_ALIAS,           
    ADDRESS_BOOK_ALIAS,  
    QR_CODE_ALIAS,       
    INFO_LIST_ALIAS,     
    TAG_VALUE_LIST_ALIAS
} nbgl_contentValueAliasType_t;
 
typedef struct {
    const char *fullValue;     
    const char *aliasSubName;  
    const char *explanation;   
    const char *title;  
    const char
        *backText;  
    union {
        const struct nbgl_contentInfoList_s *infolist;  
        const struct nbgl_contentTagValueList_s
            *tagValuelist;  
    };
    nbgl_contentValueAliasType_t aliasType;  
} nbgl_contentValueExt_t;
 
typedef struct {
    const char *item;   
    const char *value;  
    union {
        const nbgl_icon_details_t
            *valueIcon;  
        const nbgl_contentValueExt_t
            *extension;  
    };
    uint8_t forcePageStart : 1;  
    uint8_t centeredInfo : 1;    
    uint8_t aliasValue : 1;      
} nbgl_contentTagValue_t;
 
typedef nbgl_contentTagValue_t *(*nbgl_contentTagValueCallback_t)(uint8_t pairIndex);
 
typedef void (*nbgl_contentActionCallback_t)(int token, uint8_t index, int page);
 
typedef struct nbgl_contentTagValueList_s {
    const nbgl_contentTagValue_t
        *pairs;  
    nbgl_contentTagValueCallback_t callback;  
    uint8_t nbPairs;  
    uint8_t startIndex;          
    bool    hideEndOfLastLine;   
    uint8_t nbMaxLinesForValue;  
    uint8_t token;  
    bool smallCaseForValue;  
    bool wrapping;  
    nbgl_contentActionCallback_t
        actionCallback;  
} nbgl_contentTagValueList_t;
 
typedef struct {
    nbgl_contentTagValueList_t tagValueList;       
    const nbgl_icon_details_t *detailsButtonIcon;  
    const char                *detailsButtonText;  
    uint8_t detailsButtonToken;  
    tune_index_e
        tuneId;  
} nbgl_contentTagValueDetails_t;
 
typedef struct {
    nbgl_contentTagValueList_t tagValueList;       
    const nbgl_icon_details_t *detailsButtonIcon;  
    const char *detailsButtonText;  
    uint8_t     detailsButtonToken;  
    tune_index_e
        tuneId;  
    const char
        *confirmationText;  
    const char
           *cancelText;  
    uint8_t confirmationToken;  
    uint8_t cancelToken;  
} nbgl_contentTagValueConfirm_t;
 
typedef struct {
    const char *text;  
    const char
        *subText;  
    nbgl_state_t initState;  
    uint8_t token;  
    tune_index_e tuneId;  
} nbgl_contentSwitch_t;
 
typedef struct nbgl_pageSwitchesList_s {
    const nbgl_contentSwitch_t *switches;    
    uint8_t                     nbSwitches;  
} nbgl_contentSwitchesList_t;
 
typedef struct nbgl_contentInfoList_s {
    const char *const *infoTypes;     
    const char *const *infoContents;  
    const nbgl_contentValueExt_t
        *infoExtensions;  
    uint8_t nbInfos;      
    uint8_t token;  
    bool withExtensions;  
} nbgl_contentInfoList_t;
 
typedef struct {
    union {
        const char *const *names;  
#if defined(HAVE_LANGUAGE_PACK)
        UX_LOC_STRINGS_INDEX *nameIds;  
#endif                                  // HAVE_LANGUAGE_PACK
    };
    bool    localized;   
    uint8_t nbChoices;   
    uint8_t initChoice;  
    uint8_t token;       
    tune_index_e
        tuneId;  
#ifndef HAVE_SE_TOUCH
    bool vertical;  
    const nbgl_icon_details_t
        *selectionIcon;  
 
    const char *title;
#endif  // HAVE_SE_TOUCH
 
} nbgl_contentRadioChoice_t;
 
typedef struct {
    const char *const *barTexts;  
    const uint8_t     *tokens;    
    uint8_t            nbBars;    
    tune_index_e tuneId;  
#ifndef HAVE_SE_TOUCH
    bool vertical;  
 
    const char *title;
#endif  // HAVE_SE_TOUCH
} nbgl_contentBarsList_t;
 
typedef struct {
    const char                *text;    
    const nbgl_icon_details_t *icon;    
    uint8_t                    token;   
    tune_index_e               tuneId;  
} nbgl_contentTipBox_t;
 
typedef struct {
    nbgl_contentCenter_t contentCenter;  
    nbgl_contentTipBox_t tipBox;         
} nbgl_contentExtendedCenter_t;
 
typedef enum {
    CENTERED_INFO = 0,  
    EXTENDED_CENTER,    
    INFO_LONG_PRESS,    
    INFO_BUTTON,        
    TAG_VALUE_LIST,     
    TAG_VALUE_DETAILS,  
    TAG_VALUE_CONFIRM,  
    SWITCHES_LIST,      
    INFOS_LIST,         
    CHOICES_LIST,       
    BARS_LIST           
} nbgl_contentType_t;
 
typedef union {
    nbgl_contentCenteredInfo_t    centeredInfo;     
    nbgl_contentExtendedCenter_t  extendedCenter;   
    nbgl_contentInfoLongPress_t   infoLongPress;    
    nbgl_contentInfoButton_t      infoButton;       
    nbgl_contentTagValueList_t    tagValueList;     
    nbgl_contentTagValueDetails_t tagValueDetails;  
    nbgl_contentTagValueConfirm_t tagValueConfirm;  
    nbgl_contentSwitchesList_t    switchesList;     
    nbgl_contentInfoList_t        infosList;        
    nbgl_contentRadioChoice_t     choicesList;      
    nbgl_contentBarsList_t        barsList;         
} nbgl_content_u;
 
typedef struct {
    nbgl_contentType_t type;  
    nbgl_content_u     content;
    nbgl_contentActionCallback_t
        contentActionCallback;  
} nbgl_content_t;
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* NBGL_CONTENT_H */