src/DB/Savables/Colour.h

   1 /***************************************************************************
   2  *   Copyright (C) 2008 by Sverre Rabbelier                                *
   3  *   sverre@rabbelier.nl                                                   *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 3 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  19  ***************************************************************************/
  20 #pragma once
  21
  22 #include "SavableHeaders.h"
  23 #include "SavableTypes.h"
  24
  25 namespace mud
  26 {
  27         class ColourManager;
  28
  29         class Colour : public Savable
  30         {
  31         public:
  32                 /*
  33                  * Getters
  34                  */
  35                 const std::string& getName() const;
  36                 std::string getColourString();
  37                 const std::string& getCode() const;
  38                 bool isAnsi() const;
  39
  40                 /*
  41                  * Setters
  42                  */
  43                 void setName(const std::string& name);
  44                 void setColourString(const std::string& colourstring);
  45                 void setCode(const std::string& code);
  46                 void setAnsi(bool ansi);
  47
  48                 /*
  49                  * Utilities
  50                  */
  51                 SavableManagerPtr getManager() const;
  52                 TableImplPtr getTable() const;
  53
  54                 /*
  55                  * Database utilities
  56                  */
  57                 void Delete();
  58                 void Save();
  59                 void Discard();
  60                 bool Exists();
  61
  62         private:
  63                 SavableManagerPtr m_colour;
  64
  65                 /*
  66                  * Ctors
  67                  */
  68                 Colour(SavableManagerPtr object);
  69                 Colour(const Colour& rhs);
  70                 Colour operator=(const Colour& rhs);
  71                 ~Colour(void);
  72
  73                 friend class ColourManager;
  74                 friend SmartPtrDelete(mud::Colour);
  75         };
  76 }