Embedded SDK
Embedded SDK
|
API to draw all basic graphic objects. More...
Go to the source code of this file.
Classes | |
struct | nbgl_touchStatePosition_t |
The low level Touchscreen event, coming from driver. More... | |
struct | nbgl_obj_s |
Common structure for all graphical objects. More... | |
struct | nbgl_container_s |
struct to represent a container (CONTAINER type) More... | |
struct | nbgl_line_s |
struct to represent a vertical or horizontal line More... | |
struct | nbgl_image_s |
struct to represent an image (IMAGE type) More... | |
struct | nbgl_image_file_s |
struct to represent an image file object (IMAGE_FILE type) The source of the data is an image file with header. width and height are given in this header More... | |
struct | nbgl_qrcode_s |
struct to represent a QR code (QR_CODE type), whose size is fixed More... | |
struct | nbgl_radio_s |
struct to represent a radio button (RADIO_BUTTON type) More... | |
struct | nbgl_switch_s |
struct to represent a switch (size is fixed) (SWITCH type) More... | |
struct | nbgl_progress_bar_s |
struct to represent a progress bar (PROGRESS_BAR type) More... | |
struct | nbgl_navigation_bar_s |
struct to represent a navigation bar (PAGE_INDICATOR type) There can be up to 5 page indicators, whose shape is fixed. If there are more than 5 pages, the middle indicator will be "..." More... | |
struct | nbgl_button_s |
struct to represent a button (BUTTON type) that can contain a text and/or an icon More... | |
struct | nbgl_text_area_s |
struct to represent a text area (TEXT_AREA type) More... | |
struct | nbgl_text_entry_s |
struct to represent a text entry area (TEXT_ENTRY type) More... | |
struct | nbgl_mask_control_s |
struct | nbgl_spinner_s |
struct to represent a "spinner", represented by the Ledger corners, in gray, with one of the corners in black (SPINNER type) More... | |
struct | nbgl_keyboard_s |
struct to represent a keyboard (KEYBOARD type) More... | |
struct | nbgl_keypad_s |
struct to represent a keypad (KEYPAD type) More... | |
Macros | |
#define | BACKSPACE_KEY 8 |
#define | VALIDATE_KEY '\r' |
#define | KEYBOARD_KEY_HEIGHT 72 |
#define | SHIFT_KEY_INDEX 26 |
#define | DIGITS_SWITCH_KEY_INDEX 27 |
#define | BACKSPACE_KEY_INDEX 28 |
#define | SPACE_KEY_INDEX 29 |
#define | SPECIAL_KEYS_INDEX 30 |
#define | KEYPAD_KEY_HEIGHT 88 |
#define | KEYPAD_MAX_DIGITS 12 |
#define | BORDER_MARGIN 32 |
#define | BOTTOM_BORDER_MARGIN 24 |
#define | BACK_BUTTON_HEADER_HEIGHT 96 |
#define | BUTTON_RADIUS RADIUS_44_PIXELS |
#define | BUTTON_DIAMETER 88 |
#define | SPINNER_WIDTH 64 |
#define | SPINNER_HEIGHT 48 |
#define | RADIO_WIDTH 40 |
#define | RADIO_HEIGHT 40 |
#define | SPACE_ICON C_Space_40px |
#define | BACKSPACE_ICON C_Erase_40px |
#define | SHIFT_ICON C_Maj_40px |
#define | SHIFT_LOCKED_ICON C_Maj_Lock_40px |
#define | VALIDATE_ICON C_Check_40px |
#define | RADIO_OFF_ICON C_radio_inactive_40px |
#define | RADIO_ON_ICON C_radio_active_40px |
#define | PUSH_ICON C_Chevron_40px |
#define | LEFT_ARROW_ICON C_Back_40px |
#define | RIGHT_ARROW_ICON C_Next_40px |
#define | CHEVRON_BACK_ICON C_Chevron_Back_40px |
#define | CHEVRON_NEXT_ICON C_Chevron_Next_40px |
#define | CLOSE_ICON C_Close_40px |
#define | WHEEL_ICON C_Settings_40px |
#define | INFO_I_ICON C_Info_40px |
#define | QRCODE_ICON C_QRCode_40px |
#define | MINI_PUSH_ICON C_Mini_Push_40px |
#define | WARNING_ICON C_Warning_40px |
#define | C_warning64px _Pragma("GCC warning \"Deprecated constant!\"") C_Warning_64px |
#define | C_round_warning_64px _Pragma("GCC warning \"Deprecated constant!\"") C_Important_Circle_64px |
#define | C_round_check_64px _Pragma("GCC warning \"Deprecated constant!\"") C_Check_Circle_64px |
#define | C_Message_64px _Pragma("GCC warning \"Deprecated constant!\"") C_Review_64px |
#define | C_leftArrow32px _Pragma("GCC warning \"Deprecated constant!\"") C_Back_32px |
#define | C_Next32px _Pragma("GCC warning \"Deprecated constant!\"") C_Next_32px |
#define | C_round_cross_64px _Pragma("GCC warning \"Deprecated constant!\"") C_Denied_Circle_64px |
#define | NB_MAX_PAGES_WITH_DASHES 6 |
#define | SWIPE_MASK ((1 << SWIPED_UP) | (1 << SWIPED_DOWN) | (1 << SWIPED_LEFT) | (1 << SWIPED_RIGHT)) |
#define | LEFT_BUTTON 0x01 |
The different pressed buttons. More... | |
#define | RIGHT_BUTTON 0x02 |
Right button event. More... | |
#define | BOTH_BUTTONS 0x03 |
Both buttons event. More... | |
#define | RELEASED_MASK 0x80 |
released (see LSB bits to know what buttons are released) More... | |
#define | CONTINUOUS_MASK 0x40 |
300ms after the first 800ms) More... | |
Typedefs | |
typedef void(* | nbgl_buttonCallback_t) (void *obj, nbgl_buttonEvent_t buttonEvent) |
prototype of function to be called when a button event is received by an object (TODO: change to screen?) More... | |
typedef void(* | nbgl_touchCallback_t) (void *obj, nbgl_touchType_t eventType) |
prototype of function to be called when a touch event is received by an object More... | |
typedef struct PACKED__ nbgl_obj_s | nbgl_obj_t |
Common structure for all graphical objects. More... | |
typedef struct PACKED__ nbgl_container_s | nbgl_container_t |
struct to represent a container (CONTAINER type) More... | |
typedef struct PACKED__ nbgl_line_s | nbgl_line_t |
struct to represent a vertical or horizontal line More... | |
typedef nbgl_icon_details_t *(* | onImageDrawCallback_t) (uint8_t token) |
prototype of function to be called when a IMAGE object is drawned, and no buffer was provided More... | |
typedef struct PACKED__ nbgl_image_s | nbgl_image_t |
struct to represent an image (IMAGE type) More... | |
typedef struct PACKED__ nbgl_image_file_s | nbgl_image_file_t |
struct to represent an image file object (IMAGE_FILE type) The source of the data is an image file with header. width and height are given in this header More... | |
typedef struct PACKED__ nbgl_qrcode_s | nbgl_qrcode_t |
struct to represent a QR code (QR_CODE type), whose size is fixed More... | |
typedef struct PACKED__ nbgl_radio_s | nbgl_radio_t |
struct to represent a radio button (RADIO_BUTTON type) More... | |
typedef struct PACKED__ nbgl_switch_s | nbgl_switch_t |
struct to represent a switch (size is fixed) (SWITCH type) More... | |
typedef struct PACKED__ nbgl_progress_bar_s | nbgl_progress_bar_t |
struct to represent a progress bar (PROGRESS_BAR type) More... | |
typedef struct PACKED__ nbgl_navigation_bar_s | nbgl_page_indicator_t |
struct to represent a navigation bar (PAGE_INDICATOR type) There can be up to 5 page indicators, whose shape is fixed. If there are more than 5 pages, the middle indicator will be "..." More... | |
typedef char *(* | onTextDrawCallback_t) (uint8_t token) |
prototype of function to be called when a TEXT_AREA object is drawned, and no text was provided More... | |
typedef struct PACKED__ nbgl_button_s | nbgl_button_t |
struct to represent a button (BUTTON type) that can contain a text and/or an icon More... | |
typedef struct PACKED__ nbgl_text_area_s | nbgl_text_area_t |
struct to represent a text area (TEXT_AREA type) More... | |
typedef struct PACKED__ nbgl_text_entry_s | nbgl_text_entry_t |
struct to represent a text entry area (TEXT_ENTRY type) More... | |
typedef struct PACKED__ nbgl_mask_control_s | nbgl_mask_control_t |
typedef struct PACKED__ nbgl_spinner_s | nbgl_spinner_t |
struct to represent a "spinner", represented by the Ledger corners, in gray, with one of the corners in black (SPINNER type) More... | |
typedef void(* | keyboardCallback_t) (char touchedKey) |
prototype of function to be called when a valid key is pressed on keyboard Backspace is equal to 0x8 (ASCII code), Validate (for Keypad) is equal to 15 ('\r') More... | |
typedef struct PACKED__ nbgl_keyboard_s | nbgl_keyboard_t |
struct to represent a keyboard (KEYBOARD type) More... | |
typedef struct PACKED__ nbgl_keypad_s | nbgl_keypad_t |
struct to represent a keypad (KEYPAD type) More... | |
Functions | |
void | nbgl_refresh (void) |
This functions refreshes the actual screen on display with what has changed since the last refresh. More... | |
void | nbgl_refreshSpecial (nbgl_refresh_mode_t mode) |
This functions refreshes the actual screen on display with what has changed since the last refresh, according to the given mode (Black&White and other) More... | |
void | nbgl_refreshSpecialWithPostRefresh (nbgl_refresh_mode_t mode, nbgl_post_refresh_t post_refresh) |
bool | nbgl_refreshIsNeeded (void) |
This functions returns true if there is something to refresh. More... | |
void | nbgl_refreshReset (void) |
This functions resets all changes since the last refresh. More... | |
void | nbgl_objInit (void) |
This functions inits all internal of nbgl objects layer. More... | |
void | nbgl_objDraw (nbgl_obj_t *obj) |
This function draws or redraws the given object and its children (recursive version) More... | |
void | nbgl_objAllowDrawing (bool enable) |
This functions enables or disables drawing/refresh for all further calls. More... | |
uint8_t * | nbgl_objGetRAMBuffer (void) |
This function is used to get the all purpose RAM buffer. More... | |
bool | nbgl_objIsUx (nbgl_obj_t *obj) |
This function returns true if the object belongs to a UxScreen. More... | |
void | nbgl_objPoolRelease (uint8_t layer) |
Release the objects from the pool for the given layer. More... | |
nbgl_obj_t * | nbgl_objPoolGet (nbgl_obj_type_t type, uint8_t layer) |
Gets a new graphic object from the pool, with the given type. The type field of the object is set. More... | |
nbgl_obj_t * | nbgl_objPoolGetPrevious (nbgl_obj_t *obj, uint8_t layer) |
Gets a link to the previous object in the pool, for the given layer. (to be used with care) More... | |
uint8_t | nbgl_objPoolGetId (nbgl_obj_t *obj) |
Gets a unique index for the given object, in the pool. More... | |
int | nbgl_objPoolGetArray (nbgl_obj_type_t type, uint8_t nbObjs, uint8_t layer, nbgl_obj_t **objArray) |
Gets nbObjects new graphic object from the pool, with the given type, for the given layer (screen). The type field of the object is set. More... | |
uint8_t | nbgl_objPoolGetNbUsed (uint8_t layer) |
returns the number of objects currently used in the pool More... | |
void | nbgl_containerPoolRelease (uint8_t layer) |
Release the objects pointers from the pool for the given layer. More... | |
nbgl_obj_t ** | nbgl_containerPoolGet (uint8_t nbObjs, uint8_t layer) |
Gets a new container from the pool, with the given number of obj pointers. More... | |
uint8_t | nbgl_containerPoolGetNbUsed (uint8_t layer) |
returns the number of containers currently used in the pool More... | |
void | nbgl_objDrawKeyboard (nbgl_keyboard_t *kbd) |
This function draws a keyboard object. More... | |
void | nbgl_objDrawKeypad (nbgl_keypad_t *kbd) |
This function draws a keypad object. More... | |
void | nbgl_keyboardTouchCallback (nbgl_obj_t *obj, nbgl_touchType_t eventType) |
function to be called when the keyboard object is touched More... | |
void | nbgl_keypadTouchCallback (nbgl_obj_t *obj, nbgl_touchType_t eventType) |
function to be called when the keypad object is touched More... | |
bool | nbgl_keyboardGetPosition (nbgl_keyboard_t *kbd, char index, uint16_t *x, uint16_t *y) |
This function gets the position (top-left corner) of the key at the given index. (to be used for Testing purpose) More... | |
bool | nbgl_keypadGetPosition (nbgl_keypad_t *kbd, char index, uint16_t *x, uint16_t *y) |
This function gets the position (top-left corner) of the key at the given index. (to be used for Testing purpose). Only works without shuffling. More... | |
API to draw all basic graphic objects.
Definition in file nbgl_obj.h.
#define BACK_BUTTON_HEADER_HEIGHT 96 |
Definition at line 79 of file nbgl_obj.h.
#define BACKSPACE_ICON C_Erase_40px |
Definition at line 132 of file nbgl_obj.h.
#define BACKSPACE_KEY 8 |
Definition at line 26 of file nbgl_obj.h.
#define BACKSPACE_KEY_INDEX 28 |
Definition at line 41 of file nbgl_obj.h.
#define BORDER_MARGIN 32 |
Definition at line 71 of file nbgl_obj.h.
#define BOTH_BUTTONS 0x03 |
Both buttons event.
Definition at line 176 of file nbgl_obj.h.
#define BOTTOM_BORDER_MARGIN 24 |
Definition at line 72 of file nbgl_obj.h.
#define BUTTON_DIAMETER 88 |
Definition at line 88 of file nbgl_obj.h.
#define BUTTON_RADIUS RADIUS_44_PIXELS |
Definition at line 87 of file nbgl_obj.h.
#define C_leftArrow32px _Pragma("GCC warning \"Deprecated constant!\"") C_Back_32px |
Definition at line 156 of file nbgl_obj.h.
#define C_Message_64px _Pragma("GCC warning \"Deprecated constant!\"") C_Review_64px |
Definition at line 155 of file nbgl_obj.h.
#define C_Next32px _Pragma("GCC warning \"Deprecated constant!\"") C_Next_32px |
Definition at line 157 of file nbgl_obj.h.
#define C_round_check_64px _Pragma("GCC warning \"Deprecated constant!\"") C_Check_Circle_64px |
Definition at line 154 of file nbgl_obj.h.
#define C_round_cross_64px _Pragma("GCC warning \"Deprecated constant!\"") C_Denied_Circle_64px |
Definition at line 158 of file nbgl_obj.h.
#define C_round_warning_64px _Pragma("GCC warning \"Deprecated constant!\"") C_Important_Circle_64px |
Definition at line 153 of file nbgl_obj.h.
#define C_warning64px _Pragma("GCC warning \"Deprecated constant!\"") C_Warning_64px |
Definition at line 152 of file nbgl_obj.h.
#define CHEVRON_BACK_ICON C_Chevron_Back_40px |
Definition at line 141 of file nbgl_obj.h.
#define CHEVRON_NEXT_ICON C_Chevron_Next_40px |
Definition at line 142 of file nbgl_obj.h.
#define CLOSE_ICON C_Close_40px |
Definition at line 143 of file nbgl_obj.h.
#define CONTINUOUS_MASK 0x40 |
300ms after the first 800ms)
if set, means that the button(s) is continuously pressed (this event is sent every
Definition at line 180 of file nbgl_obj.h.
#define DIGITS_SWITCH_KEY_INDEX 27 |
Definition at line 40 of file nbgl_obj.h.
#define INFO_I_ICON C_Info_40px |
Definition at line 145 of file nbgl_obj.h.
#define KEYBOARD_KEY_HEIGHT 72 |
Definition at line 35 of file nbgl_obj.h.
#define KEYPAD_KEY_HEIGHT 88 |
Definition at line 55 of file nbgl_obj.h.
#define KEYPAD_MAX_DIGITS 12 |
Definition at line 59 of file nbgl_obj.h.
#define LEFT_ARROW_ICON C_Back_40px |
Definition at line 139 of file nbgl_obj.h.
#define LEFT_BUTTON 0x01 |
#define MINI_PUSH_ICON C_Mini_Push_40px |
Definition at line 147 of file nbgl_obj.h.
#define NB_MAX_PAGES_WITH_DASHES 6 |
Definition at line 161 of file nbgl_obj.h.
#define PUSH_ICON C_Chevron_40px |
Definition at line 138 of file nbgl_obj.h.
#define QRCODE_ICON C_QRCode_40px |
Definition at line 146 of file nbgl_obj.h.
#define RADIO_HEIGHT 40 |
Definition at line 107 of file nbgl_obj.h.
#define RADIO_OFF_ICON C_radio_inactive_40px |
Definition at line 136 of file nbgl_obj.h.
#define RADIO_ON_ICON C_radio_active_40px |
Definition at line 137 of file nbgl_obj.h.
#define RADIO_WIDTH 40 |
Definition at line 106 of file nbgl_obj.h.
#define RELEASED_MASK 0x80 |
released (see LSB bits to know what buttons are released)
Definition at line 177 of file nbgl_obj.h.
#define RIGHT_ARROW_ICON C_Next_40px |
Definition at line 140 of file nbgl_obj.h.
#define RIGHT_BUTTON 0x02 |
Right button event.
Definition at line 175 of file nbgl_obj.h.
#define SHIFT_ICON C_Maj_40px |
Definition at line 133 of file nbgl_obj.h.
#define SHIFT_KEY_INDEX 26 |
Definition at line 39 of file nbgl_obj.h.
#define SHIFT_LOCKED_ICON C_Maj_Lock_40px |
Definition at line 134 of file nbgl_obj.h.
#define SPACE_ICON C_Space_40px |
Definition at line 131 of file nbgl_obj.h.
#define SPACE_KEY_INDEX 29 |
Definition at line 42 of file nbgl_obj.h.
#define SPECIAL_KEYS_INDEX 30 |
Definition at line 43 of file nbgl_obj.h.
#define SPINNER_HEIGHT 48 |
Definition at line 98 of file nbgl_obj.h.
#define SPINNER_WIDTH 64 |
Definition at line 97 of file nbgl_obj.h.
#define SWIPE_MASK ((1 << SWIPED_UP) | (1 << SWIPED_DOWN) | (1 << SWIPED_LEFT) | (1 << SWIPED_RIGHT)) |
Definition at line 167 of file nbgl_obj.h.
#define VALIDATE_ICON C_Check_40px |
Definition at line 135 of file nbgl_obj.h.
#define VALIDATE_KEY '\r' |
Definition at line 27 of file nbgl_obj.h.
#define WARNING_ICON C_Warning_40px |
Definition at line 148 of file nbgl_obj.h.
#define WHEEL_ICON C_Settings_40px |
Definition at line 144 of file nbgl_obj.h.
typedef void(* keyboardCallback_t) (char touchedKey) |
prototype of function to be called when a valid key is pressed on keyboard Backspace is equal to 0x8 (ASCII code), Validate (for Keypad) is equal to 15 ('\r')
touchedKey | char typed on keyboard |
Definition at line 466 of file nbgl_obj.h.
typedef struct PACKED__ nbgl_button_s nbgl_button_t |
struct to represent a button (BUTTON type) that can contain a text and/or an icon
typedef void(* nbgl_buttonCallback_t) (void *obj, nbgl_buttonEvent_t buttonEvent) |
prototype of function to be called when a button event is received by an object (TODO: change to screen?)
obj | the concerned object |
buttonState | event on buttons |
Definition at line 200 of file nbgl_obj.h.
typedef struct PACKED__ nbgl_container_s nbgl_container_t |
struct to represent a container (CONTAINER type)
typedef struct PACKED__ nbgl_image_file_s nbgl_image_file_t |
struct to represent an image file object (IMAGE_FILE type) The source of the data is an image file with header. width and height are given in this header
typedef struct PACKED__ nbgl_image_s nbgl_image_t |
struct to represent an image (IMAGE type)
typedef struct PACKED__ nbgl_keyboard_s nbgl_keyboard_t |
struct to represent a keyboard (KEYBOARD type)
typedef struct PACKED__ nbgl_keypad_s nbgl_keypad_t |
struct to represent a keypad (KEYPAD type)
typedef struct PACKED__ nbgl_line_s nbgl_line_t |
struct to represent a vertical or horizontal line
typedef struct PACKED__ nbgl_mask_control_s nbgl_mask_control_t |
typedef struct PACKED__ nbgl_obj_s nbgl_obj_t |
Common structure for all graphical objects.
typedef struct PACKED__ nbgl_navigation_bar_s nbgl_page_indicator_t |
struct to represent a navigation bar (PAGE_INDICATOR type) There can be up to 5 page indicators, whose shape is fixed. If there are more than 5 pages, the middle indicator will be "..."
typedef struct PACKED__ nbgl_progress_bar_s nbgl_progress_bar_t |
struct to represent a progress bar (PROGRESS_BAR type)
typedef struct PACKED__ nbgl_qrcode_s nbgl_qrcode_t |
struct to represent a QR code (QR_CODE type), whose size is fixed
typedef struct PACKED__ nbgl_radio_s nbgl_radio_t |
struct to represent a radio button (RADIO_BUTTON type)
typedef struct PACKED__ nbgl_spinner_s nbgl_spinner_t |
struct to represent a "spinner", represented by the Ledger corners, in gray, with one of the corners in black (SPINNER type)
typedef struct PACKED__ nbgl_switch_s nbgl_switch_t |
struct to represent a switch (size is fixed) (SWITCH type)
typedef struct PACKED__ nbgl_text_area_s nbgl_text_area_t |
struct to represent a text area (TEXT_AREA type)
typedef struct PACKED__ nbgl_text_entry_s nbgl_text_entry_t |
struct to represent a text entry area (TEXT_ENTRY type)
typedef void(* nbgl_touchCallback_t) (void *obj, nbgl_touchType_t eventType) |
prototype of function to be called when a touch event is received by an object
obj | the concerned object |
eventType | type of touch event |
Definition at line 221 of file nbgl_obj.h.
typedef nbgl_icon_details_t*(* onImageDrawCallback_t) (uint8_t token) |
prototype of function to be called when a IMAGE object is drawned, and no buffer was provided
token | provided token in IMAGE object |
Definition at line 280 of file nbgl_obj.h.
typedef char*(* onTextDrawCallback_t) (uint8_t token) |
prototype of function to be called when a TEXT_AREA object is drawned, and no text was provided
token | provided token in TEXT_AREA object |
Definition at line 387 of file nbgl_obj.h.
anonymous enum |
ids of touchable objects, for external stimulus (by Testing environment)
Definition at line 544 of file nbgl_obj.h.
enum keyboardCase_t |
Letters casing in which to open/set the keyboard.
Enumerator | |
---|---|
LOWER_CASE | lower case mode |
UPPER_CASE | upper case mode for one character |
LOCKED_UPPER_CASE | locked upper case mode |
Definition at line 489 of file nbgl_obj.h.
enum keyboardMode_t |
Mode in which to open/set the keyboard.
Enumerator | |
---|---|
MODE_LETTERS | letters mode |
MODE_DIGITS | digits and some special characters mode |
MODE_SPECIAL | extended special characters mode |
Definition at line 472 of file nbgl_obj.h.
enum nbgl_buttonEvent_t |
Definition at line 182 of file nbgl_obj.h.
Style to apply to nbgl_page_indicator_t.
Enumerator | |
---|---|
PROGRESSIVE_INDICATOR | all dashes before active page are black |
CURRENT_INDICATOR | only current page dash is black |
Definition at line 362 of file nbgl_obj.h.
nbgl_obj_t** nbgl_containerPoolGet | ( | uint8_t | nbObjs, |
uint8_t | layer | ||
) |
Gets a new container from the pool, with the given number of obj pointers.
nbObjs | number of objects pointers for the container |
layer | layer (screen) to get the container to |
Definition at line 290 of file nbgl_obj_pool.c.
returns the number of containers currently used in the pool
Definition at line 334 of file nbgl_obj_pool.c.
void nbgl_containerPoolRelease | ( | uint8_t | layer | ) |
Release the objects pointers from the pool for the given layer.
layer | layer to release objects pointers from |
Definition at line 265 of file nbgl_obj_pool.c.
bool nbgl_keyboardGetPosition | ( | nbgl_keyboard_t * | kbd, |
char | index, | ||
uint16_t * | x, | ||
uint16_t * | y | ||
) |
This function gets the position (top-left corner) of the key at the given index. (to be used for Testing purpose)
kbd | the object to be drawned |
index | ascii character (in lower-case) |
x | [out] the top-left position |
y | [out] the top-left position |
Definition at line 644 of file nbgl_obj_keyboard.c.
void nbgl_keyboardTouchCallback | ( | nbgl_obj_t * | obj, |
nbgl_touchType_t | eventType | ||
) |
function to be called when the keyboard object is touched
obj | touched object (keyboard) |
eventType | type of touch (only TOUCHED is accepted) |
Definition at line 526 of file nbgl_obj_keyboard.c.
bool nbgl_keypadGetPosition | ( | nbgl_keypad_t * | kpd, |
char | index, | ||
uint16_t * | x, | ||
uint16_t * | y | ||
) |
This function gets the position (top-left corner) of the key at the given index. (to be used for Testing purpose). Only works without shuffling.
kpd | the object to be drawned |
index | the char of the key |
x | [out] the top-left position |
y | [out] the top-left position |
Definition at line 337 of file nbgl_obj_keypad.c.
void nbgl_keypadTouchCallback | ( | nbgl_obj_t * | obj, |
nbgl_touchType_t | eventType | ||
) |
function to be called when the keypad object is touched
obj | touched object (keypad) |
eventType | type of touch (only TOUCHED is accepted) |
Definition at line 270 of file nbgl_obj_keypad.c.
void nbgl_objAllowDrawing | ( | bool | enable | ) |
This functions enables or disables drawing/refresh for all further calls.
enable | if true, enables drawing/refresh, otherwise disables |
Definition at line 1651 of file nbgl_obj.c.
void nbgl_objDraw | ( | nbgl_obj_t * | obj | ) |
This function draws or redraws the given object and its children (recursive version)
obj | the object to redraw |
Definition at line 1522 of file nbgl_obj.c.
void nbgl_objDrawKeyboard | ( | nbgl_keyboard_t * | kbd | ) |
This function draws a keyboard object.
kbd | the object to be drawned |
Definition at line 692 of file nbgl_obj_keyboard.c.
void nbgl_objDrawKeypad | ( | nbgl_keypad_t * | kpd | ) |
This function draws a keypad object.
kpd | keypad object to draw |
Definition at line 376 of file nbgl_obj_keypad.c.
uint8_t* nbgl_objGetRAMBuffer | ( | void | ) |
This function is used to get the all purpose RAM buffer.
Definition at line 1661 of file nbgl_obj.c.
void nbgl_objInit | ( | void | ) |
This functions inits all internal of nbgl objects layer.
Definition at line 1636 of file nbgl_obj.c.
bool nbgl_objIsUx | ( | nbgl_obj_t * | obj | ) |
This function returns true if the object belongs to a UxScreen.
Definition at line 1671 of file nbgl_obj.c.
nbgl_obj_t* nbgl_objPoolGet | ( | nbgl_obj_type_t | type, |
uint8_t | layer | ||
) |
Gets a new graphic object from the pool, with the given type. The type field of the object is set.
type | type of object to get from the pool |
layer | layer to get object for |
Definition at line 164 of file nbgl_obj_pool.c.
int nbgl_objPoolGetArray | ( | nbgl_obj_type_t | type, |
uint8_t | nbObjs, | ||
uint8_t | layer, | ||
nbgl_obj_t ** | objArray | ||
) |
Gets nbObjects new graphic object from the pool, with the given type, for the given layer (screen). The type field of the object is set.
type | type of objects to get from the pool |
nbObjs | number of objects to get from the pool |
layer | layer (screen) to get the object to |
objArray | array of objs pointers |
Definition at line 242 of file nbgl_obj_pool.c.
uint8_t nbgl_objPoolGetId | ( | nbgl_obj_t * | obj | ) |
Gets a unique index for the given object, in the pool.
obj | object to get id from |
Definition at line 223 of file nbgl_obj_pool.c.
returns the number of objects currently used in the pool
Definition at line 147 of file nbgl_obj_pool.c.
nbgl_obj_t* nbgl_objPoolGetPrevious | ( | nbgl_obj_t * | obj, |
uint8_t | layer | ||
) |
Gets a link to the previous object in the pool, for the given layer. (to be used with care)
obj | object to get previous from |
layer | layer (screen) in which to retrieve the object |
Definition at line 201 of file nbgl_obj_pool.c.
void nbgl_objPoolRelease | ( | uint8_t | layer | ) |
Release the objects from the pool for the given layer.
layer | layer to release object from |
Definition at line 126 of file nbgl_obj_pool.c.
void nbgl_refresh | ( | void | ) |
This functions refreshes the actual screen on display with what has changed since the last refresh.
Definition at line 1561 of file nbgl_obj.c.
bool nbgl_refreshIsNeeded | ( | void | ) |
This functions returns true if there is something to refresh.
Definition at line 1607 of file nbgl_obj.c.
void nbgl_refreshReset | ( | void | ) |
This functions resets all changes since the last refresh.
Definition at line 1619 of file nbgl_obj.c.
void nbgl_refreshSpecial | ( | nbgl_refresh_mode_t | mode | ) |
This functions refreshes the actual screen on display with what has changed since the last refresh, according to the given mode (Black&White and other)
mode | mode of refresh |
Definition at line 1571 of file nbgl_obj.c.
void nbgl_refreshSpecialWithPostRefresh | ( | nbgl_refresh_mode_t | mode, |
nbgl_post_refresh_t | post_refresh | ||
) |
Definition at line 1587 of file nbgl_obj.c.