hi::v1::text_widget< Name > Class Template Reference

#include <hikogui/widgets/text_widget.hpp>

Inheritance diagram for hi::v1::text_widget< Name >:

Public Types
using	super = widget
using	delegate_type = text_delegate
Public Types inherited from hi::v1::widget
using	callback_token = notifier<void()>::callback_token
using	awaiter_type = notifier<void()>::awaiter_type

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 (widget const &)=delete
	widget (widget &&)=delete
widget &	operator= (widget &&)=delete
widget &	operator= (widget const &)=delete
virtual generator< widget const & >	children (bool include_invisible) const noexcept
	Get a list of child widgets.
generator< widget & >	children (bool include_invisible) noexcept
virtual hitbox	hitbox_test_from_parent (point2i position) const noexcept
	Call hitbox_test from a parent widget.
virtual hitbox	hitbox_test_from_parent (point2i position, hitbox sibling_hitbox) const noexcept
	Call hitbox_test from a parent widget.
void	reset_layout (gui_window *new_window, gfx_surface *new_surface, float new_scale) noexcept
	Reset the layout.
virtual sub_theme_selector_type	sub_theme_selector () const noexcept
virtual bool	process_event (gui_event const &event) const noexcept
virtual 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_id > const &reject_list=std::vector< widget_id >{}) noexcept
	Handle command recursive.
virtual widget_id	find_next_widget (widget_id current_keyboard_widget, keyboard_focus_group group, keyboard_focus_direction direction) const noexcept
	Find the next widget that handles keyboard focus.
widget_id	find_first_widget (keyboard_focus_group group) const noexcept
widget_id	find_last_widget (keyboard_focus_group group) const noexcept
bool	is_first (keyboard_focus_group group) const noexcept
bool	is_last (keyboard_focus_group group) const noexcept
virtual void	scroll_to_show (hi::aarectanglei rectangle) noexcept
	Scroll to show the given rectangle on the window.
std::vector< widget_id >	parent_chain () const noexcept
	Get a list of parents of a given widget.
virtual bool	is_tab_button () const noexcept
	Check if this widget is a tab-button.
template<forward_of< void()> Callback>
callback_token	subscribe (Callback &&callback, callback_flags flags=callback_flags::synchronous) const noexcept
awaiter_type	operator co_await () const noexcept

Data Fields
std::shared_ptr< delegate_type >	delegate
observer< alignment >	alignment = hi::alignment::top_flush()
	The horizontal alignment of the text inside the space of the widget.
Data Fields inherited from hi::v1::widget
widget_id	id = {}
	The numeric identifier of a widget.
widget *	parent = nullptr
	Pointer to the parent widget.
gui_window *	window = nullptr
	The window this widget is on.
gfx_surface *	surface = nullptr
	The surface this widget is drawn on.
observer< widget_mode >	mode = widget_mode::enabled
	The widget mode.
observer< bool >	hover = false
	Mouse cursor is hovering over the widget.
observer< bool >	clicked = false
	The widget is being clicked by the mouse.
observer< bool >	focus = false
	The widget has keyboard focus.
observer< widget_state >	state = widget_state::off
	The state of the widget.
size_t	semantic_layer = 0_uz
	The draw layer of the widget.
observer< extent2i >	minimum = extent2i{}
	The minimum size this widget is allowed to be.
observer< extent2i >	maximum = extent2i::large()
	The maximum size this widget is allowed to be.
widget_layout	layout

Static Public Attributes
static constexpr auto	prefix = Name / "text"

Detailed Description

template<fixed_string Name = "">
class hi::v1::text_widget< Name >

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 different types, including 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 sentence break algorithm for selecting and moving through sentences.
• 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]

template<fixed_string Name = "">

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

inlinenoexcept

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]

template<fixed_string Name = "">

hi::v1::text_widget< Name >::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.

Field Documentation

alignment

template<fixed_string Name = "">

observer<alignment> hi::v1::text_widget< Name >::alignment = hi::alignment::top_flush()

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

---

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

• hikogui/src/hikogui/widgets/text_widget.hpp