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

This structure contains info to build a header. More...

#include <nbgl_layout.h>

Public Attributes

nbgl_layoutHeaderType_t type
 type of header
bool separationLine
 if true, a separation line is added at the bottom of this control
union { 
   struct { 
      uint16_t   height 
   }   emptySpace
 if type is HEADER_EMPTY More...
   struct { 
      const nbgl_icon_details_t *   icon 
 icon on left of text (only if HEADER_BACK_ICON_AND_TEXT) More...
      const char *   text 
 can be NULL if no text More...
      uint8_t   token 
 when back key is pressed More...
      tune_index_e   tuneId 
 when back key is pressed More...
   }   backAndText
 if type is HEADER_BACK_ICON_AND_TEXT or HEADER_BACK_AND_TEXT More...
   struct { 
      const nbgl_icon_details_t *   actionIcon 
 right button icon More...
      uint8_t   activePage 
      uint8_t   nbPages 
      bool   withBack 
      uint8_t   token 
 when optional back key is pressed More...
      uint8_t   actionToken 
 when optional right button is pressed More...
      tune_index_e   tuneId 
 when optional back key is pressed More...
   }   progressAndBack
 if type is HEADER_BACK_AND_PROGRESS More...
   struct { 
      const char *   text 
   }   title
 if type is HEADER_TITLE More...
   struct { 
      const nbgl_icon_details_t *   actionIcon 
 right button icon More...
      const char *   text 
 centered text (can be NULL if no text) More...
      const char *   subText 
 text under the line (can be NULL) More...
      uint8_t   textToken 
 when text is touched More...
      uint8_t   backToken 
 when back key is pressed More...
      uint8_t   actionToken 
 when right key is pressed More...
      tune_index_e   tuneId 
 when back key is pressed More...
   }   extendedBack
 if type is HEADER_EXTENDED_BACK More...
   struct { 
      const char *   text 
 touchable text on the right More...
      uint8_t   token 
 when text is pressed More...
      tune_index_e   tuneId 
 when text is pressed More...
   }   rightText
 if type is HEADER_RIGHT_TEXT More...
}; 

Detailed Description

This structure contains info to build a header.

Definition at line 410 of file nbgl_layout.h.

Member Data Documentation

◆ [union]

union { ... } nbgl_layoutHeader_t

◆ actionIcon

const nbgl_icon_details_t* nbgl_layoutHeader_t::actionIcon

right button icon

Definition at line 425 of file nbgl_layout.h.

◆ actionToken

uint8_t nbgl_layoutHeader_t::actionToken

when optional right button is pressed

when right key is pressed

Definition at line 430 of file nbgl_layout.h.

◆ activePage

uint8_t nbgl_layoutHeader_t::activePage

Definition at line 426 of file nbgl_layout.h.

◆ [struct]

struct { ... } nbgl_layoutHeader_t::backAndText

◆ backToken

uint8_t nbgl_layoutHeader_t::backToken

when back key is pressed

Definition at line 441 of file nbgl_layout.h.

◆ [struct]

struct { ... } nbgl_layoutHeader_t::emptySpace

if type is HEADER_EMPTY

◆ [struct]

struct { ... } nbgl_layoutHeader_t::extendedBack

◆ height

uint16_t nbgl_layoutHeader_t::height

Definition at line 415 of file nbgl_layout.h.

◆ icon

const nbgl_icon_details_t* nbgl_layoutHeader_t::icon

icon on left of text (only if HEADER_BACK_ICON_AND_TEXT)

Definition at line 419 of file nbgl_layout.h.

◆ nbPages

uint8_t nbgl_layoutHeader_t::nbPages

Definition at line 427 of file nbgl_layout.h.

◆ [struct]

struct { ... } nbgl_layoutHeader_t::progressAndBack

◆ [struct]

struct { ... } nbgl_layoutHeader_t::rightText

if type is HEADER_RIGHT_TEXT

◆ separationLine

bool nbgl_layoutHeader_t::separationLine

if true, a separation line is added at the bottom of this control

Definition at line 412 of file nbgl_layout.h.

◆ subText

const char* nbgl_layoutHeader_t::subText

text under the line (can be NULL)

Definition at line 439 of file nbgl_layout.h.

◆ text

const char* nbgl_layoutHeader_t::text

can be NULL if no text

touchable text on the right

centered text (can be NULL if no text)

Definition at line 420 of file nbgl_layout.h.

◆ textToken

uint8_t nbgl_layoutHeader_t::textToken

when text is touched

Definition at line 440 of file nbgl_layout.h.

◆ [struct]

struct { ... } nbgl_layoutHeader_t::title

if type is HEADER_TITLE

◆ token

uint8_t nbgl_layoutHeader_t::token

when back key is pressed

when text is pressed

when optional back key is pressed

Definition at line 421 of file nbgl_layout.h.

◆ tuneId

tune_index_e nbgl_layoutHeader_t::tuneId

when back key is pressed

when text is pressed

when optional back key is pressed

Definition at line 422 of file nbgl_layout.h.

◆ type

nbgl_layoutHeaderType_t nbgl_layoutHeader_t::type

type of header

Definition at line 411 of file nbgl_layout.h.

◆ withBack

bool nbgl_layoutHeader_t::withBack

Definition at line 428 of file nbgl_layout.h.


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