KABC::Addressee Class Reference

#include <addressee.h>

Public Types
typedef AddresseeList	List
typedef QMap< QString, Addressee >	Map

Public Member Functions
	Addressee ()
	Addressee (const Addressee &)
	~Addressee ()
QString	additionalName () const
Address	address (Address::Type type) const
Address::List	addresses () const
Address::List	addresses (Address::Type type) const
QString	assembledName () const
QDateTime	birthday () const
QStringList	categories () const
bool	changed () const
QString	custom (const QString &app, const QString &name) const
QStringList	customs () const
QString	department () const
KABC::Email::List	emailList () const
QStringList	emails () const
KABC::Picture::List	extraLogoList () const
KABC::Picture::List	extraPhotoList () const
KABC::Sound::List	extraSoundList () const
QList< KUrl >	extraUrlList () const
QString	familyName () 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
KABC::Gender	gender () const
Geo	geo () const
QString	givenName () const
bool	hasCategory (const QString &) const
void	insertAddress (const Address &address)
void	insertCalendarUrl (const KABC::CalendarUrl &calendarUrl)
void	insertCategory (const QString &)
void	insertCustom (const QString &app, const QString &name, const QString &value)
void	insertEmail (const QString &email, bool preferred=false)
void	insertEmail (const QString &email, bool preferred, const QMap< QString, QStringList > &param)
void	insertExtraLogo (const KABC::Picture &log)
void	insertExtraPhoto (const KABC::Picture &picture)
void	insertExtraSound (const KABC::Sound &sound)
void	insertExtraUrl (const KUrl &url)
void	insertKey (const Key &key)
void	insertLang (const Lang &language)
void	insertMember (const QString &member)
void	insertPhoneNumber (const PhoneNumber &phoneNumber)
void	insertRelationShip (const QString &related)
void	insertSourceUrl (const KUrl &url)
bool	isEmpty () const
Key	key (Key::Type type, QString customTypeString=QString()) const
Key::List	keys () const
Key::List	keys (Key::Type type, QString customTypeString=QString()) const
QString	kind () const
Lang::List	langs () const
Picture	logo () const
QString	mailer () const
QStringList	members () const
QString	name () const
QString	nickName () const
QString	note () const
bool	operator!= (const Addressee &) const
bool	operator< (const Addressee &addr) const
Addressee &	operator= (const Addressee &)
bool	operator== (const Addressee &) 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	realName () const
QStringList	relationShips () const
void	removeAddress (const Address &address)
void	removeCategory (const QString &)
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)
Resource *	resource () const
QDateTime	revision () const
QString	role () const
Secrecy	secrecy () const
void	setAdditionalName (const QString &additionalName)
void	setBirthday (const QDateTime &birthday)
void	setCategories (const QStringList &)
void	setChanged (bool value)
void	setCustoms (const QStringList &)
void	setDepartment (const QString &department)
void	setEmailList (const Email::List &list)
void	setEmails (const QStringList &list)
void	setExtraLogoList (const KABC::Picture::List &logoList)
void	setExtraPhotoList (const KABC::Picture::List &pictureList)
void	setExtraSoundList (const KABC::Sound::List &soundList)
void	setExtraUrlList (const QList< KUrl > &urlList)
void	setFamilyName (const QString &familyName)
void	setFormattedName (const QString &formattedName)
void	setGender (const KABC::Gender &gender)
void	setGeo (const Geo &geo)
void	setGivenName (const QString &givenName)
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	setMembers (const QStringList &c)
void	setName (const QString &name)
void	setNameFromString (const QString &)
void	setNickName (const QString &nickName)
void	setNote (const QString &note)
void	setOrganization (const QString &organization)
void	setPhoto (const Picture &photo)
void	setPrefix (const QString &prefix)
void	setProductId (const QString &productId)
void	setRelationShips (const QStringList &c)
void	setResource (Resource *resource)
void	setRevision (const QDateTime &revision)
void	setRole (const QString &role)
void	setSecrecy (const Secrecy &secrecy)
void	setSortString (const QString &sortString)
void	setSound (const Sound &sound)
void	setSourcesUrlList (const QList< KUrl > &urlList)
void	setSuffix (const QString &suffix)
void	setTimeZone (const TimeZone &timeZone)
void	setTitle (const QString &title)
void	setUid (const QString &uid)
void	setUrl (const KUrl &url)
QString	sortString () const
Sound	sound () const
QList< KUrl >	sourcesUrlList () const
QString	suffix () const
TimeZone	timeZone () const
QString	title () const
QString	toString () const
QString	uid () const
KUrl	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 void	setSortMode (KABC::SortMode *mode)
static QString	sortStringLabel ()
static QString	soundLabel ()
static QString	suffixLabel ()
static QString	timeZoneLabel ()
static QString	titleLabel ()
static QString	uidLabel ()
static QString	urlLabel ()

Friends
QDataStream &	operator<< (QDataStream &, const Addressee &)
QDataStream &	operator>> (QDataStream &, Addressee &)

Detailed Description

address book entry

This class represents an entry in the address book.

The data of this class is implicitly shared. You can pass this class by value.

If you need the name of a field for presenting it to the user you should use the functions ending in Label(). They return a translated string which can be used as label for the corresponding field.

About the name fields:

givenName() is the first name and familyName() the last name. In some countries the family name comes first, that's the reason for the naming. formattedName() is the full name with the correct formatting. It is used as an override, when the correct formatting can't be generated from the other name fields automatically.

realName() returns a fully formatted name(). It uses formattedName, if set, otherwise it constucts the name from the name fields. As fallback, if nothing else is set it uses name().

name() is the NAME type of RFC2426. It can be used as internal name for the data enty, but shouldn't be used for displaying the data to the user.

Definition at line 78 of file addressee.h.

Member Typedef Documentation

typedef AddresseeList KABC::Addressee::List

A list of addressee objects.

Definition at line 87 of file addressee.h.

typedef QMap<QString, Addressee> KABC::Addressee::Map

A map from unique identifier to addressee.

See also

uid()

Definition at line 93 of file addressee.h.

Constructor & Destructor Documentation

Addressee::Addressee

(

)

Construct an empty address book entry.

Definition at line 180 of file addressee.cpp.

Addressee::~Addressee

(

)

Destroys the address book entry.

Definition at line 185 of file addressee.cpp.

Addressee::Addressee

(

const Addressee &

other

)

Copy constructor.

Definition at line 189 of file addressee.cpp.

Member Function Documentation

QString Addressee::additionalName

(

)

const

Return additional names.

Definition at line 639 of file addressee.cpp.

QString Addressee::additionalNameLabel ( )

static

Return translated label for additionalName field.

Definition at line 644 of file addressee.cpp.

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

Address::List Addressee::addresses

(

)

const

Return list of all addresses.

Definition at line 1820 of file addressee.cpp.

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

QString Addressee::assembledName

(

)

const

Return the name that consists of all name parts.

Definition at line 1357 of file addressee.cpp.

QDateTime Addressee::birthday

(

)

const

Return birthday.

Definition at line 719 of file addressee.cpp.

QString Addressee::birthdayLabel ( )

static

Return translated label for birthday field.

Definition at line 724 of file addressee.cpp.

QString Addressee::businessAddressCountryLabel ( )

static

Return translated label for businessAddressCountry field.

Definition at line 802 of file addressee.cpp.

QString Addressee::businessAddressLabelLabel ( )

static

Return translated label for businessAddressLabel field.

Definition at line 808 of file addressee.cpp.

QString Addressee::businessAddressLocalityLabel ( )

static

Return translated label for businessAddressLocality field.

Definition at line 784 of file addressee.cpp.

QString Addressee::businessAddressPostalCodeLabel ( )

static

Return translated label for businessAddressPostalCode field.

Definition at line 796 of file addressee.cpp.

QString Addressee::businessAddressPostOfficeBoxLabel ( )

static

Return translated label for businessAddressPostOfficeBox field.

Definition at line 778 of file addressee.cpp.

QString Addressee::businessAddressRegionLabel ( )

static

Return translated label for businessAddressRegion field.

Definition at line 790 of file addressee.cpp.

QString Addressee::businessAddressStreetLabel ( )

static

Return translated label for businessAddressStreet field.

Definition at line 772 of file addressee.cpp.

QString Addressee::businessFaxLabel ( )

static

Return translated label for businessFax field.

Definition at line 838 of file addressee.cpp.

QString Addressee::businessPhoneLabel ( )

static

Return translated label for businessPhone field.

Definition at line 820 of file addressee.cpp.

QString Addressee::carPhoneLabel ( )

static

Return translated label for carPhone field.

Definition at line 844 of file addressee.cpp.

QStringList Addressee::categories

(

)

const

Return list of all set categories.

Definition at line 1923 of file addressee.cpp.

bool Addressee::changed

(

)

const

Return whether the addressee is changed.

Definition at line 2163 of file addressee.cpp.

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

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

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

Definition at line 1974 of file addressee.cpp.

QString Addressee::department

(

)

const

Return department.

Definition at line 997 of file addressee.cpp.

QString Addressee::departmentLabel ( )

static

Return translated label for department field.

Definition at line 1002 of file addressee.cpp.

QString Addressee::emailLabel ( )

static

Return translated label for email field.

Definition at line 862 of file addressee.cpp.

QStringList Addressee::emails

(

)

const

Return list of all email addresses.

Definition at line 1442 of file addressee.cpp.

QString Addressee::familyName

(

)

const

Return family name.

Definition at line 599 of file addressee.cpp.

QString Addressee::familyNameLabel ( )

static

Return translated label for familyName field.

Definition at line 604 of file addressee.cpp.

Address Addressee::findAddress

(

const QString &

id

)

const

Return address with the given id.

Parameters

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

Definition at line 1840 of file addressee.cpp.

Key Addressee::findKey

(

const QString &

id

)

const

Return key with the given id.

Parameters

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

Definition at line 1679 of file addressee.cpp.

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

QString Addressee::formattedName

(

)

const

Return formatted name.

Definition at line 579 of file addressee.cpp.

QString Addressee::formattedNameLabel ( )

static

Return translated label for formattedName field.

Definition at line 584 of file addressee.cpp.

QString Addressee::fullEmail

(

const QString &

email = QString()

)

const

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

Geo Addressee::geo

(

)

const

Return geographic position.

Definition at line 917 of file addressee.cpp.

QString Addressee::geoLabel ( )

static

Return translated label for geo field.

Definition at line 922 of file addressee.cpp.

QString Addressee::givenName

(

)

const

Return given name.

Definition at line 619 of file addressee.cpp.

QString Addressee::givenNameLabel ( )

static

Return translated label for givenName field.

Definition at line 624 of file addressee.cpp.

bool Addressee::hasCategory

(

const QString &

category

)

const

Return, if addressee has the given category.

Definition at line 1911 of file addressee.cpp.

QString Addressee::homeAddressCountryLabel ( )

static

Return translated label for homeAddressCountry field.

Definition at line 760 of file addressee.cpp.

QString Addressee::homeAddressLabelLabel ( )

static

Return translated label for homeAddressLabel field.

Definition at line 766 of file addressee.cpp.

QString Addressee::homeAddressLocalityLabel ( )

static

Return translated label for homeAddressLocality field.

Definition at line 742 of file addressee.cpp.

QString Addressee::homeAddressPostalCodeLabel ( )

static

Return translated label for homeAddressPostalCode field.

Definition at line 754 of file addressee.cpp.

QString Addressee::homeAddressPostOfficeBoxLabel ( )

static

Return translated label for homeAddressPostOfficeBox field.

Definition at line 736 of file addressee.cpp.

QString Addressee::homeAddressRegionLabel ( )

static

Return translated label for homeAddressRegion field.

Definition at line 748 of file addressee.cpp.

QString Addressee::homeAddressStreetLabel ( )

static

Return translated label for homeAddressStreet field.

Definition at line 730 of file addressee.cpp.

QString Addressee::homeFaxLabel ( )

static

Return translated label for homeFax field.

Definition at line 832 of file addressee.cpp.

QString Addressee::homePhoneLabel ( )

static

Return translated label for homePhone field.

Definition at line 814 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

address

The address to insert

Definition at line 1773 of file addressee.cpp.

void Addressee::insertCategory

(

const QString &

c

)

Insert category.

If the category already exists it is not duplicated.

Definition at line 1894 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

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

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

Insert an email address.

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

Parameters

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

Definition at line 1420 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

key	The key to insert

Definition at line 1599 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

phoneNumber

The telephone number to insert to the addressee

Definition at line 1525 of file addressee.cpp.

QString Addressee::isdnLabel ( )

static

Return translated label for isdn field.

Definition at line 850 of file addressee.cpp.

bool Addressee::isEmpty

(

)

const

Return, if the address book entry is empty.

Definition at line 428 of file addressee.cpp.

Key Addressee::key	(	Key::Type	type,
		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

type	The type of key to look for
customTypeString	A string to match custom keys against when type is Key::Custom

Definition at line 1624 of file addressee.cpp.

Key::List Addressee::keys

(

)

const

Return list of all keys.

Definition at line 1651 of file addressee.cpp.

Key::List Addressee::keys	(	Key::Type	type,
		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

type	The type of key to look for
customTypeString	A string to match custom keys against when type is Key::Custom

Definition at line 1656 of file addressee.cpp.

Picture Addressee::logo

(

)

const

Return logo.

Definition at line 1137 of file addressee.cpp.

QString Addressee::logoLabel ( )

static

Return translated label for logo field.

Definition at line 1142 of file addressee.cpp.

QString Addressee::mailer

(

)

const

Return mail client.

Definition at line 877 of file addressee.cpp.

QString Addressee::mailerLabel ( )

static

Return translated label for mailer field.

Definition at line 882 of file addressee.cpp.

QString Addressee::mimeType ( )

static

Returns the MIME type used for Addressees.

Definition at line 2181 of file addressee.cpp.

QString Addressee::mobilePhoneLabel ( )

static

Return translated label for mobilePhone field.

Definition at line 826 of file addressee.cpp.

QString Addressee::name

(

)

const

Return name.

Definition at line 461 of file addressee.cpp.

QString Addressee::nameLabel ( )

static

Return translated label for name field.

Definition at line 466 of file addressee.cpp.

QString Addressee::nickName

(

)

const

Return nick name.

Definition at line 699 of file addressee.cpp.

QString Addressee::nickNameLabel ( )

static

Return translated label for nickName field.

Definition at line 704 of file addressee.cpp.

QString Addressee::note

(

)

const

Return note.

Definition at line 1017 of file addressee.cpp.

QString Addressee::noteLabel ( )

static

Return translated label for note field.

Definition at line 1022 of file addressee.cpp.

bool Addressee::operator!=

(

const Addressee &

a

)

const

Not-equal operator.

Returns

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

Definition at line 423 of file addressee.cpp.

bool Addressee::operator<

(

const Addressee &

addr

)

const

Return whether this addressee is "less-than" a given one.

Parameters

addr	The addressee object to compare with

See also

setSortMode()

Definition at line 2173 of file addressee.cpp.

Addressee & Addressee::operator=

(

const Addressee &

other

)

Assignment operator.

Returns

a reference to this

Definition at line 194 of file addressee.cpp.

bool Addressee::operator==

(

const Addressee &

addressee

)

const

Equality operator.

Returns

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

Definition at line 202 of file addressee.cpp.

QString Addressee::organization

(

)

const

Return organization.

Definition at line 977 of file addressee.cpp.

QString Addressee::organizationLabel ( )

static

Return translated label for organization field.

Definition at line 982 of file addressee.cpp.

QString Addressee::pagerLabel ( )

static

Return translated label for pager field.

Definition at line 856 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

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

Definition at line 1987 of file addressee.cpp.

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

PhoneNumber::List Addressee::phoneNumbers

(

)

const

Return list of all phone numbers.

Definition at line 1568 of file addressee.cpp.

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

Picture Addressee::photo

(

)

const

Return photo.

Definition at line 1157 of file addressee.cpp.

QString Addressee::photoLabel ( )

static

Return translated label for photo field.

Definition at line 1162 of file addressee.cpp.

QString Addressee::preferredEmail

(

)

const

Return preferred email address.

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

Definition at line 1434 of file addressee.cpp.

QString Addressee::prefix

(

)

const

Return honorific prefixes.

Definition at line 659 of file addressee.cpp.

QString Addressee::prefixLabel ( )

static

Return translated label for prefix field.

Definition at line 664 of file addressee.cpp.

QString Addressee::productId

(

)

const

Return product identifier.

Definition at line 1037 of file addressee.cpp.

QString Addressee::productIdLabel ( )

static

Return translated label for productId field.

Definition at line 1042 of file addressee.cpp.

QString Addressee::realName

(

)

const

Return the name of the addressee.

This is calculated from all the name fields.

Definition at line 1340 of file addressee.cpp.

void Addressee::removeAddress

(

const Address &

address

)

Remove address.

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

Parameters

address

The address to remove

Definition at line 1791 of file addressee.cpp.

void Addressee::removeCategory

(

const QString &

category

)

Remove category.

Definition at line 1904 of file addressee.cpp.

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

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

void Addressee::removeEmail

(

const QString &

email

)

Remove email address.

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

Parameters

email

Email address to remove

Definition at line 1425 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

key	The key to remove

Definition at line 1613 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

phoneNumber

The telephone number to remove from the addressee

Definition at line 1540 of file addressee.cpp.

Resource * Addressee::resource

(

)

const

Return pointer to resource.

Definition at line 2152 of file addressee.cpp.

QDateTime Addressee::revision

(

)

const

Return revision date.

Definition at line 1057 of file addressee.cpp.

QString Addressee::revisionLabel ( )

static

Return translated label for revision field.

Definition at line 1062 of file addressee.cpp.

QString Addressee::role

(

)

const

Return role.

Definition at line 957 of file addressee.cpp.

QString Addressee::roleLabel ( )

static

Return translated label for role field.

Definition at line 962 of file addressee.cpp.

Secrecy Addressee::secrecy

(

)

const

Return security class.

Definition at line 1117 of file addressee.cpp.

QString Addressee::secrecyLabel ( )

static

Return translated label for secrecy field.

Definition at line 1122 of file addressee.cpp.

void Addressee::setAdditionalName

(

const QString &

additionalName

)

Set additional names.

Definition at line 630 of file addressee.cpp.

void Addressee::setBirthday

(

const QDateTime &

birthday

)

Set birthday.

Definition at line 710 of file addressee.cpp.

void Addressee::setCategories

(

const QStringList &

c

)

Set categories to given value.

Definition at line 1916 of file addressee.cpp.

void Addressee::setChanged

(

bool

value

)

Mark addressee as changed.

Parameters

value

Sets the status indicating changed data

Definition at line 2158 of file addressee.cpp.

void Addressee::setCustoms

(

const QStringList &

customs

)

Set all custom entries.

Definition at line 1956 of file addressee.cpp.

void Addressee::setDepartment

(

const QString &

department

)

Set department.

Definition at line 988 of file addressee.cpp.

void Addressee::setEmails

(

const QStringList &

list

)

Set the emails to list.

The first email address gets the preferred one!

Parameters

list	The list of email addresses.

Definition at line 1464 of file addressee.cpp.

void Addressee::setFamilyName

(

const QString &

familyName

)

Set family name.

Definition at line 590 of file addressee.cpp.

void Addressee::setFormattedName

(

const QString &

formattedName

)

Set formatted name.

Definition at line 570 of file addressee.cpp.

void Addressee::setGeo

(

const Geo &

geo

)

Set geographic position.

Definition at line 908 of file addressee.cpp.

void Addressee::setGivenName

(

const QString &

givenName

)

Set given name.

Definition at line 610 of file addressee.cpp.

void Addressee::setKeys

(

const Key::List &

keys

)

Set the list of keys.

Parameters

keys	The keys to be set.

Definition at line 1645 of file addressee.cpp.

void Addressee::setLogo

(

const Picture &

logo

)

Set logo.

Definition at line 1128 of file addressee.cpp.

void Addressee::setMailer

(

const QString &

mailer

)

Set mail client.

Definition at line 868 of file addressee.cpp.

void Addressee::setName

(

const QString &

name

)

Set name.

Definition at line 452 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 1188 of file addressee.cpp.

void Addressee::setNickName

(

const QString &

nickName

)

Set nick name.

Definition at line 690 of file addressee.cpp.

void Addressee::setNote

(

const QString &

note

)

Set note.

Definition at line 1008 of file addressee.cpp.

void Addressee::setOrganization

(

const QString &

organization

)

Set organization.

Definition at line 968 of file addressee.cpp.

void Addressee::setPhoto

(

const Picture &

photo

)

Set photo.

Definition at line 1148 of file addressee.cpp.

void Addressee::setPrefix

(

const QString &

prefix

)

Set honorific prefixes.

Definition at line 650 of file addressee.cpp.

void Addressee::setProductId

(

const QString &

productId

)

Set product identifier.

Definition at line 1028 of file addressee.cpp.

void Addressee::setResource

(

Resource *

resource

)

Set resource where the addressee is from.

Parameters

resource

The Resource the addressee is from

Definition at line 2147 of file addressee.cpp.

void Addressee::setRevision

(

const QDateTime &

revision

)

Set revision date.

Definition at line 1048 of file addressee.cpp.

void Addressee::setRole

(

const QString &

role

)

Set role.

Definition at line 948 of file addressee.cpp.

void Addressee::setSecrecy

(

const Secrecy &

secrecy

)

Set security class.

Definition at line 1108 of file addressee.cpp.

void Addressee::setSortMode ( KABC::SortMode *  mode )

static

Sets the sort mode implementation.

Comparing to addressee objects is delegated to an instance of a subclass of KABC::SortMode.

Parameters

mode	The sort mode implementator to use

Definition at line 2168 of file addressee.cpp.

void Addressee::setSortString

(

const QString &

sortString

)

Set sort string.

Definition at line 1068 of file addressee.cpp.

void Addressee::setSound

(

const Sound &

sound

)

Set sound.

Definition at line 1168 of file addressee.cpp.

void Addressee::setSuffix

(

const QString &

suffix

)

Set honorific suffixes.

Definition at line 670 of file addressee.cpp.

void Addressee::setTimeZone

(

const TimeZone &

timeZone

)

Set time zone.

Definition at line 888 of file addressee.cpp.

void Addressee::setTitle

(

const QString &

title

)

Set title.

Definition at line 928 of file addressee.cpp.

void Addressee::setUid

(

const QString &

uid

)

Set unique identifier.

Parameters

uid	the KABC unique identifier

Definition at line 433 of file addressee.cpp.

void Addressee::setUrl

(

const KUrl &

url

)

Set homepage.

Definition at line 1088 of file addressee.cpp.

QString Addressee::sortString

(

)

const

Return sort string.

Definition at line 1077 of file addressee.cpp.

QString Addressee::sortStringLabel ( )

static

Return translated label for sortString field.

Definition at line 1082 of file addressee.cpp.

Sound Addressee::sound

(

)

const

Return sound.

Definition at line 1177 of file addressee.cpp.

QString Addressee::soundLabel ( )

static

Return translated label for sound field.

Definition at line 1182 of file addressee.cpp.

QString Addressee::suffix

(

)

const

Return honorific suffixes.

Definition at line 679 of file addressee.cpp.

QString Addressee::suffixLabel ( )

static

Return translated label for suffix field.

Definition at line 684 of file addressee.cpp.

TimeZone Addressee::timeZone

(

)

const

Return time zone.

Definition at line 897 of file addressee.cpp.

QString Addressee::timeZoneLabel ( )

static

Return translated label for timeZone field.

Definition at line 902 of file addressee.cpp.

QString Addressee::title

(

)

const

Return title.

Definition at line 937 of file addressee.cpp.

QString Addressee::titleLabel ( )

static

Return translated label for title field.

Definition at line 942 of file addressee.cpp.

QString Addressee::toString

(

)

const

Returns string representation of the addressee.

Definition at line 1691 of file addressee.cpp.

QString Addressee::uid

(

)

const

Return unique identifier.

Definition at line 442 of file addressee.cpp.

QString Addressee::uidLabel ( )

static

Return translated label for uid field.

Definition at line 447 of file addressee.cpp.

KUrl Addressee::url

(

)

const

Return homepage.

Definition at line 1097 of file addressee.cpp.

QString Addressee::urlLabel ( )

static

Return translated label for url field.

Definition at line 1102 of file addressee.cpp.

---

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

• addressee.h
• addressee.cpp