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#ifdef HAVE_PIEZO_SOUND
19#include "os_io_seproxyhal.h"
20#endif
21
22/*********************
23 * INCLUDES
24 *********************/
25
26/*********************
27 * DEFINES
28 *********************/
29#define NBGL_NO_TUNE NB_TUNES
30#define NBGL_NO_PROGRESS_INDICATOR 0xFF
31
33#define NBGL_INVALID_TOKEN 0xFF
34
35#ifdef HAVE_SE_TOUCH
38#define EXIT_PAGE 0xFF
39
40#if defined(TARGET_STAX)
41#define NB_MAX_SUGGESTION_BUTTONS 12
42// only 4 buttons are visible at the same time on Stax
43#define NB_MAX_VISIBLE_SUGGESTION_BUTTONS 4
44#define TOUCHABLE_HEADER_BAR_HEIGHT 88
45#define TOUCHABLE_MAIN_BAR_HEIGHT 96
46#define TOUCHABLE_BAR_HEIGHT 96
47#define SMALL_FOOTER_HEIGHT 88
48#define SIMPLE_FOOTER_HEIGHT 92
49#define SMALL_CENTERING_HEADER 32
50#define MEDIUM_CENTERING_HEADER 56
51#define MEDIUM_CENTERING_FOOTER 88
52#define LONG_PRESS_BUTTON_HEIGHT 128
53
54#define PRE_TEXT_MARGIN 32
55#define TEXT_SUBTEXT_MARGIN 16
56#define PRE_SUBTEXT_MARGIN 24
57#define POST_SUBTEXT_MARGIN 28
58
59#define PRE_TAG_VALUE_MARGIN 24
60#define INTER_TAG_VALUE_MARGIN 12
61#elif defined(TARGET_FLEX)
62#define NB_MAX_SUGGESTION_BUTTONS 8
63// only 2 buttons are visible at the same time on Flex
64#define NB_MAX_VISIBLE_SUGGESTION_BUTTONS 2
65#define TOUCHABLE_HEADER_BAR_HEIGHT 96
66#define TOUCHABLE_MAIN_BAR_HEIGHT 100
67#define TOUCHABLE_BAR_HEIGHT 92
68#define SMALL_FOOTER_HEIGHT 96
69#define SIMPLE_FOOTER_HEIGHT 96
70#define SMALL_CENTERING_HEADER 40
71#define MEDIUM_CENTERING_HEADER 64
72#define MEDIUM_CENTERING_FOOTER 64
73#define LONG_PRESS_BUTTON_HEIGHT 152
74
75#define PRE_TEXT_MARGIN 28
76#define TEXT_SUBTEXT_MARGIN 14
77#define PRE_SUBTEXT_MARGIN 26
78#define POST_SUBTEXT_MARGIN 26
79
80#define PRE_TAG_VALUE_MARGIN 0
81#define INTER_TAG_VALUE_MARGIN 24
82#else // TARGETS
83#error Undefined target
84#endif // TARGETS
85
86#define AVAILABLE_WIDTH (SCREEN_WIDTH - 2 * BORDER_MARGIN)
87
88#define NB_MAX_LINES NB_MAX_LINES_IN_DETAILS
89
90#else // HAVE_SE_TOUCH
91// 7 pixels on each side
92#define AVAILABLE_WIDTH (SCREEN_WIDTH - 2 * 7)
93// maximum number of lines in screen
94#define NB_MAX_LINES 4
95
96#endif // HAVE_SE_TOUCH
97
98#define SPINNER_FIXED 0xFF
99
100/**********************
101 * TYPEDEFS
102 **********************/
103
108typedef void *nbgl_layout_t;
109
116typedef void (*nbgl_layoutTouchCallback_t)(int token, uint8_t index);
117
124
130typedef struct {
143#ifdef HAVE_PIEZO_SOUND
144 tune_index_e tuneId;
145#endif // HAVE_PIEZO_SOUND
147
156
166
176
184 bool modal;
186#ifdef HAVE_SE_TOUCH
189 const char *tapActionText;
192#ifdef HAVE_PIEZO_SOUND
193 tune_index_e tapTuneId;
195#endif // HAVE_PIEZO_SOUND
198#else // HAVE_SE_TOUCH
201#endif // HAVE_SE_TOUCH
202 nbgl_screenTickerConfiguration_t ticker; // configuration of ticker (timeout)
204
209typedef struct {
212 const char *text;
215 const char *subText;
216 bool large;
218 bool inactive;
219 bool centered;
220#ifdef HAVE_PIEZO_SOUND
221 tune_index_e tuneId;
222#endif // HAVE_PIEZO_SOUND
224
230
235
241typedef const char *(*nbgl_menuListCallback_t)(uint8_t choiceIndex);
242
253
258
263
269
274typedef struct {
276 const char *title;
277 const char **rowTexts;
280
281#ifdef HAVE_SE_TOUCH
282
289typedef struct {
290 const char *url;
291 const char *text1;
292 const char *text2;
294 bool centered;
297
308
314typedef struct {
315 const char *topText;
316 const char *bottomText;
320#ifdef HAVE_PIEZO_SOUND
321 tune_index_e tuneId;
322#endif // HAVE_PIEZO_SOUND
324
331typedef struct {
333 const char *rightText;
336#ifdef HAVE_PIEZO_SOUND
337 tune_index_e tuneId;
338#endif // HAVE_PIEZO_SOUND
340
352
356typedef struct {
357 const char *text;
362 bool onBottom;
364#ifdef HAVE_PIEZO_SOUND
365 tune_index_e tuneId;
366#endif // HAVE_PIEZO_SOUND
368
378
388
392typedef struct {
393 const char *text;
394 int token;
395 bool active;
397
402typedef struct {
404 const char *title;
405 const char *text;
406 bool numbered;
411 union {
416 };
417#ifdef HAVE_PIEZO_SOUND
418 tune_index_e tuneId;
419#endif // HAVE_PIEZO_SOUND
421
436
441typedef struct {
444 union {
445 struct {
447 } emptySpace;
448 struct {
451 const char *text;
453 tune_index_e tuneId;
454 } backAndText;
455 struct {
460 uint8_t token;
462 tune_index_e tuneId;
463 } progressAndBack;
464 struct {
465 const char *text;
466 } title;
467 struct {
468 const nbgl_icon_details_t *actionIcon;
469 const char *text;
472 uint8_t actionToken;
473 tune_index_e tuneId;
474 } extendedBack;
475 struct {
476 const char *text;
477 uint8_t token;
478 tune_index_e tuneId;
479 } rightText;
480 };
482
498
503typedef struct {
506 union {
507 struct {
509 } emptySpace;
510 struct {
511 const char *text;
512 bool mutedOut;
514 tune_index_e tuneId;
515 } simpleText;
516 struct {
517 const char *leftText;
518 const char *rightText;
521 tune_index_e tuneId;
522 } doubleText;
523 struct {
525 const char *text;
526 uint8_t token;
527 tune_index_e tuneId;
528 } textAndNav;
529 nbgl_layoutNavigationBar_t navigation;
532 };
534
547
552typedef struct {
554 union {
555 struct {
556 const char *text;
558 tune_index_e tuneId;
559 } longPress;
564 struct {
565 const char *text;
566 uint8_t token;
567 tune_index_e tuneId;
568 } text;
569 };
571#else // HAVE_SE_TOUCH
576typedef enum {
579
583typedef struct {
584 const char *text;
585 const nbgl_icon_details_t *icon;
588
589#endif // HAVE_SE_TOUCH
590
596typedef struct {
598 const char *text;
599 const char *subText;
601
606typedef struct {
607 uint32_t keyMask;
613#ifdef HAVE_SE_TOUCH
615#else // HAVE_SE_TOUCH
616 bool enableBackspace;
617 bool enableValidate;
618 uint8_t selectedCharIndex;
619#endif // HAVE_SE_TOUCH
621
622/**********************
623 * GLOBAL PROTOTYPES
624 **********************/
630 const char *text,
631 const char *subText,
632 uint8_t percentage);
633
634#ifdef HAVE_SE_TOUCH
636 const nbgl_icon_details_t *icon,
637 uint8_t token,
638 tune_index_e tuneId);
639int nbgl_layoutAddTouchableBar(nbgl_layout_t *layout, const nbgl_layoutBar_t *barLayout);
640int nbgl_layoutAddSwitch(nbgl_layout_t *layout, const nbgl_layoutSwitch_t *switchLayout);
641int nbgl_layoutAddText(nbgl_layout_t *layout, const char *text, const char *subText);
643 const char *text,
644 const char *subText,
645 uint8_t token,
646 uint8_t index);
647int nbgl_layoutAddSubHeaderText(nbgl_layout_t *layout, const char *text);
654int nbgl_layoutAddLargeCaseText(nbgl_layout_t *layout, const char *text, bool grayedOut);
656 const char *title,
657 const char *description,
658 const char *info);
660
661int nbgl_layoutAddButton(nbgl_layout_t *layout, const nbgl_layoutButton_t *buttonInfo);
663 const char *text,
664 uint8_t token,
665 tune_index_e tuneId);
667 const char *text,
668 uint8_t token,
669 tune_index_e tuneId);
671 const char *leftText,
672 uint8_t leftToken,
673 const char *rightText,
674 uint8_t rightToken,
675 tune_index_e tuneId);
676int nbgl_layoutAddHeader(nbgl_layout_t *layout, const nbgl_layoutHeader_t *headerDesc);
678int nbgl_layoutAddUpFooter(nbgl_layout_t *layout, const nbgl_layoutUpFooter_t *upFooterDesc);
681 const nbgl_icon_details_t *icon,
682 uint8_t token,
683 bool separationLine,
684 tune_index_e tuneId);
686 uint8_t activePage,
687 uint8_t nbPages,
688 bool withBack,
689 uint8_t backToken,
690 tune_index_e tuneId);
692 const char *text,
693 const char *subText,
694 uint8_t percentage);
696 const char *text,
697 const char *subText,
698 uint8_t initPosition);
700 const char *text,
701 const char *subText,
702 uint8_t position);
704 uint16_t swipesMask,
705 const char *text,
706 uint8_t token,
707 tune_index_e tuneId);
708#else // HAVE_SE_TOUCH
710 const char *text,
711 const char *subText,
714int nbgl_layoutAddNavigation(nbgl_layout_t *layout, nbgl_layoutNavigation_t *info);
715int nbgl_layoutAddMenuList(nbgl_layout_t *layout, nbgl_layoutMenuList_t *list);
716int nbgl_layoutAddButton(nbgl_layout_t *layout, const nbgl_layoutButton_t *buttonInfo);
717int nbgl_layoutAddSwitch(nbgl_layout_t *layout, const nbgl_layoutSwitch_t *switchLayout);
718#endif // HAVE_SE_TOUCH
719
720#ifdef NBGL_KEYBOARD
721/* layout objects for page with keyboard */
722int nbgl_layoutAddKeyboard(nbgl_layout_t *layout, const nbgl_layoutKbd_t *kbdInfo);
723#ifdef HAVE_SE_TOUCH
725 uint8_t index,
726 uint32_t keyMask,
727 bool updateCasing,
728 keyboardCase_t casing);
731 uint8_t nbUsedButtons,
732 const char *buttonTexts[NB_MAX_SUGGESTION_BUTTONS],
733 int firstButtonToken,
734 tune_index_e tuneId);
736 nbgl_layout_t *layout,
737 uint8_t index,
738 uint8_t nbUsedButtons,
739 const char *buttonTexts[NB_MAX_SUGGESTION_BUTTONS]);
740DEPRECATED int nbgl_layoutAddEnteredText(nbgl_layout_t *layout,
741 bool numbered,
742 uint8_t number,
743 const char *text,
744 bool grayedOut,
745 int offsetY,
746 int token);
747DEPRECATED int nbgl_layoutUpdateEnteredText(nbgl_layout_t *layout,
748 uint8_t index,
749 bool numbered,
750 uint8_t number,
751 const char *text,
752 bool grayedOut);
754 bool active,
755 const char *text,
756 int token,
757 tune_index_e tuneId);
759 uint8_t index,
760 bool active,
761 const char *text);
764#else // HAVE_SE_TOUCH
765int nbgl_layoutUpdateKeyboard(nbgl_layout_t *layout, uint8_t index, uint32_t keyMask);
766int nbgl_layoutAddEnteredText(nbgl_layout_t *layout, const char *text, bool lettersOnly);
767int nbgl_layoutUpdateEnteredText(nbgl_layout_t *layout, uint8_t index, const char *text);
768#endif // HAVE_SE_TOUCH
769#endif // NBGL_KEYBOARD
770
771#ifdef NBGL_KEYPAD
772#ifdef HAVE_SE_TOUCH
773/* layout objects for page with keypad (Stax) */
774int nbgl_layoutAddKeypad(nbgl_layout_t *layout, keyboardCallback_t callback, bool shuffled);
776 uint8_t index,
777 bool enableValidate,
778 bool enableBackspace,
779 bool enableDigits);
780int nbgl_layoutUpdateKeypadValidation(nbgl_layout_t *layout, bool softValidation);
781DEPRECATED int nbgl_layoutAddHiddenDigits(nbgl_layout_t *layout, uint8_t nbDigits);
782DEPRECATED int nbgl_layoutUpdateHiddenDigits(nbgl_layout_t *layout,
783 uint8_t index,
784 uint8_t nbActive);
786 const char *title,
787 bool hidden,
788 uint8_t nbDigits,
789 const char *text);
791 bool hidden,
792 uint8_t nbActiveDigits,
793 const char *text);
794
795#else // HAVE_SE_TOUCH
796/* layout objects for pages with keypad (nanos) */
798 keyboardCallback_t callback,
799 const char *text,
800 bool shuffled);
802 uint8_t index,
803 bool enableValidate,
804 bool enableBackspace);
806int nbgl_layoutUpdateHiddenDigits(nbgl_layout_t *layout, uint8_t index, uint8_t nbActive);
808 bool hidden,
809 uint8_t nbDigits,
810 const char *text);
812 bool hidden,
813 uint8_t nbActiveDigits,
814 const char *text);
815#endif // HAVE_SE_TOUCH
816#endif // NBGL_KEYPAD
817
818/* generic functions */
819int nbgl_layoutDraw(nbgl_layout_t *layout);
821
822/**********************
823 * MACROS
824 **********************/
825
826#ifdef __cplusplus
827} /* extern "C" */
828#endif
829
830#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.
DEPRECATED int nbgl_layoutUpdateSuggestionButtons(nbgl_layout_t *layout, uint8_t index, uint8_t nbUsedButtons, const char *buttonTexts[NB_MAX_SUGGESTION_BUTTONS])
Updates the number and/or the text suggestion buttons created with nbgl_layoutAddSuggestionButtons()
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.
int nbgl_layoutUpdateProgressBar(nbgl_layout_t *layout, const char *text, const char *subText, uint8_t percentage)
Update an existing progress Bar (must be the only object of the layout)
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_layoutAddSubHeaderText(nbgl_layout_t *layout, const char *text)
Creates an area with given text in small regular font, under the header.
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.
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)
Adds up to 4 black suggestion buttons under the previously added object.
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:514
nbgl_buttonEvent_t
Definition nbgl_obj.h:207
keyboardMode_t
Mode in which to open/set the keyboard.
Definition nbgl_obj.h:497
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:491
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.
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.
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)
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 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,...
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
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
if true, the text is grayed out (but not the potential number)
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).
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
signed short int16_t
Definition usbd_conf.h:50
unsigned short uint16_t
Definition usbd_conf.h:54
unsigned char uint8_t
Definition usbd_conf.h:53