QContactFavorite Class Reference

The QContactFavorite class indicates if a contact is a favorite contact as well as the position it should appear in an ordered list of favorites. More...

 #include <QContactFavorite>

Inherits: QContactDetail.

This class was introduced in Qt Mobility 1.1.

List of all members, including inherited members

Public Functions

int	index () const
bool	isFavorite () const
void	setFavorite ( bool isFavorite )
void	setIndex ( int index )

29 public functions inherited from QContactDetail

Static Public Members

const QLatin1Constant	DefinitionName
const QLatin1Constant	FieldFavorite
const QLatin1Constant	FieldIndex
QContactFilter	match ()

Detailed Description

The QContactFavorite class indicates if a contact is a favorite contact as well as the position it should appear in an ordered list of favorites.

This leaf-class has been part of the default schema since version 1.1 of the Qt Mobility project.

Member Function Documentation

int QContactFavorite::index () const

Returns the index of the favorite contact.

See also setIndex().

bool QContactFavorite::isFavorite () const

Returns true if the contact is a favorite, false otherwise.

QContactFilter QContactFavorite::match () `[static]`

Returns a filter suitable for finding contacts which are marked as favorite contacts.

void QContactFavorite::setFavorite ( bool isFavorite )

If isFavorite is true, marks the contact as a favorite. Otherwise, marks the contact as not a favorite.

See also isFavorite().

void QContactFavorite::setIndex ( int index )

Sets the index of the favorite contact to index.

See also index().

Member Variable Documentation

const QLatin1Constant QContactFavorite::DefinitionName

The string constant for the definition name of QContactFavorite details.

const QLatin1Constant QContactFavorite::FieldFavorite

The field key constant for the value that indicates whether a contact is a favorite.

See also index() and setIndex().

const QLatin1Constant QContactFavorite::FieldIndex

The field key constant for the value containing the index of the favorite contact (which determines the order they appear)