The Battle for Wesnoth  1.15.13+dev
Public Member Functions | Private Member Functions | Private Attributes | List of all members
gui2::dialogs::hotkey_bind Class Reference

#include <hotkey_bind.hpp>

Inheritance diagram for gui2::dialogs::hotkey_bind:

Public Member Functions

 hotkey_bind (const std::string &hotkey_id)
 
hotkey::hotkey_ptr get_new_binding () const
 
- Public Member Functions inherited from gui2::dialogs::modal_dialog
 modal_dialog ()
 
virtual ~modal_dialog ()
 
bool show (const unsigned auto_close_time=0)
 Shows the window. More...
 
windowget_window () const
 Returns a pointer to the dialog's window. More...
 
int get_retval () const
 Returns the cached window exit code. More...
 
void set_retval (int retval)
 Convenience wrapper to set the window's exit code. More...
 
void set_always_save_fields (const bool always_save_fields)
 
void set_restore (const bool restore)
 
void set_allow_plugin_skip (const bool allow_plugin_skip)
 
void set_show_even_without_video (const bool show_even_without_video)
 

Private Member Functions

void sdl_event_callback (const SDL_Event &event)
 
virtual const std::string & window_id () const override
 The id of the window to build. More...
 
virtual void pre_show (window &window) override
 Actions to be taken before showing the window. More...
 

Private Attributes

const std::string & hotkey_id_
 
hotkey::hotkey_ptr new_binding_
 

Additional Inherited Members

- Protected Member Functions inherited from gui2::dialogs::modal_dialog
field_boolregister_bool (const std::string &id, const bool mandatory, const std::function< bool()> callback_load_value=nullptr, const std::function< void(bool)> callback_save_value=nullptr, const std::function< void(widget &)> callback_change=nullptr, const bool initial_fire=false)
 Creates a new boolean field. More...
 
field_boolregister_bool (const std::string &id, const bool mandatory, bool &linked_variable, const std::function< void(widget &)> callback_change=nullptr, const bool initial_fire=false)
 Creates a new boolean field. More...
 
field_integerregister_integer (const std::string &id, const bool mandatory, const std::function< int()> callback_load_value=nullptr, const std::function< void(int)> callback_save_value=nullptr)
 Creates a new integer field. More...
 
field_integerregister_integer (const std::string &id, const bool mandatory, int &linked_variable)
 Creates a new integer field. More...
 
field_textregister_text (const std::string &id, const bool mandatory, const std::function< std::string()> callback_load_value=nullptr, const std::function< void(const std::string &)> callback_save_value=nullptr, const bool capture_focus=false)
 Creates a new text field. More...
 
field_textregister_text (const std::string &id, const bool mandatory, std::string &linked_variable, const bool capture_focus=false)
 Creates a new text field. More...
 
field_labelregister_label (const std::string &id, const bool mandatory, const std::string &text, const bool use_markup=false)
 Registers a new styled_widget as a label. More...
 
field_labelregister_image (const std::string &id, const bool mandatory, const std::string &filename)
 Registers a new styled_widget as image. More...
 
- Protected Attributes inherited from gui2::dialogs::modal_dialog
std::unique_ptr< windowwindow_
 The window object build for this dialog. More...
 

Detailed Description

Definition at line 26 of file hotkey_bind.hpp.

Constructor & Destructor Documentation

◆ hotkey_bind()

gui2::dialogs::hotkey_bind::hotkey_bind ( const std::string &  hotkey_id)
explicit

Definition at line 28 of file hotkey_bind.cpp.

Member Function Documentation

◆ get_new_binding()

hotkey::hotkey_ptr gui2::dialogs::hotkey_bind::get_new_binding ( ) const
inline

Definition at line 31 of file hotkey_bind.hpp.

References new_binding_.

Referenced by gui2::dialogs::preferences_dialog::add_hotkey_callback().

◆ pre_show()

void gui2::dialogs::hotkey_bind::pre_show ( window window)
overrideprivatevirtual

Actions to be taken before showing the window.

At this point the registered fields are registered and initialized with their initial values.

Parameters
windowThe window to be shown.

Reimplemented from gui2::dialogs::modal_dialog.

Definition at line 35 of file hotkey_bind.cpp.

References gui2::event::dispatcher::connect_signal(), gui2::event::dispatcher::front_child, sdl_event_callback(), and gui2::event::SDL_RAW_EVENT.

◆ sdl_event_callback()

void gui2::dialogs::hotkey_bind::sdl_event_callback ( const SDL_Event &  event)
private

◆ window_id()

virtual const std::string& gui2::dialogs::hotkey_bind::window_id ( ) const
overrideprivatevirtual

The id of the window to build.

Implements gui2::dialogs::modal_dialog.

Member Data Documentation

◆ hotkey_id_

const std::string& gui2::dialogs::hotkey_bind::hotkey_id_
private

Definition at line 37 of file hotkey_bind.hpp.

Referenced by sdl_event_callback().

◆ new_binding_

hotkey::hotkey_ptr gui2::dialogs::hotkey_bind::new_binding_
private

Definition at line 39 of file hotkey_bind.hpp.

Referenced by get_new_binding(), and sdl_event_callback().


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