cursor.hpp

Go to the documentation of this file.

/*
   Copyright (C) 2003 - 2016 by David White <[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.
*/

/** @file */

#ifndef CURSOR_HPP_INCLUDED
#define CURSOR_HPP_INCLUDED

struct surface;

namespace cursor
{

struct manager
{
    manager();
    ~manager();
};

enum CURSOR_TYPE { NORMAL, WAIT, MOVE, ATTACK, HYPERLINK, MOVE_DRAG, ATTACK_DRAG, NO_CURSOR, NUM_CURSORS };

/**
 * Use the default parameter to reset cursors.
 * e.g. after a change in color cursor preferences
 */
void set(CURSOR_TYPE type = NUM_CURSORS);
void set_dragging(bool drag);
CURSOR_TYPE get();

// These aren't used, but leaving the prototypes doesn't hurt and allows avoiding an SDL include
void draw(surface screen);
void undraw(surface screen);

void set_focus(bool focus);

struct setter
{
    setter(CURSOR_TYPE type);
    ~setter();

private:
    CURSOR_TYPE old_;
};

} // end namespace cursor

#endif