KContacts::Addressee

#include <addressee.h>

Inheritance diagram for KContacts::Addressee:

Public Types

typedef AddresseeList List
 
typedef QHash< QString, AddresseeMap
 

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
 
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 ()
 
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 > &param=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
 
Addresseeoperator= (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 setAnniversary (const QDate &anniversary)
 
void setAssistantsName (const QString &assistantsName)
 
void setBirthday (const QDateTime &birthday, bool withTime=true)
 
void setBirthday (const QDate &birthday)
 
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 QString &nickName)
 
void setNickName (const NickName &nickName)
 
void setNote (const QString &note)
 
void setOffice (const QString &office)
 
void setOrganization (const QString &organization)
 
void setOrganization (const Org &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 ResourceLocatorUrl &url)
 
void setUrl (const QUrl &url)
 
QString sortString () const
 
Sound sound () const
 
QVector< QUrlsourcesUrlList () const
 
QString spousesName () const
 
QString suffix () const
 
TimeZone timeZone () const
 
QString title () const
 
QString toString () const
 
QString uid () const
 
ResourceLocatorUrl url () const
 

Static Public Member Functions

static QString additionalNameLabel ()
 
static QString birthdayLabel ()
 
static QString businessAddressCountryLabel ()
 
static QString businessAddressLabelLabel ()
 
static QString businessAddressLocalityLabel ()
 
static QString businessAddressPostalCodeLabel ()
 
static QString businessAddressPostOfficeBoxLabel ()
 
static QString businessAddressRegionLabel ()
 
static QString businessAddressStreetLabel ()
 
static QString businessFaxLabel ()
 
static QString businessPhoneLabel ()
 
static QString carPhoneLabel ()
 
static QString departmentLabel ()
 
static QString emailLabel ()
 
static QString familyNameLabel ()
 
static QString formattedNameLabel ()
 
static QString geoLabel ()
 
static QString givenNameLabel ()
 
static QString homeAddressCountryLabel ()
 
static QString homeAddressLabelLabel ()
 
static QString homeAddressLocalityLabel ()
 
static QString homeAddressPostalCodeLabel ()
 
static QString homeAddressPostOfficeBoxLabel ()
 
static QString homeAddressRegionLabel ()
 
static QString homeAddressStreetLabel ()
 
static QString homeFaxLabel ()
 
static QString homePhoneLabel ()
 
static QString isdnLabel ()
 
static QString logoLabel ()
 
static QString mailerLabel ()
 
static QString mimeType ()
 
static QString mobilePhoneLabel ()
 
static QString nameLabel ()
 
static QString nickNameLabel ()
 
static QString noteLabel ()
 
static QString organizationLabel ()
 
static QString pagerLabel ()
 
static void parseEmailAddress (const QString &rawEmail, QString &fullName, QString &email)
 
static QString photoLabel ()
 
static QString prefixLabel ()
 
static QString productIdLabel ()
 
static QString revisionLabel ()
 
static QString roleLabel ()
 
static QString secrecyLabel ()
 
static QString sortStringLabel ()
 
static QString soundLabel ()
 
static QString suffixLabel ()
 
static QString timeZoneLabel ()
 
static QString titleLabel ()
 
static QString uidLabel ()
 
static QString urlLabel ()
 

Friends

KCONTACTS_EXPORT QDataStreamoperator<< (QDataStream &, const Addressee &)
 
KCONTACTS_EXPORT QDataStreamoperator>> (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 68 of file addressee.h.

Member Typedef Documentation

A list of addressee objects.

Definition at line 129 of file addressee.h.

A map from unique identifier to addressee.

See also
uid()

Definition at line 135 of file addressee.h.

Constructor & Destructor Documentation

Addressee::Addressee ( )

Construct an empty address book entry.

Definition at line 147 of file addressee.cpp.

Addressee::~Addressee ( )

Destroys the address book entry.

Definition at line 152 of file addressee.cpp.

Addressee::Addressee ( const Addressee other)

Copy constructor.

Definition at line 156 of file addressee.cpp.

Member Function Documentation

QString KContacts::Addressee::additionalName ( ) const

Return additional names.

QString Addressee::additionalNameLabel ( )
static

Return translated label for additionalName field.

Definition at line 694 of file addressee.cpp.

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

Return address, which matches the given type.

Parameters
typeThe type of address to look for

Definition at line 2008 of file addressee.cpp.

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

Return list of all addresses.

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

Return list of addresses with a special type.

Parameters
typeThe type of addresses to look for

Definition at line 2031 of file addressee.cpp.

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
QString KContacts::Addressee::assembledName ( ) const

Return the name that consists of all name parts.

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
QDateTime KContacts::Addressee::birthday ( ) const

Return birthday.

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

bool KContacts::Addressee::birthdayHasTime ( ) const

Returns true if birthday has been set with a time.

Returns false otherwise.

QString Addressee::birthdayLabel ( )
static

Return translated label for birthday field.

Definition at line 825 of file addressee.cpp.

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
QString Addressee::businessAddressCountryLabel ( )
static

Return translated label for businessAddressCountry field.

Definition at line 890 of file addressee.cpp.

QString Addressee::businessAddressLabelLabel ( )
static

Return translated label for businessAddressLabel field.

Definition at line 895 of file addressee.cpp.

QString Addressee::businessAddressLocalityLabel ( )
static

Return translated label for businessAddressLocality field.

Definition at line 875 of file addressee.cpp.

QString Addressee::businessAddressPostalCodeLabel ( )
static

Return translated label for businessAddressPostalCode field.

Definition at line 885 of file addressee.cpp.

QString Addressee::businessAddressPostOfficeBoxLabel ( )
static

Return translated label for businessAddressPostOfficeBox field.

Definition at line 870 of file addressee.cpp.

QString Addressee::businessAddressRegionLabel ( )
static

Return translated label for businessAddressRegion field.

Definition at line 880 of file addressee.cpp.

QString Addressee::businessAddressStreetLabel ( )
static

Return translated label for businessAddressStreet field.

Definition at line 865 of file addressee.cpp.

QString Addressee::businessFaxLabel ( )
static

Return translated label for businessFax field.

Definition at line 920 of file addressee.cpp.

QString Addressee::businessPhoneLabel ( )
static

Return translated label for businessPhone field.

Definition at line 905 of file addressee.cpp.

QString Addressee::carPhoneLabel ( )
static

Return translated label for carPhone field.

Definition at line 925 of file addressee.cpp.

QStringList KContacts::Addressee::categories ( ) const

Return list of all set categories.

bool KContacts::Addressee::changed ( ) const

Return whether the addressee is changed.

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

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

Parameters
appName of the application which has inserted this custom entry
nameName of this application specific custom entry

Definition at line 2264 of file addressee.cpp.

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'.

QString KContacts::Addressee::department ( ) const

Return department.

QString Addressee::departmentLabel ( )
static

Return translated label for department field.

Definition at line 1173 of file addressee.cpp.

QString Addressee::emailLabel ( )
static

Return translated label for email field.

Definition at line 940 of file addressee.cpp.

QStringList KContacts::Addressee::emails ( ) const

Return list of all email addresses.

QString KContacts::Addressee::familyName ( ) const

Return family name.

QString Addressee::familyNameLabel ( )
static

Return translated label for familyName field.

Definition at line 654 of file addressee.cpp.

Address Addressee::findAddress ( const QString id) const

Return address with the given id.

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

Definition at line 2046 of file addressee.cpp.

Key Addressee::findKey ( const QString id) const

Return key with the given id.

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

Definition at line 1887 of file addressee.cpp.

PhoneNumber Addressee::findPhoneNumber ( const QString id) const

Return phone number with the given id.

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

Definition at line 1787 of file addressee.cpp.

QString KContacts::Addressee::formattedName ( ) const

Return formatted name.

QString Addressee::formattedNameLabel ( )
static

Return translated label for formattedName field.

Definition at line 634 of file addressee.cpp.

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

Return email address including real name.

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

Definition at line 1554 of file addressee.cpp.

Geo KContacts::Addressee::geo ( ) const

Return geographic position.

QString Addressee::geoLabel ( )
static

Return translated label for geo field.

Definition at line 1000 of file addressee.cpp.

QString KContacts::Addressee::givenName ( ) const

Return given name.

QString Addressee::givenNameLabel ( )
static

Return translated label for givenName field.

Definition at line 674 of file addressee.cpp.

bool Addressee::hasCategory ( const QString category) const

Return, if addressee has the given category.

Definition at line 2076 of file addressee.cpp.

QString Addressee::homeAddressCountryLabel ( )
static

Return translated label for homeAddressCountry field.

Definition at line 855 of file addressee.cpp.

QString Addressee::homeAddressLabelLabel ( )
static

Return translated label for homeAddressLabel field.

Definition at line 860 of file addressee.cpp.

QString Addressee::homeAddressLocalityLabel ( )
static

Return translated label for homeAddressLocality field.

Definition at line 840 of file addressee.cpp.

QString Addressee::homeAddressPostalCodeLabel ( )
static

Return translated label for homeAddressPostalCode field.

Definition at line 850 of file addressee.cpp.

QString Addressee::homeAddressPostOfficeBoxLabel ( )
static

Return translated label for homeAddressPostOfficeBox field.

Definition at line 835 of file addressee.cpp.

QString Addressee::homeAddressRegionLabel ( )
static

Return translated label for homeAddressRegion field.

Definition at line 845 of file addressee.cpp.

QString Addressee::homeAddressStreetLabel ( )
static

Return translated label for homeAddressStreet field.

Definition at line 830 of file addressee.cpp.

QString Addressee::homeFaxLabel ( )
static

Return translated label for homeFax field.

Definition at line 915 of file addressee.cpp.

QString Addressee::homePhoneLabel ( )
static

Return translated label for homePhone field.

Definition at line 900 of file addressee.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.

Parameters
addressThe address to insert

Definition at line 1977 of file addressee.cpp.

void Addressee::insertCategory ( const QString category)

Insert category.

If the category already exists it is not duplicated.

Definition at line 2058 of file addressee.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)

Parameters
appName of the application inserting this custom entry
nameName of this application specific custom entry
valueValue of this application specific custom entry

Definition at line 2244 of file addressee.cpp.

void Addressee::insertEmail ( const QString email,
bool  preferred = false,
const QMap< QString, QStringList > &  param = QMap<QStringQStringList>() 
)

Insert an email address.

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

Parameters
emailEmail address
preferredSet to true, if this is the preferred email address of the addressee.

Definition at line 1583 of file addressee.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.

Parameters
keyThe key to insert

Definition at line 1799 of file addressee.cpp.

void Addressee::insertLang ( const Lang language)

Insert Language.

insertLang

Parameters
language

Definition at line 1677 of file addressee.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.

Parameters
phoneNumberThe telephone number to insert to the addressee

Definition at line 1716 of file addressee.cpp.

QString Addressee::isdnLabel ( )
static

Return translated label for isdn field.

Definition at line 930 of file addressee.cpp.

bool KContacts::Addressee::isEmpty ( ) const

Return if the address book entry is empty.

Key Addressee::key ( 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.

Parameters
typeThe type of key to look for
customTypeStringA string to match custom keys against when type is Key::Custom

Definition at line 1830 of file addressee.cpp.

Key::List Addressee::keys ( ) const

Return list of all keys.

Definition at line 1858 of file addressee.cpp.

Key::List Addressee::keys ( 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.

Parameters
typeThe type of key to look for
customTypeStringA string to match custom keys against when type is Key::Custom

Definition at line 1863 of file addressee.cpp.

Lang::List Addressee::langs ( ) const

langs

Returns
List of lang

Definition at line 1696 of file addressee.cpp.

Picture Addressee::logo ( ) const

Return logo.

Definition at line 1314 of file addressee.cpp.

QString Addressee::logoLabel ( )
static

Return translated label for logo field.

Definition at line 1319 of file addressee.cpp.

QString KContacts::Addressee::mailer ( ) const

Return mail client.

QString Addressee::mailerLabel ( )
static

Return translated label for mailer field.

Definition at line 960 of file addressee.cpp.

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
QString Addressee::mimeType ( )
static

Returns the MIME type used for Addressees.

Definition at line 2494 of file addressee.cpp.

QString Addressee::mobilePhoneLabel ( )
static

Return translated label for mobilePhone field.

Definition at line 910 of file addressee.cpp.

QString KContacts::Addressee::name ( ) const

Return name.

QString Addressee::nameLabel ( )
static

Return translated label for name field.

Definition at line 438 of file addressee.cpp.

QString KContacts::Addressee::nickName ( ) const

Return nick name.

QString Addressee::nickNameLabel ( )
static

Return translated label for nickName field.

Definition at line 785 of file addressee.cpp.

QString KContacts::Addressee::note ( ) const

Return note.

QString Addressee::noteLabel ( )
static

Return translated label for note field.

Definition at line 1193 of file addressee.cpp.

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
bool Addressee::operator!= ( const Addressee other) const

Not-equal operator.

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

Definition at line 393 of file addressee.cpp.

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

Assignment operator.

Returns
a reference to this

Definition at line 161 of file addressee.cpp.

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

Equality operator.

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

Definition at line 170 of file addressee.cpp.

QString KContacts::Addressee::organization ( ) const

Return organization.

QString Addressee::organizationLabel ( )
static

Return translated label for organization field.

Definition at line 1153 of file addressee.cpp.

QString Addressee::pagerLabel ( )
static

Return translated label for pager field.

Definition at line 935 of file addressee.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.

Parameters
rawEmailThe input string to parse for name and email
fullNameThe name part of the rawEmail input, if it contained one
emailThe email part of the rawEmail input, if it contained one

Definition at line 2305 of file addressee.cpp.

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

Return phone number, which matches the given type.

Parameters
typeThe type of phone number to get

Definition at line 1744 of file addressee.cpp.

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

Return list of all phone numbers.

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

Return list of phone numbers with a special type.

Parameters
typeThe type of phone number to get

Definition at line 1773 of file addressee.cpp.

Picture Addressee::photo ( ) const

Return photo.

Definition at line 1334 of file addressee.cpp.

QString Addressee::photoLabel ( )
static

Return translated label for photo field.

Definition at line 1339 of file addressee.cpp.

QString KContacts::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.

QString KContacts::Addressee::prefix ( ) const

Return honorific prefixes.

QString Addressee::prefixLabel ( )
static

Return translated label for prefix field.

Definition at line 714 of file addressee.cpp.

QString KContacts::Addressee::productId ( ) const

Return product identifier.

QString Addressee::productIdLabel ( )
static

Return translated label for productId field.

Definition at line 1213 of file addressee.cpp.

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
QString KContacts::Addressee::realName ( ) const

Return the name of the addressee.

This is calculated from all the name fields.

void Addressee::removeAddress ( const Address address)

Remove address.

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

Parameters
addressThe address to remove

Definition at line 1997 of file addressee.cpp.

void Addressee::removeCategory ( const QString category)

Remove category.

Definition at line 2069 of file addressee.cpp.

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

Remove custom entry.

Parameters
appName of the application which has inserted this custom entry
nameName of this application specific custom entry

Definition at line 2257 of file addressee.cpp.

void Addressee::removeEmail ( const QString email)

Remove email address.

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

Parameters
emailEmail address to remove

Definition at line 1610 of file addressee.cpp.

void Addressee::removeKey ( const Key key)

Remove a key.

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

Parameters
keyThe key to remove

Definition at line 1819 of file addressee.cpp.

void Addressee::removeLang ( const QString language)

Remove Language.

removeLang

Parameters
language

Definition at line 1662 of file addressee.cpp.

void Addressee::removePhoneNumber ( const PhoneNumber phoneNumber)

Remove phone number.

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

Parameters
phoneNumberThe telephone number to remove from the addressee

Definition at line 1733 of file addressee.cpp.

QDateTime KContacts::Addressee::revision ( ) const

Return revision date.

QString Addressee::revisionLabel ( )
static

Return translated label for revision field.

Definition at line 1233 of file addressee.cpp.

QString KContacts::Addressee::role ( ) const

Return role.

QString Addressee::roleLabel ( )
static

Return translated label for role field.

Definition at line 1102 of file addressee.cpp.

Secrecy Addressee::secrecy ( ) const

Return security class.

Definition at line 1294 of file addressee.cpp.

QString Addressee::secrecyLabel ( )
static

Return translated label for secrecy field.

Definition at line 1299 of file addressee.cpp.

void Addressee::setAdditionalName ( const QString additionalName)

Set additional names.

Definition at line 679 of file addressee.cpp.

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 2151 of file addressee.cpp.

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 2165 of file addressee.cpp.

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 790 of file addressee.cpp.

void Addressee::setBirthday ( const QDate birthday)

Set birthday (date only).

birthdayHasTime() will return false afterwards.

Definition at line 804 of file addressee.cpp.

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 2179 of file addressee.cpp.

void Addressee::setCategories ( const QStringList category)

Set categories to given value.

Definition at line 2081 of file addressee.cpp.

void Addressee::setChanged ( bool  value)

Mark addressee as changed.

Parameters
valueSets the status indicating changed data

Definition at line 2484 of file addressee.cpp.

void Addressee::setCustoms ( const QStringList customs)

Set all custom entries.

Definition at line 2271 of file addressee.cpp.

void Addressee::setDepartment ( const QString department)

Set department.

Definition at line 1158 of file addressee.cpp.

void Addressee::setEmails ( const QStringList list)

Set the emails to list.

The first email address gets the preferred one!

Parameters
listThe list of email addresses.

Definition at line 1645 of file addressee.cpp.

void Addressee::setFamilyName ( const QString familyName)

Set family name.

Definition at line 639 of file addressee.cpp.

void Addressee::setFormattedName ( const QString formattedName)

Set formatted name.

Definition at line 619 of file addressee.cpp.

void Addressee::setGeo ( const Geo geo)

Set geographic position.

Definition at line 985 of file addressee.cpp.

void Addressee::setGivenName ( const QString givenName)

Set given name.

Definition at line 659 of file addressee.cpp.

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

Set the list of keys.

Parameters
keysThe keys to be set.

Definition at line 1852 of file addressee.cpp.

void Addressee::setLogo ( const Picture logo)

Set logo.

Definition at line 1304 of file addressee.cpp.

void Addressee::setMailer ( const QString mailer)

Set mail client.

Definition at line 945 of file addressee.cpp.

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 2193 of file addressee.cpp.

void Addressee::setName ( const QString name)

Set name.

Definition at line 423 of file addressee.cpp.

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 1364 of file addressee.cpp.

void Addressee::setNickName ( const QString nickName)

Set nick name.

Definition at line 739 of file addressee.cpp.

void Addressee::setNote ( const QString note)

Set note.

Definition at line 1178 of file addressee.cpp.

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 2207 of file addressee.cpp.

void Addressee::setOrganization ( const QString organization)

Set organization.

Definition at line 1107 of file addressee.cpp.

void Addressee::setPhoto ( const Picture photo)

Set photo.

Definition at line 1324 of file addressee.cpp.

void Addressee::setPrefix ( const QString prefix)

Set honorific prefixes.

Definition at line 699 of file addressee.cpp.

void Addressee::setProductId ( const QString productId)

Set product identifier.

Definition at line 1198 of file addressee.cpp.

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 2221 of file addressee.cpp.

void Addressee::setRevision ( const QDateTime revision)

Set revision date.

Definition at line 1218 of file addressee.cpp.

void Addressee::setRole ( const QString role)

Set role.

Definition at line 1056 of file addressee.cpp.

void Addressee::setSecrecy ( const Secrecy secrecy)

Set security class.

Definition at line 1284 of file addressee.cpp.

void Addressee::setSortString ( const QString sortString)

Set sort string.

Definition at line 1238 of file addressee.cpp.

void Addressee::setSound ( const Sound sound)

Set sound.

Definition at line 1344 of file addressee.cpp.

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 2235 of file addressee.cpp.

void Addressee::setSuffix ( const QString suffix)

Set honorific suffixes.

Definition at line 719 of file addressee.cpp.

void Addressee::setTimeZone ( const TimeZone timeZone)

Set time zone.

Definition at line 965 of file addressee.cpp.

void Addressee::setTitle ( const QString title)

Set title.

Definition at line 1005 of file addressee.cpp.

void Addressee::setUid ( const QString uid)

Set unique identifier.

Parameters
uidthe KABC unique identifier

Definition at line 403 of file addressee.cpp.

void Addressee::setUrl ( const ResourceLocatorUrl url)

Set homepage.

Definition at line 1265 of file addressee.cpp.

QString KContacts::Addressee::sortString ( ) const

Return sort string.

QString Addressee::sortStringLabel ( )
static

Return translated label for sortString field.

Definition at line 1253 of file addressee.cpp.

Sound Addressee::sound ( ) const

Return sound.

Definition at line 1354 of file addressee.cpp.

QString Addressee::soundLabel ( )
static

Return translated label for sound field.

Definition at line 1359 of file addressee.cpp.

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
QString KContacts::Addressee::suffix ( ) const

Return honorific suffixes.

QString Addressee::suffixLabel ( )
static

Return translated label for suffix field.

Definition at line 734 of file addressee.cpp.

TimeZone Addressee::timeZone ( ) const

Return time zone.

Definition at line 975 of file addressee.cpp.

QString Addressee::timeZoneLabel ( )
static

Return translated label for timeZone field.

Definition at line 980 of file addressee.cpp.

QString KContacts::Addressee::title ( ) const

Return title.

QString Addressee::titleLabel ( )
static

Return translated label for title field.

Definition at line 1051 of file addressee.cpp.

QString Addressee::toString ( ) const

Returns string representation of the addressee.

Definition at line 1899 of file addressee.cpp.

QString KContacts::Addressee::uid ( ) const

Return unique identifier.

QString Addressee::uidLabel ( )
static

Return translated label for uid field.

Definition at line 418 of file addressee.cpp.

ResourceLocatorUrl KContacts::Addressee::url ( ) const

Return homepage.

QString Addressee::urlLabel ( )
static

Return translated label for url field.

Definition at line 1279 of file addressee.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Wed Sep 23 2020 22:55:28 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.