Embedded SDK
Embedded SDK
Loading...
Searching...
No Matches
nbgl_flow.h
Go to the documentation of this file.
1
7#ifndef NBGL_FLOW_H
8#define NBGL_FLOW_H
9
10#ifdef __cplusplus
11extern "C" {
12#endif
13
14/*********************
15 * INCLUDES
16 *********************/
17
18#include "nbgl_step.h"
19#include "nbgl_obj.h"
20#include "nbgl_types.h"
21
22/*********************
23 * DEFINES
24 *********************/
25
26/**********************
27 * TYPEDEFS
28 **********************/
33typedef void *nbgl_flow_t;
34
38typedef void (*nbgl_stepCallback_t)(void);
39
43typedef struct nbgl_stepDesc_s {
46 const char *text;
47 const char *subText;
49#ifdef HAVE_LANGUAGE_PACK
51#endif // HAVE_LANGUAGE_PACK
53
70
71/**********************
72 * GLOBAL PROTOTYPES
73 **********************/
74
76 uint8_t nbSteps,
77 uint8_t initStep,
78 bool loop,
79 bool modal);
81
82/**********************
83 * MACROS
84 **********************/
85
86#ifdef __cplusplus
87} /* extern "C" */
88#endif
89
90#endif /* NBGL_FLOW_H */
nbgl_contentType_t
The different types of predefined contents.
void(* nbgl_stepCallback_t)(void)
prototype of function to be called when a step is using a callback on "double-key" action
Definition nbgl_flow.h:38
struct nbgl_pageContent_s nbgl_pageContent_t
This structure contains data to build a page in multi-pages mode (nbgl_pageDrawGenericContent)
void nbgl_flowRelease(nbgl_flow_t flow)
struct nbgl_stepDesc_s nbgl_stepDesc_t
Structure containing all specific information when creating a NBGL step.
void * nbgl_flow_t
type shared externally
Definition nbgl_flow.h:33
nbgl_flow_t nbgl_flowDraw(const nbgl_stepDesc_t *steps, uint8_t nbSteps, uint8_t initStep, bool loop, bool modal)
API to draw all basic graphic objects.
Step construction API of NBGL.
common types for Graphical Library
struct PACKED__ nbgl_icon_details_s nbgl_icon_details_t
Represents all information about an icon.
This structure contains data to build a BARS_LIST content.
This structure contains info to build a centered (vertically and horizontally) area,...
This structure contains data to build a centered info + simple black button content.
This structure contains data to build a INFOS_LIST content.
This structure contains a list of names to build a list of radio buttons (on the right part of screen...
This structure contains a list of [tag,value] pairs.
This structure contains data to build a page in multi-pages mode (nbgl_pageDrawGenericContent)
Definition nbgl_flow.h:58
nbgl_contentRadioChoice_t choicesList
CHOICES_LIST type
Definition nbgl_flow.h:66
nbgl_contentSwitchesList_t switchesList
SWITCHES_LIST type
Definition nbgl_flow.h:64
nbgl_contentBarsList_t barsList
BARS_LIST type
Definition nbgl_flow.h:67
nbgl_contentInfoButton_t infoButton
INFO_BUTTON type
Definition nbgl_flow.h:62
nbgl_contentInfoList_t infosList
INFOS_LIST type
Definition nbgl_flow.h:65
nbgl_contentTagValueList_t tagValueList
TAG_VALUE_LIST type
Definition nbgl_flow.h:63
nbgl_contentType_t type
type of page content in the following union
Definition nbgl_flow.h:59
nbgl_contentCenteredInfo_t centeredInfo
CENTERED_INFO type
Definition nbgl_flow.h:61
This structure contains data to build a SWITCHES_LIST content.
Structure containing all specific information when creating a NBGL step.
Definition nbgl_flow.h:43
const char * subText
sub-text to display in step (NULL most of the time)
Definition nbgl_flow.h:47
nbgl_stepCallback_t callback
if not NULL, function to be called on "double-key" action
Definition nbgl_flow.h:45
const nbgl_icon_details_t * icon
icon to display in step (text must be single-page)
Definition nbgl_flow.h:48
nbgl_stepCallback_t init
if not NULL, function to be called when the step is entered
Definition nbgl_flow.h:44
const char * text
text to display in step (can be multi-pages if icon == NULL)
Definition nbgl_flow.h:46
unsigned char uint8_t
Definition usbd_conf.h:53
BOLOS_UX_LOC_STRINGS UX_LOC_STRINGS_INDEX