KCalCore::Person Class Reference

#include <person.h>

Inheritance diagram for KCalCore::Person:

Public Types
typedef QVector< Ptr >	List
typedef QSharedPointer< Person >	Ptr

Public Member Functions
	Person ()
	Person (const QString &name, const QString &email)
	Person (const Person &person)
virtual	~Person ()
int	count () const
QString	email () const
QString	fullName () const
bool	isEmpty () const
QString	name () const
bool	operator!= (const Person &person) const
Person &	operator= (const Person &person)
bool	operator== (const Person &person) const
void	setCount (int count)
void	setEmail (const QString &email)
void	setName (const QString &name)

Static Public Member Functions
static Person::Ptr	fromFullName (const QString &fullName)
static bool	isValidEmail (const QString &email)

Friends
KCALCORE_EXPORT QDataStream &	operator<< (QDataStream &s, const KCalCore::Person::Ptr &person)
KCALCORE_EXPORT QDataStream &	operator>> (QDataStream &s, KCalCore::Person::Ptr &person)

Detailed Description

Represents a person, by name and email address.

This class represents a person, with a name and an email address. It supports the "FirstName LastName\ <mail@domain\>" format.

Definition at line 50 of file person.h.

Member Typedef Documentation

typedef QVector<Ptr> KCalCore::Person::List

List of persons.

Definition at line 61 of file person.h.

typedef QSharedPointer<Person> KCalCore::Person::Ptr

A shared pointer to a Person object.

Definition at line 56 of file person.h.

Constructor & Destructor Documentation

Person::Person

(

)

Constructs a blank person.

Private class that helps to provide binary compatibility between releases.

Definition at line 57 of file person.cpp.

Person::Person	(	const QString &	name,
		const QString &	email
	)

Constructs a person with the name name and email address email.

Parameters

name	is the name of this person.
email	is the email address of this person.

Definition at line 61 of file person.cpp.

Person::Person

(

const Person &

person

)

Constructs a person as a copy of another person object.

Parameters

person

is the person to copy.

Definition at line 68 of file person.cpp.

Person::~Person ( )

virtual

Destroys a person.

Definition at line 73 of file person.cpp.

Member Function Documentation

int Person::count

(

)

const

Returns the number of references or zero if it is not initialized.

See also

setCount()

Definition at line 166 of file person.cpp.

QString Person::email

(

)

const

Returns the email address for this person.

Returns

A QString containing the person's email address.

See also

setEmail()

Definition at line 131 of file person.cpp.

Person::Ptr Person::fromFullName ( const QString &  fullName )

static

Constructs a person with name and email address taken from fullName.

Parameters

fullName

is the name and email of the person in the form "FirstName LastName \<mail@domain\>".

Returns

A Person object pointer.

Definition at line 391 of file person.cpp.

QString Person::fullName

(

)

const

Returns the full name of this person.

Returns

A QString containing the person's full name in the form "FirstName LastName \<mail@domain\>".

Definition at line 101 of file person.cpp.

bool Person::isEmpty

(

)

const

Returns true if the person name and email address are empty.

Definition at line 136 of file person.cpp.

bool Person::isValidEmail ( const QString &  email )

static

Returns true if person's email address is valid.

Simple email validity check, test that there: is at least one @ is at least one character in the local part is at least one dot in the domain part is at least four characters in the domain (assuming that no-one has an address at the tld, that the tld is at least 2 chars)

Parameters

email

is the email address to validate

Definition at line 155 of file person.cpp.

QString Person::name

(

)

const

Returns the person name string.

See also

setName()

Definition at line 126 of file person.cpp.

bool KCalCore::Person::operator!=

(

const Person &

person

)

const

Compares this with person for non-equality.

Parameters

person

is the person to compare.

Definition at line 85 of file person.cpp.

Person & KCalCore::Person::operator=

(

const Person &

person

)

Sets this person equal to person.

Parameters

person

is the person to copy.

Definition at line 90 of file person.cpp.

bool KCalCore::Person::operator==

(

const Person &

person

)

const

Compares this with person for equality.

Parameters

person

is the person to compare.

Definition at line 78 of file person.cpp.

void Person::setCount

(

int

count

)

Sets the number of references for this person.

This can be initialized in a loading function (see ExtendedStorage), where the number of contact appearances etc. are counted.

Parameters

count

number of references

See also

count()

Definition at line 161 of file person.cpp.

void Person::setEmail

(

const QString &

email

)

Sets the email address for this person to email.

Parameters

email

is the email address for this person.

See also

email()

Definition at line 146 of file person.cpp.

void Person::setName

(

const QString &

name

)

Sets the name of the person to name.

Parameters

name	is the name of this person.

See also

name()

Definition at line 141 of file person.cpp.

Friends And Related Function Documentation

KCALCORE_EXPORT QDataStream& operator<< ( QDataStream &  s, const KCalCore::Person::Ptr &  person  )

friend

Serializes the person object into the stream.

KCALCORE_EXPORT QDataStream& operator>> ( QDataStream &  s, KCalCore::Person::Ptr &  person  )

friend

Initializes the person object from the stream.

---

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

• person.h
• person.cpp