OpenTTD
Public Types | Public Member Functions | Data Fields | Private Member Functions | Private Attributes
HotkeyList Struct Reference

List of hotkeys for a window. More...

#include <hotkeys.h>

Public Types

typedef EventState(* GlobalHotkeyHandlerFunc) (int hotkey)
 

Public Member Functions

 HotkeyList (const char *ini_group, Hotkey *items, GlobalHotkeyHandlerFunc global_hotkey_handler=NULL)
 
void Load (IniFile *ini)
 Load HotkeyList from IniFile. More...
 
void Save (IniFile *ini) const
 Save HotkeyList to IniFile. More...
 
int CheckMatch (uint16 keycode, bool global_only=false) const
 Check if a keycode is bound to something. More...
 

Data Fields

GlobalHotkeyHandlerFunc global_hotkey_handler
 

Private Member Functions

 HotkeyList (const HotkeyList &other)
 Dummy private copy constructor to prevent compilers from copying the structure, which fails due to _hotkey_lists.
 

Private Attributes

const char * ini_group
 
Hotkeyitems
 

Detailed Description

List of hotkeys for a window.

Definition at line 42 of file hotkeys.h.

Member Function Documentation

◆ CheckMatch()

int HotkeyList::CheckMatch ( uint16  keycode,
bool  global_only = false 
) const

Check if a keycode is bound to something.

Parameters
keycodeThe keycode that was pressed
global_onlyLimit the search to hotkeys defined as 'global'.
Returns
The number of the matching hotkey or -1.

Definition at line 300 of file hotkeys.cpp.

References WKC_GLOBAL_HOTKEY.

Referenced by IsQuitKey().

◆ Load()

void HotkeyList::Load ( IniFile ini)

Load HotkeyList from IniFile.

Parameters
iniIniFile to load from.

Definition at line 269 of file hotkeys.cpp.

References IniLoadFile::GetGroup(), IniGroup::GetItem(), ParseHotkeys(), and IniItem::value.

◆ Save()

void HotkeyList::Save ( IniFile ini) const

Save HotkeyList to IniFile.

Parameters
iniIniFile to save to.

Definition at line 285 of file hotkeys.cpp.

References IniLoadFile::GetGroup(), IniGroup::GetItem(), SaveKeycodes(), and IniItem::SetValue().


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