rtos_Widget Class Reference

RTOS wrapper for Widget class. More...

#include <rtos_widget.h>

Inheritance diagram for rtos_Widget:

Collaboration diagram for rtos_Widget:

Public Member Functions
	rtos_Widget (rtos_Model *actual_displayed_model, rtos_DisplayDevice *display_device=nullptr)
	constructor for RTOS widget
	~rtos_Widget ()
	destructor for RTOS widget
void	set_display_device (rtos_DisplayDevice *_new_display_device)
	Set the display screen object.
void	update_widget_anchor (uint8_t x, uint8_t y)
	Modify the anchor of the widget on the display screen.
void	add_widget (rtos_Widget *_sub_widget)
	add sub_widget to the current widget
virtual void	draw ()=0
	a pure virtual member that is called to effectively draw the widget.
virtual void	get_value_of_interest ()=0
	A pure virtual method that results in the transfer of the displayed values of the displayed model to the widget.

Public Attributes
rtos_DisplayDevice *	display_device {nullptr}
	the display device where the attached to the frame buffer
uint8_t	widget_anchor_x
	location in x of the widget within the hosting framebuffer
uint8_t	widget_anchor_y
	location in y of the widget within the hosting framebuffer
struct_WidgetDataToGateKeeper	widget_data_to_gatekeeper
	data structure used to queue widget data to send to the display task
TaskHandle_t	task_handle
	FreeRTOS task handle associated to the widget.

Protected Attributes
rtos_Model *	actual_rtos_displayed_model {nullptr}
	a pointer to the Model actually displayed by the widget
std::vector< rtos_Widget * >	rtos_widgets
	A rtos_widget can be composed by several rtos_widgets.

Detailed Description

RTOS wrapper for Widget class.

Constructor & Destructor Documentation

rtos_Widget()

rtos_Widget::rtos_Widget	(	rtos_Model *	actual_displayed_model,
		rtos_DisplayDevice *	display_device = nullptr )

constructor for RTOS widget

Parameters

actual_displayed_model	the displayed model of the widget
display_device	The display device on which the widget is drawn. This device can be "null".

Here is the caller graph for this function:

Member Function Documentation

add_widget()

void rtos_Widget::add_widget

(

rtos_Widget *

_sub_widget

)

add sub_widget to the current widget

Parameters

_sub_widget

Here is the call graph for this function:

draw()

virtual void rtos_Widget::draw ( )

pure virtual

a pure virtual member that is called to effectively draw the widget.

Note

USAGE: This member function can be called by the draw_refresh_all_attached_widgets() method of the Model. Refer to the following diagram.

set_display_device()

void rtos_Widget::set_display_device

(

rtos_DisplayDevice *

_new_display_device

)

Set the display screen object.

Parameters

_new_display_device

update_widget_anchor()

void rtos_Widget::update_widget_anchor	(	uint8_t	x,
		uint8_t	y )

Modify the anchor of the widget on the display screen.

Parameters

x	anchor x coordinate
y	anchor y coordinate

---

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

• rtos_widget.h
• rtos_widget.cpp