KABC::Addressee Class Reference
address book entry More...
#include <addressee.src.h>
Public Types | |
typedef QValueList< Addressee > | List |
typedef QMap< QString, Addressee > | Map |
Public Member Functions | |
Addressee () | |
Addressee (const Addressee &) | |
Addressee & | operator= (const Addressee &) |
bool | operator== (const Addressee &) const |
bool | operator!= (const Addressee &) const |
bool | isEmpty () const |
void | setUid (const QString &uid) |
QString | uid () const |
DECLARATIONS void | setNameFromString (const QString &) |
QString | realName () const |
QString | assembledName () const |
QString | fullEmail (const QString &email=QString::null) const |
void | insertEmail (const QString &email, bool preferred=false) |
void | removeEmail (const QString &email) |
QString | preferredEmail () const |
QStringList | emails () const |
void | setEmails (const QStringList &list) |
void | insertPhoneNumber (const PhoneNumber &phoneNumber) |
void | removePhoneNumber (const PhoneNumber &phoneNumber) |
PhoneNumber | phoneNumber (int type) const |
PhoneNumber::List | phoneNumbers () const |
PhoneNumber::List | phoneNumbers (int type) const |
PhoneNumber | findPhoneNumber (const QString &id) const |
void | insertKey (const Key &key) |
void | removeKey (const Key &key) |
Key | key (int type, QString customTypeString=QString::null) const |
Key::List | keys () const |
void | setKeys (const Key::List &keys) |
Key::List | keys (int type, QString customTypeString=QString::null) const |
Key | findKey (const QString &id) const |
void | insertAddress (const Address &address) |
void | removeAddress (const Address &address) |
Address | address (int type) const |
Address::List | addresses () const |
Address::List | addresses (int type) const |
Address | findAddress (const QString &id) const |
void | insertCategory (const QString &) |
void | removeCategory (const QString &) |
bool | hasCategory (const QString &) const |
void | setCategories (const QStringList &) |
QStringList | categories () const |
void | insertCustom (const QString &app, const QString &name, const QString &value) |
void | removeCustom (const QString &app, const QString &name) |
QString | custom (const QString &app, const QString &name) const |
void | setCustoms (const QStringList &) |
QStringList | customs () const |
void | dump () const |
QString | asString () const |
void | setResource (Resource *resource) |
Resource * | resource () const |
void | setChanged (bool value) |
bool | changed () const |
bool | operator< (const Addressee &addr) |
Static Public Member Functions | |
static QString | uidLabel () |
static void | parseEmailAddress (const QString &rawEmail, QString &fullName, QString &email) |
static void | setSortKey (KABC::Field *field) |
Friends | |
QDataStream & | operator<< (QDataStream &, const Addressee &) |
QDataStream & | operator>> (QDataStream &, Addressee &) |
Detailed Description
address book entryThis class represents an entry in the address book.
The data of this class is implicitly shared. You can pass this class by value.
If you need the name of a field for presenting it to the user you should use the functions ending in Label(). They return a translated string which can be used as label for the corresponding field.
About the name fields:
givenName() is the first name and familyName() the last name. In some countries the family name comes first, that's the reason for the naming. formattedName() is the full name with the correct formatting. It is used as an override, when the correct formatting can't be generated from the other name fields automatically.
realName() returns a fully formatted name(). It uses formattedName, if set, otherwise it constucts the name from the name fields. As fallback, if nothing else is set it uses name().
name() is the NAME type of RFC2426. It can be used as internal name for the data enty, but shouldn't be used for displaying the data to the user.
Definition at line 73 of file addressee.src.h.
Constructor & Destructor Documentation
|
Construct an empty address book entry.
|
Member Function Documentation
|
Return, if the address book entry is empty.
|
|
Set unique identifier.
|
|
Return unique identifier.
Referenced by KABC::DistributionList::insertEntry(), KABC::ResourceFile::removeAddressee(), and KABC::StdAddressBook::setWhoAmI(). |
|
Return translated label for uid field.
|
|
Set name fields by parsing the given string and trying to associate the parts of the string with according fields. This function should probably be a bit more clever. |
|
Return the name of the addressee. This is calculated from all the name fields. Referenced by KABC::AddresseeItem::AddresseeItem(). |
|
Return the name that consists of all name parts.
|
|
Return email address including real name.
Referenced by KABC::DistributionList::emails(). |
|
Insert an email address. If the email address already exists in this addressee it is not duplicated.
Referenced by KABC::VCard21Parser::readFromString(). |
|
Remove email address. If the email address doesn't exist, nothing happens. |
|
Return preferred email address. This is the first email address or the last one added with insertEmail() with a set preferred parameter. Referenced by KABC::AddresseeItem::AddresseeItem(). |
|
Return list of all email addresses.
|
|
Set the emails to.
|
|
Insert a phone number. If a phone number with the same id already exists in this addressee it is not duplicated. Referenced by KABC::VCard21Parser::readFromString(). |
|
Remove phone number. If no phone number with the given id exists for this addresse nothing happens. |
|
Return phone number, which matches the given type.
|
|
Return list of all phone numbers.
|
|
Return list of phone numbers with a special type.
|
|
Return phone number with the given id.
|
|
Insert a key. If a key with the same id already exists in this addressee it is not duplicated. |
|
Remove a key. If no key with the given id exists for this addresse nothing happens. |
|
Return key, which matches the given type.
If |
|
Return list of all keys.
|
|
Set the list of keys.
|
|
Return list of keys with a special type.
If |
|
Return key with the given id.
|
|
Insert an address. If an address with the same id already exists in this addressee it is not duplicated. Referenced by KABC::VCard21Parser::readFromString(). |
|
Remove address. If no address with the given id exists for this addresse nothing happens. |
|
Return address, which matches the given type.
|
|
Return list of all addresses.
|
|
Return list of addresses with a special type.
|
|
Return address with the given id.
|
|
Insert category. If the category already exists it is not duplicated. |
|
Remove category.
|
|
Return, if addressee has the given category.
|
|
Set categories to given value.
|
|
Return list of all set categories.
|
|
Insert custom entry. The entry is identified by the name of the inserting application and a unique name. If an entry with the given app and name already exists its value is replaced with the new given value. |
|
Remove custom entry.
|
|
Return value of custom entry, identified by app and entry name.
|
|
Set all custom entries.
|
|
Return list of all custom entries.
|
|
Parse full email address. The result is given back in fullName and email. |
|
Debug output.
|
|
Returns string representation of the addressee.
|
|
Set resource where the addressee is from.
Referenced by KABC::VCardFormatPlugin::loadAll(). |
|
Return pointer to resource.
|
|
Mark addressee as changed.
Referenced by KABC::VCardFormatPlugin::loadAll(). |
|
Return whether the addressee is changed.
|
The documentation for this class was generated from the following file: