Home · All Classes · All Functions ·

QContactFetchRequest Class Reference

The QContactFetchRequest class allows a client to asynchronously request contacts from a contacts store manager. More...

    #include <QContactFetchRequest>

Inherits QContactAbstractRequest.


Public Functions

QContactFetchRequest ()
~QContactFetchRequest ()
QList<QContact> contacts () const
QStringList definitionRestrictions () const
QContactFilter filter () const
void setDefinitionRestrictions ( const QStringList & definitionNames )
void setFilter ( const QContactFilter & filter )
void setSorting ( const QList<QContactSortOrder> & sorting )
QList<QContactSortOrder> sorting () const

Signals

void progress ( QContactFetchRequest * self, bool appendOnly )

Additional Inherited Members


Detailed Description

The QContactFetchRequest class allows a client to asynchronously request contacts from a contacts store manager.


Member Function Documentation

QContactFetchRequest::QContactFetchRequest ()

Constructs a new contact fetch request

QContactFetchRequest::~QContactFetchRequest ()

Cleans up the memory in use by this contact fetch request

QList<QContact> QContactFetchRequest::contacts () const

Returns the list of contacts retrieved by this request

QStringList QContactFetchRequest::definitionRestrictions () const

Returns the list of definition names which define which details contacts in the result list will be limited to

See also setDefinitionRestrictions().

QContactFilter QContactFetchRequest::filter () const

Returns the filter that will be used to select contacts to be returned

See also setFilter().

void QContactFetchRequest::progress ( QContactFetchRequest * self, bool appendOnly )   [signal]

This signal is emitted when some progress has been made on the request, causing either a change of status or an update of results, or both. It identifies which request the signal originated from by including a pointer to self, and contains an appendOnly flag which signifies whether or not the total ordering of the results have been maintained since the last progress signal was emitted.

void QContactFetchRequest::setDefinitionRestrictions ( const QStringList & definitionNames )

Sets the list of allowable detail definition names to definitionNames. Any contacts retrieved by the request will have any details whose definition name is not on the restricted list removed prior to being returned.

See also definitionRestrictions().

void QContactFetchRequest::setFilter ( const QContactFilter & filter )

Sets the contact filter used to determine which contacts will be retrieved to filter

See also filter().

void QContactFetchRequest::setSorting ( const QList<QContactSortOrder> & sorting )

Sets the sort order of the result to sorting. Only has an effect if called prior to calling start()

See also sorting().

QList<QContactSortOrder> QContactFetchRequest::sorting () const

Returns the sort ordering that will be used sort the results of this request

See also setSorting().


Copyright © 2009 Nokia Corporation and/or its subsidiary(-ies) Trademarks
Qt Mobility Project 1.0.0 (Technical Preview)