akonadi/contact
#include <emailaddressselection.h>
Public Types | |
typedef QList < EmailAddressSelection > | List |
Public Member Functions | |
EmailAddressSelection () | |
EmailAddressSelection (const EmailAddressSelection &other) | |
~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.
- 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
EmailAddressSelection::EmailAddressSelection | ( | ) |
Creates a new email address selection.
Definition at line 45 of file emailaddressselection.cpp.
EmailAddressSelection::EmailAddressSelection | ( | const EmailAddressSelection & | other | ) |
Creates a new email address selection from an other
selection.
Definition at line 50 of file emailaddressselection.cpp.
EmailAddressSelection::~EmailAddressSelection | ( | ) |
Destroys the email address selection.
Definition at line 64 of file emailaddressselection.cpp.
Member Function Documentation
QString 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.
Definition at line 78 of file emailaddressselection.cpp.
bool EmailAddressSelection::isValid | ( | ) | const |
Returns whether the selection is valid.
Definition at line 68 of file emailaddressselection.cpp.
Akonadi::Item EmailAddressSelection::item | ( | ) | const |
Returns the Akonadi item that is associated with the selected email address.
Definition at line 98 of file emailaddressselection.cpp.
QString EmailAddressSelection::name | ( | ) | const |
Returns the name that is associated with the selected email address.
Definition at line 73 of file emailaddressselection.cpp.
EmailAddressSelection & EmailAddressSelection::operator= | ( | const EmailAddressSelection & | other | ) |
Replaces this email address selection with the other
selection.
Definition at line 55 of file emailaddressselection.cpp.
QString 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.
Definition at line 83 of file emailaddressselection.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2013 The KDE developers.
Generated on Tue Nov 26 2013 09:03:48 by doxygen 1.8.5 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.