Qtopia Home - Classes - Hierachy - Annotated - Functions - Qt Embedded |

# PimContact Class Reference
[qpepim module]

The PimContact class holds the data of an address book entry. More...

`#include <qtopia/pim/contact.h>`

Inherits PimRecord.

List of all member functions.

## Public Members

- PimContact ()
- virtual ~PimContact ()
- void setNameTitle ( const QString & str )
- void setFirstName ( const QString & str )
- void setMiddleName ( const QString & str )
- void setLastName ( const QString & str )
- void setSuffix ( const QString & str )
- void setFileAs ( const QString & str )
- void setFileAs ()
- void setFirstNamePronunciation ( const QString & str )
- void setLastNamePronunciation ( const QString & str )
- void setCompanyPronunciation ( const QString & str )
- void setDefaultEmail ( const QString & v )
- void insertEmail ( const QString & email )
- void removeEmail ( const QString & email )
- void clearEmailList ()
- void setEmailList ( const QStringList & emails )
- void setHomeStreet ( const QString & str )
- void setHomeCity ( const QString & str )
- void setHomeState ( const QString & str )
- void setHomeZip ( const QString & str )
- void setHomeCountry ( const QString & str )
- void setHomePhone ( const QString & str )
- void setHomeFax ( const QString & str )
- void setHomeMobile ( const QString & str )
- void setHomeWebpage ( const QString & str )
- void setCompany ( const QString & str )
- void setBusinessStreet ( const QString & str )
- void setBusinessCity ( const QString & str )
- void setBusinessState ( const QString & str )
- void setBusinessZip ( const QString & str )
- void setBusinessCountry ( const QString & str )
- void setBusinessWebpage ( const QString & str )
- void setJobTitle ( const QString & str )
- void setDepartment ( const QString & str )
- void setOffice ( const QString & str )
- void setBusinessPhone ( const QString & str )
- void setBusinessFax ( const QString & str )
- void setBusinessMobile ( const QString & str )
- void setBusinessPager ( const QString & str )
- void setProfession ( const QString & str )
- void setAssistant ( const QString & str )
- void setManager ( const QString & str )
- void setSpouse ( const QString & str )
- enum GenderType { UnspecifiedGender = 0, Male, Female }
- void setGender ( GenderType g )
- void setBirthday ( const QDate & d )
- void setAnniversary ( const QDate & d )
- void setNickname ( const QString & str )
- void setChildren ( const QString & children )
- void setNotes ( const QString & str )
- bool match ( const QString & regexp ) const
- QString fullName () const
- QString nameTitle () const
- QString firstName () const
- QString middleName () const
- QString lastName () const
- QString suffix () const
- QString fileAs () const
- QString lastNamePronunciation () const
- QString firstNamePronunciation () const
- QString companyPronunciation () const
- QString bestLabel () const
- QString defaultEmail () const
- QStringList emailList () const
- QString homeStreet () const
- QString homeCity () const
- QString homeState () const
- QString homeZip () const
- QString homeCountry () const
- QString homePhone () const
- QString homeFax () const
- QString homeMobile () const
- QString homeWebpage () const
- QString displayHomeAddress () const
- QString company () const
- QString businessStreet () const
- QString businessCity () const
- QString businessState () const
- QString businessZip () const
- QString businessCountry () const
- QString businessWebpage () const
- QString jobTitle () const
- QString department () const
- QString office () const
- QString businessPhone () const
- QString businessFax () const
- QString businessMobile () const
- QString businessPager () const
- QString profession () const
- QString assistant () const
- QString manager () const
- QString displayBusinessAddress () const
- QString spouse () const
- GenderType gender () const
- QDate birthday () const
- QDate anniversary () const
- QString nickname () const
- QString children () const
- QString notes () const
- QString toRichText () const

## Static Public Members

- void writeVCard ( const QString & filename, const QValueList<PimContact> & contacts )
- void writeVCard ( const QString & filename, const PimContact & contact )
- QValueList<PimContact> readVCard ( const QString & filename )

## Detailed Description

The PimContact class holds the data of an address book entry.

This data includes information the name of the person, contact information, and business information such as deparment and job title.

See also Qtopia PIM Library.

## Member Type Documentation

### PimContact::GenderType

This enum describes the three possible choices for gender.

- `PimContact::UnspecifiedGender`
- `PimContact::Male`
- `PimContact::Female`

## Member Function Documentation

### PimContact::PimContact ()

Constructs a new PimContact.

### PimContact::~PimContact ()`[virtual]`

Destroys the contact.

### QDate PimContact::anniversary () const

Return the person's anniversary date. QDate will be null if there is anniversary has not been set.

### QString PimContact::assistant () const

Returns the assistant of the contact.

### QString PimContact::bestLabel () const

Returns a suitable display string for the contact.

See also fileAs() and fullName().

### QDate PimContact::birthday () const

Return the person's birthday. QDate will be null if there is birthday has not been set.

### QString PimContact::businessCity () const

Returns the business city of the contact.

### QString PimContact::businessCountry () const

Returns the business country of the contact.

### QString PimContact::businessFax () const

Returns the business fax number of the contact.

### QString PimContact::businessMobile () const

Returns the business mobile number of the contact.

### QString PimContact::businessPager () const

Returns the business pager number of the contact.

### QString PimContact::businessPhone () const

Returns the business phone number of the contact.

### QString PimContact::businessState () const

Returns the business state of the contact.

### QString PimContact::businessStreet () const

Returns the business street address of the contact.

### QString PimContact::businessWebpage () const

Returns the business webpage of the contact.

### QString PimContact::businessZip () const

Returns the business zip of the contact.

### QString PimContact::children () const

Returns the children of the contact.

### void PimContact::clearEmailList ()

Clear the email list for the contact, including the default email.

### QString PimContact::company () const

Returns the company for the contact.

### QString PimContact::companyPronunciation () const

Returns the pronunciation of the contacts company name.

### QString PimContact::defaultEmail () const

Returns the default email address of the contact.

### QString PimContact::department () const

Returns the department for the contact.

### QString PimContact::displayBusinessAddress () const

Returns the formated business address of the contact.

### QString PimContact::displayHomeAddress () const

Returns the formated home address of the contact.

### QStringList PimContact::emailList () const

Returns a list of email addresses belonging to the contact, including the default email address.

### QString PimContact::fileAs () const

Returns the string the contact is filed as.

### QString PimContact::firstName () const

Returns the first name of the contact.

### QString PimContact::firstNamePronunciation () const

Returns the pronunciation of the contacts first name.

### QString PimContact::fullName () const

Returns the full name of the contact, generated from the current user preferences. fileAs() in general will be a cached vopy of this.

See also setFileAs().

### GenderType PimContact::gender () const

Returns the gender of the contact as type GenderType.

### QString PimContact::homeCity () const

Returns the home city of the contact.

### QString PimContact::homeCountry () const

Returns the home country of the contact.

### QString PimContact::homeFax () const

Returns the home fax number of the contact.

### QString PimContact::homeMobile () const

Returns the home mobile number of the contact.

### QString PimContact::homePhone () const

Returns the home phone number of the contact.

### QString PimContact::homeState () const

Returns the home state of the contact.

### QString PimContact::homeStreet () const

Returns the home street address of the contact.

### QString PimContact::homeWebpage () const

Returns the home webpage of the contact.

### QString PimContact::homeZip () const

Returns the home zip of the contact.

### void PimContact::insertEmail ( const QString & email )

Adds email to the list of email address for the contact. If no default email is set, the default email will be set to email.

### QString PimContact::jobTitle () const

Returns the job title of the contact.

### QString PimContact::lastName () const

Returns the last name of the contact.

### QString PimContact::lastNamePronunciation () const

Returns the pronunciation of the contacts last name.

### QString PimContact::manager () const

Returns the manager of the contact.

### bool PimContact::match ( const QString & regexp ) const

Returns TRUE if the part of contact matches regexp. Otherwise returns FALSE.

### QString PimContact::middleName () const

Returns the middle name of the contact.

### QString PimContact::nameTitle () const

Returns the title of the contact.

### QString PimContact::nickname () const

Returns the nickname of the contact.

### QString PimContact::notes () const

Returns the notes relating to the the contact.

### QString PimContact::office () const

Returns the office for the contact.

### QString PimContact::profession () const

Returns the profession of the contact.

### QValueList<PimContact> PimContact::readVCard ( const QString & filename )`[static]`

Reads the file specified by filename as a list of vCards objects and returns the list of near equivalent contacts.

See also writeVCard().

### void PimContact::removeEmail ( const QString & email )

Removes email from the list of email address for the contact. If the email is the default email, the default email will be set to the first one in the list.

### void PimContact::setAnniversary ( const QDate & d )

Sets the person's anniversary to d.

### void PimContact::setAssistant ( const QString & str )

Sets the assistant of the contact to str.

### void PimContact::setBirthday ( const QDate & d )

Sets the person's birthday to d.

### void PimContact::setBusinessCity ( const QString & str )

Sets the business city of the contact to str.

### void PimContact::setBusinessCountry ( const QString & str )

Sets the business country of the contact to str.

### void PimContact::setBusinessFax ( const QString & str )

Sets the business fax number of the contact to str.

### void PimContact::setBusinessMobile ( const QString & str )

Sets the business mobile phone number of the contact to str.

### void PimContact::setBusinessPager ( const QString & str )

Sets the business pager number of the contact to str.

### void PimContact::setBusinessPhone ( const QString & str )

Sets the business phone number of the contact to str.

### void PimContact::setBusinessState ( const QString & str )

Sets the business state of the contact to str.

### void PimContact::setBusinessStreet ( const QString & str )

Sets the business street address of the contact to str.

### void PimContact::setBusinessWebpage ( const QString & str )

Sets the business webpage of the contact to str.

### void PimContact::setBusinessZip ( const QString & str )

Sets the business zip code of the contact to str.

### void PimContact::setChildren ( const QString & children )

Sets the children of the contact to children.

### void PimContact::setCompany ( const QString & str )

Sets the company for contact to str.

### void PimContact::setCompanyPronunciation ( const QString & str )

Sets the pronunciation of the contacts company name to str.

### void PimContact::setDefaultEmail ( const QString & v )

Sets the default email to v and adds it to the list.

### void PimContact::setDepartment ( const QString & str )

Sets the department for contact to str.

### void PimContact::setEmailList ( const QStringList & emails )

Sets the email list to emails

### void PimContact::setFileAs ( const QString & str )

Sets the contact to filed as str.

### void PimContact::setFileAs ()

Set the contact to be filed by the fullName().

### void PimContact::setFirstName ( const QString & str )

Sets the first name of the contact to str.

### void PimContact::setFirstNamePronunciation ( const QString & str )

Sets the pronunciation of the contacts first name to str.

### void PimContact::setGender ( GenderType g )

Sets the persons gender to the enum value specified in g.

### void PimContact::setHomeCity ( const QString & str )

Sets the home city of the contact to str.

### void PimContact::setHomeCountry ( const QString & str )

Sets the home country of the contact to str.

### void PimContact::setHomeFax ( const QString & str )

Sets the home fax number of the contact to str.

### void PimContact::setHomeMobile ( const QString & str )

Sets the home mobile phone number of the contact to str.

### void PimContact::setHomePhone ( const QString & str )

Sets the home phone number of the contact to str.

### void PimContact::setHomeState ( const QString & str )

Sets the home state of the contact to str.

### void PimContact::setHomeStreet ( const QString & str )

Sets the home street address of the contact to str.

### void PimContact::setHomeWebpage ( const QString & str )

Sets the home webpage of the contact to str.

### void PimContact::setHomeZip ( const QString & str )

Sets the home zip code of the contact to str.

### void PimContact::setJobTitle ( const QString & str )

Sets the job title of the contact to str.

### void PimContact::setLastName ( const QString & str )

Sets the last name of the contact to str.

### void PimContact::setLastNamePronunciation ( const QString & str )

Sets the pronunciation of the contacts last name to str.

### void PimContact::setManager ( const QString & str )

Sets the manager of the contact to str.

### void PimContact::setMiddleName ( const QString & str )

Sets the middle name of the contact to str.

### void PimContact::setNameTitle ( const QString & str )

Sets the title of the contact to str.

### void PimContact::setNickname ( const QString & str )

Sets the nickname of the contact to str.

### void PimContact::setNotes ( const QString & str )

Sets the notes about the contact to str.

### void PimContact::setOffice ( const QString & str )

Sets the office for contact to str.

### void PimContact::setProfession ( const QString & str )

Sets the profession of the contact to str.

### void PimContact::setSpouse ( const QString & str )

Sets the spouse of the contact to str.

### void PimContact::setSuffix ( const QString & str )

Sets the suffix of the contact to str.

### QString PimContact::spouse () const

Returns the spouse of the contact.

### QString PimContact::suffix () const

Returns the suffix of the contact.

### QString PimContact::toRichText () const

Returns a rich text formatted QString of the PimContact.

### void PimContact::writeVCard ( const QString & filename, const QValueList<PimContact> & contacts )`[static]`

Write the list of contacts as vCard objects to the file specified by filename.

See also readVCard().

### void PimContact::writeVCard ( const QString & filename, const PimContact & contact )`[static]`

Write the contact as a vCard object to the file specified by filename.

See also readVCard().

This file is part of the Qtopia platform, copyright © 1995-2004 Trolltech, all rights reserved.