Embedded SDK
Embedded SDK
Loading...
Searching...
No Matches
nbgl_layout.h
Go to the documentation of this file.
1
7#ifndef NBGL_LAYOUT_H
8#define NBGL_LAYOUT_H
9
10#ifdef __cplusplus
11extern "C" {
12#endif
13
14#include "nbgl_obj.h"
15#include "nbgl_screen.h"
16#include "nbgl_types.h"
17#include "nbgl_content.h"
18
19/*********************
20 * INCLUDES
21 *********************/
22
23/*********************
24 * DEFINES
25 *********************/
26#define NBGL_NO_TUNE NB_TUNES
27#define NBGL_NO_PROGRESS_INDICATOR 0xFF
28
30#define NBGL_INVALID_TOKEN 0xFF
31
32#ifdef HAVE_SE_TOUCH
35#define EXIT_PAGE 0xFF
36
37#if defined(TARGET_STAX)
38#define NB_MAX_SUGGESTION_BUTTONS 12
39// only 4 buttons are visible at the same time on Stax
40#define NB_MAX_VISIBLE_SUGGESTION_BUTTONS 4
41#define TOUCHABLE_HEADER_BAR_HEIGHT 88
42#define SMALL_FOOTER_HEIGHT 88
43#define SIMPLE_FOOTER_HEIGHT 92
44#define SMALL_CENTERING_HEADER 32
45#define MEDIUM_CENTERING_HEADER 56
46#define LARGE_CENTERING_HEADER 56
47#define MEDIUM_CENTERING_FOOTER 88
48#define LONG_PRESS_BUTTON_HEIGHT 128
49#define UP_FOOTER_BUTTON_HEIGHT 120
50#define ACTION_AND_FOOTER_FOOTER_HEIGHT 216
51#define BOTH_ROUNDED_FOOTER_HEIGHT 216
52
53#define LIST_ITEM_MIN_TEXT_HEIGHT 40
54#define LIST_ITEM_PRE_HEADING 28
55#define LIST_ITEM_PRE_HEADING_LARGE 28
56#define LIST_ITEM_HEADING_SUB_TEXT 12
57
58#define PRE_TAG_VALUE_MARGIN 24
59#define INTER_TAG_VALUE_MARGIN 12
60// width & height for progress bar
61#define PROGRESSBAR_WIDTH 120
62#define PROGRESSBAR_HEIGHT 12
63#define BACK_KEY_WIDTH 88
64#define ICON_TITLE_MARGIN 24
65#define TITLE_DESC_MARGIN 16
66
67#elif defined(TARGET_FLEX)
68#define NB_MAX_SUGGESTION_BUTTONS 8
69// only 2 buttons are visible at the same time on Flex
70#define NB_MAX_VISIBLE_SUGGESTION_BUTTONS 2
71#define TOUCHABLE_HEADER_BAR_HEIGHT 96
72#define SMALL_FOOTER_HEIGHT 96
73#define SIMPLE_FOOTER_HEIGHT 96
74#define SMALL_CENTERING_HEADER 40
75#define MEDIUM_CENTERING_HEADER 64
76#define LARGE_CENTERING_HEADER 64
77#define MEDIUM_CENTERING_FOOTER 64
78#define LONG_PRESS_BUTTON_HEIGHT 152
79#define UP_FOOTER_BUTTON_HEIGHT 136
80#define ACTION_AND_FOOTER_FOOTER_HEIGHT 232
81#define BOTH_ROUNDED_FOOTER_HEIGHT 232
82
83#define LIST_ITEM_MIN_TEXT_HEIGHT SMALL_ICON_SIZE
84#define LIST_ITEM_PRE_HEADING 26
85#define LIST_ITEM_PRE_HEADING_LARGE 30
86#define LIST_ITEM_HEADING_SUB_TEXT 12
87
88#define PRE_TAG_VALUE_MARGIN 0
89#define INTER_TAG_VALUE_MARGIN 24
90// width & height for progress bar
91#define PROGRESSBAR_WIDTH 120
92#define PROGRESSBAR_HEIGHT 12
93#define BACK_KEY_WIDTH 104
94#define ICON_TITLE_MARGIN 24
95#define TITLE_DESC_MARGIN 16
96
97#elif defined(TARGET_APEX)
98#define NB_MAX_SUGGESTION_BUTTONS 8
99// only 2 buttons are visible at the same time on Apex
100#define NB_MAX_VISIBLE_SUGGESTION_BUTTONS 2
101#define TOUCHABLE_HEADER_BAR_HEIGHT 60
102#define SMALL_FOOTER_HEIGHT 60
103#define SIMPLE_FOOTER_HEIGHT 60
104#define SMALL_CENTERING_HEADER 24
105#define MEDIUM_CENTERING_HEADER 40
106#define LARGE_CENTERING_HEADER 60
107#define MEDIUM_CENTERING_FOOTER 40
108#define LONG_PRESS_BUTTON_HEIGHT 88
109#define UP_FOOTER_BUTTON_HEIGHT 88
110#define ACTION_AND_FOOTER_FOOTER_HEIGHT 128
111#define BOTH_ROUNDED_FOOTER_HEIGHT 148
112
113#define LIST_ITEM_MIN_TEXT_HEIGHT SMALL_ICON_SIZE
114#define LIST_ITEM_PRE_HEADING 22
115#define LIST_ITEM_PRE_HEADING_LARGE 22
116#define LIST_ITEM_HEADING_SUB_TEXT 8
117
118#define PRE_TAG_VALUE_MARGIN 0
119#define INTER_TAG_VALUE_MARGIN 16
120// width & height for progress bar
121#define PROGRESSBAR_WIDTH 78
122#define PROGRESSBAR_HEIGHT 8
123#define BACK_KEY_WIDTH 56
124#define ICON_TITLE_MARGIN 16
125#define TITLE_DESC_MARGIN 12
126
127#else // TARGETS
128#error Undefined target
129#endif // TARGETS
130
131#define AVAILABLE_WIDTH (SCREEN_WIDTH - 2 * BORDER_MARGIN)
132
133// not really used
134#define NB_MAX_LINES 12
135
136#else // HAVE_SE_TOUCH
137// 7 pixels on each side
138#define AVAILABLE_WIDTH (SCREEN_WIDTH - 2 * 7)
139// maximum number of lines in screen
140#define NB_MAX_LINES 4
141
142#endif // HAVE_SE_TOUCH
143
144#define SPINNER_FIXED 0xFF
145
146/**********************
147 * TYPEDEFS
148 **********************/
149
154typedef void *nbgl_layout_t;
155
162typedef void (*nbgl_layoutTouchCallback_t)(int token, uint8_t index);
163
170
191
200
210
220
228 bool modal;
230#ifdef HAVE_SE_TOUCH
233 const char *tapActionText;
236 tune_index_e tapTuneId;
240#else // HAVE_SE_TOUCH
243#endif // HAVE_SE_TOUCH
244 nbgl_screenTickerConfiguration_t ticker; // configuration of ticker (timeout)
246
251typedef struct {
254 const char *text;
257 const char *subText;
258 bool large;
259 uint8_t token;
260 bool inactive;
261 bool centered;
262 tune_index_e tuneId;
264
270
275
281typedef const char *(*nbgl_menuListCallback_t)(uint8_t choiceIndex);
282
293
298
303
309
314typedef struct {
315 uint8_t nbRows;
316 const char *title;
317 const char **rowTexts;
320
321#ifdef HAVE_SE_TOUCH
322
329typedef struct {
330 const char *url;
331 const char *text1;
332 const char *text2;
333 int16_t offsetY;
334 bool centered;
337
348
362
369typedef struct {
371 const char *rightText;
372 uint8_t leftToken;
373 uint8_t rightToken;
374 tune_index_e tuneId;
376
388
402
412
416typedef struct {
417 const char **buttons;
422
426typedef struct {
427 const char *text;
428 int token;
429 bool active;
431
453
468
473typedef struct {
476 union {
477 struct {
478 uint16_t height;
479 } emptySpace;
480 struct {
483 const char *text;
484 uint8_t token;
485 tune_index_e tuneId;
486 } backAndText;
487 struct {
489 uint8_t activePage;
490 uint8_t nbPages;
492 uint8_t token;
493 uint8_t actionToken;
494 tune_index_e tuneId;
495 } progressAndBack;
496 struct {
497 const char *text;
498 } title;
499 struct {
500 const nbgl_icon_details_t *actionIcon;
501 const char *text;
502 const char *subText;
503 uint8_t textToken;
504 uint8_t backToken;
505 uint8_t actionToken;
506 tune_index_e tuneId;
507 } extendedBack;
508 struct {
509 const char *text;
510 uint8_t token;
511 tune_index_e tuneId;
512 } rightText;
513 };
515
531
536typedef struct {
539 union {
540 struct {
541 uint16_t height;
542 } emptySpace;
543 struct {
544 const char *text;
545 bool mutedOut;
546 uint8_t token;
547 tune_index_e tuneId;
548 } simpleText;
549 struct {
550 const char *leftText;
551 const char *rightText;
552 uint8_t leftToken;
553 uint8_t rightToken;
554 tune_index_e tuneId;
555 } doubleText;
556 struct {
558 const char *text;
559 uint8_t token;
560 tune_index_e tuneId;
561 } textAndNav;
562 nbgl_layoutNavigationBar_t navigation;
565 };
567
580
585typedef struct {
587 union {
588 struct {
589 const char *text;
590 uint8_t token;
591 tune_index_e tuneId;
592 } longPress;
597 struct {
598 const char *text;
599 uint8_t token;
600 tune_index_e tuneId;
601 } text;
602 };
604#else // HAVE_SE_TOUCH
609typedef enum {
612
616typedef struct {
617 const char *text;
618 const nbgl_icon_details_t *icon;
621
622#endif // HAVE_SE_TOUCH
623
629typedef struct {
630 uint8_t percentage;
631 const char *text;
632 const char *subText;
634
639typedef struct {
640 uint32_t keyMask;
646#ifdef HAVE_SE_TOUCH
648#else // HAVE_SE_TOUCH
649 bool enableBackspace;
650 bool enableValidate;
651 uint8_t selectedCharIndex;
652#endif // HAVE_SE_TOUCH
654
655/**********************
656 * GLOBAL PROTOTYPES
657 **********************/
662
663#ifdef HAVE_SE_TOUCH
665 const nbgl_icon_details_t *icon,
666 uint8_t token,
667 tune_index_e tuneId);
668int nbgl_layoutAddTouchableBar(nbgl_layout_t *layout, const nbgl_layoutBar_t *barLayout);
669int nbgl_layoutAddSwitch(nbgl_layout_t *layout, const nbgl_layoutSwitch_t *switchLayout);
670int nbgl_layoutAddText(nbgl_layout_t *layout, const char *text, const char *subText);
672 const char *text,
673 const char *subText,
674 uint8_t token,
675 uint8_t index);
682int nbgl_layoutAddLargeCaseText(nbgl_layout_t *layout, const char *text, bool grayedOut);
684 const char *title,
685 const char *description,
686 const char *info);
688
689int nbgl_layoutAddButton(nbgl_layout_t *layout, const nbgl_layoutButton_t *buttonInfo);
691 const char *text,
692 uint8_t token,
693 tune_index_e tuneId);
695 const char *text,
696 uint8_t token,
697 tune_index_e tuneId);
699 const char *leftText,
700 uint8_t leftToken,
701 const char *rightText,
702 uint8_t rightToken,
703 tune_index_e tuneId);
704int nbgl_layoutAddHeader(nbgl_layout_t *layout, const nbgl_layoutHeader_t *headerDesc);
706int nbgl_layoutAddUpFooter(nbgl_layout_t *layout, const nbgl_layoutUpFooter_t *upFooterDesc);
709 const nbgl_icon_details_t *icon,
710 uint8_t token,
711 bool separationLine,
712 tune_index_e tuneId);
714 uint8_t activePage,
715 uint8_t nbPages,
716 bool withBack,
717 uint8_t backToken,
718 tune_index_e tuneId);
720 const char *text,
721 const char *subText,
722 uint8_t percentage);
724 const char *text,
725 const char *subText,
726 uint8_t initPosition);
728 const char *text,
729 const char *subText,
730 uint8_t position);
732 uint16_t swipesMask,
733 const char *text,
734 uint8_t token,
735 tune_index_e tuneId);
737#else // HAVE_SE_TOUCH
739 const char *text,
740 const char *subText,
743int nbgl_layoutAddNavigation(nbgl_layout_t *layout, nbgl_layoutNavigation_t *info);
744int nbgl_layoutAddMenuList(nbgl_layout_t *layout, nbgl_layoutMenuList_t *list);
745int nbgl_layoutAddButton(nbgl_layout_t *layout, const nbgl_layoutButton_t *buttonInfo);
746int nbgl_layoutAddSwitch(nbgl_layout_t *layout, const nbgl_layoutSwitch_t *switchLayout);
747#endif // HAVE_SE_TOUCH
748
749#ifdef NBGL_KEYBOARD
750/* layout objects for page with keyboard */
751int nbgl_layoutAddKeyboard(nbgl_layout_t *layout, const nbgl_layoutKbd_t *kbdInfo);
752#ifdef HAVE_SE_TOUCH
754 uint8_t index,
755 uint32_t keyMask,
756 bool updateCasing,
757 keyboardCase_t casing);
758bool nbgl_layoutKeyboardNeedsRefresh(nbgl_layout_t *layout, uint8_t index);
760 uint8_t nbUsedButtons,
761 const char *buttonTexts[NB_MAX_SUGGESTION_BUTTONS],
762 int firstButtonToken,
763 tune_index_e tuneId);
764DEPRECATED int nbgl_layoutAddEnteredText(nbgl_layout_t *layout,
765 bool numbered,
766 uint8_t number,
767 const char *text,
768 bool grayedOut,
769 int offsetY,
770 int token);
771DEPRECATED int nbgl_layoutUpdateEnteredText(nbgl_layout_t *layout,
772 uint8_t index,
773 bool numbered,
774 uint8_t number,
775 const char *text,
776 bool grayedOut);
778 bool active,
779 const char *text,
780 int token,
781 tune_index_e tuneId);
783 uint8_t index,
784 bool active,
785 const char *text);
788#else // HAVE_SE_TOUCH
789int nbgl_layoutUpdateKeyboard(nbgl_layout_t *layout, uint8_t index, uint32_t keyMask);
790int nbgl_layoutAddEnteredText(nbgl_layout_t *layout, const char *text, bool lettersOnly);
791int nbgl_layoutUpdateEnteredText(nbgl_layout_t *layout, uint8_t index, const char *text);
792#endif // HAVE_SE_TOUCH
793#endif // NBGL_KEYBOARD
794
795#ifdef NBGL_KEYPAD
796#ifdef HAVE_SE_TOUCH
797/* layout objects for page with keypad (Stax) */
798int nbgl_layoutAddKeypad(nbgl_layout_t *layout, keyboardCallback_t callback, bool shuffled);
800 uint8_t index,
801 bool enableValidate,
802 bool enableBackspace,
803 bool enableDigits);
804int nbgl_layoutUpdateKeypadValidation(nbgl_layout_t *layout, bool softValidation);
805DEPRECATED int nbgl_layoutAddHiddenDigits(nbgl_layout_t *layout, uint8_t nbDigits);
806DEPRECATED int nbgl_layoutUpdateHiddenDigits(nbgl_layout_t *layout,
807 uint8_t index,
808 uint8_t nbActive);
810 const char *title,
811 bool hidden,
812 uint8_t nbDigits,
813 const char *text);
815 bool hidden,
816 uint8_t nbActiveDigits,
817 const char *text);
818
819#else // HAVE_SE_TOUCH
820/* layout objects for pages with keypad (nanos) */
822 keyboardCallback_t callback,
823 const char *text,
824 bool shuffled);
826 uint8_t index,
827 bool enableValidate,
828 bool enableBackspace);
829int nbgl_layoutAddHiddenDigits(nbgl_layout_t *layout, uint8_t nbDigits);
830int nbgl_layoutUpdateHiddenDigits(nbgl_layout_t *layout, uint8_t index, uint8_t nbActive);
832 bool hidden,
833 uint8_t nbDigits,
834 const char *text);
836 bool hidden,
837 uint8_t nbActiveDigits,
838 const char *text);
839#endif // HAVE_SE_TOUCH
840#endif // NBGL_KEYPAD
841
842/* generic functions */
843int nbgl_layoutDraw(nbgl_layout_t *layout);
845
846/**********************
847 * MACROS
848 **********************/
849
850#ifdef __cplusplus
851} /* extern "C" */
852#endif
853
854#endif /* NBGL_LAYOUT_H */
common content for Graphical Library
nbgl_contentCenteredInfoStyle_t
possible styles for Centered Info Area
void(* nbgl_layoutTouchCallback_t)(int token, uint8_t index)
prototype of function to be called when an object is touched
int nbgl_layoutAddTagValueList(nbgl_layout_t *layout, const nbgl_layoutTagValueList_t *list)
Creates a list of [tag,value] pairs.
int nbgl_layoutAddContentCenter(nbgl_layout_t *layout, const nbgl_contentCenter_t *info)
Creates an area on the center of the main panel, with a possible icon, and possible texts under it.
DEPRECATED int nbgl_layoutAddEnteredText(nbgl_layout_t *layout, bool numbered, uint8_t number, const char *text, bool grayedOut, int offsetY, int token)
Adds a "text entry" area under the previously entered object. This area can be preceded (beginning of...
int nbgl_layoutAddUpFooter(nbgl_layout_t *layout, const nbgl_layoutUpFooter_t *upFooterDesc)
Creates a touchable area on top of the footer of the screen, containing various controls,...
int nbgl_layoutUpdateKeyboard(nbgl_layout_t *layout, uint8_t index, uint32_t keyMask, bool updateCasing, keyboardCase_t casing)
Updates an existing keyboard on bottom of the screen, with the given configuration.
DEPRECATED int nbgl_layoutAddConfirmationButton(nbgl_layout_t *layout, bool active, const char *text, int token, tune_index_e tuneId)
Adds a black full width confirmation button on top of the previously added keyboard.
int nbgl_layoutAddKeyboard(nbgl_layout_t *layout, const nbgl_layoutKbd_t *kbdInfo)
Creates a keyboard on bottom of the screen, with the given configuration.
int nbgl_layoutAddTextContent(nbgl_layout_t *layout, const char *title, const char *description, const char *info)
Creates in the main container three text areas:
nbgl_layoutNavDirection_t
possible directions for Navigation arrows
@ VERTICAL_NAV
'\/' and '/\' are displayed, to navigate in a list (vertical scrolling)
@ HORIZONTAL_NAV
'<' and '>' are displayed, to navigate between pages and steps
int nbgl_layoutAddText(nbgl_layout_t *layout, const char *text, const char *subText)
Creates an area with given text (in bold) and sub text (in regular)
nbgl_contentRadioChoice_t nbgl_layoutRadioChoice_t
Deprecated, kept for retro compatibility.
nbgl_layoutNavIndication_t
possible styles for Navigation arrows (it's a bit field)
@ NO_ARROWS
@ LEFT_ARROW
left arrow is used
@ RIGHT_ARROW
right arrow is used
int nbgl_layoutUpdateKeypad(nbgl_layout_t *layout, uint8_t index, bool enableValidate, bool enableBackspace, bool enableDigits)
Updates an existing keypad on bottom of the screen, with the given configuration.
int nbgl_layoutAddProgressIndicator(nbgl_layout_t *layout, uint8_t activePage, uint8_t nbPages, bool withBack, uint8_t backToken, tune_index_e tuneId)
Creates a kind of navigation bar with an optional <- arrow on the left. This widget is placed on top ...
DEPRECATED int nbgl_layoutAddHiddenDigits(nbgl_layout_t *layout, uint8_t nbDigits)
Adds a placeholder for hidden digits on top of a keypad, to represent the entered digits,...
int nbgl_layoutAddNavigationBar(nbgl_layout_t *layout, const nbgl_layoutNavigationBar_t *info)
Creates a navigation bar on bottom of main container.
int nbgl_layoutAddKeyboardContent(nbgl_layout_t *layout, nbgl_layoutKeyboardContent_t *content)
Adds an area containing a potential title, a text entry and either confirmation or suggestion buttons...
int nbgl_layoutAddSeparationLine(nbgl_layout_t *layout)
adds a separation line on bottom of the last added item
int nbgl_layoutAddQRCode(nbgl_layout_t *layout, const nbgl_layoutQRCode_t *info)
Creates an area on the center of the main panel, with a QRCode, a possible text in black (bold) under...
int nbgl_layoutAddRadioChoice(nbgl_layout_t *layout, const nbgl_layoutRadioChoice_t *choices)
Creates a list of radio buttons (on the right)
int nbgl_layoutAddCenteredInfo(nbgl_layout_t *layout, const nbgl_layoutCenteredInfo_t *info)
Creates an area on the center of the main panel, with a possible icon/image, a possible text in black...
int nbgl_layoutUpdateKeypadValidation(nbgl_layout_t *layout, bool softValidation)
Updates an existing keypad on bottom of the screen, with the given configuration, without redraw.
nbgl_contentSwitch_t nbgl_layoutSwitch_t
Deprecated, kept for retro compatibility.
int nbgl_layoutAddSplitFooter(nbgl_layout_t *layout, const char *leftText, uint8_t leftToken, const char *rightText, uint8_t rightToken, tune_index_e tuneId)
Creates 2 touchable texts at the footer of the screen, separated with a thin line from the rest of th...
int nbgl_layoutAddTextWithAlias(nbgl_layout_t *layout, const char *text, const char *subText, uint8_t token, uint8_t index)
Creates an area with given text (in bold) and sub text (in regular), with a ‍icon on right of text to...
int nbgl_layoutDraw(nbgl_layout_t *layout)
Applies given layout. The screen will be redrawn.
int nbgl_layoutAddTouchableBar(nbgl_layout_t *layout, const nbgl_layoutBar_t *barLayout)
Creates a touchable bar in main panel.
nbgl_layoutButtonStyle_t
The different styles for a button.
@ WHITE_BACKGROUND
rounded bordered button, with text/icon in black, on white background
@ NO_BORDER
simple clickable text, in black
@ LONG_PRESS
long press button, with progress indicator
@ BLACK_BACKGROUND
rounded bordered button, with text/icon in white, on black background
int nbgl_layoutAddTopRightButton(nbgl_layout_t *layout, const nbgl_icon_details_t *icon, uint8_t token, tune_index_e tuneId)
Creates a Top-right button in the top right corner of the top panel.
int nbgl_layoutInvertBackground(nbgl_layout_t *layout)
Inverts the background color (black instead of white)
nbgl_layoutUpFooterType_t
The different types of area on top of footer.
@ UP_FOOTER_TEXT
grayed-out text, for example "Tap to continue"
@ NB_UP_FOOTER_TYPES
@ UP_FOOTER_BUTTON
simple button
@ UP_FOOTER_LONG_PRESS
long-press button
@ UP_FOOTER_TIP_BOX
Tip-box.
@ UP_FOOTER_HORIZONTAL_BUTTONS
2 buttons, on the same line
int nbgl_layoutAddSwipe(nbgl_layout_t *layout, uint16_t swipesMask, const char *text, uint8_t token, tune_index_e tuneId)
Creates a swipe interaction on the main container.
void * nbgl_layout_t
type shared externally
int nbgl_layoutAddSwitch(nbgl_layout_t *layout, const nbgl_layoutSwitch_t *switchLayout)
Creates a switch with the given text and its state.
int nbgl_layoutAddHorizontalButtons(nbgl_layout_t *layout, const nbgl_layoutHorizontalButtons_t *info)
Creates two buttons to make a choice. Both buttons are mandatory The left one contains only an icon a...
nbgl_layoutHeaderType_t
The different types of extended header.
@ HEADER_TITLE
simple centered text
@ HEADER_BACK_AND_PROGRESS
optional back key and progress indicator (only on Stax)
@ HEADER_EMPTY
empty space, to have a better vertical centering of centered info
@ NB_HEADER_TYPES
@ HEADER_EXTENDED_BACK
back key, centered text and touchable key on the right
@ HEADER_BACK_AND_TEXT
back key and optional text
@ HEADER_RIGHT_TEXT
touchable text on the right, with a vertical separation line
@ HEADER_BACK_ICON_AND_TEXT
back key and optional icon and text
int nbgl_layoutUpdateKeyboardContent(nbgl_layout_t *layout, nbgl_layoutKeyboardContent_t *content)
Updates an area containing a potential title, a text entry and either confirmation or suggestion butt...
DEPRECATED int nbgl_layoutUpdateHiddenDigits(nbgl_layout_t *layout, uint8_t index, uint8_t nbActive)
Updates an existing set of hidden digits, with the given configuration.
const char *(* nbgl_menuListCallback_t)(uint8_t choiceIndex)
prototype of menu list item retrieval callback
int nbgl_layoutAddKeypadContent(nbgl_layout_t *layout, const char *title, bool hidden, uint8_t nbDigits, const char *text)
Adds an area with a title and a placeholder for hidden digits on top of a keypad, to represent the en...
int nbgl_layoutAddButton(nbgl_layout_t *layout, const nbgl_layoutButton_t *buttonInfo)
Creates a rounded button in the main container.
int nbgl_layoutUpdateKeypadContent(nbgl_layout_t *layout, bool hidden, uint8_t nbActiveDigits, const char *text)
Updates an existing set of hidden digits, with the given configuration.
nbgl_layout_t * nbgl_layoutGet(const nbgl_layoutDescription_t *description)
returns a layout of the given type. The layout is reset
int nbgl_layoutAddExtendedFooter(nbgl_layout_t *layout, const nbgl_layoutFooter_t *footerDesc)
Creates a touchable area at the footer of the screen, containing various controls,...
int nbgl_layoutAddLeftContent(nbgl_layout_t *layout, const nbgl_layoutLeftContent_t *info)
Creates an area with a title, and rows of icon + text, left aligned.
nbgl_layoutChoiceButtonsStyle_t
The different styles for a pair of buttons.
@ SOFT_ACTION_AND_FOOTER_STYLE
A white button on top of a footer, with a separation line.
@ BOTH_ROUNDED_STYLE
A black button on top of a white button.
@ ROUNDED_AND_FOOTER_STYLE
A black background button on top of a footer.
@ STRONG_ACTION_AND_FOOTER_STYLE
A black button on top of a footer, with a separation line.
int nbgl_layoutAddChoiceButtons(nbgl_layout_t *layout, const nbgl_layoutChoiceButtons_t *info)
Creates two buttons to make a choice. Both buttons are mandatory. Both buttons are full width,...
int nbgl_layoutAddSpinner(nbgl_layout_t *layout, const char *text, const char *subText, uint8_t initPosition)
Creates a centered (vertically & horizontally) spinner with a text under it.
int nbgl_layoutUpdateSpinner(nbgl_layout_t *layout, const char *text, const char *subText, uint8_t position)
Update an existing spinner (must be the only object of the layout)
int nbgl_layoutAddLongPressButton(nbgl_layout_t *layout, const char *text, uint8_t token, tune_index_e tuneId)
Creates a long press button in the main container.
struct nbgl_layoutDescription_s nbgl_layoutDescription_t
Structure containing all information when creating a layout. This structure must be passed as argumen...
int nbgl_layoutAddProgressBar(nbgl_layout_t *layout, const char *text, const char *subText, uint8_t percentage)
Creates an area in main panel to display a progress bar, with a title text and a subtext if needed.
int nbgl_layoutAddHeader(nbgl_layout_t *layout, const nbgl_layoutHeader_t *headerDesc)
Creates a touchable (or not) area at the header of the screen, containing various controls,...
int nbgl_layoutAddBottomButton(nbgl_layout_t *layout, const nbgl_icon_details_t *icon, uint8_t token, bool separationLine, tune_index_e tuneId)
Creates a centered button at bottom of main container.
nbgl_layoutKeyboardContentType_t
The different types of keyboard contents.
@ KEYBOARD_WITH_BUTTON
text entry area + confirmation button
@ KEYBOARD_WITH_SUGGESTIONS
text entry area + suggestion buttons
@ NB_KEYBOARD_CONTENT_TYPES
void(* nbgl_layoutButtonCallback_t)(nbgl_layout_t *layout, nbgl_buttonEvent_t event)
prototype of function to be called when buttons are touched on a screen
nbgl_layoutFooterType_t
The different types of extended footer.
@ FOOTER_SIMPLE_TEXT
simple touchable text in bold
@ FOOTER_NAV
navigation bar
@ FOOTER_SIMPLE_BUTTON
simple black or white button (see nbgl_layoutButtonStyle_t)
@ FOOTER_TEXT_AND_NAV
@ FOOTER_DOUBLE_TEXT
2 touchable texts in bold, separated by a vertical line (only on Stax)
@ NB_FOOTER_TYPES
@ FOOTER_EMPTY
empty space, to have a better vertical centering of centered info
@ FOOTER_CHOICE_BUTTONS
double buttons (see nbgl_layoutChoiceButtonsStyle_t)
int nbgl_layoutRelease(nbgl_layout_t *layout)
Release the layout obtained with nbgl_layoutGet()
DEPRECATED int nbgl_layoutAddSuggestionButtons(nbgl_layout_t *layout, uint8_t nbUsedButtons, const char *buttonTexts[NB_MAX_SUGGESTION_BUTTONS], int firstButtonToken, tune_index_e tuneId)
nbgl_contentTagValueList_t nbgl_layoutTagValueList_t
Deprecated, kept for retro compatibility.
DEPRECATED int nbgl_layoutUpdateEnteredText(nbgl_layout_t *layout, uint8_t index, bool numbered, uint8_t number, const char *text, bool grayedOut)
Updates an existing "text entry" area, created with nbgl_layoutAddEnteredText()
int nbgl_layoutAddFooter(nbgl_layout_t *layout, const char *text, uint8_t token, tune_index_e tuneId)
Creates a touchable text at the footer of the screen, separated with a thin line from the rest of the...
int nbgl_layoutAddKeypad(nbgl_layout_t *layout, keyboardCallback_t callback, bool shuffled)
Adds a keypad on bottom of the screen, with the associated callback.
int nbgl_layoutAddLargeCaseText(nbgl_layout_t *layout, const char *text, bool grayedOut)
Creates an area with given text in 32px font (in Black or Light Gray)
bool nbgl_layoutKeyboardNeedsRefresh(nbgl_layout_t *layout, uint8_t index)
function called to know whether the keyboard has been redrawn and needs a refresh
DEPRECATED int nbgl_layoutUpdateConfirmationButton(nbgl_layout_t *layout, uint8_t index, bool active, const char *text)
Updates an existing black full width confirmation button on top of the previously added keyboard.
nbgl_contentTagValue_t nbgl_layoutTagValue_t
Deprecated, kept for retro compatibility.
nbgl_contentCenteredInfo_t nbgl_layoutCenteredInfo_t
Deprecated, kept for retro compatibility.
API to draw all basic graphic objects.
keyboardCase_t
Letters casing in which to open/set the keyboard.
Definition nbgl_obj.h:616
nbgl_buttonEvent_t
Definition nbgl_obj.h:307
keyboardMode_t
Mode in which to open/set the keyboard.
Definition nbgl_obj.h:599
void(* keyboardCallback_t)(char touchedKey)
prototype of function to be called when a valid key is pressed on keyboard Backspace is equal to 0x8 ...
Definition nbgl_obj.h:593
API to manage screens.
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.
This structure contains info to build a centered (vertically and horizontally) area,...
This structure contains info to build a centered (vertically and horizontally) area,...
This structure contains a list of names to build a list of radio buttons (on the right part of screen...
This structure contains info to build a switch (on the right) with a description (on the left),...
This structure contains a list of [tag,value] pairs.
This structure contains a [tag,value] pair and possible extensions.
This structure contains data to build a tip-box, on top of a footer, on bottom of a content center.
This structure contains info to build a clickable "bar" with a text and an icon.
bool inactive
if set to true, the bar is grayed-out and cannot be touched
const char * text
text (can be NULL)
uint8_t token
the token that will be used as argument of the callback
bool large
set to true only for the main level of OS settings
const char * subText
sub text (can be NULL)
bool centered
DEPRECATED, not used.
tune_index_e tuneId
if not NBGL_NO_TUNE, a tune will be played
const nbgl_icon_details_t * iconLeft
a buffer containing the 1BPP icon for icon on left (can be NULL)
const nbgl_icon_details_t * iconRight
This structure contains info to build a single button.
tune_index_e tuneId
if not NBGL_NO_TUNE, a tune will be played
const char * text
button text
uint8_t token
the token that will be used as argument of the callback
const nbgl_icon_details_t * icon
a buffer containing the 1BPP icon for button
nbgl_layoutButtonStyle_t style
bool fittingContent
if set to true, fit the width of button to text, otherwise full width
This structure contains info to build a pair of buttons, one on top of the other.
nbgl_layoutChoiceButtonsStyle_t style
the style of the pair
const nbgl_icon_details_t * topIcon
icon of top button
uint8_t token
the token that will be used as argument of the callback
const char * topText
up-button text (index 0)
tune_index_e tuneId
if not NBGL_NO_TUNE, a tune will be played
const char * bottomText
bottom-button text (index 1)
This structure contains info to build a confirmation button.
int token
token of the button
const char * text
text of the button
bool active
if true, button is active, otherwise inactive (grayed-out)
Structure containing all information when creating a layout. This structure must be passed as argumen...
nbgl_screenTickerConfiguration_t ticker
const char * tapActionText
Light gray text used when main container is "tapable".
nbgl_layoutTouchCallback_t onActionCallback
the callback to be called on any action on the layout
This structure contains info to build an extended footer.
nbgl_layoutChoiceButtons_t choiceButtons
if type is FOOTER_CHOICE_BUTTONS
bool separationLine
if true, a separation line is added at the top of this control
const char * leftText
nbgl_layoutButton_t button
if type is FOOTER_SIMPLE_BUTTON
bool mutedOut
if true, text is displayed in gray
nbgl_layoutFooterType_t type
type of footer
nbgl_layoutNavigationBar_t navigation
if type is FOOTER_NAV
const char * rightText
const char * text
tune_index_e tuneId
This structure contains info to build a header.
nbgl_layoutHeaderType_t type
type of header
const nbgl_icon_details_t * icon
icon on left of text (only if HEADER_BACK_ICON_AND_TEXT)
uint8_t backToken
when back key is pressed
const char * subText
text under the line (can be NULL)
const nbgl_icon_details_t * actionIcon
right button icon
uint8_t actionToken
when optional right button is pressed
bool separationLine
if true, a separation line is added at the bottom of this control
tune_index_e tuneId
when back key is pressed
const char * text
can be NULL if no text
uint8_t textToken
when text is touched
uint8_t token
when back key is pressed
This structure contains info to build a pair of buttons, the small one, with icon,...
tune_index_e tuneId
if not NBGL_NO_TUNE, a tune will be played
const nbgl_icon_details_t * leftIcon
a buffer containing the 1BPP icon for left button
uint8_t leftToken
the token used when left button is pressed
uint8_t rightToken
the token used when right button is pressed
const char * rightText
right-button text
This structure contains info to build a keyboard with nbgl_layoutAddKeyboard()
bool lettersOnly
if true, only display letter keys and Backspace
keyboardCallback_t callback
function called when an active key is pressed
keyboardMode_t mode
keyboard mode to start with
keyboardCase_t casing
keyboard casing mode (lower, upper once or upper locked)
This structure contains info to build a keyboard content (controls that are linked to keyboard)
uint8_t number
if numbered is true, number used to build 'number.' text
const char * text
already entered text
tune_index_e tuneId
if not NBGL_NO_TUNE, a tune will be played
nbgl_layoutKeyboardContentType_t type
type of content
nbgl_layoutSuggestionButtons_t suggestionButtons
nbgl_layoutConfirmationButton_t confirmationButton
used if type is KEYBOARD_WITH_SUGGESTIONS
const char * title
centered title explaining the screen
bool numbered
if set to true, the text is preceded on the left by 'number.'
bool grayedOut
(unused, kept for compatibility)
This structure contains info to build a left content area.
uint8_t nbRows
number of rows in the area
const char * title
title of area in bold
const nbgl_icon_details_t ** rowIcons
array of nbRows icon
const char ** rowTexts
array of nbRows texts (displayed in regular)
This structure contains a list of names to build a menu list on Nanos, with for each item a descripti...
nbgl_menuListCallback_t callback
function to call to retrieve a menu list item text
uint8_t nbChoices
total number of choices in the menu list
uint8_t selectedChoice
index of the selected choice (centered, in bold)
This structure contains info to build a navigation bar at the bottom of the screen.
uint8_t activePage
index of active page (from 0 to nbPages-1).
tune_index_e tuneId
if not NBGL_NO_TUNE, a tune will be played when pressing keys)
bool withBackKey
if set to true, the "back" key is drawn
bool withExitKey
if set to true, an exit button is drawn (X on the left)
uint8_t token
the token that will be used as argument of the callback
uint8_t nbPages
number of pages. (if 0, no navigation)
This structure contains info to build a navigation bar at the bottom of the screen.
nbgl_layoutNavDirection_t direction
vertical or horizontal navigation
nbgl_layoutNavIndication_t indication
specifies which arrows to use (left or right)
This structure contains info to build a progress bar with info. The progress bar itself is 120px widt...
uint8_t percentage
percentage of completion, from 0 to 100.
const char * text
text in black, on top of progress bar
const char * subText
text in gray, under progress bar
This structure contains info to build a centered (vertically and horizontally) area,...
const char * text2
second text (can be null)
const char * text1
first text (can be null)
const char * url
URL for QR code.
bool largeText1
if set to true, use 32px font for text1
int16_t offsetY
vertical shift to apply to this info (if > 0, shift to bottom)
bool centered
if set to true, center vertically
This structure contains info to build suggestion buttons.
uint8_t nbUsedButtons
the number of actually used buttons
const char ** buttons
array of 4 strings for buttons (last ones can be NULL)
This structure contains info to build an up-footer (area on top of footer).
nbgl_layoutButton_t button
if type is UP_FOOTER_BUTTON
tune_index_e tuneId
tune played when button is long-pressed
nbgl_contentTipBox_t tipBox
if type is UP_FOOTER_TIP_BOX
const char * text
text in the long-press button
nbgl_layoutUpFooterType_t type
type of up-footer
uint8_t token
token used when button is long-pressed
nbgl_layoutHorizontalButtons_t horizontalButtons
if type is UP_FOOTER_HORIZONTAL_BUTTONS