MeeGo 1.2 Harmattan Developer Documentation Develop for the Nokia N9

QLandmarkProximityFilter Class Reference

The QLandmarkProximityFilter class is used to search for landmarks based on the radius around a given coordinate and perform sorting by distance. More...

 #include <QLandmarkProximityFilter>

Inherits: QLandmarkFilter.

This class was introduced in Qt Mobility 1.1.

Public Functions

QLandmarkProximityFilter ( const QGeoCoordinate & center = QGeoCoordinate(), qreal radius = -1 )
QLandmarkProximityFilter ( const QGeoBoundingCircle & circle )
QLandmarkProximityFilter ( const QLandmarkFilter & other )
virtual ~QLandmarkProximityFilter ()
QGeoBoundingCircle boundingCircle ()
QGeoCoordinate center () const
qreal radius () const
void setBoundingCircle ( const QGeoBoundingCircle & circle )
void setCenter ( const QGeoCoordinate & center )
void setRadius ( qreal radius )

Detailed Description

The QLandmarkProximityFilter class is used to search for landmarks based on the radius around a given coordinate and perform sorting by distance.

In order to be a valid filter, the region covered by the proximity filter must not cover one of the poles. The landmarks are returned in ascending order of distance. A proximity filter may be used inside an intersection filter to sort landmarks by distance in combination with other criteria such as categories. (Note that a using sort order other than QLandmarkSortOrder (i.e. no sort) will override the sorting by distance).

Member Function Documentation

QLandmarkProximityFilter::QLandmarkProximityFilter ( const QGeoCoordinate & center = QGeoCoordinate(), qreal radius = -1 )

Creates a filter that will select landmarks within a given radius around a center coordinate.

This function was introduced in Qt Mobility 1.1.

QLandmarkProximityFilter::QLandmarkProximityFilter ( const QGeoBoundingCircle & circle )

Creates a filter that will select landmarks withiin a given bounding circle.

This function was introduced in Qt Mobility 1.1.

QLandmarkProximityFilter::QLandmarkProximityFilter ( const QLandmarkFilter & other )

Constructs a copy of other if possible, otherwise constructs a new proximity filter.

This function was introduced in Qt Mobility 1.1.

QLandmarkProximityFilter::~QLandmarkProximityFilter () [virtual]

Destroys the filter.

QGeoBoundingCircle QLandmarkProximityFilter::boundingCircle ()

Sets the bounding circle for the proximity filter.

This function was introduced in Qt Mobility 1.1.

See also setBoundingCircle().

QGeoCoordinate QLandmarkProximityFilter::center () const

Returns the center coordinate of the filter.

This function was introduced in Qt Mobility 1.1.

See also setCenter().

qreal QLandmarkProximityFilter::radius () const

Returns the radius of the filter. The unit of the radius is meters.

This function was introduced in Qt Mobility 1.1.

See also setRadius().

void QLandmarkProximityFilter::setBoundingCircle ( const QGeoBoundingCircle & circle )

Sets the bounding circle for the proximity filter

This function was introduced in Qt Mobility 1.1.

See also boundingCircle().

void QLandmarkProximityFilter::setCenter ( const QGeoCoordinate & center )

Sets the center coordinate of the filter.

This function was introduced in Qt Mobility 1.1.

See also center().

void QLandmarkProximityFilter::setRadius ( qreal radius )

Sets the radius of the filter. The unit of the radius is meters.

This function was introduced in Qt Mobility 1.1.

See also radius().