playsingle_controller::hotkey_handler Class Reference

#include <hotkey_handler_sp.hpp>

Inheritance diagram for playsingle_controller::hotkey_handler:

Public Member Functions
	hotkey_handler (playsingle_controller &, saved_game &)
	~hotkey_handler ()
virtual void	recruit ()
virtual void	repeat_recruit ()
virtual void	recall ()
virtual bool	can_execute_command (const hotkey::hotkey_command &command, int index=-1) const
	Check if a command can be executed. More...
virtual void	toggle_shroud_updates ()
virtual void	update_shroud_now ()
virtual void	end_turn ()
virtual void	rename_unit ()
virtual void	create_unit ()
virtual void	change_side ()
virtual void	kill_unit ()
virtual void	label_terrain (bool)
virtual void	clear_labels ()
virtual void	label_settings ()
virtual void	continue_move ()
virtual void	unit_hold_position ()
virtual void	end_unit_turn ()
virtual void	user_command ()
virtual void	custom_command ()
virtual void	ai_formula ()
virtual void	clear_messages ()
virtual void	whiteboard_toggle ()
virtual void	whiteboard_execute_action ()
virtual void	whiteboard_execute_all_actions ()
virtual void	whiteboard_delete_action ()
virtual void	whiteboard_bump_up_action ()
virtual void	whiteboard_bump_down_action ()
virtual void	whiteboard_suppose_dead ()
replay_controller &	get_replay_controller ()
virtual void	stop_replay () override
virtual void	play_replay () override
virtual void	replay_next_turn () override
virtual void	replay_next_side () override
virtual void	replay_next_move () override
virtual void	replay_show_everything () override
virtual void	replay_show_each () override
virtual void	replay_show_team1 () override
virtual void	reset_replay () override
virtual void	replay_exit () override
virtual void	load_autosave (const std::string &filename)
virtual hotkey::ACTION_STATE	get_action_state (hotkey::HOTKEY_COMMAND command, int index) const
Public Member Functions inherited from play_controller::hotkey_handler
	hotkey_handler (play_controller &, saved_game &)
	~hotkey_handler ()
virtual void	objectives ()
virtual void	show_statistics ()
virtual void	unit_list ()
virtual void	left_mouse_click ()
virtual void	move_action ()
virtual void	select_and_action ()
virtual void	select_hex ()
virtual void	deselect_hex ()
virtual void	right_mouse_click ()
virtual void	status_table ()
virtual void	save_game ()
virtual void	save_replay ()
virtual void	save_map ()
virtual void	load_game ()
virtual void	preferences ()
virtual void	show_chat_log ()
virtual void	show_help ()
virtual void	cycle_units ()
virtual void	cycle_back_units ()
virtual void	undo ()
virtual void	redo ()
virtual void	show_enemy_moves (bool ignore_units)
virtual void	goto_leader ()
virtual void	unit_description ()
virtual void	terrain_description ()
virtual void	toggle_ellipses ()
virtual void	toggle_grid ()
virtual void	search ()
virtual void	toggle_accelerated_speed ()
virtual void	scroll_up (bool on)
virtual void	scroll_down (bool on)
virtual void	scroll_left (bool on)
virtual void	scroll_right (bool on)
virtual void	replay_skip_animation () override
virtual std::string	get_action_image (hotkey::HOTKEY_COMMAND, int index) const
virtual bool	execute_command (const hotkey::hotkey_command &command, int index=-1, bool press=true)
void	show_menu (const std::vector< std::string > &items_arg, int xloc, int yloc, bool context_menu, display &disp)
bool	in_context_menu (hotkey::HOTKEY_COMMAND command) const
	Determines whether the command should be in the context menu or not. More...
Public Member Functions inherited from hotkey::command_executor_default
CVideo &	get_video ()
void	set_button_state ()
void	recalculate_minimap ()
void	lua_console ()
void	zoom_in ()
void	zoom_out ()
void	zoom_default ()
void	map_screenshot ()
void	quit_to_main_menu ()
Public Member Functions inherited from hotkey::command_executor
virtual void	speak ()
virtual void	whisper ()
virtual void	shout ()
virtual void	stop_network ()
virtual void	start_network ()
virtual void	change_language ()
std::string	get_menu_image (display &disp, const std::string &command, int index=-1) const
std::vector< std::string >	get_menu_images (display &, const std::vector< std::string > &items_arg)
void	execute_action (const std::vector< std::string > &items_arg, int xloc, int yloc, bool context_menu, display &gui)

Protected Member Functions
bool	is_observer () const
Protected Member Functions inherited from play_controller::hotkey_handler
display &	get_display ()
game_display *	gui () const
game_state &	gamestate ()
const game_state &	gamestate () const
bool	browse () const
bool	linger () const
const team &	viewing_team () const
bool	viewing_team_is_playing () const
Protected Member Functions inherited from hotkey::command_executor
virtual	~command_executor ()

Protected Attributes
playsingle_controller &	playsingle_controller_
boost::shared_ptr< wb::manager >	whiteboard_manager_
Protected Attributes inherited from play_controller::hotkey_handler
play_controller &	play_controller_
	References to parent object / constituents. More...
events::menu_handler &	menu_handler_
events::mouse_handler &	mouse_handler_
saved_game &	saved_game_

Additional Inherited Members
Static Public Attributes inherited from play_controller::hotkey_handler
static const std::string	wml_menu_hotkey_prefix = "wml_menu:"
Static Protected Attributes inherited from hotkey::command_executor_default
static const int	zoom_amount = 4

Detailed Description

Definition at line 31 of file hotkey_handler_sp.hpp.

Constructor & Destructor Documentation

playsingle_controller::hotkey_handler::hotkey_handler	(	playsingle_controller &	pc,
		saved_game &	sg
	)

Definition at line 33 of file hotkey_handler_sp.cpp.

playsingle_controller::hotkey_handler::~hotkey_handler

(

)

Definition at line 39 of file hotkey_handler_sp.cpp.

Member Function Documentation

void playsingle_controller::hotkey_handler::ai_formula ( )

virtual

Reimplemented from hotkey::command_executor.

Definition at line 122 of file hotkey_handler_sp.cpp.

References events::menu_handler::ai_formula(), and play_controller::menu_handler_.

bool playsingle_controller::hotkey_handler::can_execute_command ( const hotkey::hotkey_command &  command, int  index = -1  ) const

virtual

Check if a command can be executed.

Reimplemented from play_controller::hotkey_handler.

Reimplemented in playmp_controller::hotkey_handler.

Definition at line 193 of file hotkey_handler_sp.cpp.

References play_controller::hotkey_handler::can_execute_command(), hotkey::hotkey_command::command, events::commands_disabled, events::menu_handler::current_unit(), game_config::debug, game_events::wmi_container::end(), game_events::wmi_container::find(), play_controller::gamestate(), events::mouse_handler::get_last_hex(), events::mouse_handler::get_selected_hex(), game_state::get_wml_menu_items(), hotkey::HOTKEY_CHANGE_SIDE, hotkey::HOTKEY_CLEAR_LABELS, hotkey::HOTKEY_CONTINUE_MOVE, hotkey::HOTKEY_CREATE_UNIT, hotkey::HOTKEY_DELAY_SHROUD, hotkey::HOTKEY_END_UNIT_TURN, hotkey::HOTKEY_ENDTURN, hotkey::HOTKEY_KILL_UNIT, hotkey::HOTKEY_LABEL_TEAM_TERRAIN, hotkey::HOTKEY_LABEL_TERRAIN, hotkey::HOTKEY_RECALL, hotkey::HOTKEY_RECRUIT, hotkey::HOTKEY_REPEAT_RECRUIT, hotkey::HOTKEY_REPLAY_EXIT, hotkey::HOTKEY_REPLAY_NEXT_MOVE, hotkey::HOTKEY_REPLAY_NEXT_SIDE, hotkey::HOTKEY_REPLAY_NEXT_TURN, hotkey::HOTKEY_REPLAY_PLAY, hotkey::HOTKEY_REPLAY_RESET, hotkey::HOTKEY_REPLAY_SHOW_EACH, hotkey::HOTKEY_REPLAY_SHOW_EVERYTHING, hotkey::HOTKEY_REPLAY_SHOW_TEAM1, hotkey::HOTKEY_REPLAY_SKIP_ANIMATION, hotkey::HOTKEY_REPLAY_STOP, hotkey::HOTKEY_UNIT_HOLD_POSITION, hotkey::HOTKEY_UPDATE_SHROUD, hotkey::HOTKEY_WB_BUMP_DOWN_ACTION, hotkey::HOTKEY_WB_BUMP_UP_ACTION, hotkey::HOTKEY_WB_DELETE_ACTION, hotkey::HOTKEY_WB_EXECUTE_ACTION, hotkey::HOTKEY_WB_EXECUTE_ALL_ACTIONS, hotkey::HOTKEY_WB_SUPPOSE_DEAD, hotkey::HOTKEY_WB_TOGGLE, hotkey::HOTKEY_WML, i, hotkey::hotkey_command::id, terrain_label::immutable(), play_controller::is_observer(), playsingle_controller::linger(), play_controller::menu_handler_, play_controller::mouse_handler_, unit_map::iterator_base< iter_types >::valid(), and play_controller::whiteboard_manager_.

Referenced by playmp_controller::hotkey_handler::can_execute_command().

void playsingle_controller::hotkey_handler::change_side ( )

virtual

Reimplemented from hotkey::command_executor.

Definition at line 84 of file hotkey_handler_sp.cpp.

References events::menu_handler::change_side(), play_controller::menu_handler_, and play_controller::mouse_handler_.

void playsingle_controller::hotkey_handler::clear_labels ( )

virtual

Reimplemented from hotkey::command_executor.

Definition at line 96 of file hotkey_handler_sp.cpp.

References events::menu_handler::clear_labels(), and play_controller::menu_handler_.

void playsingle_controller::hotkey_handler::clear_messages ( )

virtual

Reimplemented from hotkey::command_executor.

Definition at line 126 of file hotkey_handler_sp.cpp.

References events::menu_handler::clear_messages(), and play_controller::menu_handler_.

void playsingle_controller::hotkey_handler::continue_move ( )

virtual

Reimplemented from hotkey::command_executor.

Definition at line 100 of file hotkey_handler_sp.cpp.

References events::menu_handler::continue_move(), play_controller::menu_handler_, and play_controller::mouse_handler_.

void playsingle_controller::hotkey_handler::create_unit ( )

virtual

Reimplemented from hotkey::command_executor.

Definition at line 80 of file hotkey_handler_sp.cpp.

References events::menu_handler::create_unit(), play_controller::menu_handler_, and play_controller::mouse_handler_.

void playsingle_controller::hotkey_handler::custom_command ( )

virtual

Reimplemented from hotkey::command_executor.

Definition at line 118 of file hotkey_handler_sp.cpp.

References events::menu_handler::custom_command(), and play_controller::menu_handler_.

void playsingle_controller::hotkey_handler::end_turn ( )

virtual

Reimplemented from hotkey::command_executor.

Definition at line 72 of file hotkey_handler_sp.cpp.

void playsingle_controller::hotkey_handler::end_unit_turn ( )

virtual

Reimplemented from hotkey::command_executor.

Definition at line 109 of file hotkey_handler_sp.cpp.

References events::menu_handler::end_unit_turn(), play_controller::menu_handler_, and play_controller::mouse_handler_.

hotkey::ACTION_STATE playsingle_controller::hotkey_handler::get_action_state ( hotkey::HOTKEY_COMMAND  command, int  index  ) const

virtual

Reimplemented from play_controller::hotkey_handler.

Definition at line 183 of file hotkey_handler_sp.cpp.

References hotkey::ACTION_OFF, hotkey::ACTION_ON, play_controller::hotkey_handler::get_action_state(), hotkey::HOTKEY_WB_TOGGLE, and play_controller::whiteboard_manager_.

replay_controller& playsingle_controller::hotkey_handler::get_replay_controller ( )

inline

Definition at line 75 of file hotkey_handler_sp.hpp.

References playsingle_controller::get_replay_controller().

Referenced by play_replay(), replay_next_move(), replay_next_side(), replay_next_turn(), replay_show_each(), replay_show_everything(), replay_show_team1(), and stop_replay().

bool playsingle_controller::hotkey_handler::is_observer ( ) const

protected

Definition at line 41 of file hotkey_handler_sp.cpp.

void playsingle_controller::hotkey_handler::kill_unit ( )

virtual

Reimplemented from hotkey::command_executor.

Definition at line 88 of file hotkey_handler_sp.cpp.

References events::menu_handler::kill_unit(), play_controller::menu_handler_, and play_controller::mouse_handler_.

void playsingle_controller::hotkey_handler::label_settings ( )

virtual

Reimplemented from hotkey::command_executor.

Definition at line 130 of file hotkey_handler_sp.cpp.

References events::menu_handler::label_settings(), and play_controller::menu_handler_.

void playsingle_controller::hotkey_handler::label_terrain ( bool  team_only )

virtual

Reimplemented from hotkey::command_executor.

Definition at line 92 of file hotkey_handler_sp.cpp.

References events::menu_handler::label_terrain(), play_controller::menu_handler_, and play_controller::mouse_handler_.

void playsingle_controller::hotkey_handler::load_autosave ( const std::string &  filename )

virtual

Reimplemented from play_controller::hotkey_handler.

Definition at line 298 of file hotkey_handler_sp.cpp.

References _(), config::child_or_empty(), play_controller::hotkey_handler::load_autosave(), savegame::read_save_file(), and gui2::show_error_message().

virtual void playsingle_controller::hotkey_handler::play_replay ( )

inlineoverridevirtual

Reimplemented from hotkey::command_executor.

Definition at line 82 of file hotkey_handler_sp.hpp.

References get_replay_controller(), and replay_controller::play_replay().

void playsingle_controller::hotkey_handler::recall ( )

virtual

Reimplemented from hotkey::command_executor.

Definition at line 57 of file hotkey_handler_sp.cpp.

References events::mouse_handler::get_last_hex(), play_controller::menu_handler_, play_controller::mouse_handler_, events::menu_handler::recall(), and play_controller::whiteboard_manager_.

void playsingle_controller::hotkey_handler::recruit ( )

virtual

Reimplemented from hotkey::command_executor.

Definition at line 43 of file hotkey_handler_sp.cpp.

References events::mouse_handler::get_last_hex(), play_controller::menu_handler_, play_controller::mouse_handler_, events::menu_handler::recruit(), and play_controller::whiteboard_manager_.

void playsingle_controller::hotkey_handler::rename_unit ( )

virtual

Reimplemented from hotkey::command_executor.

Definition at line 76 of file hotkey_handler_sp.cpp.

References play_controller::menu_handler_, and events::menu_handler::rename_unit().

void playsingle_controller::hotkey_handler::repeat_recruit ( )

virtual

Reimplemented from hotkey::command_executor.

Definition at line 50 of file hotkey_handler_sp.cpp.

References events::mouse_handler::get_last_hex(), play_controller::menu_handler_, play_controller::mouse_handler_, events::menu_handler::repeat_recruit(), and play_controller::whiteboard_manager_.

void playsingle_controller::hotkey_handler::replay_exit ( )

overridevirtual

Reimplemented from hotkey::command_executor.

Definition at line 321 of file hotkey_handler_sp.cpp.

References replay::delete_upcoming_commands(), and resources::recorder.

virtual void playsingle_controller::hotkey_handler::replay_next_move ( )

inlineoverridevirtual

Reimplemented from hotkey::command_executor.

Definition at line 88 of file hotkey_handler_sp.hpp.

References get_replay_controller(), and replay_controller::replay_next_move().

virtual void playsingle_controller::hotkey_handler::replay_next_side ( )

inlineoverridevirtual

Reimplemented from hotkey::command_executor.

Definition at line 86 of file hotkey_handler_sp.hpp.

References get_replay_controller(), and replay_controller::replay_next_side().

virtual void playsingle_controller::hotkey_handler::replay_next_turn ( )

inlineoverridevirtual

Reimplemented from hotkey::command_executor.

Definition at line 84 of file hotkey_handler_sp.hpp.

References get_replay_controller(), and replay_controller::replay_next_turn().

virtual void playsingle_controller::hotkey_handler::replay_show_each ( )

inlineoverridevirtual

Reimplemented from hotkey::command_executor.

Definition at line 92 of file hotkey_handler_sp.hpp.

References get_replay_controller(), and replay_controller::replay_show_each().

virtual void playsingle_controller::hotkey_handler::replay_show_everything ( )

inlineoverridevirtual

Reimplemented from hotkey::command_executor.

Definition at line 90 of file hotkey_handler_sp.hpp.

References get_replay_controller(), and replay_controller::replay_show_everything().

virtual void playsingle_controller::hotkey_handler::replay_show_team1 ( )

inlineoverridevirtual

Reimplemented from hotkey::command_executor.

Definition at line 94 of file hotkey_handler_sp.hpp.

References get_replay_controller(), and replay_controller::replay_show_team1().

virtual void playsingle_controller::hotkey_handler::reset_replay ( )

inlineoverridevirtual

Reimplemented from hotkey::command_executor.

Definition at line 96 of file hotkey_handler_sp.hpp.

References playsingle_controller::reset_replay().

virtual void playsingle_controller::hotkey_handler::stop_replay ( )

inlineoverridevirtual

Reimplemented from hotkey::command_executor.

Definition at line 80 of file hotkey_handler_sp.hpp.

References get_replay_controller(), and replay_controller::stop_replay().

void playsingle_controller::hotkey_handler::toggle_shroud_updates ( )

virtual

Reimplemented from hotkey::command_executor.

Definition at line 64 of file hotkey_handler_sp.cpp.

References play_controller::menu_handler_, and events::menu_handler::toggle_shroud_updates().

void playsingle_controller::hotkey_handler::unit_hold_position ( )

virtual

Reimplemented from hotkey::command_executor.

Definition at line 104 of file hotkey_handler_sp.cpp.

References play_controller::menu_handler_, play_controller::mouse_handler_, and events::menu_handler::unit_hold_position().

void playsingle_controller::hotkey_handler::update_shroud_now ( )

virtual

Reimplemented from hotkey::command_executor.

Definition at line 68 of file hotkey_handler_sp.cpp.

References play_controller::menu_handler_, and events::menu_handler::update_shroud_now().

void playsingle_controller::hotkey_handler::user_command ( )

virtual

Reimplemented from hotkey::command_executor.

Definition at line 114 of file hotkey_handler_sp.cpp.

References play_controller::menu_handler_, and events::menu_handler::user_command().

void playsingle_controller::hotkey_handler::whiteboard_bump_down_action ( )

virtual

Reimplemented from hotkey::command_executor.

Definition at line 167 of file hotkey_handler_sp.cpp.

References play_controller::whiteboard_manager_.

void playsingle_controller::hotkey_handler::whiteboard_bump_up_action ( )

virtual

Reimplemented from hotkey::command_executor.

Definition at line 162 of file hotkey_handler_sp.cpp.

References play_controller::whiteboard_manager_.

void playsingle_controller::hotkey_handler::whiteboard_delete_action ( )

virtual

Reimplemented from hotkey::command_executor.

Definition at line 158 of file hotkey_handler_sp.cpp.

References play_controller::whiteboard_manager_.

void playsingle_controller::hotkey_handler::whiteboard_execute_action ( )

virtual

Reimplemented from hotkey::command_executor.

Definition at line 150 of file hotkey_handler_sp.cpp.

References play_controller::whiteboard_manager_.

void playsingle_controller::hotkey_handler::whiteboard_execute_all_actions ( )

virtual

Reimplemented from hotkey::command_executor.

Definition at line 154 of file hotkey_handler_sp.cpp.

References play_controller::whiteboard_manager_.

void playsingle_controller::hotkey_handler::whiteboard_suppose_dead ( )

virtual

Reimplemented from hotkey::command_executor.

Definition at line 172 of file hotkey_handler_sp.cpp.

References events::menu_handler::current_unit(), unit::get_location(), play_controller::menu_handler_, and play_controller::whiteboard_manager_.

void playsingle_controller::hotkey_handler::whiteboard_toggle ( )

virtual

Reimplemented from hotkey::command_executor.

Definition at line 134 of file hotkey_handler_sp.cpp.

References _(), hotkey::hotkey_command::get_command_by_command(), hotkey::get_names(), hotkey::HOTKEY_WB_TOGGLE, font::NORMAL_COLOR, vgettext(), and play_controller::whiteboard_manager_.

Member Data Documentation

playsingle_controller& playsingle_controller::hotkey_handler::playsingle_controller_

protected

Definition at line 34 of file hotkey_handler_sp.hpp.

boost::shared_ptr<wb::manager> playsingle_controller::hotkey_handler::whiteboard_manager_

protected

Definition at line 36 of file hotkey_handler_sp.hpp.

---

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

• hotkey/hotkey_handler_sp.hpp
• hotkey/hotkey_handler_sp.cpp