mirror of
https://github.com/wesnoth/wesnoth
synced 2025-04-30 18:55:36 +00:00
e4095a30cf
...moved the functions of config_adapter to controller_base, play_controller, team and game_state
123 lines
3.3 KiB
C++
123 lines
3.3 KiB
C++
/* $Id$ */
|
|
/*
|
|
Copyright (C) 2006 - 2009 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 version 2
|
|
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.
|
|
*/
|
|
|
|
#ifndef CONTROLLER_BASE_H_INCLUDED
|
|
#define CONTROLLER_BASE_H_INCLUDED
|
|
|
|
#include "global.hpp"
|
|
|
|
#include "generic_event.hpp"
|
|
#include "hotkeys.hpp"
|
|
#include "key.hpp"
|
|
#include "preferences_display.hpp"
|
|
#include "sdl_utils.hpp"
|
|
|
|
#include <vector>
|
|
namespace events {
|
|
class mouse_handler_base;
|
|
}
|
|
|
|
class controller_base : public hotkey::command_executor, public events::handler
|
|
{
|
|
public:
|
|
controller_base(int ticks, const config& game_config, CVideo& video);
|
|
virtual ~controller_base();
|
|
|
|
void play_slice(bool is_delay_enabled = true);
|
|
|
|
int get_ticks();
|
|
|
|
protected:
|
|
/**
|
|
* Called by play_slice after events:: calls, but before processing scroll
|
|
* and other things like menu.
|
|
*/
|
|
virtual void slice_before_scroll();
|
|
|
|
/**
|
|
* Called at the very end of play_slice
|
|
*/
|
|
virtual void slice_end();
|
|
|
|
/**
|
|
* Inherited from command_executor, still declared pure virtual but might
|
|
* provide some defaults
|
|
*/
|
|
virtual bool can_execute_command(hotkey::HOTKEY_COMMAND command, int index=-1) const = 0;
|
|
/**
|
|
* 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;
|
|
|
|
|
|
/**
|
|
* 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 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);
|
|
|
|
/**
|
|
* Process mouse- and keypress-events from SDL.
|
|
* Not virtual but calls various virtual function to allow specialized
|
|
* behaviour of derived classess.
|
|
*/
|
|
void handle_event(const SDL_Event& event);
|
|
|
|
/**
|
|
* Process keydown (only when the general map display does not have focus).
|
|
* Overriden in derived classes
|
|
*/
|
|
virtual void process_keydown_event(const SDL_Event& event);
|
|
|
|
/**
|
|
* Process keyup (always).
|
|
* Overriden in derived classes
|
|
*/
|
|
virtual void process_keyup_event(const SDL_Event& event);
|
|
|
|
/**
|
|
* Called after processing a mouse button up or down event
|
|
* Overriden in derived classes
|
|
*/
|
|
virtual void post_mouse_press(const SDL_Event& event);
|
|
|
|
virtual void show_menu(const std::vector<std::string>& items_arg, int xloc, int yloc, bool context_menu);
|
|
|
|
virtual bool in_context_menu(hotkey::HOTKEY_COMMAND command) const;
|
|
|
|
const config &get_theme(const config& game_config, std::string theme_name);
|
|
const config& game_config_;
|
|
const int ticks_;
|
|
CKey key_;
|
|
bool browse_;
|
|
bool scrolling_;
|
|
};
|
|
|
|
|
|
#endif
|