src/textscroller.hpp

   1 //  $Id$
   2 //
   3 //  SuperTux
   4 //  Copyright (C) 2005 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 "video/surface.hpp"
  29
  30 class DrawingContext;
  31
  32 /** This class is displaying a box with information text inside the game
  33  */
  34 class InfoBox
  35 {
  36 public:
  37   InfoBox(const std::string& text);
  38   ~InfoBox();
  39
  40   void draw(DrawingContext& context);
  41   void scrolldown();
  42   void scrollup();
  43   void pagedown();
  44   void pageup();
  45
  46 private:
  47   size_t firstline;
  48   std::vector<std::string> lines;
  49   std::map<std::string, Surface*> images;
  50 };
  51
  52 /** Reads a text file (using LispReader, so it as to be in its formatting)
  53  * and scroll it over the screen
  54  * (this call blocks until all text scrolled through or the user aborted the
  55  *  textscrolling)
  56  */
  57 void display_text_file(const std::string& file);
  58
  59 #endif
  60