Member Function Documentation

Addressee::Addressee()

Construct an empty address book entry.

Addressee::Addressee(const KContacts::Addressee &other)

Copy constructor.

[noexcept] Addressee::~Addressee()

Destroys the address book entry.

[since 5.88] void Addressee::addEmail(const KContacts::Email &email)

Adds an email address. If the email address (i.e. email.mail()) already exists in this addressee it won't be duplicated, instead email is assigned to it.

This function was introduced in 5.88.

QString Addressee::additionalName() const

Return additional names.

See also setAdditionalName().

[static] QString Addressee::additionalNameLabel()

Return translated label for additionalName field.

KContacts::Address Addressee::address(KContacts::Address::Type type) const

Return address, which matches the given type.

type The type of address to look for

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

Return list of all addresses.

See also setAddresses().

KContacts::Address::List Addressee::addresses(KContacts::Address::Type type) const

Return list of addresses with a special type.

type The type of addresses to look for

[since 5.12] QDate Addressee::anniversary() const

Returns the contact's anniversary date.

This function was introduced in 5.12.

See also setAnniversary().

QString Addressee::assembledName() const

Return the name that consists of all name parts.

[since 5.12] QString Addressee::assistantsName() const

Returns the contact's assistant's name.

This function was introduced in 5.12.

See also setAssistantsName().

QDateTime Addressee::birthday() const

Return birthday. (If a valid date has been set, birthday().time() will always return a valid QTime!)

See also setBirthday().

bool Addressee::birthdayHasTime() const

Returns true if birthday has been set with a time. Returns false otherwise.

[static] QString Addressee::birthdayLabel()

Return translated label for birthday field.

[since 5.12] QUrl Addressee::blogFeed() const

Returns the contact's blog feed.

This function was introduced in 5.12.

See also setBlogFeed().

[static] QString Addressee::businessAddressCountryLabel()

Return translated label for businessAddressCountry field.

[static] QString Addressee::businessAddressLabelLabel()

Return translated label for businessAddressLabel field.

[static] QString Addressee::businessAddressLocalityLabel()

Return translated label for businessAddressLocality field.

[static] QString Addressee::businessAddressPostOfficeBoxLabel()

Return translated label for businessAddressPostOfficeBox field.

[static] QString Addressee::businessAddressPostalCodeLabel()

Return translated label for businessAddressPostalCode field.

[static] QString Addressee::businessAddressRegionLabel()

Return translated label for businessAddressRegion field.

[static] QString Addressee::businessAddressStreetLabel()

Return translated label for businessAddressStreet field.

[static] QString Addressee::businessFaxLabel()

Return translated label for businessFax field.

[static] QString Addressee::businessPhoneLabel()

Return translated label for businessPhone field.

KContacts::CalendarUrl::List Addressee::calendarUrlList() const

[static] QString Addressee::carPhoneLabel()

Return translated label for carPhone field.

QStringList Addressee::categories() const

Return list of all set categories.

See also setCategories().

bool Addressee::changed() const

Return whether the addressee is changed.

See also setChanged().

KContacts::ClientPidMap::List Addressee::clientPidMapList() const

See also setClientPidMapList().

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

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

app Name of the application which has inserted this custom entry

name Name of this application specific custom entry

QStringList Addressee::customs() const

Return list of all custom entries.

The format of the custom entries is 'app-key:value' and the list is sorted alphabetically by 'app-key'.

See also setCustoms().

QString Addressee::department() const

Return department.

See also setDepartment().

[static] QString Addressee::departmentLabel()

Return translated label for department field.

[static] QString Addressee::emailLabel()

Return translated label for email field.

QStringList Addressee::emails() const

Return list of all email addresses.

See also setEmails().

KContacts::Picture::List Addressee::extraLogoList() const

See also setExtraLogoList().

KContacts::NickName::List Addressee::extraNickNameList() const

See also setExtraNickNameList().

KContacts::Org::List Addressee::extraOrganizationList() const

See also setExtraOrganizationList().

KContacts::Picture::List Addressee::extraPhotoList() const

See also setExtraPhotoList().

KContacts::Role::List Addressee::extraRoleList() const

See also setExtraRoleList().

KContacts::Sound::List Addressee::extraSoundList() const

See also setExtraSoundList().

KContacts::Title::List Addressee::extraTitleList() const

See also setExtraTitleList().

KContacts::ResourceLocatorUrl::List Addressee::extraUrlList() const

See also setExtraUrlList().

QString Addressee::familyName() const

Return family name.

See also setFamilyName().

[static] QString Addressee::familyNameLabel()

Return translated label for familyName field.

KContacts::FieldGroup::List Addressee::fieldGroupList() const

See also setFieldGroupList().

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

Return address with the given id.

id The identifier of the address to look for. See Address::id()

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

Return key with the given id.

id The identifier of the key to look for. See Key::id()

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

Return phone number with the given id.

id The identifier of the phone number to look for. See PhoneNumber::id()

QString Addressee::formattedName() const

Return formatted name.

See also setFormattedName().

[static] QString Addressee::formattedNameLabel()

Return translated label for formattedName field.

QString Addressee::fullEmail(const QString &email = QString()) const

Return email address including real name.

email Email address to be used to construct the full email string. If this is QString() the preferred email address is used.

KContacts::Gender Addressee::gender() const

See also setGender().

KContacts::Geo Addressee::geo() const

Return geographic position.

See also setGeo().

[static] QString Addressee::geoLabel()

Return translated label for geo field.

QString Addressee::givenName() const

Return given name.

See also setGivenName().

[static] QString Addressee::givenNameLabel()

Return translated label for givenName field.

bool Addressee::hasCategory(const QString &category) const

Return, if addressee has the given category.

[static] QString Addressee::homeAddressCountryLabel()

Return translated label for homeAddressCountry field.

[static] QString Addressee::homeAddressLabelLabel()

Return translated label for homeAddressLabel field.

[static] QString Addressee::homeAddressLocalityLabel()

Return translated label for homeAddressLocality field.

[static] QString Addressee::homeAddressPostOfficeBoxLabel()

Return translated label for homeAddressPostOfficeBox field.

[static] QString Addressee::homeAddressPostalCodeLabel()

Return translated label for homeAddressPostalCode field.

[static] QString Addressee::homeAddressRegionLabel()

Return translated label for homeAddressRegion field.

[static] QString Addressee::homeAddressStreetLabel()

Return translated label for homeAddressStreet field.

[static] QString Addressee::homeFaxLabel()

Return translated label for homeFax field.

[static] QString Addressee::homePhoneLabel()

Return translated label for homePhone field.

KContacts::Impp::List Addressee::imppList() const

See also setImppList().

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

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

address The address to insert

void Addressee::insertCalendarUrl(const KContacts::CalendarUrl &calendarUrl)

void Addressee::insertCategory(const QString &category)

Insert category. If the category already exists it is not duplicated.

void Addressee::insertClientPidMap(const KContacts::ClientPidMap &clientpidmap)

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)

app Name of the application inserting this custom entry

name Name of this application specific custom entry

value Value of this application specific custom entry

void Addressee::insertExtraLogo(const KContacts::Picture &logo)

void Addressee::insertExtraNickName(const KContacts::NickName &nickName)

void Addressee::insertExtraOrganization(const KContacts::Org &organization)

void Addressee::insertExtraPhoto(const KContacts::Picture &picture)

void Addressee::insertExtraRole(const KContacts::Role &role)

void Addressee::insertExtraSound(const KContacts::Sound &sound)

void Addressee::insertExtraTitle(const KContacts::Title &title)

void Addressee::insertExtraUrl(const KContacts::ResourceLocatorUrl &url)

void Addressee::insertFieldGroup(const KContacts::FieldGroup &fieldGroup)

void Addressee::insertImpp(const KContacts::Impp &impp)

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

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

key The key to insert

void Addressee::insertLang(const KContacts::Lang &language)

Insert Language

void Addressee::insertMember(const QString &member)

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

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

phoneNumber The telephone number to insert to the addressee

void Addressee::insertRelationship(const KContacts::Related &related)

void Addressee::insertSourceUrl(const QUrl &url)

bool Addressee::isEmpty() const

Return if the address book entry is empty.

[static] QString Addressee::isdnLabel()

Return translated label for isdn field.

KContacts::Key Addressee::key(KContacts::Key::Type type, const QString &customTypeString = QString()) 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.

type The type of key to look for

customTypeString A string to match custom keys against when type is Key::Custom

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

Return list of all keys.

See also setKeys().

KContacts::Key::List Addressee::keys(KContacts::Key::Type type, const QString &customTypeString = QString()) 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.

type The type of key to look for

customTypeString A string to match custom keys against when type is Key::Custom

QString Addressee::kind() const

See also setKind().

KContacts::Lang::List Addressee::langs() const

Returns List of lang

See also setLangs().

KContacts::Picture Addressee::logo() const

Return logo.

See also setLogo().

[static] QString Addressee::logoLabel()

Return translated label for logo field.

QString Addressee::mailer() const

Return mail client.

See also setMailer().

[static] QString Addressee::mailerLabel()

Return translated label for mailer field.

[since 5.12] QString Addressee::managersName() const

Returns the contact's manager's name.

This function was introduced in 5.12.

See also setManagersName().

QStringList Addressee::members() const

See also setMembers().

[static] QString Addressee::mimeType()

Returns the MIME type used for Addressees

[static] QString Addressee::mobilePhoneLabel()

Return translated label for mobilePhone field.

QString Addressee::name() const

Return name.

See also setName().

[static] QString Addressee::nameLabel()

Return translated label for name field.

QString Addressee::nickName() const

Return nick name.

See also setNickName().

[static] QString Addressee::nickNameLabel()

Return translated label for nickName field.

QString Addressee::note() const

Return note.

See also setNote().

[static] QString Addressee::noteLabel()

Return translated label for note field.

[since 5.12] QString Addressee::office() const

Returns the contact's office.

This function was introduced in 5.12.

See also setOffice().

QString Addressee::organization() const

Return organization.

See also setOrganization().

[static] QString Addressee::organizationLabel()

Return translated label for organization field.

[static] QString Addressee::pagerLabel()

Return translated label for pager field.

[static] void Addressee::parseEmailAddress(const QString &rawEmail, QString &fullName, QString &email)

Parse full email address. The result is given back in fullName and email.

rawEmail The input string to parse for name and email

fullName The name part of the rawEmail input, if it contained one

email The email part of the rawEmail input, if it contained one

KContacts::PhoneNumber Addressee::phoneNumber(KContacts::PhoneNumber::Type type) const

Return phone number, which matches the given type.

type The type of phone number to get

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

Return list of all phone numbers.

See also setPhoneNumbers().

KContacts::PhoneNumber::List Addressee::phoneNumbers(KContacts::PhoneNumber::Type type) const

Return list of phone numbers with a special type.

type The type of phone number to get

KContacts::Picture Addressee::photo() const

Return photo.

See also setPhoto().

[static] QString Addressee::photoLabel()

Return translated label for photo field.

QString Addressee::preferredEmail() const

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

QString Addressee::prefix() const

Return honorific prefixes.

See also setPrefix().

[static] QString Addressee::prefixLabel()

Return translated label for prefix field.

QString Addressee::productId() const

Return product identifier.

See also setProductId().

[static] QString Addressee::productIdLabel()

Return translated label for productId field.

[since 5.12] QString Addressee::profession() const

Returns the contact's profession.

This function was introduced in 5.12.

See also setProfession().

QString Addressee::realName() const

Return the name of the addressee. This is calculated from all the name fields.

KContacts::Related::List Addressee::relationships() const

See also setRelationships().

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

Remove address. If no address with the given id exists for this addressee, nothing happens.

address The address to remove

void Addressee::removeCategory(const QString &category)

Remove category.

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

Remove custom entry.

app Name of the application which has inserted this custom entry

name Name of this application specific custom entry

void Addressee::removeEmail(const QString &email)

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

email Email address to remove

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

Remove a key. If no key with the given id exists for this addressee, nothing happens.

key The key to remove

void Addressee::removeLang(const QString &language)

Remove Language

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

Remove phone number. If no phone number with the given id exists for this addressee, nothing happens.

phoneNumber The telephone number to remove from the addressee

QDateTime Addressee::revision() const

Return revision date.

See also setRevision().

[static] QString Addressee::revisionLabel()

Return translated label for revision field.

QString Addressee::role() const

Return role.

See also setRole().

[static] QString Addressee::roleLabel()

Return translated label for role field.

KContacts::Secrecy Addressee::secrecy() const

Return security class.

See also setSecrecy().

[static] QString Addressee::secrecyLabel()

Return translated label for secrecy field.

void Addressee::setAdditionalName(const QString &additionalName)

Set additional names.

See also additionalName().

[since 5.100] void Addressee::setAddresses(const KContacts::Address::List &addresses)

Set the addressee

addresses The new addresses

This function was introduced in 5.100.

See also addresses().

[since 5.12] void Addressee::setAnniversary(const QDate &anniversary)

Sets the contact's anniversary date.

This function was introduced in 5.12.

See also anniversary().

[since 5.12] void Addressee::setAssistantsName(const QString &assistantsName)

Set the contact's assistant's name.

This function was introduced in 5.12.

See also assistantsName().

void Addressee::setBirthday(const QDate &birthday)

Set birthday (date only). birthdayHasTime() will return false afterwards.

See also birthday().

[since 5.4] void Addressee::setBirthday(const QDateTime &birthday, bool withTime = true)

Set birthday (date and time). If withTime is false the time will be set to midnight and birthdayHasTime() will return false afterwards.

This function was introduced in 5.4.

[since 5.12] void Addressee::setBlogFeed(const QUrl &blogFeed)

Set the contact's blog feed.

This function was introduced in 5.12.

See also blogFeed().

void Addressee::setCategories(const QStringList &category)

Set categories to given value.

See also categories().

void Addressee::setChanged(bool value)

Mark addressee as changed.

value Sets the status indicating changed data

See also changed().

void Addressee::setClientPidMapList(const KContacts::ClientPidMap::List &clientpidmaplist)

See also clientPidMapList().

void Addressee::setCustoms(const QStringList &customs)

Set all custom entries.

See also customs().

void Addressee::setDepartment(const QString &department)

Set department.

See also department().

void Addressee::setEmails(const QStringList &list)

Set the emails to list. The first email address gets the preferred one!

See also emails().

void Addressee::setExtraLogoList(const KContacts::Picture::List &logoList)

See also extraLogoList().

void Addressee::setExtraNickNameList(const KContacts::NickName::List &nickNameList)

See also extraNickNameList().

void Addressee::setExtraOrganizationList(const KContacts::Org::List &orgList)

See also extraOrganizationList().

void Addressee::setExtraPhotoList(const KContacts::Picture::List &pictureList)

See also extraPhotoList().

void Addressee::setExtraRoleList(const KContacts::Role::List &roleList)

See also extraRoleList().

void Addressee::setExtraSoundList(const KContacts::Sound::List &soundList)

See also extraSoundList().

void Addressee::setExtraTitleList(const KContacts::Title::List &urltitle)

See also extraTitleList().

void Addressee::setExtraUrlList(const KContacts::ResourceLocatorUrl::List &urlList)

See also extraUrlList().

void Addressee::setFamilyName(const QString &familyName)

Set family name.

See also familyName().

void Addressee::setFieldGroupList(const KContacts::FieldGroup::List &fieldGroupList)

See also fieldGroupList().

void Addressee::setFormattedName(const QString &formattedName)

Set formatted name.

See also formattedName().

void Addressee::setGender(const KContacts::Gender &gender)

See also gender().

void Addressee::setGeo(const KContacts::Geo &geo)

Set geographic position.

See also geo().

void Addressee::setGivenName(const QString &givenName)

Set given name.

See also givenName().

void Addressee::setImppList(const KContacts::Impp::List &imppList)

See also imppList().

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

Set the list of keys keys The keys to be set.

See also keys().

void Addressee::setKind(const QString &kind)

See also kind().

void Addressee::setLangs(const KContacts::Lang::List &langs)

See also langs().

void Addressee::setLogo(const KContacts::Picture &logo)

Set logo.

See also logo().

void Addressee::setMailer(const QString &mailer)

Set mail client.

See also mailer().

[since 5.12] void Addressee::setManagersName(const QString &managersName)

Set the contact's manager's name.

This function was introduced in 5.12.

See also managersName().

void Addressee::setMembers(const QStringList &c)

See also members().

void Addressee::setName(const QString &name)

Set name.

See also name().

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.

void Addressee::setNickName(const KContacts::NickName &nickName)

See also nickName().

void Addressee::setNickName(const QString &nickName)

Set nick name.

void Addressee::setNote(const QString &note)

Set note.

See also note().

[since 5.12] void Addressee::setOffice(const QString &office)

Set the contact's office.

This function was introduced in 5.12.

See also office().

void Addressee::setOrganization(const KContacts::Org &organization)

See also organization().

void Addressee::setOrganization(const QString &organization)

Set organization.

void Addressee::setPhoto(const KContacts::Picture &photo)

Set photo.

See also photo().

void Addressee::setPrefix(const QString &prefix)

Set honorific prefixes.

See also prefix().

void Addressee::setProductId(const QString &productId)

Set product identifier.

See also productId().

[since 5.12] void Addressee::setProfession(const QString &profession)

Set the contact's profession. @note This is a non-standard extension using the X-Profession field.

This function was introduced in 5.12.

See also profession().

void Addressee::setRelationships(const KContacts::Related::List &c)

See also relationships().

void Addressee::setRevision(const QDateTime &revision)

Set revision date.

See also revision().

void Addressee::setRole(const KContacts::Role &role)

See also role().

void Addressee::setRole(const QString &role)

Set role.

void Addressee::setSecrecy(const KContacts::Secrecy &secrecy)

Set security class.

See also secrecy().

void Addressee::setSortString(const QString &sortString)

Set sort string.

See also sortString().

void Addressee::setSound(const KContacts::Sound &sound)

Set sound.

See also sound().

void Addressee::setSourcesUrlList(const QList<QUrl> &urlList)

See also sourcesUrlList().

[since 5.12] void Addressee::setSpousesName(const QString &spousesName)

Set the contact's spouse's name.

This function was introduced in 5.12.

See also spousesName().

void Addressee::setSuffix(const QString &suffix)

Set honorific suffixes.

See also suffix().

void Addressee::setTimeZone(const KContacts::TimeZone &timeZone)

Set time zone.

See also timeZone().

void Addressee::setTitle(const KContacts::Title &title)

See also title().

void Addressee::setTitle(const QString &title)

Set title.

void Addressee::setUid(const QString &uid)

Set unique identifier.

uid the KABC unique identifier

See also uid().

void Addressee::setUrl(const KContacts::ResourceLocatorUrl &url)

Set homepage.

See also url().

QString Addressee::sortString() const

Return sort string.

See also setSortString().

[static] QString Addressee::sortStringLabel()

Return translated label for sortString field.

KContacts::Sound Addressee::sound() const

Return sound.

See also setSound().

[static] QString Addressee::soundLabel()

Return translated label for sound field.

QList<QUrl> Addressee::sourcesUrlList() const

See also setSourcesUrlList().

[since 5.12] QString Addressee::spousesName() const

Returns the contact's spouse's name.

This function was introduced in 5.12.

See also setSpousesName().

QString Addressee::suffix() const

Return honorific suffixes.

See also setSuffix().

[static] QString Addressee::suffixLabel()

Return translated label for suffix field.

KContacts::TimeZone Addressee::timeZone() const

Return time zone.

See also setTimeZone().

[static] QString Addressee::timeZoneLabel()

Return translated label for timeZone field.

QString Addressee::title() const

Return title.

See also setTitle().

[static] QString Addressee::titleLabel()

Return translated label for title field.

QString Addressee::toString() const

Returns string representation of the addressee.

QString Addressee::uid() const

Return unique identifier.

See also setUid().

[static] QString Addressee::uidLabel()

Return translated label for uid field.

KContacts::ResourceLocatorUrl Addressee::url() const

Return homepage.

See also setUrl().

[static] QString Addressee::urlLabel()

Return translated label for url field.

bool Addressee::operator!=(const KContacts::Addressee &other) const

Not-equal operator.

Returns true if this and the given addressee are not equal, otherwise false

KContacts::Addressee &Addressee::operator=(const KContacts::Addressee &other)

Assignment operator.

Returns a reference to this

bool Addressee::operator==(const KContacts::Addressee &other) const

Equality operator.

Returns true if this and the given addressee are equal, otherwise false