Embedded SDK
Embedded SDK
Loading...
Searching...
No Matches
nbgl_pageMultiScreensDescription_s Struct Reference

Structure containing all specific information when creating a multi-screens page. More...

#include <nbgl_page.h>

Collaboration diagram for nbgl_pageMultiScreensDescription_s:

Public Attributes

uint8_t activePage
 the index of the page to display at start-up
uint8_t nbPages
 the number of pages to display (if <2, no navigation bar)
uint8_t quitToken
 the token used as argument of the actionCallback when the footer is touched
nbgl_pageNavigationType_t navType
bool progressIndicator
 if set to true, display a progress indicator on top of the page
tune_index_e tuneId
 if not NBGL_NO_TUNE, a tune will be played when next or back is pressed
const char * skipText
uint8_t skipToken
 if skipText is NULL the token used when right part of footer is touched
union { 
   nbgl_pageNavWithTap_t   navWithTap 
 structure used when navigation with "tap" More...
   nbgl_pageNavWithButtons_t   navWithButtons 
 structure used when navigation with buttons More...
}; 

Detailed Description

Structure containing all specific information when creating a multi-screens page.

Definition at line 96 of file nbgl_page.h.

Member Data Documentation

◆ [union]

◆ activePage

uint8_t nbgl_pageMultiScreensDescription_s::activePage

the index of the page to display at start-up

Definition at line 97 of file nbgl_page.h.

◆ navType

nbgl_pageNavigationType_t nbgl_pageMultiScreensDescription_s::navType

type of navigation, it will tell which structure in the following union will be used

Definition at line 101 of file nbgl_page.h.

◆ navWithButtons

nbgl_pageNavWithButtons_t nbgl_pageMultiScreensDescription_s::navWithButtons

structure used when navigation with buttons

Definition at line 111 of file nbgl_page.h.

◆ navWithTap

nbgl_pageNavWithTap_t nbgl_pageMultiScreensDescription_s::navWithTap

structure used when navigation with "tap"

Definition at line 110 of file nbgl_page.h.

◆ nbPages

uint8_t nbgl_pageMultiScreensDescription_s::nbPages

the number of pages to display (if <2, no navigation bar)

Definition at line 98 of file nbgl_page.h.

◆ progressIndicator

bool nbgl_pageMultiScreensDescription_s::progressIndicator

if set to true, display a progress indicator on top of the page

Definition at line 103 of file nbgl_page.h.

◆ quitToken

uint8_t nbgl_pageMultiScreensDescription_s::quitToken

the token used as argument of the actionCallback when the footer is touched

Definition at line 100 of file nbgl_page.h.

◆ skipText

const char* nbgl_pageMultiScreensDescription_s::skipText

if not NULL the text displayed in right part of footer, used for example to skip pages

Definition at line 106 of file nbgl_page.h.

◆ skipToken

uint8_t nbgl_pageMultiScreensDescription_s::skipToken

if skipText is NULL the token used when right part of footer is touched

Definition at line 108 of file nbgl_page.h.

◆ tuneId

tune_index_e nbgl_pageMultiScreensDescription_s::tuneId

if not NBGL_NO_TUNE, a tune will be played when next or back is pressed

Definition at line 105 of file nbgl_page.h.


The documentation for this struct was generated from the following file: