#include <hikogui/widgets/text_widget.hpp>

Inheritance diagram for hi::v1::text_widget:

Public Types
using	super = widget

using	delegate_type = text_delegate

Public Member Functions
	text_widget (widget *parent, std::shared_ptr< delegate_type > delegate) noexcept
	Construct a text widget.

	text_widget (widget *parent, std::shared_ptr< delegate_type > delegate, text_widget_attribute auto &&...attributes) noexcept

	text_widget (widget *parent, different_from< std::shared_ptr< delegate_type > > auto &&text, text_widget_attribute auto &&...attributes) noexcept
	Construct a text widget.

Public Member Functions inherited from hi::v1::widget
	widget (widget *parent) noexcept

	widget (const widget &)=delete

widget &	operator= (const widget &)=delete

	widget (widget &&)=delete

widget &	operator= (widget &&)=delete

virtual hitbox	hitbox_test_from_parent (point3 position) const noexcept
	Call hitbox_test from a parent widget.

virtual hitbox	hitbox_test_from_parent (point3 position, hitbox sibling_hitbox) const noexcept
	Call hitbox_test from a parent widget.

widget_constraints const &	constraints () const noexcept

widget_layout const &	layout () const noexcept
	Get the current layout for this widget.

virtual bool	process_event (gui_event const &event) const noexcept

void	request_redraw () const noexcept
	Request the widget to be redrawn on the next frame.

virtual bool	handle_event_recursive (gui_event const &event, std::vector< widget const * > const &reject_list=std::vector< widget const * >{}) noexcept
	Handle command recursive.

virtual widget const *	find_next_widget (widget const *current_keyboard_widget, keyboard_focus_group group, keyboard_focus_direction direction) const noexcept
	Find the next widget that handles keyboard focus.

widget const *	find_first_widget (keyboard_focus_group group) const noexcept

widget const *	find_last_widget (keyboard_focus_group group) const noexcept

bool	is_first (keyboard_focus_group group) const noexcept
	Is this widget the first widget in the parent container.

bool	is_last (keyboard_focus_group group) const noexcept
	Is this widget the last widget in the parent container.

virtual void	scroll_to_show (hi::aarectangle rectangle) noexcept
	Scroll to show the given rectangle on the window.

void	scroll_to_show () noexcept
	Scroll to show the important part of the widget.

std::vector< widget const * >	parent_chain () const noexcept
	Get a list of parents of a given widget.

virtual color	background_color () const noexcept

virtual color	foreground_color () const noexcept

virtual color	focus_color () const noexcept

virtual color	accent_color () const noexcept

virtual color	label_color () const noexcept

Data Fields
std::shared_ptr< delegate_type >	delegate

observer< alignment >	alignment = hi::alignment::middle_center()
	The horizontal alignment of the text inside the space of the widget.

observer< semantic_text_style >	text_style = semantic_text_style::label
	The style of the text.

Data Fields inherited from hi::v1::widget
widget *	parent
	Pointer to the parent widget.

std::string	id
	A name of widget, should be unique between siblings.

observer< widget_mode >	mode = widget_mode::enabled
	The widget mode.

observer< bool >	hover = false
	Mouse cursor is hovering over the widget.

observer< bool >	focus = false
	The widget has keyboard focus.

int	semantic_layer
	The draw layer of the widget.

int	logical_layer
	The logical layer of the widget.

Detailed Description

A text widget.

The text widget is a widget for displaying, selecting and editing text.

On its own it can be used to edit multiple lines of text, but it will probably be used embedded inside other widgets, like:

label_widget to display translated text together with an optional icon.
text_field_widget to edit a value of diffent types, includig integers, floating point, strings, etc.

Features:

Multiple paragraphs.
Uses the unicode line break algorithm to wrap lines when not enough horizontal space.
Used the unicode word break algorithm for selecting and moving through words.
Uses the unicode scentence break algorithm for selecting and moving through scentences.
Uses the unicode bidi algorithm for displaying text in mixed left-to-right & right-to-left languages.
Displays secondary cursor where text in the other language-direction will be inserted.
Keeps track if the user has just worked in left-to-right or right-to-left language.
Arrow keys move the cursor visually through the text
Handles insertion and overwrite mode; showing a caret or box cursor.
When entering dead-key on the keyboard the dead-key character is displayed underneath a secondary overwrite cursor.
Cut, Copy & Paste.
Undo & Redo.

Constructor & Destructor Documentation

◆ text_widget() [1/2]

hi::v1::text_widget::text_widget	(	widget *	parent,
		std::shared_ptr< delegate_type >	delegate )

noexcept

Construct a text widget.

Parameters

parent	The owner of this widget.
delegate	The delegate to use to control the widget's data.

◆ text_widget() [2/2]

hi::v1::text_widget::text_widget	(	widget *	parent,
		different_from< std::shared_ptr< delegate_type > > auto &&	text,
		text_widget_attribute auto &&...	attributes )

inlinenoexcept

Construct a text widget.

Parameters

parent	The owner of this widget.
text	The text to be displayed.
attributes	A set of attributes used to configure the text widget: a `alignment` or `semantic_text_style`.

Field Documentation

◆ alignment

observer<alignment> hi::v1::text_widget::alignment = hi::alignment::middle_center()

The horizontal alignment of the text inside the space of the widget.

◆ text_style

observer<semantic_text_style> hi::v1::text_widget::text_style = semantic_text_style::label

The style of the text.

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

hikogui/src/hikogui/widgets/text_widget.hpp

Public Types

Public Member Functions