ui::button_data Struct Reference

#include <gui_graphics.hpp>

Inheritance diagram for ui::button_data:

Collaboration diagram for ui::button_data:

Public Member Functions
clicksound	get_clicksound () const
bool	is_checkbox () const
button_scripting	get_button_scripting () const
Public Member Functions inherited from ui::text_base_data
alignment	get_alignment () const

Public Attributes
dcon::gfx_object_id	button_image
dcon::trigger_key	scriptable_enable
dcon::effect_key	scriptable_effect
sys::virtual_key	shortcut = sys::virtual_key::NONE
Public Attributes inherited from ui::text_base_data
dcon::text_key	txt
uint16_t	font_handle = 0
uint16_t	flags = 0

Static Public Attributes
static constexpr uint16_t	clicksound_mask = (0x03 << clicksound_bit_offset)
static constexpr uint16_t	is_checkbox_mask = (0x01 << checkbox_bit_offset)
static constexpr uint16_t	button_scripting_mask = (0x03 << button_scripting_bit_offset)
Static Public Attributes inherited from ui::text_base_data
static constexpr uint16_t	alignment_mask = 0x03

Detailed Description

Definition at line 135 of file gui_graphics.hpp.

Member Function Documentation

get_button_scripting()

button_scripting ui::button_data::get_button_scripting ( ) const

inline

Definition at line 152 of file gui_graphics.hpp.

get_clicksound()

clicksound ui::button_data::get_clicksound ( ) const

inline

Definition at line 146 of file gui_graphics.hpp.

is_checkbox()

bool ui::button_data::is_checkbox ( ) const

inline

Definition at line 149 of file gui_graphics.hpp.

Member Data Documentation

button_image

dcon::gfx_object_id ui::button_data::button_image

Definition at line 141 of file gui_graphics.hpp.

button_scripting_mask

constexpr uint16_t ui::button_data::button_scripting_mask = (0x03 << button_scripting_bit_offset)

staticconstexpr

Definition at line 138 of file gui_graphics.hpp.

clicksound_mask

constexpr uint16_t ui::button_data::clicksound_mask = (0x03 << clicksound_bit_offset)

staticconstexpr

Definition at line 136 of file gui_graphics.hpp.

is_checkbox_mask

constexpr uint16_t ui::button_data::is_checkbox_mask = (0x01 << checkbox_bit_offset)

staticconstexpr

Definition at line 137 of file gui_graphics.hpp.

scriptable_effect

dcon::effect_key ui::button_data::scriptable_effect

Definition at line 143 of file gui_graphics.hpp.

scriptable_enable

dcon::trigger_key ui::button_data::scriptable_enable

Definition at line 142 of file gui_graphics.hpp.

shortcut

sys::virtual_key ui::button_data::shortcut = sys::virtual_key::NONE

Definition at line 144 of file gui_graphics.hpp.

---

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

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