KABC::Addressee Class Reference
address book entry More...
#include <addressee.h>
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 75 of file addressee.h.
Constructor & Destructor Documentation
|
Construct an empty address book entry.
|
|
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::DistributionList::removeEntry(), and KABC::StdAddressBook::setWhoAmI(). |
|
Return translated label for uid field.
|
|
Set name.
|
|
Return name.
|
|
Return translated label for name field.
|
|
Set formatted name.
Referenced by KABC::VCard21Parser::readFromString(). |
|
Return formatted name.
|
|
Return translated label for formattedName field.
|
|
Set family name.
Referenced by KABC::VCard21Parser::readFromString(). |
|
Return family name.
|
|
Return translated label for familyName field.
|
|
Set given name.
Referenced by KABC::VCard21Parser::readFromString(). |
|
Return given name.
|
|
Return translated label for givenName field.
|
|
Set additional names.
Referenced by KABC::VCard21Parser::readFromString(). |
|
Return additional names.
|
|
Return translated label for additionalName field.
|
|
Set honorific prefixes.
Referenced by KABC::VCard21Parser::readFromString(). |
|
Return honorific prefixes.
|
|
Return translated label for prefix field.
|
|
Set honorific suffixes.
Referenced by KABC::VCard21Parser::readFromString(). |
|
Return honorific suffixes.
|
|
Return translated label for suffix field.
|
|
Set nick name.
Referenced by KABC::VCard21Parser::readFromString(). |
|
Return nick name.
|
|
Return translated label for nickName field.
|
|
Set birthday.
Referenced by KABC::VCard21Parser::readFromString(). |
|
Return birthday.
|
|
Return translated label for birthday field.
|
|
Return translated label for homeAddressStreet field.
|
|
Return translated label for homeAddressLocality field.
|
|
Return translated label for homeAddressRegion field.
|
|
Return translated label for homeAddressPostalCode field.
|
|
Return translated label for homeAddressCountry field.
|
|
Return translated label for homeAddressLabel field.
|
|
Return translated label for businessAddressStreet field.
|
|
Return translated label for businessAddressLocality field.
|
|
Return translated label for businessAddressRegion field.
|
|
Return translated label for businessAddressPostalCode field.
|
|
Return translated label for businessAddressCountry field.
|
|
Return translated label for businessAddressLabel field.
|
|
Return translated label for homePhone field.
|
|
Return translated label for businessPhone field.
|
|
Return translated label for mobilePhone field.
|
|
Return translated label for homeFax field.
|
|
Return translated label for businessFax field.
|
|
Return translated label for carPhone field.
|
|
Return translated label for isdn field.
|
|
Return translated label for pager field.
|
|
Return translated label for email field.
|
|
Set mail client.
|
|
Return mail client.
|
|
Return translated label for mailer field.
|
|
Set time zone.
Referenced by KABC::VCard21Parser::readFromString(). |
|
Return time zone.
|
|
Return translated label for timeZone field.
|
|
Set geographic position.
Referenced by KABC::VCard21Parser::readFromString(). |
|
Return geographic position.
|
|
Return translated label for geo field.
|
|
Set title.
Referenced by KABC::VCard21Parser::readFromString(). |
|
Return title.
|
|
Return translated label for title field.
|
|
Set role.
Referenced by KABC::VCard21Parser::readFromString(). |
|
Return role.
|
|
Return translated label for role field.
|
|
Set organization.
Referenced by KABC::VCard21Parser::readFromString(). |
|
Return organization.
|
|
Return translated label for organization field.
|
|
Set note.
Referenced by KABC::VCard21Parser::readFromString(). |
|
Return note.
|
|
Return translated label for note field.
|
|
Set product identifier.
|
|
Return product identifier.
|
|
Return translated label for productId field.
|
|
Set revision date.
Referenced by KABC::VCard21Parser::readFromString(). |
|
Return revision date.
|
|
Return translated label for revision field.
|
|
Set sort string.
|
|
Return sort string.
|
|
Return translated label for sortString field.
|
|
Set homepage.
Referenced by KABC::VCard21Parser::readFromString(). |
|
Return homepage.
|
|
Return translated label for url field.
|
|
Set security class.
|
|
Return security class.
|
|
Return translated label for secrecy field.
|
|
Set logo.
|
|
Return logo.
|
|
Return translated label for logo field.
|
|
Set photo.
|
|
Return photo.
|
|
Return translated label for photo field.
|
|
Set sound.
|
|
Return sound.
|
|
Return translated label for sound field.
|
|
Set agent.
|
|
Return agent.
|
|
Return translated label for agent 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 The first email address gets the preferred one!
|
|
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. An empty value isn't allowed (nothing happens if this is called with any of the three arguments being empty) |
|
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(), and KABC::BinaryFormat::loadAll(). |
|
Return pointer to resource.
|
|
Mark addressee as changed.
Referenced by KABC::VCardFormatPlugin::loadAll(), and KABC::BinaryFormat::loadAll(). |
|
Return whether the addressee is changed.
|
|
Return, if the address book entry is empty.
|
|
Set unique identifier.
|
|
Return unique identifier.
|
|
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. |
|
Return the name that consists of all name parts.
|
|
Return email address including real name.
|
|
Insert an email address. If the email address already exists in this addressee it is not duplicated.
|
|
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. |
|
Return list of all email addresses.
|
|
Set the emails to The first email address gets the preferred one!
|
|
Insert a phone number. If a phone number with the same id already exists in this addressee it is not duplicated. |
|
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. |
|
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. An empty value isn't allowed (nothing happens if this is called with any of the three arguments being empty) |
|
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.
|
|
Return pointer to resource.
|
|
Mark addressee as changed.
|
|
Return whether the addressee is changed.
|
The documentation for this class was generated from the following files: