class Addressee

address book entry. More...

Full nameKABC::Addressee
Definition#include <addressee.h>
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Types

Public Methods


Detailed Description

This class represents an entry in the address book.

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

typedef QValueList List

List

 Addressee ()

Addressee

Construct an empty address book entry.

 ~Addressee ()

~Addressee

 Addressee ( const Addressee & )

Addressee

Addressee & operator= ( const Addressee & )

operator=

bool  isEmpty ()

isEmpty

[const]

Return, if the address book entry is empty.

void  setUid ( const QString &uid )

setUid

QString  uid ()

uid

[const]

void  setName ( const QString &name )

setName

QString  name ()

name

[const]

void  setFormattedName ( const QString &formattedName )

setFormattedName

QString  formattedName ()

formattedName

[const]

void  setFamilyName ( const QString &familyName )

setFamilyName

QString  familyName ()

familyName

[const]

void  setGivenName ( const QString &givenName )

setGivenName

QString  givenName ()

givenName

[const]

void  setAdditionalName ( const QString &additionalName )

setAdditionalName

QString  additionalName ()

additionalName

[const]

void  setPrefix ( const QString &prefix )

setPrefix

QString  prefix ()

prefix

[const]

void  setSuffix ( const QString &suffix )

setSuffix

QString  suffix ()

suffix

[const]

void  setNickName ( const QString &nickName )

setNickName

QString  nickName ()

nickName

[const]

void  setBirthday ( const QDateTime &birthday )

setBirthday

QDateTime  birthday ()

birthday

[const]

void  setMailer ( const QString &mailer )

setMailer

QString  mailer ()

mailer

[const]

void  setTimeZone ( const TimeZone &timeZone )

setTimeZone

TimeZone  timeZone ()

timeZone

[const]

void  setGeo ( const Geo &geo )

setGeo

Geo  geo ()

geo

[const]

void  setTitle ( const QString &title )

setTitle

QString  title ()

title

[const]

void  setRole ( const QString &role )

setRole

QString  role ()

role

[const]

void  setOrganization ( const QString &organization )

setOrganization

QString  organization ()

organization

[const]

void  setNote ( const QString ¬e )

setNote

QString  note ()

note

[const]

void  setProductId ( const QString &productId )

setProductId

QString  productId ()

productId

[const]

void  setRevision ( const QDateTime &revision )

setRevision

QDateTime  revision ()

revision

[const]

void  setSortString ( const QString &sortString )

setSortString

QString  sortString ()

sortString

[const]

void  setUrl ( const KURL &url )

setUrl

KURL  url ()

url

[const]

void  setNameFromString ( const QString & )

setNameFromString

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.

QString  realName ()

realName

[const]

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

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

fullEmail

[const]

Return email address including real name.

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

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

insertEmail

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.

void  removeEmail ( const QString &email )

removeEmail

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

QString  preferredEmail ()

preferredEmail

[const]

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

QStringList  emails ()

emails

[const]

Return list of all email addresses.

void  insertPhoneNumber ( const PhoneNumber &phoneNumber )

insertPhoneNumber

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

void  removePhoneNumber ( const PhoneNumber &phoneNumber )

removePhoneNumber

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

PhoneNumber  phoneNumber ( int type )

phoneNumber

[const]

Return phone number, which matches the given type.

PhoneNumber::List  phoneNumbers ()

phoneNumbers

[const]

Return list of all phone numbers.

PhoneNumber  findPhoneNumber ( const QString &id )

findPhoneNumber

[const]

Return phone number with the given id.

void  insertAddress ( const Address &address )

insertAddress

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

void  removeAddress ( const Address &address )

removeAddress

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

Address  address ( int type )

address

[const]

Return address, which matches the given type.

Address::List  addresses ()

addresses

[const]

Return list of all addresses.

Address  findAddress ( const QString &id )

findAddress

[const]

Return address with the given id.

void  insertCategory ( const QString & )

insertCategory

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

void  removeCategory ( const QString & )

removeCategory

Remove category.

bool  hasCategory ( const QString & )

hasCategory

[const]

Return, if addressee has the given category.

void  setCategories ( const QStringList & )

setCategories

Set categories to given value.

QStringList  categories ()

categories

[const]

Return list of all set categories.

void  insertCustom ( const QString &app, const QString &name, const QString &value )

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 ne given value.

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

removeCustom

Remove custom entry.

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

custom

[const]

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

void  setCustoms ( const QStringList & )

setCustoms

Set all custom entries.

QStringList  customs ()

customs

[const]

Return list of all custom entries.

void  dump ()

dump

[const]

Debug output.


Generated by: hany on w1.md.megaloman.sk on Tue Aug 12 15:46:45 2003, using kdoc 2.0a54.