---

Description.h

/*
 * Description.h -- class interface for text descriptions
 * Copyright (C) 2002  Eric Lemings <elemings@users.sourceforge.net>
 *
 * This software is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this software; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
 * 02111-1307, USA
 *
 * RCS: $Id: Description.h,v 1.2 2003/04/18 01:41:03 elemings Exp $
 */

#ifdef __cplusplus

#  ifndef OGS_CORE_DETAILS_DESCRIPTION_H
#    define OGS_CORE_DETAILS_DESCRIPTION_H

#    include <string>

#    include <ogs/core/Detail.h>
#    include <ogs/core/details/Namespace.h>

OGS_BEGIN_CORE_DETAILS_NAMESPACE

class Description: public Detail {
  public:
    enum Aspect {
      NAME,
      PERSONALITY,
      APPEARANCE,
      BACKGROUND
    };

    Description (Aspect aspect, const std::string& text);

    Aspect getAspect () const;
    std::string getText () const;
    void setText (const std::string& text);

  private:
    Aspect _aspect;
    std::string _text;
};

inline Description::Description (Aspect aspect, const std::string& text):
  _aspect (aspect), _text (text) { }

inline Description::Aspect Description::getAspect () const {
  return (this->_aspect);
}

inline std::string Description::getText () const {
  return (this->_text);
}

inline void Description::setText (const std::string& text) {
  this->_text = text;
}

OGS_END_CORE_DETAILS_NAMESPACE

#  endif /* !defined OGS_CORE_DETAILS_DESCRIPTION_H */

#endif /* defined __cplusplus */

---