#include <controller_base.hpp>

Inheritance diagram for controller_base:

Public Member Functions
	controller_base (const config &game_config, CVideo &video)

virtual	~controller_base ()

void	play_slice (bool is_delay_enabled=true)

void	apply_keyboard_scroll (int x, int y)

void	set_scroll_up (bool on)

void	set_scroll_down (bool on)

void	set_scroll_left (bool on)

void	set_scroll_right (bool on)

Public Member Functions inherited from events::sdl_handler
virtual void	process_event ()

virtual void	draw ()

virtual void	volatile_draw ()

virtual void	volatile_undraw ()

virtual bool	requires_event_focus (const SDL_Event *=nullptr) const

virtual void	process_help_string (int, int)

virtual void	process_tooltip_string (int, int)

virtual void	join ()

virtual void	join (context &c)

virtual void	join_same (sdl_handler *parent)

virtual void	leave ()

virtual void	join_global ()

virtual void	leave_global ()

Static Public Member Functions
static const config &	get_theme (const config &game_config, std::string theme_name)

Protected Member Functions
virtual bool	is_browsing () const

virtual events::mouse_handler_base &	get_mouse_handler_base ()=0
	Get a reference to a mouse handler member a derived class uses. More...

virtual display &	get_display ()=0
	Get a reference to a display member a derived class uses. More...

virtual soundsource::manager *	get_soundsource_man ()
	Get (optionally) a soundsources manager a derived class uses. More...

virtual plugins_context *	get_plugins_context ()
	Get (optionally) a plugins context a derived class uses. More...

virtual hotkey::command_executor *	get_hotkey_command_executor ()
	Get (optionally) a command executor to handle context menu events. More...

virtual bool	have_keyboard_focus ()
	Derived classes should override this to return false when arrow keys should not scroll the map, hotkeys not processed etc, for example when a textbox is active. More...

virtual std::vector< std::string >	additional_actions_pressed ()

bool	handle_scroll (int mousex, int mousey, int mouse_flags, double joystickx, double joysticky)
	Handle scrolling by keyboard, joystick and moving mouse near map edges. More...

void	handle_event (const SDL_Event &event)
	Process mouse- and keypress-events from SDL. More...

void	handle_window_event (const SDL_Event &)

virtual void	process_focus_keydown_event (const SDL_Event &event)
	Process keydown (only when the general map display does not have focus). More...

virtual void	process_keydown_event (const SDL_Event &event)
	Process keydown (always). More...

virtual void	process_keyup_event (const SDL_Event &event)
	Process keyup (always). More...

virtual void	show_menu (const std::vector< std::string > &items_arg, int xloc, int yloc, bool context_menu, display &disp)

virtual void	execute_action (const std::vector< std::string > &items_arg, int xloc, int yloc, bool context_menu)

virtual bool	in_context_menu (hotkey::HOTKEY_COMMAND command) const

Protected Member Functions inherited from video2::draw_layering
	draw_layering (const bool auto_join=true)

virtual	~draw_layering ()

Protected Member Functions inherited from events::sdl_handler
	sdl_handler (const bool auto_join=true)

virtual	~sdl_handler ()

virtual std::vector < sdl_handler * >	handler_members ()

Protected Attributes
const config &	game_config_

CKey	key_

bool	scrolling_

bool	scroll_up_

bool	scroll_down_

bool	scroll_left_

bool	scroll_right_

joystick_manager	joystick_manager_

Detailed Description

Definition at line 58 of file controller_base.hpp.

Constructor & Destructor Documentation

controller_base::controller_base	(	const config &	game_config,
		CVideo &	video
	)

Definition at line 32 of file controller_base.cpp.

controller_base::~controller_base ( )

virtual

Definition at line 45 of file controller_base.cpp.

Member Function Documentation

virtual std::vector<std::string> controller_base::additional_actions_pressed ( )

inlineprotectedvirtual

Reimplemented in editor::editor_controller.

Definition at line 108 of file controller_base.hpp.

Referenced by play_slice().

void controller_base::apply_keyboard_scroll	(	int	x,
		int	y
	)

void controller_base::execute_action	(	const std::vector< std::string > &	items_arg,
		int	xloc,
		int	yloc,
		bool	context_menu
	)

protectedvirtual

Definition at line 314 of file controller_base.cpp.

References hotkey::command_executor::can_execute_command(), hotkey::command_executor::execute_action(), get_display(), hotkey::get_hotkey_command(), get_hotkey_command_executor(), and mp_ui_alerts::items.

Referenced by play_slice().

virtual display& controller_base::get_display ( )

protectedpure virtual

Get a reference to a display member a derived class uses.

Implemented in play_controller, and editor::editor_controller.

Referenced by execute_action(), handle_event(), handle_scroll(), and play_slice().

virtual hotkey::command_executor* controller_base::get_hotkey_command_executor ( )

inlineprotectedvirtual

Get (optionally) a command executor to handle context menu events.

Reimplemented in play_controller, and editor::editor_controller.

Definition at line 98 of file controller_base.hpp.

Referenced by execute_action(), handle_event(), and show_menu().

virtual events::mouse_handler_base& controller_base::get_mouse_handler_base ( )

protectedpure virtual

Get a reference to a mouse handler member a derived class uses.

Implemented in play_controller, and editor::editor_controller.

Referenced by handle_event(), handle_scroll(), and play_slice().

virtual plugins_context* controller_base::get_plugins_context ( )

inlineprotectedvirtual

Get (optionally) a plugins context a derived class uses.

Reimplemented in play_controller.

Definition at line 93 of file controller_base.hpp.

Referenced by play_slice().

virtual soundsource::manager* controller_base::get_soundsource_man ( )

inlineprotectedvirtual

Get (optionally) a soundsources manager a derived class uses.

Reimplemented in play_controller.

Definition at line 88 of file controller_base.hpp.

Referenced by play_slice().

const config & controller_base::get_theme	(	const config &	game_config,
		std::string	theme_name
	)

static

Definition at line 341 of file controller_base.cpp.

References ERR_DP, config::find_child(), and preferences::theme().

Referenced by replay_controller::add_replay_theme(), play_controller::hotkey_handler::execute_command(), handle_event(), play_controller::init(), and replay_controller::rebuild_replay_theme().

void controller_base::handle_event ( const SDL_Event & event )

protectedvirtual

Process mouse- and keypress-events from SDL.

Calls various virtual function to allow specialized behavior of derived classes.

Implements events::sdl_handler.

Definition at line 49 of file controller_base.cpp.

References hotkey::execute_command(), hotkey::hotkey_command::get_command_by_command(), get_display(), get_hotkey_command_executor(), get_mouse_handler_base(), get_theme(), have_keyboard_focus(), hotkey::HOTKEY_QUIT_GAME, gui::in_dialog(), is_browsing(), mp_ui_alerts::items, hotkey::jbutton_event(), hotkey::jhat_event(), hotkey::key_event(), hotkey::mbutton_event(), events::mouse_handler_base::mouse_motion_event(), events::mouse_handler_base::mouse_press(), events::mouse_handler_base::mouse_wheel(), process_focus_keydown_event(), process_keydown_event(), process_keyup_event(), SDL_EVENTMASK, and show_menu().

bool controller_base::handle_scroll	(	int	mousex,
		int	mousey,
		int	mouse_flags,
		double	joystickx,
		double	joysticky
	)

protected

Handle scrolling by keyboard, joystick and moving mouse near map edges.

See also: scrolling_, which is set if the display is being scrolled

Returns: true when there was any scrolling, false otherwise

Definition at line 136 of file controller_base.cpp.

References preferences::get(), get_display(), get_mouse_handler_base(), events::mouse_handler_base::get_scroll_start(), display::get_theme(), display::h(), display::map_outside_area(), theme::menus(), preferences::middle_click_scrolls(), preferences::mouse_scroll_enabled(), preferences::mouse_scroll_threshold(), sdl::point_in_rect(), round_double(), display::scroll(), scroll_down_, scroll_left_, scroll_right_, preferences::scroll_speed(), scroll_up_, SDL_APPMOUSEFOCUS, SDL_GetAppState, events::mouse_handler_base::set_scroll_start(), display::w(), map_location::x, and map_location::y.

Referenced by play_slice().

void controller_base::handle_window_event ( const SDL_Event & )

inlineprotectedvirtual

Implements events::sdl_handler.

Definition at line 125 of file controller_base.hpp.

bool controller_base::have_keyboard_focus ( )

protectedvirtual

Derived classes should override this to return false when arrow keys should not scroll the map, hotkeys not processed etc, for example when a textbox is active.