nbgl_page.h

Go to the documentation of this file.

 
#ifndef NBGL_PAGE_H
#define NBGL_PAGE_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*********************
 *      INCLUDES
 *********************/
 
#include "nbgl_layout.h"
#include "nbgl_obj.h"
#include "nbgl_types.h"
#include "nbgl_content.h"
 
/*********************
 *      DEFINES
 *********************/
 
/**********************
 *      TYPEDEFS
 **********************/
 
typedef enum {
    NO_BUTTON_STYLE = 0,  
    SETTINGS_ICON,        
    QUIT_ICON,            
    INFO_ICON,            
    QUIT_APP_TEXT         
} nbgl_pageButtonStyle_t;
 
typedef nbgl_contentInfoLongPress_t nbgl_pageInfoLongPress_t;
 
typedef struct nbgl_pageContent_s {
    const char *title;             
    bool        isTouchableTitle;  
    uint8_t titleToken;   
    tune_index_e tuneId;  
    uint8_t      topRightToken;  
    const nbgl_icon_details_t *topRightIcon;  
    nbgl_contentType_t type;                  
    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_pageContent_t;
 
typedef void *nbgl_page_t;
 
typedef enum {
    NAV_WITH_TAP,      
    NAV_WITH_BUTTONS,  
} nbgl_pageNavigationType_t;
 
typedef struct nbgl_pageNavWithTap_s {
    bool backButton;    
    uint8_t backToken;  
    uint8_t nextPageToken;     
    const char *nextPageText;  
    const char *quitText;      
} nbgl_pageNavWithTap_t;
 
typedef struct nbgl_pageNavWithButtons_s {
    bool quitButton;  
    bool backButton;  
    bool
        visiblePageIndicator;  
    uint8_t navToken;  
    const char
        *quitText;  
} nbgl_pageNavWithButtons_t;
 
typedef struct nbgl_pageMultiScreensDescription_s {
    uint8_t activePage;  
    uint8_t nbPages;     
    uint8_t
        quitToken;  
    nbgl_pageNavigationType_t navType;  
    bool progressIndicator;  
    tune_index_e
        tuneId;  
    const char *skipText;  
    uint8_t skipToken;  
    union {
        nbgl_pageNavWithTap_t     navWithTap;      
        nbgl_pageNavWithButtons_t navWithButtons;  
    };
} nbgl_pageNavigationInfo_t;
 
typedef struct nbgl_pageConfirmationDescription_s {
    nbgl_layoutCenteredInfo_t centeredInfo;      
    const char               *confirmationText;  
    const char *cancelText;  
    uint8_t     confirmationToken;  
    uint8_t cancelToken;  
    tune_index_e
         tuneId;  
    bool modal;   
} nbgl_pageConfirmationDescription_t;
 
typedef struct nbgl_pageAddressConfirmationDescription_s {
    const char *address;  
    const char
        *qrCodeButtonText;  
    const char
        *confirmationText;  
    const char
           *cancelText;  
    uint8_t confirmationToken;  
    uint8_t cancelToken;  
    tune_index_e
        tuneId;  
} nbgl_pageAddressConfirmationDescription_t;
 
typedef struct nbgl_pageInfoDescription_s {
    nbgl_layoutCenteredInfo_t centeredInfo;       
    nbgl_pageButtonStyle_t    topRightStyle;      
    nbgl_pageButtonStyle_t    bottomButtonStyle;  
    uint8_t topRightToken;  
    uint8_t bottomButtonsToken;  
    const char *footerText;      
    uint8_t     footerToken;    
    const char *tapActionText;  
    bool    isSwipeable;        
    uint8_t tapActionToken;  
    const char
        *actionButtonText;  
    const nbgl_icon_details_t *actionButtonIcon;   
    nbgl_layoutButtonStyle_t   actionButtonStyle;  
    tune_index_e
        tuneId;  
} nbgl_pageInfoDescription_t;
 
/**********************
 * GLOBAL PROTOTYPES
 **********************/
 
nbgl_page_t *nbgl_pageDrawLedgerInfo(nbgl_layoutTouchCallback_t              onActionCallback,
                                     const nbgl_screenTickerConfiguration_t *ticker,
                                     const char                             *text,
                                     int                                     tapActionToken);
nbgl_page_t *nbgl_pageDrawSpinner(const char *text, uint8_t initPosition);
nbgl_page_t *nbgl_pageDrawInfo(nbgl_layoutTouchCallback_t              onActionCallback,
                               const nbgl_screenTickerConfiguration_t *ticker,
                               const nbgl_pageInfoDescription_t       *info);
nbgl_page_t *nbgl_pageDrawConfirmation(nbgl_layoutTouchCallback_t                onActionCallback,
                                       const nbgl_pageConfirmationDescription_t *info);
nbgl_page_t *nbgl_pageDrawGenericContentExt(nbgl_layoutTouchCallback_t       onActionCallback,
                                            const nbgl_pageNavigationInfo_t *nav,
                                            nbgl_pageContent_t              *content,
                                            bool                             modal);
nbgl_page_t *nbgl_pageDrawGenericContent(nbgl_layoutTouchCallback_t       onActionCallback,
                                         const nbgl_pageNavigationInfo_t *nav,
                                         nbgl_pageContent_t              *content);
int          nbgl_pageRelease(nbgl_page_t *);
 
/**********************
 *      MACROS
 **********************/
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* NBGL_PAGE_H */