Simple push button. More...
#include <combobox.hpp>
Public Member Functions | |
tcombobox () | |
virtual void | set_active (const bool active) override |
See tcontrol::set_active. More... | |
virtual bool | get_active () const override |
See tcontrol::get_active. More... | |
virtual unsigned | get_state () const override |
See tcontrol::get_state. More... | |
void | connect_click_handler (const event::tsignal_function &signal) |
Inherited from tclickable. More... | |
void | disconnect_click_handler (const event::tsignal_function &signal) |
Inherited from tclickable. More... | |
void | set_retval (const int retval) |
void | set_values (const std::vector< std::string > &values, int selected=0) |
void | set_selected (int selected) |
virtual unsigned | get_value () const override |
Inherited from tselectable_. More... | |
virtual void | set_value (const unsigned value) override |
Inherited from tselectable_. More... | |
virtual unsigned | num_states () const override |
Inherited from tselectable_. More... | |
virtual void | set_callback_state_change (std::function< void(twidget &)> callback) |
Inherited from tselectable_. More... | |
std::string | get_value_string () const |
Returns the value of the selected row. More... | |
![]() | |
tcontrol (const unsigned canvas_count) | |
tcontrol (const implementation::tbuilder_control &builder, const unsigned canvas_count, const std::string &control_type) | |
Constructor. More... | |
virtual void | set_members (const string_map &data) |
Sets the members of the control. More... | |
bool | disable_click_dismiss () const override |
See twidget::disable_click_dismiss. More... | |
virtual iterator::twalker_ * | create_walker () override |
See twidget::create_walker. More... | |
tpoint | get_config_minimum_size () const |
Gets the minimum size as defined in the config. More... | |
tpoint | get_config_default_size () const |
Gets the default size as defined in the config. More... | |
tpoint | 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 std::string | get_link_color () const |
Returns the color string to be used with links. More... | |
virtual void | layout_initialise (const bool full_initialisation) override |
See twidget::layout_initialise. More... | |
virtual void | request_reduce_width (const unsigned maximum_width) override |
See twidget::request_reduce_width. More... | |
virtual void | place (const tpoint &origin, const tpoint &size) override |
See twidget::place. More... | |
virtual twidget * | find_at (const tpoint &coordinate, const bool must_be_active) override |
See twidget::find_at. More... | |
virtual const twidget * | find_at (const tpoint &coordinate, const bool must_be_active) const override |
See twidget::find_at. More... | |
twidget * | find (const std::string &id, const bool must_be_active) override |
See twidget::find. More... | |
const twidget * | find (const std::string &id, const bool must_be_active) const override |
See twidget::find. More... | |
void | set_definition (const std::string &definition) |
Sets the definition. More... | |
bool | get_use_tooltip_on_label_overflow () const |
void | set_use_tooltip_on_label_overflow (const bool use_tooltip=true) |
const t_string & | 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< tcanvas > & | canvas () |
tcanvas & | canvas (const unsigned index) |
void | set_text_alignment (const PangoAlignment text_alignment) |
PangoAlignment | get_text_alignment () const |
![]() | |
twidget () | |
twidget (const tbuilder_widget &builder) | |
Constructor. More... | |
virtual | ~twidget () override |
void | set_id (const std::string &id) |
const std::string & | id () const |
twindow * | get_window () |
Get the parent window. More... | |
const twindow * | get_window () const |
The constant version of get_window. More... | |
tdialog * | dialog () |
Returns the top-level dialogue. More... | |
void | set_parent (twidget *parent) |
twidget * | parent () |
virtual void | demand_reduce_width (const unsigned maximum_width) |
Tries to reduce the width of a widget. More... | |
virtual void | request_reduce_height (const unsigned maximum_height) |
Tries to reduce the height of a widget. More... | |
virtual void | demand_reduce_height (const unsigned maximum_height) |
Tries to reduce the height of a widget. More... | |
tpoint | 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 tpoint &origin) |
Sets the origin of the widget. More... | |
virtual void | set_size (const tpoint &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 | layout_children () |
Allows a widget to update its children. More... | |
tpoint | get_origin () const |
Returns the screen origin of the widget. More... | |
tpoint | 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 (twindow &caller, std::vector< twidget * > &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 tvisible::scoped_enum visible) |
tvisible::scoped_enum | get_visible () const |
tredraw_action::scoped_enum | get_drawing_action () const |
void | set_debug_border_mode (const unsigned debug_border_mode) |
void | set_debug_border_colour (const unsigned debug_border_colour) |
virtual bool | has_widget (const twidget &widget) const |
Does the widget contain the widget. More... | |
![]() | |
tevent_executor () | |
virtual | ~tevent_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 |
tevent_executor & | set_wants_mouse_right_double_click (const bool click=true) |
bool | wants_mouse_right_double_click () const |
![]() | |
tdispatcher () | |
virtual | ~tdispatcher () |
void | connect () |
Connects the dispatcher to the event handler. More... | |
bool | has_event (const tevent event, const tevent_type event_type) |
bool | fire (const tevent event, twidget &target) |
Fires an event which has no extra parameters. More... | |
bool | fire (const tevent event, twidget &target, const tpoint &coordinate) |
Fires an event which takes a coordinate parameter. More... | |
bool | fire (const tevent event, twidget &target, const SDLKey key, const SDLMod modifier, const utf8::string &unicode) |
Fires an event which takes keyboard parameters. More... | |
bool | fire (const tevent event, twidget &target, void *) |
Fires an event which takes notification parameters. More... | |
bool | fire (const tevent event, twidget &target, tmessage &message) |
Fires an event which takes message parameters. More... | |
template<tevent E> | |
boost::enable_if < boost::mpl::has_key < tset_event, boost::mpl::int_ < E > > >::type | connect_signal (const tsignal_function &signal, const tposition position=back_child) |
Connect a signal for callback in tset_event. More... | |
template<tevent E> | |
boost::enable_if < boost::mpl::has_key < tset_event, boost::mpl::int_ < E > > >::type | disconnect_signal (const tsignal_function &signal, const tposition position=back_child) |
Disconnect a signal for callback in tset_event. More... | |
template<tevent E> | |
boost::enable_if < boost::mpl::has_key < tset_event_mouse, boost::mpl::int_< E > > >::type | connect_signal (const tsignal_mouse_function &signal, const tposition position=back_child) |
Connect a signal for callback in tset_event_mouse. More... | |
template<tevent E> | |
boost::enable_if < boost::mpl::has_key < tset_event_mouse, boost::mpl::int_< E > > >::type | disconnect_signal (const tsignal_mouse_function &signal, const tposition position=back_child) |
Disconnect a signal for callback in tset_event_mouse. More... | |
template<tevent E> | |
boost::enable_if < boost::mpl::has_key < tset_event_keyboard, boost::mpl::int_< E > > >::type | connect_signal (const tsignal_keyboard_function &signal, const tposition position=back_child) |
Connect a signal for callback in tset_event_keyboard. More... | |
template<tevent E> | |
boost::enable_if < boost::mpl::has_key < tset_event_keyboard, boost::mpl::int_< E > > >::type | disconnect_signal (const tsignal_keyboard_function &signal, const tposition position=back_child) |
Disconnect a signal for callback in tset_event_keyboard. More... | |
template<tevent E> | |
boost::enable_if < boost::mpl::has_key < tset_event_notification, boost::mpl::int_< E > > >::type | connect_signal (const tsignal_notification_function &signal, const tposition position=back_child) |
Connect a signal for callback in tset_event_notification. More... | |
template<tevent E> | |
boost::enable_if < boost::mpl::has_key < tset_event_notification, boost::mpl::int_< E > > >::type | disconnect_signal (const tsignal_notification_function &signal, const tposition position=back_child) |
Disconnect a signal for callback in tset_event_notification. More... | |
template<tevent E> | |
boost::enable_if < boost::mpl::has_key < tset_event_message, boost::mpl::int_< E > > >::type | connect_signal (const tsignal_message_function &signal, const tposition position=back_child) |
Connect a signal for callback in tset_event_message. More... | |
template<tevent E> | |
boost::enable_if < boost::mpl::has_key < tset_event_message, boost::mpl::int_< E > > >::type | disconnect_signal (const tsignal_message_function &signal, const tposition position=back_child) |
Disconnect a signal for callback in tset_event_message. More... | |
void | capture_mouse () |
Captures the mouse. More... | |
void | release_mouse () |
Releases the mouse capture. More... | |
void | set_mouse_behavior (const tmouse_behavior mouse_behavior) |
tmouse_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 thotkey_function &function) |
Registers a hotkey. More... | |
bool | execute_hotkey (const hotkey::HOTKEY_COMMAND id) |
Executes a hotkey. More... | |
![]() | |
virtual | ~tselectable_ () |
bool | get_value_bool () const |
void | set_value_bool (const bool value) |
Public Attributes | |
std::function< void(twidget &)> | callback_state_change_ |
See tselectable_::set_callback_state_change. More... | |
Private Types | |
enum | tstate { ENABLED, DISABLED, PRESSED, FOCUSED, COUNT } |
Possible states of the widget. More... | |
Private Member Functions | |
void | set_state (const tstate state) |
virtual const std::string & | get_control_type () const override |
See tcontrol::get_control_type. More... | |
void | signal_handler_mouse_enter (const event::tevent event, bool &handled) |
void | signal_handler_mouse_leave (const event::tevent event, bool &handled) |
void | signal_handler_left_button_down (const event::tevent event, bool &handled) |
void | signal_handler_left_button_up (const event::tevent event, bool &handled) |
void | signal_handler_left_button_click (const event::tevent event, bool &handled) |
Private Attributes | |
tstate | state_ |
Current state of the widget. More... | |
int | retval_ |
The return value of the button. More... | |
std::vector< std::string > | values_ |
int | selected_ |
std::function< void(twidget &)> | selected_callback_ |
Additional Inherited Members | |
![]() | |
enum | tevent_type { pre = 1, child = 2, post = 4 } |
enum | tposition { 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 | tmouse_behavior { all, hit, none } |
The behavior of the mouse events. More... | |
![]() | |
virtual tpoint | calculate_best_size () const override |
See twidget::calculate_best_size. More... | |
tresolution_definition_ptr | config () |
tresolution_definition_const_ptr | config () const |
void | set_config (tresolution_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 twidget::impl_draw_background. More... | |
virtual void | impl_draw_foreground (surface &frame_buffer, int x_offset, int y_offset) override |
See twidget::impl_draw_foreground. More... | |
std::string | get_label_token (const gui2::tpoint &position, const char *delimiters=" \n\r\t") const |
Exposes font::ttext::get_token, for the text label of this control. More... | |
std::string | get_label_link (const gui2::tpoint &position) const |
![]() | |
void | set_layout_size (const tpoint &size) |
const tpoint & | layout_size () const |
Simple push button.
Definition at line 31 of file combobox.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 | |
COUNT |
Definition at line 95 of file combobox.hpp.
gui2::tcombobox::tcombobox | ( | ) |
Definition at line 41 of file combobox.cpp.
References signal_handler_left_button_click(), signal_handler_left_button_down(), signal_handler_left_button_up(), signal_handler_mouse_enter(), and signal_handler_mouse_leave().
|
inline |
Inherited from tclickable.
Definition at line 48 of file combobox.hpp.
References gui2::event::connect_signal_mouse_left_click().
Referenced by gui2::tpreferences::initialize_members().
|
inline |
Inherited from tclickable.
Definition at line 54 of file combobox.hpp.
References gui2::event::disconnect_signal_mouse_left_click().
|
overridevirtual |
See tcontrol::get_active.
Implements gui2::tcontrol.
Definition at line 71 of file combobox.cpp.
References DISABLED, and state_.
Referenced by set_active().
|
overrideprivatevirtual |
See tcontrol::get_control_type.
Implements gui2::tcontrol.
Definition at line 89 of file combobox.cpp.
|
overridevirtual |
See tcontrol::get_state.
Implements gui2::tcontrol.
Definition at line 76 of file combobox.cpp.
References state_.
|
inlineoverridevirtual |
Inherited from tselectable_.
Implements gui2::tselectable_.
Definition at line 72 of file combobox.hpp.
References selected_.
Referenced by gui2::tpreferences::handle_res_select(), and gui2::tpreferences::simple_combobox_callback().
|
inline |
Returns the value of the selected row.
Definition at line 87 of file combobox.hpp.
References selected_, and values_.
Referenced by gui2::disambiguate_widget_value().
|
inlineoverridevirtual |
Inherited from tselectable_.
Implements gui2::tselectable_.
Definition at line 78 of file combobox.hpp.
References values_.
|
overridevirtual |
See tcontrol::set_active.
Implements gui2::tcontrol.
Definition at line 64 of file combobox.cpp.
References DISABLED, ENABLED, get_active(), and set_state().
Referenced by gui2::tpreferences::fullscreen_toggle_callback(), and gui2::tpreferences::initialize_members().
|
inlinevirtual |
Inherited from tselectable_.
Implements gui2::tselectable_.
Definition at line 81 of file combobox.hpp.
References selected_callback_.
Definition at line 61 of file combobox.hpp.
References retval_.
Referenced by gui2::implementation::tbuilder_combobox::build().
Definition at line 177 of file combobox.cpp.
References game_config::images::selected, selected_, gui2::twidget::set_is_dirty(), gui2::tcontrol::set_label(), and values_.
Referenced by set_value().
Definition at line 81 of file combobox.cpp.
References gui2::twidget::set_is_dirty(), 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 tselectable_.
Implements gui2::tselectable_.
Definition at line 75 of file combobox.hpp.
References set_selected().
void gui2::tcombobox::set_values | ( | const std::vector< std::string > & | values, |
int | selected = 0 |
||
) |
Definition at line 165 of file combobox.cpp.
References game_config::images::selected, selected_, gui2::twidget::set_is_dirty(), gui2::tcontrol::set_label(), and values_.
Referenced by gui2::implementation::tbuilder_combobox::build(), gui2::set_resolution_list(), and gui2::tpreferences::setup_combobox().
|
private |
Definition at line 136 of file combobox.cpp.
References DBG_GUI_E, gui2::twidget::get_rectangle(), gui2::tcontrol::get_use_markup(), gui2::twidget::get_window(), LOG_HEADER, sound::play_UI_sound(), retval_, selected_, selected_callback_, gui2::tdrop_down_list::selected_item(), gui2::tcontrol::set_label(), gui2::twindow::set_retval(), gui2::tdialog::show(), gui2::settings::sound_button_click, and values_.
Referenced by tcombobox().
|
private |
Definition at line 113 of file combobox.cpp.
References DBG_GUI_E, gui2::twidget::get_window(), LOG_HEADER, gui2::twindow::mouse_capture(), PRESSED, and set_state().
Referenced by tcombobox().
|
private |
Definition at line 127 of file combobox.cpp.
References DBG_GUI_E, FOCUSED, LOG_HEADER, and set_state().
Referenced by tcombobox().
|
private |
Definition at line 95 of file combobox.cpp.
References DBG_GUI_E, FOCUSED, LOG_HEADER, and set_state().
Referenced by tcombobox().
|
private |
Definition at line 104 of file combobox.cpp.
References DBG_GUI_E, ENABLED, LOG_HEADER, and set_state().
Referenced by tcombobox().
See tselectable_::set_callback_state_change.
Definition at line 69 of file combobox.hpp.
|
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 118 of file combobox.hpp.
Referenced by set_retval(), and signal_handler_left_button_click().
|
private |
Definition at line 124 of file combobox.hpp.
Referenced by get_value(), get_value_string(), set_selected(), set_values(), and signal_handler_left_button_click().
Definition at line 126 of file combobox.hpp.
Referenced by set_callback_state_change(), and signal_handler_left_button_click().
|
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 110 of file combobox.hpp.
Referenced by get_active(), get_state(), and set_state().
|
private |
Definition at line 121 of file combobox.hpp.
Referenced by get_value_string(), num_states(), set_selected(), set_values(), and signal_handler_left_button_click().