MaxOS::gui::widgets::Text Class Reference

A box that can be used to display text. More...

#include <text.h>

Inheritance diagram for MaxOS::gui::widgets::Text:

Public Member Functions
	Text (int32_t left, int32_t top, uint32_t width, uint32_t height, const string &text)
	Construct a new Text object at a specific position and size with text.
void	draw (common::GraphicsContext *gc, common::Rectangle< int32_t > &area) override
	Draw the text on the screen.
void	update_text (const string &)
	Update the text of the widget.
Public Member Functions inherited from MaxOS::gui::Widget
	Widget ()
	Construct a new Widget object.
	Widget (int32_t left, int32_t top, uint32_t width, uint32_t height)
	Construct a new Widget object at a specific position and size.
void	invalidate ()
	Invalidates the entire widget. This forces the widget to be redrawn on the next screen update.
virtual void	invalidate (common::Rectangle< int32_t > &area)
	Invalidates a specific area of the widget. This forces that part of the screen to be redrawn on the next screen update.
virtual void	add_child (Widget *child)
	Set the parent of a widget to this widget, making it into a child.
virtual common::Coordinates	absolute_coordinates (common::Coordinates coordinates)
	Get the absolute coordinates of the widget (relative to the screen)
virtual bool	contains_coordinate (uint32_t x, uint32_t y)
	Check if the widget contains a specific coordinate.
common::Rectangle< int32_t >	position ()
	Get the position of the widget.
void	move (int32_t left, int32_t top)
	Set the position of the widget, and invalidate the old and new positions so they are redrawn.
void	resize (int32_t width, int32_t height)
	Set the size of the widget, and invalidate the old and new positions so they are redrawn.
void	focus ()
	Set the current focused widget to be this widget.
virtual void	on_focus ()
	Handles the event when the widget is focussed.
virtual void	on_focus_lost ()
	Handles the event when the widget is unfocused.
void	bring_to_front ()
	Brings this widget to the front of the screen.
virtual void	on_mouse_enter_widget (uint32_t to_x, uint32_t to_y)
	Handles the event when the mouse is moved on to the widget.
virtual void	on_mouse_leave_widget (uint32_t from_x, uint32_t from_y)
	Handles the event when the mouse is moved out of the widget.
virtual void	on_mouse_move_widget (uint32_t from_x, uint32_t from_y, uint32_t to_x, uint32_t to_y)
	Handles the event when the mouse is moved over the widget.
virtual drivers::peripherals::MouseEventHandler *	on_mouse_button_pressed (uint32_t x, uint32_t y, uint8_t button)
	Handles the event when the mouse is pressed on the widget.
virtual void	on_mouse_button_released (uint32_t x, uint32_t y, uint8_t button)
	Handles the event when the mouse is released on the widget.
Public Member Functions inherited from MaxOS::drivers::peripherals::KeyboardEventHandler
common::Event< KeyboardEvents > *	on_event (common::Event< KeyboardEvents > *) override
	Handle the trigger of an event.
virtual void	on_key_down (KeyCode, const KeyboardState &)
	Handle the key down event.
virtual void	on_key_up (KeyCode, const KeyboardState &)
	Handle the key up event.
Public Member Functions inherited from MaxOS::common::EventHandler< KeyboardEvents >
virtual Event< KeyboardEvents > *	on_event (Event< KeyboardEvents > *event)
	This function is called when an event is raised.

Public Attributes
gui::Font	font
	The font to use for the text.
common::Colour	foreground_colour
	The colour of the text characters.
common::Colour	background_colour
	The colour to draw behind the text characters.

Additional Inherited Members
Protected Member Functions inherited from MaxOS::gui::Widget
virtual void	set_focus (Widget *)
	Sets the widget that is currently focussed.
virtual void	bring_to_front (Widget *)
	Brings a specific widget to the front of the screen.
Protected Attributes inherited from MaxOS::gui::Widget
common::Rectangle< int32_t >	m_position
	The position and size of the widget (relative to its parent)
Widget *	m_parent { nullptr }
	The widget that owns this widget.
bool	m_valid { false }
	Is the widget drawn to the screen and up to date.
uint32_t	m_min_width { 5 }
	The smallest m_width the widget can be resized to.
uint32_t	m_min_height { 5 }
	The smallest m_height the widget can be resized to.
uint32_t	m_max_width { 0x8FFFFFFF }
	The largest m_width the widget can be resized to.
uint32_t	m_max_height { 0x8FFFFFFF }
	The largest m_height the widget can be resized to.

Detailed Description

A box that can be used to display text.

Definition at line 24 of file text.h.

Constructor & Destructor Documentation

Text()

Text::Text	(	int32_t	left,
		int32_t	top,
		uint32_t	width,
		uint32_t	height,
		const string &	text
	)

Construct a new Text object at a specific position and size with text.

Parameters

left	How many pixels from the left of the parent widget the text is
top	How many pixels from the top of the parent widget the text is
width	How many pixels wide the text area is
height	How many pixels tall the text area is
text	The text to display

Definition at line 26 of file text.cpp.

: Widget(left, top, width, height),
  font((uint8_t*) AMIGA_FONT),
  foreground_colour(Colour(0, 0, 0)),
  background_colour(Colour(255, 255, 255))
{
 
    // Set the text
    update_text(text);
}

References update_text().

Member Function Documentation

draw()

void Text::draw ( common::GraphicsContext *  gc, common::Rectangle< int32_t > &  area  )

overridevirtual

Draw the text on the screen.

Parameters

gc	The graphics context to draw on
area	The area of the text to draw

Reimplemented from MaxOS::gui::Widget.

Definition at line 45 of file text.cpp.

                                                             {
 
    // Default Draw Operation
    Widget::draw(gc, area);
 
    // Get the absolute m_position of the text
    Coordinates textCoordinates = absolute_coordinates(Coordinates(0, 0));
    Rectangle<int32_t> text_position = position();
 
    // Get the x and y m_position of the text
    int32_t x = textCoordinates.first;
    int32_t y = textCoordinates.second;
 
    // Draw the background (as the text might not fill the entire area)
    gc->fill_rectangle(x + area.left, y + area.top, x + area.left + area.width, y + area.top + area.height, background_colour);
 
    // Draw the text
    this->font.draw_text(x, y, foreground_colour, background_colour, gc, m_widget_text, area);
}

References MaxOS::gui::Widget::absolute_coordinates(), background_colour, MaxOS::gui::Widget::draw(), MaxOS::gui::Font::draw_text(), font, foreground_colour, MaxOS::common::Rectangle< Type >::height, MaxOS::common::Rectangle< Type >::left, MaxOS::gui::Widget::position(), MaxOS::common::Rectangle< Type >::top, and MaxOS::common::Rectangle< Type >::width.

update_text()

void Text::update_text

(

const string &

new_text

)

Update the text of the widget.

Parameters

new_text

The new text to display

Definition at line 69 of file text.cpp.

                                             {
 
    // Set the text
    m_widget_text.copy(new_text);
    invalidate();
 
}

References MaxOS::gui::Widget::invalidate().

Referenced by Text().

Member Data Documentation

background_colour

common::Colour MaxOS::gui::widgets::Text::background_colour

The colour to draw behind the text characters.

Definition at line 34 of file text.h.

Referenced by draw(), MaxOS::gui::Window::Window(), and MaxOS::gui::Window::Window().

font

gui::Font MaxOS::gui::widgets::Text::font

The font to use for the text.

Definition at line 31 of file text.h.

Referenced by draw().

foreground_colour

common::Colour MaxOS::gui::widgets::Text::foreground_colour

The colour of the text characters.

Definition at line 33 of file text.h.

Referenced by draw(), MaxOS::gui::Window::Window(), and MaxOS::gui::Window::Window().

---

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

• /home/runner/work/MaxOS/MaxOS/kernel/include/gui/widgets/text.h
• /home/runner/work/MaxOS/MaxOS/kernel/src/gui/widgets/text.cpp