ui::checkbox_button Class Reference

#include <gui_element_types.hpp>

Inheritance diagram for ui::checkbox_button:

Collaboration diagram for ui::checkbox_button:

Public Member Functions
virtual bool	is_active (sys::state &state) noexcept
sound::audio_instance &	get_click_sound (sys::state &state) noexcept override
void	render (sys::state &state, int32_t x, int32_t y) noexcept override
Public Member Functions inherited from ui::button_element_base
	button_element_base ()
void	set_button_text (sys::state &state, std::string const &new_text)
void	on_reset_text (sys::state &state) noexcept override
virtual void	button_action (sys::state &state) noexcept
virtual void	button_right_action (sys::state &state) noexcept
virtual void	button_shift_action (sys::state &state) noexcept
virtual void	button_shift_right_action (sys::state &state) noexcept
virtual void	button_ctrl_action (sys::state &state) noexcept
virtual void	button_ctrl_right_action (sys::state &state) noexcept
virtual void	button_ctrl_shift_action (sys::state &state) noexcept
virtual void	button_ctrl_shift_right_action (sys::state &state) noexcept
virtual sound::audio_instance &	get_click_sound (sys::state &state) noexcept
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
message_result	on_lbutton_up (sys::state &state, int32_t x, int32_t y, sys::key_modifiers mods, bool under_mouse) noexcept override
message_result	on_key_down (sys::state &state, sys::virtual_key key, sys::key_modifiers mods) noexcept final
void	on_create (sys::state &state) noexcept override
void	render (sys::state &state, int32_t x, int32_t y) noexcept override
void	format_text (sys::state &state)
Public Member Functions inherited from ui::opaque_element_base
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 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	update_tooltip (sys::state &state, int32_t x, int32_t y, text::columnar_layout &contents) 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
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
Protected Attributes inherited from ui::button_element_base
text::layout	internal_layout
std::string	cached_text
bool	black_text = true

Detailed Description

Definition at line 476 of file gui_element_types.hpp.

Member Function Documentation

get_click_sound()

sound::audio_instance & ui::checkbox_button::get_click_sound ( sys::state &  state )

inlineoverridevirtualnoexcept

Reimplemented from ui::button_element_base.

Reimplemented in ui::generic_tab_button< TabT >, ui::topbar_budget_tab_button, ui::topbar_trade_tab_button, ui::topbar_politics_tab_button, ui::topbar_diplomacy_tab_button, ui::topbar_military_tab_button, ui::topbar_population_tab_button, ui::topbar_production_tab_button, ui::topbar_technology_tab_button, and ui::topbar_population_view_button.

Definition at line 482 of file gui_element_types.hpp.

Here is the call graph for this function:

is_active()

virtual bool ui::checkbox_button::is_active ( sys::state &  state )

inlinevirtualnoexcept

Reimplemented in ui::generic_tab_button< TabT >, ui::generic_opaque_checkbox_button< TabT >, ui::crisis_tab_button, ui::technology_folder_tab_sub_button, ui::nation_toggle_checkbox, ui::price_toggle_checkbox, ui::window_mode_checkbox, ui::fonts_mode_checkbox, ui::left_mouse_click_mode_checkbox, ui::map_mouse_edge_scrolling, ui::tooltip_mode_checkbox, ui::spoilers_checkbox, ui::wasd_for_map_movement_checkbox, ui::dm_popup_checkbox, ui::mute_on_focus_lost_checkbox, ui::fow_checkbox, ui::render_models_checkbox, ui::black_map_font_checkbox, ui::railroad_checkbox, ui::river_checkbox, ui::message_notify_rebels_defeat, ui::message_log_filter_checkbox< Filter >, ui::minimap_mapmode_button, ui::outliner_filter_checkbox< Filter >, ui::topbar_tab_button, ui::unit_details_ai_controlled, ui::multi_unit_details_ai_controlled, ui::diplomacy_country_interested_in_alliance, ui::military_mobilized_is_ai_controlled, and ui::ignore_checkbox.

Definition at line 478 of file gui_element_types.hpp.

Here is the caller graph for this function:

render()

void ui::checkbox_button::render ( sys::state &  state, int32_t  x, int32_t  y  )

inlineoverridevirtualnoexcept

Reimplemented from ui::button_element_base.

Reimplemented in ui::multi_unit_details_ai_controlled.

Definition at line 486 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