src/gui/mousecursor.hpp

   1 //  $Id$
   2 //
   3 //  SuperTux -  A Jump'n Run
   4 //  Copyright (C) 2004 Ricardo Cruz <rick2@aeiou.pt>
   5 //
   6 //  This program is free software; you can redistribute it and/or
   7 //  modify it under the terms of the GNU General Public License
   8 //  as published by the Free Software Foundation; either version 2
   9 //  of the License, or (at your option) any later version.
  10 //
  11 //  This program is distributed in the hope that it will be useful,
  12 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 //  GNU General Public License for more details.
  15 //
  16 //  You should have received a copy of the GNU General Public License
  17 //  along with this program; if not, write to the Free Software
  18 //  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  19 #ifndef SUPERTUX_MOUSECURSOR_H
  20 #define SUPERTUX_MOUSECURSOR_H
  21
  22 #include <string>
  23
  24 #include "video/surface.hpp"
  25
  26 #define MC_STATES_NB 3
  27
  28 enum {
  29   MC_NORMAL = 0,
  30   MC_CLICK,
  31   MC_LINK,
  32   MC_HIDE
  33 };
  34
  35 class DrawingContext;
  36
  37 /// Mouse cursor.
  38 /** Used to create mouse cursors.
  39     The mouse cursors can be animated
  40     and can be used in four different states.
  41     (MC_NORMAL, MC_CLICK, MC_LINK or MC_HIDE) */
  42 class MouseCursor
  43 {
  44 public:
  45   /// Constructor of MouseCursor.
  46   /** Expects an imagefile for the cursor and  the number of animation frames it contains. */
  47   MouseCursor(std::string cursor_file);
  48   ~MouseCursor();
  49   /// Get MouseCursor state.
  50   /** (MC_NORMAL, MC_CLICK, MC_LINK or MC_HIDE) */
  51   int state();
  52   /// Set MouseCursor state.
  53   /** (MC_NORMAL, MC_CLICK, MC_LINK or MC_HIDE) */
  54   void set_state(int nstate);
  55   /// Define the middle of a MouseCursor.
  56   /** Useful for cross mouse cursor images in example. */
  57   void set_mid(int x, int y);
  58
  59   /// Draw MouseCursor on screen.
  60   void draw(DrawingContext& context);
  61
  62   /// Return the current cursor.
  63   static MouseCursor* current()
  64   {        return current_;      };
  65   /// Set current cursor.
  66   static void set_current(MouseCursor* pcursor)
  67   {        current_ = pcursor;      };
  68
  69 private:
  70   int mid_x, mid_y;
  71   static MouseCursor* current_;
  72   int state_before_click;
  73   int cur_state;
  74   Surface* cursor;
  75 };
  76
  77 #endif /*SUPERTUX_MOUSECURSOR_H*/