Member Function Documentation

QGeoAreaMonitorInfo::QGeoAreaMonitorInfo(const QString &name = QString())

Constructs a QGeoAreaMonitorInfo object with the specified name.

See also name().

QGeoAreaMonitorInfo::QGeoAreaMonitorInfo(const QGeoAreaMonitorInfo &other)

Constructs a QGeoAreaMonitorInfo object as a copy of other.

QGeoAreaMonitorInfo::~QGeoAreaMonitorInfo()

Destructor

QGeoShape QGeoAreaMonitorInfo::area() const

Returns the boundaries of the to-be-monitored area. This area must not be empty.

See also setArea().

QDateTime QGeoAreaMonitorInfo::expiration() const

Returns the expiry date.

After an active QGeoAreaMonitorInfo has expired the region is no longer monitored and the QGeoAreaMonitorInfo object is removed from the list of active monitors.

If the expiry QDateTime is invalid the QGeoAreaMonitorInfo object is treated as not having an expiry date. This implies an indefinite monitoring period if the object is persistent or until the current application closes if the object is non-persistent.

See also setExpiration() and QGeoAreaMonitorSource::activeMonitors().

QString QGeoAreaMonitorInfo::identifier() const

Returns the identifier of the QGeoAreaMonitorInfo object. The identifier is automatically generated upon construction of a new QGeoAreaMonitorInfo object.

bool QGeoAreaMonitorInfo::isPersistent() const

Returns true if the QGeoAreaMonitorInfo is persistent. The default value for this property is false.

A non-persistent QGeoAreaMonitorInfo will be removed by the system once the application owning the monitor object stops. Persistent objects remain active and can be retrieved once the application restarts.

If the system triggers an event associated to a persistent QGeoAreaMonitorInfo the relevant application will be re-started and the appropriate signal emitted.

See also setPersistent().

bool QGeoAreaMonitorInfo::isValid() const

Returns true, if the monitor is valid. A valid QGeoAreaMonitorInfo has a non-empty name() and the monitored area is not empty(). Otherwise this function returns false.

QString QGeoAreaMonitorInfo::name() const

Returns the name of the QGeoAreaMonitorInfo object. The name should be used to for user-visibility purposes.

See also setName().

QVariantMap QGeoAreaMonitorInfo::notificationParameters() const

Returns the set of platform specific paraemters used by this QGeoAreaMonitorInfo.

See also setNotificationParameters().

void QGeoAreaMonitorInfo::setArea(const QGeoShape &newShape)

Sets the to-be-monitored area to newShape.

See also area().

void QGeoAreaMonitorInfo::setExpiration(const QDateTime &expiry)

Sets the expiry date and time to expiry.

See also expiration().

void QGeoAreaMonitorInfo::setName(const QString &name)

Sets the user visibile name.

See also name().

void QGeoAreaMonitorInfo::setNotificationParameters(const QVariantMap &parameters)

Sets the set of platform specific parameters used by QGeoAreaMonitorInfo.

See also notificationParameters().

void QGeoAreaMonitorInfo::setPersistent(bool isPersistent)

Sets the QGeoAreaMonitorInfo objects persistence to isPersistent.

Note that setting this flag does not imply that QGeoAreaMonitorInfoSource supports persistent monitoring. QGeoAreaMonitorSource::supportedAreaMonitorFeatures() can be used to check for this feature's availability.

See also isPersistent().

bool QGeoAreaMonitorInfo::operator!=(const QGeoAreaMonitorInfo &other) const

Returns true if any of this object's values are not the same as those of other.

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

Assigns other to this QGeoAreaMonitorInfo object and returns a reference to this QGeoAreaMonitorInfo object.

bool QGeoAreaMonitorInfo::operator==(const QGeoAreaMonitorInfo &other) const

Returns true if all of this object's values are the same as those of other.