#include <units_dialog.hpp>

Inheritance diagram for gui2::dialogs::units_dialog:

Public Types
enum class	sort_type { generator , none }
	Controls the sort behavior for functions returned by make_column_builder. More...

using	recruit_msgs_map = std::map< const unit_type *, t_string >

Public Types inherited from gui2::window
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
	units_dialog ()

int	get_selected_index () const

bool	is_selected () const

unit_race::GENDER	gender () const
	Gender choice from the user. More...

std::string	variation () const
	Variation choice from the user. More...

void	clear_variation ()

units_dialog &	set_title (const std::string &title)

units_dialog &	set_ok_label (const std::string &ok_label)

units_dialog &	set_cancel_label (const std::string &cancel_label)

units_dialog &	set_show_rename (bool show=true)

units_dialog &	set_show_dismiss (bool show=true)

units_dialog &	set_show_variations (bool show=true)

units_dialog &	set_help_topic (const std::string &topic_id)

units_dialog &	set_row_num (const std::size_t row_num)

units_dialog &	set_sort_by (std::pair< std::string, sort_order::type > sort_order)

template<typename Func >
void	on_modified (const Func &f)
	Registers an function which will fired on NOTIFY_MODIFIED dialog events. More...

template<typename Sorter >
void	set_sorter (std::string_view id, const Sorter &sorter)

template<typename Value >
auto	make_column_builder (const std::vector< Value > &list)
	Creates a generator function which registers secondary generator and sorter functions for the list column associated with the given ID. More...

template<typename Generator >
units_dialog &	set_tooltip_generator (const Generator &generator)
	Sets the generator function for the tooltips. More...

template<typename Generator >
units_dialog &	set_filter_generator (const Generator &generator)
	Sets the generator function for filter text. More...

Public Member Functions inherited from gui2::dialogs::modal_dialog
	modal_dialog (const std::string &window_id)

virtual	~modal_dialog ()

bool	show (const unsigned auto_close_time=0)
	Shows the window. More...

void	set_always_save_fields (const bool always_save_fields)

void	set_allow_plugin_skip (const bool allow_plugin_skip)

void	set_show_even_without_video (const bool show_even_without_video)

Public Member Functions inherited from gui2::window
	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 SDL_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 SDL_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...

void	set_text_maximum_width (int max_width)
	Set how wide the text can become. More...

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

widget &	operator= (const widget &)=delete

	widget ()

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

virtual	~widget () override

void	set_id (const std::string &id)

const std::string &	id () const

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

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

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

const grid *	get_parent_grid () const

void	set_parent (widget *parent)

widget *	parent ()

point	get_best_size () const
	Gets the best size for the widget. More...

virtual bool	can_mouse_focus () const
	Whether the mouse move/click event go 'through' this widget. More...

virtual void	set_size (const point &size)
	Sets the size of the widget. More...

virtual void	move (const int x_offset, const int y_offset)
	Moves a widget. More...

virtual void	set_horizontal_alignment (const std::string &alignment)
	Sets the horizontal alignment of the widget within its parent grid. More...

virtual void	set_vertical_alignment (const std::string &alignment)
	Sets the horizontal alignment of the widget within its parent grid. More...

point	get_origin () const
	Returns the screen origin of the widget. More...

point	get_size () const
	Returns the size of the widget. More...

rect	get_rectangle () const
	Gets the bounding rectangle of the widget on the screen. More...

int	get_x () const

int	get_y () const

unsigned	get_width () const

unsigned	get_height () const

void	set_linked_group (const std::string &linked_group)

std::string	get_linked_group () const

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

SDL_Rect	calculate_clipping_rectangle () const
	Calculates the clipping rectangle of the widget. More...

bool	draw_background ()
	Draws the background of a widget. More...

void	draw_children ()
	Draws the children of a widget. More...

bool	draw_foreground ()
	Draws the foreground of the widget. More...

SDL_Rect	get_dirty_rectangle () const
	Gets the dirty rectangle of the widget. More...

void	queue_redraw ()
	Indicates that this widget should be redrawn. More...

void	queue_redraw (const rect &region)
	Indicate that specific region of the screen should be redrawn. More...

void	set_visible (const visibility visible)

visibility	get_visible () const

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

redraw_action	get_drawing_action () const

void	set_debug_border_mode (const debug_border debug_border_mode)

void	set_debug_border_color (const color_t debug_border_color)

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

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

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

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

Public Member Functions inherited from gui2::event_executor
	event_executor ()

virtual	~event_executor ()

void	set_wants_mouse_hover (const bool hover=true)

bool	wants_mouse_hover () const

void	set_wants_mouse_left_double_click (const bool click=true)

bool	wants_mouse_left_double_click () const

void	set_wants_mouse_middle_double_click (const bool click=true)

bool	wants_mouse_middle_double_click () const

event_executor &	set_wants_mouse_right_double_click (const bool click=true)

bool	wants_mouse_right_double_click () const

Public Member Functions inherited from gui2::event::dispatcher
	dispatcher ()

virtual	~dispatcher ()

void	connect ()
	Connects the dispatcher to the event handler. More...

void	disconnect ()
	Disconnects the dispatcher from the event handler. More...

bool	is_connected () const
	Return whether the dispatcher is currently connected. More...

bool	has_event (const ui_event event, const event_queue_type event_type)

bool	fire (const ui_event event, widget &target)
	Fires an event which has no extra parameters. More...

bool	fire (const ui_event event, widget &target, const point &coordinate)
	Fires an event which takes a coordinate parameter. More...

bool	fire (const ui_event event, widget &target, const SDL_Keycode key, const SDL_Keymod modifier, const std::string &unicode)
	Fires an event which takes keyboard parameters. More...

bool	fire (const ui_event event, widget &target, const point &pos, const point &distance)
	Fires an event which takes touch-motion parameters. More...

bool	fire (const ui_event event, widget &target, const point &center, float dTheta, float dDist, uint8_t numFingers)
	Fires an event which takes touch-gesture parameters. More...

bool	fire (const ui_event event, widget &target, void *)
	Fires an event which takes notification parameters. More...

bool	fire (const ui_event event, widget &target, const message &msg)
	Fires an event which takes message parameters. More...

bool	fire (const ui_event event, widget &target, const SDL_Event &sdlevent)
	Fires an event that's a raw SDL event. More...

bool	fire (const ui_event event, widget &target, const std::string &text, int32_t start, int32_t len)
	Fires an event which takes text input parameters. More...

template<ui_event E, typename F >
void	connect_signal (const F &func, const queue_position position=back_child)
	Adds a callback to the appropriate queue based on event type. More...

template<ui_event E, typename F >
void	disconnect_signal (const F &func, const queue_position position=back_child)
	Removes a callback from the appropriate queue based on event type. More...

void	capture_mouse ()
	Captures the mouse. More...

void	release_mouse ()
	Releases the mouse capture. More...

void	set_mouse_behavior (const mouse_behavior mouse_behavior)

mouse_behavior	get_mouse_behavior () const

void	set_want_keyboard_input (const bool want_keyboard_input)

bool	get_want_keyboard_input () const

void	register_hotkey (const hotkey::HOTKEY_COMMAND id, const hotkey_function &function)
	Registers a hotkey. More...

bool	execute_hotkey (const hotkey::HOTKEY_COMMAND id)
	Executes a hotkey. More...

Public Member Functions inherited from enable_lua_ptr< widget >
	enable_lua_ptr (widget *tp)

	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
template<typename Value , typename Func >
static auto	make_index_wrapper (const std::vector< Value > &list, const Func &func)

static std::unique_ptr< units_dialog >	build_create_dialog (const std::vector< const unit_type * > &types_list)

static std::unique_ptr< units_dialog >	build_recruit_dialog (const std::vector< const unit_type * > &recruit_list, recruit_msgs_map &err_msgs_map, const team &team)

static std::unique_ptr< units_dialog >	build_recall_dialog (std::vector< unit_const_ptr > &recall_list, const team &team)

static std::unique_ptr< units_dialog >	build_unit_list_dialog (std::vector< unit_const_ptr > &units_list)

Static Public Member Functions inherited from gui2::window
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
group< unit_race::GENDER > &	get_toggle ()

void	list_item_clicked ()
	Callbacks. More...

void	filter_text_changed (const std::string &text)

void	dismiss_unit (std::vector< unit_const_ptr > &unit_list, const team &team)

void	rename_unit (std::vector< unit_const_ptr > &unit_list)

void	show_list (listbox &list)

void	show_help () const

void	update_gender (const unit_race::GENDER val)

void	update_variation ()

virtual const std::string &	window_id () const override
	The ID of the window to build. More...

virtual void	pre_show () override
	Actions to be taken before showing the window. More...

virtual void	post_show () override
	Actions to be taken after the window has been shown. More...

Private Attributes
int	selected_index_

std::size_t	num_rows_

std::string	title_

std::string	ok_label_

std::string	cancel_label_

std::string	topic_id_

bool	show_rename_

bool	show_dismiss_

bool	show_variations_

std::pair< std::string, sort_order::type >	sort_order_

std::map< std::string_view, std::function< std::string(std::size_t)> >	column_generators_

std::function< std::string(std::size_t)>	tooltip_gen_

std::function< std::vector< std::string >std::size_t)>	filter_gen_

unit_race::GENDER	gender_

std::string	variation_

std::vector< std::vector< std::string > >	filter_options_

group< unit_race::GENDER >	gender_toggle_

Additional Inherited Members
Protected Member Functions inherited from gui2::dialogs::modal_dialog
template<typename T , typename... Args>
T *	register_field (Args &&... args)
	Creates a new field of given type with given arguments. More...

field_bool *	register_bool (const std::string &id, const bool mandatory, const std::function< bool()> &callback_load_value=nullptr, const std::function< void(bool)> &callback_save_value=nullptr, const std::function< void(widget &)> &callback_change=nullptr, const bool initial_fire=false)
	Creates a new boolean field. More...

field_bool *	register_bool (const std::string &id, const bool mandatory, bool &linked_variable, const std::function< void(widget &)> &callback_change=nullptr, const bool initial_fire=false)
	Creates a new boolean field. More...

field_integer *	register_integer (const std::string &id, const bool mandatory, const std::function< int()> &callback_load_value=nullptr, const std::function< void(int)> &callback_save_value=nullptr)
	Creates a new integer field. More...

field_integer *	register_integer (const std::string &id, const bool mandatory, int &linked_variable)
	Creates a new integer field. More...

field_text *	register_text (const std::string &id, const bool mandatory, const std::function< std::string()> &callback_load_value=nullptr, const std::function< void(const std::string &)> &callback_save_value=nullptr, const bool capture_focus=false)
	Creates a new text field. More...

field_text *	register_text (const std::string &id, const bool mandatory, std::string &linked_variable, const bool capture_focus=false)
	Creates a new text field. More...

field_label *	register_label (const std::string &id, const bool mandatory, const std::string &text, const bool use_markup=false)
	Registers a new styled_widget as a label. More...

field_label *	register_image (const std::string &id, const bool mandatory, const std::string &filename)
	Registers a new styled_widget as image. More...

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

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

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

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

top_level_drawable &	operator= (top_level_drawable &&)

Detailed Description

Definition at line 34 of file units_dialog.hpp.

Member Typedef Documentation

◆ recruit_msgs_map

using gui2::dialogs::units_dialog::recruit_msgs_map = std::map<const unit_type*, t_string>

Definition at line 199 of file units_dialog.hpp.

Member Enumeration Documentation

◆ sort_type

enum gui2::dialogs::units_dialog::sort_type

strong

Controls the sort behavior for functions returned by make_column_builder.

Enumerator
generator
none

Definition at line 149 of file units_dialog.hpp.

Constructor & Destructor Documentation

◆ units_dialog()

gui2::dialogs::units_dialog::units_dialog ( )

Definition at line 67 of file units_dialog.cpp.

References gui2::widget::invisible, and gui2::widget::set_visible().

Member Function Documentation

◆ build_create_dialog()

std::unique_ptr< units_dialog > gui2::dialogs::units_dialog::build_create_dialog ( const std::vector< const unit_type * > & types_list )

static

Definition at line 382 of file units_dialog.cpp.

References _(), gui2::widget::find_widget(), g, gender(), generator, unit_type::get_gender_unit_type(), unit_type::get_variation(), unit_type::has_gender_variation(), utf8::index(), make_column_builder(), n, gui2::menu_button::set_active(), set_help_topic(), set_ok_label(), set_row_num(), set_show_variations(), gui2::menu_button::set_values(), and gui2::window::type().

Referenced by gui2::dialogs::editor_edit_unit::load_unit_type().

◆ build_recall_dialog()

std::unique_ptr< units_dialog > gui2::dialogs::units_dialog::build_recall_dialog	(	std::vector< unit_const_ptr > &	recall_list,
		const team &	team
	)

static

Definition at line 641 of file units_dialog.cpp.

References _(), unit::absolute_image(), unit::alignment(), unit_type::alignment_description(), unit::can_advance(), unit::can_recruit(), gui2::event::connect_signal_mouse_left_click(), resources::controller, t_string::empty(), unit::experience(), unit::experience_to_advance(), gui2::widget::find_widget(), unit_helper::format_cost_string(), unit_helper::format_level_string(), unit_helper::format_movement_string(), unit::gender(), play_controller::get_whiteboard(), team::gold(), font::GRAY_COLOR, unit::hitpoints(), unit::hp_color(), unit::image_mods(), utf8::index(), unit::level(), unit::max_experience(), unit::max_hitpoints(), unit_helper::maybe_inactive(), unit::movement_left(), unit::name(), none, unit::overlays(), unit::race(), game_config::recall_cost, team::recall_cost(), unit::recall_cost(), gui2::button::set_active(), team::side(), markup::span_color(), t_string::str(), unit::total_movement(), unit::trait_names(), unit::type_name(), font::unicode_en_dash, unit::unrenamable(), and unit::xp_color().

Referenced by lua_gui2::intf_show_recall_dialog().

◆ build_recruit_dialog()

std::unique_ptr< units_dialog > gui2::dialogs::units_dialog::build_recruit_dialog	(	const std::vector< const unit_type * > &	recruit_list,
		recruit_msgs_map &	err_msgs_map,
		const team &	team
	)

static

Definition at line 474 of file units_dialog.cpp.

References _(), team::color(), unit_helper::format_cost_string(), generator, utf8::index(), unit_helper::maybe_inactive(), none, on_modified(), set_help_topic(), set_ok_label(), set_row_num(), set_tooltip_generator(), and team::side().

Referenced by lua_gui2::intf_show_recruit_dialog().

◆ build_unit_list_dialog()

std::unique_ptr< units_dialog > gui2::dialogs::units_dialog::build_unit_list_dialog ( std::vector< unit_const_ptr > & units_list )

static

Definition at line 519 of file units_dialog.cpp.

References _(), unit::alignment(), unit_type::alignment_description(), unit::can_advance(), gui2::event::connect_signal_mouse_left_click(), t_string::empty(), unit::experience(), unit::experience_to_advance(), gui2::widget::find_widget(), unit_helper::format_level_string(), unit_helper::format_movement_string(), unit::gender(), generator, unit::get_location(), unit::hitpoints(), unit::hp_color(), unit::incapacitated(), utf8::index(), unit::invisible(), utils::join(), unit::level(), unit::max_experience(), unit::max_hitpoints(), unit::movement_left(), unit::name(), none, unit::poisoned(), unit::race(), gui2::button::set_active(), unit::slowed(), markup::span_color(), t_string::str(), unit::total_movement(), unit::trait_names(), unit::type_name(), font::unicode_en_dash, unit::unrenamable(), and unit::xp_color().

Referenced by editor::editor_controller::unit_list().

◆ clear_variation()

void gui2::dialogs::units_dialog::clear_variation ( )

inline

Definition at line 61 of file units_dialog.hpp.

References variation_.

◆ dismiss_unit()

void gui2::dialogs::units_dialog::dismiss_unit	(	std::vector< unit_const_ptr > &	unit_list,
		const team &	team
	)

private

◆ filter_text_changed()

void gui2::dialogs::units_dialog::filter_text_changed ( const std::string & text )

private

Definition at line 344 of file units_dialog.cpp.

References filter_options_, and translation::make_ci_matcher().

Referenced by pre_show().

◆ gender()

unit_race::GENDER gui2::dialogs::units_dialog::gender ( ) const

inline

Gender choice from the user.

Definition at line 50 of file units_dialog.hpp.

References gender_.

Referenced by build_create_dialog(), and pre_show().

◆ get_selected_index()

int gui2::dialogs::units_dialog::get_selected_index ( ) const

inline

Definition at line 39 of file units_dialog.hpp.

References selected_index_.

Referenced by on_modified().

◆ get_toggle()

group<unit_race::GENDER>& gui2::dialogs::units_dialog::get_toggle ( )

inlineprivate

Definition at line 231 of file units_dialog.hpp.

References gender_toggle_.

Referenced by pre_show().

◆ is_selected()

bool gui2::dialogs::units_dialog::is_selected ( ) const

inline

Definition at line 44 of file units_dialog.hpp.

References selected_index_.

◆ list_item_clicked()

void gui2::dialogs::units_dialog::list_item_clicked ( )

private

Callbacks.

Definition at line 319 of file units_dialog.cpp.

References gui2::event::dispatcher::fire(), gui2::event::NOTIFY_MODIFIED, and selected_index_.

Referenced by dismiss_unit(), pre_show(), and rename_unit().

◆ make_column_builder()

template<typename Value >

auto gui2::dialogs::units_dialog::make_column_builder ( const std::vector< Value > & list )

inline

Creates a generator function which registers secondary generator and sorter functions for the list column associated with the given ID.

Parameters

list	A list of values to associate with the generator functions. These will be used to populate the dialog's listbox.

Returns

A function which takes takes the following arguments:

The widget ID whose value will be generated.
The function which returns said widget's display value.
A sort_type flag or a function used to order the list. If sort_type::generator is specified, the second argument will be used as the sorter.

Definition at line 166 of file units_dialog.hpp.

References column_generators_, generator, gui2::widget::id(), make_index_wrapper(), and set_sorter().

Referenced by build_create_dialog().

◆ make_index_wrapper()

template<typename Value , typename Func >

static auto gui2::dialogs::units_dialog::make_index_wrapper	(	const std::vector< Value > &	list,
		const Func &	func
	)

inlinestatic

Definition at line 137 of file units_dialog.hpp.

References utf8::index().

Referenced by make_column_builder().

◆ on_modified()

template<typename Func >

void gui2::dialogs::units_dialog::on_modified ( const Func & f )

inline

Registers an function which will fired on NOTIFY_MODIFIED dialog events.

Parameters

f	The update function. This should return a const reference to the appropriate unit or unit type to display in the sidebar.

Definition at line 129 of file units_dialog.hpp.

References f, get_selected_index(), and w.

Referenced by build_recruit_dialog().

◆ post_show()

void gui2::dialogs::units_dialog::post_show ( )

overrideprivatevirtual

Actions to be taken after the window has been shown.

At this point the registered fields already stored their values (if the button with id 'ok' has been pressed).

Reimplemented from gui2::dialogs::modal_dialog.

Definition at line 330 of file units_dialog.cpp.

References gui2::listbox::get_active_sorter(), gui2::window::get_retval(), gui2::listbox::get_selected_row(), gui2::OK, and selected_index_.

◆ pre_show()

void gui2::dialogs::units_dialog::pre_show ( )

overrideprivatevirtual

Actions to be taken before showing the window.

At this point the registered fields are registered and initialized with their initial values.

Reimplemented from gui2::dialogs::modal_dialog.

Definition at line 133 of file units_dialog.cpp.

References gui2::group< T >::add_member(), gui2::window::add_to_keyboard_chain(), cancel_label_, gui2::event::connect_signal_mouse_left_click(), gui2::event::connect_signal_notify_modified(), unit_race::FEMALE, utils::views::filter, filter_text_changed(), gender(), get_toggle(), gui2::window::keyboard_capture(), list_item_clicked(), unit_race::MALE, ok_label_, gui2::group< T >::on_modified(), gui2::group< T >::set_member_states(), show_dismiss_, show_help(), show_list(), show_rename_, show_variations_, title_, update_gender(), and update_variation().

◆ rename_unit()

void gui2::dialogs::units_dialog::rename_unit ( std::vector< unit_const_ptr > & unit_list )

private

Definition at line 214 of file units_dialog.cpp.

References _(), filter_gen_, filter_options_, gui2::widget::find_widget(), gui2::listbox::get_row_grid(), gui2::listbox::get_selected_row(), gui2::window::invalidate_layout(), list_item_clicked(), unit::name(), unit::rename(), selected_index_, and gui2::styled_widget::set_label().

◆ set_cancel_label()

units_dialog& gui2::dialogs::units_dialog::set_cancel_label ( const std::string & cancel_label )

inline

Definition at line 80 of file units_dialog.hpp.

References cancel_label_.

◆ set_filter_generator()

template<typename Generator >

units_dialog& gui2::dialogs::units_dialog::set_filter_generator ( const Generator & generator )

inline

Sets the generator function for filter text.

Definition at line 191 of file units_dialog.hpp.

References filter_gen_.

◆ set_help_topic()

units_dialog& gui2::dialogs::units_dialog::set_help_topic ( const std::string & topic_id )

inline

Definition at line 104 of file units_dialog.hpp.

References topic_id_.

Referenced by build_create_dialog(), and build_recruit_dialog().

◆ set_ok_label()

units_dialog& gui2::dialogs::units_dialog::set_ok_label ( const std::string & ok_label )

inline

Definition at line 74 of file units_dialog.hpp.

References ok_label_.

Referenced by build_create_dialog(), and build_recruit_dialog().

◆ set_row_num()

units_dialog& gui2::dialogs::units_dialog::set_row_num ( const std::size_t row_num )

inline

Definition at line 110 of file units_dialog.hpp.

References num_rows_.

Referenced by build_create_dialog(), and build_recruit_dialog().

◆ set_show_dismiss()

units_dialog& gui2::dialogs::units_dialog::set_show_dismiss ( bool show = true )

inline

Definition at line 92 of file units_dialog.hpp.

References gui2::dialogs::modal_dialog::show(), and show_dismiss_.

◆ set_show_rename()

units_dialog& gui2::dialogs::units_dialog::set_show_rename ( bool show = true )

inline

Definition at line 86 of file units_dialog.hpp.

References gui2::dialogs::modal_dialog::show(), and show_rename_.

◆ set_show_variations()

units_dialog& gui2::dialogs::units_dialog::set_show_variations ( bool show = true )

inline

Definition at line 98 of file units_dialog.hpp.

References gui2::dialogs::modal_dialog::show(), and show_variations_.

Referenced by build_create_dialog().

◆ set_sort_by()

units_dialog& gui2::dialogs::units_dialog::set_sort_by ( std::pair< std::string, sort_order::type > sort_order )

inline

Definition at line 116 of file units_dialog.hpp.

References sort_order_.

◆ set_sorter()

template<typename Sorter >

void gui2::dialogs::units_dialog::set_sorter	(	std::string_view	id,
		const Sorter &	sorter
	)

inline

Definition at line 143 of file units_dialog.hpp.

Referenced by make_column_builder().

◆ set_title()

units_dialog& gui2::dialogs::units_dialog::set_title ( const std::string & title )

inline

Definition at line 68 of file units_dialog.hpp.

References title_.

◆ set_tooltip_generator()

template<typename Generator >

units_dialog& gui2::dialogs::units_dialog::set_tooltip_generator ( const Generator & generator )

inline

Sets the generator function for the tooltips.

Definition at line 183 of file units_dialog.hpp.

References tooltip_gen_.

Referenced by build_recruit_dialog().

◆ show_help()

void gui2::dialogs::units_dialog::show_help ( ) const

private

Definition at line 312 of file units_dialog.cpp.

References help::show_help(), and topic_id_.

Referenced by pre_show().

◆ show_list()

void gui2::dialogs::units_dialog::show_list ( listbox & list )

private

Definition at line 174 of file units_dialog.cpp.

References gui2::listbox::add_row(), column_generators_, filter_gen_, filter_options_, i, num_rows_, gui2::listbox::set_active_sorter(), sort_order_, and tooltip_gen_.

Referenced by pre_show().

◆ update_gender()

void gui2::dialogs::units_dialog::update_gender ( const unit_race::GENDER val )

private

Definition at line 357 of file units_dialog.cpp.

References gui2::event::dispatcher::fire(), gender_, gui2::event::NOTIFY_MODIFIED, and selected_index_.

Referenced by pre_show().

◆ update_variation()

void gui2::dialogs::units_dialog::update_variation ( )

private

Definition at line 369 of file units_dialog.cpp.

References gui2::event::dispatcher::fire(), gui2::event::NOTIFY_MODIFIED, selected_index_, and variation_.

Referenced by pre_show().

◆ variation()

std::string gui2::dialogs::units_dialog::variation ( ) const

inline

Variation choice from the user.

Definition at line 56 of file units_dialog.hpp.

References variation_.

◆ window_id()

virtual const std::string& gui2::dialogs::units_dialog::window_id ( ) const

overrideprivatevirtual

The ID of the window to build.

Usually set by REGISTER_DIALOG.

Implements gui2::dialogs::modal_dialog.

Member Data Documentation

◆ cancel_label_

std::string gui2::dialogs::units_dialog::cancel_label_

private

Definition at line 213 of file units_dialog.hpp.

Referenced by pre_show(), and set_cancel_label().

◆ column_generators_

std::map<std::string_view, std::function<std::string(std::size_t)> > gui2::dialogs::units_dialog::column_generators_

private

Definition at line 221 of file units_dialog.hpp.

Referenced by make_column_builder(), and show_list().

◆ filter_gen_

std::function<std::vector<std::string>std::size_t)> gui2::dialogs::units_dialog::filter_gen_

private

Definition at line 223 of file units_dialog.hpp.

Referenced by rename_unit(), set_filter_generator(), and show_list().

◆ filter_options_

std::vector<std::vector<std::string> > gui2::dialogs::units_dialog::filter_options_

private

Definition at line 228 of file units_dialog.hpp.

Referenced by dismiss_unit(), filter_text_changed(), rename_unit(), and show_list().

◆ gender_

unit_race::GENDER gui2::dialogs::units_dialog::gender_

private

Definition at line 225 of file units_dialog.hpp.

Referenced by gender(), and update_gender().

◆ gender_toggle_

group<unit_race::GENDER> gui2::dialogs::units_dialog::gender_toggle_

private

Definition at line 229 of file units_dialog.hpp.

Referenced by get_toggle().

◆ num_rows_

std::size_t gui2::dialogs::units_dialog::num_rows_

private

Definition at line 209 of file units_dialog.hpp.

Referenced by set_row_num(), and show_list().

◆ ok_label_

std::string gui2::dialogs::units_dialog::ok_label_

private

Definition at line 212 of file units_dialog.hpp.

Referenced by pre_show(), and set_ok_label().

◆ selected_index_

int gui2::dialogs::units_dialog::selected_index_

private

Definition at line 208 of file units_dialog.hpp.

Referenced by dismiss_unit(), get_selected_index(), is_selected(), list_item_clicked(), post_show(), rename_unit(), update_gender(), and update_variation().

◆ show_dismiss_

bool gui2::dialogs::units_dialog::show_dismiss_

private

Definition at line 217 of file units_dialog.hpp.

Referenced by pre_show(), and set_show_dismiss().

◆ show_rename_

bool gui2::dialogs::units_dialog::show_rename_

private

Definition at line 216 of file units_dialog.hpp.

Referenced by pre_show(), and set_show_rename().

◆ show_variations_

bool gui2::dialogs::units_dialog::show_variations_

private

Definition at line 218 of file units_dialog.hpp.

Referenced by pre_show(), and set_show_variations().

◆ sort_order_

std::pair<std::string, sort_order::type> gui2::dialogs::units_dialog::sort_order_

private

Definition at line 220 of file units_dialog.hpp.

Referenced by set_sort_by(), and show_list().

◆ title_

std::string gui2::dialogs::units_dialog::title_

private

Definition at line 211 of file units_dialog.hpp.

Referenced by pre_show(), and set_title().

◆ tooltip_gen_

std::function<std::string(std::size_t)> gui2::dialogs::units_dialog::tooltip_gen_

private

Definition at line 222 of file units_dialog.hpp.

Referenced by set_tooltip_generator(), and show_list().

◆ topic_id_

std::string gui2::dialogs::units_dialog::topic_id_

private

Definition at line 214 of file units_dialog.hpp.

Referenced by set_help_topic(), and show_help().

◆ variation_

std::string gui2::dialogs::units_dialog::variation_

private

Definition at line 226 of file units_dialog.hpp.

Referenced by clear_variation(), update_variation(), and variation().

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

gui/dialogs/units_dialog.hpp
gui/dialogs/units_dialog.cpp

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ recruit_msgs_map

Member Enumeration Documentation

◆ sort_type

Constructor & Destructor Documentation

◆ units_dialog()

Member Function Documentation

◆ build_create_dialog()

◆ build_recall_dialog()

◆ build_recruit_dialog()

◆ build_unit_list_dialog()

◆ clear_variation()

◆ dismiss_unit()

◆ filter_text_changed()

◆ gender()

◆ get_selected_index()

◆ get_toggle()

◆ is_selected()

◆ list_item_clicked()

◆ make_column_builder()

◆ make_index_wrapper()

◆ on_modified()

◆ post_show()

◆ pre_show()

◆ rename_unit()

◆ set_cancel_label()

◆ set_filter_generator()

◆ set_help_topic()

◆ set_ok_label()

◆ set_row_num()

◆ set_show_dismiss()

◆ set_show_rename()

◆ set_show_variations()

◆ set_sort_by()

◆ set_sorter()

◆ set_title()

◆ set_tooltip_generator()

◆ show_help()

◆ show_list()

◆ update_gender()

◆ update_variation()

◆ variation()

◆ window_id()

Member Data Documentation

◆ cancel_label_

◆ column_generators_

◆ filter_gen_

◆ filter_options_

◆ gender_

◆ gender_toggle_

◆ num_rows_

◆ ok_label_

◆ selected_index_

◆ show_dismiss_

◆ show_rename_

◆ show_variations_

◆ sort_order_

◆ title_

◆ tooltip_gen_

◆ topic_id_

◆ variation_