P::AboutData Class Reference
[Core library]

Application about data. More...

#include <paboutdata.h>

List of all members.

Public Types
typedef std::pair< std::string, std::string >	author_t
	Type used to store authors name & email address.
typedef std::pair< std::string, std::string >	credit_t
	Type used to store name & email address for credits.
enum	license_t { GPL, LGPL, QPL, Custom }
	Distribution license type. More...
Public Member Functions
	AboutData (const std::string &appName, const std::string &appDesc, const std::string &version, const std::string &copyright, license_t lic)
	Construct about data.
	~AboutData ()
const std::string &	name () const
	Returns the application name.
const std::string &	description () const
	Returns the applications short description.
const std::string &	version () const
	Returns the application version.
const std::string &	copyright () const
	Returns the application copyright.
license_t	license () const
	Returns the distribution license.
void	addAuthor (const std::string &name, const std::string &email)
	Add an author to the list of authors.
const std::list< author_t > &	authors () const
	Returns the list of authors.
void	addCredit (const std::string &name, const std::string &email)
	Add a credit to the list of authors.
const std::list< credit_t > &	credits () const
	Returns the list of credits.

---

Detailed Description

Application about data.

This class is used to store data about the application itself.

Author:

Christian Prochnow <cproch@seculogix.de>

Definition at line 40 of file paboutdata.h.

---

Member Typedef Documentation

typedef std::pair<std::string, std::string> P::AboutData::author_t

Type used to store authors name & email address. Definition at line 52 of file paboutdata.h.

typedef std::pair<std::string, std::string> P::AboutData::credit_t

Type used to store name & email address for credits. Definition at line 55 of file paboutdata.h.

---

Member Enumeration Documentation

enum P::AboutData::license_t

Distribution license type. Enumeration values: GPL  GNU Public License LGPL  Lesser GNU Public License QPL  Qt Publis License Custom  Custom License Definition at line 44 of file paboutdata.h.

---

Constructor & Destructor Documentation

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

Construct about data. Constructs the about data object with the given values. Parameters: appName  Applications short name appDesc  Short application description version  Application version copyright  Copyright string lic  Distribution license

P::AboutData::~AboutData (   )

---

Member Function Documentation

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

Add an author to the list of authors.

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

Add a credit to the list of authors.

const std::list<author_t>& P::AboutData::authors (   )  const [inline]

Returns the list of authors. Definition at line 94 of file paboutdata.h.

const std::string& P::AboutData::copyright (   )  const [inline]

Returns the application copyright. Definition at line 83 of file paboutdata.h.

const std::list<credit_t>& P::AboutData::credits (   )  const [inline]

Returns the list of credits. Definition at line 101 of file paboutdata.h.

const std::string& P::AboutData::description (   )  const [inline]

Returns the applications short description. Definition at line 75 of file paboutdata.h.

license_t P::AboutData::license (   )  const [inline]

Returns the distribution license. Definition at line 87 of file paboutdata.h.

const std::string& P::AboutData::name (   )  const [inline]

Returns the application name. Definition at line 71 of file paboutdata.h.

const std::string& P::AboutData::version (   )  const [inline]

Returns the application version. Definition at line 79 of file paboutdata.h.

---

The documentation for this class was generated from the following file:

• paboutdata.h

---