ui::opaque_element_base Class Reference

#include <gui_element_types.hpp>

Inheritance diagram for ui::opaque_element_base:

Collaboration diagram for ui::opaque_element_base:

Public Member Functions
message_result	test_mouse (sys::state &state, int32_t x, int32_t y, mouse_probe_type type) noexcept override
message_result	on_lbutton_down (sys::state &state, int32_t x, int32_t y, sys::key_modifiers mods) noexcept override
message_result	on_rbutton_down (sys::state &state, int32_t x, int32_t y, sys::key_modifiers mods) noexcept override
tooltip_behavior	has_tooltip (sys::state &state) noexcept override
Public Member Functions inherited from ui::image_element_base
void	render (sys::state &state, int32_t x, int32_t y) noexcept override
void	on_create (sys::state &state) noexcept override
virtual bool	get_horizontal_flip (sys::state &state) noexcept
message_result	test_mouse (sys::state &state, int32_t x, int32_t y, mouse_probe_type type) noexcept override
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 ()

Additional Inherited Members
Public Attributes inherited from ui::image_element_base
int32_t	frame = 0
bool	disabled = false
bool	interactable = false
Public Attributes inherited from ui::element_base
element_data	base_data
element_base *	parent = nullptr
uint8_t	flags = 0
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 124 of file gui_element_types.hpp.

Member Function Documentation

has_tooltip()

tooltip_behavior ui::opaque_element_base::has_tooltip ( sys::state &  state )

inlineoverridevirtualnoexcept

Reimplemented from ui::element_base.

Reimplemented in ui::scrollbar_track, ui::province_script_button, ui::nation_script_button, ui::flag_button, ui::flag_button2, ui::overlapping_flags_flag_button, ui::overlapping_truce_flag_button, ui::scrollbar_left, ui::scrollbar_right, ui::end_window_ledger_button, ui::event_option_button, ui::event_auto_button, ui::generic_callback_button, ui::lc_retreat_button, ui::sort_leader_attack, ui::sort_leader_def, ui::sort_leader_org, ui::sort_leader_morale, ui::sort_leader_speed, ui::sort_leader_recon, ui::sort_leader_reliable, ui::sort_leader_exp, ui::leader_prestige_progress_bar< T >, ui::leader_prestige_progress_bar< dcon::leader_id >, ui::ledger_generic_sort_button, ui::tl_frame_bg, ui::message_handling_buton< category >, ui::message_log_text, ui::message_log_filter_checkbox< Filter >, ui::minimap_mapmode_button, ui::minimap_goto_button, ui::minimap_ledger_button, ui::minimap_macro_builder_button, ui::minimap_console_button, ui::minimap_msg_settings_button, ui::minimap_msg_combat_button, ui::minimap_msg_diplo_button, ui::minimap_msg_unit_button, ui::minimap_msg_province_button, ui::minimap_msg_other_button, ui::minimap_msg_event_button, ui::minimap_menu_button, ui::minimap_zoom_in_button, ui::minimap_zoom_out_button, ui::start_game_button, ui::nc_retreat_button, ui::outliner_element_button, ui::outliner_filter_checkbox< Filter >, ui::outliner_button, ui::land_rally_point, ui::naval_rally_point, ui::merge_rally_point, ui::province_liferating, ui::province_pop_button, ui::province_terrain_image, ui::province_controller_flag, ui::province_national_focus_button, ui::province_move_capital_button, ui::province_take_province_button, ui::province_grant_province_button, ui::province_building_expand_button< Value >, ui::province_building_progress< Value >, ui::province_country_flag_button, ui::province_rgo_employment_progress_icon, ui::colony_invest_button, ui::topbar_tab_button, ui::topbar_population_view_button, ui::topbar_pause_button, ui::topbar_speedup_button, ui::topbar_speeddown_button, ui::topbar_available_reforms_icon, ui::topbar_available_decisions_icon, ui::topbar_rebels_icon, ui::topbar_colony_icon, ui::unit_frame_bg, ui::unit_selection_close_button, ui::unit_selection_new_unit_button< T >, ui::unit_selection_split_in_half_button< T >, ui::unit_selection_disband_button< T >, ui::unit_selection_disband_too_small_button, ui::unit_selection_unit_upgrade_button, ui::unit_selection_change_leader_button< T >, ui::unit_selection_leader_image< T >, ui::unit_selection_unit_location_button< T >, ui::unit_selection_str_bar< T >, ui::unit_selection_org_bar< T >, ui::unit_details_load_army_button, ui::unit_details_unload_army_button, ui::unit_details_unload_navy_button, ui::unit_details_hunt_rebels, ui::unit_details_dont_hunt_rebels, ui::unit_details_ai_controlled, ui::unit_supply_bar, ui::disband_all_button, ui::u_row_disband, ui::u_row_remove, ui::u_row_split, ui::multi_selection_leader_image, ui::multi_unit_details_ai_controlled, ui::subunit_organisation_progress_bar< T >, ui::subunit_strength_progress_bar< T >, ui::diplomacy_crisis_sponsored_attacker_flag, ui::crisis_add_wargoal_confirm_button, ui::diplomacy_crisis_sponsored_defender_flag, ui::diplomacy_crisis_temperature_bar, ui::make_offer_button, ui::join_crisis_button, ui::gp_action_choice_accept_button, ui::diplomacy_peace_send, ui::wargoal_type_item_button, ui::wargoal_country_item_button, ui::diplomacy_declare_war_agree_button, ui::diplomacy_declare_war_call_allies_checkbox, ui::diplomacy_declare_war_run_conference_checkbox, ui::wargoal_offer_agree_button, ui::wargoal_target_country_item_button, ui::tax_list_pop_type_icon, ui::enable_debt_toggle, ui::cb_wargoal_button, ui::diplomacy_priority_button, ui::diplomacy_country_interested_in_alliance, ui::diplomacy_action_add_wargoal_button, ui::war_side_strength_text< IsAttacker >, ui::diplomacy_join_war_button< B >, ui::war_score_progress_bar, ui::justifying_cb_progress, ui::military_mob_button, ui::military_mobilized_is_ai_controlled, ui::politics_choose_party_button, ui::politics_change_party_button, ui::popwin_religion_type, ui::province_growth_indicator, ui::state_growth_indicator, ui::nation_growth_indicator, ui::pop_revolt_faction, ui::pop_movement_social, ui::pop_movement_political, ui::pop_movement_flag, ui::pop_growth_indicator, ui::pop_unemployment_progress_bar, ui::pop_life_needs_progress_bar, ui::pop_everyday_needs_progress_bar, ui::pop_luxury_needs_progress_bar, ui::pop_national_focus_button, ui::pop_details_promotion_percent_text, ui::pop_filter_button, ui::pop_sort_button< Sort >, ui::factory_priority_button, ui::factory_upgrade_button, ui::factory_reopen_button, ui::factory_subsidise_button, ui::factory_delete_button, ui::factory_close_and_delete_button, ui::factory_build_progress_bar, ui::factory_upgrade_progress_bar, ui::factory_cancel_new_const_button, ui::factory_cancel_upgrade_button, ui::province_build_new_factory, ui::production_build_new_factory, ui::production_national_focus_button, ui::technology_folder_tab_sub_button, ui::technology_item_button, ui::invention_image, ui::technology_sort_by_type_button, ui::technology_sort_by_name_button, ui::technology_sort_by_percent_button, ui::stockpile_buy_from_stockpile_hint, ui::unit_build_button, ui::unit_build_button_group, ui::unit_queue_button, ui::cancel_all_units_button, ui::unit_folder_button, ui::build_unit_province_cancel_all_units_button, ui::military_make_leader_button< B >, ui::leaders_sortby_prestige, ui::leaders_sortby_type, ui::leaders_sortby_name, ui::leaders_sortby_army, ui::military_unit_building_progress_bar< T >, ui::military_unit_morale_progress_bar, ui::military_unit_strength_progress_bar, ui::build_unit_button< T >, ui::military_units_sortby_name, ui::military_units_sortby_strength, ui::decision_requirements, ui::decision_ai_will_do, ui::decision_potential, ui::make_decision, ui::ignore_checkbox, ui::reforms_reform_button, ui::unciv_reforms_reform_button, ui::factory_build_cancel_button, ui::factory_build_button, ui::factory_build_item_button, ui::commodity_filter_button, ui::factory_prod_subsidise_all_button, ui::factory_prod_unsubsidise_all_button, ui::factory_prod_open_all_button, ui::factory_prod_close_all_button, ui::factory_select_all_button, ui::factory_show_empty_states_button, ui::production_sort_my_nation_flag, ui::production_project_invest_button, table::sort_button< item_type >, and table::entry< item_type >.

Definition at line 137 of file gui_element_types.hpp.

on_lbutton_down()

message_result ui::opaque_element_base::on_lbutton_down ( sys::state &  state, int32_t  x, int32_t  y, sys::key_modifiers  mods  )

inlineoverridevirtualnoexcept

Reimplemented from ui::element_base.

Reimplemented in ui::scrollbar_track, ui::scrollbar_slider, ui::progress_bar, ui::button_element_base, ui::draggable_target, ui::left_mouse_click_mode_checkbox, ui::prov_map_battle_bar, ui::minimap_picture_window, and ui::subunit_entry_bg< T >.

Definition at line 131 of file gui_element_types.hpp.

on_rbutton_down()

message_result ui::opaque_element_base::on_rbutton_down ( sys::state &  state, int32_t  x, int32_t  y, sys::key_modifiers  mods  )

inlineoverridevirtualnoexcept

Reimplemented from ui::element_base.

Reimplemented in ui::right_click_button_element_base, ui::tinted_right_click_button_element_base, ui::progress_bar, and ui::button_element_base.

Definition at line 134 of file gui_element_types.hpp.

test_mouse()

message_result ui::opaque_element_base::test_mouse ( sys::state &  state, int32_t  x, int32_t  y, mouse_probe_type  type  )

inlineoverridevirtualnoexcept

Reimplemented from ui::image_element_base.

Reimplemented in ui::unit_details_load_army_button, ui::unit_details_unload_army_button, ui::partially_transparent_image, ui::progress_bar, ui::draggable_target, ui::prov_map_battle_bar, ui::unit_details_hunt_rebels, ui::unit_details_dont_hunt_rebels, ui::factory_close_and_delete_button, and table::entry< item_type >.

Definition at line 126 of file gui_element_types.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

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