Feel++ 0.91.0
Public Member Functions

Feel::AboutPerson Class Reference

#include <about.hpp>

List of all members.

Public Member Functions

 AboutPerson (std::string name, std::string task, std::string emailAddress, std::string webAddress)
 AboutPerson (AboutPerson const &ap)
AboutPersonoperator= (AboutPerson const &__ap)
std::string name () const
std::string task () const
std::string emailAddress () const
std::string webAddress () const

Detailed Description

This structure is used to store information about a person or developer. It can store the person's name, a task, an email address and a link to a home page. This class is intended for use in the AboutData class, but it can be used elsewhere as well. Normally you should at least define the person's name.

Example Usage within a main():

AboutData about("hello", "0.1", "A Feel version of Hello, world!"), AboutData::License_LGPL, "Copyright (c) 2003 Developer");

about.addAuthor("Joe Developer", "developer", "joe@host.com", 0); about.addCredit("Joe User", "A lot of bug reports"), "joe.user@host.org", 0);


Constructor & Destructor Documentation

Feel::AboutPerson::AboutPerson ( std::string  name,
std::string  task,
std::string  emailAddress,
std::string  webAddress 
) [inline]

Convenience constructor

Parameters:
nameThe name of the person.
taskThe task of this person. This string should be marked for translation, e.g.
emailAddressThe email address of the person.
webAddressHome page of the person.

Member Function Documentation

std::string Feel::AboutPerson::emailAddress ( ) const

The person's email address

Returns:
the person's email address (can be std::string, if it has been constructed with a null email)
std::string Feel::AboutPerson::name ( ) const

The person's name

Returns:
the person's name (can be std::string, if it has been constructed with a null name)
std::string Feel::AboutPerson::task ( ) const

The person's task

Returns:
the person's task (can be std::string, if it has been constructed with a null task)
std::string Feel::AboutPerson::webAddress ( ) const

The home page or a relevant link

Returns:
the persons home page (can be std::string, if it has been constructed with a null home page)