ui::container_base Class Reference

#include <gui_element_types.hpp>

Inherits ui::element_base.

Inherited by table::body< dcon::commodity_id >, table::body< dcon::trade_route_id >, table::body< dcon::nation_id >, table::body< dcon::market_id >, ui::listbox2_base< outliner_data >, ui::listbox_element_base< army_group_entry, dcon::automated_army_group_id >, ui::listbox_element_base< event_option_button_row, int32_t >, ui::listbox_element_base< chat_message_entry, chat_message >, ui::listbox_element_base< chat_player_entry, dcon::nation_id >, ui::listbox_element_base< colonist_entry, dcon::colonization_id >, ui::listbox_element_base< debt_item, debt_item_data >, ui::listbox_element_base< decision_item, dcon::decision_id >, ui::listbox_element_base< diplo_actions_row_entry, int16_t >, ui::listbox_element_base< diplomacy_casus_belli_entry, dcon::nation_id >, ui::listbox_element_base< diplomacy_country_info, dcon::nation_id >, ui::listbox_element_base< diplomacy_crisis_peace_goal_row, int32_t >, ui::listbox_element_base< diplomacy_make_cb_type, dcon::cb_type_id >, ui::listbox_element_base< diplomacy_peace_goal_row, dcon::wargoal_id >, ui::listbox_element_base< diplomacy_war_info, dcon::war_id >, ui::listbox_element_base< election_party_entry, dcon::political_party_id >, ui::listbox_element_base< election_popularity_entry, dcon::political_party_id >, ui::listbox_element_base< election_voter_issue_entry, dcon::issue_option_id >, ui::listbox_element_base< election_issue_support_item, dcon::issue_option_id >, ui::listbox_element_base< factory_build_item, dcon::factory_type_id >, ui::listbox_element_base< leader_select_row, dcon::leader_id >, ui::listbox_element_base< ledger_commodity_price_entry, dcon::commodity_id >, ui::listbox_element_base< ledger_factories_production_entry, dcon::factory_id >, ui::listbox_element_base< ledger_nation_comparison_entry, dcon::nation_id >, ui::listbox_element_base< ledger_nation_reforms_entry< true >, dcon::nation_id >, ui::listbox_element_base< ledger_nation_political_systems_entry, dcon::nation_id >, ui::listbox_element_base< ledger_nation_population_entry, dcon::nation_id >, ui::listbox_element_base< ledger_nation_ranking_entry, dcon::nation_id >, ui::listbox_element_base< ledger_nation_reforms_entry< false >, dcon::nation_id >, ui::listbox_element_base< ledger_nation_entry, dcon::nation_id >, ui::listbox_element_base< ledger_province_entry, dcon::province_id >, ui::listbox_element_base< ledger_province_population_entry, dcon::province_id >, ui::listbox_element_base< ledger_provinces_production_entry, dcon::province_id >, ui::listbox_element_base< map_state_select_entry, dcon::state_definition_id >, ui::listbox_element_base< message_filters_country_item, dcon::nation_id >, ui::listbox_element_base< message_log_entry, int32_t >, ui::listbox_element_base< message_settings_item, int32_t >, ui::listbox_element_base< military_leaders, dcon::leader_id >, ui::listbox_element_base< military_unit_entry< T >, military_unit_info< T > >, ui::listbox_element_base< movements_option, dcon::movement_id >, ui::listbox_element_base< movements_rebel_option, dcon::rebel_faction_id >, ui::listbox_element_base< nation_picker_multiplayer_entry, dcon::nation_id >, ui::listbox_element_base< playable_nations_item, dcon::nation_id >, ui::listbox_element_base< politics_all_party_entry, dcon::political_party_id >, ui::listbox_element_base< politics_issue_support_item, dcon::issue_option_id >, ui::listbox_element_base< politics_party_issue_entry, dcon::issue_option_id >, ui::listbox_element_base< politics_upper_house_entry, dcon::ideology_id >, ui::listbox_element_base< pop_detailed_ideology_distribution_item, std::pair< dcon::ideology_id, float > >, ui::listbox_element_base< pop_detailed_issue_distribution_item, std::pair< dcon::issue_option_id, float > >, ui::listbox_element_base< pop_details_needs_item, pop_details_needs_data >, ui::listbox_element_base< pop_distribution_item< T >, std::pair< T, float > >, ui::listbox_element_base< pop_left_side_item, pop_left_side_data >, ui::listbox_element_base< pop_item, dcon::pop_id >, ui::listbox_element_base< production_investment_country_info, dcon::nation_id >, ui::listbox_element_base< production_project_info, production_project_data >, ui::listbox_element_base< production_state_info, dcon::state_instance_id >, ui::listbox_element_base< province_search_list_item, dcon::province_id >, ui::listbox_element_base< reforms_option, dcon::issue_option_id >, ui::listbox_element_base< release_nation_option, dcon::national_identity_id >, ui::listbox_element_base< reorg_unit_listbox_row< T2 >, T2 >, ui::listbox_element_base< save_game_item, std::shared_ptr< save_item > >, ui::listbox_element_base< unit_type_row, army_group_unit_type_info_grid_row >, ui::listbox_element_base< selected_unit_item, unit_var >, ui::listbox_element_base< technology_possible_invention, dcon::invention_id >, ui::listbox_element_base< technology_selected_invention, dcon::invention_id >, ui::listbox_element_base< trade_flow_entry, trade_flow_data >, ui::listbox_element_base< unciv_reforms_option, dcon::reform_option_id >, ui::listbox_element_base< subunit_details_entry_regiment, dcon::regiment_id >, ui::listbox_element_base< subunit_details_entry_ship, dcon::ship_id >, ui::listbox_element_base< unit_grid_row, grid_row >, ui::listbox_element_base< unit_type_listbox_entry, dcon::unit_type_id >, ui::listbox_element_base< units_build_item, buildable_unit_entry_info >, ui::listbox_element_base< units_queue_item, ui::queue_unit_entry_info >, ui::listbox_element_base< wargoal_country_item, dcon::national_identity_id >, ui::listbox_element_base< wargoal_type_item, dcon::cb_type_id >, ui::listbox_element_base< wargoal_target_country_item, dcon::nation_id >, alice_ui::budgetwindow_bottom_spacer_t, alice_ui::budgetwindow_main_t, alice_ui::budgetwindow_neutral_spacer_t, alice_ui::budgetwindow_section_header_t, alice_ui::budgetwindow_top_spacer_t, alice_ui::macrobuilder2_grid_item_t, alice_ui::macrobuilder2_list_item_t, alice_ui::macrobuilder2_main_t, alice_ui::macrobuilder2_main_template_list_t, alice_ui::macrobuilder2_main_unit_grid_t, table::body< item_type >, ui::listbox2_base< contents_type >, ui::listbox_element_base< RowWinT, RowConT >, ui::scrollbar, and ui::window_element_base.

Collaboration diagram for ui::container_base:

Public Member Functions
mouse_probe	impl_probe_mouse (sys::state &state, int32_t x, int32_t y, mouse_probe_type type) noexcept override
message_result	impl_on_key_down (sys::state &state, sys::virtual_key key, sys::key_modifiers mods) noexcept final
void	impl_on_update (sys::state &state) noexcept override
message_result	impl_set (sys::state &state, Cyto::Any &payload) noexcept final
void	impl_render (sys::state &state, int32_t x, int32_t y) noexcept override
void	impl_on_reset_text (sys::state &state) noexcept override
std::unique_ptr< element_base >	remove_child (element_base *child) noexcept final
void	move_child_to_front (element_base *child) noexcept final
void	move_child_to_back (element_base *child) noexcept final
void	add_child_to_front (std::unique_ptr< element_base > child) noexcept final
void	add_child_to_back (std::unique_ptr< element_base > child) noexcept final
element_base *	get_child_by_name (sys::state const &state, std::string_view name) noexcept final
element_base *	get_child_by_index (sys::state const &state, int32_t index) noexcept final
Public Member Functions inherited from ui::element_base
bool	is_visible () const
void	set_visible (sys::state &state, bool vis)
	element_base ()
virtual mouse_probe	impl_probe_mouse (sys::state &state, int32_t x, int32_t y, mouse_probe_type type) noexcept
virtual message_result	impl_on_lbutton_down (sys::state &state, int32_t x, int32_t y, sys::key_modifiers mods) noexcept
virtual message_result	impl_on_lbutton_up (sys::state &state, int32_t x, int32_t y, sys::key_modifiers mods, bool under_mouse) noexcept
virtual message_result	impl_on_rbutton_down (sys::state &state, int32_t x, int32_t y, sys::key_modifiers mods) noexcept
virtual message_result	impl_on_key_down (sys::state &state, sys::virtual_key key, sys::key_modifiers mods) noexcept
virtual message_result	impl_on_scroll (sys::state &state, int32_t x, int32_t y, float amount, sys::key_modifiers mods) noexcept
virtual message_result	impl_on_mouse_move (sys::state &state, int32_t x, int32_t y, sys::key_modifiers mods) noexcept
virtual void	impl_on_update (sys::state &state) noexcept
message_result	impl_get (sys::state &state, Cyto::Any &payload) noexcept
virtual void *	get_by_name (sys::state &state, std::string_view name) noexcept
virtual message_result	impl_set (sys::state &state, Cyto::Any &payload) noexcept
virtual void	impl_render (sys::state &state, int32_t x, int32_t y) noexcept
virtual void	impl_on_reset_text (sys::state &state) noexcept
virtual void	impl_on_drag_finish (sys::state &state) noexcept
virtual tooltip_behavior	has_tooltip (sys::state &state) noexcept
virtual void	tooltip_position (sys::state &state, int32_t x, int32_t y, int32_t &ident, urect &subrect) noexcept
virtual void	update_tooltip (sys::state &state, int32_t x, int32_t y, text::columnar_layout &contents) noexcept
virtual void	on_hover (sys::state &state) noexcept
virtual void	on_hover_end (sys::state &state) noexcept
virtual std::unique_ptr< element_base >	remove_child (element_base *child) noexcept
virtual void	move_child_to_front (element_base *child) noexcept
virtual void	move_child_to_back (element_base *child) noexcept
virtual void	add_child_to_front (std::unique_ptr< element_base > child) noexcept
virtual void	add_child_to_back (std::unique_ptr< element_base > child) noexcept
virtual element_base *	get_child_by_name (sys::state const &state, std::string_view name) noexcept
virtual element_base *	get_child_by_index (sys::state const &state, int32_t index) noexcept
virtual	~element_base ()

Public Attributes
std::vector< std::unique_ptr< element_base > >	children
Public Attributes inherited from ui::element_base
element_data	base_data
element_base *	parent = nullptr
uint8_t	flags = 0

Additional Inherited Members
Static Public Attributes inherited from ui::element_base
static constexpr uint8_t	is_invisible_mask = 0x01
static constexpr uint8_t	wants_update_when_hidden_mask = 0x02
Protected Member Functions inherited from ui::element_base
virtual message_result	test_mouse (sys::state &state, int32_t x, int32_t y, mouse_probe_type type) noexcept
virtual message_result	on_lbutton_down (sys::state &state, int32_t x, int32_t y, sys::key_modifiers mods) noexcept
virtual message_result	on_lbutton_up (sys::state &state, int32_t x, int32_t y, sys::key_modifiers mods, bool under_mouse) noexcept
virtual message_result	on_rbutton_down (sys::state &state, int32_t x, int32_t y, sys::key_modifiers mods) noexcept
virtual message_result	on_key_down (sys::state &state, sys::virtual_key key, sys::key_modifiers mods) noexcept
virtual message_result	on_scroll (sys::state &state, int32_t x, int32_t y, float amount, sys::key_modifiers mods) noexcept
virtual message_result	on_mouse_move (sys::state &state, int32_t x, int32_t y, sys::key_modifiers mods) noexcept
virtual message_result	get (sys::state &state, Cyto::Any &payload) noexcept
virtual message_result	set (sys::state &state, Cyto::Any &payload) noexcept
virtual void	render (sys::state &state, int32_t x, int32_t y) noexcept
virtual void	on_update (sys::state &state) noexcept
virtual void	on_create (sys::state &state) noexcept
virtual void	on_drag (sys::state &state, int32_t oldx, int32_t oldy, int32_t x, int32_t y, sys::key_modifiers mods) noexcept
virtual void	on_text (sys::state &state, char32_t ch) noexcept
virtual void	on_visible (sys::state &state) noexcept
virtual void	on_hide (sys::state &state) noexcept
virtual void	on_reset_text (sys::state &state) noexcept
virtual focus_result	on_get_focus (sys::state &state) noexcept
virtual void	on_lose_focus (sys::state &state) noexcept
virtual void	on_drag_finish (sys::state &state) noexcept

Detailed Description

Definition at line 53 of file gui_element_types.hpp.

Member Function Documentation

add_child_to_back()

void ui::container_base::add_child_to_back ( std::unique_ptr< element_base >  child )

finalvirtualnoexcept

Reimplemented from ui::element_base.

Definition at line 193 of file gui_element_types.cpp.

Here is the caller graph for this function:

add_child_to_front()

void ui::container_base::add_child_to_front ( std::unique_ptr< element_base >  child )

finalvirtualnoexcept

Reimplemented from ui::element_base.

Definition at line 186 of file gui_element_types.cpp.

Here is the caller graph for this function:

get_child_by_index()

element_base * ui::container_base::get_child_by_index ( sys::state const &  state, int32_t  index  )

finalvirtualnoexcept

Reimplemented from ui::element_base.

Definition at line 203 of file gui_element_types.cpp.

Here is the call graph for this function:

get_child_by_name()

element_base * ui::container_base::get_child_by_name ( sys::state const &  state, std::string_view  name  )

finalvirtualnoexcept

Reimplemented from ui::element_base.

Definition at line 197 of file gui_element_types.cpp.

Here is the call graph for this function:

impl_on_key_down()

message_result ui::container_base::impl_on_key_down ( sys::state &  state, sys::virtual_key  key, sys::key_modifiers  mods  )

finalvirtualnoexcept

Reimplemented from ui::element_base.

Definition at line 60 of file gui_element_types.cpp.

Here is the call graph for this function:

impl_on_reset_text()

void ui::container_base::impl_on_reset_text ( sys::state &  state )

overridevirtualnoexcept

Reimplemented from ui::element_base.

Definition at line 103 of file gui_element_types.cpp.

impl_on_update()

void ui::container_base::impl_on_update ( sys::state &  state )

overridevirtualnoexcept

Reimplemented from ui::element_base.

Reimplemented in ui::army_group_counter_window, ui::unit_counter_window, and ui::province_details_container.

Definition at line 83 of file gui_element_types.cpp.

Here is the caller graph for this function:

impl_probe_mouse()

mouse_probe ui::container_base::impl_probe_mouse ( sys::state &  state, int32_t  x, int32_t  y, mouse_probe_type  type  )

overridevirtualnoexcept

Reimplemented from ui::element_base.

Reimplemented in ui::chat_message_listbox< true >, ui::port_window, ui::map_siege, ui::map_battle, ui::top_right_unit_icon, ui::small_top_right_unit_icon, ui::unit_counter_window, ui::province_details_container, ui::base_unit_container, ui::unit_type_grid_item, ui::diplomacy_crisis_interested_container, and ui::diplomacy_crisis_join_container.

Definition at line 36 of file gui_element_types.cpp.

Here is the call graph for this function:

impl_render()

void ui::container_base::impl_render ( sys::state &  state, int32_t  x, int32_t  y  )

overridevirtualnoexcept

Reimplemented from ui::element_base.

Reimplemented in ui::port_window, ui::map_siege, ui::map_battle, ui::top_right_unit_icon, ui::small_top_right_unit_icon, ui::army_group_counter_window, ui::unit_counter_window, ui::province_details_container, ui::map_legend_gradient, ui::map_legend_civ_level, ui::map_legend_col, ui::map_legend_dip, ui::map_legend_rr, ui::map_legend_nav, ui::map_legend_rank, ui::map_legend_rec, ui::rr_invest_inwdow, ui::base_unit_container, ui::unit_type_grid_item, ui::diplomacy_crisis_interested_container, ui::diplomacy_crisis_join_container, and ui::trade_slider.

Definition at line 130 of file gui_element_types.cpp.

Here is the call graph for this function:

impl_set()

message_result ui::container_base::impl_set ( sys::state &  state, Cyto::Any &  payload  )

finalvirtualnoexcept

Reimplemented from ui::element_base.

Definition at line 115 of file gui_element_types.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

move_child_to_back()

void ui::container_base::move_child_to_back ( element_base *  child )

finalvirtualnoexcept

Reimplemented from ui::element_base.

Definition at line 174 of file gui_element_types.cpp.

move_child_to_front()

void ui::container_base::move_child_to_front ( element_base *  child )

finalvirtualnoexcept

Reimplemented from ui::element_base.

Definition at line 162 of file gui_element_types.cpp.

Here is the caller graph for this function:

remove_child()

std::unique_ptr< element_base > ui::container_base::remove_child ( element_base *  child )

finalvirtualnoexcept

Reimplemented from ui::element_base.

Definition at line 151 of file gui_element_types.cpp.

Member Data Documentation

children

std::vector<std::unique_ptr<element_base> > ui::container_base::children

Definition at line 55 of file gui_element_types.hpp.

---

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

• /github/workspace/src/gui/gui_element_types.hpp
• /github/workspace/src/gui/gui_element_types.cpp