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#endif
20
21/*********************
22 * INCLUDES
23 *********************/
24
25/*********************
26 * DEFINES
27 *********************/
28#define NBGL_NO_TUNE NB_TUNES
29#define NBGL_NO_PROGRESS_INDICATOR 0xFF
30
32#define NBGL_INVALID_TOKEN 0xFF
33
34#ifdef HAVE_SE_TOUCH
37#define EXIT_PAGE 0xFF
38
39#if defined(TARGET_STAX)
40#define NB_MAX_SUGGESTION_BUTTONS 12
41// only 4 buttons are visible at the same time on Stax
42#define NB_MAX_VISIBLE_SUGGESTION_BUTTONS 4
43#define TOUCHABLE_HEADER_BAR_HEIGHT 88
44#define TOUCHABLE_MAIN_BAR_HEIGHT 96
45#define TOUCHABLE_BAR_HEIGHT 96
46#define SMALL_FOOTER_HEIGHT 88
47#define SIMPLE_FOOTER_HEIGHT 92
48#define SMALL_CENTERING_HEADER 32
49#define MEDIUM_CENTERING_HEADER 56
50#define MEDIUM_CENTERING_FOOTER 88
51#define LONG_PRESS_BUTTON_HEIGHT 128
52#define UP_FOOTER_BUTTON_HEIGHT 120
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// width & height for progress bar
62#define PROGRESSBAR_WIDTH 120
63#define PROGRESSBAR_HEIGHT 12
64#define BACK_KEY_WIDTH 88
65#elif defined(TARGET_FLEX)
66#define NB_MAX_SUGGESTION_BUTTONS 8
67// only 2 buttons are visible at the same time on Flex
68#define NB_MAX_VISIBLE_SUGGESTION_BUTTONS 2
69#define TOUCHABLE_HEADER_BAR_HEIGHT 96
70#define TOUCHABLE_MAIN_BAR_HEIGHT 100
71#define TOUCHABLE_BAR_HEIGHT 92
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 MEDIUM_CENTERING_FOOTER 64
77#define LONG_PRESS_BUTTON_HEIGHT 152
78#define UP_FOOTER_BUTTON_HEIGHT 136
79
80#define PRE_TEXT_MARGIN 28
81#define TEXT_SUBTEXT_MARGIN 14
82#define PRE_SUBTEXT_MARGIN 26
83#define POST_SUBTEXT_MARGIN 26
84
85#define PRE_TAG_VALUE_MARGIN 0
86#define INTER_TAG_VALUE_MARGIN 24
87// width & height for progress bar
88#define PROGRESSBAR_WIDTH 120
89#define PROGRESSBAR_HEIGHT 12
90#define BACK_KEY_WIDTH 104
91#else // TARGETS
92#error Undefined target
93#endif // TARGETS
94
95#define AVAILABLE_WIDTH (SCREEN_WIDTH - 2 * BORDER_MARGIN)
96
97// not really used
98#define NB_MAX_LINES 12
99
100#else // HAVE_SE_TOUCH
101// 7 pixels on each side
102#define AVAILABLE_WIDTH (SCREEN_WIDTH - 2 * 7)
103// maximum number of lines in screen
104#define NB_MAX_LINES 4
105
106#endif // HAVE_SE_TOUCH
107
108#define SPINNER_FIXED 0xFF
109
110/**********************
111 * TYPEDEFS
112 **********************/
113
118typedef void *nbgl_layout_t;
119
126typedef void (*nbgl_layoutTouchCallback_t)(int token, uint8_t index);
127
134
140typedef struct {
141 uint8_t token;
142 uint8_t nbPages;
143 uint8_t activePage;
153#ifdef HAVE_PIEZO_SOUND
154 tune_index_e tuneId;
155#endif // HAVE_PIEZO_SOUND
157
166
176
186
194 bool modal;
196#ifdef HAVE_SE_TOUCH
199 const char *tapActionText;
202#ifdef HAVE_PIEZO_SOUND
203 tune_index_e tapTuneId;
205#endif // HAVE_PIEZO_SOUND
208#else // HAVE_SE_TOUCH
211#endif // HAVE_SE_TOUCH
212 nbgl_screenTickerConfiguration_t ticker; // configuration of ticker (timeout)
214
219typedef struct {
222 const char *text;
225 const char *subText;
226 bool large;
227 uint8_t token;
228 bool inactive;
229 bool centered;
230#ifdef HAVE_PIEZO_SOUND
231 tune_index_e tuneId;
232#endif // HAVE_PIEZO_SOUND
234
240
245
251typedef const char *(*nbgl_menuListCallback_t)(uint8_t choiceIndex);
252
263
268
273
279
284typedef struct {
285 uint8_t nbRows;
286 const char *title;
287 const char **rowTexts;
290
291#ifdef HAVE_SE_TOUCH
292
299typedef struct {
300 const char *url;
301 const char *text1;
302 const char *text2;
303 int16_t offsetY;
304 bool centered;
307
318
324typedef struct {
325 const char *topText;
326 const char *bottomText;
328 uint8_t token;
330#ifdef HAVE_PIEZO_SOUND
331 tune_index_e tuneId;
332#endif // HAVE_PIEZO_SOUND
334
341typedef struct {
343 const char *rightText;
344 uint8_t leftToken;
345 uint8_t rightToken;
346#ifdef HAVE_PIEZO_SOUND
347 tune_index_e tuneId;
348#endif // HAVE_PIEZO_SOUND
350
362
366typedef struct {
367 const char *text;
369 uint8_t token;
372 bool onBottom;
374#ifdef HAVE_PIEZO_SOUND
375 tune_index_e tuneId;
376#endif // HAVE_PIEZO_SOUND
378
388
392typedef struct {
393 const char **buttons;
398
402typedef struct {
403 const char *text;
404 int token;
405 bool active;
407
412typedef struct {
414 const char *title;
415 const char *text;
416 bool numbered;
417 uint8_t number;
421 union {
426 };
427#ifdef HAVE_PIEZO_SOUND
428 tune_index_e tuneId;
429#endif // HAVE_PIEZO_SOUND
431
446
451typedef struct {
454 union {
455 struct {
456 uint16_t height;
457 } emptySpace;
458 struct {
461 const char *text;
462 uint8_t token;
463 tune_index_e tuneId;
464 } backAndText;
465 struct {
467 uint8_t activePage;
468 uint8_t nbPages;
470 uint8_t token;
471 uint8_t actionToken;
472 tune_index_e tuneId;
473 } progressAndBack;
474 struct {
475 const char *text;
476 } title;
477 struct {
478 const nbgl_icon_details_t *actionIcon;
479 const char *text;
480 uint8_t textToken;
481 uint8_t backToken;
482 uint8_t actionToken;
483 tune_index_e tuneId;
484 } extendedBack;
485 struct {
486 const char *text;
487 uint8_t token;
488 tune_index_e tuneId;
489 } rightText;
490 };
492
508
513typedef struct {
516 union {
517 struct {
518 uint16_t height;
519 } emptySpace;
520 struct {
521 const char *text;
522 bool mutedOut;
523 uint8_t token;
524 tune_index_e tuneId;
525 } simpleText;
526 struct {
527 const char *leftText;
528 const char *rightText;
529 uint8_t leftToken;
530 uint8_t rightToken;
531 tune_index_e tuneId;
532 } doubleText;
533 struct {
535 const char *text;
536 uint8_t token;
537 tune_index_e tuneId;
538 } textAndNav;
539 nbgl_layoutNavigationBar_t navigation;
542 };
544
557
562typedef struct {
564 union {
565 struct {
566 const char *text;
567 uint8_t token;
568 tune_index_e tuneId;
569 } longPress;
574 struct {
575 const char *text;
576 uint8_t token;
577 tune_index_e tuneId;
578 } text;
579 };
581#else // HAVE_SE_TOUCH
586typedef enum {
589
593typedef struct {
594 const char *text;
595 const nbgl_icon_details_t *icon;
598
599#endif // HAVE_SE_TOUCH
600
606typedef struct {
607 uint8_t percentage;
608 const char *text;
609 const char *subText;
611
616typedef struct {
617 uint32_t keyMask;
623#ifdef HAVE_SE_TOUCH
625#else // HAVE_SE_TOUCH
626 bool enableBackspace;
627 bool enableValidate;
628 uint8_t selectedCharIndex;
629#endif // HAVE_SE_TOUCH
631
632/**********************
633 * GLOBAL PROTOTYPES
634 **********************/
639
640#ifdef HAVE_SE_TOUCH
642 const nbgl_icon_details_t *icon,
643 uint8_t token,
644 tune_index_e tuneId);
645int nbgl_layoutAddTouchableBar(nbgl_layout_t *layout, const nbgl_layoutBar_t *barLayout);
646int nbgl_layoutAddSwitch(nbgl_layout_t *layout, const nbgl_layoutSwitch_t *switchLayout);
647int nbgl_layoutAddText(nbgl_layout_t *layout, const char *text, const char *subText);
649 const char *text,
650 const char *subText,
651 uint8_t token,
652 uint8_t index);
653int nbgl_layoutAddSubHeaderText(nbgl_layout_t *layout, const char *text);
660int nbgl_layoutAddLargeCaseText(nbgl_layout_t *layout, const char *text, bool grayedOut);
662 const char *title,
663 const char *description,
664 const char *info);
666
667int nbgl_layoutAddButton(nbgl_layout_t *layout, const nbgl_layoutButton_t *buttonInfo);
669 const char *text,
670 uint8_t token,
671 tune_index_e tuneId);
673 const char *text,
674 uint8_t token,
675 tune_index_e tuneId);
677 const char *leftText,
678 uint8_t leftToken,
679 const char *rightText,
680 uint8_t rightToken,
681 tune_index_e tuneId);
682int nbgl_layoutAddHeader(nbgl_layout_t *layout, const nbgl_layoutHeader_t *headerDesc);
684int nbgl_layoutAddUpFooter(nbgl_layout_t *layout, const nbgl_layoutUpFooter_t *upFooterDesc);
687 const nbgl_icon_details_t *icon,
688 uint8_t token,
689 bool separationLine,
690 tune_index_e tuneId);
692 uint8_t activePage,
693 uint8_t nbPages,
694 bool withBack,
695 uint8_t backToken,
696 tune_index_e tuneId);
698 const char *text,
699 const char *subText,
700 uint8_t percentage);
702 const char *text,
703 const char *subText,
704 uint8_t initPosition);
706 const char *text,
707 const char *subText,
708 uint8_t position);
710 uint16_t swipesMask,
711 const char *text,
712 uint8_t token,
713 tune_index_e tuneId);
714#else // HAVE_SE_TOUCH
716 const char *text,
717 const char *subText,
720int nbgl_layoutAddNavigation(nbgl_layout_t *layout, nbgl_layoutNavigation_t *info);
721int nbgl_layoutAddMenuList(nbgl_layout_t *layout, nbgl_layoutMenuList_t *list);
722int nbgl_layoutAddButton(nbgl_layout_t *layout, const nbgl_layoutButton_t *buttonInfo);
723int nbgl_layoutAddSwitch(nbgl_layout_t *layout, const nbgl_layoutSwitch_t *switchLayout);
724#endif // HAVE_SE_TOUCH
725
726#ifdef NBGL_KEYBOARD
727/* layout objects for page with keyboard */
728int nbgl_layoutAddKeyboard(nbgl_layout_t *layout, const nbgl_layoutKbd_t *kbdInfo);
729#ifdef HAVE_SE_TOUCH
731 uint8_t index,
732 uint32_t keyMask,
733 bool updateCasing,
734 keyboardCase_t casing);
735bool nbgl_layoutKeyboardNeedsRefresh(nbgl_layout_t *layout, uint8_t index);
737 uint8_t nbUsedButtons,
738 const char *buttonTexts[NB_MAX_SUGGESTION_BUTTONS],
739 int firstButtonToken,
740 tune_index_e tuneId);
742 nbgl_layout_t *layout,
743 uint8_t index,
744 uint8_t nbUsedButtons,
745 const char *buttonTexts[NB_MAX_SUGGESTION_BUTTONS]);
746DEPRECATED int nbgl_layoutAddEnteredText(nbgl_layout_t *layout,
747 bool numbered,
748 uint8_t number,
749 const char *text,
750 bool grayedOut,
751 int offsetY,
752 int token);
753DEPRECATED int nbgl_layoutUpdateEnteredText(nbgl_layout_t *layout,
754 uint8_t index,
755 bool numbered,
756 uint8_t number,
757 const char *text,
758 bool grayedOut);
760 bool active,
761 const char *text,
762 int token,
763 tune_index_e tuneId);
765 uint8_t index,
766 bool active,
767 const char *text);
770#else // HAVE_SE_TOUCH
771int nbgl_layoutUpdateKeyboard(nbgl_layout_t *layout, uint8_t index, uint32_t keyMask);
772int nbgl_layoutAddEnteredText(nbgl_layout_t *layout, const char *text, bool lettersOnly);
773int nbgl_layoutUpdateEnteredText(nbgl_layout_t *layout, uint8_t index, const char *text);
774#endif // HAVE_SE_TOUCH
775#endif // NBGL_KEYBOARD
776
777#ifdef NBGL_KEYPAD
778#ifdef HAVE_SE_TOUCH
779/* layout objects for page with keypad (Stax) */
780int nbgl_layoutAddKeypad(nbgl_layout_t *layout, keyboardCallback_t callback, bool shuffled);
782 uint8_t index,
783 bool enableValidate,
784 bool enableBackspace,
785 bool enableDigits);
786int nbgl_layoutUpdateKeypadValidation(nbgl_layout_t *layout, bool softValidation);
787DEPRECATED int nbgl_layoutAddHiddenDigits(nbgl_layout_t *layout, uint8_t nbDigits);
788DEPRECATED int nbgl_layoutUpdateHiddenDigits(nbgl_layout_t *layout,
789 uint8_t index,
790 uint8_t nbActive);
792 const char *title,
793 bool hidden,
794 uint8_t nbDigits,
795 const char *text);
797 bool hidden,
798 uint8_t nbActiveDigits,
799 const char *text);
800
801#else // HAVE_SE_TOUCH
802/* layout objects for pages with keypad (nanos) */
804 keyboardCallback_t callback,
805 const char *text,
806 bool shuffled);
808 uint8_t index,
809 bool enableValidate,
810 bool enableBackspace);
811int nbgl_layoutAddHiddenDigits(nbgl_layout_t *layout, uint8_t nbDigits);
812int nbgl_layoutUpdateHiddenDigits(nbgl_layout_t *layout, uint8_t index, uint8_t nbActive);
814 bool hidden,
815 uint8_t nbDigits,
816 const char *text);
818 bool hidden,
819 uint8_t nbActiveDigits,
820 const char *text);
821#endif // HAVE_SE_TOUCH
822#endif // NBGL_KEYPAD
823
824/* generic functions */
825int nbgl_layoutDraw(nbgl_layout_t *layout);
827
828/**********************
829 * MACROS
830 **********************/
831
832#ifdef __cplusplus
833} /* extern "C" */
834#endif
835
836#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.
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:516
nbgl_buttonEvent_t
Definition nbgl_obj.h:207
keyboardMode_t
Mode in which to open/set the keyboard.
Definition nbgl_obj.h:499
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:493
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