C++ DevKit
C++ set of OOP library
Loading...
Searching...
No Matches
rtos_TextWidget Class Reference

RTOS wrapper for TextWidget class. More...

#include <rtos_widget.h>

Inheritance diagram for rtos_TextWidget:
Inheritance graph
Collaboration diagram for rtos_TextWidget:
Collaboration graph

Public Member Functions

 rtos_TextWidget (rtos_Model *actual_displayed_model, struct_ConfigTextWidget text_cfg, CanvasFormat canvas_format, rtos_DisplayDevice *display_device)
 Construct a new Text Widget object.
 
 rtos_TextWidget (rtos_Model *actual_displayed_model, struct_ConfigTextWidget text_cfg, CanvasFormat canvas_format, size_t frame_width, size_t frame_height, rtos_DisplayDevice *display_device)
 Construct a new Text Widget object.
 
- Public Member Functions inherited from rtos_Widget
 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

TextWriterwriter
 the text writer associated to the widget
 
- Public Attributes inherited from rtos_Widget
rtos_DisplayDevicedisplay_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.
 

Additional Inherited Members

- Protected Attributes inherited from rtos_Widget
rtos_Modelactual_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 TextWidget class.

Constructor & Destructor Documentation

◆ rtos_TextWidget() [1/2]

rtos_TextWidget::rtos_TextWidget ( rtos_Model * actual_displayed_model,
struct_ConfigTextWidget text_cfg,
CanvasFormat canvas_format,
rtos_DisplayDevice * display_device )

Construct a new Text Widget object.

Note
USAGE: when the text frame is defined by the number of characters width and height.
Parameters
actual_displayed_modelthe displayed model of the widget
text_cfgthe configuration data for the textual frame
canvas_formatthe format of the associated canvas (see CanvasFormat)
display_devicethe display device on which the widget is drawn
Here is the call graph for this function:

◆ rtos_TextWidget() [2/2]

rtos_TextWidget::rtos_TextWidget ( rtos_Model * actual_displayed_model,
struct_ConfigTextWidget text_cfg,
CanvasFormat canvas_format,
size_t frame_width,
size_t frame_height,
rtos_DisplayDevice * display_device )

Construct a new Text Widget object.

Note
USAGE: when the text frame is defined by the frame size width and height in pixel.
Parameters
actual_displayed_modelthe displayed model of the widget
text_cfgthe configuration data for the textual frame
canvas_formatthe format of the associated canvas (see CanvasFormat)
frame_widththe frame size width
frame_heightthe frame size height
display_devicethe display device on which the widget is drawn
Here is the call graph for this function:

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