src/gui/mousecursor.hpp

   1 //  SuperTux
   2 //  Copyright (C) 2006 Matthias Braun <matze@braunis.de>
   3 //
   4 //  This program is free software: you can redistribute it and/or modify
   5 //  it under the terms of the GNU General Public License as published by
   6 //  the Free Software Foundation, either version 3 of the License, or
   7 //  (at your option) any later version.
   8 //
   9 //  This program is distributed in the hope that it will be useful,
  10 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 //  GNU General Public License for more details.
  13 //
  14 //  You should have received a copy of the GNU General Public License
  15 //  along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 #ifndef HEADER_SUPERTUX_GUI_MOUSECURSOR_HPP
  18 #define HEADER_SUPERTUX_GUI_MOUSECURSOR_HPP
  19
  20 #include <string>
  21
  22 #include "video/surface_ptr.hpp"
  23
  24 #define MC_STATES_NB 3
  25
  26 enum MouseCursorState
  27 {
  28   MC_NORMAL = 0,
  29   MC_CLICK,
  30   MC_LINK,
  31   MC_HIDE
  32 };
  33
  34 class DrawingContext;
  35
  36 /// Mouse cursor.
  37 /** Used to create mouse cursors.
  38     The mouse cursors can be animated
  39     and can be used in four different states.
  40     (MC_NORMAL, MC_CLICK, MC_LINK or MC_HIDE) */
  41 class MouseCursor
  42 {
  43 public:
  44   MouseCursor(const std::string& cursor_file,
  45               const std::string& cursor_click_file,
  46               const std::string& cursor_link_file);
  47   ~MouseCursor();
  48
  49   /// Set MouseCursor state.
  50   /** (MC_NORMAL, MC_CLICK, MC_LINK or MC_HIDE) */
  51   void set_state(MouseCursorState nstate);
  52
  53   /// Define the middle of a MouseCursor.
  54   /** Useful for cross mouse cursor images in example. */
  55   void set_mid(int x, int y);
  56
  57   /// Draw MouseCursor on screen.
  58   void draw(DrawingContext& context);
  59
  60   /// Return the current cursor.
  61   static MouseCursor* current()
  62   {        return current_;      };
  63   /// Set current cursor.
  64   static void set_current(MouseCursor* pcursor)
  65   {        current_ = pcursor;      };
  66
  67 private:
  68   int m_mid_x;
  69   int m_mid_y;
  70   MouseCursorState m_state;
  71   std::vector<SurfacePtr> m_cursor;
  72
  73 private:
  74   static MouseCursor* current_;
  75
  76 private:
  77   MouseCursor(const MouseCursor&);
  78   MouseCursor& operator=(const MouseCursor&);
  79 };
  80
  81 #endif /*SUPERTUX_MOUSECURSOR_H*/
  82
  83 /* EOF */