nbgl_use_case.h File Reference

API of the Advanced BOLOS Graphical Library, for typical application use-cases. More...

#include "nbgl_content.h"
#include "nbgl_page.h"

Include dependency graph for nbgl_use_case.h:

Go to the source code of this file.

Classes
struct	nbgl_genericContents_t
struct	nbgl_homeAction_t
	Structure describing the action button in Home Screen. More...
struct	nbgl_tipBox_t
	The necessary parameters to build a tip-box in first review page and the modal if this tip box is touched. More...
struct	nbgl_warningBarList_t
	The necessary parameters to build a list of touchable bars, to display sub-pages. More...
struct	nbgl_warningDetails_s
	The necessary parameters to build the page(s) displayed when the top-right button is touched in intro page (before review) More...
struct	nbgl_warning_t
	The necessary parameters to build a warning page preceding a review. One can either use predefinedSet when the warnings are already supported in nbgl_warningType_t list, or use introDetails or reviewDetails to configure manually the warning pages. More...

Macros
#define	FIRST_USER_TOKEN   20
	when using controls in page content (nbgl_pageContent_t), this is the first token value usable for these controls
#define	LAST_PAGE_FOR_REVIEW   0xFF
	value of page parameter used with navigation callback when "skip" button is touched, to display the long press button to confirm review.
#define	NB_MAX_DISPLAYED_PAIRS_IN_REVIEW   4
	maximum number of lines for value field in details pages
#define	TAG_VALUE_AREA_HEIGHT   (SCREEN_HEIGHT - SMALL_CENTERING_HEADER - SIMPLE_FOOTER_HEIGHT)
	height available for tag/value pairs display
#define	INFOS_AREA_HEIGHT   (SCREEN_HEIGHT - TOUCHABLE_HEADER_BAR_HEIGHT)
	height available for infos pairs display
#define	TAGLINE_PART1   "This app enables signing\ntransactions on the"
	Default strings used in the Home tagline.
#define	TAGLINE_PART2   "network."
#define	APP_DESCRIPTION_MAX_LEN   74
	Length of buffer used for the default Home tagline.
#define	MAX_APP_NAME_FOR_SDK_TAGLINE    (APP_DESCRIPTION_MAX_LEN - 1 - (sizeof(TAGLINE_PART1) + sizeof(TAGLINE_PART2)))
	Max supported length of appName used for the default Home tagline.
#define	INIT_HOME_PAGE   0xff
	Value to pass to nbgl_useCaseHomeAndSettings() initSettingPage parameter to initialize the use case on the Home page and not on a specific setting page.
#define	SKIPPABLE_OPERATION   (1 << 4)
	This is to use in nbgl_operationType_t when the operation is skippable. This is used.
#define	BLIND_OPERATION   (1 << 5)
	This is to use in nbgl_operationType_t when the operation is "blind" This is used to indicate a warning with a top-right button in review first & last page.
#define	nbgl_useCaseAddressConfirmation(__address, __callback)    nbgl_useCaseAddressConfirmationExt(__address, __callback, NULL)

Typedefs
typedef void(*	nbgl_callback_t) (void)
	prototype of generic callback function
typedef bool(*	nbgl_navCallback_t) (uint8_t page, nbgl_pageContent_t *content)
	prototype of navigation callback function
typedef void(*	nbgl_choiceCallback_t) (bool confirm)
	prototype of choice callback function
typedef void(*	nbgl_actionCallback_t) (uint8_t page)
	prototype of function to be called when an page of settings is double-pressed
typedef void(*	nbgl_pinValidCallback_t) (const uint8_t *pin, uint8_t pinLen)
	prototype of pin validation callback function
typedef void(*	nbgl_contentCallback_t) (uint8_t contentIndex, nbgl_content_t *content)
	prototype of content navigation callback function
typedef struct nbgl_warningDetails_s	nbgl_warningDetails_t
	The necessary parameters to build the page(s) displayed when the top-right button is touched in intro page (before review)
typedef uint32_t	nbgl_operationType_t
	This mask is used to describe the type of operation to review with additional options It is a mask of nbgl_opType_t [| SKIPPABLE_OPERATION] [| BLIND_OPERATION].

Enumerations
enum	nbgl_homeActionStyle_t { STRONG_HOME_ACTION = 0 , SOFT_HOME_ACTION }
	The different types of action button in Home Screen. More...
enum	nbgl_warningDetailsType_t { CENTERED_INFO_WARNING = 0 , QRCODE_WARNING , BAR_LIST_WARNING }
	The different types of warning page contents. More...
enum	nbgl_warningType_t {   W3C_ISSUE_WARN = 0 , W3C_RISK_DETECTED_WARN , W3C_THREAT_DETECTED_WARN , W3C_NO_THREAT_WARN ,   BLIND_SIGNING_WARN , NB_WARNING_TYPES }
	The different types of pre-defined warnings. More...
enum	nbgl_opType_t { TYPE_TRANSACTION = 0 , TYPE_MESSAGE , TYPE_OPERATION }
	The different types of operation to review. More...
enum	nbgl_reviewStatusType_t {   STATUS_TYPE_TRANSACTION_SIGNED = 0 , STATUS_TYPE_TRANSACTION_REJECTED , STATUS_TYPE_MESSAGE_SIGNED , STATUS_TYPE_MESSAGE_REJECTED ,   STATUS_TYPE_OPERATION_SIGNED , STATUS_TYPE_OPERATION_REJECTED , STATUS_TYPE_ADDRESS_VERIFIED , STATUS_TYPE_ADDRESS_REJECTED }
	The different types of review status. More...

Functions
void	nbgl_useCaseHomeAndSettings (const char *appName, const nbgl_icon_details_t *appIcon, const char *tagline, const uint8_t initSettingPage, const nbgl_genericContents_t *settingContents, const nbgl_contentInfoList_t *infosList, const nbgl_homeAction_t *action, nbgl_callback_t quitCallback)
void	nbgl_useCaseReview (nbgl_operationType_t operationType, const nbgl_contentTagValueList_t *tagValueList, const nbgl_icon_details_t *icon, const char *reviewTitle, const char *reviewSubTitle, const char *finishTitle, nbgl_choiceCallback_t choiceCallback)
void	nbgl_useCaseReviewBlindSigning (nbgl_operationType_t operationType, const nbgl_contentTagValueList_t *tagValueList, const nbgl_icon_details_t *icon, const char *reviewTitle, const char *reviewSubTitle, const char *finishTitle, const nbgl_tipBox_t *tipBox, nbgl_choiceCallback_t choiceCallback)
void	nbgl_useCaseAdvancedReview (nbgl_operationType_t operationType, const nbgl_contentTagValueList_t *tagValueList, const nbgl_icon_details_t *icon, const char *reviewTitle, const char *reviewSubTitle, const char *finishTitle, const nbgl_tipBox_t *tipBox, const nbgl_warning_t *warning, nbgl_choiceCallback_t choiceCallback)
void	nbgl_useCaseReviewLight (nbgl_operationType_t operationType, const nbgl_contentTagValueList_t *tagValueList, const nbgl_icon_details_t *icon, const char *reviewTitle, const char *reviewSubTitle, const char *finishTitle, nbgl_choiceCallback_t choiceCallback)
void	nbgl_useCaseAddressReview (const char *address, const nbgl_contentTagValueList_t *additionalTagValueList, const nbgl_icon_details_t *icon, const char *reviewTitle, const char *reviewSubTitle, nbgl_choiceCallback_t choiceCallback)
void	nbgl_useCaseReviewStatus (nbgl_reviewStatusType_t reviewStatusType, nbgl_callback_t quitCallback)
void	nbgl_useCaseReviewStreamingStart (nbgl_operationType_t operationType, const nbgl_icon_details_t *icon, const char *reviewTitle, const char *reviewSubTitle, nbgl_choiceCallback_t choiceCallback)
void	nbgl_useCaseReviewStreamingBlindSigningStart (nbgl_operationType_t operationType, const nbgl_icon_details_t *icon, const char *reviewTitle, const char *reviewSubTitle, nbgl_choiceCallback_t choiceCallback)
void	nbgl_useCaseAdvancedReviewStreamingStart (nbgl_operationType_t operationType, const nbgl_icon_details_t *icon, const char *reviewTitle, const char *reviewSubTitle, const nbgl_warning_t *warning, nbgl_choiceCallback_t choiceCallback)
void	nbgl_useCaseReviewStreamingContinueExt (const nbgl_contentTagValueList_t *tagValueList, nbgl_choiceCallback_t choiceCallback, nbgl_callback_t skipCallback)
void	nbgl_useCaseReviewStreamingContinue (const nbgl_contentTagValueList_t *tagValueList, nbgl_choiceCallback_t choiceCallback)
void	nbgl_useCaseReviewStreamingFinish (const char *finishTitle, nbgl_choiceCallback_t choiceCallback)
void	nbgl_useCaseGenericReview (const nbgl_genericContents_t *contents, const char *rejectText, nbgl_callback_t rejectCallback)
void	nbgl_useCaseGenericConfiguration (const char *title, uint8_t initPage, const nbgl_genericContents_t *contents, nbgl_callback_t quitCallback)
void	nbgl_useCaseGenericSettings (const char *appName, uint8_t initPage, const nbgl_genericContents_t *settingContents, const nbgl_contentInfoList_t *infosList, nbgl_callback_t quitCallback)
void	nbgl_useCaseChoice (const nbgl_icon_details_t *icon, const char *message, const char *subMessage, const char *confirmText, const char *rejectString, nbgl_choiceCallback_t callback)
void	nbgl_useCaseStatus (const char *message, bool isSuccess, nbgl_callback_t quitCallback)
void	nbgl_useCaseConfirm (const char *message, const char *subMessage, const char *confirmText, const char *rejectText, nbgl_callback_t callback)
void	nbgl_useCaseSpinner (const char *text)
void	nbgl_useCaseNavigableContent (const char *title, uint8_t initPage, uint8_t nbPages, nbgl_callback_t quitCallback, nbgl_navCallback_t navCallback, nbgl_layoutTouchCallback_t controlsCallback)
uint8_t	nbgl_useCaseGetNbTagValuesInPage (uint8_t nbPairs, const nbgl_contentTagValueList_t *tagValueList, uint8_t startIndex, bool *requireSpecificDisplay)
uint8_t	nbgl_useCaseGetNbTagValuesInPageExt (uint8_t nbPairs, const nbgl_contentTagValueList_t *tagValueList, uint8_t startIndex, bool isSkippable, bool *requireSpecificDisplay)
uint8_t	nbgl_useCaseGetNbInfosInPage (uint8_t nbInfos, const nbgl_contentInfoList_t *infosList, uint8_t startIndex, bool withNav)
uint8_t	nbgl_useCaseGetNbSwitchesInPage (uint8_t nbSwitches, const nbgl_contentSwitchesList_t *switchesList, uint8_t startIndex, bool withNav)
uint8_t	nbgl_useCaseGetNbBarsInPage (uint8_t nbBars, const nbgl_contentBarsList_t *barsList, uint8_t startIndex, bool withNav)
uint8_t	nbgl_useCaseGetNbChoicesInPage (uint8_t nbChoices, const nbgl_contentRadioChoice_t *choicesList, uint8_t startIndex, bool withNav)
uint8_t	nbgl_useCaseGetNbPagesForTagValueList (const nbgl_contentTagValueList_t *tagValueList)
DEPRECATED void	nbgl_useCaseHome (const char *appName, const nbgl_icon_details_t *appIcon, const char *tagline, bool withSettings, nbgl_callback_t topRightCallback, nbgl_callback_t quitCallback)
DEPRECATED void	nbgl_useCaseHomeExt (const char *appName, const nbgl_icon_details_t *appIcon, const char *tagline, bool withSettings, const char *actionButtonText, nbgl_callback_t actionCallback, nbgl_callback_t topRightCallback, nbgl_callback_t quitCallback)
DEPRECATED void	nbgl_useCaseSettings (const char *settingsTitle, uint8_t initPage, uint8_t nbPages, bool touchableTitle, nbgl_callback_t quitCallback, nbgl_navCallback_t navCallback, nbgl_layoutTouchCallback_t controlsCallback)
void	nbgl_useCaseReviewStart (const nbgl_icon_details_t *icon, const char *reviewTitle, const char *reviewSubTitle, const char *rejectText, nbgl_callback_t continueCallback, nbgl_callback_t rejectCallback)
DEPRECATED void	nbgl_useCaseRegularReview (uint8_t initPage, uint8_t nbPages, const char *rejectText, nbgl_layoutTouchCallback_t buttonCallback, nbgl_navCallback_t navCallback, nbgl_choiceCallback_t choiceCallback)
void	nbgl_useCaseStaticReview (const nbgl_contentTagValueList_t *tagValueList, const nbgl_pageInfoLongPress_t *infoLongPress, const char *rejectText, nbgl_choiceCallback_t callback)
void	nbgl_useCaseStaticReviewLight (const nbgl_contentTagValueList_t *tagValueList, const nbgl_pageInfoLongPress_t *infoLongPress, const char *rejectText, nbgl_choiceCallback_t callback)
DEPRECATED void	nbgl_useCaseAddressConfirmationExt (const char *address, nbgl_choiceCallback_t callback, const nbgl_contentTagValueList_t *tagValueList)
void	nbgl_useCaseKeypadDigits (const char *title, uint8_t minDigits, uint8_t maxDigits, uint8_t backToken, bool shuffled, tune_index_e tuneId, nbgl_pinValidCallback_t validatePinCallback, nbgl_layoutTouchCallback_t actionCallback)
void	nbgl_useCaseKeypadPIN (const char *title, uint8_t minDigits, uint8_t maxDigits, uint8_t backToken, bool shuffled, tune_index_e tuneId, nbgl_pinValidCallback_t validatePinCallback, nbgl_layoutTouchCallback_t actionCallback)

Detailed Description

API of the Advanced BOLOS Graphical Library, for typical application use-cases.

Definition in file nbgl_use_case.h.

Macro Definition Documentation

APP_DESCRIPTION_MAX_LEN

#define APP_DESCRIPTION_MAX_LEN   74

Length of buffer used for the default Home tagline.

Definition at line 84 of file nbgl_use_case.h.

BLIND_OPERATION

#define BLIND_OPERATION   (1 << 5)

This is to use in nbgl_operationType_t when the operation is "blind" This is used to indicate a warning with a top-right button in review first & last page.

Definition at line 301 of file nbgl_use_case.h.

FIRST_USER_TOKEN

#define FIRST_USER_TOKEN   20

when using controls in page content (nbgl_pageContent_t), this is the first token value usable for these controls

Definition at line 32 of file nbgl_use_case.h.

INFOS_AREA_HEIGHT

#define INFOS_AREA_HEIGHT   (SCREEN_HEIGHT - TOUCHABLE_HEADER_BAR_HEIGHT)

height available for infos pairs display

Definition at line 73 of file nbgl_use_case.h.

INIT_HOME_PAGE

#define INIT_HOME_PAGE   0xff

Value to pass to nbgl_useCaseHomeAndSettings() initSettingPage parameter to initialize the use case on the Home page and not on a specific setting page.

Definition at line 97 of file nbgl_use_case.h.

LAST_PAGE_FOR_REVIEW

#define LAST_PAGE_FOR_REVIEW   0xFF

value of page parameter used with navigation callback when "skip" button is touched, to display the long press button to confirm review.

Definition at line 38 of file nbgl_use_case.h.

MAX_APP_NAME_FOR_SDK_TAGLINE

#define MAX_APP_NAME_FOR_SDK_TAGLINE    (APP_DESCRIPTION_MAX_LEN - 1 - (sizeof(TAGLINE_PART1) + sizeof(TAGLINE_PART2)))

Max supported length of appName used for the default Home tagline.

Definition at line 89 of file nbgl_use_case.h.

NB_MAX_DISPLAYED_PAIRS_IN_REVIEW

#define NB_MAX_DISPLAYED_PAIRS_IN_REVIEW   4

maximum number of lines for value field in details pages

maximum number of lines for value field in review pages

maximum number of simultaneously displayed pairs in review pages. Can be useful when using nbgl_useCaseStaticReview() with the callback mechanism to retrieve the item/value pairs.

Definition at line 63 of file nbgl_use_case.h.

nbgl_useCaseAddressConfirmation

#define nbgl_useCaseAddressConfirmation	(		__address,
			__callback
	)		nbgl_useCaseAddressConfirmationExt(__address, __callback, NULL)

Definition at line 524 of file nbgl_use_case.h.

SKIPPABLE_OPERATION

#define SKIPPABLE_OPERATION   (1 << 4)

This is to use in nbgl_operationType_t when the operation is skippable. This is used.

Definition at line 294 of file nbgl_use_case.h.

TAG_VALUE_AREA_HEIGHT

#define TAG_VALUE_AREA_HEIGHT   (SCREEN_HEIGHT - SMALL_CENTERING_HEADER - SIMPLE_FOOTER_HEIGHT)

height available for tag/value pairs display

Definition at line 68 of file nbgl_use_case.h.

TAGLINE_PART1

#define TAGLINE_PART1   "This app enables signing\ntransactions on the"

Default strings used in the Home tagline.

Definition at line 78 of file nbgl_use_case.h.

TAGLINE_PART2

#define TAGLINE_PART2   "network."

Definition at line 79 of file nbgl_use_case.h.

Typedef Documentation

nbgl_actionCallback_t

typedef void(* nbgl_actionCallback_t) (uint8_t page)

prototype of function to be called when an page of settings is double-pressed

Parameters

page	page index (0->(nb_pages-1))

Definition at line 129 of file nbgl_use_case.h.

nbgl_callback_t

typedef void(* nbgl_callback_t) (void)

prototype of generic callback function

Definition at line 109 of file nbgl_use_case.h.

nbgl_choiceCallback_t

typedef void(* nbgl_choiceCallback_t) (bool confirm)

prototype of choice callback function

Parameters

confirm

if true, means that the confirmation button has been pressed

Definition at line 123 of file nbgl_use_case.h.

nbgl_contentCallback_t

typedef void(* nbgl_contentCallback_t) (uint8_t contentIndex, nbgl_content_t *content)

prototype of content navigation callback function

Parameters

contentIndex	content index (0->(nbContents-1)) that is needed by the lib
content	content to fill

Definition at line 143 of file nbgl_use_case.h.

nbgl_navCallback_t

typedef bool(* nbgl_navCallback_t) (uint8_t page, nbgl_pageContent_t *content)

prototype of navigation callback function

Parameters

page	page index (0->(nb_pages-1)) on which we go
content	content to fill (only type and union)

Returns

true if the page content is valid, false if no more page

Definition at line 117 of file nbgl_use_case.h.

nbgl_operationType_t

typedef uint32_t nbgl_operationType_t

This mask is used to describe the type of operation to review with additional options It is a mask of nbgl_opType_t [| SKIPPABLE_OPERATION] [| BLIND_OPERATION].

Definition at line 308 of file nbgl_use_case.h.

nbgl_pinValidCallback_t

typedef void(* nbgl_pinValidCallback_t) (const uint8_t *pin, uint8_t pinLen)

prototype of pin validation callback function

Parameters

pin	pin value
pinLen	pin length

Definition at line 136 of file nbgl_use_case.h.

nbgl_warningDetails_t

typedef struct nbgl_warningDetails_s nbgl_warningDetails_t

The necessary parameters to build the page(s) displayed when the top-right button is touched in intro page (before review)

Enumeration Type Documentation

nbgl_homeActionStyle_t

enum nbgl_homeActionStyle_t

The different types of action button in Home Screen.

Enumerator
STRONG_HOME_ACTION	Black button, implicating the main action of the App.
SOFT_HOME_ACTION	White button, more for extended features.

Definition at line 160 of file nbgl_use_case.h.

nbgl_opType_t

enum nbgl_opType_t

The different types of operation to review.

Enumerator
TYPE_TRANSACTION	For operations transferring a coin or taken from an account to another.
TYPE_MESSAGE	For operations signing a message that will not be broadcast on the blockchain
TYPE_OPERATION	For other types of operation (generic type)

Definition at line 281 of file nbgl_use_case.h.

nbgl_reviewStatusType_t

enum nbgl_reviewStatusType_t

The different types of review status.

Enumerator
STATUS_TYPE_TRANSACTION_SIGNED
STATUS_TYPE_TRANSACTION_REJECTED
STATUS_TYPE_MESSAGE_SIGNED
STATUS_TYPE_MESSAGE_REJECTED
STATUS_TYPE_OPERATION_SIGNED
STATUS_TYPE_OPERATION_REJECTED
STATUS_TYPE_ADDRESS_VERIFIED
STATUS_TYPE_ADDRESS_REJECTED

Definition at line 314 of file nbgl_use_case.h.

nbgl_warningDetailsType_t

enum nbgl_warningDetailsType_t

The different types of warning page contents.

Enumerator
CENTERED_INFO_WARNING	Centered info.
QRCODE_WARNING	QR Code.
BAR_LIST_WARNING	list of touchable bars, to display sub-pages

Definition at line 196 of file nbgl_use_case.h.

nbgl_warningType_t

enum nbgl_warningType_t

The different types of pre-defined warnings.

Enumerator
W3C_ISSUE_WARN	Web3 Checks issue (not available)
W3C_RISK_DETECTED_WARN	Web3 Checks: Risk detected (see reportRisk field)
W3C_THREAT_DETECTED_WARN	Web3 Checks: Threat detected (see reportRisk field)
W3C_NO_THREAT_WARN	Web3 Checks: No Threat detected.
BLIND_SIGNING_WARN	Blind signing.
NB_WARNING_TYPES

Definition at line 238 of file nbgl_use_case.h.

Function Documentation

nbgl_useCaseAddressConfirmationExt()

DEPRECATED void nbgl_useCaseAddressConfirmationExt	(	const char *	address,
		nbgl_choiceCallback_t	callback,
		const nbgl_contentTagValueList_t *	tagValueList
	)

nbgl_useCaseAddressReview()

void nbgl_useCaseAddressReview	(	const char *	address,
		const nbgl_contentTagValueList_t *	additionalTagValueList,
		const nbgl_icon_details_t *	icon,
		const char *	reviewTitle,
		const char *	reviewSubTitle,
		nbgl_choiceCallback_t	choiceCallback
	)

nbgl_useCaseAdvancedReview()

void nbgl_useCaseAdvancedReview	(	nbgl_operationType_t	operationType,
		const nbgl_contentTagValueList_t *	tagValueList,
		const nbgl_icon_details_t *	icon,
		const char *	reviewTitle,
		const char *	reviewSubTitle,
		const char *	finishTitle,
		const nbgl_tipBox_t *	tipBox,
		const nbgl_warning_t *	warning,
		nbgl_choiceCallback_t	choiceCallback
	)

nbgl_useCaseAdvancedReviewStreamingStart()

void nbgl_useCaseAdvancedReviewStreamingStart	(	nbgl_operationType_t	operationType,
		const nbgl_icon_details_t *	icon,
		const char *	reviewTitle,
		const char *	reviewSubTitle,
		const nbgl_warning_t *	warning,
		nbgl_choiceCallback_t	choiceCallback
	)

nbgl_useCaseChoice()

void nbgl_useCaseChoice	(	const nbgl_icon_details_t *	icon,
		const char *	message,
		const char *	subMessage,
		const char *	confirmText,
		const char *	rejectString,
		nbgl_choiceCallback_t	callback
	)

nbgl_useCaseConfirm()

void nbgl_useCaseConfirm	(	const char *	message,
		const char *	subMessage,
		const char *	confirmText,
		const char *	rejectText,
		nbgl_callback_t	callback
	)

nbgl_useCaseGenericConfiguration()

void nbgl_useCaseGenericConfiguration	(	const char *	title,
		uint8_t	initPage,
		const nbgl_genericContents_t *	contents,
		nbgl_callback_t	quitCallback
	)

nbgl_useCaseGenericReview()

void nbgl_useCaseGenericReview	(	const nbgl_genericContents_t *	contents,
		const char *	rejectText,
		nbgl_callback_t	rejectCallback
	)

nbgl_useCaseGenericSettings()

void nbgl_useCaseGenericSettings	(	const char *	appName,
		uint8_t	initPage,
		const nbgl_genericContents_t *	settingContents,
		const nbgl_contentInfoList_t *	infosList,
		nbgl_callback_t	quitCallback
	)

nbgl_useCaseGetNbBarsInPage()

uint8_t nbgl_useCaseGetNbBarsInPage	(	uint8_t	nbBars,
		const nbgl_contentBarsList_t *	barsList,
		uint8_t	startIndex,
		bool	withNav
	)

nbgl_useCaseGetNbChoicesInPage()

uint8_t nbgl_useCaseGetNbChoicesInPage	(	uint8_t	nbChoices,
		const nbgl_contentRadioChoice_t *	choicesList,
		uint8_t	startIndex,
		bool	withNav
	)

nbgl_useCaseGetNbInfosInPage()

uint8_t nbgl_useCaseGetNbInfosInPage	(	uint8_t	nbInfos,
		const nbgl_contentInfoList_t *	infosList,
		uint8_t	startIndex,
		bool	withNav
	)

nbgl_useCaseGetNbPagesForTagValueList()

uint8_t nbgl_useCaseGetNbPagesForTagValueList

(

const nbgl_contentTagValueList_t *

tagValueList

)

nbgl_useCaseGetNbSwitchesInPage()

uint8_t nbgl_useCaseGetNbSwitchesInPage	(	uint8_t	nbSwitches,
		const nbgl_contentSwitchesList_t *	switchesList,
		uint8_t	startIndex,
		bool	withNav
	)

nbgl_useCaseGetNbTagValuesInPage()

uint8_t nbgl_useCaseGetNbTagValuesInPage	(	uint8_t	nbPairs,
		const nbgl_contentTagValueList_t *	tagValueList,
		uint8_t	startIndex,
		bool *	requireSpecificDisplay
	)

nbgl_useCaseGetNbTagValuesInPageExt()

uint8_t nbgl_useCaseGetNbTagValuesInPageExt	(	uint8_t	nbPairs,
		const nbgl_contentTagValueList_t *	tagValueList,
		uint8_t	startIndex,
		bool	isSkippable,
		bool *	requireSpecificDisplay
	)

nbgl_useCaseHome()

DEPRECATED void nbgl_useCaseHome	(	const char *	appName,
		const nbgl_icon_details_t *	appIcon,
		const char *	tagline,
		bool	withSettings,
		nbgl_callback_t	topRightCallback,
		nbgl_callback_t	quitCallback
	)

nbgl_useCaseHomeAndSettings()

void nbgl_useCaseHomeAndSettings	(	const char *	appName,
		const nbgl_icon_details_t *	appIcon,
		const char *	tagline,
		const uint8_t	initSettingPage,
		const nbgl_genericContents_t *	settingContents,
		const nbgl_contentInfoList_t *	infosList,
		const nbgl_homeAction_t *	action,
		nbgl_callback_t	quitCallback
	)

nbgl_useCaseHomeExt()

DEPRECATED void nbgl_useCaseHomeExt	(	const char *	appName,
		const nbgl_icon_details_t *	appIcon,
		const char *	tagline,
		bool	withSettings,
		const char *	actionButtonText,
		nbgl_callback_t	actionCallback,
		nbgl_callback_t	topRightCallback,
		nbgl_callback_t	quitCallback
	)

nbgl_useCaseKeypadDigits()

void nbgl_useCaseKeypadDigits	(	const char *	title,
		uint8_t	minDigits,
		uint8_t	maxDigits,
		uint8_t	backToken,
		bool	shuffled,
		tune_index_e	tuneId,
		nbgl_pinValidCallback_t	validatePinCallback,
		nbgl_layoutTouchCallback_t	actionCallback
	)

nbgl_useCaseKeypadPIN()

void nbgl_useCaseKeypadPIN	(	const char *	title,
		uint8_t	minDigits,
		uint8_t	maxDigits,
		uint8_t	backToken,
		bool	shuffled,
		tune_index_e	tuneId,
		nbgl_pinValidCallback_t	validatePinCallback,
		nbgl_layoutTouchCallback_t	actionCallback
	)

nbgl_useCaseNavigableContent()

void nbgl_useCaseNavigableContent	(	const char *	title,
		uint8_t	initPage,
		uint8_t	nbPages,
		nbgl_callback_t	quitCallback,
		nbgl_navCallback_t	navCallback,
		nbgl_layoutTouchCallback_t	controlsCallback
	)

nbgl_useCaseRegularReview()

DEPRECATED void nbgl_useCaseRegularReview	(	uint8_t	initPage,
		uint8_t	nbPages,
		const char *	rejectText,
		nbgl_layoutTouchCallback_t	buttonCallback,
		nbgl_navCallback_t	navCallback,
		nbgl_choiceCallback_t	choiceCallback
	)

nbgl_useCaseReview()

void nbgl_useCaseReview	(	nbgl_operationType_t	operationType,
		const nbgl_contentTagValueList_t *	tagValueList,
		const nbgl_icon_details_t *	icon,
		const char *	reviewTitle,
		const char *	reviewSubTitle,
		const char *	finishTitle,
		nbgl_choiceCallback_t	choiceCallback
	)

nbgl_useCaseReviewBlindSigning()

void nbgl_useCaseReviewBlindSigning	(	nbgl_operationType_t	operationType,
		const nbgl_contentTagValueList_t *	tagValueList,
		const nbgl_icon_details_t *	icon,
		const char *	reviewTitle,
		const char *	reviewSubTitle,
		const char *	finishTitle,
		const nbgl_tipBox_t *	tipBox,
		nbgl_choiceCallback_t	choiceCallback
	)

nbgl_useCaseReviewLight()

void nbgl_useCaseReviewLight	(	nbgl_operationType_t	operationType,
		const nbgl_contentTagValueList_t *	tagValueList,
		const nbgl_icon_details_t *	icon,
		const char *	reviewTitle,
		const char *	reviewSubTitle,
		const char *	finishTitle,
		nbgl_choiceCallback_t	choiceCallback
	)

nbgl_useCaseReviewStart()

void nbgl_useCaseReviewStart	(	const nbgl_icon_details_t *	icon,
		const char *	reviewTitle,
		const char *	reviewSubTitle,
		const char *	rejectText,
		nbgl_callback_t	continueCallback,
		nbgl_callback_t	rejectCallback
	)

nbgl_useCaseReviewStatus()

void nbgl_useCaseReviewStatus	(	nbgl_reviewStatusType_t	reviewStatusType,
		nbgl_callback_t	quitCallback
	)

nbgl_useCaseReviewStreamingBlindSigningStart()

void nbgl_useCaseReviewStreamingBlindSigningStart	(	nbgl_operationType_t	operationType,
		const nbgl_icon_details_t *	icon,
		const char *	reviewTitle,
		const char *	reviewSubTitle,
		nbgl_choiceCallback_t	choiceCallback
	)

nbgl_useCaseReviewStreamingContinue()

void nbgl_useCaseReviewStreamingContinue	(	const nbgl_contentTagValueList_t *	tagValueList,
		nbgl_choiceCallback_t	choiceCallback
	)

nbgl_useCaseReviewStreamingContinueExt()

void nbgl_useCaseReviewStreamingContinueExt	(	const nbgl_contentTagValueList_t *	tagValueList,
		nbgl_choiceCallback_t	choiceCallback,
		nbgl_callback_t	skipCallback
	)

nbgl_useCaseReviewStreamingFinish()

void nbgl_useCaseReviewStreamingFinish	(	const char *	finishTitle,
		nbgl_choiceCallback_t	choiceCallback
	)

nbgl_useCaseReviewStreamingStart()

void nbgl_useCaseReviewStreamingStart	(	nbgl_operationType_t	operationType,
		const nbgl_icon_details_t *	icon,
		const char *	reviewTitle,
		const char *	reviewSubTitle,
		nbgl_choiceCallback_t	choiceCallback
	)

nbgl_useCaseSettings()

DEPRECATED void nbgl_useCaseSettings	(	const char *	settingsTitle,
		uint8_t	initPage,
		uint8_t	nbPages,
		bool	touchableTitle,
		nbgl_callback_t	quitCallback,
		nbgl_navCallback_t	navCallback,
		nbgl_layoutTouchCallback_t	controlsCallback
	)

nbgl_useCaseSpinner()

void nbgl_useCaseSpinner

(

const char *

text

)

nbgl_useCaseStaticReview()

void nbgl_useCaseStaticReview	(	const nbgl_contentTagValueList_t *	tagValueList,
		const nbgl_pageInfoLongPress_t *	infoLongPress,
		const char *	rejectText,
		nbgl_choiceCallback_t	callback
	)

nbgl_useCaseStaticReviewLight()

void nbgl_useCaseStaticReviewLight	(	const nbgl_contentTagValueList_t *	tagValueList,
		const nbgl_pageInfoLongPress_t *	infoLongPress,
		const char *	rejectText,
		nbgl_choiceCallback_t	callback
	)

nbgl_useCaseStatus()

void nbgl_useCaseStatus	(	const char *	message,
		bool	isSuccess,
		nbgl_callback_t	quitCallback
	)