Feel::AboutPerson Class Reference

This structure is used to store information about a person or developer. More...

Collaboration diagram for Feel::AboutPerson:

Public Member Functions
	AboutPerson (AboutPerson const &ap)
	AboutPerson (std::string _name, std::string _task, std::string _emailAddress, std::string _webAddress)
	Convenience constructor. More...
std::string	emailAddress () const
	The person's email address. More...
std::string	name () const
	The person's name. More...
AboutPerson &	operator= (AboutPerson const &__ap)
std::string	task () const
	The person's task. More...
std::string	webAddress () const
	The home page or a relevant link. More...

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

AboutPerson()

Feel::AboutPerson::AboutPerson	(	std::string	_name,
		std::string	_task,
		std::string	_emailAddress,
		std::string	_webAddress
	)

Convenience constructor.

Parameters

name	The name of the person.
task	The task of this person. This string should be marked for translation, e.g.
emailAddress	The email address of the person.
webAddress	Home page of the person.

Member Function Documentation

emailAddress()

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)

name()

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)

task()

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)

webAddress()

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)