KABC::Addressee Class Reference

`#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 | setSortMode (KABC::SortMode *mode)

## Friends

KABC_EXPORT QDataStream & | operator<< (QDataStream &, const Addressee &)
KABC_EXPORT QDataStream & | operator>> (QDataStream &, Addressee &)

## Detailed Description

address book entry

This 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 74 of file addressee.src.h.

## Constructor & Destructor Documentation

Addressee::Addressee | ( |  | ) |

Construct an empty address book entry.

Definition at line 77 of file addressee.src.cpp.

## Member Function Documentation

Address Addressee::address | ( | int | type | ) | const

Return address, which matches the given type.

Definition at line 688 of file addressee.src.cpp.

Address::List Addressee::addresses | ( |  | ) | const

Return list of all addresses.

Definition at line 704 of file addressee.src.cpp.

Address::List Addressee::addresses | ( | int | type | ) | const

Return list of addresses with a special type.

Definition at line 709 of file addressee.src.cpp.

QString Addressee::assembledName | ( |  | ) | const

Return the name that consists of all name parts.

Definition at line 359 of file addressee.src.cpp.

QString Addressee::asString | ( |  | ) | const

Returns string representation of the addressee.

Definition at line 607 of file addressee.src.cpp.

QStringList Addressee::categories | ( |  | ) | const

Return list of all set categories.

Definition at line 767 of file addressee.src.cpp.

bool Addressee::changed | ( |  | ) | const

Return whether the addressee is changed.

Definition at line 1011 of file addressee.src.cpp.

QString Addressee::custom | ( | const QString & | app,
|  | const QString & | name
| ) |  | const

Return value of custom entry, identified by app and entry name.

Definition at line 808 of file addressee.src.cpp.

QStringList Addressee::customs | ( |  | ) | const

Return list of all custom entries.

Definition at line 832 of file addressee.src.cpp.

void Addressee::dump | ( |  | ) | const

Debug output.

Definition at line 612 of file addressee.src.cpp.

QStringList Addressee::emails | ( |  | ) | const

Return list of all email addresses.

Definition at line 432 of file addressee.src.cpp.

Address Addressee::findAddress | ( | const QString & | id | ) | const

Return address with the given id.

Definition at line 723 of file addressee.src.cpp.

Key Addressee::findKey | ( | const QString & | id | ) | const

Return key with the given id.

Definition at line 596 of file addressee.src.cpp.

PhoneNumber Addressee::findPhoneNumber | ( | const QString & | id | ) | const

Return phone number with the given id.

Definition at line 504 of file addressee.src.cpp.

QString Addressee::fullEmail | ( | const QString & | email = `QString::null` | ) | const

Return email address including real name.

Parameters

  email | Email address to be used to construct the full email string. If this is QString::null the preferred email address is used.

Definition at line 367 of file addressee.src.cpp.

bool Addressee::hasCategory | ( | const QString & | c | ) | const

Return, if addressee has the given category.

Definition at line 754 of file addressee.src.cpp.

void Addressee::insertAddress | ( | const Address & | address | ) |

Insert an address.

If an address with the same id already exists in this addressee it is not duplicated.

Definition at line 656 of file addressee.src.cpp.

void Addressee::insertCategory | ( | const QString & | c | ) |

Insert category.

If the category already exists it is not duplicated.

Definition at line 734 of file addressee.src.cpp.

void Addressee::insertCustom | ( | const QString & | app,
|  | const QString & | name,
|  | const QString & | value
| ) |  |

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.

An empty value isn't allowed (nothing happens if this is called with any of the three arguments being empty)

Definition at line 772 of file addressee.src.cpp.

void Addressee::insertEmail | ( | const QString & | email,
|  | bool | preferred = `false`
| ) |  |

Insert an email address.

If the email address already exists in this addressee it is not duplicated.

Parameters

  email | Email address
  preferred | Set to true, if this is the preferred email address of the addressee.

Definition at line 393 of file addressee.src.cpp.

void Addressee::insertKey | ( | const Key & | key | ) |

Insert a key.

If a key with the same id already exists in this addressee it is not duplicated.

Definition at line 515 of file addressee.src.cpp.

void Addressee::insertPhoneNumber | ( | const PhoneNumber & | phoneNumber | ) |

Insert a phone number.

If a phone number with the same id already exists in this addressee it is not duplicated.

Definition at line 441 of file addressee.src.cpp.

bool Addressee::isEmpty | ( |  | ) | const

Return, if the address book entry is empty.

Definition at line 160 of file addressee.src.cpp.

Key Addressee::key | ( | int | type,
|  | QString | customTypeString = `QString::null`
| ) |  | const

Return key, which matches the given type.

If `type` == Key::Custom you can specify a string that should match. If you leave the string empty, the first key with a custom value is returned.

Definition at line 543 of file addressee.src.cpp.

Key::List Addressee::keys | ( |  | ) | const

Return list of all keys.

Definition at line 569 of file addressee.src.cpp.

Key::List Addressee::keys | ( | int | type,
|  | QString | customTypeString = `QString::null`
| ) |  | const

Return list of keys with a special type.

If `type` == Key::Custom you can specify a string that should match. If you leave the string empty, all custom keys will be returned.

Definition at line 574 of file addressee.src.cpp.

void Addressee::parseEmailAddress | ( | const QString & | rawEmail,
|  | QString & | fullName,
|  | QString & | email
| ) |  |

static

Parse full email address.

The result is given back in fullName and email.

Definition at line 837 of file addressee.src.cpp.

PhoneNumber Addressee::phoneNumber | ( | int | type | ) | const

Return phone number, which matches the given type.

Definition at line 470 of file addressee.src.cpp.

PhoneNumber::List Addressee::phoneNumbers | ( |  | ) | const

Return list of all phone numbers.

Definition at line 486 of file addressee.src.cpp.

PhoneNumber::List Addressee::phoneNumbers | ( | int | type | ) | const

Return list of phone numbers with a special type.

Definition at line 491 of file addressee.src.cpp.

QString Addressee::preferredEmail | ( |  | ) | const

Return preferred email address.

This is the first email address or the last one added with insertEmail() with a set preferred parameter.

Definition at line 426 of file addressee.src.cpp.

QString Addressee::realName | ( |  | ) | const

Return the name of the addressee.

This is calculated from all the name fields.

Definition at line 342 of file addressee.src.cpp.

void Addressee::removeAddress | ( | const Address & | address | ) |

Remove address.

If no address with the given id exists for this addresse nothing happens.

Definition at line 675 of file addressee.src.cpp.

void Addressee::removeCategory | ( | const QString & | c | ) |

Remove category.

Definition at line 744 of file addressee.src.cpp.

void Addressee::removeCustom | ( | const QString & | app,
|  | const QString & | name
| ) |  |

Remove custom entry.

Definition at line 793 of file addressee.src.cpp.

void Addressee::removeEmail | ( | const QString & | email | ) |

Remove email address.

If the email address doesn't exist, nothing happens.

Definition at line 416 of file addressee.src.cpp.

void Addressee::removeKey | ( | const Key & | key | ) |

Remove a key.

If no key with the given id exists for this addresse nothing happens.

Definition at line 530 of file addressee.src.cpp.

void Addressee::removePhoneNumber | ( | const PhoneNumber & | phoneNumber | ) |

Remove phone number.

If no phone number with the given id exists for this addresse nothing happens.

Definition at line 457 of file addressee.src.cpp.

Resource * Addressee::resource | ( |  | ) | const

Return pointer to resource.

Definition at line 1000 of file addressee.src.cpp.

void Addressee::setCategories | ( | const QStringList & | c | ) |

Set categories to given value.

Definition at line 759 of file addressee.src.cpp.

void Addressee::setChanged | ( | bool | value | ) |

Mark addressee as changed.

Definition at line 1005 of file addressee.src.cpp.

void Addressee::setCustoms | ( | const QStringList & | l | ) |

Set all custom entries.

Definition at line 824 of file addressee.src.cpp.

void Addressee::setEmails | ( | const QStringList & | list | ) |

Set the emails to `list`.

The first email address gets the preferred one!

Parameters

  list | The list of email addresses.

Definition at line 436 of file addressee.src.cpp.

void Addressee::setKeys | ( | const Key::List & | keys | ) |

Set the list of keys.

Parameters

  keys | The keys to be set.

Definition at line 563 of file addressee.src.cpp.

DEFINITIONS void Addressee::setNameFromString | ( | const QString & | s | ) |

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.

Definition at line 185 of file addressee.src.cpp.

void Addressee::setResource | ( | Resource * | resource | ) |

Set resource where the addressee is from.

Definition at line 994 of file addressee.src.cpp.

void Addressee::setUid | ( | const QString & | uid | ) |

Set unique identifier.

Definition at line 165 of file addressee.src.cpp.

QString Addressee::uid | ( |  | ) | const

Return unique identifier.

Definition at line 173 of file addressee.src.cpp.

QString Addressee::uidLabel | ( |  | ) |

static

Return translated label for uid field.

Definition at line 178 of file addressee.src.cpp.

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

- addressee.src.h
- addressee.src.cpp

KDE Home | KDE Accessibility Home | Description of Access Keys