Akonadi::EmailAddressSelection Class Reference

An selection of an email address and corresponding name. More...

#include <emailaddressselection.h>

List of all members.

Public Types
typedef QList < EmailAddressSelection >	List
Public Member Functions
	EmailAddressSelection (const EmailAddressSelection &other)
	EmailAddressSelection ()
	~EmailAddressSelection ()
QString	email () const
bool	isValid () const
Akonadi::Item	item () const
QString	name () const
EmailAddressSelection &	operator= (const EmailAddressSelection &other)
QString	quotedEmail () const

---

Detailed Description

An selection of an email address and corresponding name.

This class encapsulates the selection of an email address and name as it is returned by EmailAddressSelectionWidget or EmailAddressSelectionDialog.

It offers convenience methods to retrieve the quoted version of the email address and access to the Akonadi item that is associated with this address.

Author:

Tobias Koenig <tokoe@kde.org>

Since:

4.5

Definition at line 49 of file emailaddressselection.h.

---

Member Typedef Documentation

typedef QList<EmailAddressSelection> Akonadi::EmailAddressSelection::List

A list of email address selection objects.

Definition at line 55 of file emailaddressselection.h.

---

Constructor & Destructor Documentation

Akonadi::EmailAddressSelection::EmailAddressSelection

(

)

Creates a new email address selection.

Akonadi::EmailAddressSelection::EmailAddressSelection

(

const EmailAddressSelection &

other

)

Creates a new email address selection from an other selection.

Akonadi::EmailAddressSelection::~EmailAddressSelection

(

)

Destroys the email address selection.

---

Member Function Documentation

QString Akonadi::EmailAddressSelection::email

(

)

const

Returns the address part of the selected email address.

Note:

If a contact group has been selected, the name of the contact group is returned here and must be expanded by the caller.

bool Akonadi::EmailAddressSelection::isValid

(

)

const

Returns whether the selection is valid.

Akonadi::Item Akonadi::EmailAddressSelection::item

(

)

const

Returns the Akonadi item that is associated with the selected email address.

QString Akonadi::EmailAddressSelection::name

(

)

const

Returns the name that is associated with the selected email address.

EmailAddressSelection& Akonadi::EmailAddressSelection::operator=

(

const EmailAddressSelection &

other

)

Replaces this email address selection with the other selection.

QString Akonadi::EmailAddressSelection::quotedEmail

(

)

const

Returns the name and email address together, properly quoted if needed.

Note:

If a contact group has been selected, the name of the contact group is returned here and must be expanded by the caller.

---

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

• emailaddressselection.h