QContactFetchHint Class Reference

Member Function Documentation

QContactFetchHint::QContactFetchHint ()

Constructs a new contact fetch hint which requests that the backend fetch all information

QContactFetchHint::QContactFetchHint ( const QContactFetchHint & other )

Constructs a new contact fetch hint as a copy of other

QContactFetchHint::~QContactFetchHint ()

Frees any memory in use by the fetch hint

QStringList QContactFetchHint::detailDefinitionsHint () const

Returns the list of definition names that identify detail definitions of which details the manager should (at a minimum) retrieve when fetching contacts. This hint may be ignored by the backend, in which case it will return the full set of details for each contact retrieved.

This function was introduced in Qt Mobility 1.0.

See also setDetailDefinitionsHint().

int QContactFetchHint::maxCountHint () const

Returns the number of results which the client considers to be the maximum number of useful results. The client is only interested in this number of results, so returning any more results would be superfluous to the client's requirements. Note that this fetch hint only affects operations where the backend would return a list of contacts; this hint specifies the maximum number of contacts in the list which would be useful to the client. The backend may ignore this hint, in which case it must return all contacts which would otherwise have been returned as a result of the operation.

A negative value for count denotes that the client wishes to retrieve all results. The default value is -1.

See also setMaxCountHint().

OptimizationHints QContactFetchHint::optimizationHints () const

Returns the optimization hint flags specified by the client. These hints may be ignored by the backend, in which case it will return the full set of information accessible in a contact, including relationships, action preferences, and binary blobs.

This function was introduced in Qt Mobility 1.0.

See also setOptimizationHints().

QSize QContactFetchHint::preferredImageSize () const

Returns the preferred pixel dimensions for any images returned by the manager for a given request. This hint may be ignored by the manager.

This is useful when the backend supports multiple sizes of an image (or the image is natively scaleable) in order to get an image that will look good at the indicated dimensions.

The caller should be prepared for images of any dimensions, in any case.

See also setPreferredImageSize().

QStringList QContactFetchHint::relationshipTypesHint () const

Returns the list of relationship types that the manager should (at a minimum) retrieve when fetching contacts. This hint may be ignored by the backend, in which case it will return the full set of relationships for each contact retrieved.

This function was introduced in Qt Mobility 1.0.

See also setRelationshipTypesHint() and QContact::relationships().

void QContactFetchHint::setDetailDefinitionsHint ( const QStringList & definitionNames )

Sets the list of definition names that identify detail definitions of which details the manager should (at a minimum) retrieve when fetching contacts to definitionNames. This hint may be ignored by the backend, in which case it will return the full set of details for each contact retrieved.

This function was introduced in Qt Mobility 1.0.

See also detailDefinitionsHint().

void QContactFetchHint::setMaxCountHint ( int count )

Sets the maximum number of results which the client is interested in to count. The client is only interested in this number of results, so returning any more results would be superfluous to the client's requirements. Note that this fetch hint only affects operations where the backend would return a list of contacts; this hint specifies the maximum number of contacts in the list which would be useful to the client. The backend may ignore this hint, in which case it must return all contacts which would otherwise have been returned as a result of the operation.

A negative value for count denotes that the client wishes to retrieve all results. The default value is -1.

See also maxCountHint().

void QContactFetchHint::setOptimizationHints ( OptimizationHints hints )

Sets the optimization hint flags specified by the client to hints. These hints may be ignored by the backend, in which case it will return the full set of information accessible in a contact, including relationships, action preferences, and binary blobs.

This function was introduced in Qt Mobility 1.0.

See also optimizationHints().

void QContactFetchHint::setPreferredImageSize ( const QSize & size )

Sets the preferred pixel dimensions for any images returned by the manager for the given request to size. This hint may be ignored by the manager.

This is useful when the backend supports multiple sizes of an image (or the image is natively scaleable) in order to get an image that will look good at the indicated dimensions.

The caller should be prepared for images of any dimensions, in any case.

See also preferredImageSize().

void QContactFetchHint::setRelationshipTypesHint ( const QStringList & relationshipTypes )

Sets the list of relationship types that the manager should (at a minimum) retrieve when fetching contacts to relationshipTypes. This hint may be ignored by the backend, in which case it will return the full set of relationships for each contact retrieved.

This function was introduced in Qt Mobility 1.0.

See also relationshipTypesHint() and QContact::relationships().

QContactFetchHint & QContactFetchHint::operator= ( const QContactFetchHint & other )

Assigns this fetch hint to be equal to the other fetch hint

This function was introduced in Qt Mobility 1.0.