mouse_action_village.hpp

Go to the documentation of this file.

/*
   Copyright (C) 2008 - 2016 by Fabian Mueller <[email protected]>
   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.
*/

#ifndef EDITOR_MOUSE_ACTION_VILLAGE_HPP
#define EDITOR_MOUSE_ACTION_VILLAGE_HPP

#include "mouse_action.hpp"

class CKey;
class empty_palette;

namespace editor {

/**
 * Editor mouse action class.
 * Called by the editor tool to assign village ownership to defined sides.
 */
class mouse_action_village : public mouse_action
{
public:
    mouse_action_village(const CKey& key, empty_palette& palette)
    : mouse_action(palette, key)
    {
    }

    /**
     * No action.
     */
    editor_action* click_left(editor_display& /*disp*/, int /*x*/, int /*y*/) {return nullptr;}

    /**
     * If clicked on a village hex field, assigns the ownership of it to the current side.
     */
    editor_action* up_left(editor_display& disp, int x, int y);

    /**
     * No action.
     */
    editor_action* click_right(editor_display& /*disp*/, int /*x*/, int /*y*/) {return nullptr;}

    /**
     * If clicked on a village hex field, unassigns it's ownership.
     */
    editor_action* up_right(editor_display& disp, int x, int y);

    virtual void set_mouse_overlay(editor_display& disp);
};


} //end namespace editor

#endif