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

Structure containing all information about the current layout. More...

#include <nbgl_layout_internal.h>

Collaboration diagram for nbgl_layoutInternal_s:

Public Attributes

struct nbgl_layoutInternal_s * top
 layout above this one, in stack
struct nbgl_layoutInternal_s * bottom
 layout under this one, in stack
nbgl_obj_t ** children
 children for main screen
nbgl_container_t * headerContainer
 container used to store header (progress, back, empty space...)
nbgl_container_t * footerContainer
 container used to store footer (buttons, nav....)
nbgl_container_t * upFooterContainer
nbgl_text_area_t * tapText
nbgl_layoutTouchCallback_t callback
 user callback for all controls
layoutObj_t callbackObjPool [LAYOUT_OBJ_POOL_LEN]
nbgl_container_t * container
const nbgl_animation_t * animation
 current animation (if not NULL)
uint8_t nbPages
 number of pages for navigation bar
uint8_t activePage
 index of active page for navigation bar
nbgl_layoutHeaderType_t headerType
 type of header
nbgl_layoutFooterType_t footerType
 type of footer
nbgl_layoutUpFooterType_t upFooterType
 type of up-footer
uint8_t modal: 1
 if true, means the screen is a modal
uint8_t withLeftBorder: 1
uint8_t incrementAnim: 1
 if true, means that animation index is currently incrementing
uint8_t layer: 5
 layer in screen stack
uint8_t nbUsedCallbackObjs: 6
uint8_t isUsed: 1
 if true, means this layout is in use
uint8_t invertedColors: 1
 if true, means that background is black
uint8_t iconIdxInAnim
 current icon index in animation
nbgl_swipe_usage_t swipeUsage

Detailed Description

Structure containing all information about the current layout.

Note
It shall not be used externally

Definition at line 80 of file nbgl_layout_internal.h.

Member Data Documentation

◆ activePage

uint8_t nbgl_layoutInternal_s::activePage

index of active page for navigation bar

Definition at line 98 of file nbgl_layout_internal.h.

◆ animation

const nbgl_animation_t* nbgl_layoutInternal_s::animation

current animation (if not NULL)

Definition at line 95 of file nbgl_layout_internal.h.

◆ bottom

struct nbgl_layoutInternal_s* nbgl_layoutInternal_s::bottom

layout under this one, in stack

Definition at line 82 of file nbgl_layout_internal.h.

◆ callback

nbgl_layoutTouchCallback_t nbgl_layoutInternal_s::callback

user callback for all controls

Definition at line 90 of file nbgl_layout_internal.h.

◆ callbackObjPool

layoutObj_t nbgl_layoutInternal_s::callbackObjPool[LAYOUT_OBJ_POOL_LEN]

Definition at line 92 of file nbgl_layout_internal.h.

◆ children

nbgl_obj_t** nbgl_layoutInternal_s::children

children for main screen

Definition at line 83 of file nbgl_layout_internal.h.

◆ container

nbgl_container_t* nbgl_layoutInternal_s::container

Definition at line 94 of file nbgl_layout_internal.h.

◆ footerContainer

nbgl_container_t* nbgl_layoutInternal_s::footerContainer

container used to store footer (buttons, nav....)

Definition at line 86 of file nbgl_layout_internal.h.

◆ footerType

nbgl_layoutFooterType_t nbgl_layoutInternal_s::footerType

type of footer

Definition at line 100 of file nbgl_layout_internal.h.

◆ headerContainer

nbgl_container_t* nbgl_layoutInternal_s::headerContainer

container used to store header (progress, back, empty space...)

Definition at line 85 of file nbgl_layout_internal.h.

◆ headerType

nbgl_layoutHeaderType_t nbgl_layoutInternal_s::headerType

type of header

Definition at line 99 of file nbgl_layout_internal.h.

◆ iconIdxInAnim

uint8_t nbgl_layoutInternal_s::iconIdxInAnim

current icon index in animation

Definition at line 111 of file nbgl_layout_internal.h.

◆ incrementAnim

uint8_t nbgl_layoutInternal_s::incrementAnim

if true, means that animation index is currently incrementing

Definition at line 105 of file nbgl_layout_internal.h.

◆ invertedColors

uint8_t nbgl_layoutInternal_s::invertedColors

if true, means that background is black

Definition at line 110 of file nbgl_layout_internal.h.

◆ isUsed

uint8_t nbgl_layoutInternal_s::isUsed

if true, means this layout is in use

Definition at line 109 of file nbgl_layout_internal.h.

◆ layer

uint8_t nbgl_layoutInternal_s::layer

layer in screen stack

Definition at line 106 of file nbgl_layout_internal.h.

◆ modal

uint8_t nbgl_layoutInternal_s::modal

if true, means the screen is a modal

Definition at line 102 of file nbgl_layout_internal.h.

◆ nbPages

uint8_t nbgl_layoutInternal_s::nbPages

number of pages for navigation bar

Definition at line 97 of file nbgl_layout_internal.h.

◆ nbUsedCallbackObjs

uint8_t nbgl_layoutInternal_s::nbUsedCallbackObjs

number of callback objects used by the whole layout in callbackObjPool

Definition at line 107 of file nbgl_layout_internal.h.

◆ swipeUsage

nbgl_swipe_usage_t nbgl_layoutInternal_s::swipeUsage

Definition at line 112 of file nbgl_layout_internal.h.

◆ tapText

nbgl_text_area_t* nbgl_layoutInternal_s::tapText

Definition at line 89 of file nbgl_layout_internal.h.

◆ top

struct nbgl_layoutInternal_s* nbgl_layoutInternal_s::top

layout above this one, in stack

Definition at line 81 of file nbgl_layout_internal.h.

◆ upFooterContainer

nbgl_container_t* nbgl_layoutInternal_s::upFooterContainer

container used on top on footer to store special contents like tip-box or long-press button

Definition at line 87 of file nbgl_layout_internal.h.

◆ upFooterType

nbgl_layoutUpFooterType_t nbgl_layoutInternal_s::upFooterType

type of up-footer

Definition at line 101 of file nbgl_layout_internal.h.

◆ withLeftBorder

uint8_t nbgl_layoutInternal_s::withLeftBorder

if true, draws a light gray left border on the whole height of the screen

Definition at line 103 of file nbgl_layout_internal.h.


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