The Battle for Wesnoth  1.15.1+dev
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
hotkey::hotkey_mouse Class Reference

This class is responsible for handling mouse button presses. More...

#include <hotkey_item.hpp>

Inheritance diagram for hotkey::hotkey_mouse:
Inheritance graph

Public Member Functions

 hotkey_mouse ()
 Initialise new instance of this class that has no button associated with is. More...
 
virtual bool valid () const
 Returns true if the hotkey has a valid mouse button associated with it. More...
 
void set_button (int button)
 
- Public Member Functions inherited from hotkey::hotkey_base
 hotkey_base ()
 Initialises a new empty hotkey that will be disabled. More...
 
void set_command (const std::string &command)
 
void set_mods (unsigned int mods)
 Set keyboard modifiers. More...
 
const std::string & get_command () const
 Returns the string name of the HOTKEY_COMMAND. More...
 
const std::string get_description () const
 Returns the translated description. More...
 
virtual bool hidden () const
 This controls whether the item should appear in the hotkey preferences. More...
 
bool is_default () const
 This indicates whether a hotkey is from the default config or if it's from the user preferences. More...
 
void unset_default ()
 Used to indicate that a hotkey is overridden and should be treated as a user-set hotkey. More...
 
bool is_disabled () const
 
void disable ()
 
void enable ()
 
void clear ()
 Unbind this hotkey by linking it to the null-command. More...
 
bool null () const
 Returns whether this hotkey points to the null-command. More...
 
bool active () const
 
void save (config &cfg) const
 Save the hotkey into the configuration object. More...
 
const std::string get_name () const
 Return "name" of hotkey. More...
 
bool matches (const SDL_Event &event) const
 Used to evaluate whether: More...
 
virtual bool bindings_equal (hotkey_ptr other)
 Checks whether the hotkey bindings and scope are equal. More...
 
virtual ~hotkey_base ()
 

Protected Member Functions

virtual void save_helper (config &cfg) const
 
virtual const std::string get_name_helper () const
 This is invoked by hotkey_base::get_name and must be implemented by subclasses. More...
 
virtual bool matches_helper (const SDL_Event &event) const
 This is invoked by hotkey_base::matches as a helper for the concrete classes. More...
 
virtual bool bindings_equal_helper (hotkey_ptr other) const
 This is invoked by hotkey_base::bindings_equal as a helper for the concrete classes. More...
 

Protected Attributes

int button_
 
- Protected Attributes inherited from hotkey::hotkey_base
std::string command_
 The command that should be executed, or "null". More...
 
bool is_default_
 is_default_ is true if the hot-key is part of the default hot-key list defined in data/core/hotkeys.cfg. More...
 
bool is_disabled_
 
unsigned int mod_
 

Detailed Description

This class is responsible for handling mouse button presses.

Definition at line 312 of file hotkey_item.hpp.

Constructor & Destructor Documentation

◆ hotkey_mouse()

hotkey::hotkey_mouse::hotkey_mouse ( )
inline

Initialise new instance of this class that has no button associated with is.

Definition at line 318 of file hotkey_item.hpp.

Member Function Documentation

◆ bindings_equal_helper()

bool hotkey::hotkey_mouse::bindings_equal_helper ( hotkey_ptr  other) const
protectedvirtual

This is invoked by hotkey_base::bindings_equal as a helper for the concrete classes.

Implementing classes should only check their parts of the hotkey.

Parameters
otherThe other hotkey the check against. Not guaranteed to be the same subclass.
Returns
true if they match, false otherwise.

Implements hotkey::hotkey_base.

Definition at line 326 of file hotkey_item.cpp.

References button_.

◆ get_name_helper()

const std::string hotkey::hotkey_mouse::get_name_helper ( ) const
protectedvirtual

This is invoked by hotkey_base::get_name and must be implemented by subclasses.

Keyboard modifiers are handled in this class, other hotkeys in the respective classes

Implements hotkey::hotkey_base.

Definition at line 285 of file hotkey_item.cpp.

◆ matches_helper()

bool hotkey::hotkey_mouse::matches_helper ( const SDL_Event &  event) const
protectedvirtual

This is invoked by hotkey_base::matches as a helper for the concrete classes.

Implementing classes should only check their parts of the hotkey.

Parameters
eventThe SDL_Event being generated.
Returns
true if they match, false otherwise.

Implements hotkey::hotkey_base.

Definition at line 264 of file hotkey_item.cpp.

References hotkey::hotkey_base::mod_, and hotkey::sdl_get_mods().

◆ save_helper()

void hotkey::hotkey_mouse::save_helper ( config cfg) const
protectedvirtual

Implements hotkey::hotkey_base.

Definition at line 290 of file hotkey_item.cpp.

◆ set_button()

void hotkey::hotkey_mouse::set_button ( int  button)
inline

Definition at line 331 of file hotkey_item.hpp.

◆ valid()

virtual bool hotkey::hotkey_mouse::valid ( ) const
inlinevirtual

Returns true if the hotkey has a valid mouse button associated with it.

Returns
true if a mouse button is set, false otherwise.

Implements hotkey::hotkey_base.

Definition at line 325 of file hotkey_item.hpp.

Member Data Documentation

◆ button_

int hotkey::hotkey_mouse::button_
protected

Definition at line 336 of file hotkey_item.hpp.

Referenced by bindings_equal_helper().


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