A stacked widget holds several widgets on top of each other. More...

#include <stacked_widget.hpp>

Inheritance diagram for gui2::stacked_widget:

Public Member Functions
	stacked_widget (const implementation::builder_stacked_widget &builder)

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

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

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

int	current_layer () const
	Gets the current visible layer number. More...

bool	layer_selected (const unsigned layer)
	Tests if the specified layer is selected (ie, visible). More...

void	select_layer (const int layer)
	Selects and displays a particular layer. More...

void	select_layers (const boost::dynamic_bitset<> &mask)
	Selects and displays multiple layers based on the state of the provided dynamic_bitset. More...

unsigned int	get_layer_count () const
	Gets the total number of layers. More...

grid *	get_layer_grid (unsigned int i)
	Gets the grid for a specified layer. More...

const grid *	get_layer_grid (unsigned int i) const
	Const overload for get_layer_grid. More...

void	set_find_in_all_layers (const bool do_find)

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

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

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

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

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_ptr	create_walker () override
	See widget::create_walker. 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 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 &text)

virtual void	set_use_markup (bool use_markup)

bool	get_use_markup () const

const t_string &	tooltip () const

void	set_tooltip (const t_string &tooltip)

const t_string &	help_message () const

void	set_help_message (const t_string &help_message)

std::vector< canvas > &	get_canvases ()

canvas &	get_canvas (const unsigned index)

virtual void	set_text_alignment (const PangoAlignment text_alignment)

PangoAlignment	get_text_alignment () const

void	set_text_ellipse_mode (const PangoEllipsizeMode ellipse_mode)

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

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

widget &	operator= (const widget &)=delete

	widget ()

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

virtual	~widget () override

void	set_id (const std::string &id)

const std::string &	id () const

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

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

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

void	set_parent (widget *parent)

widget *	parent ()

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)

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

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)

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

Private Member Functions
void	finalize (std::unique_ptr< generator_base > generator, const std::vector< builder_grid > &widget_builders)
	Finishes the building initialization of the widget. More...

void	update_selected_layer_index (const int i)

void	select_layer_impl (std::function< bool(unsigned int i)> display_condition)
	Internal implementation detail for selecting layers. More...

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

virtual void	set_self_active (const bool active) override
	See container_base::set_self_active. More...

Private Attributes
generator_base *	generator_
	Contains a pointer to the generator. More...

int	selected_layer_
	The number of the current selected layer. More...

bool	find_in_all_layers_
	If true, find will search all layers for widgets regardless of which one is visible. More...

Friends
struct	stacked_widget_implementation

struct	implementation::builder_stacked_widget

class	debug_layout_graph

Additional Inherited Members
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::container_base
virtual point	calculate_best_size () const override
	See widget::calculate_best_size. 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

A stacked widget holds several widgets on top of each other.

This can be used for various effects; add an optional overlay to an image, stack it with a spacer to force a minimum size of a widget. The latter is handy to avoid making a separate definition for a single instance with a fixed size.

A stacked widget has no states.

Definition at line 46 of file stacked_widget.hpp.

Constructor & Destructor Documentation

◆ stacked_widget()

gui2::stacked_widget::stacked_widget ( const implementation::builder_stacked_widget & builder )

explicit

Definition at line 61 of file stacked_widget.cpp.

Member Function Documentation

◆ current_layer()

int gui2::stacked_widget::current_layer ( ) const

inline

Gets the current visible layer number.

The current layer number will be -1 if all layers are currently visible. In this case, only the topmost (highest-numbered) layer will receive events.

If more than one but not all layers are visible, this will be the number of the last one made visible.

Returns: The most recently shown layer

Definition at line 78 of file stacked_widget.hpp.

References selected_layer_.

Referenced by gui2::dialogs::story_viewer::display_part(), and gui2::dialogs::addon_manager::toggle_details().

◆ finalize()

void gui2::stacked_widget::finalize	(	std::unique_ptr< generator_base >	generator,
		const std::vector< builder_grid > &	widget_builders
	)

private

Finishes the building initialization of the widget.

Parameters

generator	Generator for the list
widget_builders	The builder to build the contents of the widget.

Definition at line 87 of file stacked_widget.cpp.

References gui2::generator< minimum_selection, maximum_selection, my_placement, select_action >::create_item(), generator_, gui2::container_base::get_grid(), select_layer(), and gui2::swap_grid().

◆ find() [1/2]

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

overridevirtual

See widget::find.

Reimplemented from gui2::container_base.

Definition at line 201 of file stacked_widget.cpp.

◆ find() [2/2]

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

overridevirtual

See widget::find.

Reimplemented from gui2::container_base.

Definition at line 196 of file stacked_widget.cpp.

◆ get_active()

bool gui2::stacked_widget::get_active ( ) const

overridevirtual

See styled_widget::get_active.

Implements gui2::styled_widget.

Definition at line 69 of file stacked_widget.cpp.

◆ get_control_type()

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

overrideprivatevirtual

Inherited from styled_widget, implemented by REGISTER_WIDGET.

Implements gui2::styled_widget.

◆ get_layer_count()

unsigned int gui2::stacked_widget::get_layer_count ( ) const

Gets the total number of layers.

Returns: The total number of layers

Definition at line 179 of file stacked_widget.cpp.

References generator_, and gui2::generator_base::get_item_count().

Referenced by layer_selected(), gui2::dialogs::game_version::pre_show(), gui2::dialogs::preferences_dialog::pre_show(), gui2::dialogs::server_info::pre_show(), select_layer_impl(), select_layers(), and update_selected_layer_index().

◆ get_layer_grid() [1/2]

grid * gui2::stacked_widget::get_layer_grid ( unsigned int i )

Gets the grid for a specified layer.

This can be used to search for widgets in a hidden layer.

Parameters

i	The layer to retrieve

Returns: The grid for the specified layer.

Definition at line 184 of file stacked_widget.cpp.

References generator_, i, and gui2::generator_base::item().

Referenced by gui2::dialogs::story_viewer::display_part(), gui2::dialogs::addon_manager::pre_show(), and gui2::dialogs::preferences_dialog::pre_show().

◆ get_layer_grid() [2/2]

const grid * gui2::stacked_widget::get_layer_grid ( unsigned int i ) const

Const overload for get_layer_grid.

Definition at line 190 of file stacked_widget.cpp.

References generator_, i, and gui2::generator_base::item().

◆ get_state()

unsigned gui2::stacked_widget::get_state ( ) const

overridevirtual

See styled_widget::get_state.

Implements gui2::styled_widget.

Definition at line 74 of file stacked_widget.cpp.

◆ layer_selected()

bool gui2::stacked_widget::layer_selected ( const unsigned layer )

Tests if the specified layer is selected (ie, visible).

Parameters

layer The layer to test

Returns: True if the specified layer is selected

Definition at line 149 of file stacked_widget.cpp.

References generator_, get_layer_count(), and gui2::generator_base::is_selected().

◆ layout_children()

void gui2::stacked_widget::layout_children ( )

overridevirtual

See widget::layout_children.

Reimplemented from gui2::container_base.

Definition at line 79 of file stacked_widget.cpp.

References generator_, gui2::generator_base::get_item_count(), i, gui2::generator_base::item(), and gui2::grid::layout_children().

◆ select_layer()

void gui2::stacked_widget::select_layer ( const int layer )

Selects and displays a particular layer.

If layer -1 is selected, all layers will be displayed but only the topmost (highest-numbered) layer will receive events.

Parameters

layer The layer to select

Definition at line 155 of file stacked_widget.cpp.

References i, select_layer_impl(), selected_layer_, and update_selected_layer_index().

Referenced by gui2::dialogs::editor_edit_unit::add_attack(), gui2::dialogs::story_viewer::display_part(), finalize(), gui2::dialogs::editor_edit_unit::load_unit_type(), gui2::dialogs::addon_manager::on_addon_select(), gui2::dialogs::addon_manager::on_selected_version_change(), gui2::dialogs::addon_manager::pre_show(), gui2::dialogs::editor_edit_unit::pre_show(), gui2::dialogs::game_version::pre_show(), gui2::dialogs::preferences_dialog::pre_show(), gui2::dialogs::server_info::pre_show(), gui2::dialogs::editor_edit_unit::save_unit_type(), gui2::addon_list::set_addons(), gui2::dialogs::editor_edit_unit::store_attack(), gui2::dialogs::game_version::tab_switch_callback(), gui2::dialogs::server_info::tab_switch_callback(), gui2::dialogs::addon_manager::toggle_details(), gui2::dialogs::editor_edit_unit::update_attacks(), and gui2::dialogs::editor_edit_unit::update_wml_view().

◆ select_layer_impl()

void gui2::stacked_widget::select_layer_impl ( std::function< bool(unsigned int i)> display_condition )

private

Internal implementation detail for selecting layers.

Definition at line 107 of file stacked_widget.cpp.

References generator_, get_layer_count(), i, gui2::generator_base::is_selected(), gui2::generator_base::select_item(), game_config::images::selected, and selected_layer_.

Referenced by select_layer(), and select_layers().

◆ select_layers()

void gui2::stacked_widget::select_layers ( const boost::dynamic_bitset<> & mask )

Selects and displays multiple layers based on the state of the provided dynamic_bitset.

Parameters

mask	A mask specifying which layers to select and deselect

Definition at line 165 of file stacked_widget.cpp.

References get_layer_count(), i, select_layer_impl(), and update_selected_layer_index().

◆ set_find_in_all_layers()

void gui2::stacked_widget::set_find_in_all_layers ( const bool do_find )

inline

Definition at line 124 of file stacked_widget.hpp.

References find_in_all_layers_.

Referenced by gui2::dialogs::preferences_dialog::pre_show().

◆ set_self_active()

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

overrideprivatevirtual

See container_base::set_self_active.

Implements gui2::container_base.

Definition at line 102 of file stacked_widget.cpp.

◆ type()

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

static

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

◆ update_selected_layer_index()

void gui2::stacked_widget::update_selected_layer_index ( const int i )

private

Definition at line 144 of file stacked_widget.cpp.

References get_layer_count(), i, and selected_layer_.

Referenced by select_layer(), and select_layers().

Friends And Related Function Documentation

◆ debug_layout_graph

friend class debug_layout_graph

friend

Definition at line 50 of file stacked_widget.hpp.

◆ implementation::builder_stacked_widget

friend struct implementation::builder_stacked_widget

friend

Definition at line 49 of file stacked_widget.hpp.

◆ stacked_widget_implementation

friend struct stacked_widget_implementation

friend

Definition at line 48 of file stacked_widget.hpp.

Member Data Documentation

◆ find_in_all_layers_

bool gui2::stacked_widget::find_in_all_layers_

private

If true, find will search all layers for widgets regardless of which one is visible.

Definition at line 166 of file stacked_widget.hpp.

Referenced by set_find_in_all_layers().

◆ generator_

generator_base* gui2::stacked_widget::generator_

private

Contains a pointer to the generator.

The pointer is not owned by this class, it's stored in the content_grid_ of the scrollbar_container super class and freed when its grid is freed.

NOTE: the generator is initialized with has_minimum (first arg) as false, which seems a little counter-intuitive at first. After all, shouldn't the stack always have at least one layer visible? However, this allows select_layer to function correctly.

If has_minimum is true, the generator policy selected (one_item) can leave multiple layers selected when selecting a new one. This is most likely due to cases where the new chosen layer comes after the currently selected one. In that case, the generator would not allow the interim state where no layer before the new chosen layer is reached in the loop.

Definition at line 155 of file stacked_widget.hpp.

Referenced by finalize(), get_layer_count(), get_layer_grid(), layer_selected(), layout_children(), and select_layer_impl().

◆ selected_layer_

int gui2::stacked_widget::selected_layer_

private

The number of the current selected layer.

Definition at line 160 of file stacked_widget.hpp.

Referenced by current_layer(), select_layer(), select_layer_impl(), and update_selected_layer_index().

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

gui/widgets/stacked_widget.hpp
gui/widgets/stacked_widget.cpp

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ stacked_widget()

Member Function Documentation

◆ current_layer()

◆ finalize()

◆ find() [1/2]

◆ find() [2/2]

◆ get_active()

◆ get_control_type()

◆ get_layer_count()

◆ get_layer_grid() [1/2]

◆ get_layer_grid() [2/2]

◆ get_state()

◆ layer_selected()

◆ layout_children()

◆ select_layer()

◆ select_layer_impl()

◆ select_layers()

◆ set_find_in_all_layers()

◆ set_self_active()

◆ type()

◆ update_selected_layer_index()

Friends And Related Function Documentation

◆ debug_layout_graph

◆ implementation::builder_stacked_widget

◆ stacked_widget_implementation

Member Data Documentation

◆ find_in_all_layers_

◆ generator_

◆ selected_layer_