base class of top level items, the only item which needs to store the final canvases to draw on. More...

#include <window.hpp>

Inheritance diagram for gui2::window:

Classes
class	invalidate_layout_blocker
	Helper class to block invalidate_layout. More...

struct	linked_size
	Helper struct to force widgets the have the same size. More...

Public Types
enum class	status { NEW , SHOWING , REQUEST_CLOSE , CLOSED }
	The status of the window. More...

enum class	exit_hook { always , ok_only }

enum class	show_mode { none , modal , modeless , tooltip }

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

Public Member Functions
	window (const builder_window::window_resolution &definition)
	< Needs to be initialized in show. More...

virtual	~window ()

int	show (unsigned auto_close_timeout=0)
	Shows the window, running an event loop until it should close. More...

void	show_tooltip ()
	Shows the window as a tooltip. More...

void	show_non_modal ()
	Shows the window non modal. More...

void	draw ()
	Draws the window. More...

void	hide ()
	Hides the window. More...

virtual void	layout () override
	Lays out the window. More...

virtual void	render () override
	Ensure the window's internal render buffer is up-to-date. More...

virtual bool	expose (const rect &region) override
	Called by draw_manager when it believes a redraw is necessary. More...

virtual rect	screen_location () override
	The current draw location of the window, on the screen. More...

void	queue_rerender (const rect &region)
	Queue a rerender of the internal render buffer. More...

void	queue_rerender ()

void	defer_region (const rect &region)
	Defer rendering of a particular region to next frame. More...

void	close ()
	Requests to close the window. More...

bool	invalidate_layout_blocked () const
	Is invalidate_layout blocked, see invalidate_layout_blocker. More...

void	invalidate_layout ()
	Updates the size of the window. 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...

dialogs::modal_dialog *	dialog ()
	Inherited from widget. 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	does_click_dismiss () const
	Does the window close easily? More...

void	set_enter_disabled (const bool enter_disabled)
	Disable the enter key. More...

void	set_escape_disabled (const bool escape_disabled)
	Disable the escape key. More...

bool	init_linked_size_group (const std::string &id, const bool fixed_width, const bool fixed_height)
	Initializes a linked size group. More...

bool	has_linked_size_group (const std::string &id)
	Is the linked size group defined for this window? More...

void	add_linked_widget (const std::string &id, widget *widget)
	Adds a widget to a linked size group. More...

void	remove_linked_widget (const std::string &id, const widget *widget)
	Removes a widget from a linked size group. More...

void	set_retval (const int retval, const bool close_window=true)
	Sets there return value of the window. More...

int	get_retval ()

void	set_owner (dialogs::modal_dialog *owner)

void	set_click_dismiss (const bool click_dismiss)

bool	get_need_layout () const

void	set_variable (const std::string &key, const wfl::variant &value)

point	get_linked_size (std::string_view group_id) const

template<typename Func >
void	set_exit_hook (exit_hook mode, const Func &hook)
	Sets the window's exit hook. More...

const event::distributor &	get_distributor () const
	Gets a reference to the window's distributor to allow some state peeking. More...

show_mode	mode () const
	Returns the dialog mode for this window. More...

void	mouse_capture (const bool capture=true)

void	keyboard_capture (widget *widget)

void	add_to_keyboard_chain (widget *widget)
	Adds the widget to the keyboard chain. More...

void	remove_from_keyboard_chain (widget *widget)
	Remove the widget from the keyboard chain. More...

void	add_to_tab_order (widget *widget, int at=-1)
	Add the widget to the tabbing order. More...

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

virtual rect	get_client_rect () const override
	See container_base::get_client_rect. 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...

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

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 rect &rectangle) override
	See widget::set_visible_rectangle. More...

virtual void	impl_draw_children () override
	See widget::impl_draw_children. 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...

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

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

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

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

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

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

template<typename Func >
void	register_hotkey (const hotkey::HOTKEY_COMMAND id, Func &&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)

	enable_lua_ptr (enable_lua_ptr &&o)

enable_lua_ptr &	operator= (enable_lua_ptr &&o)

Public Member Functions inherited from gui2::top_level_drawable
virtual void	update ()
	Update state and any parameters that may effect layout, or any of the later stages. More...

Static Public Member Functions
static window *	window_instance (const unsigned handle)
	Returns the instance of a window. More...

static retval	get_retval_by_id (const std::string &id)
	Gets the retval for the default buttons. More...

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::panel
static const std::string &	type ()
	Static type getter that does not rely on the widget being constructed. More...

Private Member Functions
void	update_render_textures ()
	Ensure render textures are valid and correct. More...

void	layout_linked_widgets ()
	Layouts the linked widgets. More...

bool	click_dismiss (const int mouse_button_mask)
	Handles a mouse click event for dismissing the dialog. More...

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

void	redraw_windows_on_top () const
	Schedules windows on top of us (if any) to redraw. More...

void	finalize (const builder_grid &content_grid)
	Finishes the initialization of the grid. More...

void	generate_dot_file (const std::string &, const unsigned)

void	signal_handler_sdl_video_resize (const event::ui_event event, bool &handled, const point &new_size)

void	signal_handler_click_dismiss (const event::ui_event event, bool &handled, bool &halt, const int mouse_button_mask)
	The handler for the click dismiss mouse 'event'. More...

void	signal_handler_sdl_key_down (const event::ui_event event, bool &handled, const SDL_Keycode key, const SDL_Keymod mod, bool handle_tab)

void	signal_handler_message_show_tooltip (const event::ui_event event, bool &handled, const event::message &message)

void	signal_handler_message_show_helptip (const event::ui_event event, bool &handled, const event::message &message)

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

void	signal_handler_close_window ()

Private Attributes
texture	render_buffer_ = {}
	The internal render buffer used by render() and expose(). More...

rect	awaiting_rerender_
	The part of the window (if any) currently marked for rerender. More...

std::vector< rect >	deferred_regions_
	Parts of the window (if any) with rendering deferred to next frame. More...

status	status_
	The status of the window. More...

show_mode	show_mode_
	The mode in which the window is shown. More...

int	retval_

dialogs::modal_dialog *	owner_
	The dialog that owns the window. More...

bool	need_layout_
	When set the form needs a full layout redraw cycle. More...

wfl::map_formula_callable	variables_
	The variables of the canvas. More...

bool	invalidate_layout_blocked_
	Is invalidate_layout blocked, see invalidate_layout_blocker. More...

bool	hidden_
	Avoid drawing the window. More...

const bool	automatic_placement_
	Do we wish to place the widget automatically? More...

const unsigned	horizontal_placement_
	Sets the horizontal placement. More...

const unsigned	vertical_placement_
	Sets the vertical placement. More...

typed_formula< unsigned >	maximum_width_
	The maximum width if automatic_placement_ is true. More...

typed_formula< unsigned >	maximum_height_
	The maximum height if automatic_placement_ is true. More...

typed_formula< unsigned >	x_
	The formula to calculate the x value of the dialog. More...

typed_formula< unsigned >	y_
	The formula to calculate the y value of the dialog. More...

typed_formula< unsigned >	w_
	The formula to calculate the width of the dialog. More...

typed_formula< unsigned >	h_
	The formula to calculate the height of the dialog. More...

typed_formula< bool >	reevaluate_best_size_
	The formula to determine whether the size is good. More...

wfl::function_symbol_table	functions_
	The formula definitions available for the calculation formulas. More...

builder_window::window_resolution::tooltip_info	tooltip_
	The settings for the tooltip. More...

builder_window::window_resolution::tooltip_info	helptip_
	The settings for the helptip. More...

bool	click_dismiss_
	Do we want to have easy close behavior? More...

bool	enter_disabled_
	Disable the enter key see our setter for more info. More...

bool	escape_disabled_
	Disable the escape key see our setter for more info. More...

std::map< std::string, linked_size, std::less<> >	linked_size_
	List of the widgets, whose size are linked together. More...

std::vector< widget * >	tab_order
	List of widgets in the tabbing order. More...

int	mouse_button_state_
	The state of the mouse button. More...

unsigned int	consecutive_changed_frames_ = 0u
	In how many consecutive frames the window has changed. More...

std::unique_ptr< event::distributor >	event_distributor_

std::function< bool()>	exit_hook_

Friends
class	debug_layout_graph

struct	window_implementation

class	invalidate_layout_blocker

class	pane

Additional Inherited Members
Protected Member Functions inherited from gui2::container_base
virtual point	calculate_best_size () const override
	See widget::calculate_best_size. More...

virtual void	layout_children () override
	See widget::layout_children. 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...

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

std::string	get_label_token (const point &position, std::string_view 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...

Protected Member Functions inherited from gui2::top_level_drawable
	top_level_drawable ()

virtual	~top_level_drawable ()

	top_level_drawable (const top_level_drawable &)

top_level_drawable &	operator= (const top_level_drawable &)

	top_level_drawable (top_level_drawable &&) noexcept

top_level_drawable &	operator= (top_level_drawable &&) noexcept

Detailed Description

base class of top level items, the only item which needs to store the final canvases to draw on.

A window is a kind of panel see the panel for which fields exist.

Definition at line 60 of file window.hpp.

Member Enumeration Documentation

◆ exit_hook

enum gui2::window::exit_hook

strong

Enumerator
always
ok_only

Definition at line 437 of file window.hpp.

◆ show_mode

enum gui2::window::show_mode

strong

Enumerator
none
modal
modeless
tooltip

Definition at line 464 of file window.hpp.

◆ status

enum gui2::window::status

strong

The status of the window.

Enumerator
NEW	The window is new and not yet shown.
SHOWING	The window is being shown.
REQUEST_CLOSE	The window has been requested to be closed but still needs to evaluate the request.
CLOSED	The window has been closed.

Definition at line 205 of file window.hpp.

Constructor & Destructor Documentation

◆ window()

gui2::window::window ( const builder_window::window_resolution & definition )

explicit

< Needs to be initialized in show.

Todo:: : should eventually become part of global hotkey handling.

Definition at line 248 of file window.cpp.

◆ ~window()

gui2::window::~window ( )

virtual

Definition at line 374 of file window.cpp.

References gui2::grid::get_cols(), gui2::container_base::get_grid(), gui2::grid::get_rows(), hidden_, modal, gui2::widget::queue_redraw(), gui2::dialogs::tip::remove(), gui2::grid::remove_child(), and show_mode_.

Member Function Documentation

◆ add_linked_widget()

void gui2::window::add_linked_widget	(	const std::string &	id,
		widget *	widget
	)

Adds a widget to a linked size group.

The group needs to exist, which is done by calling init_linked_size_group. A widget may only be member of one group.

Todo:: Untested if a new widget is added after showing the widgets.

Parameters

id	The id of the group.
widget	The widget to add to the group.

Definition at line 800 of file window.cpp.

References ERR_GUI, utils::find(), has_linked_size_group(), gui2::widget::id(), and linked_size_.

Referenced by gui2::widget::layout_initialize().

◆ add_to_keyboard_chain()

void gui2::window::add_to_keyboard_chain ( widget * widget )

Adds the widget to the keyboard chain.

Todo:: rename to keyboard_add_to_chain.

Parameters

widget The widget to add to the chain. The widget should be valid widget, which hasn't been added to the chain yet.

Definition at line 1210 of file window.cpp.

References event_distributor_.

Referenced by gui2::addon_list::add_list_to_keyboard_chain(), gui2::dialogs::campaign_selection::pre_show(), gui2::dialogs::file_dialog::pre_show(), gui2::dialogs::game_load::pre_show(), gui2::dialogs::help_browser::pre_show(), gui2::dialogs::log_settings::pre_show(), gui2::dialogs::mp_create_game::pre_show(), gui2::dialogs::units_dialog::pre_show(), and gui2::dialogs::wml_message_base::pre_show().

◆ add_to_tab_order()

void gui2::window::add_to_tab_order	(	widget *	widget,
		int	at = `-1`
	)

Add the widget to the tabbing order.

Parameters

widget	The widget to be added to the tabbing order
at	A hint for where to place the widget in the tabbing order

Definition at line 1222 of file window.cpp.

References schema_validation::at(), event_distributor_, utils::find(), keyboard_capture(), and tab_order.

Referenced by gui2::dialogs::addon_auth::pre_show(), gui2::dialogs::custom_tod::pre_show(), gui2::dialogs::editor_edit_label::pre_show(), gui2::dialogs::editor_edit_scenario::pre_show(), gui2::dialogs::editor_edit_side::pre_show(), gui2::dialogs::mp_login::pre_show(), and gui2::dialogs::lobby_player_info::pre_show().

◆ click_dismiss()

bool gui2::window::click_dismiss ( const int mouse_button_mask )

private

Handles a mouse click event for dismissing the dialog.

Parameters

mouse_button_mask The SDL_BUTTON mask for the button used to dismiss the click. If the caller is from the keyboard code the value should be 0.

Returns: Whether the event should be considered as handled.

Definition at line 1078 of file window.cpp.

References does_click_dismiss(), mouse_button_state_, gui2::OK, and set_retval().

Referenced by set_click_dismiss(), signal_handler_click_dismiss(), and signal_handler_sdl_key_down().

◆ close()

void gui2::window::close ( )

inline

Requests to close the window.

This request is not always honored immediately, and so callers must account for the window remaining open. For example, when overriding draw_manager's update() method.

Definition at line 218 of file window.hpp.

References REQUEST_CLOSE, and status_.

Referenced by gui2::dialogs::lobby_player_info::check_status_button_callback(), gui2::dialogs::addon_manager::fetch_addons_list(), gui2::dialogs::synched_choice_wait::handle_generic_event(), intf_dialog_close(), gui2::dialogs::lobby_player_info::kick_ban_button_callback(), gui2::dialogs::lobby_player_info::kick_button_callback(), gui2::dialogs::story_viewer::nav_button_callback(), gui2::dialogs::synched_choice_wait::pre_show(), gui2::dialogs::loading_screen::process(), set_retval(), gui2::dialogs::lobby_player_info::start_whisper_button_callback(), and gui2::dialogs::lobby_player_info::stopgame_button_callback().

◆ defer_region()

void gui2::window::defer_region ( const rect & region )

Defer rendering of a particular region to next frame.

This is used for blur, which must render the region underneath once before rendering the blur.

Parameters

region The region to defer in screen coordinates.

Definition at line 685 of file window.cpp.

References deferred_regions_, and LOG_DP.

Referenced by draw(), and gui2::grid::impl_draw_children().

◆ dialog()

dialogs::modal_dialog* gui2::window::dialog ( )

inline

Inherited from widget.

Definition at line 267 of file window.hpp.

References owner_.

◆ does_click_dismiss()

bool gui2::window::does_click_dismiss ( ) const

inline

Does the window close easily?

The behavior can change at run-time, but that might cause oddities with the easy close button (when one is needed).

Returns: Whether or not the window closes easily.

Definition at line 308 of file window.hpp.

References click_dismiss_, and gui2::container_base::disable_click_dismiss().

Referenced by click_dismiss().

◆ draw()

void gui2::window::draw ( )

Draws the window.

This routine draws the window if needed, it's called from the event handler. This is done by a drawing event. When a window is shown it manages an SDL timer which fires a drawing event every X milliseconds, that event calls this routine. Don't call it manually.

Definition at line 594 of file window.cpp.

References defer_region(), gui2::widget::draw_background(), gui2::widget::draw_children(), gui2::widget::draw_foreground(), gui2::widget::get_rectangle(), and hidden_.

Referenced by render(), and update_render_textures().

◆ expose()

bool gui2::window::expose ( const rect & region )

overridevirtual

Called by draw_manager when it believes a redraw is necessary.

Can be called multiple times per vsync.

Implements gui2::top_level_drawable.

Definition at line 718 of file window.cpp.

References draw::blit(), texture::clear_src(), rect::clip(), DBG_DP, dst, rect::empty(), draw::get_clip(), gui2::widget::get_origin(), gui2::widget::get_rectangle(), rect::intersect(), render_buffer_, texture::set_src(), rect::shift(), and src.

◆ finalize()

void gui2::window::finalize ( const builder_grid & content_grid )

private

Finishes the initialization of the grid.

Parameters

content_grid The new contents for the content grid.

Definition at line 1091 of file window.cpp.

References gui2::builder_grid::build(), c, gui2::widget::find_widget(), gui2::container_base::get_grid(), gui2::widget::id(), and gui2::widget::set_id().

◆ find() [1/2]

const widget * gui2::window::find	(	const std::string_view	id,
		const bool	must_be_active
	)		const

overridevirtual

See widget::find.

Reimplemented from gui2::container_base.

Definition at line 782 of file window.cpp.

References gui2::container_base::find().

◆ find() [2/2]

widget * gui2::window::find	(	const std::string_view	id,
		const bool	must_be_active
	)

overridevirtual

See widget::find.

Reimplemented from gui2::container_base.

Definition at line 777 of file window.cpp.

References gui2::container_base::find().

Referenced by gui2::dialogs::modal_dialog::init_fields(), and gui2::dialogs::lobby_player_info::pre_show().

◆ find_at() [1/2]

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

overridevirtual

See widget::find_at.

Reimplemented from gui2::container_base.

Definition at line 771 of file window.cpp.

References gui2::container_base::find_at().

◆ find_at() [2/2]

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

overridevirtual

See widget::find_at.

Reimplemented from gui2::container_base.

Definition at line 766 of file window.cpp.

References gui2::container_base::find_at().

Referenced by gui2::dialogs::drop_down_menu::mouse_up_callback().

◆ generate_dot_file()

void gui2::window::generate_dot_file	(	const std::string &	,
		const unsigned
	)

inlineprivate

Definition at line 680 of file window.hpp.

Referenced by layout(), show(), show_non_modal(), and show_tooltip().

◆ get_control_type()

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

overrideprivatevirtual

Inherited from styled_widget, implemented by REGISTER_WIDGET.

Reimplemented from gui2::panel.

◆ get_distributor()

const event::distributor& gui2::window::get_distributor ( ) const

inline

Gets a reference to the window's distributor to allow some state peeking.

Definition at line 689 of file window.hpp.

References event_distributor_.

◆ get_linked_size()

point gui2::window::get_linked_size ( std::string_view group_id ) const

inline

Definition at line 428 of file window.hpp.

References linked_size_.

Referenced by gui2::widget::get_best_size().

◆ get_need_layout()

bool gui2::window::get_need_layout ( ) const

inline

Definition at line 417 of file window.hpp.

References need_layout_.

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

◆ get_retval()

int gui2::window::get_retval ( )

inline

Definition at line 402 of file window.hpp.

References retval_.

◆ get_retval_by_id()

retval gui2::window::get_retval_by_id ( const std::string & id )

static

Gets the retval for the default buttons.

Definition at line 413 of file window.cpp.

References gui2::CANCEL, gui2::NONE, and gui2::OK.

Referenced by gui2::implementation::get_retval().

◆ has_linked_size_group()

bool gui2::window::has_linked_size_group ( const std::string & id )

Is the linked size group defined for this window?

Parameters

id	The id of the group.

Returns: True if defined, false otherwise.

Definition at line 795 of file window.cpp.

References linked_size_.

Referenced by add_linked_widget(), and remove_linked_widget().

◆ hide()

void gui2::window::hide ( )

Hides the window.

It will not draw until it is shown again.

Definition at line 621 of file window.cpp.

References gui2::event::dispatcher::disconnect(), hidden_, gui2::widget::id(), gui2::event::dispatcher::is_connected(), LOG_DP, and gui2::widget::queue_redraw().

Referenced by show().

◆ init_linked_size_group()

bool gui2::window::init_linked_size_group	(	const std::string &	id,
		const bool	fixed_width,
		const bool	fixed_height
	)

Initializes a linked size group.

Note at least one of fixed_width or fixed_height must be true.

Parameters

id	The id of the group.
fixed_width	Does the group have a fixed width?
fixed_height	Does the group have a fixed height?

Returns: True if successful, false otherwise.

Definition at line 788 of file window.cpp.

References linked_size_.

Referenced by gui2::container_base::inject_linked_groups().

◆ invalidate_layout()

void gui2::window::invalidate_layout ( )

Updates the size of the window.

If the window has automatic placement set this function recalculates the window. To be used after creation and after modification or items which can have different sizes eg listboxes.

Definition at line 760 of file window.cpp.

References invalidate_layout_blocked_, and need_layout_.

Referenced by gui2::scrollbar_container::content_resize_height(), gui2::scrollbar_container::content_resize_width(), gui2::dialogs::editor_edit_unit::load_unit_type(), gui2::dialogs::help_browser::pre_show(), gui2::scrollbar_base::recalculate(), gui2::dialogs::units_dialog::rename_unit(), gui2::listbox::set_row_shown(), gui2::widget::set_visible(), show(), show_non_modal(), show_tooltip(), gui2::dialogs::help_browser::show_topic(), signal_handler_request_placement(), signal_handler_sdl_video_resize(), gui2::dialogs::units_dialog::toggle_favorite(), gui2::dialogs::custom_tod::update_image(), gui2::dialogs::editor_edit_unit::update_image(), gui2::multiline_text::update_layout(), gui2::dialogs::custom_tod::update_tod_display(), and WIDGET_SETTER().

◆ invalidate_layout_blocked()

bool gui2::window::invalidate_layout_blocked ( ) const

inline

Is invalidate_layout blocked, see invalidate_layout_blocker.

Definition at line 244 of file window.hpp.

References invalidate_layout_blocked_.

◆ keyboard_capture()

void gui2::window::keyboard_capture ( widget * widget )

Definition at line 1201 of file window.cpp.

References event_distributor_.

◆ layout()

void gui2::window::layout ( )

overridevirtual

Lays out the window.

This part does the pre and post processing for the actual layout algorithm.

See Layout algorithm for more information.

This is also called by draw_manager to finalize screen layout.

Todo:: implement the scrollbars on the window.

Todo:: implement the scrollbars on the window.

Reimplemented from gui2::top_level_drawable.

Reimplemented in gui2::dialogs::loading_screen.

Definition at line 832 of file window.cpp.

References _(), wfl::map_formula_callable::add(), automatic_placement_, click_dismiss_, gui2::event::connect_signal_mouse_left_click(), DBG_DP, gui2::container_base::disable_click_dismiss(), functions_, generate_dot_file(), gui2::widget::get_best_size(), gui2::get_mouse_position(), gui2::get_screen_size_variables(), h_, gui2::grid::HORIZONTAL_ALIGN_CENTER, gui2::grid::HORIZONTAL_ALIGN_LEFT, gui2::grid::HORIZONTAL_ALIGN_RIGHT, horizontal_placement_, gui2::event::init_mouse_location(), gui2::widget::invisible, gui2::window_implementation::layout(), gui2::container_base::layout_initialize(), layout_linked_widgets(), gui2::log_gui_layout, log_scope2, LOG_SCOPE_HEADER, maximum_height_, maximum_width_, need_layout_, gui2::OK, gui2::container_base::place(), reevaluate_best_size_, gui2::settings::screen_height, gui2::settings::screen_width, set_retval(), gui2::widget::set_visible(), utf8::size(), VALIDATE, variables_, gui2::grid::VERTICAL_ALIGN_BOTTOM, gui2::grid::VERTICAL_ALIGN_CENTER, gui2::grid::VERTICAL_ALIGN_TOP, vertical_placement_, gui2::widget::visible, w_, x_, and y_.

Referenced by gui2::dialogs::loading_screen::layout(), and gui2::window_implementation::layout().

◆ layout_linked_widgets()

void gui2::window::layout_linked_widgets ( )

private

Layouts the linked widgets.

See Layout algorithm for more information.

Definition at line 1032 of file window.cpp.

References gui2::widget::get_best_size(), gui2::window::linked_size::height, linked_size_, gui2::widget::set_layout_size(), utf8::size(), gui2::window::linked_size::widgets, and gui2::window::linked_size::width.

Referenced by layout(), gui2::window_implementation::layout(), and gui2::pane::signal_handler_request_placement().

◆ mode()

show_mode gui2::window::mode ( ) const

inline

Returns the dialog mode for this window.

Definition at line 695 of file window.hpp.

References show_mode_.

Referenced by gui2::dialogs::mp_lobby::enter_game(), gui2::dialogs::mp_lobby::enter_game_by_id(), gui2::dialogs::mp_lobby::enter_selected_game(), and set_exit_hook().

◆ mouse_capture()

void gui2::window::mouse_capture ( const bool capture = true )

Definition at line 1195 of file window.cpp.

References event_distributor_.

◆ queue_rerender() [1/2]

void gui2::window::queue_rerender ( )

Definition at line 671 of file window.cpp.

References gui2::widget::get_rectangle().

Referenced by update_render_textures().

◆ queue_rerender() [2/2]

void gui2::window::queue_rerender ( const rect & region )

Queue a rerender of the internal render buffer.

This does not request a repaint. Ordinarily use queue_redraw() on a widget, which will call this automatically.

Parameters

region The region to rerender in screen coordinates.

Definition at line 676 of file window.cpp.

References awaiting_rerender_, rect::expand_to_cover(), gui2::widget::get_origin(), gui2::widget::get_rectangle(), rect::intersect(), and rect::shift().

Referenced by gui2::widget::queue_redraw().

◆ redraw_windows_on_top()

void gui2::window::redraw_windows_on_top ( ) const

private

Schedules windows on top of us (if any) to redraw.

◆ remove_from_keyboard_chain()

void gui2::window::remove_from_keyboard_chain ( widget * widget )

Remove the widget from the keyboard chain.

Todo:: rename to keyboard_remove_from_chain.

Parameters

widget The widget to be removed from the chain.

Definition at line 1216 of file window.cpp.

References event_distributor_.

◆ remove_linked_widget()

void gui2::window::remove_linked_widget	(	const std::string &	id,
		const widget *	widget
	)

Removes a widget from a linked size group.

The group needs to exist, which is done by calling init_linked_size_group. If the widget is no member of the group the function does nothing.

Parameters

id	The id of the group.
widget	The widget to remove from the group.

Definition at line 814 of file window.cpp.

References utils::find(), has_linked_size_group(), gui2::widget::id(), and linked_size_.

Referenced by gui2::widget::~widget().

◆ render()

void gui2::window::render ( )

overridevirtual

Ensure the window's internal render buffer is up-to-date.

This renders the window to an off-screen texture, which is then copied to the screen during expose().

Reimplemented from gui2::top_level_drawable.

Definition at line 691 of file window.cpp.

References awaiting_rerender_, draw::clear(), DBG_DP, deferred_regions_, draw(), rect::empty(), draw::override_clip(), gui2::widget::queue_redraw(), render_buffer_, draw::set_render_target(), and update_render_textures().

Referenced by update_render_textures().

◆ screen_location()

rect gui2::window::screen_location ( )

overridevirtual

The current draw location of the window, on the screen.

Implements gui2::top_level_drawable.

Definition at line 739 of file window.cpp.

References gui2::widget::get_rectangle(), and hidden_.

◆ set_click_dismiss()

void gui2::window::set_click_dismiss ( const bool click_dismiss )

inline

Definition at line 412 of file window.hpp.

References click_dismiss(), and click_dismiss_.

Referenced by gui2::dialogs::lua_interpreter::controller::bind(), gui2::dialogs::title_screen::init_callbacks(), gui2::dialogs::message::pre_show(), and gui2::dialogs::wml_message_base::pre_show().

◆ set_enter_disabled()

void gui2::window::set_enter_disabled ( const bool enter_disabled )

inline

Disable the enter key.

This is added to block dialogs from being closed automatically.

Todo:: this function should be merged with the hotkey support once that has been added.

Definition at line 321 of file window.hpp.

References enter_disabled_.

Referenced by gui2::dialogs::lua_interpreter::controller::bind(), gui2::dialogs::game_load::display_savegame(), gui2::dialogs::title_screen::init_callbacks(), gui2::dialogs::addon_manager::pre_show(), gui2::dialogs::loading_screen::pre_show(), gui2::dialogs::mp_lobby::pre_show(), gui2::dialogs::mp_join_game::pre_show(), gui2::dialogs::mp_staging::pre_show(), gui2::dialogs::screenshot_notification::pre_show(), and gui2::dialogs::story_viewer::pre_show().

◆ set_escape_disabled()

void gui2::window::set_escape_disabled ( const bool escape_disabled )

inline

Disable the escape key.

This is added to block dialogs from being closed automatically.

Todo:: this function should be merged with the hotkey support once that has been added.

Definition at line 334 of file window.hpp.

References escape_disabled_.

Referenced by gui2::dialogs::title_screen::init_callbacks(), gui2::dialogs::addon_manager::pre_show(), gui2::dialogs::loading_screen::pre_show(), gui2::dialogs::mp_join_game::pre_show(), gui2::dialogs::mp_staging::pre_show(), gui2::dialogs::unit_advance::pre_show(), and gui2::dialogs::wml_message_base::pre_show().

◆ set_exit_hook()

template<typename Func >

void gui2::window::set_exit_hook	(	exit_hook	mode,
		const Func &	hook
	)

inline

Sets the window's exit hook.

A window will only close if the given function returns true under the specified mode.

Definition at line 448 of file window.hpp.

References always, exit_hook_, get_retval(), mode(), gui2::OK, and ok_only.

Referenced by gui2::dialogs::addon_manager::pre_show(), gui2::dialogs::file_dialog::pre_show(), gui2::dialogs::mp_lobby::pre_show(), gui2::dialogs::mp_create_game::pre_show(), and gui2::dialogs::mp_report::pre_show().

◆ set_owner()

void gui2::window::set_owner ( dialogs::modal_dialog * owner )

inline

Definition at line 407 of file window.hpp.

References owner_.

◆ set_retval()

void gui2::window::set_retval	(	const int	retval,
		const bool	close_window = `true`
	)

inline

Sets there return value of the window.

Parameters

retval	The return value for the window.
close_window	Close the window after setting the value.

Definition at line 395 of file window.hpp.

References close(), and retval_.

◆ set_variable()

void gui2::window::set_variable	(	const std::string &	key,
		const wfl::variant &	value
	)

inline

Definition at line 422 of file window.hpp.

References wfl::map_formula_callable::add(), gui2::widget::queue_redraw(), and variables_.

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

◆ show()

int gui2::window::show ( unsigned auto_close_timeout = 0 )

Shows the window, running an event loop until it should close.

Parameters

auto_close_timeout The time in ms after which the window will automatically close, if 0 it doesn't close.

Note: the timeout is a minimum time and there's no guarantee about how fast it closes after the minimum.

Returns: The close code of the window, predefined values are listed in retval.

Definition at line 492 of file window.cpp.

References CLOSE_WINDOW_EVENT, CLOSED, gui2::event::dispatcher::connect(), data, DBG_DP, events::draw(), event_distributor_, exit_hook_, generate_dot_file(), sdl::get_mouse_button_mask(), utils::get_unknown_exception_type(), hidden_, hide(), gui2::widget::id(), invalidate_layout(), gui2::event::dispatcher::is_connected(), LOG_DP, gui2::log_gui_draw, log_scope2, LOG_SCOPE_HEADER, modal, mouse_button_state_, events::pump(), gui2::widget::queue_redraw(), gui2::dialogs::tip::remove(), REQUEST_CLOSE, retval_, show_mode_, SHOWING, and status_.

Referenced by gui2::dialogs::modal_dialog::show().

◆ show_non_modal()

void gui2::window::show_non_modal ( )

Shows the window non modal.

A tooltip can be interacted with unlike the tooltip.

Todo:: implement auto_close_timeout.

auto_close_timeout The time in ms after which the window will automatically close, if 0 it doesn't close.

Note: the timeout is a minimum time and there's no guarantee about how fast it closes after the minimum.

Definition at line 458 of file window.cpp.

References gui2::event::dispatcher::connect(), DBG_DP, generate_dot_file(), gui2::widget::get_rectangle(), hidden_, gui2::event::dispatcher::hit, gui2::widget::id(), invalidate_layout(), gui2::event::dispatcher::is_connected(), LOG_DP, gui2::log_gui_draw, log_scope2, modeless, NEW, events::pump_and_draw(), gui2::widget::queue_redraw(), gui2::event::dispatcher::set_mouse_behavior(), show_mode_, and status_.

Referenced by gui2::dialogs::modeless_dialog::show().

◆ show_tooltip()

void gui2::window::show_tooltip ( )

Shows the window as a tooltip.

A tooltip can't be interacted with and is just shown.

Todo:: implement auto_close_timeout.

auto_close_timeout The time in ms after which the window will automatically close, if 0 it doesn't close.

Note: the timeout is a minimum time and there's no guarantee about how fast it closes after the minimum.

Definition at line 426 of file window.cpp.

References gui2::event::dispatcher::connect(), DBG_DP, generate_dot_file(), gui2::widget::get_rectangle(), hidden_, gui2::widget::id(), invalidate_layout(), gui2::event::dispatcher::is_connected(), LOG_DP, gui2::log_gui_draw, log_scope2, NEW, gui2::event::dispatcher::none, gui2::widget::queue_redraw(), gui2::event::dispatcher::set_mouse_behavior(), gui2::event::dispatcher::set_want_keyboard_input(), show_mode_, status_, and tooltip.

Referenced by gui2::dialogs::modeless_dialog::show().

◆ signal_handler_click_dismiss()

void gui2::window::signal_handler_click_dismiss	(	const event::ui_event	event,
		bool &	handled,
		bool &	halt,
		const int	mouse_button_mask
	)

private

The handler for the click dismiss mouse 'event'.

Parameters

event	See event::dispatcher::fire.
handled	See event::dispatcher::fire.
halt	See event::dispatcher::fire.
mouse_button_mask	Forwared to click_dismiss.

Definition at line 1253 of file window.cpp.

References click_dismiss(), DBG_GUI_E, and LOG_HEADER.

◆ signal_handler_close_window()

void gui2::window::signal_handler_close_window ( )

private

Definition at line 1376 of file window.cpp.

References gui2::AUTO_CLOSE, and set_retval().

◆ signal_handler_message_show_helptip()

void gui2::window::signal_handler_message_show_helptip	(	const event::ui_event	event,
		bool &	handled,
		const event::message &	message
	)

private

Definition at line 1352 of file window.cpp.

References DBG_GUI_E, helptip_, gui2::builder_window::window_resolution::tooltip_info::id, gui2::event::message_show_helptip::location, LOG_HEADER, gui2::event::message_show_helptip::message, gui2::dialogs::tip::show(), and gui2::event::message_show_helptip::source_rect.

◆ signal_handler_message_show_tooltip()

void gui2::window::signal_handler_message_show_tooltip	(	const event::ui_event	event,
		bool &	handled,
		const event::message &	message
	)

private

Definition at line 1338 of file window.cpp.

References DBG_GUI_E, gui2::builder_window::window_resolution::tooltip_info::id, gui2::event::message_show_tooltip::location, LOG_HEADER, gui2::event::message_show_tooltip::message, gui2::dialogs::tip::show(), gui2::event::message_show_tooltip::source_rect, and tooltip_.

◆ signal_handler_request_placement()

void gui2::window::signal_handler_request_placement	(	const event::ui_event	event,
		bool &	handled
	)

private

Definition at line 1366 of file window.cpp.

References DBG_GUI_E, invalidate_layout(), and LOG_HEADER.

◆ signal_handler_sdl_key_down()

void gui2::window::signal_handler_sdl_key_down	(	const event::ui_event	event,
		bool &	handled,
		const SDL_Keycode	key,
		const SDL_Keymod	mod,
		bool	handle_tab
	)

private

Definition at line 1272 of file window.cpp.

References gui2::CANCEL, click_dismiss(), DBG_GUI_E, enter_disabled_, escape_disabled_, event_distributor_, utils::find(), gui2::is_active(), keyboard_capture(), LOG_HEADER, gui2::OK, set_retval(), and tab_order.

◆ signal_handler_sdl_video_resize()

void gui2::window::signal_handler_sdl_video_resize	(	const event::ui_event	event,
		bool &	handled,
		const point &	new_size
	)

private

Definition at line 1238 of file window.cpp.

References DBG_GUI_E, gui2::settings::gamemap_height, gui2::settings::gamemap_width, invalidate_layout(), LOG_HEADER, gui2::settings::screen_height, and gui2::settings::screen_width.

◆ type()

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

static

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

Referenced by gui2::dialogs::statistics_dialog::add_damage_row(), gui2::dialogs::statistics_dialog::add_hits_row(), gui2::dialogs::statistics_dialog::add_stat_row(), gui2::dialogs::units_dialog::build_create_dialog(), gui2::dialogs::custom_tod::color_slider_callback(), gui2::dialogs::custom_tod::copy_to_clipboard_callback(), gui2::dialogs::mp_create_game::display_games_of_type(), gui2::dialogs::mp_join_game::generate_side_list(), gui2::dialogs::editor_edit_unit::load_unit_type(), gui2::dialogs::statistics_dialog::on_primary_list_select(), gui2::dialogs::mp_create_game::post_show(), gui2::dialogs::custom_tod::select_file(), gui2::dialogs::editor_edit_unit::select_file(), and gui2::dialogs::mp_staging::update_leader_display().

◆ update_render_textures()

void gui2::window::update_render_textures ( )

private

Ensure render textures are valid and correct.

Definition at line 637 of file window.cpp.

References draw::clear(), draw(), texture::draw_size(), video::get_pixel_scale(), texture::get_raw_size(), gui2::widget::get_size(), LOG_DP, queue_rerender(), render(), render_buffer_, texture::set_draw_size(), draw::set_render_target(), and setter.

Referenced by render().

◆ window_instance()

window * gui2::window::window_instance ( const unsigned handle )

static

Returns the instance of a window.

Parameters

handle The instance id of the window.

Returns: The window or nullptr.

Definition at line 408 of file window.cpp.

References gui2::widget::get_window().

Referenced by gui2::event::sdl_event_handler::close_window().

Friends And Related Function Documentation

◆ debug_layout_graph

friend class debug_layout_graph

friend

Definition at line 62 of file window.hpp.

◆ invalidate_layout_blocker

friend class invalidate_layout_blocker

friend

Definition at line 64 of file window.hpp.

◆ pane

friend class pane

friend

Definition at line 65 of file window.hpp.

◆ window_implementation

friend struct window_implementation

friend

Definition at line 63 of file window.hpp.

Member Data Documentation

◆ automatic_placement_

const bool gui2::window::automatic_placement_

private

Do we wish to place the widget automatically?

Definition at line 506 of file window.hpp.

Referenced by layout().

◆ awaiting_rerender_

rect gui2::window::awaiting_rerender_

private

The part of the window (if any) currently marked for rerender.

Definition at line 165 of file window.hpp.

Referenced by queue_rerender(), and render().

◆ click_dismiss_

bool gui2::window::click_dismiss_

private

Do we want to have easy close behavior?

Easy closing means that whenever a mouse click is done the dialog will be closed. The widgets in the window may override this behavior by registering themselves as blockers. This is tested by the function disable_click_dismiss().

The handling of easy close is done in the window, in order to do so a window either needs a click_dismiss or an ok button. Both will be hidden when not needed and when needed first the ok is tried and then the click_dismiss button. this allows adding a click_dismiss button to the window definition and use the ok from the window instance.

Todo:: After testing the click dismiss feature it should be documented in the wiki.

Definition at line 571 of file window.hpp.

Referenced by does_click_dismiss(), layout(), and set_click_dismiss().

◆ consecutive_changed_frames_

unsigned int gui2::window::consecutive_changed_frames_ = 0u

private

In how many consecutive frames the window has changed.

This is used to detect the situation where the title screen changes in every frame, forcing all other windows to redraw everything all the time.

Definition at line 659 of file window.hpp.

◆ deferred_regions_

std::vector<rect> gui2::window::deferred_regions_

private

Parts of the window (if any) with rendering deferred to next frame.

Definition at line 168 of file window.hpp.

Referenced by defer_region(), and render().

◆ enter_disabled_

bool gui2::window::enter_disabled_

private

Disable the enter key see our setter for more info.

Definition at line 574 of file window.hpp.

Referenced by set_enter_disabled(), and signal_handler_sdl_key_down().

◆ escape_disabled_

bool gui2::window::escape_disabled_

private

Disable the escape key see our setter for more info.

Definition at line 577 of file window.hpp.

Referenced by set_escape_disabled(), and signal_handler_sdl_key_down().

◆ event_distributor_

std::unique_ptr<event::distributor> gui2::window::event_distributor_

private

Definition at line 685 of file window.hpp.

Referenced by add_to_keyboard_chain(), add_to_tab_order(), get_distributor(), keyboard_capture(), mouse_capture(), remove_from_keyboard_chain(), show(), and signal_handler_sdl_key_down().

◆ exit_hook_

std::function<bool()> gui2::window::exit_hook_

private

Definition at line 770 of file window.hpp.

Referenced by set_exit_hook(), and show().

◆ functions_

wfl::function_symbol_table gui2::window::functions_

private

The formula definitions available for the calculation formulas.

Definition at line 546 of file window.hpp.

Referenced by layout().

◆ h_

typed_formula<unsigned> gui2::window::h_

private

The formula to calculate the height of the dialog.

Definition at line 540 of file window.hpp.

Referenced by layout().

◆ helptip_

builder_window::window_resolution::tooltip_info gui2::window::helptip_

private

The settings for the helptip.

Definition at line 552 of file window.hpp.

Referenced by signal_handler_message_show_helptip().

◆ hidden_

bool gui2::window::hidden_

private

Avoid drawing the window.

Definition at line 503 of file window.hpp.

Referenced by draw(), hide(), screen_location(), show(), show_non_modal(), show_tooltip(), and ~window().

◆ horizontal_placement_

const unsigned gui2::window::horizontal_placement_

private

Sets the horizontal placement.

Only used if automatic_placement_ is true. The value should be a grid placement flag.

Definition at line 514 of file window.hpp.

Referenced by layout().

◆ invalidate_layout_blocked_

bool gui2::window::invalidate_layout_blocked_

private

Is invalidate_layout blocked, see invalidate_layout_blocker.

Definition at line 500 of file window.hpp.

Referenced by invalidate_layout(), invalidate_layout_blocked(), and gui2::window::invalidate_layout_blocker::invalidate_layout_blocker().

◆ linked_size_

std::map<std::string, linked_size, std::less<> > gui2::window::linked_size_

private

List of the widgets, whose size are linked together.

Definition at line 604 of file window.hpp.

Referenced by add_linked_widget(), get_linked_size(), has_linked_size_group(), init_linked_size_group(), layout_linked_widgets(), and remove_linked_widget().

◆ maximum_height_

typed_formula<unsigned> gui2::window::maximum_height_

private

The maximum height if automatic_placement_ is true.

Definition at line 528 of file window.hpp.

Referenced by layout().

◆ maximum_width_

typed_formula<unsigned> gui2::window::maximum_width_

private

The maximum width if automatic_placement_ is true.

Definition at line 525 of file window.hpp.

Referenced by layout().

◆ mouse_button_state_

int gui2::window::mouse_button_state_

private

The state of the mouse button.

When click dismissing a dialog in the past the DOWN event was used. This lead to a bug [1]. The obvious change was to switch to the UP event, this lead to another bug; the dialog was directly dismissed. Since the game map code uses the UP and DOWN event to select a unit there is no simple solution.

Upon entry this value stores the mouse button state at entry. When a button is DOWN and goes UP that button does not trigger a dismissal of the dialog, instead that button's down state is removed from this variable. Therefore the next UP event does dismiss the dialog.

[1] https://gna.org/bugs/index.php?18970

Definition at line 644 of file window.hpp.

Referenced by click_dismiss(), and show().

◆ need_layout_

bool gui2::window::need_layout_

private

When set the form needs a full layout redraw cycle.

This happens when either a widget changes it's size or visibility or the window is resized.

Definition at line 494 of file window.hpp.

Referenced by get_need_layout(), invalidate_layout(), and layout().

◆ owner_

dialogs::modal_dialog* gui2::window::owner_

private

The dialog that owns the window.

Definition at line 486 of file window.hpp.

Referenced by dialog(), gui2::dialogs::mp_connect::selection::parent_list(), gui2::dialogs::mp_connect::selection::relative_index(), set_owner(), and gui2::dialogs::mp_connect::selection::user_defined().

◆ reevaluate_best_size_

typed_formula<bool> gui2::window::reevaluate_best_size_

private

The formula to determine whether the size is good.

Definition at line 543 of file window.hpp.

Referenced by layout().

◆ render_buffer_

texture gui2::window::render_buffer_ = {}

private

The internal render buffer used by render() and expose().

Definition at line 162 of file window.hpp.

Referenced by expose(), render(), and update_render_textures().

◆ retval_

int gui2::window::retval_

private

Definition at line 483 of file window.hpp.

Referenced by get_retval(), set_retval(), and show().

◆ show_mode_

show_mode gui2::window::show_mode_

private

The mode in which the window is shown.

This is used to determine whether or not to remove the tip.

Definition at line 480 of file window.hpp.

Referenced by mode(), show(), show_non_modal(), show_tooltip(), and ~window().

◆ status_

status gui2::window::status_

private

The status of the window.

Definition at line 473 of file window.hpp.

Referenced by close(), show(), show_non_modal(), and show_tooltip().

◆ tab_order

std::vector<widget*> gui2::window::tab_order

private

List of widgets in the tabbing order.

Definition at line 607 of file window.hpp.

Referenced by add_to_tab_order(), and signal_handler_sdl_key_down().

◆ tooltip_

builder_window::window_resolution::tooltip_info gui2::window::tooltip_

private

The settings for the tooltip.

Definition at line 549 of file window.hpp.

Referenced by signal_handler_message_show_tooltip().

◆ variables_

wfl::map_formula_callable gui2::window::variables_

private

The variables of the canvas.

Definition at line 497 of file window.hpp.

Referenced by layout(), and set_variable().

◆ vertical_placement_

const unsigned gui2::window::vertical_placement_

private

Sets the vertical placement.

Only used if automatic_placement_ is true. The value should be a grid placement flag.

Definition at line 522 of file window.hpp.

Referenced by layout().

◆ w_

typed_formula<unsigned> gui2::window::w_

private

The formula to calculate the width of the dialog.

Definition at line 537 of file window.hpp.

Referenced by layout().

◆ x_

typed_formula<unsigned> gui2::window::x_

private

The formula to calculate the x value of the dialog.

Definition at line 531 of file window.hpp.

Referenced by layout().

◆ y_

typed_formula<unsigned> gui2::window::y_

private

The formula to calculate the y value of the dialog.

Definition at line 534 of file window.hpp.

Referenced by layout().

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

gui/widgets/window.hpp
gui/widgets/window.cpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ exit_hook

◆ show_mode

◆ status

Constructor & Destructor Documentation

◆ window()

◆ ~window()

Member Function Documentation

◆ add_linked_widget()

◆ add_to_keyboard_chain()

◆ add_to_tab_order()

◆ click_dismiss()

◆ close()

◆ defer_region()

◆ dialog()

◆ does_click_dismiss()

◆ draw()

◆ expose()

◆ finalize()

◆ find() [1/2]

◆ find() [2/2]

◆ find_at() [1/2]

◆ find_at() [2/2]

◆ generate_dot_file()

◆ get_control_type()

◆ get_distributor()

◆ get_linked_size()

◆ get_need_layout()

◆ get_retval()

◆ get_retval_by_id()

◆ has_linked_size_group()

◆ hide()

◆ init_linked_size_group()

◆ invalidate_layout()

◆ invalidate_layout_blocked()

◆ keyboard_capture()

◆ layout()

◆ layout_linked_widgets()

◆ mode()

◆ mouse_capture()

◆ queue_rerender() [1/2]

◆ queue_rerender() [2/2]

◆ redraw_windows_on_top()

◆ remove_from_keyboard_chain()

◆ remove_linked_widget()

◆ render()

◆ screen_location()

◆ set_click_dismiss()

◆ set_enter_disabled()

◆ set_escape_disabled()

◆ set_exit_hook()

◆ set_owner()

◆ set_retval()

◆ set_variable()

◆ show()

◆ show_non_modal()

◆ show_tooltip()

◆ signal_handler_click_dismiss()

◆ signal_handler_close_window()

◆ signal_handler_message_show_helptip()

◆ signal_handler_message_show_tooltip()

◆ signal_handler_request_placement()

◆ signal_handler_sdl_key_down()

◆ signal_handler_sdl_video_resize()

◆ type()

◆ update_render_textures()

◆ window_instance()

Friends And Related Function Documentation

◆ debug_layout_graph

◆ invalidate_layout_blocker

◆ pane