QLandmark Class Reference
The QLandmark class represents a location or point of interest of some significance. More...
#include <QLandmark>
Inherits QGeoPlace.
Public Functions
Detailed Description
The QLandmark class represents a location or point of interest of some significance.
Each landmark consists of a number of properties such as name, coordinates, description etc. Landmarks may also be assigned a set of generic attributes which may be accessed and modified by using the attribute() and setAttribute() functions.
Each QLandmark may be associated with zero or more categories. A category defines a type of landmark such as restaurant or cinema. To set the category that a landmark belongs to, use the setCategoryId() or addCategoryId() functions. A landmark may be removed from a category by using the removeCategoryId() function.
Some landmarks may be designated as read-only, e.g. a publically accessible landmark server may not want some of its content to be editable. Localization is only possible for landmarks that are read-only. If the landmark store supports localization, the locale may be set through a QLandmarkManager's parameters and whenever landmarks are retrieved, the translated names are used. The QLandmarkManager::isReadOnly(const QLandmarkyId &) function may be used to determine if a category is read-only.
Each QLandmark is an in memory representation of a landmark; it does not reflect the actual landmark state in persistent storage until the appropriate synchronization method is called on the QLandmarkManager(e.g. saveLandmark(), removeLandmark()).
Member Function Documentation
QLandmark::QLandmark ()
Constructs an new landmark.
A new landmark will be assigned with invalid QLandmarkId.
QLandmark::QLandmark ( const QGeoPlace & other )
Constructs a new landmark from other.
If other is a QLandmark instance this is equivalent to QLandmark(const QLandmark &other).
If other::type() is QGeoPlace instance this will initialize just the coordinate and address of this landmark.
Otherwise this is equivalent to QLandmark().
QLandmark::QLandmark ( const QLandmark & other )
Constructs a copy of other.
QLandmark::~QLandmark ()
Destroys the landmark.
void QLandmark::addCategoryId ( const QLandmarkCategoryId & categoryId )
Adds another category that this landmark will be associated with via its categoryId.
See also setCategoryIds() and removeCategoryId().
QVariant QLandmark::attribute ( const QString & key, const QVariant & defaultValue = QVariant() ) const
Returns the value of the attribute corresponding to key. If the attribute doest exist, returns defaultValue.
If no default value is specified, a default QVariant is returned.
See also setAttribute().
QStringList QLandmark::attributeKeys () const
Returns a list of attribute keys.
See also attribute() and setAttribute().
QList<QLandmarkCategoryId> QLandmark::categoryIds () const
Returns a of list identifiers of categories that this landmark belongs to.
See also setCategoryIds().
void QLandmark::clear ()
Clears all the data fields of the landmark.
QString QLandmark::description () const
Returns a description of the landmark.
See also setDescription().
QUrl QLandmark::iconUrl () const
Returns the url of the landmark's icon.
See also setIconUrl().
QLandmarkId QLandmark::landmarkId () const
Returns the identifier of the landmark.
See also setLandmarkId().
QString QLandmark::name () const
Returns the name of the landmark.
See also setName().
QString QLandmark::phone () const
Returns the phone number of the landmark.
See also setPhone().
double QLandmark::radius () const
Returns the coverage radius of the landmark.
The coverage radius is relevant for large landmarks such as cities. Note that landmark searches over a given area do not factor in the coverage radius.
See also setRadius().
void QLandmark::removeCategoryId ( const QLandmarkCategoryId & categoryId )
Removes a category from a landmark, by using its categoryId.
See also addCategoryId() and categoryIds().
void QLandmark::setAttribute ( const QString & key, const QVariant & value )
Sets the value of the attribute corresponding to key.
See also attribute().
void QLandmark::setCategoryIds ( const QList<QLandmarkCategoryId> & categoryIds )
Sets the categories that this landmark belongs to via a list of categoryIds.
See also categoryIds(), addCategoryId(), and removeCategoryId().
void QLandmark::setDescription ( const QString & description )
Sets the description of the landmark.
See also description().
void QLandmark::setIconUrl ( const QUrl & url )
Sets the url of the landmark's icon.
See also iconUrl().
void QLandmark::setLandmarkId ( const QLandmarkId & id )
Sets the id of the landmark.
Note that saving a new landmark using a QLandmarkManager will automatically assign the landmark a valid identifier.
See also landmarkId().
void QLandmark::setName ( const QString & name )
Sets the name of the landmark.
See also name().
void QLandmark::setPhone ( const QString & phone )
Sets the phone number of the landmark.
See also phone().
void QLandmark::setRadius ( double radius )
Sets the coverage radius of the landmark.
See also radius().
void QLandmark::setUrl ( const QUrl & url )
Sets the url of the landmark.
See also url().
QUrl QLandmark::url () const
Returns the url of the landmark.
See also setUrl().
bool QLandmark::operator!= ( const QLandmark & other ) const
Returns true if this landmark not is equal to other, otherwise returns false.
See also operator==().
QLandmark & QLandmark::operator= ( const QLandmark & other )
Assigns other to this landmark and returns a reference to this landmark.
bool QLandmark::operator== ( const QLandmark & other ) const
Returns true if this landmark is equal to other, otherwise returns false.
Two landmarks are considered equal if both the landmark details and identifiers are equal.
See also operator!=().