paboutdata.h

Go to the documentation of this file.

/*
 *   P::Classes - Portable C++ Application Framework
 *   Copyright (C) 2000-2003  Christian Prochnow <cproch@seculogix.de>
 *
 *   This library is free software; you can redistribute it and/or
 *   modify it under the terms of the GNU Lesser General Public
 *   License as published by the Free Software Foundation; either
 *   version 2 of the License, or (at your option) any later version.
 *
 *   This library 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
 *   Lesser General Public License for more details.
 *
 *   You should have received a copy of the GNU Lesser General Public
 *   License along with this library; if not, write to the Free Software
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#ifndef _paboutdata_h_
#define _paboutdata_h_

#include <pclasses/pexport.h>
#include <utility>
#include <string>
#include <list>

namespace P {


class PCORE_EXPORT AboutData {
  public:

    enum license_t {
      GPL,      
      LGPL,     
      QPL,      
      Custom    
    };

    typedef std::pair<std::string, std::string> author_t;

    typedef std::pair<std::string, std::string> credit_t;


    AboutData(const std::string& appName, const std::string& appDesc,
              const std::string& version, const std::string& copyright, license_t lic);
    ~AboutData();

    inline const std::string& name() const
    { return m_appName; }

    inline const std::string& description() const
    { return m_appDesc; }

    inline const std::string& version() const
    { return m_version; }

    inline const std::string& copyright() const
    { return m_copyright; }

    inline license_t license() const
    { return m_license; }

    void addAuthor(const std::string& name, const std::string& email);

    inline const std::list<author_t>& authors() const
    { return m_authors; }

    void addCredit(const std::string& name, const std::string& email);

    inline const std::list<credit_t>& credits() const
    { return m_credits; }

  private:
    std::string         m_appName;
    std::string         m_appDesc;
    std::string         m_version;
    std::string         m_copyright;
    license_t           m_license;
    std::list<author_t> m_authors;
    std::list<credit_t> m_credits;
};

}

#endif

---