Embedded SDK
Embedded SDK
Loading...
Searching...
No Matches
nbgl_flow.h
Go to the documentation of this file.
1
6
7#ifndef NBGL_FLOW_H
8#define NBGL_FLOW_H
9
11
12#ifdef __cplusplus
13extern "C" {
14#endif
15
16/*********************
17 * INCLUDES
18 *********************/
19
20#include "nbgl_step.h"
21#include "nbgl_obj.h"
22#include "nbgl_types.h"
23
24/*********************
25 * DEFINES
26 *********************/
27
28/**********************
29 * TYPEDEFS
30 **********************/
35typedef void *nbgl_flow_t;
36
40typedef void (*nbgl_stepCallback_t)(void);
41
45typedef struct nbgl_stepDesc_s {
48 const char *text;
49 const char *subText;
51#ifdef HAVE_LANGUAGE_PACK
53#endif // HAVE_LANGUAGE_PACK
55
73
74/**********************
75 * GLOBAL PROTOTYPES
76 **********************/
77
79 uint8_t nbSteps,
80 uint8_t initStep,
81 bool loop,
82 bool modal);
84
85/**********************
86 * MACROS
87 **********************/
88
89#ifdef __cplusplus
90} /* extern "C" */
91#endif
92
93#endif /* NBGL_FLOW_H */
struct nbgl_pageSwitchesList_s nbgl_contentSwitchesList_t
This structure contains data to build a SWITCHES_LIST content.
struct nbgl_contentTagValueList_s nbgl_contentTagValueList_t
This structure contains a list of [tag,value] pairs.
nbgl_contentType_t
The different types of predefined contents.
struct nbgl_contentInfoList_s nbgl_contentInfoList_t
This structure contains data to build a INFOS_LIST content.
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:40
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)
release the given flow
Definition nbgl_flow.c:234
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:35
nbgl_flow_t nbgl_flowDraw(const nbgl_stepDesc_t *steps, uint8_t nbSteps, uint8_t initStep, bool loop, bool modal)
draw the given flow, starting at the given step
Definition nbgl_flow.c:194
Included by every low-level NBGL header, to forbid them in apollo app code.
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 a list of names to build a list of radio buttons (on the right part of screen...
This structure contains [item,value] pair(s) and info about a potential "details" button,...
This structure contains data to build a page in multi-pages mode (nbgl_pageDrawGenericContent).
Definition nbgl_flow.h:60
nbgl_contentRadioChoice_t choicesList
CHOICES_LIST type
Definition nbgl_flow.h:69
nbgl_contentSwitchesList_t switchesList
SWITCHES_LIST type
Definition nbgl_flow.h:67
nbgl_contentBarsList_t barsList
BARS_LIST type
Definition nbgl_flow.h:70
nbgl_contentInfoButton_t infoButton
INFO_BUTTON type
Definition nbgl_flow.h:64
nbgl_contentInfoList_t infosList
INFOS_LIST type
Definition nbgl_flow.h:68
nbgl_contentTagValueList_t tagValueList
TAG_VALUE_LIST type
Definition nbgl_flow.h:65
nbgl_contentType_t type
type of page content in the following union
Definition nbgl_flow.h:61
nbgl_contentCenteredInfo_t centeredInfo
CENTERED_INFO type
Definition nbgl_flow.h:63
nbgl_contentTagValueConfirm_t tagValueConfirm
TAG_VALUE_CONFIRM type
Definition nbgl_flow.h:66
Structure containing all specific information when creating a NBGL step.
Definition nbgl_flow.h:45
const char * subText
sub-text to display in step (NULL most of the time)
Definition nbgl_flow.h:49
nbgl_stepCallback_t callback
if not NULL, function to be called on "double-key" action
Definition nbgl_flow.h:47
const nbgl_icon_details_t * icon
icon to display in step (text must be single-page)
Definition nbgl_flow.h:50
nbgl_stepCallback_t init
if not NULL, function to be called when the step is entered
Definition nbgl_flow.h:46
const char * text
text to display in step (can be multi-pages if icon == NULL)
Definition nbgl_flow.h:48
BOLOS_UX_LOC_STRINGS UX_LOC_STRINGS_INDEX