A generic container base class. More...

#include <container_base.hpp>

Inheritance diagram for gui2::container_base:

Public Member Functions
	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...

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

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

virtual void	request_reduce_width (const unsigned maximum_width) override
	See widget::request_reduce_width. 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	request_reduce_height (const unsigned maximum_height) override
	See widget::request_reduce_height. More...

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

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

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

virtual bool	has_widget (const widget &widget) const override
	See widget::has_widget. 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 void	impl_draw_children (surface &frame_buffer, int x_offset, int y_offset) override
	See widget::impl_draw_children. 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...

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

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

virtual iteration::walker_base *	create_walker () override
	See widget::create_walker. More...

void	init_grid (const std::shared_ptr< 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 (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 string_map &data)
	Sets the members of the styled_widget. More...

virtual bool	get_active () const =0
	Gets the active state 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 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...

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 &label)

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

virtual const std::string &	get_control_type () const =0
	Returns the type of this styled_widget. 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 ()

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

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

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 unsigned debug_border_mode)

void	set_debug_border_color (const color_t debug_border_color)

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

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)

Protected Member Functions
virtual point	calculate_best_size () const override
	See widget::calculate_best_size. More...

virtual void	layout_children () override
	See widget::layout_children. More...

virtual void	child_populate_dirty_list (window &caller, const std::vector< widget *> &call_stack) override
	See widget::child_populate_dirty_list. More...

Protected Member Functions inherited from gui2::styled_widget
virtual unsigned	get_state () const =0
	Returns the id of the state. 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)

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 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 point &	layout_size () const

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

Private Member Functions
virtual point	border_space () const
	Returns the space used by the border. More...

virtual void	set_self_active (const bool active)=0
	Helper for set_active. More...

void	inject_linked_groups ()

Private Attributes
grid	grid_
	The grid which holds the child objects. More...

Friends
class	debug_layout_graph

Additional Inherited Members
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...

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

A generic container base class.

A container is a class build with multiple items either acting as one widget.

Definition at line 35 of file container_base.hpp.

Constructor & Destructor Documentation

◆ container_base()

gui2::container_base::container_base	(	const implementation::builder_styled_widget &	builder,
		const std::string &	control_type
	)

explicit

Definition at line 31 of file container_base.cpp.

References gui2::event::dispatcher::back_pre_child, gui2::widget::clear_layout_size(), grid_, and gui2::widget::set_parent().

Member Function Documentation

◆ add_row()

unsigned gui2::container_base::add_row ( const unsigned count = 1 )

inline

Definition at line 175 of file container_base.hpp.

◆ begin()

grid::iterator gui2::container_base::begin ( )

inline

Definition at line 166 of file container_base.hpp.

◆ border_space()

point gui2::container_base::border_space ( ) const

privatevirtual

Returns the space used by the border.

Reimplemented in gui2::toggle_panel, and gui2::panel.

Definition at line 275 of file container_base.cpp.

Referenced by calculate_best_size(), demand_reduce_height(), demand_reduce_width(), reduce_height(), reduce_width(), request_reduce_height(), and request_reduce_width().

◆ calculate_best_size()

point gui2::container_base::calculate_best_size ( ) const

overrideprotectedvirtual

See widget::calculate_best_size.

Reimplemented from gui2::styled_widget.

Reimplemented in gui2::listbox, gui2::scrollbar_container, and gui2::size_lock.

Definition at line 148 of file container_base.cpp.

References border_space(), DBG_GUI_L, gui2::widget::get_best_size(), gui2::styled_widget::get_config_default_size(), grid_, gui2::log_gui_layout, LOG_HEADER, log_scope2, LOG_SCOPE_HEADER, point::x, and point::y.

◆ can_wrap()

bool gui2::container_base::can_wrap ( ) const

overridevirtual

See widget::can_wrap.

Reimplemented from gui2::widget.

Reimplemented in gui2::scrollbar_container, and gui2::scroll_label.

Definition at line 128 of file container_base.cpp.

References gui2::grid::can_wrap(), gui2::widget::can_wrap(), and grid_.

◆ child_populate_dirty_list()

void gui2::container_base::child_populate_dirty_list	(	window &	caller,
		const std::vector< widget *> &	call_stack
	)

overrideprotectedvirtual

See widget::child_populate_dirty_list.

Reimplemented from gui2::widget.

Reimplemented in gui2::scrollbar_container, gui2::listbox, and gui2::tree_view.

Definition at line 213 of file container_base.cpp.

References wfl::call_stack, grid_, and gui2::widget::populate_dirty_list().

Referenced by gui2::scrollbar_container::child_populate_dirty_list().

◆ create_walker()

virtual iteration::walker_base* gui2::container_base::create_walker ( )

inlineoverridevirtual

See widget::create_walker.

Todo:: Implement properly.

Reimplemented from gui2::styled_widget.

Definition at line 150 of file container_base.hpp.

◆ demand_reduce_height()

void gui2::container_base::demand_reduce_height ( const unsigned maximum_height )

overridevirtual

See widget::demand_reduce_height.

Reimplemented from gui2::widget.

Definition at line 123 of file container_base.cpp.

References border_space(), gui2::grid::demand_reduce_height(), and grid_.

◆ demand_reduce_width()

void gui2::container_base::demand_reduce_width ( const unsigned maximum_width )

overridevirtual

See widget::demand_reduce_width.

Reimplemented from gui2::widget.

Definition at line 88 of file container_base.cpp.

References border_space(), gui2::grid::demand_reduce_width(), and grid_.

◆ disable_click_dismiss()

bool gui2::container_base::disable_click_dismiss ( ) const

overridevirtual

See widget::disable_click_dismiss.

Implements gui2::widget.

Reimplemented in gui2::scrollbar_container.

Definition at line 260 of file container_base.cpp.

References gui2::styled_widget::disable_click_dismiss(), gui2::grid::disable_click_dismiss(), and grid_.

Referenced by gui2::scrollbar_container::disable_click_dismiss(), and gui2::window::layout().

◆ end()

grid::iterator gui2::container_base::end ( )

inline

Definition at line 170 of file container_base.hpp.

◆ find() [1/2]

widget * gui2::container_base::find	(	const std::string &	id,
		const bool	must_be_active
	)

overridevirtual

See widget::find.

Reimplemented from gui2::widget.

Reimplemented in gui2::window, gui2::stacked_widget, and gui2::scrollbar_container.

Definition at line 232 of file container_base.cpp.

References gui2::styled_widget::find(), gui2::grid::find(), and grid_.

Referenced by gui2::window::find(), and gui2::toggle_panel::set_child_members().

◆ find() [2/2]

const widget * gui2::container_base::find	(	const std::string &	id,
		const bool	must_be_active
	)		const

overridevirtual

See widget::find.

Reimplemented from gui2::widget.

Reimplemented in gui2::window, gui2::stacked_widget, and gui2::scrollbar_container.

Definition at line 238 of file container_base.cpp.

References gui2::styled_widget::find(), gui2::grid::find(), and grid_.

◆ find_at() [1/2]

widget * gui2::container_base::find_at	(	const point &	coordinate,
		const bool	must_be_active
	)

overridevirtual

See widget::find_at.

Reimplemented from gui2::styled_widget.

Reimplemented in gui2::window, gui2::scrollbar_container, and gui2::toggle_panel.

Definition at line 220 of file container_base.cpp.

References gui2::grid::find_at(), and grid_.

Referenced by gui2::toggle_panel::find_at(), and gui2::window::find_at().

◆ find_at() [2/2]

const widget * gui2::container_base::find_at	(	const point &	coordinate,
		const bool	must_be_active
	)		const

overridevirtual

See widget::find_at.

Reimplemented from gui2::styled_widget.

Reimplemented in gui2::window, gui2::scrollbar_container, and gui2::toggle_panel.

Definition at line 226 of file container_base.cpp.

References gui2::grid::find_at(), and grid_.

◆ get_client_rect()

SDL_Rect gui2::container_base::get_client_rect ( ) const

virtual

Returns the client rect.

The client rect is the area which is used for child items. The rest of the area of this widget is used for its own decoration.

Returns: The client rect.

Reimplemented in gui2::toggle_panel, and gui2::panel.

Definition at line 41 of file container_base.cpp.

References gui2::widget::get_rectangle().

Referenced by place(), and set_origin().

◆ get_cols()

unsigned int gui2::container_base::get_cols ( ) const

inline

Definition at line 193 of file container_base.hpp.

◆ get_grid() [1/2]

const grid& gui2::container_base::get_grid ( ) const

inline

Definition at line 227 of file container_base.hpp.

Referenced by gui2::listbox::calculate_best_size(), gui2::stacked_widget::finalize(), gui2::multi_page::finalize(), gui2::listbox::finalize(), gui2::window::finalize(), gui2::scrollbar_container::finalize_setup(), gui2::addon_list::get_listbox(), gui2::addon_list::get_selected_addon(), gui2::scrollbar_container::request_reduce_width(), and gui2::window::~window().

◆ get_grid() [2/2]

grid& gui2::container_base::get_grid ( )

inline

Definition at line 231 of file container_base.hpp.

◆ get_rows()

unsigned int gui2::container_base::get_rows ( ) const

inline

Definition at line 184 of file container_base.hpp.

◆ has_widget()

bool gui2::container_base::has_widget ( const widget & widget ) const

overridevirtual

See widget::has_widget.

Reimplemented from gui2::widget.

Definition at line 143 of file container_base.cpp.

References grid_, gui2::grid::has_widget(), and gui2::widget::has_widget().

◆ impl_draw_children()

void gui2::container_base::impl_draw_children	(	surface &	frame_buffer,
		int	x_offset,
		int	y_offset
	)

overridevirtual

See widget::impl_draw_children.

Reimplemented from gui2::widget.

Reimplemented in gui2::scrollbar_container.

Definition at line 197 of file container_base.cpp.

References gui2::widget::draw_children(), gui2::widget::get_visible(), grid_, and gui2::widget::visible.

Referenced by gui2::scrollbar_container::impl_draw_children().

◆ init_grid()

void gui2::container_base::init_grid ( const std::shared_ptr< builder_grid > & grid_builder )

Initializes and builds the grid.

This function should only be called upon an empty grid.

Parameters

grid_builder The builder for the grid.

Definition at line 266 of file container_base.cpp.

References gui2::grid::get_cols(), gui2::grid::get_rows(), grid_, gui2::log_gui_general, log_scope2, and LOG_SCOPE_HEADER.

◆ inject_linked_groups()

void gui2::container_base::inject_linked_groups ( )

private

Definition at line 280 of file container_base.cpp.

References gui2::styled_widget::config(), gui2::widget::get_window(), and gui2::window::init_linked_size_group().

Referenced by layout_initialize().

◆ layout_children()

void gui2::container_base::layout_children ( )

overrideprotectedvirtual

See widget::layout_children.

Reimplemented from gui2::widget.

Reimplemented in gui2::scrollbar_container, gui2::listbox, gui2::tree_view, gui2::size_lock, and gui2::stacked_widget.

Definition at line 207 of file container_base.cpp.

References grid_, and gui2::grid::layout_children().

Referenced by gui2::window::draw(), and gui2::scrollbar_container::layout_children().

◆ layout_initialize()

void gui2::container_base::layout_initialize ( const bool full_initialization )

overridevirtual

See widget::layout_initialize.

Reimplemented from gui2::styled_widget.

Reimplemented in gui2::scrollbar_container.

Definition at line 46 of file container_base.cpp.

References grid_, inject_linked_groups(), gui2::styled_widget::layout_initialize(), and gui2::grid::layout_initialize().

Referenced by gui2::window_implementation::layout(), gui2::window::layout(), and gui2::scrollbar_container::layout_initialize().

◆ place()

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

overridevirtual

See widget::place.

Reimplemented from gui2::styled_widget.

Reimplemented in gui2::listbox, gui2::scrollbar_container, and gui2::size_lock.

Definition at line 133 of file container_base.cpp.

References get_client_rect(), grid_, gui2::styled_widget::place(), and gui2::grid::place().

Referenced by gui2::window::layout(), gui2::size_lock::place(), and gui2::scrollbar_container::place().

◆ reduce_height()

void gui2::container_base::reduce_height ( const unsigned maximum_height )

Tries to reduce the height of a container.

See Layout algorithm for more information.

Parameters

maximum_height The wanted maximum height.

Definition at line 93 of file container_base.cpp.

References border_space(), gui2::widget::get_best_size(), grid_, gui2::grid::reduce_height(), gui2::widget::set_layout_size(), size, and point::y.

Referenced by gui2::window_implementation::layout(), and gui2::size_lock::place().

◆ reduce_width()

void gui2::container_base::reduce_width ( const unsigned maximum_width )

Tries to reduce the width of a container.

See Layout algorithm for more information.

Parameters

maximum_width The wanted maximum width.

Definition at line 56 of file container_base.cpp.

References border_space(), gui2::widget::get_best_size(), grid_, gui2::grid::reduce_width(), gui2::widget::set_layout_size(), size, point::x, and point::y.

Referenced by gui2::window_implementation::layout(), and gui2::size_lock::place().

◆ request_reduce_height()

void gui2::container_base::request_reduce_height ( const unsigned maximum_height )

overridevirtual

See widget::request_reduce_height.

Reimplemented from gui2::styled_widget.

Reimplemented in gui2::scrollbar_container.

Definition at line 108 of file container_base.cpp.

References border_space(), gui2::widget::get_best_size(), grid_, gui2::grid::request_reduce_height(), gui2::widget::set_layout_size(), size, and point::y.

◆ request_reduce_width()

void gui2::container_base::request_reduce_width ( const unsigned maximum_width )

overridevirtual

See widget::request_reduce_width.

Reimplemented from gui2::styled_widget.

Reimplemented in gui2::scrollbar_container.

Definition at line 72 of file container_base.cpp.

References border_space(), gui2::widget::get_best_size(), grid_, gui2::grid::request_reduce_width(), gui2::widget::set_layout_size(), size, point::x, and point::y.

◆ set_active()

void gui2::container_base::set_active ( const bool active )

overridevirtual

See styled_widget::set_active.

Implements gui2::styled_widget.

Reimplemented in gui2::addon_list, gui2::toggle_panel, gui2::chatbox, and gui2::unit_preview_pane.

Definition at line 245 of file container_base.cpp.

References gui2::styled_widget::get_active(), grid_, gui2::grid::set_active(), gui2::widget::set_is_dirty(), and set_self_active().

◆ set_child()

void gui2::container_base::set_child	(	widget *	widget,
		const unsigned	row,
		const unsigned	col,
		const unsigned	flags,
		const unsigned	border_size
	)

inline

Definition at line 203 of file container_base.hpp.

Referenced by gui2::size_lock::finalize().

◆ set_cols()

void gui2::container_base::set_cols ( const unsigned cols )

inline

Definition at line 189 of file container_base.hpp.

◆ set_column_grow_factor()

void gui2::container_base::set_column_grow_factor	(	const unsigned	column,
		const unsigned	factor
	)

inline

Definition at line 217 of file container_base.hpp.

◆ set_origin()

void gui2::container_base::set_origin ( const point & origin )

overridevirtual

See widget::set_origin.

Reimplemented from gui2::widget.

Reimplemented in gui2::scrollbar_container.

Definition at line 179 of file container_base.cpp.

References get_client_rect(), grid_, gui2::grid::set_origin(), and gui2::widget::set_origin().

Referenced by gui2::scrollbar_container::set_origin().

◆ set_row_grow_factor()

void gui2::container_base::set_row_grow_factor	(	const unsigned	row,
		const unsigned	factor
	)

inline

Definition at line 212 of file container_base.hpp.

◆ set_rows()

void gui2::container_base::set_rows ( const unsigned rows )

inline

Definition at line 180 of file container_base.hpp.

◆ set_rows_cols()

void gui2::container_base::set_rows_cols	(	const unsigned	rows,
		const unsigned	cols
	)

inline

Definition at line 198 of file container_base.hpp.

Referenced by gui2::size_lock::finalize().

◆ set_self_active()

virtual void gui2::container_base::set_self_active ( const bool active )

privatepure virtual

Helper for set_active.

This function should set the styled_widget itself active. It's called by set_active if the state needs to change. The widget is set to dirty() by set_active so we only need to change the state.

Implemented in gui2::listbox, gui2::multi_page, gui2::addon_list, gui2::stacked_widget, gui2::chatbox, gui2::unit_preview_pane, gui2::size_lock, gui2::tree_view, gui2::panel, gui2::scrollbar_panel, and gui2::scroll_label.

Referenced by set_active().

◆ set_visible_rectangle()

void gui2::container_base::set_visible_rectangle ( const SDL_Rect & rectangle )

overridevirtual

See widget::set_visible_rectangle.

Reimplemented from gui2::widget.

Reimplemented in gui2::scrollbar_container.

Definition at line 189 of file container_base.cpp.

References grid_, gui2::grid::set_visible_rectangle(), and gui2::widget::set_visible_rectangle().

Referenced by gui2::scrollbar_container::set_visible_rectangle().

Friends And Related Function Documentation

◆ debug_layout_graph

friend class debug_layout_graph

friend

Definition at line 37 of file container_base.hpp.

Member Data Documentation

◆ grid_

grid gui2::container_base::grid_

private

The grid which holds the child objects.

Definition at line 238 of file container_base.hpp.

Referenced by calculate_best_size(), can_wrap(), child_populate_dirty_list(), container_base(), demand_reduce_height(), demand_reduce_width(), disable_click_dismiss(), find(), find_at(), has_widget(), impl_draw_children(), init_grid(), layout_children(), layout_initialize(), place(), reduce_height(), reduce_width(), request_reduce_height(), request_reduce_width(), set_active(), set_origin(), and set_visible_rectangle().

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

gui/widgets/container_base.hpp
gui/widgets/container_base.cpp

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ container_base()

Member Function Documentation

◆ add_row()

◆ begin()

◆ border_space()

◆ calculate_best_size()

◆ can_wrap()

◆ child_populate_dirty_list()

◆ create_walker()

◆ demand_reduce_height()

◆ demand_reduce_width()

◆ disable_click_dismiss()

◆ end()

◆ find() [1/2]

◆ find() [2/2]

◆ find_at() [1/2]

◆ find_at() [2/2]

◆ get_client_rect()

◆ get_cols()

◆ get_grid() [1/2]

◆ get_grid() [2/2]

◆ get_rows()

◆ has_widget()

◆ impl_draw_children()

◆ init_grid()

◆ inject_linked_groups()

◆ layout_children()

◆ layout_initialize()

◆ place()

◆ reduce_height()

◆ reduce_width()

◆ request_reduce_height()

◆ request_reduce_width()

◆ set_active()

◆ set_child()

◆ set_cols()

◆ set_column_grow_factor()

◆ set_origin()

◆ set_row_grow_factor()

◆ set_rows()

◆ set_rows_cols()

◆ set_self_active()

◆ set_visible_rectangle()

Friends And Related Function Documentation

◆ debug_layout_graph

Member Data Documentation

◆ grid_