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

   1 //  Copyright (C) 2008, 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 RENAMABLE_H
  19 #define RENAMABLE_H
  20
  21 #include "vector.h"
  22 #include "Named.h"
  23
  24 #include "defs.h"
  25
  26 class XML_Helper;
  27
  28 //! A game object that has a name that can be altered.
  29 /**
  30  * A Renamable is a game object that has a name that can be changed.
  31  */
  32 class Renamable: private Named
  33 {
  34  public:
  35      //! Default constructor.
  36      Renamable(std::string name);
  37
  38      //! Copy constructor.
  39      Renamable(const Renamable&);
  40
  41      //! Loading constructor.
  42      Renamable(XML_Helper* helper);
  43
  44      //! Destructor.
  45      ~Renamable();
  46
  47      // Get Methods
  48
  49      //! Return the name of the object on the game map.
  50      std::string getName(bool translate = false) const
  51        {
  52          if (translate == true)
  53            return _(d_name.c_str());
  54          else return d_name;
  55        }
  56
  57
  58      // Set Methods
  59
  60      //! Set the name of the object on the game map.
  61      void setName(std::string name) {d_name = name;}
  62
  63 };
  64
  65 #endif