nbgl_page.c File Reference

Implementation of predefined pages management for Applications. More...

#include <string.h>
#include "nbgl_debug.h"
#include "nbgl_page.h"
#include "glyphs.h"
#include "os_pic.h"

Include dependency graph for nbgl_page.c:

Go to the source code of this file.

Functions
nbgl_page_t *	nbgl_pageDrawLedgerInfo (nbgl_layoutTouchCallback_t onActionCallback, const nbgl_screenTickerConfiguration_t *ticker, const char *text, int tapActionToken)
	draw a page with a centered text in large case, with a round check icon
nbgl_page_t *	nbgl_pageDrawSpinner (const char *text, uint8_t initPosition)
	draw a spinner page with the given parameters. The spinner will "rotate" automatically every 800 ms
nbgl_page_t *	nbgl_pageDrawInfo (nbgl_layoutTouchCallback_t onActionCallback, const nbgl_screenTickerConfiguration_t *ticker, const nbgl_pageInfoDescription_t *info)
	draw a page with a centered info (icon and/or texts) with a touchable footer, in a potential "tapable" area, with an optional top-right button, with an optional bottom button
nbgl_page_t *	nbgl_pageDrawConfirmation (nbgl_layoutTouchCallback_t onActionCallback, const nbgl_pageConfirmationDescription_t *info)
	draw a confirmation page, with a centered info (icon and/or text), a button to confirm and a footer to cancel
nbgl_page_t *	nbgl_pageDrawGenericContentExt (nbgl_layoutTouchCallback_t onActionCallback, const nbgl_pageNavigationInfo_t *nav, nbgl_pageContent_t *content, bool modal)
	draw a generic content page, with the given content, and if nav parameter is not NULL, with the given navigation controls (either with navigation bar or with "tap" and "back")
nbgl_page_t *	nbgl_pageDrawGenericContent (nbgl_layoutTouchCallback_t onActionCallback, const nbgl_pageNavigationInfo_t *nav, nbgl_pageContent_t *content)
	draw a generic content page, with the given content, and if nav parameter is not NULL, with the given navigation controls (either with navigation bar or with "tap" and "back")
int	nbgl_pageRelease (nbgl_page_t *page)
	Release the page obtained with any of the nbgl_pageDrawXXX() functions.

Detailed Description

Implementation of predefined pages management for Applications.

Definition in file nbgl_page.c.

Function Documentation

nbgl_pageDrawConfirmation()

nbgl_page_t * nbgl_pageDrawConfirmation	(	nbgl_layoutTouchCallback_t	onActionCallback,
		const nbgl_pageConfirmationDescription_t *	info
	)

draw a confirmation page, with a centered info (icon and/or text), a button to confirm and a footer to cancel

Parameters

onActionCallback	common callback for all actions on this page
info	structure describing the centered info and other controls of this page

Returns

the page context (or NULL if error)

Definition at line 442 of file nbgl_page.c.

nbgl_pageDrawGenericContent()

nbgl_page_t * nbgl_pageDrawGenericContent	(	nbgl_layoutTouchCallback_t	onActionCallback,
		const nbgl_pageNavigationInfo_t *	nav,
		nbgl_pageContent_t *	content
	)

draw a generic content page, with the given content, and if nav parameter is not NULL, with the given navigation controls (either with navigation bar or with "tap" and "back")

Parameters

onActionCallback	common callback for all actions on this page
nav	structure describing the navigation controls of this page (no navigation if NULL)
content	structure describing the main content of this page

Returns

the page context (or NULL if error)

Definition at line 612 of file nbgl_page.c.

nbgl_pageDrawGenericContentExt()

nbgl_page_t * nbgl_pageDrawGenericContentExt	(	nbgl_layoutTouchCallback_t	onActionCallback,
		const nbgl_pageNavigationInfo_t *	nav,
		nbgl_pageContent_t *	content,
		bool	modal
	)

draw a generic content page, with the given content, and if nav parameter is not NULL, with the given navigation controls (either with navigation bar or with "tap" and "back")

Parameters

onActionCallback	common callback for all actions on this page
nav	structure describing the navigation controls of this page (no navigation if NULL)
content	structure describing the main content of this page
modal	set to true to draw as a modal

Returns

the page context (or NULL if error)

Definition at line 483 of file nbgl_page.c.

nbgl_pageDrawInfo()

nbgl_page_t * nbgl_pageDrawInfo	(	nbgl_layoutTouchCallback_t	onActionCallback,
		const nbgl_screenTickerConfiguration_t *	ticker,
		const nbgl_pageInfoDescription_t *	info
	)

draw a page with a centered info (icon and/or texts) with a touchable footer, in a potential "tapable" area, with an optional top-right button, with an optional bottom button

Parameters

onActionCallback	common callback for all actions on this page
ticker	ticker configuration, set to NULL to disable it
info	structure describing the centered info and other controls of this page

Returns

the page context (or NULL if error)

Definition at line 324 of file nbgl_page.c.

nbgl_pageDrawLedgerInfo()

nbgl_page_t * nbgl_pageDrawLedgerInfo	(	nbgl_layoutTouchCallback_t	onActionCallback,
		const nbgl_screenTickerConfiguration_t *	ticker,
		const char *	text,
		int	tapActionToken
	)

draw a page with a centered text in large case, with a round check icon

Parameters

onActionCallback	common callback for all actions on this page
ticker	ticker configuration, set to NULL to disable it
text	text in LEDGER style (UPPER CASE only)
tapActionToken	token passed to onActionCallback, on a tap event

Returns

the page context (or NULL if error)

Definition at line 256 of file nbgl_page.c.

nbgl_pageDrawSpinner()

nbgl_page_t * nbgl_pageDrawSpinner	(	const char *	text,
		uint8_t	initPosition
	)

draw a spinner page with the given parameters. The spinner will "rotate" automatically every 800 ms

Parameters

text	text to use under spinner
initPosition	if set to any value expect SPINNER_FIXED, it will be used as the init position of the spinner

Returns

the page context (or NULL if error)

Definition at line 299 of file nbgl_page.c.

nbgl_pageRelease()

int nbgl_pageRelease

(

nbgl_page_t *

page

)

Release the page obtained with any of the nbgl_pageDrawXXX() functions.

Parameters

page	page to release

Returns

>= 0 if OK

Definition at line 625 of file nbgl_page.c.