Embedded SDK
Embedded SDK
Public Attributes | List of all members
nbgl_pageInfoDescription_s Struct Reference

Structure containing all specific information when creating an information page. More...

#include <nbgl_page.h>

Collaboration diagram for nbgl_pageInfoDescription_s:
Collaboration graph
[legend]

Public Attributes

nbgl_layoutCenteredInfo_t centeredInfo
 description of the centered info to be used More...
 
nbgl_pageButtonStyle_t topRightStyle
 style to apply to the Top-Right button More...
 
nbgl_pageButtonStyle_t bottomButtonStyle
 style to apply to the Bottom button More...
 
uint8_t topRightToken
 the token that will be used as argument of the onActionCallback More...
 
uint8_t bottomButtonsToken
 
const char * footerText
 if not NULL, add a touchable footer More...
 
uint8_t footerToken
 the token that will be used as argument of the onActionCallback More...
 
const char * tapActionText
 
bool isSwipeable
 if true, main area is swipeable More...
 
uint8_t tapActionToken
 
const char * actionButtonText
 if not NULL an "action" button is set under the centered info More...
 
const nbgl_icon_details_tactionButtonIcon
 potential icon of "action" button More...
 
nbgl_layoutButtonStyle_t actionButtonStyle
 style of "action" button More...
 
tune_index_e tuneId
 if not NBGL_NO_TUNE, a tune will be played when button/footer is pressed More...
 

Detailed Description

Structure containing all specific information when creating an information page.

Definition at line 185 of file nbgl_page.h.

Member Data Documentation

◆ actionButtonIcon

const nbgl_icon_details_t* nbgl_pageInfoDescription_s::actionButtonIcon

potential icon of "action" button

Definition at line 201 of file nbgl_page.h.

◆ actionButtonStyle

nbgl_layoutButtonStyle_t nbgl_pageInfoDescription_s::actionButtonStyle

style of "action" button

Definition at line 202 of file nbgl_page.h.

◆ actionButtonText

const char* nbgl_pageInfoDescription_s::actionButtonText

if not NULL an "action" button is set under the centered info

Definition at line 200 of file nbgl_page.h.

◆ bottomButtonsToken

uint8_t nbgl_pageInfoDescription_s::bottomButtonsToken

the token that will be used as argument of the onActionCallback if action/bottom button is touched

Definition at line 190 of file nbgl_page.h.

◆ bottomButtonStyle

nbgl_pageButtonStyle_t nbgl_pageInfoDescription_s::bottomButtonStyle

style to apply to the Bottom button

Definition at line 188 of file nbgl_page.h.

◆ centeredInfo

nbgl_layoutCenteredInfo_t nbgl_pageInfoDescription_s::centeredInfo

description of the centered info to be used

Definition at line 186 of file nbgl_page.h.

◆ footerText

const char* nbgl_pageInfoDescription_s::footerText

if not NULL, add a touchable footer

Definition at line 192 of file nbgl_page.h.

◆ footerToken

uint8_t nbgl_pageInfoDescription_s::footerToken

the token that will be used as argument of the onActionCallback

Definition at line 193 of file nbgl_page.h.

◆ isSwipeable

bool nbgl_pageInfoDescription_s::isSwipeable

if true, main area is swipeable

Definition at line 196 of file nbgl_page.h.

◆ tapActionText

const char* nbgl_pageInfoDescription_s::tapActionText

if non NULL, main area is "tapable", with this text as indication

Definition at line 194 of file nbgl_page.h.

◆ tapActionToken

uint8_t nbgl_pageInfoDescription_s::tapActionToken

the token that will be used as argument of the onActionCallback, when tapped or swiped

Definition at line 197 of file nbgl_page.h.

◆ topRightStyle

nbgl_pageButtonStyle_t nbgl_pageInfoDescription_s::topRightStyle

style to apply to the Top-Right button

Definition at line 187 of file nbgl_page.h.

◆ topRightToken

uint8_t nbgl_pageInfoDescription_s::topRightToken

the token that will be used as argument of the onActionCallback

Definition at line 189 of file nbgl_page.h.

◆ tuneId

tune_index_e nbgl_pageInfoDescription_s::tuneId

if not NBGL_NO_TUNE, a tune will be played when button/footer is pressed

Definition at line 204 of file nbgl_page.h.


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