Class for a single line text area. More...

#include <text_box.hpp>

Inheritance diagram for gui2::text_box:

Public Member Functions
	text_box (const implementation::builder_styled_widget &builder)

void	save_to_history ()
	Saves the text in the widget to the history. More...

void	set_history (const std::string &id)

void	set_max_input_length (const std::size_t length)

void	set_hint_data (const std::string &text, const std::string &image)

void	clear ()

Public Member Functions inherited from gui2::text_box_base
	text_box_base (const implementation::builder_styled_widget &builder, const std::string &control_type)

	~text_box_base ()

virtual void	set_active (const bool active) override
	See styled_widget::set_active. More...

virtual bool	get_active () const override
	See styled_widget::get_active. More...

virtual unsigned	get_state () const override
	See styled_widget::get_state. More...

void	set_maximum_length (const std::size_t maximum_length)

std::size_t	get_length () const
	Wrapper function, returns length of the text in pango column offsets. More...

std::vector< std::string >	get_lines ()
	Wrapper function, returns a vector with the lines. More...

unsigned	get_lines_count () const
	Wrapper function, return number of lines. More...

int	get_byte_offset (const unsigned column) const
	Wrapper function, returns corrected column offset from pango. More...

void	set_highlight_area (const unsigned start_offset, const unsigned end_offset, const color_t &color)
	Wrapper function, sets the area between column start and end offset to be highlighted in a specific color. More...

virtual void	set_value (const std::string &text)
	The set_value is virtual for the password_box class. More...

std::string	get_value () const

const std::string &	text () const

void	set_text_changed_callback (std::function< void(text_box_base *textbox, const std::string text)> cb)
	Set the text_changed callback. More...

void	set_selection (std::size_t start, int length)
	Sets or clears the text selection. More...

void	set_editable (bool editable)

bool	is_editable ()

bool	is_composing () const

void	interrupt_composition ()

Public Member Functions inherited from gui2::styled_widget
	styled_widget (const implementation::builder_styled_widget &builder, const std::string &control_type)
	Constructor. More...

virtual void	set_members (const widget_item &data)
	Sets the members of the styled_widget. More...

bool	disable_click_dismiss () const override
	See widget::disable_click_dismiss. More...

virtual iteration::walker_ptr	create_walker () override
	See widget::create_walker. More...

point	get_config_minimum_size () const
	Gets the minimum size as defined in the config. More...

point	get_config_default_size () const
	Gets the default size as defined in the config. More...

point	get_config_maximum_size () const
	Gets the best size as defined in the config. More...

virtual unsigned	get_characters_per_line () const
	Returns the number of characters per line. More...

virtual bool	get_link_aware () const
	Returns whether the label should be link_aware, in in rendering and in searching for links with get_link. More...

virtual color_t	get_link_color () const
	Returns the color string to be used with links. More...

virtual void	layout_initialize (const bool full_initialization) override
	See widget::layout_initialize. More...

virtual void	request_reduce_width (const unsigned maximum_width) override
	See widget::request_reduce_width. More...

virtual void	request_reduce_height (const unsigned maximum_height) override
	See widget::request_reduce_height. More...

virtual widget *	find_at (const point &coordinate, const bool must_be_active) override
	See widget::find_at. More...

virtual const widget *	find_at (const point &coordinate, const bool must_be_active) const override
	See widget::find_at. More...

widget *	find (const std::string &id, const bool must_be_active) override
	See widget::find. More...

const widget *	find (const std::string &id, const bool must_be_active) const override
	See widget::find. More...

bool	get_use_tooltip_on_label_overflow () const

void	set_use_tooltip_on_label_overflow (const bool use_tooltip=true)

const t_string &	get_label () const

virtual void	set_label (const t_string &text)

virtual void	set_use_markup (bool use_markup)

bool	get_use_markup () const

const t_string &	tooltip () const

void	set_tooltip (const t_string &tooltip)

const t_string &	help_message () const

void	set_help_message (const t_string &help_message)

std::vector< canvas > &	get_canvases ()

canvas &	get_canvas (const unsigned index)

virtual void	set_text_alignment (const PangoAlignment text_alignment)

PangoAlignment	get_text_alignment () const

void	set_text_ellipse_mode (const PangoEllipsizeMode ellipse_mode)

PangoEllipsizeMode	get_text_ellipse_mode () const
	Get the text's ellipsize mode. More...

Public Member Functions inherited from gui2::widget
	widget (const widget &)=delete

widget &	operator= (const widget &)=delete

	widget ()

	widget (const builder_widget &builder)
	Constructor. More...

virtual	~widget () override

void	set_id (const std::string &id)

const std::string &	id () const

window *	get_window ()
	Get the parent window. More...

const window *	get_window () const
	The constant version of get_window. More...

grid *	get_parent_grid ()
	Get the parent grid. More...

void	set_parent (widget *parent)

widget *	parent ()

virtual void	demand_reduce_width (const unsigned maximum_width)
	Tries to reduce the width of a widget. More...

virtual void	demand_reduce_height (const unsigned maximum_height)
	Tries to reduce the height of a widget. More...

point	get_best_size () const
	Gets the best size for the widget. More...

virtual bool	can_mouse_focus () const
	Whether the mouse move/click event go 'through' this widget. More...

virtual bool	can_wrap () const
	Can the widget wrap. More...

virtual void	set_origin (const point &origin)
	Sets the origin of the widget. More...

virtual void	set_size (const point &size)
	Sets the size of the widget. More...

virtual void	move (const int x_offset, const int y_offset)
	Moves a widget. More...

virtual void	set_horizontal_alignment (const std::string &alignment)
	Sets the horizontal alignment of the widget within its parent grid. More...

virtual void	set_vertical_alignment (const std::string &alignment)
	Sets the horizontal alignment of the widget within its parent grid. More...

virtual void	layout_children ()
	Allows a widget to update its children. More...

point	get_origin () const
	Returns the screen origin of the widget. More...

point	get_size () const
	Returns the size of the widget. More...

rect	get_rectangle () const
	Gets the bounding rectangle of the widget on the screen. More...

int	get_x () const

int	get_y () const

unsigned	get_width () const

unsigned	get_height () const

void	set_linked_group (const std::string &linked_group)

SDL_Rect	calculate_blitting_rectangle () const
	Calculates the blitting rectangle of the widget. More...

SDL_Rect	calculate_clipping_rectangle () const
	Calculates the clipping rectangle of the widget. More...

bool	draw_background ()
	Draws the background of a widget. More...

void	draw_children ()
	Draws the children of a widget. More...

bool	draw_foreground ()
	Draws the foreground of the widget. More...

SDL_Rect	get_dirty_rectangle () const
	Gets the dirty rectangle of the widget. More...

virtual void	set_visible_rectangle (const SDL_Rect &rectangle)
	Sets the visible rectangle for a widget. More...

void	queue_redraw ()
	Indicates that this widget should be redrawn. More...

void	queue_redraw (const rect &region)
	Indicate that specific region of the screen should be redrawn. More...

void	set_visible (const visibility visible)

visibility	get_visible () const

redraw_action	get_drawing_action () const

void	set_debug_border_mode (const debug_border debug_border_mode)

void	set_debug_border_color (const color_t debug_border_color)

virtual bool	has_widget (const widget &widget) const
	Does the widget contain the widget. More...

Public Member Functions inherited from gui2::event_executor
	event_executor ()

virtual	~event_executor ()

void	set_wants_mouse_hover (const bool hover=true)

bool	wants_mouse_hover () const

void	set_wants_mouse_left_double_click (const bool click=true)

bool	wants_mouse_left_double_click () const

void	set_wants_mouse_middle_double_click (const bool click=true)

bool	wants_mouse_middle_double_click () const

event_executor &	set_wants_mouse_right_double_click (const bool click=true)

bool	wants_mouse_right_double_click () const

Public Member Functions inherited from gui2::event::dispatcher
	dispatcher ()

virtual	~dispatcher ()

void	connect ()
	Connects the dispatcher to the event handler. More...

void	disconnect ()
	Disconnects the dispatcher from the event handler. More...

bool	is_connected () const
	Return whether the dispatcher is currently connected. More...

bool	has_event (const ui_event event, const event_queue_type event_type)

bool	fire (const ui_event event, widget &target)
	Fires an event which has no extra parameters. More...

bool	fire (const ui_event event, widget &target, const point &coordinate)
	Fires an event which takes a coordinate parameter. More...

bool	fire (const ui_event event, widget &target, const SDL_Keycode key, const SDL_Keymod modifier, const std::string &unicode)
	Fires an event which takes keyboard parameters. More...

bool	fire (const ui_event event, widget &target, const point &pos, const point &distance)
	Fires an event which takes touch-motion parameters. More...

bool	fire (const ui_event event, widget &target, const point &center, float dTheta, float dDist, uint8_t numFingers)
	Fires an event which takes touch-gesture parameters. More...

bool	fire (const ui_event event, widget &target, void *)
	Fires an event which takes notification parameters. More...

bool	fire (const ui_event event, widget &target, const message &msg)
	Fires an event which takes message parameters. More...

bool	fire (const ui_event event, widget &target, const SDL_Event &sdlevent)
	Fires an event that's a raw SDL event. More...

bool	fire (const ui_event event, widget &target, const std::string &text, int32_t start, int32_t len)
	Fires an event which takes text input parameters. More...

template<ui_event E, typename F >
void	connect_signal (const F &func, const queue_position position=back_child)
	Adds a callback to the appropriate queue based on event type. More...

template<ui_event E, typename F >
void	disconnect_signal (const F &func, const queue_position position=back_child)
	Removes a callback from the appropriate queue based on event type. More...

void	capture_mouse ()
	Captures the mouse. More...

void	release_mouse ()
	Releases the mouse capture. More...

void	set_mouse_behavior (const mouse_behavior mouse_behavior)

mouse_behavior	get_mouse_behavior () const

void	set_want_keyboard_input (const bool want_keyboard_input)

bool	get_want_keyboard_input () const

void	register_hotkey (const hotkey::HOTKEY_COMMAND id, const hotkey_function &function)
	Registers a hotkey. More...

bool	execute_hotkey (const hotkey::HOTKEY_COMMAND id)
	Executes a hotkey. More...

Public Member Functions inherited from enable_lua_ptr< widget >
	enable_lua_ptr (widget *tp)

Static Public Member Functions
static const std::string &	type ()
	Static type getter that does not rely on the widget being constructed. More...

Protected Member Functions
virtual void	place (const point &origin, const point &size) override
	See widget::place. More...

virtual void	update_canvas () override
	See styled_widget::update_canvas. More...

void	goto_end_of_line (const bool select=false) override
	Inherited from text_box_base. More...

void	goto_start_of_line (const bool select=false) override
	Inherited from text_box_base. More...

void	delete_char (const bool before_cursor) override
	Inherited from text_box_base. More...

void	delete_selection () override
	Inherited from text_box_base. More...

void	handle_mouse_selection (point mouse, const bool start_selection)

Protected Member Functions inherited from gui2::text_box_base
size_t	get_composition_length () const
	Get length of composition text by IME. More...

virtual void	goto_end_of_data (const bool select=false)
	Moves the cursor to the end of all text. More...

virtual void	goto_start_of_data (const bool select=false)
	Moves the cursor to the beginning of the data. More...

void	select_all ()
	Selects all text. More...

virtual void	set_cursor (const std::size_t offset, const bool select)
	Moves the cursor at the wanted position. More...

virtual void	insert_char (const std::string &unicode)
	Inserts a character at the cursor. More...

virtual void	copy_selection (const bool mouse)
	Copies the current selection. More...

virtual void	paste_selection (const bool mouse)
	Pastes the current selection. More...

point	get_cursor_position (const unsigned column, const unsigned line=0) const

point	get_column_line (const point &position) const

font::family_class	get_font_family ()

void	set_font_family (font::family_class fclass)

void	set_font_size (const unsigned font_size)

void	set_font_style (const font::pango_text::FONT_STYLE font_style)

void	set_maximum_width (const int width)

void	set_maximum_height (const int height, const bool multiline)

void	set_ellipse_mode (const PangoEllipsizeMode ellipse_mode)

std::size_t	get_selection_start () const

void	set_selection_start (const std::size_t selection_start)

std::size_t	get_selection_length () const

void	set_selection_length (const int selection_length)

std::size_t	get_composition_start () const

virtual void	handle_key_left_arrow (SDL_Keymod modifier, bool &handled)
	Left arrow key pressed. More...

virtual void	handle_key_right_arrow (SDL_Keymod modifier, bool &handled)
	Right arrow key pressed. More...

virtual void	handle_commit (bool &handled, const std::string &unicode)

virtual void	handle_editing (bool &handled, const std::string &unicode, int32_t start, int32_t length)
	SDL_TEXTEDITING handler. More...

Protected Member Functions inherited from gui2::styled_widget
virtual point	calculate_best_size () const override
	See widget::calculate_best_size. More...

resolution_definition_ptr	get_config ()

resolution_definition_const_ptr	get_config () const

template<typename T >
std::shared_ptr< const typename T::resolution >	cast_config_to () const
	Casts the current resolution definition config to the respective type of a derived widget. More...

void	set_config (resolution_definition_ptr config)

unsigned int	get_text_font_size () const
	Resolves and returns the text_font_size. More...

int	get_text_maximum_width () const
	Returns the maximum width available for the text. More...

int	get_text_maximum_height () const
	Returns the maximum height available for the text. More...

virtual bool	impl_draw_background () override
	See widget::impl_draw_background. More...

virtual bool	impl_draw_foreground () override
	See widget::impl_draw_foreground. More...

std::string	get_label_token (const point &position, const char *delimiters=" \n\r\t") const
	Exposes font::pango_text::get_token, for the text label of this styled_widget. More...

std::string	get_label_link (const point &position) const

Protected Member Functions inherited from gui2::widget
void	set_layout_size (const point &size)

const point &	layout_size () const

void	clear_layout_size ()
	Throws away layout_size_. More...

Private Member Functions
void	update_offsets ()
	Updates text_x_offset_ and text_y_offset_. More...

void	handle_key_up_arrow (SDL_Keymod, bool &) override
	Inherited from text_box_base. More...

void	handle_key_down_arrow (SDL_Keymod, bool &) override
	Inherited from text_box_base. More...

bool	history_up ()
	Goes one item up in the history. More...

bool	history_down ()
	Goes one item down in the history. More...

void	handle_key_tab (SDL_Keymod modifier, bool &handled) override
	Inherited from text_box_base. More...

void	handle_key_clear_line (SDL_Keymod modifier, bool &handled) override
	Inherited from text_box_base. More...

virtual const std::string &	get_control_type () const override
	Inherited from styled_widget, implemented by REGISTER_WIDGET. More...

void	signal_handler_mouse_motion (const event::ui_event event, bool &handled, const point &coordinate)

void	signal_handler_left_button_down (const event::ui_event event, bool &handled)

void	signal_handler_left_button_up (const event::ui_event event, bool &handled)

void	signal_handler_left_button_double_click (const event::ui_event event, bool &handled)

Private Attributes
text_history	history_
	The history text for this widget. More...

std::size_t	max_input_length_
	The maximum length of the text input. More...

unsigned	text_x_offset_
	The x offset in the widget where the text starts. More...

unsigned	text_y_offset_
	The y offset in the widget where the text starts. More...

unsigned	text_height_
	The height of the text itself. More...

bool	dragging_
	Is the mouse in dragging mode, this affects selection in mouse move. More...

std::string	hint_text_
	Helper text to display (such as "Search") if the text box is empty. More...

std::string	hint_image_
	Image (such as a magnifying glass) that accompanies the help text. More...

Friends
struct	implementation::builder_text_box

Additional Inherited Members
Public Types inherited from gui2::text_box_base
enum	state_t { ENABLED , DISABLED , FOCUSED , HOVERED }
	Note the order of the states must be the same as defined in settings.hpp. More...

Public Types inherited from gui2::widget
enum class	visibility { visible , hidden , invisible }
	Visibility settings done by the user. More...

enum class	redraw_action { full , partly , none }
	Visibility set by the engine. More...

enum class	debug_border { none , outline , fill }

Public Types inherited from gui2::event::dispatcher
enum	event_queue_type { pre = 1 , child = 2 , post = 4 }

enum	queue_position { front_pre_child , back_pre_child , front_child , back_child , front_post_child , back_post_child }
	The position where to add a new callback in the signal handler. More...

enum class	mouse_behavior { all , hit , none }
	The behavior of the mouse events. More...

Detailed Description

Class for a single line text area.

The resolution for a text box also contains the following keys:

Key	Type	Default	Description
text_x_offset	f_unsigned	""	The x offset of the text in the text box. This is needed for the code to determine where in the text the mouse clicks, so it can set the cursor properly.
text_y_offset	f_unsigned	""	The y offset of the text in the text box.

The following states exist:

state_enabled - the text box is enabled.
state_disabled - the text box is disabled.

state_focussed - the text box has the focus of the keyboard. The following variables exist:

Key	Type	Default	Description
label	t_string	""	The initial text of the text box.
history	string	""	The name of the history for the text box. A history saves the data entered in a text box between the games. With the up and down arrow it can be accessed. To create a new history item just add a new unique name for this field and the engine will handle the rest.

Definition at line 141 of file text_box.hpp.

Constructor & Destructor Documentation

◆ text_box()

gui2::text_box::text_box ( const implementation::builder_styled_widget & builder )

explicit

Definition at line 98 of file text_box.cpp.

References gui2::styled_widget::get_text_font_size(), gui2::text_box_base::set_font_size(), gui2::text_box_base::set_font_style(), gui2::event_executor::set_wants_mouse_left_double_click(), signal_handler_left_button_double_click(), signal_handler_left_button_down(), signal_handler_left_button_up(), signal_handler_mouse_motion(), and update_offsets().

Member Function Documentation

◆ clear()

void gui2::text_box::clear ( )

inline

Definition at line 174 of file text_box.hpp.

References gui2::text_box_base::set_value().

Referenced by gui2::dialogs::preferences_dialog::add_friend_list_entry(), and gui2::dialogs::preferences_dialog::remove_friend_list_entry().

◆ delete_char()

void gui2::text_box::delete_char ( const bool before_cursor )

overrideprotectedvirtual

Inherited from text_box_base.

Implements gui2::text_box_base.

Definition at line 219 of file text_box.cpp.

References delete_selection(), gui2::text_box_base::get_selection_start(), gui2::text_box_base::set_cursor(), and gui2::text_box_base::set_selection_length().

◆ delete_selection()

void gui2::text_box::delete_selection ( )

overrideprotectedvirtual

Inherited from text_box_base.

Implements gui2::text_box_base.

Definition at line 230 of file text_box.cpp.

References utf8::erase(), gui2::text_box_base::get_selection_length(), gui2::text_box_base::get_selection_start(), gui2::text_box_base::get_value(), gui2::text_box_base::set_cursor(), gui2::text_box_base::set_value(), and editor::start().

Referenced by delete_char().

◆ get_control_type()

virtual const std::string& gui2::text_box::get_control_type ( ) const

overrideprivatevirtual

Inherited from styled_widget, implemented by REGISTER_WIDGET.

Implements gui2::styled_widget.

Reimplemented in gui2::password_box.

Referenced by signal_handler_mouse_motion().

◆ goto_end_of_line()

void gui2::text_box::goto_end_of_line ( const bool select = false )

inlineoverrideprotectedvirtual

Inherited from text_box_base.

Implements gui2::text_box_base.

Definition at line 191 of file text_box.hpp.

References gui2::text_box_base::goto_end_of_data().

◆ goto_start_of_line()

void gui2::text_box::goto_start_of_line ( const bool select = false )

inlineoverrideprotectedvirtual

Inherited from text_box_base.

Implements gui2::text_box_base.

Definition at line 197 of file text_box.hpp.

References gui2::text_box_base::goto_start_of_data().

◆ handle_key_clear_line()

void gui2::text_box::handle_key_clear_line	(	SDL_Keymod	modifier,
		bool &	handled
	)

overrideprivatevirtual

Inherited from text_box_base.

Implements gui2::text_box_base.

Definition at line 337 of file text_box.cpp.

References gui2::text_box_base::set_value().

◆ handle_key_down_arrow()

void gui2::text_box::handle_key_down_arrow	(	SDL_Keymod	,
		bool &
	)

inlineoverrideprivatevirtual

Inherited from text_box_base.

Unmodified Unhandled. Control Ignored. Shift Ignored. Alt Ignored.

Implements gui2::text_box_base.

Definition at line 271 of file text_box.hpp.

◆ handle_key_tab()

void gui2::text_box::handle_key_tab	(	SDL_Keymod	modifier,
		bool &	handled
	)

overrideprivatevirtual

Inherited from text_box_base.

Reimplemented from gui2::text_box_base.

Definition at line 326 of file text_box.cpp.

References history_down(), and history_up().

◆ handle_key_up_arrow()

void gui2::text_box::handle_key_up_arrow	(	SDL_Keymod	,
		bool &
	)

inlineoverrideprivatevirtual

Inherited from text_box_base.

Unmodified Unhandled. Control Ignored. Shift Ignored. Alt Ignored.

Implements gui2::text_box_base.

Definition at line 259 of file text_box.hpp.

◆ handle_mouse_selection()

void gui2::text_box::handle_mouse_selection	(	point	mouse,
		const bool	start_selection
	)

protected

Definition at line 250 of file text_box.cpp.

References dragging_, gui2::text_box_base::get_column_line(), gui2::widget::get_x(), gui2::widget::get_y(), draw::point(), gui2::widget::queue_redraw(), gui2::text_box_base::set_cursor(), text_height_, text_x_offset_, text_y_offset_, and update_canvas().

Referenced by signal_handler_left_button_down(), and signal_handler_mouse_motion().

◆ history_down()

bool gui2::text_box::history_down ( )

private

Goes one item down in the history.

Returns: True if there's a history, false otherwise.

Definition at line 313 of file text_box.cpp.

References gui2::text_history::down(), gui2::text_history::get_enabled(), gui2::text_box_base::get_value(), history_, and gui2::text_box_base::set_value().

Referenced by handle_key_tab().

◆ history_up()

bool gui2::text_box::history_up ( )

private

Goes one item up in the history.

Returns: True if there's a history, false otherwise.

Definition at line 300 of file text_box.cpp.

References gui2::text_history::get_enabled(), gui2::text_box_base::get_value(), history_, gui2::text_box_base::set_value(), and gui2::text_history::up().

Referenced by handle_key_tab().

◆ place()

void gui2::text_box::place	(	const point &	origin,
		const point &	size
	)

overrideprotectedvirtual

See widget::place.

Reimplemented from gui2::styled_widget.

Definition at line 127 of file text_box.cpp.

References gui2::styled_widget::get_text_maximum_height(), gui2::styled_widget::get_text_maximum_width(), max_input_length_, gui2::styled_widget::place(), gui2::text_box_base::set_maximum_height(), gui2::text_box_base::set_maximum_length(), gui2::text_box_base::set_maximum_width(), utf8::size(), and update_offsets().

◆ save_to_history()

void gui2::text_box::save_to_history ( )

inline

Saves the text in the widget to the history.

Definition at line 149 of file text_box.hpp.

References gui2::text_box_base::get_value(), history_, and gui2::text_history::push().

Referenced by gui2::chatbox::chat_input_keypress_callback(), gui2::dialogs::addon_connect::post_show(), and gui2::dialogs::mp_method_selection::post_show().

◆ set_hint_data()

void gui2::text_box::set_hint_data	(	const std::string &	text,
		const std::string &	image
	)

inline

Definition at line 166 of file text_box.hpp.

References hint_image_, hint_text_, gui2::text_box_base::text(), and update_canvas().

◆ set_history()

void gui2::text_box::set_history ( const std::string & id )

inline

Definition at line 156 of file text_box.hpp.

References gui2::text_history::get_history(), and history_.

◆ set_max_input_length()

void gui2::text_box::set_max_input_length ( const std::size_t length )

inline

Definition at line 161 of file text_box.hpp.

References max_input_length_.

◆ signal_handler_left_button_double_click()

void gui2::text_box::signal_handler_left_button_double_click	(	const event::ui_event	event,
		bool &	handled
	)

private

Definition at line 384 of file text_box.cpp.

References DBG_GUI_E, LOG_HEADER, and gui2::text_box_base::select_all().

Referenced by text_box().

◆ signal_handler_left_button_down()

void gui2::text_box::signal_handler_left_button_down	(	const event::ui_event	event,
		bool &	handled
	)

private

Definition at line 357 of file text_box.cpp.

References DBG_GUI_E, gui2::get_mouse_position(), gui2::widget::get_window(), handle_mouse_selection(), gui2::window::keyboard_capture(), LOG_HEADER, and gui2::window::mouse_capture().

Referenced by text_box().

◆ signal_handler_left_button_up()

void gui2::text_box::signal_handler_left_button_up	(	const event::ui_event	event,
		bool &	handled
	)

private

Definition at line 374 of file text_box.cpp.

References DBG_GUI_E, dragging_, and LOG_HEADER.

Referenced by text_box().

◆ signal_handler_mouse_motion()

void gui2::text_box::signal_handler_mouse_motion	(	const event::ui_event	event,
		bool &	handled,
		const point &	coordinate
	)

private

Definition at line 344 of file text_box.cpp.

References DBG_GUI_E, dragging_, get_control_type(), handle_mouse_selection(), and gui2::widget::id().

Referenced by text_box().

◆ type()

static const std::string& gui2::text_box::type ( )

static

Static type getter that does not rely on the widget being constructed.

◆ update_canvas()

void gui2::text_box::update_canvas ( )

overrideprotectedvirtual

See styled_widget::update_canvas.

Reimplemented from gui2::styled_widget.

Definition at line 140 of file text_box.cpp.

Referenced by handle_mouse_selection(), set_hint_data(), and update_offsets().

◆ update_offsets()

void gui2::text_box::update_offsets ( )

private

Updates text_x_offset_ and text_y_offset_.

Definition at line 274 of file text_box.cpp.

References wfl::map_formula_callable::add(), gui2::styled_widget::get_canvases(), gui2::widget::get_height(), font::get_max_height(), gui2::styled_widget::get_text_font_size(), gui2::widget::get_width(), text_height_, text_x_offset_, text_y_offset_, and update_canvas().

Referenced by place(), and text_box().

Friends And Related Function Documentation

◆ implementation::builder_text_box

friend struct implementation::builder_text_box

friend

Definition at line 143 of file text_box.hpp.

Member Data Documentation

◆ dragging_

bool gui2::text_box::dragging_

private

Is the mouse in dragging mode, this affects selection in mouse move.

Definition at line 243 of file text_box.hpp.

Referenced by handle_mouse_selection(), signal_handler_left_button_up(), and signal_handler_mouse_motion().

◆ hint_image_

std::string gui2::text_box::hint_image_

private

Image (such as a magnifying glass) that accompanies the help text.

Definition at line 249 of file text_box.hpp.

Referenced by set_hint_data(), and update_canvas().

◆ hint_text_

std::string gui2::text_box::hint_text_

private

Helper text to display (such as "Search") if the text box is empty.

Definition at line 246 of file text_box.hpp.

Referenced by set_hint_data(), and update_canvas().

◆ history_

text_history gui2::text_box::history_

private

The history text for this widget.

Definition at line 212 of file text_box.hpp.

Referenced by history_down(), history_up(), save_to_history(), and set_history().

◆ max_input_length_

std::size_t gui2::text_box::max_input_length_

private

The maximum length of the text input.

Definition at line 215 of file text_box.hpp.

Referenced by place(), set_max_input_length(), and update_canvas().

◆ text_height_

unsigned gui2::text_box::text_height_

private

The height of the text itself.

Needed to determine whether a click is on the text.

Definition at line 237 of file text_box.hpp.

Referenced by handle_mouse_selection(), and update_offsets().

◆ text_x_offset_

unsigned gui2::text_box::text_x_offset_

private

The x offset in the widget where the text starts.

This value is needed to translate a location in the widget to a location in the text.

Definition at line 223 of file text_box.hpp.

Referenced by handle_mouse_selection(), update_canvas(), and update_offsets().

◆ text_y_offset_

unsigned gui2::text_box::text_y_offset_

private

The y offset in the widget where the text starts.

Needed to determine whether a click is on the text.

Definition at line 230 of file text_box.hpp.

Referenced by handle_mouse_selection(), update_canvas(), and update_offsets().

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

gui/widgets/text_box.hpp
gui/widgets/text_box.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ text_box()

Member Function Documentation

◆ clear()

◆ delete_char()

◆ delete_selection()

◆ get_control_type()

◆ goto_end_of_line()

◆ goto_start_of_line()

◆ handle_key_clear_line()

◆ handle_key_down_arrow()

◆ handle_key_tab()

◆ handle_key_up_arrow()

◆ handle_mouse_selection()

◆ history_down()

◆ history_up()

◆ place()

◆ save_to_history()

◆ set_hint_data()

◆ set_history()

◆ set_max_input_length()

◆ signal_handler_left_button_double_click()

◆ signal_handler_left_button_down()

◆ signal_handler_left_button_up()

◆ signal_handler_mouse_motion()

◆ type()

◆ update_canvas()

◆ update_offsets()

Friends And Related Function Documentation

◆ implementation::builder_text_box

Member Data Documentation

◆ dragging_

◆ hint_image_

◆ hint_text_

◆ history_

◆ max_input_length_

◆ text_height_

◆ text_x_offset_

◆ text_y_offset_