git.maemo.org Git - lordsawar/blob - src/namelist.h

   1 //  Copyright (C) 2009, Ben Asselstine
   2 //
   3 //  This program is free software; you can redistribute it and/or modify
   4 //  it under the terms of the GNU General Public License as published by
   5 //  the Free Software Foundation; either version 3 of the License, or
   6 //  (at your option) any later version.
   7 //
   8 //  This program is distributed in the hope that it will be useful,
   9 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11 //  GNU Library General Public License for more details.
  12 //
  13 //  You should have received a copy of the GNU General Public License
  14 //  along with this program; if not, write to the Free Software
  15 //  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  16 //  02110-1301, USA.
  17
  18 #ifndef NAMELIST_H
  19 #define NAMELIST_H
  20
  21 #include <string>
  22 #include <map>
  23 #include <vector>
  24 #include <sigc++/trackable.h>
  25
  26 #include "xmlhelper.h"
  27
  28
  29 //! A list of names for ruins, temples and cities available to the game.
  30 /**
  31  * This class holds all of the possible names in the game for ruins, temples,
  32  * and cities.
  33  *
  34  */
  35 class NameList : public std::vector<std::string>, public sigc::trackable
  36 {
  37     public:
  38
  39         //! Default Constructor.
  40         /**
  41          * Loads all names it can find in the given file, and
  42          * makes a new NameList object from what it finds.
  43          */
  44         NameList(std::string filename, std::string item_tag);
  45
  46         std::string popRandomName();
  47
  48     private:
  49
  50         //! Destructor.
  51         ~NameList();
  52
  53         //! Callback for loading names into the NameList.
  54         bool load(std::string tag, XML_Helper *helper);
  55
  56         std::string d_item_tag;
  57 };
  58
  59 #endif // NAMELIST_H
  60