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

Structure containing all parameters for keyboard use case. More...

#include <nbgl_use_case.h>

Collaboration diagram for nbgl_keyboardParams_t:

Public Attributes

nbgl_layoutKeyboardContentType_t type
 type of content
const char * title
 centered title explaining the screen
char * entryBuffer
 already entered text
uint8_t entryMaxLen
keyboardMode_t mode
 keyboard mode to start with
bool lettersOnly
 if true, only display letter keys and Backspace
bool numbered
 if set to true, the text is preceded on the left by 'number.'
uint8_t number
 if numbered is true, number used to build 'number.' text
keyboardCase_t casing
 keyboard casing mode (lower, upper once or upper locked)
bool obfuscated
 if true, entered text and suggestions use the obfuscated font
union { 
   nbgl_kbdSuggestParams_t   suggestionParams 
   nbgl_kbdButtonParams_t   confirmationParams 
 used if type is KEYBOARD_WITH_SUGGESTIONS More...
}; 

Detailed Description

Structure containing all parameters for keyboard use case.

This structure is used to configure the keyboard modal page, including the title, input buffer, keyboard mode, and the type of content (with button or suggestions).

Definition at line 393 of file nbgl_use_case.h.

Member Data Documentation

◆ [union]

union { ... } nbgl_keyboardParams_t

◆ casing

keyboardCase_t nbgl_keyboardParams_t::casing

keyboard casing mode (lower, upper once or upper locked)

Definition at line 405 of file nbgl_use_case.h.

◆ confirmationParams

nbgl_kbdButtonParams_t nbgl_keyboardParams_t::confirmationParams

used if type is KEYBOARD_WITH_SUGGESTIONS

Definition at line 411 of file nbgl_use_case.h.

◆ entryBuffer

char* nbgl_keyboardParams_t::entryBuffer

already entered text

Definition at line 396 of file nbgl_use_case.h.

◆ entryMaxLen

uint8_t nbgl_keyboardParams_t::entryMaxLen

maximum length of text that can be entered, excluding the NUL terminator (entryBuffer must be at least entryMaxLen + 1 bytes long)

Definition at line 397 of file nbgl_use_case.h.

◆ lettersOnly

bool nbgl_keyboardParams_t::lettersOnly

if true, only display letter keys and Backspace

Definition at line 401 of file nbgl_use_case.h.

◆ mode

keyboardMode_t nbgl_keyboardParams_t::mode

keyboard mode to start with

Definition at line 400 of file nbgl_use_case.h.

◆ number

uint8_t nbgl_keyboardParams_t::number

if numbered is true, number used to build 'number.' text

Definition at line 404 of file nbgl_use_case.h.

◆ numbered

bool nbgl_keyboardParams_t::numbered

if set to true, the text is preceded on the left by 'number.'

Definition at line 403 of file nbgl_use_case.h.

◆ obfuscated

bool nbgl_keyboardParams_t::obfuscated

if true, entered text and suggestions use the obfuscated font

Definition at line 406 of file nbgl_use_case.h.

◆ suggestionParams

nbgl_kbdSuggestParams_t nbgl_keyboardParams_t::suggestionParams

Definition at line 410 of file nbgl_use_case.h.

◆ title

const char* nbgl_keyboardParams_t::title

centered title explaining the screen

Definition at line 395 of file nbgl_use_case.h.

◆ type

nbgl_layoutKeyboardContentType_t nbgl_keyboardParams_t::type

type of content

Definition at line 394 of file nbgl_use_case.h.


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