0abde389dc
when quitting (for example by clicking on the red cross in the corner) the game now asks for a confirmation, if there is currently a (re-)play or the editor running.
145 lines
4.5 KiB
C++
145 lines
4.5 KiB
C++
/*
|
|
Copyright (C) 2006 - 2015 by Joerg Hinrichs <joerg.hinrichs@alice-dsl.de>
|
|
wesnoth playlevel Copyright (C) 2003 by David White <dave@whitevine.net>
|
|
Part of the Battle for Wesnoth Project http://www.wesnoth.org/
|
|
|
|
This program is free software; you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation; either version 2 of the License, or
|
|
(at your option) any later version.
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY.
|
|
|
|
See the COPYING file for more details.
|
|
*/
|
|
|
|
/**
|
|
* @file
|
|
* controller_base framework:
|
|
* controller_base is roughly analogous to a "dialog" class in a GUI toolkit
|
|
* which is appropriate for deriving wesnoth game modes, e.g. single player
|
|
* mode, multiplayer mode, replay mode, editor mode.
|
|
*
|
|
* It provides implementation details for:
|
|
* - play_slice, which is essentially one pass of the "main loop" of
|
|
* the application, pumping and dispatching SDL events, raising draw
|
|
* events, handling scrolling, sound sources, and some joystick issues
|
|
* It also handles displaying menus (Menu, Action).
|
|
*
|
|
* - showing context menus (much is delegated to command executor though)
|
|
*
|
|
* Other than this it functions as an abstract interface, enforcing that
|
|
* controllers derive from events::sdl_handler, hotkey_command_executor,
|
|
* and provide some accessors needed for event handling.
|
|
*/
|
|
|
|
#ifndef CONTROLLER_BASE_H_INCLUDED
|
|
#define CONTROLLER_BASE_H_INCLUDED
|
|
|
|
#include "global.hpp"
|
|
|
|
#include "events.hpp"
|
|
#include "hotkey/hotkey_command.hpp"
|
|
#include "joystick.hpp"
|
|
#include "key.hpp"
|
|
#include "quit_confirmation.hpp"
|
|
|
|
class CVideo;
|
|
class display;
|
|
class plugins_context;
|
|
|
|
namespace events { class mouse_handler_base; }
|
|
|
|
namespace hotkey { class command_executor; }
|
|
|
|
namespace soundsource { class manager; }
|
|
|
|
class controller_base : public events::sdl_handler, quit_confirmation
|
|
{
|
|
public:
|
|
controller_base(const config& game_config, CVideo& video);
|
|
virtual ~controller_base();
|
|
|
|
void play_slice(bool is_delay_enabled = true);
|
|
|
|
protected:
|
|
virtual bool is_browsing() const
|
|
{ return false; }
|
|
/**
|
|
* Get a reference to a mouse handler member a derived class uses
|
|
*/
|
|
virtual events::mouse_handler_base& get_mouse_handler_base() = 0;
|
|
/**
|
|
* Get a reference to a display member a derived class uses
|
|
*/
|
|
virtual display& get_display() = 0;
|
|
|
|
/**
|
|
* Get (optionally) a soundsources manager a derived class uses
|
|
*/
|
|
virtual soundsource::manager * get_soundsource_man() { return NULL; }
|
|
|
|
/**
|
|
* Get (optionally) a plugins context a derived class uses
|
|
*/
|
|
virtual plugins_context * get_plugins_context() { return NULL; }
|
|
|
|
/**
|
|
* Get (optionally) a command executor to handle context menu events
|
|
*/
|
|
virtual hotkey::command_executor * get_hotkey_command_executor() { return NULL; }
|
|
|
|
/**
|
|
* 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
|
|
* @returns true when arrow keys should scroll the map, false otherwise
|
|
*/
|
|
virtual bool have_keyboard_focus();
|
|
|
|
|
|
/**
|
|
* Handle scrolling by keyboard, joystick and moving mouse near map edges
|
|
* @see is_keyboard_scroll_active
|
|
* @return true when there was any scrolling, false otherwise
|
|
*/
|
|
bool handle_scroll(CKey& key, int mousex, int mousey, int mouse_flags, double joystickx, double joysticky);
|
|
|
|
/**
|
|
* Process mouse- and keypress-events from SDL.
|
|
* Not virtual but calls various virtual function to allow specialized
|
|
* behavior of derived classes.
|
|
*/
|
|
void handle_event(const SDL_Event& event);
|
|
|
|
/**
|
|
* Process keydown (only when the general map display does not have focus).
|
|
*/
|
|
virtual void process_focus_keydown_event(const SDL_Event& event);
|
|
|
|
/**
|
|
* Process keydown (always).
|
|
* Overridden in derived classes
|
|
*/
|
|
virtual void process_keydown_event(const SDL_Event& event);
|
|
|
|
/**
|
|
* Process keyup (always).
|
|
* Overridden in derived classes
|
|
*/
|
|
virtual void process_keyup_event(const SDL_Event& event);
|
|
|
|
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;
|
|
|
|
static const config &get_theme(const config& game_config, std::string theme_name);
|
|
const config& game_config_;
|
|
CKey key_;
|
|
bool scrolling_;
|
|
joystick_manager joystick_manager_;
|
|
};
|
|
|
|
|
|
#endif
|