src/textscroller.hpp

   1 //  $Id$
   2 //
   3 //  SuperTux
   4 //  Copyright (C) 2006 Matthias Braun <matze@braunis.de>
   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
  19 //  02111-1307, USA.
  20
  21 #ifndef __TEXTSCROLLER_H__
  22 #define __TEXTSCROLLER_H__
  23
  24 #include <vector>
  25 #include <string>
  26 #include <map>
  27
  28 #include "screen.hpp"
  29 #include "video/font.hpp"
  30
  31 class DrawingContext;
  32 class Surface;
  33
  34 /**
  35  * Helper class for InfoBox: Represents a line of text
  36  */
  37 class InfoBoxLine
  38 {
  39 private:
  40   enum LineType { NORMAL, NORMAL_LEFT, SMALL, HEADING, REFERENCE, IMAGE};
  41   LineType lineType;
  42   Font* font;
  43   std::string text;
  44   Surface* image;
  45
  46 public:
  47   InfoBoxLine(char format_char, const std::string& text);
  48   ~InfoBoxLine();
  49
  50   void draw(DrawingContext& context, const Vector& position, int layer);
  51   float get_height();
  52
  53   static const std::vector<InfoBoxLine*> split(const std::string& text, int line_length);
  54 };
  55
  56 /** This class is displaying a box with information text inside the game
  57  */
  58 class InfoBox
  59 {
  60 public:
  61   InfoBox(const std::string& text);
  62   ~InfoBox();
  63
  64   void draw(DrawingContext& context);
  65   void scrolldown();
  66   void scrollup();
  67   void pagedown();
  68   void pageup();
  69
  70 private:
  71   size_t firstline;
  72   std::vector<InfoBoxLine*> lines;
  73   std::map<std::string, Surface*> images;
  74   Surface* arrow_scrollup;
  75   Surface* arrow_scrolldown;
  76 };
  77
  78 class TextScroller : public Screen
  79 {
  80 public:
  81   TextScroller(const std::string& file);
  82   virtual ~TextScroller();
  83
  84   void setup();
  85   void draw(DrawingContext& context);
  86   void update(float elapsed_time);
  87
  88 private:
  89   float defaultspeed;
  90   float speed;
  91   std::string music;
  92   std::auto_ptr<Surface> background;
  93   std::vector<InfoBoxLine*> lines;
  94   float scroll;
  95   bool fading;
  96 };
  97
  98 #endif