The Battle for Wesnoth  1.13.10+dev
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
gui2::multimenu_button Class Reference

Simple push button. More...

#include <multimenu_button.hpp>

Inheritance diagram for gui2::multimenu_button:
Inheritance graph

Public Member Functions

 multimenu_button (const implementation::builder_multimenu_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 connect_click_handler (const event::signal_function &signal)
 Inherited from clickable_item. More...
 
void disconnect_click_handler (const event::signal_function &signal)
 Inherited from clickable_item. More...
 
void set_retval (const int retval)
 
void set_max_shown (const int max)
 Sets the maximum number of selected elements shown on the label. More...
 
int get_max_shown ()
 Get the maximum number of selected elements shown on the label. More...
 
unsigned num_options ()
 Get the number of options available in the menu. More...
 
void select_option (const unsigned option, const bool selected=true)
 Select an option in the menu. More...
 
void select_options (boost::dynamic_bitset<> states)
 Set the options selected in the menu. More...
 
void set_values (const std::vector<::config > &values)
 Set the available menu options. More...
 
boost::dynamic_bitset get_toggle_states () const
 Get the current state of the menu options. More...
 
void reset_toggle_states ()
 Deselect all the menu options. More...
 
- Public Member Functions inherited from gui2::styled_widget
 styled_widget (const implementation::builder_styled_widget &builder, const std::string &control_type)
 Constructor. More...
 
virtual void set_members (const string_map &data)
 Sets the members of the styled_widget. More...
 
bool disable_click_dismiss () const override
 See widget::disable_click_dismiss. More...
 
virtual iteration::walker_basecreate_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 widgetfind_at (const point &coordinate, const bool must_be_active) override
 See widget::find_at. More...
 
virtual const widgetfind_at (const point &coordinate, const bool must_be_active) const override
 See widget::find_at. More...
 
widgetfind (const std::string &id, const bool must_be_active) override
 See widget::find. More...
 
const widgetfind (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_stringget_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_stringtooltip () const
 
void set_tooltip (const t_string &tooltip)
 
const t_stringhelp_message () const
 
void set_help_message (const t_string &help_message)
 
std::vector< canvas > & get_canvases ()
 
canvasget_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...
 
- Public Member Functions inherited from gui2::widget
 widget (const widget &)=delete
 
widgetoperator= (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
 
windowget_window ()
 Get the parent window. More...
 
const windowget_window () const
 The constant version of get_window. More...
 
gridget_parent_grid ()
 Get the parent grid. More...
 
dialogs::modal_dialogdialog ()
 Returns the top-level dialog. More...
 
void set_parent (widget *parent)
 
widgetparent ()
 
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...
 
SDL_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 int x_offset, const int y_offset)
 Calculates the blitting rectangle of the widget. More...
 
SDL_Rect calculate_clipping_rectangle (const int x_offset, const int y_offset)
 Calculates the clipping rectangle of the widget. More...
 
void draw_background (surface &frame_buffer, int x_offset, int y_offset)
 Draws the background of a widget. More...
 
void draw_children (surface &frame_buffer, int x_offset, int y_offset)
 Draws the children of a widget. More...
 
void draw_foreground (surface &frame_buffer, int x_offset, int y_offset)
 Draws the foreground of the widget. More...
 
void populate_dirty_list (window &caller, std::vector< widget * > &call_stack)
 Adds a widget to the dirty list if it is dirty. 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 set_is_dirty (const bool is_dirty)
 
bool get_is_dirty () const
 
void set_visible (const visibility visible)
 
visibility get_visible () const
 
redraw_action get_drawing_action () const
 
void set_debug_border_mode (const unsigned 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...
 
- Public Member Functions inherited from gui2::event_executor
 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_executorset_wants_mouse_right_double_click (const bool click=true)
 
bool wants_mouse_right_double_click () const
 
- Public Member Functions inherited from gui2::event::dispatcher
 dispatcher ()
 
virtual ~dispatcher ()
 
void connect ()
 Connects the dispatcher to the event handler. 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 utf8::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 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, 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>
utils::enable_if_t< has_key
< set_event, E >::value > 
connect_signal (const signal_function &signal, const queue_position position=back_child)
 Connect a signal for callback in set_event. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event, E >::value > 
disconnect_signal (const signal_function &signal, const queue_position position=back_child)
 Disconnect a signal for callback in set_event. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_mouse, E >::value > 
connect_signal (const signal_mouse_function &signal, const queue_position position=back_child)
 Connect a signal for callback in set_event_mouse. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_mouse, E >::value > 
disconnect_signal (const signal_mouse_function &signal, const queue_position position=back_child)
 Disconnect a signal for callback in set_event_mouse. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_keyboard, E >
::value > 
connect_signal (const signal_keyboard_function &signal, const queue_position position=back_child)
 Connect a signal for callback in set_event_keyboard. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_keyboard, E >
::value > 
disconnect_signal (const signal_keyboard_function &signal, const queue_position position=back_child)
 Disconnect a signal for callback in set_event_keyboard. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_touch, E >::value > 
connect_signal (const signal_touch_function &signal, const queue_position position=back_child)
 Connect a signal for callback in set_event_touch. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_touch, E >::value > 
disconnect_signal (const signal_touch_function &signal, const queue_position position=back_child)
 Disconnect a signal for callback in set_event_touch. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_notification, E >
::value > 
connect_signal (const signal_notification_function &signal, const queue_position position=back_child)
 Connect a signal for callback in set_event_notification. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_notification, E >
::value > 
disconnect_signal (const signal_notification_function &signal, const queue_position position=back_child)
 Disconnect a signal for callback in set_event_notification. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_message, E >
::value > 
connect_signal (const signal_message_function &signal, const queue_position position=back_child)
 Connect a signal for callback in set_event_message. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_message, E >
::value > 
disconnect_signal (const signal_message_function &signal, const queue_position position=back_child)
 Disconnect a signal for callback in set_event_message. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_raw_event, E >
::value > 
connect_signal (const signal_raw_event_function &signal, const queue_position position=back_child)
 Connect a signal for callback in set_raw_event. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_raw_event, E >
::value > 
disconnect_signal (const signal_raw_event_function &signal, const queue_position position=back_child)
 Disconnect a signal for callback in set_raw_event. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_text_input, E >
::value > 
connect_signal (const signal_text_input_function &signal, const queue_position position=back_child)
 Connect a signal for callback in set_text_input. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_text_input, E >
::value > 
disconnect_signal (const signal_text_input_function &signal, const queue_position position=back_child)
 Disconnect a signal for callback in set_text_input. 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...
 

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)
 
void update_config_from_toggle_states ()
 
void update_label ()
 
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 toggle_state_changed ()
 

Private Attributes

state_t state_
 Current state of the widget. More...
 
int retval_
 The return value of the button. More...
 
int max_shown_
 The maximum number of selected states to list in the label. More...
 
std::vector<::configvalues_
 
boost::dynamic_bitset toggle_states_
 
dialogs::drop_down_menudroplist_
 

Additional Inherited Members

- Public Types inherited from gui2::widget
enum  visibility { visibility::visible, visibility::hidden, visibility::invisible }
 Visibility settings done by the user. More...
 
enum  redraw_action { redraw_action::full, redraw_action::partly, redraw_action::none }
 Visibility set by the engine. More...
 
- Public Types inherited from gui2::event::dispatcher
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  mouse_behavior { all, hit, none }
 The behavior of the mouse events. More...
 
- Protected Member Functions inherited from gui2::styled_widget
virtual point calculate_best_size () const override
 See widget::calculate_best_size. More...
 
resolution_definition_ptr config ()
 
resolution_definition_const_ptr 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...
 
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 void impl_draw_background (surface &frame_buffer, int x_offset, int y_offset) override
 See widget::impl_draw_background. More...
 
virtual void impl_draw_foreground (surface &frame_buffer, int x_offset, int y_offset) 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
 
- Protected Member Functions inherited from gui2::widget
void set_layout_size (const point &size)
 
const pointlayout_size () const
 
void clear_layout_size ()
 Throws away layout_size_. More...
 

Detailed Description

Simple push button.

Definition at line 41 of file multimenu_button.hpp.

Member Enumeration Documentation

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 150 of file multimenu_button.hpp.

Constructor & Destructor Documentation

gui2::multimenu_button::multimenu_button ( const implementation::builder_multimenu_button builder)
explicit

Member Function Documentation

void gui2::multimenu_button::connect_click_handler ( const event::signal_function signal)
inline

Inherited from clickable_item.

Definition at line 58 of file multimenu_button.hpp.

References gui2::event::connect_signal_mouse_left_click().

void gui2::multimenu_button::disconnect_click_handler ( const event::signal_function signal)
inline

Inherited from clickable_item.

Definition at line 64 of file multimenu_button.hpp.

References gui2::event::disconnect_signal_mouse_left_click().

bool gui2::multimenu_button::get_active ( ) const
overridevirtual

See styled_widget::get_active.

Implements gui2::styled_widget.

Definition at line 73 of file multimenu_button.cpp.

References DISABLED, and state_.

Referenced by set_active().

virtual const std::string& gui2::multimenu_button::get_control_type ( ) const
overrideprivatevirtual

Inherited from styled_widget, implemented by REGISTER_WIDGET.

Implements gui2::styled_widget.

int gui2::multimenu_button::get_max_shown ( )
inline

Get the maximum number of selected elements shown on the label.

Returns
The maximum number of elements to show

Definition at line 92 of file multimenu_button.hpp.

References max_shown_.

unsigned gui2::multimenu_button::get_state ( ) const
overridevirtual

See styled_widget::get_state.

Implements gui2::styled_widget.

Definition at line 78 of file multimenu_button.cpp.

References state_.

boost::dynamic_bitset gui2::multimenu_button::get_toggle_states ( ) const
inline

Get the current state of the menu options.

Returns
A mask specifying which options are selected

Definition at line 134 of file multimenu_button.hpp.

References toggle_states_.

Referenced by gui2::dialogs::addon_manager::get_type_filter_visibility(), and gui2::dialogs::preferences_dialog::hotkey_type_filter_callback().

unsigned gui2::multimenu_button::num_options ( )
inline

Get the number of options available in the menu.

Returns
The number of options in the menu

Definition at line 102 of file multimenu_button.hpp.

References values_.

void gui2::multimenu_button::reset_toggle_states ( )

Deselect all the menu options.

Definition at line 195 of file multimenu_button.cpp.

References toggle_states_, update_config_from_toggle_states(), and update_label().

void gui2::multimenu_button::select_option ( const unsigned  option,
const bool  selected = true 
)

Select an option in the menu.

Parameters
optionThe option to select
selectedTrue to select it, or false to deselect it

Definition at line 211 of file multimenu_button.cpp.

References game_config::images::selected, toggle_states_, update_config_from_toggle_states(), update_label(), and values_.

void gui2::multimenu_button::select_options ( boost::dynamic_bitset<>  states)

Set the options selected in the menu.

Parameters
statesA mask specifying which options to select and deselect

Definition at line 223 of file multimenu_button.cpp.

References toggle_states_, update_config_from_toggle_states(), update_label(), and values_.

Referenced by gui2::dialogs::campaign_selection::pre_show().

void gui2::multimenu_button::set_active ( const bool  active)
overridevirtual
void gui2::multimenu_button::set_max_shown ( const int  max)
inline

Sets the maximum number of selected elements shown on the label.

If more are selected, the label will say "and N others".

Parameters
maxThe maximum number of elements to show

Definition at line 82 of file multimenu_button.hpp.

References max_shown_.

Referenced by gui2::implementation::builder_multimenu_button::build().

void gui2::multimenu_button::set_retval ( const int  retval)
inline

Definition at line 71 of file multimenu_button.hpp.

References retval_.

Referenced by gui2::implementation::builder_multimenu_button::build().

void gui2::multimenu_button::set_state ( const state_t  state)
private
void gui2::multimenu_button::set_values ( const std::vector<::config > &  values)
void gui2::multimenu_button::signal_handler_left_button_click ( const event::ui_event  event,
bool &  handled 
)
private
void gui2::multimenu_button::signal_handler_left_button_down ( const event::ui_event  event,
bool &  handled 
)
private
void gui2::multimenu_button::signal_handler_left_button_up ( const event::ui_event  event,
bool &  handled 
)
private

Definition at line 120 of file multimenu_button.cpp.

References DBG_GUI_E, FOCUSED, LOG_HEADER, and set_state().

Referenced by multimenu_button().

void gui2::multimenu_button::signal_handler_mouse_enter ( const event::ui_event  event,
bool &  handled 
)
private

Definition at line 91 of file multimenu_button.cpp.

References DBG_GUI_E, FOCUSED, LOG_HEADER, and set_state().

Referenced by multimenu_button().

void gui2::multimenu_button::signal_handler_mouse_leave ( const event::ui_event  event,
bool &  handled 
)
private

Definition at line 99 of file multimenu_button.cpp.

References DBG_GUI_E, ENABLED, LOG_HEADER, and set_state().

Referenced by multimenu_button().

void gui2::multimenu_button::toggle_state_changed ( )
private
void gui2::multimenu_button::update_config_from_toggle_states ( )
private
void gui2::multimenu_button::update_label ( )
private

Member Data Documentation

dialogs::drop_down_menu* gui2::multimenu_button::droplist_
private

Definition at line 184 of file multimenu_button.hpp.

Referenced by signal_handler_left_button_click(), and toggle_state_changed().

int gui2::multimenu_button::max_shown_
private

The maximum number of selected states to list in the label.

Definition at line 178 of file multimenu_button.hpp.

Referenced by get_max_shown(), set_max_shown(), and update_label().

int gui2::multimenu_button::retval_
private

The return value of the button.

If this value is not 0 and the button is clicked it sets the retval of the window and the window closes itself.

Definition at line 173 of file multimenu_button.hpp.

Referenced by set_retval(), and signal_handler_left_button_click().

state_t gui2::multimenu_button::state_
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 165 of file multimenu_button.hpp.

Referenced by get_active(), get_state(), and set_state().

boost::dynamic_bitset gui2::multimenu_button::toggle_states_
private
std::vector<::config> gui2::multimenu_button::values_
private

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