A menu_button is a styled_widget to choose an element from a list of elements. More...
#include <menu_button.hpp>
Public Member Functions | |
menu_button (const implementation::builder_menu_button &builder) | |
virtual void | set_active (const bool active) override |
See styled_widget::set_active. 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... | |
void | set_values (const std::vector<::config > &values, unsigned selected=0) |
void | set_selected (unsigned selected, bool fire_event=true) |
virtual unsigned | get_value () const override |
Inherited from selectable_item. More... | |
virtual void | set_value (unsigned value, bool fire_event=false) override |
Inherited from selectable_item. More... | |
virtual unsigned | num_states () const override |
Inherited from selectable_item. More... | |
std::string | get_value_string () const |
Returns the value of the selected row. More... | |
const ::config & | get_value_config () const |
Returns the entire config object for the selected row. More... | |
void | set_keep_open (const bool keep_open) |
![]() | |
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... | |
virtual iteration::walker_ptr | create_walker () override |
See widget::create_walker. 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... | |
virtual void | layout_initialize (const bool full_initialization) override |
See widget::layout_initialize. More... | |
virtual void | request_reduce_width (const unsigned maximum_width) override |
See widget::request_reduce_width. More... | |
virtual void | request_reduce_height (const unsigned maximum_height) override |
See widget::request_reduce_height. More... | |
virtual void | place (const point &origin, const point &size) override |
See widget::place. 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... | |
widget * | find (const std::string &id, const bool must_be_active) override |
See widget::find. More... | |
const widget * | find (const std::string &id, const bool must_be_active) const override |
See widget::find. 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 &label) |
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... | |
![]() | |
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... | |
void | set_parent (widget *parent) |
widget * | parent () |
virtual void | demand_reduce_width (const unsigned maximum_width) |
Tries to reduce the width of a widget. More... | |
virtual void | demand_reduce_height (const unsigned maximum_height) |
Tries to reduce the height of a widget. More... | |
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 bool | can_wrap () const |
Can the widget wrap. More... | |
virtual void | set_origin (const point &origin) |
Sets the origin of the 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... | |
virtual void | layout_children () |
Allows a widget to update its children. 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) |
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... | |
virtual void | set_visible_rectangle (const SDL_Rect &rectangle) |
Sets the visible rectangle for a widget. More... | |
void | queue_redraw () |
Indicates that this widget should be redrawn. More... | |
void | queue_redraw (const rect ®ion) |
Indicate that specific region of the screen should be redrawn. More... | |
void | set_visible (const visibility visible) |
visibility | get_visible () const |
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) |
virtual bool | has_widget (const widget &widget) const |
Does the widget contain the widget. More... | |
![]() | |
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 |
![]() | |
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 ¢er, 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... | |
![]() | |
enable_lua_ptr (widget *tp) | |
![]() | |
virtual | ~selectable_item () |
bool | get_value_bool () const |
void | set_value_bool (bool value, bool fire_event=false) |
Static Public Member Functions | |
static const std::string & | type () |
Static type getter that does not rely on the widget being constructed. More... | |
Private Types | |
enum | state_t { ENABLED , DISABLED , PRESSED , FOCUSED } |
Possible states of the widget. More... | |
Private Member Functions | |
void | set_state (const state_t state) |
virtual const std::string & | get_control_type () const override |
Inherited from styled_widget, implemented by REGISTER_WIDGET. More... | |
void | signal_handler_mouse_enter (const event::ui_event event, bool &handled) |
void | signal_handler_mouse_leave (const event::ui_event event, bool &handled) |
void | signal_handler_left_button_down (const event::ui_event event, bool &handled) |
void | signal_handler_left_button_up (const event::ui_event event, bool &handled) |
void | signal_handler_left_button_click (const event::ui_event event, bool &handled) |
void | signal_handler_sdl_wheel_up (const event::ui_event event, bool &handled) |
void | signal_handler_sdl_wheel_down (const event::ui_event event, bool &handled) |
Private Attributes | |
state_t | state_ |
Current state of the widget. More... | |
std::vector<::config > | values_ |
unsigned | selected_ |
bool | keep_open_ |
Additional Inherited Members | |
![]() | |
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 } |
![]() | |
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... | |
![]() | |
virtual point | calculate_best_size () const override |
See widget::calculate_best_size. More... | |
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... | |
virtual bool | impl_draw_background () override |
See widget::impl_draw_background. More... | |
virtual bool | impl_draw_foreground () override |
See widget::impl_draw_foreground. 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 |
![]() | |
void | set_layout_size (const point &size) |
const point & | layout_size () const |
void | clear_layout_size () |
Throws away layout_size_. More... | |
A menu_button is a styled_widget to choose an element from a list of elements.
When a menu_button has a return value it sets the return value for the window. Normally this closes the window and returns this value to the caller. The return value can either be defined by the user or determined from the id of the menu_button. The return value has a higher precedence as the one defined by the id. (Of course it's weird to give a menu_button an id and then override its return value.)
When the menu_button doesn't have a standard id, but you still want to use the return value of that id, use return_value_id instead. This has a higher precedence as return_value.
List with the menu_button specific variables:
Key | Type | Default | Description |
---|---|---|---|
return_value_id | string | "" | The return value id. |
return_value | int | 0 | The return value. |
The following states exist:
Definition at line 61 of file menu_button.hpp.
|
private |
Possible states of the widget.
Note the order of the states must be the same as defined in settings.hpp.
Enumerator | |
---|---|
ENABLED | |
DISABLED | |
PRESSED | |
FOCUSED |
Definition at line 115 of file menu_button.hpp.
|
explicit |
Definition at line 43 of file menu_button.cpp.
References gui2::event::dispatcher::back_post_child, signal_handler_left_button_click(), signal_handler_left_button_down(), signal_handler_left_button_up(), signal_handler_mouse_enter(), signal_handler_mouse_leave(), signal_handler_sdl_wheel_down(), and signal_handler_sdl_wheel_up().
|
overridevirtual |
See styled_widget::get_active.
Implements gui2::styled_widget.
Definition at line 84 of file menu_button.cpp.
References DISABLED, and state_.
Referenced by set_active().
|
overrideprivatevirtual |
Inherited from styled_widget, implemented by REGISTER_WIDGET.
Implements gui2::styled_widget.
|
overridevirtual |
|
inlineoverridevirtual |
Inherited from selectable_item.
Implements gui2::selectable_item.
Definition at line 84 of file menu_button.hpp.
References selected_.
Referenced by gui2::dialogs::addon_manager::get_status_filter_visibility(), gui2::dialogs::preferences_dialog::handle_res_select(), gui2::dialogs::mp_staging::on_ai_select(), gui2::dialogs::mp_staging::on_controller_select(), gui2::dialogs::mp_create_game::on_era_select(), gui2::dialogs::mp_create_game::on_game_select(), gui2::dialogs::addon_manager::order_addons(), gui2::dialogs::mp_report::post_show(), and gui2::dialogs::achievements_dialog::set_achievements_row().
|
inline |
Returns the entire config object for the selected row.
Definition at line 99 of file menu_button.hpp.
References selected_, and values_.
Referenced by gui2::dialogs::game_load::handle_dir_select(), gui2::dialogs::mp_staging::on_team_select(), and gui2::dialogs::unit_create::variation_menu_callback().
|
inline |
Returns the value of the selected row.
Definition at line 93 of file menu_button.hpp.
|
inlineoverridevirtual |
Inherited from selectable_item.
Implements gui2::selectable_item.
Definition at line 90 of file menu_button.hpp.
References values_.
|
overridevirtual |
See styled_widget::set_active.
Implements gui2::styled_widget.
Definition at line 77 of file menu_button.cpp.
References DISABLED, ENABLED, get_active(), and set_state().
Referenced by gui2::dialogs::mp_staging::add_side_node(), gui2::dialogs::preferences_dialog::fullscreen_toggle_callback(), gui2::dialogs::preferences_dialog::initialize_callbacks(), gui2::dialogs::unit_create::list_item_clicked(), gui2::dialogs::mp_staging::network_handler(), gui2::dialogs::addon_manager::on_addon_select(), gui2::dialogs::faction_select::on_faction_select(), and gui2::dialogs::mp_create_game::on_game_select().
|
inline |
Definition at line 104 of file menu_button.hpp.
References keep_open_.
void gui2::menu_button::set_selected | ( | unsigned | selected, |
bool | fire_event = true |
||
) |
Definition at line 203 of file menu_button.cpp.
References gui2::event::dispatcher::fire(), gui2::event::implementation::fire_event(), gui2::event::NOTIFY_MODIFIED, gui2::widget::queue_redraw(), game_config::images::selected, selected_, gui2::styled_widget::set_label(), and values_.
Referenced by gui2::dialogs::mp_options_helper::display_custom_options(), gui2::dialogs::mp_create_game::on_game_select(), gui2::dialogs::achievements_dialog::pre_show(), gui2::dialogs::editor_edit_pbl::pre_show(), gui2::dialogs::mp_lobby::pre_show(), gui2::dialogs::mp_create_game::pre_show(), set_value(), signal_handler_left_button_click(), signal_handler_sdl_wheel_down(), and signal_handler_sdl_wheel_up().
|
private |
Definition at line 94 of file menu_button.cpp.
References gui2::widget::queue_redraw(), and state_.
Referenced by set_active(), signal_handler_left_button_down(), signal_handler_left_button_up(), signal_handler_mouse_enter(), and signal_handler_mouse_leave().
|
inlineoverridevirtual |
Inherited from selectable_item.
Implements gui2::selectable_item.
Definition at line 87 of file menu_button.hpp.
References gui2::event::implementation::fire_event(), and set_selected().
Referenced by gui2::dialogs::addon_manager::on_order_changed(), and gui2::dialogs::mp_create_game::sync_with_depcheck().
void gui2::menu_button::set_values | ( | const std::vector<::config > & | values, |
unsigned | selected = 0 |
||
) |
Definition at line 188 of file menu_button.cpp.
References gui2::widget::queue_redraw(), game_config::images::selected, selected_, gui2::styled_widget::set_label(), and values_.
Referenced by gui2::dialogs::mp_staging::add_side_node(), gui2::dialogs::mp_options_helper::display_custom_options(), gui2::dialogs::preferences_dialog::initialize_callbacks(), gui2::dialogs::unit_create::list_item_clicked(), gui2::dialogs::mp_staging::network_handler(), gui2::dialogs::addon_manager::on_addon_select(), gui2::dialogs::faction_select::on_faction_select(), gui2::dialogs::achievements_dialog::pre_show(), gui2::dialogs::addon_manager::pre_show(), gui2::dialogs::editor_edit_pbl::pre_show(), gui2::dialogs::mp_create_game::pre_show(), gui2::dialogs::statistics_dialog::pre_show(), gui2::dialogs::preferences_dialog::set_resolution_list(), and gui2::dialogs::game_load::set_save_dir_list().
|
private |
Definition at line 139 of file menu_button.cpp.
References DBG_GUI_E, gui2::widget::get_window(), keep_open_, LOG_HEADER, sound::play_UI_sound(), game_config::images::selected, selected_, gui2::dialogs::drop_down_menu::selected_item(), set_selected(), gui2::dialogs::modal_dialog::show(), gui2::settings::sound_button_click, and values_.
Referenced by menu_button().
|
private |
Definition at line 118 of file menu_button.cpp.
References DBG_GUI_E, gui2::widget::get_window(), LOG_HEADER, gui2::window::mouse_capture(), PRESSED, and set_state().
Referenced by menu_button().
|
private |
Definition at line 131 of file menu_button.cpp.
References DBG_GUI_E, FOCUSED, LOG_HEADER, and set_state().
Referenced by menu_button().
|
private |
Definition at line 102 of file menu_button.cpp.
References DBG_GUI_E, FOCUSED, LOG_HEADER, and set_state().
Referenced by menu_button().
|
private |
Definition at line 110 of file menu_button.cpp.
References DBG_GUI_E, ENABLED, LOG_HEADER, and set_state().
Referenced by menu_button().
|
private |
Definition at line 176 of file menu_button.cpp.
References DBG_GUI_E, LOG_HEADER, selected_, set_selected(), and values_.
Referenced by menu_button().
|
private |
Definition at line 164 of file menu_button.cpp.
References DBG_GUI_E, LOG_HEADER, selected_, and set_selected().
Referenced by menu_button().
|
static |
Static type getter that does not rely on the widget being constructed.
|
private |
Definition at line 136 of file menu_button.hpp.
Referenced by set_keep_open(), and signal_handler_left_button_click().
|
private |
Definition at line 134 of file menu_button.hpp.
Referenced by get_value(), get_value_config(), get_value_string(), set_selected(), set_values(), signal_handler_left_button_click(), signal_handler_sdl_wheel_down(), and signal_handler_sdl_wheel_up().
|
private |
Current state of the widget.
The state of the widget determines what to render and how the widget reacts to certain 'events'.
Definition at line 130 of file menu_button.hpp.
Referenced by get_active(), get_state(), and set_state().
|
private |
Definition at line 132 of file menu_button.hpp.
Referenced by get_value_config(), get_value_string(), num_states(), set_selected(), set_values(), signal_handler_left_button_click(), and signal_handler_sdl_wheel_down().