Embedded SDK
Embedded SDK
Loading...
Searching...
No Matches
nbgl_page.h
Go to the documentation of this file.
1
6
7#ifndef NBGL_PAGE_H
8#define NBGL_PAGE_H
9
11
12#ifdef __cplusplus
13extern "C" {
14#endif
15
16/*********************
17 * INCLUDES
18 *********************/
19
20#include "nbgl_layout.h"
21#include "nbgl_obj.h"
22#include "nbgl_types.h"
23#include "nbgl_content.h"
24#include "nbgl_page_types.h"
25
26/*********************
27 * DEFINES
28 *********************/
29
30/**********************
31 * TYPEDEFS
32 **********************/
33
45
50typedef void *nbgl_page_t;
51
60
76
91
114
129
150
175
176/**********************
177 * GLOBAL PROTOTYPES
178 **********************/
179
182 const char *text,
183 int tapActionToken);
184nbgl_page_t *nbgl_pageDrawSpinner(const char *text, uint8_t initPosition);
187 const nbgl_pageInfoDescription_t *info);
191 const nbgl_pageNavigationInfo_t *nav,
192 nbgl_pageContent_t *content,
193 bool modal);
195 const nbgl_pageNavigationInfo_t *nav,
196 nbgl_pageContent_t *content);
198
199/**********************
200 * MACROS
201 **********************/
202
203#ifdef __cplusplus
204} /* extern "C" */
205#endif
206
207#endif /* NBGL_PAGE_H */
common content for Graphical Library
struct nbgl_pageContent_s nbgl_pageContent_t
This structure contains data to build a page in multi-pages mode (nbgl_pageDrawGenericContent).
API of the Advanced BOLOS Graphical Library, for predefined layouts.
nbgl_layoutButtonStyle_t
The different styles for a button.
nbgl_contentCenteredInfo_t nbgl_layoutCenteredInfo_t
Deprecated, kept for retro compatibility.
void(* nbgl_layoutTouchCallback_t)(int token, uint8_t index)
prototype of function to be called when an object is touched
Included by every low-level NBGL header, to forbid them in apollo app code.
API to draw all basic graphic objects.
struct nbgl_pageNavWithButtons_s nbgl_pageNavWithButtons_t
Structure containing all information to create a navigation with buttons in bottom nav bar.
struct nbgl_pageInfoDescription_s nbgl_pageInfoDescription_t
Structure containing all specific information when creating an information page.
nbgl_page_t * nbgl_pageDrawGenericContent(nbgl_layoutTouchCallback_t onActionCallback, const nbgl_pageNavigationInfo_t *nav, nbgl_pageContent_t *content)
nbgl_page_t * nbgl_pageDrawInfo(nbgl_layoutTouchCallback_t onActionCallback, const nbgl_screenTickerConfiguration_t *ticker, const nbgl_pageInfoDescription_t *info)
void * nbgl_page_t
type shared externally
Definition nbgl_page.h:50
struct nbgl_pageNavWithTap_s nbgl_pageNavWithTap_t
Structure containing all information to create a navigation with "tap".
nbgl_pageNavigationType_t
The different types of navigation in a multi-screens page.
Definition nbgl_page.h:56
@ NAV_WITH_BUTTONS
move forward and backward with buttons in bottom nav bar
Definition nbgl_page.h:58
@ NAV_WITH_TAP
move forward with "tap" and possibly backward with top left arrow
Definition nbgl_page.h:57
struct nbgl_pageMultiScreensDescription_s nbgl_pageNavigationInfo_t
Structure containing all specific information when creating a multi-screens page.
nbgl_page_t * nbgl_pageDrawLedgerInfo(nbgl_layoutTouchCallback_t onActionCallback, const nbgl_screenTickerConfiguration_t *ticker, const char *text, int tapActionToken)
nbgl_page_t * nbgl_pageDrawConfirmation(nbgl_layoutTouchCallback_t onActionCallback, const nbgl_pageConfirmationDescription_t *info)
struct nbgl_pageConfirmationDescription_s nbgl_pageConfirmationDescription_t
Structure containing all specific information when creating a confirmation page.
int nbgl_pageRelease(nbgl_page_t *)
nbgl_page_t * nbgl_pageDrawSpinner(const char *text, uint8_t initPosition)
nbgl_page_t * nbgl_pageDrawGenericContentExt(nbgl_layoutTouchCallback_t onActionCallback, const nbgl_pageNavigationInfo_t *nav, nbgl_pageContent_t *content, bool modal)
struct nbgl_pageAddressConfirmationDescription_s nbgl_pageAddressConfirmationDescription_t
Structure containing all specific information when creating a address confirmation page....
nbgl_pageButtonStyle_t
The different types of top-right / bottom button.
Definition nbgl_page.h:38
@ QUIT_APP_TEXT
A full width button with "Quit app" text (only for bottom button).
Definition nbgl_page.h:43
@ INFO_ICON
info (i) icon in the button.
Definition nbgl_page.h:42
@ QUIT_ICON
quit (X) icon in the button.
Definition nbgl_page.h:41
@ NO_BUTTON_STYLE
no button.
Definition nbgl_page.h:39
@ SETTINGS_ICON
settings (wheel) icon in the button.
Definition nbgl_page.h:40
Types of NBGL pages also used by the use-case API.
struct PACKED__ nbgl_screenTickerConfiguration_s nbgl_screenTickerConfiguration_t
struct to configure a screen layer
common types for Graphical Library
struct PACKED__ nbgl_icon_details_s nbgl_icon_details_t
Represents all information about an icon.
Structure containing all specific information when creating a address confirmation page....
Definition nbgl_page.h:136
const char * confirmationText
text of the confirmation button, if NULL "It matches" is used
Definition nbgl_page.h:141
tune_index_e tuneId
if not NBGL_NO_TUNE, a tune will be played when button is pressed
Definition nbgl_page.h:148
uint8_t confirmationToken
the token used as argument of the onActionCallback
Definition nbgl_page.h:144
const char * qrCodeButtonText
text to display in "QR code button", if NULL "Show as QR is used"
Definition nbgl_page.h:139
const char * address
address to confirm
Definition nbgl_page.h:137
const char * cancelText
the text used for cancel action, if NULL "It doesn't matches" is used
Definition nbgl_page.h:143
Structure containing all specific information when creating a confirmation page.
Definition nbgl_page.h:118
const char * cancelText
the text used for cancel action, if NULL a simple X button is used
Definition nbgl_page.h:121
uint8_t confirmationToken
the token used as argument of the onActionCallback
Definition nbgl_page.h:122
bool modal
if true, page is open as a modal
Definition nbgl_page.h:127
const char * confirmationText
text of the confirmation button
Definition nbgl_page.h:120
nbgl_layoutCenteredInfo_t centeredInfo
description of the centered info to be used
Definition nbgl_page.h:119
tune_index_e tuneId
if not NBGL_NO_TUNE, a tune will be played when button is pressed
Definition nbgl_page.h:126
Structure containing all specific information when creating an information page.
Definition nbgl_page.h:154
nbgl_layoutButtonStyle_t actionButtonStyle
style of "action" button
Definition nbgl_page.h:171
const char * actionButtonText
if not NULL an "action" button is set under the centered info
Definition nbgl_page.h:169
const char * footerText
if not NULL, add a touchable footer
Definition nbgl_page.h:161
nbgl_pageButtonStyle_t topRightStyle
style to apply to the Top-Right button
Definition nbgl_page.h:156
uint8_t topRightToken
the token that will be used as argument of the onActionCallback
Definition nbgl_page.h:158
bool isSwipeable
if true, main area is swipeable
Definition nbgl_page.h:165
tune_index_e tuneId
if not NBGL_NO_TUNE, a tune will be played when button/footer is pressed
Definition nbgl_page.h:173
uint8_t footerToken
the token that will be used as argument of the onActionCallback
Definition nbgl_page.h:162
const nbgl_icon_details_t * actionButtonIcon
potential icon of "action" button
Definition nbgl_page.h:170
nbgl_pageButtonStyle_t bottomButtonStyle
style to apply to the Bottom button
Definition nbgl_page.h:157
nbgl_layoutCenteredInfo_t centeredInfo
description of the centered info to be used
Definition nbgl_page.h:155
Structure containing all specific information when creating a multi-screens page.
Definition nbgl_page.h:96
uint8_t nbPages
the number of pages to display (if <2, no navigation bar)
Definition nbgl_page.h:98
uint8_t quitToken
the token used as argument of the actionCallback when the footer is touched
Definition nbgl_page.h:100
uint8_t skipToken
if skipText is NULL the token used when right part of footer is touched
Definition nbgl_page.h:108
nbgl_pageNavigationType_t navType
Definition nbgl_page.h:101
uint8_t activePage
the index of the page to display at start-up
Definition nbgl_page.h:97
bool progressIndicator
if set to true, display a progress indicator on top of the page
Definition nbgl_page.h:103
nbgl_pageNavWithButtons_t navWithButtons
structure used when navigation with buttons
Definition nbgl_page.h:111
nbgl_pageNavWithTap_t navWithTap
structure used when navigation with "tap"
Definition nbgl_page.h:110
tune_index_e tuneId
if not NBGL_NO_TUNE, a tune will be played when next or back is pressed
Definition nbgl_page.h:105
Structure containing all information to create a navigation with buttons in bottom nav bar.
Definition nbgl_page.h:81
bool visiblePageIndicator
if set to true, the page indicator will be visible in navigation
Definition nbgl_page.h:85
bool quitButton
if set to true, a quit button (X) is displayed in the nav bar
Definition nbgl_page.h:82
const char * quitText
the text displayed in footer (on the left), used to quit (only on Flex)
Definition nbgl_page.h:89
bool backButton
if set to true, a back button (<-) is displayed in the nav bar
Definition nbgl_page.h:83
Structure containing all information to create a navigation with "tap".
Definition nbgl_page.h:65
const char * quitText
the text displayed in footer, used to quit
Definition nbgl_page.h:74
const char * nextPageText
Definition nbgl_page.h:72