#include <scroll_text.hpp>

Inheritance diagram for gui2::scroll_text:

Public Member Functions
	scroll_text (const implementation::builder_scroll_text &builder)

virtual void	set_label (const t_string &label) override

void	set_value (const t_string &label)

std::string	get_value ()

virtual void	set_text_alignment (const PangoAlignment text_alignment) override
	See styled_widget::set_text_alignment. More...

virtual void	set_self_active (const bool active) override
	See container_base::set_self_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...

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

void	set_can_wrap (bool can_wrap)

void	set_link_aware (bool l)

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

void	set_editable (bool editable)

bool	is_editable () const

multiline_text *	get_internal_text_box ()

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

virtual	~scrollbar_container ()

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

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

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

virtual void	set_origin (const point &origin) override
	See widget::set_origin. More...

virtual void	set_visible_rectangle (const SDL_Rect &rectangle) override
	See widget::set_visible_rectangle. 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_view id, const bool must_be_active) override
	See widget::find. More...

const widget *	find (const std::string_view id, const bool must_be_active) const override
	See widget::find. 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...

void	set_vertical_scrollbar_mode (const scrollbar_mode scrollbar_mode)

scrollbar_mode	get_vertical_scrollbar_mode () const

void	set_horizontal_scrollbar_mode (const scrollbar_mode scrollbar_mode)

scrollbar_mode	get_horizontal_scrollbar_mode () const

grid *	content_grid ()

const grid *	content_grid () const

const SDL_Rect &	content_visible_area () const

bool	vertical_scrollbar_at_end ()

unsigned	get_vertical_scrollbar_item_position () const
	Returns current position of the vertical scrollbar. More...

void	set_vertical_scrollbar_item_position (const unsigned position)
	Move the vertical scrollbar to a position. More...

unsigned	get_horizontal_scrollbar_item_position () const
	Returns current position of the horizontal scrollbar. More...

void	set_horizontal_scrollbar_item_position (const unsigned position)
	Move the horizontal scrollbar to a position. More...

void	scroll_vertical_scrollbar (const scrollbar_base::scroll_mode scroll)
	Scrolls the vertical scrollbar. More...

void	scroll_horizontal_scrollbar (const scrollbar_base::scroll_mode scroll)
	Scrolls the horizontal scrollbar. More...

void	scroll_vertical_scrollbar_by (const int pixels)
	Scrolls the vertical scrollbar by pixel. More...

void	scroll_horizontal_scrollbar_by (const int pixels)
	Scrolls the horizontal scrollbar by pixel. More...

void	vertical_scrollbar_moved ()
	Callback when the scrollbar moves (NOTE maybe only one callback needed). More...

void	horizontal_scrollbar_moved ()

void	move_viewport (const int pixels_x, const int pixels_y)
	To be called after the scollbar moves manually (by pixel) to move the viewport. More...

scrollbar_base *	horizontal_scrollbar ()

scrollbar_base *	vertical_scrollbar ()

grid *	get_horizontal_scrollbar_grid ()

grid *	get_vertical_scrollbar_grid ()

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

virtual SDL_Rect	get_client_rect () const
	Returns the client rect. More...

void	reduce_width (const unsigned maximum_width)
	Tries to reduce the width of a container. More...

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

void	reduce_height (const unsigned maximum_height)
	Tries to reduce the height of a container. More...

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

virtual bool	has_widget (const widget &widget) const override
	See widget::has_widget. More...

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

void	init_grid (const builder_grid &grid_builder)
	Initializes and builds the grid. More...

grid::iterator	begin ()

grid::iterator	end ()

unsigned	add_row (const unsigned count=1)

void	set_rows (const unsigned rows)

unsigned int	get_rows () const

void	set_cols (const unsigned cols)

unsigned int	get_cols () const

void	set_rows_cols (const unsigned rows, const unsigned cols)

void	set_child (std::unique_ptr< widget > widget, const unsigned row, const unsigned col, const unsigned flags, const unsigned border_size)

void	set_row_grow_factor (const unsigned row, const unsigned factor)

void	set_column_grow_factor (const unsigned column, const unsigned factor)

const grid &	get_grid () const

grid &	get_grid ()

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

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 color_t	get_link_color () const
	Returns the color string to be used with links. More...

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

const widget *	find (const std::string_view 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_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)

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

void	set_text_maximum_width (int max_width)
	Set how wide the text can become. 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...

const grid *	get_parent_grid () const

void	set_parent (widget *parent)

widget *	parent ()

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

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)

std::string	get_linked_group () const

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

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

void	set_visible (bool visible)
	Sets widget to visible if visible is true, else invisible. More...

void	set_hidden (bool hidden)
	Sets widget to visible if hidden is true, else hidden. More...

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)

template<class T >
T *	find_widget (const std::string_view id, const bool must_be_active, const bool must_exist)
	Gets a widget with the wanted id. More...

template<class T >
const T *	find_widget (const std::string_view id, const bool must_be_active, const bool must_exist) const

template<class T >
T &	find_widget (const std::string_view id, const bool must_be_active=false)
	Gets a widget with the wanted id. More...

template<class T >
const T &	find_widget (const std::string_view id, const bool must_be_active=false) const

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

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

Private Types
enum	state_t { ENABLED , DISABLED }
	Possible states of the widget. More...

Private Member Functions
void	finalize_subclass () override
	Function for the subclasses to do their setup. More...

void	refresh ()
	Used for moving scrollbars. More...

unsigned	get_horizontal_position ()

unsigned	get_vertical_position ()

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

point	calculate_best_size () const override
	See widget::calculate_best_size. More...

void	set_max_size (point max_size)
	Sets the size of the text beyond which scrollbars should be visible. More...

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

void	signal_handler_left_button_down (const event::ui_event event)

Private Attributes
state_t	state_
	Current state of the widget. More...

bool	wrap_on_

PangoAlignment	text_alignment_

bool	editable_

point	max_size_

bool	link_aware_

Friends
struct	implementation::builder_scroll_text

Additional Inherited Members
Public Types inherited from gui2::scrollbar_container
enum	scrollbar_mode { ALWAYS_VISIBLE , ALWAYS_INVISIBLE , AUTO_VISIBLE , AUTO_VISIBLE_FIRST_RUN }
	The way to handle the showing or hiding of the scrollbar. 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...

Protected Member Functions inherited from gui2::scrollbar_container
void	show_content_rect (const SDL_Rect &rect)
	Shows a certain part of the content. More...

void	set_scrollbar_button_status ()
	Sets the status of the scrollbar buttons. More...

bool	content_resize_request (const bool force_sizing=false)
	Notification if the content of a child needs a resize. More...

bool	content_resize_request (const int width_modification, const int height_modification, const int width_modification_pos=-1, const int height_modification_pos=-1)
	Request from the content to modify the size of the container. More...

virtual void	handle_key_home (SDL_Keymod modifier, bool &handled)
	Home key pressed. More...

virtual void	handle_key_end (SDL_Keymod modifier, bool &handled)
	End key pressed. More...

virtual void	handle_key_page_up (SDL_Keymod modifier, bool &handled)
	Page up key pressed. More...

virtual void	handle_key_page_down (SDL_Keymod modifier, bool &handled)
	Page down key pressed. More...

virtual void	handle_key_up_arrow (SDL_Keymod modifier, bool &handled)
	Up arrow key pressed. More...

virtual void	handle_key_down_arrow (SDL_Keymod modifier, bool &handled)
	Down arrow key pressed. More...

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

void	finalize_setup ()
	The builder needs to call us so we do our setup. More...

Protected Member Functions inherited from gui2::styled_widget
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)

virtual void	update_canvas ()
	Updates the canvas(ses). More...

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

Detailed Description

Definition at line 35 of file scroll_text.hpp.

Member Enumeration Documentation

◆ state_t

enum gui2::scroll_text::state_t

private

Possible states of the widget.

Note the order of the states must be the same as defined in settings.hpp.

Enumerator
ENABLED
DISABLED

Definition at line 94 of file scroll_text.hpp.

Constructor & Destructor Documentation

◆ scroll_text()

gui2::scroll_text::scroll_text ( const implementation::builder_scroll_text & builder )

explicit

Definition at line 39 of file scroll_text.cpp.

References gui2::event::dispatcher::back_pre_child, and signal_handler_left_button_down().

Member Function Documentation

◆ calculate_best_size()

point gui2::scroll_text::calculate_best_size ( ) const

overrideprivatevirtual

See widget::calculate_best_size.

Reimplemented from gui2::scrollbar_container.

Definition at line 166 of file scroll_text.cpp.

References gui2::scrollbar_container::calculate_best_size(), and max_size_.

◆ can_wrap()

bool gui2::scroll_text::can_wrap ( ) const

overridevirtual

See widget::can_wrap.

Note: This function is called before the object is finalized.

Reimplemented from gui2::scrollbar_container.

Definition at line 204 of file scroll_text.cpp.

Referenced by set_can_wrap().

◆ finalize_subclass()

void gui2::scroll_text::finalize_subclass ( )

overrideprivatevirtual

Function for the subclasses to do their setup.

This function is called at the end of finalize_setup().

Reimplemented from gui2::scrollbar_container.

Definition at line 121 of file scroll_text.cpp.

References get_internal_text_box(), gui2::styled_widget::get_label(), gui2::styled_widget::get_use_markup(), is_editable(), link_aware_, gui2::text_box_base::set_editable(), gui2::styled_widget::set_label(), gui2::multiline_text::set_link_aware(), gui2::styled_widget::set_text_alignment(), gui2::styled_widget::set_use_markup(), and text_alignment_.

◆ get_active()

bool gui2::scroll_text::get_active ( ) const

overridevirtual

See styled_widget::get_active.

Reimplemented from gui2::scrollbar_container.

Definition at line 111 of file scroll_text.cpp.

References DISABLED, and state_.

◆ get_control_type()

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

overrideprivatevirtual

Inherited from styled_widget, implemented by REGISTER_WIDGET.

Reimplemented from gui2::scrollbar_container.

◆ get_horizontal_position()

unsigned gui2::scroll_text::get_horizontal_position ( )

inlineprivate

Definition at line 127 of file scroll_text.hpp.

References gui2::scrollbar_base::get_positioner_offset(), and gui2::scrollbar_container::horizontal_scrollbar().

◆ get_internal_text_box()

multiline_text * gui2::scroll_text::get_internal_text_box ( )

Definition at line 53 of file scroll_text.cpp.

References gui2::scrollbar_container::content_grid(), and gui2::grid::find().

Referenced by finalize_subclass(), get_value(), place(), set_label(), set_link_aware(), and set_text_alignment().

◆ get_link_aware()

virtual bool gui2::scroll_text::get_link_aware ( ) const

inlineoverridevirtual

See styled_widget::get_link_aware.

Reimplemented from gui2::styled_widget.

Definition at line 73 of file scroll_text.hpp.

References link_aware_.

◆ get_state()

unsigned gui2::scroll_text::get_state ( ) const

overridevirtual

See styled_widget::get_state.

Reimplemented from gui2::scrollbar_container.

Definition at line 116 of file scroll_text.cpp.

References state_.

◆ get_value()

std::string gui2::scroll_text::get_value ( )

Definition at line 76 of file scroll_text.cpp.

References get_internal_text_box().

Referenced by gui2::chatbox::append_to_chatbox(), and gui2::dialogs::editor_edit_unit::save_unit_type().

◆ get_vertical_position()

unsigned gui2::scroll_text::get_vertical_position ( )

inlineprivate

Definition at line 132 of file scroll_text.hpp.

References gui2::scrollbar_base::get_positioner_offset(), and gui2::scrollbar_container::vertical_scrollbar().

◆ is_editable()

bool gui2::scroll_text::is_editable ( ) const

inline

Definition at line 83 of file scroll_text.hpp.

References editable_.

Referenced by finalize_subclass().

◆ place()

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

overrideprivatevirtual

See widget::place.

Reimplemented from gui2::scrollbar_container.

Definition at line 133 of file scroll_text.cpp.

References gui2::scrollbar_base::BEGIN, gui2::scrollbar_container::content_visible_area(), gui2::scrollbar_base::END, get_internal_text_box(), gui2::scrollbar_container::place(), gui2::scrollbar_container::scroll_horizontal_scrollbar(), gui2::scrollbar_container::scroll_horizontal_scrollbar_by(), gui2::scrollbar_container::scroll_vertical_scrollbar(), gui2::scrollbar_container::scroll_vertical_scrollbar_by(), set_max_size(), and utf8::size().

Referenced by set_label().

◆ refresh()

void gui2::scroll_text::refresh ( )

private

Used for moving scrollbars.

Has to be called from signal notify_modified, otherwise doesn't work after invalidate_layout.

◆ set_can_wrap()

void gui2::scroll_text::set_can_wrap ( bool can_wrap )

Definition at line 199 of file scroll_text.cpp.

References can_wrap(), and wrap_on_.

◆ set_editable()

void gui2::scroll_text::set_editable ( bool editable )

inline

Definition at line 78 of file scroll_text.hpp.

References editable_.

◆ set_label()

void gui2::scroll_text::set_label ( const t_string & label )

overridevirtual

Reimplemented from gui2::styled_widget.

Definition at line 62 of file scroll_text.cpp.

References gui2::scrollbar_container::content_resize_request(), get_internal_text_box(), gui2::widget::get_origin(), gui2::widget::get_size(), place(), and draw::point().

Referenced by gui2::chatbox::clear_messages(), and set_value().

◆ set_link_aware()

void gui2::scroll_text::set_link_aware ( bool l )

Definition at line 85 of file scroll_text.cpp.

References get_internal_text_box(), and link_aware_.

◆ set_max_size()

void gui2::scroll_text::set_max_size ( point max_size )

private

Sets the size of the text beyond which scrollbars should be visible.

Definition at line 181 of file scroll_text.cpp.

References gui2::widget::get_best_size(), gui2::scrollbar_container::get_horizontal_scrollbar_grid(), gui2::scrollbar_container::get_vertical_scrollbar_grid(), gui2::widget::get_visible(), gui2::widget::invisible, max_size_, and draw::point().

Referenced by place().

◆ set_self_active()

void gui2::scroll_text::set_self_active ( const bool active )

overridevirtual

See container_base::set_self_active.

Implements gui2::container_base.

Definition at line 106 of file scroll_text.cpp.

References DISABLED, ENABLED, and state_.

◆ set_text_alignment()

void gui2::scroll_text::set_text_alignment ( const PangoAlignment text_alignment )

overridevirtual

See styled_widget::set_text_alignment.

Reimplemented from gui2::styled_widget.

Definition at line 94 of file scroll_text.cpp.

References get_internal_text_box(), gui2::styled_widget::set_text_alignment(), and text_alignment_.

◆ set_value()

void gui2::scroll_text::set_value ( const t_string & label )

inline

Definition at line 47 of file scroll_text.hpp.

References set_label().

Referenced by gui2::chatbox::append_to_chatbox().

◆ signal_handler_left_button_down()

void gui2::scroll_text::signal_handler_left_button_down ( const event::ui_event event )

private

Definition at line 209 of file scroll_text.cpp.

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

Referenced by scroll_text().

◆ type()

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

static

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

Friends And Related Function Documentation

◆ implementation::builder_scroll_text

friend struct implementation::builder_scroll_text

friend

Definition at line 37 of file scroll_text.hpp.

Member Data Documentation

◆ editable_

bool gui2::scroll_text::editable_

private

Definition at line 114 of file scroll_text.hpp.

Referenced by is_editable(), and set_editable().

◆ link_aware_

bool gui2::scroll_text::link_aware_

private

Definition at line 118 of file scroll_text.hpp.

Referenced by finalize_subclass(), get_link_aware(), and set_link_aware().

◆ max_size_

point gui2::scroll_text::max_size_

private

Definition at line 116 of file scroll_text.hpp.

Referenced by calculate_best_size(), and set_max_size().

◆ state_

state_t gui2::scroll_text::state_

private

Current state of the widget.

The state of the widget determines what to render and how the widget reacts to certain 'events'.

Definition at line 108 of file scroll_text.hpp.

Referenced by get_active(), get_state(), and set_self_active().

◆ text_alignment_

PangoAlignment gui2::scroll_text::text_alignment_

private

Definition at line 112 of file scroll_text.hpp.

Referenced by finalize_subclass(), and set_text_alignment().

◆ wrap_on_

bool gui2::scroll_text::wrap_on_

private

Definition at line 110 of file scroll_text.hpp.

Referenced by set_can_wrap().

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

gui/widgets/scroll_text.hpp
gui/widgets/scroll_text.cpp

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ state_t

Constructor & Destructor Documentation

◆ scroll_text()

Member Function Documentation

◆ calculate_best_size()

◆ can_wrap()

◆ finalize_subclass()

◆ get_active()

◆ get_control_type()

◆ get_horizontal_position()

◆ get_internal_text_box()

◆ get_link_aware()

◆ get_state()

◆ get_value()

◆ get_vertical_position()

◆ is_editable()

◆ place()

◆ refresh()

◆ set_can_wrap()

◆ set_editable()

◆ set_label()

◆ set_link_aware()

◆ set_max_size()

◆ set_self_active()

◆ set_text_alignment()

◆ set_value()

◆ signal_handler_left_button_down()

◆ type()

Friends And Related Function Documentation

◆ implementation::builder_scroll_text

Member Data Documentation

◆ editable_

◆ link_aware_

◆ max_size_

◆ state_

◆ text_alignment_

◆ wrap_on_