Helps build and manage the LVGL objects and screens for the application code. More...

Public Member Functions
	ws_display_ui_helper (ws_display_driver *drv)
	Constructor for the ws_display_ui_helper class. More...

void	set_bg_black ()
	Sets the screen's background to a black color.

void	show_scr_load ()
	Builds and displays the loading screen.

void	clear_scr_load ()
	Deletes all objects/styles off the load screen and frees their resources.

void	build_scr_monitor ()
	Build and display the monitor screen.

void	add_text_to_terminal (const char *text)
	Add text on the terminal label and displays it. More...

void	set_load_bar_icon_complete (loadBarIcons iconType)
	Sets the color of an icon on the loading screen to green. More...

void	set_label_status (const char *text)
	Sets the text of the status label on the loading screen. More...

void	remove_tip_timer ()
	Pauses and deletes the loading tip callback timer.

void	show_scr_error (const char lblError, const char lblDesc)
	Build and display an error screen. More...

bool	getLoadingState ()
	Returns the loading screen's state. More...

Detailed Description

Helps build and manage the LVGL objects and screens for the application code.

Constructor & Destructor Documentation

ws_display_ui_helper::ws_display_ui_helper ( ws_display_driver * drv )

inline

Constructor for the ws_display_ui_helper class.

Parameters

drv	Pointer to the display driver.

void ws_display_ui_helper::add_text_to_terminal ( const char * text )

Add text on the terminal label and displays it.

Parameters

text	Text to display on the terminal, should end in "\n"

void ws_display_ui_helper::set_load_bar_icon_complete ( loadBarIcons iconType )

Sets the color of an icon on the loading screen to green.

Parameters

iconType Desired icon.

void ws_display_ui_helper::set_label_status ( const char * text )

Sets the text of the status label on the loading screen.

Parameters

text	Desired text to write to the status label.

void ws_display_ui_helper::show_scr_error	(	const char *	lblError,
		const char *	lblDesc
	)

Build and display an error screen.

Parameters

lblError	The generic error.
lblDesc	Instructions or steps to resolve the error.

bool ws_display_ui_helper::getLoadingState ( )

Returns the loading screen's state.

Returns: The loading state, True if loading screen is active, False otherwise.

The documentation for this class was generated from the following files: