Embedded SDK
Embedded SDK
Public Attributes | List of all members
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 More...
 
bool separationLine
 if true, a separation line is added at the bottom of this control More...
 
union {
   struct {
      uint16_t   height
 
   }   emptySpace
 if type is HEADER_EMPTY More...
 
   struct {
      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_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...
 
      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 430 of file nbgl_layout.h.

Member Data Documentation

◆ 

union { ... }

◆ actionIcon

const nbgl_icon_details_t* nbgl_layoutHeader_t::actionIcon

right button icon

Definition at line 443 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 448 of file nbgl_layout.h.

◆ activePage

uint8_t nbgl_layoutHeader_t::activePage

Definition at line 444 of file nbgl_layout.h.

◆ 

struct { ... } nbgl_layoutHeader_t::backAndText

◆ backToken

uint8_t nbgl_layoutHeader_t::backToken

when back key is pressed

Definition at line 458 of file nbgl_layout.h.

◆ 

struct { ... } nbgl_layoutHeader_t::emptySpace

if type is HEADER_EMPTY

◆ 

struct { ... } nbgl_layoutHeader_t::extendedBack

◆ height

uint16_t nbgl_layoutHeader_t::height

Definition at line 435 of file nbgl_layout.h.

◆ nbPages

uint8_t nbgl_layoutHeader_t::nbPages

Definition at line 445 of file nbgl_layout.h.

◆ 

struct { ... } nbgl_layoutHeader_t::progressAndBack

◆ 

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 432 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 438 of file nbgl_layout.h.

◆ textToken

uint8_t nbgl_layoutHeader_t::textToken

when text is touched

Definition at line 457 of file nbgl_layout.h.

◆ 

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 439 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 440 of file nbgl_layout.h.

◆ type

nbgl_layoutHeaderType_t nbgl_layoutHeader_t::type

type of header

Definition at line 431 of file nbgl_layout.h.

◆ withBack

bool nbgl_layoutHeader_t::withBack

Definition at line 446 of file nbgl_layout.h.


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