hotkey Namespace Reference

Keyboard shortcuts for game actions. More...


Classes

class  hotkey_item
class  manager
class  command_executor
struct  basic_handler

Enumerations

enum  HOTKEY_COMMAND {
  HOTKEY_CYCLE_UNITS, HOTKEY_CYCLE_BACK_UNITS, HOTKEY_UNIT_HOLD_POSITION, HOTKEY_END_UNIT_TURN,
  HOTKEY_LEADER, HOTKEY_UNDO, HOTKEY_REDO, HOTKEY_ZOOM_IN,
  HOTKEY_ZOOM_OUT, HOTKEY_ZOOM_DEFAULT, HOTKEY_FULLSCREEN, HOTKEY_SCREENSHOT,
  HOTKEY_MAP_SCREENSHOT, HOTKEY_ACCELERATED, HOTKEY_UNIT_DESCRIPTION, HOTKEY_RENAME_UNIT,
  HOTKEY_SAVE_GAME, HOTKEY_SAVE_REPLAY, HOTKEY_SAVE_MAP, HOTKEY_LOAD_GAME,
  HOTKEY_RECRUIT, HOTKEY_REPEAT_RECRUIT, HOTKEY_RECALL, HOTKEY_ENDTURN,
  HOTKEY_TOGGLE_GRID, HOTKEY_STATUS_TABLE, HOTKEY_MUTE, HOTKEY_MOUSE_SCROLL,
  HOTKEY_SPEAK, HOTKEY_CREATE_UNIT, HOTKEY_CHANGE_UNIT_SIDE, HOTKEY_PREFERENCES,
  HOTKEY_OBJECTIVES, HOTKEY_UNIT_LIST, HOTKEY_STATISTICS, HOTKEY_QUIT_GAME,
  HOTKEY_LABEL_TEAM_TERRAIN, HOTKEY_LABEL_TERRAIN, HOTKEY_CLEAR_LABELS, HOTKEY_SHOW_ENEMY_MOVES,
  HOTKEY_BEST_ENEMY_MOVES, HOTKEY_DELAY_SHROUD, HOTKEY_UPDATE_SHROUD, HOTKEY_CONTINUE_MOVE,
  HOTKEY_SEARCH, HOTKEY_SPEAK_ALLY, HOTKEY_SPEAK_ALL, HOTKEY_HELP,
  HOTKEY_CHAT_LOG, HOTKEY_LANGUAGE, HOTKEY_PLAY_REPLAY, HOTKEY_RESET_REPLAY,
  HOTKEY_STOP_REPLAY, HOTKEY_REPLAY_NEXT_TURN, HOTKEY_REPLAY_NEXT_SIDE, HOTKEY_REPLAY_SHOW_EVERYTHING,
  HOTKEY_REPLAY_SHOW_EACH, HOTKEY_REPLAY_SHOW_TEAM1, HOTKEY_REPLAY_SKIP_ANIMATION, HOTKEY_EDIT_SET_TERRAIN,
  HOTKEY_EDIT_QUIT, HOTKEY_EDIT_SAVE_MAP, HOTKEY_EDIT_SAVE_AS, HOTKEY_EDIT_SET_START_POS,
  HOTKEY_EDIT_NEW_MAP, HOTKEY_EDIT_LOAD_MAP, HOTKEY_EDIT_FLOOD_FILL, HOTKEY_EDIT_FILL_SELECTION,
  HOTKEY_EDIT_ROTATE_SELECTION, HOTKEY_EDIT_CUT, HOTKEY_EDIT_COPY, HOTKEY_EDIT_PASTE,
  HOTKEY_EDIT_REVERT, HOTKEY_EDIT_RESIZE, HOTKEY_EDIT_FLIP, HOTKEY_EDIT_SELECT_ALL,
  HOTKEY_EDIT_DRAW, HOTKEY_EDIT_REFRESH, HOTKEY_EDIT_UPDATE, HOTKEY_EDIT_AUTO_UPDATE,
  HOTKEY_USER_CMD, HOTKEY_CUSTOM_CMD, HOTKEY_AI_FORMULA, HOTKEY_CLEAR_MSG,
  HOTKEY_NULL
}
enum  ACTION_STATE { ACTION_STATELESS, ACTION_ON, ACTION_OFF }

Functions

static void key_event_execute (display &disp, const SDL_KeyboardEvent &event, command_executor *executor)
void load_descriptions ()
void load_hotkeys (const config &cfg)
void save_hotkeys (config &cfg)
hotkey_itemget_hotkey (HOTKEY_COMMAND id)
hotkey_itemget_hotkey (const std::string &command)
hotkey_itemget_hotkey (int character, int keycode, bool shift, bool ctrl, bool alt, bool cmd)
hotkey_itemget_hotkey (const SDL_KeyboardEvent &event)
static void _get_visible_hotkey_itor (int index, std::vector< hotkey_item >::iterator &itor)
hotkey_itemget_visible_hotkey (int index)
std::vector< hotkey_item > & get_hotkeys ()
void key_event (display &disp, const SDL_KeyboardEvent &event, command_executor *executor)
void execute_command (display &disp, HOTKEY_COMMAND command, command_executor *executor, int index)

Variables

const std::string CLEARED_TEXT = "__none__"


Detailed Description

Keyboard shortcuts for game actions.

Hotkey commands can be loaded from configuration objects. When a keyboard event corresponding to a hotkey occurs, a command_executor object can execute the hotkeys actions. For this to work, key_event() must be called whenever a keyboard event happens.


Enumeration Type Documentation

Enumerator:
ACTION_STATELESS 
ACTION_ON 
ACTION_OFF 

Definition at line 169 of file hotkeys.hpp.

Enumerator:
HOTKEY_CYCLE_UNITS 
HOTKEY_CYCLE_BACK_UNITS 
HOTKEY_UNIT_HOLD_POSITION 
HOTKEY_END_UNIT_TURN 
HOTKEY_LEADER 
HOTKEY_UNDO 
HOTKEY_REDO 
HOTKEY_ZOOM_IN 
HOTKEY_ZOOM_OUT 
HOTKEY_ZOOM_DEFAULT 
HOTKEY_FULLSCREEN 
HOTKEY_SCREENSHOT 
HOTKEY_MAP_SCREENSHOT 
HOTKEY_ACCELERATED 
HOTKEY_UNIT_DESCRIPTION 
HOTKEY_RENAME_UNIT 
HOTKEY_SAVE_GAME 
HOTKEY_SAVE_REPLAY 
HOTKEY_SAVE_MAP 
HOTKEY_LOAD_GAME 
HOTKEY_RECRUIT 
HOTKEY_REPEAT_RECRUIT 
HOTKEY_RECALL 
HOTKEY_ENDTURN 
HOTKEY_TOGGLE_GRID 
HOTKEY_STATUS_TABLE 
HOTKEY_MUTE 
HOTKEY_MOUSE_SCROLL 
HOTKEY_SPEAK 
HOTKEY_CREATE_UNIT 
HOTKEY_CHANGE_UNIT_SIDE 
HOTKEY_PREFERENCES 
HOTKEY_OBJECTIVES 
HOTKEY_UNIT_LIST 
HOTKEY_STATISTICS 
HOTKEY_QUIT_GAME 
HOTKEY_LABEL_TEAM_TERRAIN 
HOTKEY_LABEL_TERRAIN 
HOTKEY_CLEAR_LABELS 
HOTKEY_SHOW_ENEMY_MOVES 
HOTKEY_BEST_ENEMY_MOVES 
HOTKEY_DELAY_SHROUD 
HOTKEY_UPDATE_SHROUD 
HOTKEY_CONTINUE_MOVE 
HOTKEY_SEARCH 
HOTKEY_SPEAK_ALLY 
HOTKEY_SPEAK_ALL 
HOTKEY_HELP 
HOTKEY_CHAT_LOG 
HOTKEY_LANGUAGE 
HOTKEY_PLAY_REPLAY 
HOTKEY_RESET_REPLAY 
HOTKEY_STOP_REPLAY 
HOTKEY_REPLAY_NEXT_TURN 
HOTKEY_REPLAY_NEXT_SIDE 
HOTKEY_REPLAY_SHOW_EVERYTHING 
HOTKEY_REPLAY_SHOW_EACH 
HOTKEY_REPLAY_SHOW_TEAM1 
HOTKEY_REPLAY_SKIP_ANIMATION 
HOTKEY_EDIT_SET_TERRAIN 
HOTKEY_EDIT_QUIT 
HOTKEY_EDIT_SAVE_MAP 
HOTKEY_EDIT_SAVE_AS 
HOTKEY_EDIT_SET_START_POS 
HOTKEY_EDIT_NEW_MAP 
HOTKEY_EDIT_LOAD_MAP 
HOTKEY_EDIT_FLOOD_FILL 
HOTKEY_EDIT_FILL_SELECTION 
HOTKEY_EDIT_ROTATE_SELECTION 
HOTKEY_EDIT_CUT 
HOTKEY_EDIT_COPY 
HOTKEY_EDIT_PASTE 
HOTKEY_EDIT_REVERT 
HOTKEY_EDIT_RESIZE 
HOTKEY_EDIT_FLIP 
HOTKEY_EDIT_SELECT_ALL 
HOTKEY_EDIT_DRAW 
HOTKEY_EDIT_REFRESH 
HOTKEY_EDIT_UPDATE 
HOTKEY_EDIT_AUTO_UPDATE 
HOTKEY_USER_CMD 
HOTKEY_CUSTOM_CMD 
HOTKEY_AI_FORMULA 
HOTKEY_CLEAR_MSG 
HOTKEY_NULL 

Definition at line 31 of file hotkeys.hpp.


Function Documentation

static void hotkey::_get_visible_hotkey_itor ( int  index,
std::vector< hotkey_item >::iterator &  itor 
) [static]

Definition at line 477 of file hotkeys.cpp.

References hotkeys_.

Referenced by get_visible_hotkey().

void hotkey::execute_command ( display disp,
HOTKEY_COMMAND  command,
command_executor *  executor,
int  index 
)

hotkey_item & hotkey::get_hotkey ( const SDL_KeyboardEvent &  event  ) 

Definition at line 464 of file hotkeys.cpp.

References get_hotkey().

hotkey_item & hotkey::get_hotkey ( int  character,
int  keycode,
bool  shift,
bool  ctrl,
bool  alt,
bool  cmd 
)

hotkey_item & hotkey::get_hotkey ( const std::string &  command  ) 

Definition at line 393 of file hotkeys.cpp.

References hotkeys_, and null_hotkey_.

hotkey_item & hotkey::get_hotkey ( HOTKEY_COMMAND  id  ) 

std::vector< hotkey_item > & hotkey::get_hotkeys (  ) 

Definition at line 502 of file hotkeys.cpp.

References hotkeys_.

Referenced by preferences::show_hotkeys_dialog().

hotkey_item & hotkey::get_visible_hotkey ( int  index  ) 

Definition at line 491 of file hotkeys.cpp.

References _get_visible_hotkey_itor(), hotkeys_, and null_hotkey_.

Referenced by preferences::show_hotkeys_dialog().

void hotkey::key_event ( display disp,
const SDL_KeyboardEvent &  event,
command_executor *  executor 
)

void hotkey::key_event_execute ( display disp,
const SDL_KeyboardEvent &  event,
command_executor *  executor 
) [static]

void hotkey::load_descriptions (  ) 

void hotkey::load_hotkeys ( const config cfg  ) 

void hotkey::save_hotkeys ( config cfg  ) 


Variable Documentation

const std::string hotkey::CLEARED_TEXT = "__none__"

Definition at line 161 of file hotkeys.cpp.

Referenced by hotkey::hotkey_item::load_from_config(), and save_hotkeys().


Generated by doxygen 1.5.5 on 23 May 2008 for The Battle for Wesnoth
Gna! | Forum | Wiki | CIA | devdocs