Embedded SDK
Embedded SDK
Loading...
Searching...
No Matches
nbgl_flow.h File Reference

Flow construction API of NBGL. More...

#include "nbgl_low_level_guard.h"
#include "nbgl_step.h"
#include "nbgl_obj.h"
#include "nbgl_types.h"
Include dependency graph for nbgl_flow.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  nbgl_stepDesc_s
 Structure containing all specific information when creating a NBGL step. More...
struct  nbgl_pageContent_s
 This structure contains data to build a page in multi-pages mode (nbgl_pageDrawGenericContent). More...

Typedefs

typedef void * nbgl_flow_t
 type shared externally
typedef void(* nbgl_stepCallback_t) (void)
 prototype of function to be called when a step is using a callback on "double-key" action
typedef struct nbgl_stepDesc_s nbgl_stepDesc_t
 Structure containing all specific information when creating a NBGL step.
typedef struct nbgl_pageContent_s nbgl_pageContent_t
 This structure contains data to build a page in multi-pages mode (nbgl_pageDrawGenericContent).

Functions

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
void nbgl_flowRelease (nbgl_flow_t flow)
 release the given flow

Detailed Description

Flow construction API of NBGL.

Definition in file nbgl_flow.h.

Typedef Documentation

◆ nbgl_flow_t

typedef void* nbgl_flow_t

type shared externally

Definition at line 35 of file nbgl_flow.h.

◆ nbgl_pageContent_t

This structure contains data to build a page in multi-pages mode (nbgl_pageDrawGenericContent).

◆ nbgl_stepCallback_t

typedef void(* nbgl_stepCallback_t) (void)

prototype of function to be called when a step is using a callback on "double-key" action

Definition at line 40 of file nbgl_flow.h.

◆ nbgl_stepDesc_t

Structure containing all specific information when creating a NBGL step.

Function Documentation

◆ nbgl_flowDraw()

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

Parameters
stepsarray of step descriptions
nbStepsnumber of steps in above array
initStepinit step in above array
loopif true, loop between last and first step, in both direction
modalif true, screens are modal
Returns
>= 0 if OK, < 0 otherwise

Definition at line 194 of file nbgl_flow.c.

◆ nbgl_flowRelease()

void nbgl_flowRelease ( nbgl_flow_t flow)

release the given flow

Parameters
flowflow to release

Definition at line 234 of file nbgl_flow.c.