|
Home · All Namespaces · All Classes · Grouped Classes · Modules · Functions | |
The QContact class holds the data of an address book entry. More...
#include <QContact>
Inherits QPimRecord.
The QContact class holds the data of an address book entry.
This data includes information the name of the contact, phone numbers and email addresses, postal address information, and business information such as department and job title.
It also allows a portrait picture (and corresponding thumbnail) to be specified, provides functions for matching a contact against a regular expression, and converting to and from vCard format.
See also QContactAddress and Pim Library.
This enum describes the three possible choices for gender.
| Constant | Value |
|---|---|
| QContact::UnspecifiedGender | 0 |
| QContact::Male | 1 |
| QContact::Female | 2 |
Enumerates the types of addresses a contact can have.
| Constant | Value | Description |
|---|---|---|
| QContact::Home | 0x01 | Residential contact address |
| QContact::Business | 0x02 | Business contact address |
| QContact::Other | 0x00 | Contact address that does not fit into other Location types |
Enumerates the types of phone numbers that can be assigned to a contact.
| Constant | Value | Description |
|---|---|---|
| QContact::HomePhone | 0x01 | A non-business land line. |
| QContact::HomeMobile | 0x0101 | A non-business mobile phone number. |
| QContact::HomeFax | 0x0201 | A non-business fax number. |
| QContact::HomePager | 0x0401 | A non-business pager number. |
| QContact::HomeVOIP | 0x0301 | A non-business VOIP URL |
| QContact::BusinessPhone | 0x02 | A business land line. |
| QContact::BusinessMobile | 0x0102 | A business mobile phone number. |
| QContact::BusinessFax | 0x0202 | A business fax number. |
| QContact::BusinessPager | 0x0402 | A business pager number. |
| QContact::BusinessVOIP | 0x0302 | A business VOIP URL |
| QContact::OtherPhone | 0x00 | A land line. Whether the phone number is for Home or Business use is unspecified. |
| QContact::Mobile | 0x0100 | A mobile phone number. Whether the phone is for Home or Business use is unspecified. |
| QContact::Fax | 0x0200 | A fax number. Whether the phone is for Home or Business use is unspecified. |
| QContact::Pager | 0x0400 | A pager number. Whether the phone is for Home or Business use is unspecified. |
| QContact::VOIP | 0x0300 | A VOIP URL. Whether the URL is for Home or Business use is unspecified. |
Constructs a new QContact.
Constructs a new QContact that is a copy of contact.
Destroys the contact.
Returns the contact's address for the specified location.
See also setAddress().
Returns the contact's list of addresses with their types.
See also setAddresses().
Return the contact's anniversary date. If this has not been set, the returned date will be null.
See also setAnniversary().
Returns the assistant of the contact.
See also setAssistant().
Return the contact's birthday. If this has not been set, the returned date will be null.
See also setBirthday().
Returns the business city of the contact.
See also setBusinessCity().
Returns the business country of the contact.
See also setBusinessCountry().
Returns the business fax number of the contact.
See also setBusinessFax().
Returns the business mobile number of the contact.
See also setBusinessMobile().
Returns the business pager number of the contact.
See also setBusinessPager().
Returns the business phone number of the contact.
See also setBusinessPhone().
Returns the business state of the contact.
See also setBusinessState().
Returns the business street address of the contact.
See also setBusinessStreet().
Returns the business VOIP URL of the contact.
See also setBusinessVOIP().
Returns the business webpage of the contact.
See also setBusinessWebpage().
Returns the business zip of the contact.
See also setBusinessZip().
Changes the contacts portrait to the given pixmap p. The pixmap is saved to the contactimages directory in the Qtopia "addressbook" application storage directory, and removes the file previously used as the contact's portrait. The corresponding filename will be set as the Portrait field of this contact.
Note: the previous image is removed immediately if it is in the "addressbook" application data storage area, but the database will not be updated until QContactModel::updateContact is called.
This is an overloaded member function, provided for convenience.
Changes the contacts portrait to the given image. The image is saved to the contactimages directory in the Qtopia "addressbook" application storage directory, and removes the file previously used as the contact's portrait. The corresponding filename will be set as the Portrait field of this contact.
Note: the previous image is removed immediately if it is in the "addressbook" application data storage area, but the database will not be updated until QContactModel::updateContact is called.
This is an overloaded member function, provided for convenience.
Changes the contacts portrait to the image at the given imageLocation. The image is loaded, scaled and then saved to the contactimages directory in the Qtopia "addressbook" application storage directory. If the specified clip rectangle rect is not null, only the clip area of the image specified is used. The file previously used as the contact's portrait is removed. The corresponding filename will be set as the Portrait field of this contact.
Note: the previous image is removed immediately if it is in the "addressbook" application data storage area, but the database will not be updated until QContactModel::updateContact is called.
Returns the children of the contact.
See also setChildren().
Clears the addresses of the contact.
Clear the email list for the contact, including the default email.
Clears the phone number list of the contact, including the default phone number.
Returns the company for the contact.
See also setCompany().
Returns the pronunciation of the contact's company name.
See also setCompanyPronunciation().
Returns the default email address of the contact.
See also setDefaultEmail().
Return the default phone number of the contact. If no default phone number is set, this returns the null string.
See also setDefaultPhoneNumber().
Returns the department for the contact.
See also setDepartment().
Returns a formatted string with the contact's address of type location.
Returns a formatted string with the contact's business address.
Returns a formatted string with the contact's home address.
Returns a list of email addresses belonging to the contact, including the default email address.
See also setEmailList() and defaultEmail().
Returns the first name of the contact.
See also setFirstName().
Returns the pronunciation of the contact's first name.
See also setFirstNamePronunciation().
Returns the gender of the contact as type GenderType.
See also setGender().
Returns the home city of the contact.
See also setHomeCity().
Returns the home country of the contact.
See also setHomeCountry().
Returns the home fax number of the contact.
See also setHomeFax().
Returns the home mobile number of the contact.
See also setHomeMobile().
Returns the home phone number of the contact.
See also setHomePhone().
Returns the home state of the contact.
See also setHomeState().
Returns the home street address of the contact.
See also setHomeStreet().
Returns the home VOIP URL of the contact.
See also setHomeVOIP().
Returns the home webpage of the contact.
See also setHomeWebpage().
Returns the home zip of the contact.
See also setHomeZip().
Returns the portrait of the contact as an icon. If there is no portrait set for the contact will return a default icon.
See also portrait() and thumbnailSize().
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.
Returns the job title of the contact.
See also setJobTitle().
Returns a suitable display string for the contact. This is built up by using fields of the contact and the format set for generating the contact labels.
See also labelFormat() and labelFields().
Returns the string identifiers suitable for describing the format for the contact label.
See also labelFormat() and label().
Returns the format for contact labels.
The format is a set of pattern separated by '|'s. Each pattern is a set of space separated tokens. A token can either be _ for a space, an identifier as from identifierKey(), or any string. The format for label will the first pattern for which all fields specified are non null for the contact.
For example: lastname , _ firstname | lastname | firstname | company
See also setLabelFormat(), labelFields(), and label().
Returns the last name of the contact.
See also setLastName().
Returns the pronunciation of the contact's last name.
See also setLastNamePronunciation().
Returns the manager of the contact.
See also setManager().
Returns true if one of this contact's fields matches the given expression.
The function does not compare the gender, unique identifier, birthday or anniversary of the contact.
This is an overloaded member function, provided for convenience.
Returns true if one of this contact's fields matches the given expression.
The function does not compare the gender, unique identifier, birthday or anniversary of the contact.
Returns the middle name of the contact.
See also setMiddleName().
Returns the title of the contact (e.g. Dr., Prof.)
See also setNameTitle().
Returns the nickname of the contact.
See also setNickname().
Returns the notes relating to the the contact.
Reimplemented from QPimRecord.
See also setNotes().
Returns the office for the contact.
See also setOffice().
Parses the given text using contact name formatting rules and merges the information with contact. Returns the merged contact.
Formatting rules include using () for the nick name, "" for pronunciation, standard name titles and suffixes as well as detecting first, middle and last name ordering, similar to the default label formatting.
See also label().
Returns an icon representing the phone number type. Returns a null icon if no icon is available for the phone number type.
See also phoneIconResource().
Returns the resource location (e.g. ":icon/addressbook/homephone") for an icon representing the phone number type. Returns a null string if no icon is available for the phone number type.
See also phoneIcon().
Returns the phone number of type for the contact. If the contact does not have a corresponding phone number, this will return a null QString.
See also setPhoneNumber().
Returns the contact's list of phone numbers and their types.
See also setPhoneNumbers().
Returns a list of phone types that can be assigned as a contact phone number.
Returns the portrait of the contact as a pixmap. If there is no portrait set for the contact, this will return a default pixmap based on the contact's fields.
See also icon() and portraitSize().
Returns the path for the portrait file of the contact. This is either a resource file path (e.g. ":icon/happyface") or the name of a file that is stored in the "addressbook/contactimages" directory in the Qt Extended application data storage directory.
See also setPortraitFile().
Returns the size of the portrait pixmap of a contact.
See also portrait() and thumbnailSize().
Returns the profession of the contact.
See also setProfession().
Reads a list of vCards from the given device and returns the equivalent set of contacts.
See also writeVCard().
This function is deprecated.
This is an overloaded member function, provided for convenience.
Reads the file specified by filename as a list of vCard objects and returns the list of contacts that correspond to the vCard objects.
Note: the fields stored by QContact may not correspond exactly to the vCard data.
See also writeVCard().
This function is deprecated.
This is an overloaded member function, provided for convenience.
Reads the given vCard data in vcard, and returns the list of corresponding contacts.
Note: the fields stored by QContact may not correspond exactly to the vCard data.
See also writeVCard().
This is an overloaded member function, provided for convenience.
Reads the given vCard data in vobject, and returns the list of corresponding contacts.
Note: the fields stored by QContact may not correspond exactly to the vCard data.
See also writeVCard().
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.
Sets the contact's address for the given location to address. If the address is empty, this will effectively remove that Location type for this contact.
See also address().
Sets the contact addresses to the given addresses
See also addresses().
Sets the contact's anniversary to date.
See also anniversary().
Sets the assistant of the contact to str.
See also assistant().
Sets the contact's birthday to date.
See also birthday().
Sets the business city of the contact to str.
See also businessCity().
Sets the business country of the contact to str.
See also businessCountry().
Sets the business fax number of the contact to str.
See also businessFax().
Sets the business mobile phone number of the contact to str.
See also businessMobile().
Sets the business pager number of the contact to str.
See also businessPager().
Sets the business phone number of the contact to str.
See also businessPhone().
Sets the business state of the contact to str.
See also businessState().
Sets the business street address of the contact to str.
See also businessStreet().
Sets the business VOIP URL of the contact to str. This should be in the form of a URL (e.g. 'sip:user@sipserver').
See also businessVOIP().
Sets the business webpage of the contact to str.
See also businessWebpage().
Sets the business zip code of the contact to str.
See also businessZip().
Sets the children of the contact to str.
See also children().
Sets the company for contact to str.
See also company().
Sets the pronunciation of the contact's company name to str.
See also companyPronunciation().
Sets the default email to v. If the given email address v is not already in the contact's list of email addresses, this function adds it.
See also defaultEmail() and setEmailList().
If the contact has an existing phone number that matches str, it will be set as the default phone number.
See also defaultPhoneNumber().
This is an overloaded member function, provided for convenience.
If the contact has an existing phone number of a type that matches type, it will be set as the default phone number.
Sets the department for contact to str.
See also department().
Sets the email list to emails
See also emailList() and defaultEmail().
Sets the first name of the contact to str.
See also firstName().
Sets the pronunciation of the contact's first name to str.
See also firstNamePronunciation().
Sets the contact's gender to the enum value specified in g.
See also gender().
Sets the home city of the contact to str.
See also homeCity().
Sets the home country of the contact to str.
See also homeCountry().
Sets the home fax number of the contact to str.
See also homeFax().
Sets the home mobile phone number of the contact to str.
See also homeMobile().
Sets the home phone number of the contact to str.
See also homePhone().
Sets the home state of the contact to str.
See also homeState().
Sets the home street address of the contact to str.
See also homeStreet().
Sets the home VOIP URL of the contact to str. This should be in the form of a URL (e.g. 'sip:user@sipserver').
See also homeVOIP().
Sets the home webpage of the contact to str.
See also homeWebpage().
Sets the home zip code of the contact to str.
See also homeZip().
Sets the job title of the contact to str.
See also jobTitle().
Sets the format for contact labels to that described by f.
The format is a set of pattern separated by '|'s. Each pattern is a set of space separated tokens. A token can either be _ for a space, an identifier as from identifierKey(), or any string. The format used for label() will be the first pattern for which all fields specified are non null for the contact.
For example: lastname , _ firstname | lastname | firstname | company
See also labelFormat(), labelFields(), and label().
Sets the last name of the contact to str.
See also lastName().
Sets the pronunciation of the contact's last name to str.
See also lastNamePronunciation().
Sets the manager of the contact to str.
See also manager().
Sets the middle name of the contact to str.
See also middleName().
Sets the title of the contact to str.
See also nameTitle().
Sets the nickname of the contact to str.
See also nickname().
Sets the notes about the contact to str.
Reimplemented from QPimRecord.
See also notes().
Sets the office for contact to str.
See also office().
Sets the phone number of type type to str.
If there is no default phone number set, this will set the given number as the default phone number.
See also phoneNumber().
Sets the set of phone numbers of the contact to the given numbers
See also phoneNumbers().
Sets the path for the portrait file of the contact to str.
The string is interpreted as follows: - if the path starts with a ':' character, it is interpreted as a Qt Resource system path - otherwise, the string will be interpreted as a path relative to the "contactimages" subdirectory of the "addressbook" application storage directory (retrieved using Qtopia::applicationFileName).
See also portraitFile().
Sets the profession of the contact to str.
See also profession().
Sets the spouse of the contact to str.
See also spouse().
Sets the suffix of the contact to str.
See also suffix().
Returns the spouse of the contact.
See also setSpouse().
Returns the suffix of the contact.
See also setSuffix().
Returns the portrait of the contact, scaled down to the thumbnail size.
If there is no portrait set for the contact, this will return a default pixmap based on the contact's fields.
See also thumbnailSize().
Returns the size of the thumbnail of a contact's portrait.
See also thumbnail() and portraitSize().
Returns a rich text formatted QString of the QContact.
Writes the given list of contacts to the given device as vCards.
Returns true on success.
See also readVCard().
This is an overloaded member function, provided for convenience.
Writes the given contact to the given device as vCards.
Returns true on success.
See also readVCard().
This function is deprecated.
This is an overloaded member function, provided for convenience.
Write the list of contacts as vCard objects to the file specified by filename.
Returns true on success, false on failure.
See also readVCard().
This function is deprecated.
This is an overloaded member function, provided for convenience.
Writes the contact as a vCard object to the file specified by filename.
Returns true on success, false on failure.
See also readVCard().
This function is deprecated.
This is an overloaded member function, provided for convenience.
Writes the contact as a vCard object to the given file, which must be already open for writing.
See also readVCard().
This function is deprecated.
This is an overloaded member function, provided for convenience.
Writes the contact as a vCard object to the given stream, which must be writable.
See also readVCard().
Returns false if other is identical to this contact. Otherwise return true.
Makes a copy of contact and assigns it to this QContact.
Compares to other contact and returns true if it is equivalent. Otherwise returns false.
| Copyright © 2009 Nokia | Trademarks | Qt Extended 4.4.3 |