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 #include <vector>
  22
  23 #include "video/surface_ptr.hpp"
  24
  25 #define MC_STATES_NB 3
  26
  27 enum MouseCursorState
  28 {
  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   MouseCursor(const std::string& cursor_file,
  46               const std::string& cursor_click_file,
  47               const std::string& cursor_link_file);
  48   ~MouseCursor();
  49
  50   /// Set MouseCursor state.
  51   /** (MC_NORMAL, MC_CLICK, MC_LINK or MC_HIDE) */
  52   void set_state(MouseCursorState nstate);
  53
  54   /// Define the middle of a MouseCursor.
  55   /** Useful for cross mouse cursor images in example. */
  56   void set_mid(int x, int y);
  57
  58   /// Draw MouseCursor on screen.
  59   void draw(DrawingContext& context);
  60
  61   /// Return the current cursor.
  62   static MouseCursor* current()
  63   {        return current_;      };
  64   /// Set current cursor.
  65   static void set_current(MouseCursor* pcursor)
  66   {        current_ = pcursor;      };
  67
  68 private:
  69   int m_mid_x;
  70   int m_mid_y;
  71   MouseCursorState m_state;
  72   std::vector<SurfacePtr> m_cursor;
  73
  74 private:
  75   static MouseCursor* current_;
  76
  77 private:
  78   MouseCursor(const MouseCursor&);
  79   MouseCursor& operator=(const MouseCursor&);
  80 };
  81
  82 #endif /*SUPERTUX_MOUSECURSOR_H*/
  83
  84 /* EOF */