KContacts::Addressee
#include <addressee.h>

Public Types | |
typedef AddresseeList | List |
typedef QHash< QString, Addressee > | Map |
Properties | |
QString | additionalName |
QVariantList | addresses |
QDate | anniversary |
QString | assembledName |
QString | assistantsName |
QDateTime | birthday |
bool | birthdayHasTime |
QUrl | blogFeed |
QStringList | categories |
bool | changed |
QStringList | customs |
QString | department |
QVariantList | emails |
QString | familyName |
QString | formattedName |
KContacts::Geo | geo |
QString | givenName |
QVariantList | impps |
bool | isEmpty |
QString | mailer |
QString | managersName |
QString | name |
QString | nickName |
QString | note |
QString | office |
QString | organization |
QVariantList | phoneNumbers |
KContacts::Picture | photo |
QString | preferredEmail |
QString | prefix |
QString | productId |
QString | profession |
QString | realName |
QDateTime | revision |
QString | role |
QString | sortString |
QString | spousesName |
QString | suffix |
QString | title |
QString | uid |
KContacts::ResourceLocatorUrl | url |
QVariantList | urls |
Public Member Functions | |
Addressee () | |
Addressee (const Addressee &other) | |
~Addressee () | |
void | addEmail (const Email &email) |
QString | additionalName () const |
Address | address (Address::Type type) const |
Address::List | addresses () const |
Address::List | addresses (Address::Type type) const |
QDate | anniversary () const |
QString | assembledName () const |
QString | assistantsName () const |
QDateTime | birthday () const |
bool | birthdayHasTime () const |
QUrl | blogFeed () const |
CalendarUrl::List | calendarUrlList () const |
QStringList | categories () const |
bool | changed () const |
ClientPidMap::List | clientPidMapList () const |
QString | custom (const QString &app, const QString &name) const |
QStringList | customs () const |
QString | department () const |
KContacts::Email::List | emailList () const |
QStringList | emails () const |
Picture::List | extraLogoList () const |
NickName::List | extraNickNameList () const |
Org::List | extraOrganizationList () const |
Picture::List | extraPhotoList () const |
Role::List | extraRoleList () const |
Sound::List | extraSoundList () const |
Title::List | extraTitleList () const |
ResourceLocatorUrl::List | extraUrlList () const |
QString | familyName () const |
FieldGroup::List | fieldGroupList () const |
Address | findAddress (const QString &id) const |
Key | findKey (const QString &id) const |
PhoneNumber | findPhoneNumber (const QString &id) const |
QString | formattedName () const |
QString | fullEmail (const QString &email=QString()) const |
Gender | gender () const |
Geo | geo () const |
QString | givenName () const |
bool | hasCategory (const QString &category) const |
Impp::List | imppList () const |
void | insertAddress (const Address &address) |
void | insertCalendarUrl (const CalendarUrl &calendarUrl) |
void | insertCategory (const QString &category) |
void | insertClientPidMap (const ClientPidMap &clientpidmap) |
void | insertCustom (const QString &app, const QString &name, const QString &value) |
void | insertEmail (const QString &email, bool preferred=false, const QMap< QString, QStringList > ¶m=QMap< QString, QStringList >()) |
void | insertExtraLogo (const Picture &logo) |
void | insertExtraNickName (const NickName &nickName) |
void | insertExtraOrganization (const Org &organization) |
void | insertExtraPhoto (const Picture &picture) |
void | insertExtraRole (const Role &role) |
void | insertExtraSound (const Sound &sound) |
void | insertExtraTitle (const Title &title) |
void | insertExtraUrl (const ResourceLocatorUrl &url) |
void | insertFieldGroup (const FieldGroup &fieldGroup) |
void | insertImpp (const Impp &impp) |
void | insertKey (const Key &key) |
void | insertLang (const Lang &language) |
void | insertMember (const QString &member) |
void | insertPhoneNumber (const PhoneNumber &phoneNumber) |
void | insertRelationship (const Related &related) |
void | insertSourceUrl (const QUrl &url) |
bool | isEmpty () const |
Key | key (Key::Type type, const QString &customTypeString=QString()) const |
Key::List | keys () const |
Key::List | keys (Key::Type type, const QString &customTypeString=QString()) const |
QString | kind () const |
Lang::List | langs () const |
Picture | logo () const |
QString | mailer () const |
QString | managersName () const |
QStringList | members () const |
QString | name () const |
QString | nickName () const |
QString | note () const |
QString | office () const |
bool | operator!= (const Addressee &other) const |
Addressee & | operator= (const Addressee &other) |
bool | operator== (const Addressee &other) const |
QString | organization () const |
PhoneNumber | phoneNumber (PhoneNumber::Type type) const |
PhoneNumber::List | phoneNumbers () const |
PhoneNumber::List | phoneNumbers (PhoneNumber::Type type) const |
Picture | photo () const |
QString | preferredEmail () const |
QString | prefix () const |
QString | productId () const |
QString | profession () const |
QString | realName () const |
Related::List | relationships () const |
void | removeAddress (const Address &address) |
void | removeCategory (const QString &category) |
void | removeCustom (const QString &app, const QString &name) |
void | removeEmail (const QString &email) |
void | removeKey (const Key &key) |
void | removeLang (const QString &language) |
void | removePhoneNumber (const PhoneNumber &phoneNumber) |
QDateTime | revision () const |
QString | role () const |
Secrecy | secrecy () const |
void | setAdditionalName (const QString &additionalName) |
void | setAddresses (const Address::List &addresses) |
void | setAnniversary (const QDate &anniversary) |
void | setAssistantsName (const QString &assistantsName) |
void | setBirthday (const QDate &birthday) |
void | setBirthday (const QDateTime &birthday, bool withTime=true) |
void | setBlogFeed (const QUrl &blogFeed) |
void | setCategories (const QStringList &category) |
void | setChanged (bool value) |
void | setClientPidMapList (const ClientPidMap::List &clientpidmaplist) |
void | setCustoms (const QStringList &customs) |
void | setDepartment (const QString &department) |
void | setEmailList (const Email::List &list) |
void | setEmails (const QStringList &list) |
void | setExtraLogoList (const Picture::List &logoList) |
void | setExtraNickNameList (const NickName::List &nickNameList) |
void | setExtraOrganizationList (const Org::List &orgList) |
void | setExtraPhotoList (const Picture::List &pictureList) |
void | setExtraRoleList (const Role::List &roleList) |
void | setExtraSoundList (const Sound::List &soundList) |
void | setExtraTitleList (const Title::List &urltitle) |
void | setExtraUrlList (const ResourceLocatorUrl::List &urlList) |
void | setFamilyName (const QString &familyName) |
void | setFieldGroupList (const FieldGroup::List &fieldGroupList) |
void | setFormattedName (const QString &formattedName) |
void | setGender (const Gender &gender) |
void | setGeo (const Geo &geo) |
void | setGivenName (const QString &givenName) |
void | setImppList (const Impp::List &imppList) |
void | setKeys (const Key::List &keys) |
void | setKind (const QString &kind) |
void | setLangs (const Lang::List &langs) |
void | setLogo (const Picture &logo) |
void | setMailer (const QString &mailer) |
void | setManagersName (const QString &managersName) |
void | setMembers (const QStringList &c) |
void | setName (const QString &name) |
void | setNameFromString (const QString &s) |
void | setNickName (const NickName &nickName) |
void | setNickName (const QString &nickName) |
void | setNote (const QString ¬e) |
void | setOffice (const QString &office) |
void | setOrganization (const Org &organization) |
void | setOrganization (const QString &organization) |
void | setPhoneNumbers (const PhoneNumber::List &phoneNumbers) |
void | setPhoto (const Picture &photo) |
void | setPrefix (const QString &prefix) |
void | setProductId (const QString &productId) |
void | setProfession (const QString &profession) |
void | setRelationships (const Related::List &c) |
void | setRevision (const QDateTime &revision) |
void | setRole (const QString &role) |
void | setRole (const Role &role) |
void | setSecrecy (const Secrecy &secrecy) |
void | setSortString (const QString &sortString) |
void | setSound (const Sound &sound) |
void | setSourcesUrlList (const QVector< QUrl > &urlList) |
void | setSpousesName (const QString &spousesName) |
void | setSuffix (const QString &suffix) |
void | setTimeZone (const TimeZone &timeZone) |
void | setTitle (const QString &title) |
void | setTitle (const Title &title) |
void | setUid (const QString &uid) |
void | setUrl (const QUrl &url) |
void | setUrl (const ResourceLocatorUrl &url) |
QString | sortString () const |
Sound | sound () const |
QVector< QUrl > | sourcesUrlList () const |
QString | spousesName () const |
QString | suffix () const |
TimeZone | timeZone () const |
QString | title () const |
QString | toString () const |
QString | uid () const |
ResourceLocatorUrl | url () const |
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 constructs 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 entry, but shouldn't be used for displaying the data to the user.
Definition at line 69 of file addressee.h.
Member Typedef Documentation
◆ List
A list of addressee objects.
Definition at line 131 of file addressee.h.
◆ Map
typedef QHash<QString, Addressee> KContacts::Addressee::Map |
A map from unique identifier to addressee.
- Deprecated:
- Since 5.88, as it's not used anywhere.
- See also
- uid()
Definition at line 142 of file addressee.h.
Constructor & Destructor Documentation
◆ Addressee() [1/2]
Addressee::Addressee | ( | ) |
Construct an empty address book entry.
Definition at line 182 of file addressee.cpp.
◆ ~Addressee()
Addressee::~Addressee | ( | ) |
Destroys the address book entry.
Definition at line 187 of file addressee.cpp.
◆ Addressee() [2/2]
Addressee::Addressee | ( | const Addressee & | other | ) |
Copy constructor.
Definition at line 191 of file addressee.cpp.
Member Function Documentation
◆ addEmail()
void Addressee::addEmail | ( | const 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.
- Since
- 5.88
Definition at line 1619 of file addressee.cpp.
◆ additionalName()
QString KContacts::Addressee::additionalName | ( | ) | const |
Return additional names.
◆ additionalNameLabel()
|
static |
Return translated label for additionalName field.
Definition at line 730 of file addressee.cpp.
◆ address()
Address Addressee::address | ( | Address::Type | type | ) | const |
Return address, which matches the given type.
- Parameters
-
type The type of address to look for
Definition at line 2049 of file addressee.cpp.
◆ addresses() [1/2]
Address::List KContacts::Addressee::addresses | ( | ) | const |
Return list of all addresses.
◆ addresses() [2/2]
Address::List Addressee::addresses | ( | Address::Type | type | ) | const |
Return list of addresses with a special type.
- Parameters
-
type The type of addresses to look for
Definition at line 2070 of file addressee.cpp.
◆ anniversary()
QDate KContacts::Addressee::anniversary | ( | ) | const |
Returns the contact's anniversary date.
- Note
- This is a non-standard extension using the
X-Anniversary
field.
- Since
- 5.12
◆ assembledName()
QString KContacts::Addressee::assembledName | ( | ) | const |
Return the name that consists of all name parts.
◆ assistantsName()
QString KContacts::Addressee::assistantsName | ( | ) | const |
Returns the contact's assistant's name.
- Note
- This is a non-standard extension using the
X-AssistantsName
field.
- Since
- 5.12
◆ birthday()
QDateTime KContacts::Addressee::birthday | ( | ) | const |
Return birthday.
(If a valid date has been set, birthday().time() will always return a valid QTime!)
◆ birthdayHasTime()
bool KContacts::Addressee::birthdayHasTime | ( | ) | const |
Returns true if birthday has been set with a time.
Returns false otherwise.
◆ birthdayLabel()
|
static |
Return translated label for birthday field.
Definition at line 861 of file addressee.cpp.
◆ blogFeed()
QUrl KContacts::Addressee::blogFeed | ( | ) | const |
Returns the contact's blog feed.
- Note
- This is a non-standard extension using the
BlogFeed
field.
- Since
- 5.12
◆ businessAddressCountryLabel()
|
static |
Return translated label for businessAddressCountry field.
Definition at line 926 of file addressee.cpp.
◆ businessAddressLabelLabel()
|
static |
Return translated label for businessAddressLabel field.
Definition at line 931 of file addressee.cpp.
◆ businessAddressLocalityLabel()
|
static |
Return translated label for businessAddressLocality field.
Definition at line 911 of file addressee.cpp.
◆ businessAddressPostalCodeLabel()
|
static |
Return translated label for businessAddressPostalCode field.
Definition at line 921 of file addressee.cpp.
◆ businessAddressPostOfficeBoxLabel()
|
static |
Return translated label for businessAddressPostOfficeBox field.
Definition at line 906 of file addressee.cpp.
◆ businessAddressRegionLabel()
|
static |
Return translated label for businessAddressRegion field.
Definition at line 916 of file addressee.cpp.
◆ businessAddressStreetLabel()
|
static |
Return translated label for businessAddressStreet field.
Definition at line 901 of file addressee.cpp.
◆ businessFaxLabel()
|
static |
Return translated label for businessFax field.
Definition at line 956 of file addressee.cpp.
◆ businessPhoneLabel()
|
static |
Return translated label for businessPhone field.
Definition at line 941 of file addressee.cpp.
◆ carPhoneLabel()
|
static |
Return translated label for carPhone field.
Definition at line 961 of file addressee.cpp.
◆ categories()
QStringList KContacts::Addressee::categories | ( | ) | const |
Return list of all set categories.
◆ changed()
bool KContacts::Addressee::changed | ( | ) | const |
Return whether the addressee is changed.
◆ custom()
Return value of custom entry, identified by app and entry name.
- Parameters
-
app Name of the application which has inserted this custom entry name Name of this application specific custom entry
Definition at line 2304 of file addressee.cpp.
◆ customs()
QStringList KContacts::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'.
◆ department()
QString KContacts::Addressee::department | ( | ) | const |
Return department.
◆ departmentLabel()
|
static |
Return translated label for department field.
Definition at line 1209 of file addressee.cpp.
◆ emailLabel()
|
static |
Return translated label for email field.
Definition at line 976 of file addressee.cpp.
◆ emails()
QStringList KContacts::Addressee::emails | ( | ) | const |
Return list of all email addresses.
◆ familyName()
QString KContacts::Addressee::familyName | ( | ) | const |
Return family name.
◆ familyNameLabel()
|
static |
Return translated label for familyName field.
Definition at line 690 of file addressee.cpp.
◆ findAddress()
Return address with the given id.
- Parameters
-
id The identifier of the address to look for. See Address::id()
Definition at line 2081 of file addressee.cpp.
◆ findKey()
Return key with the given id.
- Parameters
-
id The identifier of the key to look for. See Key::id()
Definition at line 1932 of file addressee.cpp.
◆ findPhoneNumber()
PhoneNumber Addressee::findPhoneNumber | ( | const QString & | id | ) | const |
Return phone number with the given id.
- Parameters
-
id The identifier of the phone number to look for. See PhoneNumber::id()
Definition at line 1845 of file addressee.cpp.
◆ formattedName()
QString KContacts::Addressee::formattedName | ( | ) | const |
Return formatted name.
◆ formattedNameLabel()
|
static |
Return translated label for formattedName field.
Definition at line 670 of file addressee.cpp.
◆ fullEmail()
Return email address including real name.
- Parameters
-
email Email address to be used to construct the full email string. If this is QString() the preferred email address is used.
Definition at line 1590 of file addressee.cpp.
◆ geo()
Geo KContacts::Addressee::geo | ( | ) | const |
Return geographic position.
◆ geoLabel()
|
static |
Return translated label for geo field.
Definition at line 1036 of file addressee.cpp.
◆ givenName()
QString KContacts::Addressee::givenName | ( | ) | const |
Return given name.
◆ givenNameLabel()
|
static |
Return translated label for givenName field.
Definition at line 710 of file addressee.cpp.
◆ hasCategory()
bool Addressee::hasCategory | ( | const QString & | category | ) | const |
Return, if addressee has the given category.
Definition at line 2107 of file addressee.cpp.
◆ homeAddressCountryLabel()
|
static |
Return translated label for homeAddressCountry field.
Definition at line 891 of file addressee.cpp.
◆ homeAddressLabelLabel()
|
static |
Return translated label for homeAddressLabel field.
Definition at line 896 of file addressee.cpp.
◆ homeAddressLocalityLabel()
|
static |
Return translated label for homeAddressLocality field.
Definition at line 876 of file addressee.cpp.
◆ homeAddressPostalCodeLabel()
|
static |
Return translated label for homeAddressPostalCode field.
Definition at line 886 of file addressee.cpp.
◆ homeAddressPostOfficeBoxLabel()
|
static |
Return translated label for homeAddressPostOfficeBox field.
Definition at line 871 of file addressee.cpp.
◆ homeAddressRegionLabel()
|
static |
Return translated label for homeAddressRegion field.
Definition at line 881 of file addressee.cpp.
◆ homeAddressStreetLabel()
|
static |
Return translated label for homeAddressStreet field.
Definition at line 866 of file addressee.cpp.
◆ homeFaxLabel()
|
static |
Return translated label for homeFax field.
Definition at line 951 of file addressee.cpp.
◆ homePhoneLabel()
|
static |
Return translated label for homePhone field.
Definition at line 936 of file addressee.cpp.
◆ insertAddress()
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.
- Parameters
-
address The address to insert
Definition at line 2014 of file addressee.cpp.
◆ insertCategory()
void Addressee::insertCategory | ( | const QString & | category | ) |
Insert category.
If the category already exists it is not duplicated.
Definition at line 2089 of file addressee.cpp.
◆ insertCustom()
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)
- Parameters
-
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
Definition at line 2275 of file addressee.cpp.
◆ insertEmail()
void Addressee::insertEmail | ( | const QString & | email, |
bool | preferred = false , |
||
const QMap< QString, QStringList > & | param = QMap<QString, QStringList>() |
||
) |
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.
- Deprecated:
- Since 5.88, use addEmail(const Email &) instead; you can use the Email methods to set any parameters, e.g. Email::setPreferred(), Email::setType() ...etc
Definition at line 1644 of file addressee.cpp.
◆ insertKey()
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.
- Parameters
-
key The key to insert
Definition at line 1854 of file addressee.cpp.
◆ insertLang()
void Addressee::insertLang | ( | const Lang & | language | ) |
◆ insertPhoneNumber()
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.
- Parameters
-
phoneNumber The telephone number to insert to the addressee
Definition at line 1778 of file addressee.cpp.
◆ isdnLabel()
|
static |
Return translated label for isdn field.
Definition at line 966 of file addressee.cpp.
◆ isEmpty()
bool KContacts::Addressee::isEmpty | ( | ) | const |
Return if the address book entry is empty.
◆ key()
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.
- Parameters
-
type The type of key to look for customTypeString A string to match custom keys against when type
isKey::Custom
Definition at line 1876 of file addressee.cpp.
◆ keys() [1/2]
Key::List Addressee::keys | ( | ) | const |
Return list of all keys.
Definition at line 1902 of file addressee.cpp.
◆ keys() [2/2]
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.
- Parameters
-
type The type of key to look for customTypeString A string to match custom keys against when type
isKey::Custom
Definition at line 1907 of file addressee.cpp.
◆ langs()
Lang::List Addressee::langs | ( | ) | const |
◆ logo()
Picture Addressee::logo | ( | ) | const |
Return logo.
Definition at line 1350 of file addressee.cpp.
◆ logoLabel()
|
static |
Return translated label for logo field.
Definition at line 1355 of file addressee.cpp.
◆ mailer()
QString KContacts::Addressee::mailer | ( | ) | const |
Return mail client.
◆ mailerLabel()
|
static |
Return translated label for mailer field.
Definition at line 996 of file addressee.cpp.
◆ managersName()
QString KContacts::Addressee::managersName | ( | ) | const |
Returns the contact's manager's name.
- Note
- This is a non-standard extension using the
X-ManagersName
field.
- Since
- 5.12
◆ mimeType()
|
static |
Returns the MIME type used for Addressees.
Definition at line 2538 of file addressee.cpp.
◆ mobilePhoneLabel()
|
static |
Return translated label for mobilePhone field.
Definition at line 946 of file addressee.cpp.
◆ name()
QString KContacts::Addressee::name | ( | ) | const |
Return name.
◆ nameLabel()
|
static |
Return translated label for name field.
Definition at line 474 of file addressee.cpp.
◆ nickName()
QString KContacts::Addressee::nickName | ( | ) | const |
Return nick name.
◆ nickNameLabel()
|
static |
Return translated label for nickName field.
Definition at line 821 of file addressee.cpp.
◆ note()
QString KContacts::Addressee::note | ( | ) | const |
Return note.
◆ noteLabel()
|
static |
Return translated label for note field.
Definition at line 1229 of file addressee.cpp.
◆ office()
QString KContacts::Addressee::office | ( | ) | const |
Returns the contact's office.
- Note
- This is a non-standard extension using the
X-Office
field.
- Since
- 5.12
◆ operator!=()
bool Addressee::operator!= | ( | const Addressee & | other | ) | const |
Not-equal operator.
- Returns
true
ifthis
and the given addressee are not equal, otherwisefalse
Definition at line 429 of file addressee.cpp.
◆ operator=()
◆ operator==()
bool Addressee::operator== | ( | const Addressee & | other | ) | const |
Equality operator.
- Returns
true
ifthis
and the given addressee are equal, otherwisefalse
Definition at line 205 of file addressee.cpp.
◆ organization()
QString KContacts::Addressee::organization | ( | ) | const |
Return organization.
◆ organizationLabel()
|
static |
Return translated label for organization field.
Definition at line 1189 of file addressee.cpp.
◆ pagerLabel()
|
static |
Return translated label for pager field.
Definition at line 971 of file addressee.cpp.
◆ parseEmailAddress()
|
static |
Parse full email address.
The result is given back in fullName and email.
- Parameters
-
rawEmail The input string to parse for name and email fullName The name part of the rawEmail
input, if it contained oneemail The email part of the rawEmail
input, if it contained one
Definition at line 2349 of file addressee.cpp.
◆ phoneNumber()
PhoneNumber Addressee::phoneNumber | ( | PhoneNumber::Type | type | ) | const |
Return phone number, which matches the given type.
- Parameters
-
type The type of phone number to get
Definition at line 1806 of file addressee.cpp.
◆ phoneNumbers() [1/2]
PhoneNumber::List KContacts::Addressee::phoneNumbers | ( | ) | const |
Return list of all phone numbers.
◆ phoneNumbers() [2/2]
PhoneNumber::List Addressee::phoneNumbers | ( | PhoneNumber::Type | type | ) | const |
Return list of phone numbers with a special type.
- Parameters
-
type The type of phone number to get
Definition at line 1835 of file addressee.cpp.
◆ photo()
Picture KContacts::Addressee::photo | ( | ) | const |
Return photo.
◆ photoLabel()
|
static |
Return translated label for photo field.
Definition at line 1375 of file addressee.cpp.
◆ preferredEmail()
QString KContacts::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.
◆ prefix()
QString KContacts::Addressee::prefix | ( | ) | const |
Return honorific prefixes.
◆ prefixLabel()
|
static |
Return translated label for prefix field.
Definition at line 750 of file addressee.cpp.
◆ productId()
QString KContacts::Addressee::productId | ( | ) | const |
Return product identifier.
◆ productIdLabel()
|
static |
Return translated label for productId field.
Definition at line 1249 of file addressee.cpp.
◆ profession()
QString KContacts::Addressee::profession | ( | ) | const |
Returns the contact's profession.
- Note
- This is a non-standard extension using the
X-Profession
field.
- Since
- 5.12
◆ realName()
QString KContacts::Addressee::realName | ( | ) | const |
Return the name of the addressee.
This is calculated from all the name fields.
◆ removeAddress()
void Addressee::removeAddress | ( | const Address & | address | ) |
Remove address.
If no address with the given id exists for this addressee, nothing happens.
- Parameters
-
address The address to remove
Definition at line 2033 of file addressee.cpp.
◆ removeCategory()
void Addressee::removeCategory | ( | const QString & | category | ) |
Remove category.
Definition at line 2100 of file addressee.cpp.
◆ removeCustom()
Remove custom entry.
- Parameters
-
app Name of the application which has inserted this custom entry name Name of this application specific custom entry
Definition at line 2295 of file addressee.cpp.
◆ removeEmail()
void Addressee::removeEmail | ( | const QString & | ) |
Remove email address.
If the email address doesn't exist, nothing happens.
- Parameters
-
email Email address to remove
Definition at line 1672 of file addressee.cpp.
◆ removeKey()
void Addressee::removeKey | ( | const Key & | key | ) |
Remove a key.
If no key with the given id exists for this addressee, nothing happens.
- Parameters
-
key The key to remove
Definition at line 1868 of file addressee.cpp.
◆ removeLang()
void Addressee::removeLang | ( | const QString & | language | ) |
◆ removePhoneNumber()
void Addressee::removePhoneNumber | ( | const PhoneNumber & | phoneNumber | ) |
Remove phone number.
If no phone number with the given id exists for this addressee, nothing happens.
- Parameters
-
phoneNumber The telephone number to remove from the addressee
Definition at line 1795 of file addressee.cpp.
◆ revision()
QDateTime KContacts::Addressee::revision | ( | ) | const |
Return revision date.
◆ revisionLabel()
|
static |
Return translated label for revision field.
Definition at line 1269 of file addressee.cpp.
◆ role()
QString KContacts::Addressee::role | ( | ) | const |
Return role.
◆ roleLabel()
|
static |
Return translated label for role field.
Definition at line 1138 of file addressee.cpp.
◆ secrecy()
Secrecy Addressee::secrecy | ( | ) | const |
Return security class.
Definition at line 1330 of file addressee.cpp.
◆ secrecyLabel()
|
static |
Return translated label for secrecy field.
Definition at line 1335 of file addressee.cpp.
◆ setAdditionalName()
void Addressee::setAdditionalName | ( | const QString & | additionalName | ) |
Set additional names.
Definition at line 715 of file addressee.cpp.
◆ setAddresses()
void Addressee::setAddresses | ( | const Address::List & | addresses | ) |
Set the addressee.
- Parameters
-
addresses The new addresses
- Since
- 5.100
Definition at line 2043 of file addressee.cpp.
◆ setAnniversary()
void Addressee::setAnniversary | ( | const QDate & | anniversary | ) |
Sets the contact's anniversary date.
- Note
- This is a non-standard extension using the
X-Anniversary
field.
- Since
- 5.12
Definition at line 2182 of file addressee.cpp.
◆ setAssistantsName()
void Addressee::setAssistantsName | ( | const QString & | assistantsName | ) |
Set the contact's assistant's name.
- Note
- This is a non-standard extension using the
X-AssistantsName
field.
- Since
- 5.12
Definition at line 2196 of file addressee.cpp.
◆ setBirthday() [1/2]
void Addressee::setBirthday | ( | const QDate & | birthday | ) |
Set birthday (date only).
birthdayHasTime() will return false afterwards.
Definition at line 840 of file addressee.cpp.
◆ setBirthday() [2/2]
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.
- Since
- 5.4
Definition at line 826 of file addressee.cpp.
◆ setBlogFeed()
void Addressee::setBlogFeed | ( | const QUrl & | blogFeed | ) |
Set the contact's blog feed.
- Note
- This is a non-standard extension using the
BlogFeed
field.
- Since
- 5.12
Definition at line 2210 of file addressee.cpp.
◆ setCategories()
void Addressee::setCategories | ( | const QStringList & | category | ) |
Set categories to given value.
Definition at line 2112 of file addressee.cpp.
◆ setChanged()
void Addressee::setChanged | ( | bool | value | ) |
Mark addressee as changed.
- Parameters
-
value Sets the status indicating changed data
Definition at line 2528 of file addressee.cpp.
◆ setCustoms()
void Addressee::setCustoms | ( | const QStringList & | customs | ) |
Set all custom entries.
Definition at line 2311 of file addressee.cpp.
◆ setDepartment()
void Addressee::setDepartment | ( | const QString & | department | ) |
Set department.
Definition at line 1194 of file addressee.cpp.
◆ setEmails()
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 1707 of file addressee.cpp.
◆ setFamilyName()
void Addressee::setFamilyName | ( | const QString & | familyName | ) |
Set family name.
Definition at line 675 of file addressee.cpp.
◆ setFormattedName()
void Addressee::setFormattedName | ( | const QString & | formattedName | ) |
Set formatted name.
Definition at line 655 of file addressee.cpp.
◆ setGeo()
void Addressee::setGeo | ( | const Geo & | geo | ) |
Set geographic position.
Definition at line 1021 of file addressee.cpp.
◆ setGivenName()
void Addressee::setGivenName | ( | const QString & | givenName | ) |
Set given name.
Definition at line 695 of file addressee.cpp.
◆ setKeys()
void Addressee::setKeys | ( | const Key::List & | keys | ) |
Set the list of keys.
- Parameters
-
keys The keys to be set.
Definition at line 1896 of file addressee.cpp.
◆ setLogo()
void Addressee::setLogo | ( | const Picture & | logo | ) |
Set logo.
Definition at line 1340 of file addressee.cpp.
◆ setMailer()
void Addressee::setMailer | ( | const QString & | mailer | ) |
Set mail client.
Definition at line 981 of file addressee.cpp.
◆ setManagersName()
void Addressee::setManagersName | ( | const QString & | managersName | ) |
Set the contact's manager's name.
- Note
- This is a non-standard extension using the
X-ManagersName
field.
- Since
- 5.12
Definition at line 2224 of file addressee.cpp.
◆ setName()
void Addressee::setName | ( | const QString & | name | ) |
Set name.
Definition at line 459 of file addressee.cpp.
◆ setNameFromString()
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 1400 of file addressee.cpp.
◆ setNickName()
void Addressee::setNickName | ( | const QString & | nickName | ) |
Set nick name.
Definition at line 775 of file addressee.cpp.
◆ setNote()
void Addressee::setNote | ( | const QString & | note | ) |
Set note.
Definition at line 1214 of file addressee.cpp.
◆ setOffice()
void Addressee::setOffice | ( | const QString & | office | ) |
Set the contact's office.
- Note
- This is a non-standard extension using the
X-Office
field.
- Since
- 5.12
Definition at line 2238 of file addressee.cpp.
◆ setOrganization()
void Addressee::setOrganization | ( | const QString & | organization | ) |
Set organization.
Definition at line 1143 of file addressee.cpp.
◆ setPhoto()
void Addressee::setPhoto | ( | const Picture & | photo | ) |
Set photo.
Definition at line 1360 of file addressee.cpp.
◆ setPrefix()
void Addressee::setPrefix | ( | const QString & | prefix | ) |
Set honorific prefixes.
Definition at line 735 of file addressee.cpp.
◆ setProductId()
void Addressee::setProductId | ( | const QString & | productId | ) |
Set product identifier.
Definition at line 1234 of file addressee.cpp.
◆ setProfession()
void Addressee::setProfession | ( | const QString & | profession | ) |
Set the contact's profession.
- Note
- This is a non-standard extension using the
X-Profession
field.
- Since
- 5.12
Definition at line 2252 of file addressee.cpp.
◆ setRevision()
void Addressee::setRevision | ( | const QDateTime & | revision | ) |
Set revision date.
Definition at line 1254 of file addressee.cpp.
◆ setRole()
void Addressee::setRole | ( | const QString & | role | ) |
Set role.
Definition at line 1092 of file addressee.cpp.
◆ setSecrecy()
void Addressee::setSecrecy | ( | const Secrecy & | secrecy | ) |
Set security class.
Definition at line 1320 of file addressee.cpp.
◆ setSortString()
void Addressee::setSortString | ( | const QString & | sortString | ) |
Set sort string.
Definition at line 1274 of file addressee.cpp.
◆ setSound()
void Addressee::setSound | ( | const Sound & | sound | ) |
Set sound.
Definition at line 1380 of file addressee.cpp.
◆ setSpousesName()
void Addressee::setSpousesName | ( | const QString & | spousesName | ) |
Set the contact's spouse's name.
- Note
- This is a non-standard extension using the
X-SpousesName
field.
- Since
- 5.12
Definition at line 2266 of file addressee.cpp.
◆ setSuffix()
void Addressee::setSuffix | ( | const QString & | suffix | ) |
Set honorific suffixes.
Definition at line 755 of file addressee.cpp.
◆ setTimeZone()
void Addressee::setTimeZone | ( | const TimeZone & | timeZone | ) |
Set time zone.
Definition at line 1001 of file addressee.cpp.
◆ setTitle()
void Addressee::setTitle | ( | const QString & | title | ) |
Set title.
Definition at line 1041 of file addressee.cpp.
◆ setUid()
void Addressee::setUid | ( | const QString & | uid | ) |
Set unique identifier.
- Parameters
-
uid the KABC unique identifier
Definition at line 439 of file addressee.cpp.
◆ setUrl()
void Addressee::setUrl | ( | const ResourceLocatorUrl & | url | ) |
Set homepage.
Definition at line 1301 of file addressee.cpp.
◆ sortString()
QString KContacts::Addressee::sortString | ( | ) | const |
Return sort string.
◆ sortStringLabel()
|
static |
Return translated label for sortString field.
Definition at line 1289 of file addressee.cpp.
◆ sound()
Sound Addressee::sound | ( | ) | const |
Return sound.
Definition at line 1390 of file addressee.cpp.
◆ soundLabel()
|
static |
Return translated label for sound field.
Definition at line 1395 of file addressee.cpp.
◆ spousesName()
QString KContacts::Addressee::spousesName | ( | ) | const |
Returns the contact's spouse's name.
- Note
- This is a non-standard extension using the
X-SpousesName
field.
- Since
- 5.12
◆ suffix()
QString KContacts::Addressee::suffix | ( | ) | const |
Return honorific suffixes.
◆ suffixLabel()
|
static |
Return translated label for suffix field.
Definition at line 770 of file addressee.cpp.
◆ timeZone()
TimeZone Addressee::timeZone | ( | ) | const |
Return time zone.
Definition at line 1011 of file addressee.cpp.
◆ timeZoneLabel()
|
static |
Return translated label for timeZone field.
Definition at line 1016 of file addressee.cpp.
◆ title()
QString KContacts::Addressee::title | ( | ) | const |
Return title.
◆ titleLabel()
|
static |
Return translated label for title field.
Definition at line 1087 of file addressee.cpp.
◆ toString()
QString Addressee::toString | ( | ) | const |
Returns string representation of the addressee.
Definition at line 1941 of file addressee.cpp.
◆ uid()
QString KContacts::Addressee::uid | ( | ) | const |
Return unique identifier.
◆ uidLabel()
|
static |
Return translated label for uid field.
Definition at line 454 of file addressee.cpp.
◆ url()
ResourceLocatorUrl KContacts::Addressee::url | ( | ) | const |
Return homepage.
◆ urlLabel()
|
static |
Return translated label for url field.
Definition at line 1315 of file addressee.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon Sep 25 2023 04:08:01 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.