ScummVM API documentation
Common::KeymapperDefaultBindings Class Reference
Inheritance diagram for Common::KeymapperDefaultBindings:
Common::HashMap< String, StringArray >

Public Member Functions

void setDefaultBinding (String keymapId, String actionId, String hwInputId)
 
void addDefaultBinding (String keymapId, String actionId, String hwInputId)
 
const_iterator findDefaultBinding (String keymapId, String actionId) const
 
- Public Member Functions inherited from Common::HashMap< String, StringArray >
 HashMap ()
 
 HashMap (const HM_t &map)
 
 ~HashMap ()
 
HM_toperator= (const HM_t &map)
 
bool contains (const String &key) const
 
StringArrayoperator[] (const String &key)
 
const StringArrayoperator[] (const String &key) const
 
StringArraygetOrCreateVal (const String &key)
 
StringArraygetVal (const String &key)
 
const StringArraygetVal (const String &key) const
 
const StringArraygetValOrDefault (const String &key) const
 
const StringArraygetValOrDefault (const String &key, const StringArray &defaultVal) const
 
bool tryGetVal (const String &key, StringArray &out) const
 
void setVal (const String &key, const StringArray &val)
 
void clear (bool shrinkArray=0)
 
void erase (iterator entry)
 
void erase (const String &key)
 
size_type size () const
 
iterator begin ()
 
const_iterator begin () const
 
iterator end ()
 
const_iterator end () const
 
iterator find (const String &key)
 
const_iterator find (const String &key) const
 
bool empty () const
 

Additional Inherited Members

- Public Types inherited from Common::HashMap< String, StringArray >
typedef uint size_type
 
typedef IteratorImpl< Nodeiterator
 
typedef IteratorImpl< const Nodeconst_iterator
 

Member Function Documentation

◆ setDefaultBinding()

void Common::KeymapperDefaultBindings::setDefaultBinding ( String  keymapId,
String  actionId,
String  hwInputId 
)
inline

This sets a default hwInput for a given Keymap Action

Parameters
keymapIdString representing Keymap id (Keymap.name)
actionIdString representing Action id (Action.id)
hwInputIdString representing the HardwareInput id (HardwareInput.id)

◆ addDefaultBinding()

void Common::KeymapperDefaultBindings::addDefaultBinding ( String  keymapId,
String  actionId,
String  hwInputId 
)
inline

This adds a default hwInput for a given Keymap Action

Parameters
keymapIdString representing Keymap id (Keymap.name)
actionIdString representing Action id (Action.id)
hwInputIdString representing the HardwareInput id (HardwareInput.id)

◆ findDefaultBinding()

const_iterator Common::KeymapperDefaultBindings::findDefaultBinding ( String  keymapId,
String  actionId 
) const
inline

This retrieves the assigned default hwKey for a given Keymap Action

Parameters
keymapIdString representing Keymap id (Keymap.name)
actionIdString representing Action id (Action.id)
Returns
StringArray representing the list of HardwareInput ids (HardwareInput.id) that are mapped to Keymap Action

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