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

Structure containing all information when creating a layout. This structure must be passed as argument to nbgl_layoutGet. More...

#include <nbgl_layout.h>

Collaboration diagram for nbgl_layoutDescription_s:

Public Attributes

bool modal
bool withLeftBorder
const char * tapActionText
 Light gray text used when main container is "tapable".
uint8_t tapActionToken
tune_index_e tapTuneId
nbgl_layoutTouchCallback_t onActionCallback
 the callback to be called on any action on the layout
nbgl_screenTickerConfiguration_t ticker

Detailed Description

Structure containing all information when creating a layout. This structure must be passed as argument to nbgl_layoutGet.

Note
It shall not be used

Definition at line 228 of file nbgl_layout.h.

Member Data Documentation

◆ modal

bool nbgl_layoutDescription_s::modal

if true, puts the layout on top of screen stack (modal). Otherwise puts on background (for apps)

Definition at line 229 of file nbgl_layout.h.

◆ onActionCallback

nbgl_layoutTouchCallback_t nbgl_layoutDescription_s::onActionCallback

the callback to be called on any action on the layout

Definition at line 240 of file nbgl_layout.h.

◆ tapActionText

const char* nbgl_layoutDescription_s::tapActionText

Light gray text used when main container is "tapable".

Definition at line 234 of file nbgl_layout.h.

◆ tapActionToken

uint8_t nbgl_layoutDescription_s::tapActionToken

the token that will be used as argument of the onActionCallback when main container is "tapped"

Definition at line 235 of file nbgl_layout.h.

◆ tapTuneId

tune_index_e nbgl_layoutDescription_s::tapTuneId

if not NBGL_NO_TUNE, a tune will be played when tapping on main container

Definition at line 237 of file nbgl_layout.h.

◆ ticker

nbgl_screenTickerConfiguration_t nbgl_layoutDescription_s::ticker

Definition at line 245 of file nbgl_layout.h.

◆ withLeftBorder

bool nbgl_layoutDescription_s::withLeftBorder

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

Definition at line 232 of file nbgl_layout.h.


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