The Battle for Wesnoth  1.17.0-dev
Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
gui2::text_box Class Reference

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
 
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...
 
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 string_map &data)
 Sets the members of the styled_widget. More...
 
bool disable_click_dismiss () const override
 See widget::disable_click_dismiss. More...
 
virtual iteration::walker_basecreate_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 widgetfind_at (const point &coordinate, const bool must_be_active) override
 See widget::find_at. More...
 
virtual const widgetfind_at (const point &coordinate, const bool must_be_active) const override
 See widget::find_at. More...
 
widgetfind (const std::string &id, const bool must_be_active) override
 See widget::find. More...
 
const widgetfind (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_stringget_label () const
 
virtual void set_label (const t_string &label)
 
virtual void set_use_markup (bool use_markup)
 
bool get_use_markup () const
 
const t_stringtooltip () const
 
void set_tooltip (const t_string &tooltip)
 
const t_stringhelp_message () const
 
void set_help_message (const t_string &help_message)
 
std::vector< canvas > & get_canvases ()
 
canvasget_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
 
widgetoperator= (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
 
windowget_window ()
 Get the parent window. More...
 
const windowget_window () const
 The constant version of get_window. More...
 
gridget_parent_grid ()
 Get the parent grid. More...
 
void set_parent (widget *parent)
 
widgetparent ()
 
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...
 
SDL_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 int x_offset, const int y_offset)
 Calculates the blitting rectangle of the widget. More...
 
SDL_Rect calculate_clipping_rectangle (const int x_offset, const int y_offset)
 Calculates the clipping rectangle of the widget. More...
 
void draw_background (surface &frame_buffer, int x_offset, int y_offset)
 Draws the background of a widget. More...
 
void draw_children (surface &frame_buffer, int x_offset, int y_offset)
 Draws the children of a widget. More...
 
void draw_foreground (surface &frame_buffer, int x_offset, int y_offset)
 Draws the foreground of the widget. More...
 
void populate_dirty_list (window &caller, std::vector< widget *> &call_stack)
 Adds a widget to the dirty list if it is dirty. 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 set_is_dirty (const bool is_dirty)
 
bool get_is_dirty () const
 
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_executorset_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...
 
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>
std::enable_if_t< is_general_event(E)> connect_signal (const signal_function &signal, const queue_position position=back_child)
 Connect a signal for callback in set_event. More...
 
template<ui_event E>
std::enable_if_t< is_general_event(E)> disconnect_signal (const signal_function &signal, const queue_position position=back_child)
 Disconnect a signal for callback in set_event. More...
 
template<ui_event E>
std::enable_if_t< is_mouse_event(E)> connect_signal (const signal_mouse_function &signal, const queue_position position=back_child)
 Connect a signal for callback in set_event_mouse. More...
 
template<ui_event E>
std::enable_if_t< is_mouse_event(E)> disconnect_signal (const signal_mouse_function &signal, const queue_position position=back_child)
 Disconnect a signal for callback in set_event_mouse. More...
 
template<ui_event E>
std::enable_if_t< is_keyboard_event(E)> connect_signal (const signal_keyboard_function &signal, const queue_position position=back_child)
 Connect a signal for callback in set_event_keyboard. More...
 
template<ui_event E>
std::enable_if_t< is_keyboard_event(E)> disconnect_signal (const signal_keyboard_function &signal, const queue_position position=back_child)
 Disconnect a signal for callback in set_event_keyboard. More...
 
template<ui_event E>
std::enable_if_t< is_touch_motion_event(E)> connect_signal (const signal_touch_motion_function &signal, const queue_position position=back_child)
 Connect a signal for callback in set_event_touch_motion. More...
 
template<ui_event E>
std::enable_if_t< is_touch_motion_event(E)> disconnect_signal (const signal_touch_motion_function &signal, const queue_position position=back_child)
 Disconnect a signal for callback in set_event_touch_motion. More...
 
template<ui_event E>
std::enable_if_t< is_touch_gesture_event(E)> connect_signal (const signal_touch_gesture_function &signal, const queue_position position=back_child)
 Connect a signal for callback in set_event_touch_gesture. More...
 
template<ui_event E>
std::enable_if_t< is_touch_gesture_event(E)> disconnect_signal (const signal_touch_gesture_function &signal, const queue_position position=back_child)
 Disconnect a signal for callback in set_event_touch_gesture. More...
 
template<ui_event E>
std::enable_if_t< is_notification_event(E)> connect_signal (const signal_notification_function &signal, const queue_position position=back_child)
 Connect a signal for callback in set_event_notification. More...
 
template<ui_event E>
std::enable_if_t< is_notification_event(E)> disconnect_signal (const signal_notification_function &signal, const queue_position position=back_child)
 Disconnect a signal for callback in set_event_notification. More...
 
template<ui_event E>
std::enable_if_t< is_message_event(E)> connect_signal (const signal_message_function &signal, const queue_position position=back_child)
 Connect a signal for callback in set_event_message. More...
 
template<ui_event E>
std::enable_if_t< is_message_event(E)> disconnect_signal (const signal_message_function &signal, const queue_position position=back_child)
 Disconnect a signal for callback in set_event_message. More...
 
template<ui_event E>
std::enable_if_t< is_raw_event_event(E)> connect_signal (const signal_raw_event_function &signal, const queue_position position=back_child)
 Connect a signal for callback in set_raw_event. More...
 
template<ui_event E>
std::enable_if_t< is_raw_event_event(E)> disconnect_signal (const signal_raw_event_function &signal, const queue_position position=back_child)
 Disconnect a signal for callback in set_raw_event. More...
 
template<ui_event E>
std::enable_if_t< is_text_input_event(E)> connect_signal (const signal_text_input_function &signal, const queue_position position=back_child)
 Connect a signal for callback in set_text_input. More...
 
template<ui_event E>
std::enable_if_t< is_text_input_event(E)> disconnect_signal (const signal_text_input_function &signal, const queue_position position=back_child)
 Disconnect a signal for callback in set_text_input. 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...
 
void goto_end_of_data (const bool select=false)
 Moves the cursor to the end of all text. More...
 
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...
 
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
 
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_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 config ()
 
resolution_definition_const_ptr 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 void impl_draw_background (surface &frame_buffer, int x_offset, int y_offset) override
 See widget::impl_draw_background. More...
 
virtual void impl_draw_foreground (surface &frame_buffer, int x_offset, int y_offset) override
 See widget::impl_draw_foreground. More...
 
std::string get_label_token (const point &position, const char *delimiters=" \\) 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 pointlayout_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  visibility { visibility::visible, visibility::hidden, visibility::invisible }
 Visibility settings done by the user. More...
 
enum  redraw_action { redraw_action::full, redraw_action::partly, redraw_action::none }
 Visibility set by the engine. More...
 
enum  debug_border { debug_border::none, debug_border::outline, debug_border::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  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_offsetf_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_offsetf_unsigned"" The y offset of the text in the text box.

The following states exist:

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

Member Function Documentation

◆ clear()

void gui2::text_box::clear ( )
inline

◆ delete_char()

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

◆ delete_selection()

void gui2::text_box::delete_selection ( )
overrideprotectedvirtual

◆ 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.

◆ 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.

◆ 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 339 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 328 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

◆ 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 315 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 302 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

◆ save_to_history()

void gui2::text_box::save_to_history ( )
inline

◆ 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.

Referenced by gui2::implementation::builder_text_box::build().

◆ set_history()

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

◆ 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.

Referenced by gui2::implementation::builder_text_box::build().

◆ 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 386 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

◆ 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 376 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 346 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

◆ update_offsets()

void gui2::text_box::update_offsets ( )
private

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 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 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(), and history_up().

◆ 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(), 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: