Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
QDeclarativeGeoRouteQuery Class Reference

#include <qdeclarativegeoroutemodel_p.h>

+ Inheritance diagram for QDeclarativeGeoRouteQuery:
+ Collaboration diagram for QDeclarativeGeoRouteQuery:

Public Types

enum  TravelMode {
  CarTravel = QGeoRouteRequest::CarTravel , PedestrianTravel = QGeoRouteRequest::PedestrianTravel , BicycleTravel = QGeoRouteRequest::BicycleTravel , PublicTransitTravel = QGeoRouteRequest::PublicTransitTravel ,
  TruckTravel = QGeoRouteRequest::TruckTravel
}
 
enum  FeatureType {
  NoFeature = QGeoRouteRequest::NoFeature , TollFeature = QGeoRouteRequest::TollFeature , HighwayFeature = QGeoRouteRequest::HighwayFeature , PublicTransitFeature = QGeoRouteRequest::PublicTransitFeature ,
  FerryFeature = QGeoRouteRequest::FerryFeature , TunnelFeature = QGeoRouteRequest::TunnelFeature , DirtRoadFeature = QGeoRouteRequest::DirtRoadFeature , ParksFeature = QGeoRouteRequest::ParksFeature ,
  MotorPoolLaneFeature = QGeoRouteRequest::MotorPoolLaneFeature , TrafficFeature = QGeoRouteRequest::TrafficFeature
}
 
enum  FeatureWeight {
  NeutralFeatureWeight = QGeoRouteRequest::NeutralFeatureWeight , PreferFeatureWeight = QGeoRouteRequest::PreferFeatureWeight , RequireFeatureWeight = QGeoRouteRequest::RequireFeatureWeight , AvoidFeatureWeight = QGeoRouteRequest::AvoidFeatureWeight ,
  DisallowFeatureWeight = QGeoRouteRequest::DisallowFeatureWeight
}
 
enum  RouteOptimization { ShortestRoute = QGeoRouteRequest::ShortestRoute , FastestRoute = QGeoRouteRequest::FastestRoute , MostEconomicRoute = QGeoRouteRequest::MostEconomicRoute , MostScenicRoute = QGeoRouteRequest::MostScenicRoute }
 
enum  SegmentDetail { NoSegmentData = 0x0000 , BasicSegmentData = 0x0001 }
 
enum  ManeuverDetail { NoManeuvers = 0x0000 , BasicManeuvers = 0x0001 }
 

Signals

void numberAlternativeRoutesChanged ()
 
void travelModesChanged ()
 
void routeOptimizationsChanged ()
 
void waypointsChanged ()
 
void excludedAreasChanged ()
 
void featureTypesChanged ()
 
void maneuverDetailChanged ()
 
void segmentDetailChanged ()
 
void queryDetailsChanged ()
 
void departureTimeChanged ()
 
- Signals inherited from QObject
void destroyed (QObject *=nullptr)
 This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
 
void objectNameChanged (const QString &objectName, QPrivateSignal)
 This signal is emitted after the object's name has been changed.
 

Public Member Functions

 QDeclarativeGeoRouteQuery (QObject *parent=nullptr)
 \qmltype RouteQuery \instantiates QDeclarativeGeoRouteQuery \inqmlmodule QtLocation
 
 QDeclarativeGeoRouteQuery (const QGeoRouteRequest &request, QObject *parent=nullptr)
 
 ~QDeclarativeGeoRouteQuery ()
 
void classBegin () override
 Invoked after class creation, but before any properties have been set.
 
void componentComplete () override
 
QGeoRouteRequest routeRequest () const
 
void setNumberAlternativeRoutes (int numberAlternativeRoutes)
 
int numberAlternativeRoutes () const
 \qmlproperty int RouteQuery::numberAlternativeRoutes
 
QList< int > featureTypes () const
 \qmlproperty QList<FeatureType> RouteQuery::featureTypes
 
QList< QGeoCoordinatewaypoints () const
 \qmlproperty list<coordinate> RouteQuery::waypoints
 
void setWaypoints (const QList< QGeoCoordinate > &value)
 
QList< QGeoRectangleexcludedAreas () const
 \qmlproperty list<georectangle> RouteQuery::excludedAreas
 
void setExcludedAreas (const QList< QGeoRectangle > &value)
 
Q_INVOKABLE void addWaypoint (const QGeoCoordinate &w)
 \qmlmethod void QtLocation::RouteQuery::addWaypoint(coordinate)
 
Q_INVOKABLE void removeWaypoint (const QGeoCoordinate &waypoint)
 \qmlmethod void QtLocation::RouteQuery::removeWaypoint(coordinate)
 
Q_INVOKABLE void clearWaypoints ()
 \qmlmethod void QtLocation::RouteQuery::clearWaypoints()
 
Q_INVOKABLE void addExcludedArea (const QGeoRectangle &area)
 \qmlmethod void QtLocation::RouteQuery::addExcludedArea(georectangle area)
 
Q_INVOKABLE void removeExcludedArea (const QGeoRectangle &area)
 \qmlmethod void QtLocation::RouteQuery::removeExcludedArea(georectangle area)
 
Q_INVOKABLE void clearExcludedAreas ()
 \qmlmethod void QtLocation::RouteQuery::clearExcludedAreas()
 
Q_INVOKABLE void setFeatureWeight (FeatureType featureType, FeatureWeight featureWeight)
 \qmlmethod void QtLocation::RouteQuery::setFeatureWeight(FeatureType feature, FeatureWeight weight)
 
Q_INVOKABLE int featureWeight (FeatureType featureType)
 \qmlmethod FeatureWeight QtLocation::RouteQuery::featureWeight(FeatureType featureType)
 
Q_INVOKABLE void resetFeatureWeights ()
 \qmlmethod void QtLocation::RouteQuery::resetFeatureWeights()
 
void setTravelModes (TravelModes travelModes)
 
TravelModes travelModes () const
 \qmlproperty enumeration RouteQuery::travelModes
 
void setSegmentDetail (SegmentDetail segmentDetail)
 \qmlproperty enumeration RouteQuery::segmentDetail
 
SegmentDetail segmentDetail () const
 
void setManeuverDetail (ManeuverDetail maneuverDetail)
 \qmlproperty enumeration RouteQuery::maneuverDetail
 
ManeuverDetail maneuverDetail () const
 
void setRouteOptimizations (RouteOptimizations optimization)
 
RouteOptimizations routeOptimizations () const
 \qmlproperty enumeration RouteQuery::routeOptimizations
 
void setDepartureTime (const QDateTime &departureTime)
 \qmlproperty date RouteQuery::departureTime
 
QDateTime departureTime () const
 
- Public Member Functions inherited from QObject
Q_INVOKABLE QObject (QObject *parent=nullptr)
 Constructs an object with parent object parent.
 
virtual ~QObject ()
 Destroys the object, deleting all its child objects.
 
virtual bool event (QEvent *event)
 This virtual function receives events to an object and should return true if the event e was recognized and processed.
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 Filters events if this object has been installed as an event filter for the watched object.
 
QString objectName () const
 
Q_WEAK_OVERLOAD void setObjectName (const QString &name)
 Sets the object's name to name.
 
void setObjectName (QAnyStringView name)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QBindable< QStringbindableObjectName ()
 
bool isWidgetType () const
 Returns true if the object is a widget; otherwise returns false.
 
bool isWindowType () const
 Returns true if the object is a window; otherwise returns false.
 
bool isQuickItemType () const
 Returns true if the object is a QQuickItem; otherwise returns false.
 
bool signalsBlocked () const noexcept
 Returns true if signals are blocked; otherwise returns false.
 
bool blockSignals (bool b) noexcept
 If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
 
QThreadthread () const
 Returns the thread in which the object lives.
 
bool moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
 Changes the thread affinity for this object and its children and returns true on success.
 
int startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
 This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
 
int startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
 
void killTimer (int id)
 Kills the timer with timer identifier, id.
 
void killTimer (Qt::TimerId id)
 
template<typename T >
findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
 
template<typename T >
QList< T > findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
 
template<typename T >
findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
template<typename T >
QList< T > findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
const QObjectListchildren () const
 Returns a list of child objects.
 
void setParent (QObject *parent)
 Makes the object a child of parent.
 
void installEventFilter (QObject *filterObj)
 Installs an event filter filterObj on this object.
 
void removeEventFilter (QObject *obj)
 Removes an event filter object obj from this object.
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
 
bool disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const
 
bool disconnect (const QObject *receiver, const char *member=nullptr) const
 
void dumpObjectTree () const
 Dumps a tree of children to the debug output.
 
void dumpObjectInfo () const
 Dumps information about signal connections, etc.
 
bool setProperty (const char *name, const QVariant &value)
 Sets the value of the object's name property to value.
 
bool setProperty (const char *name, QVariant &&value)
 
QVariant property (const char *name) const
 Returns the value of the object's name property.
 
QList< QByteArraydynamicPropertyNames () const
 
QBindingStoragebindingStorage ()
 
const QBindingStoragebindingStorage () const
 
QObjectparent () const
 Returns a pointer to the parent object.
 
bool inherits (const char *classname) const
 Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false.
 
- Public Member Functions inherited from QQmlParserStatus
 QQmlParserStatus ()
 
virtual ~QQmlParserStatus ()
 

Properties

int numberAlternativeRoutes
 
TravelModes travelModes
 
RouteOptimizations routeOptimizations
 
SegmentDetail segmentDetail
 
ManeuverDetail maneuverDetail
 
QList< QGeoCoordinatewaypoints
 
QList< QGeoRectangleexcludedAreas
 
QList< int > featureTypes
 
QDateTime departureTime
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Additional Inherited Members

- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 
- Static Public Member Functions inherited from QObject
static QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 \threadsafe
 
static QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
 
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 \threadsafe
 
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
 
static bool disconnect (const QMetaObject::Connection &)
 Disconnect a connection.
 
template<typename Func1 , typename Func2 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot)
 
template<typename Func1 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero)
 
- Protected Member Functions inherited from QObject
QObjectsender () const
 Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
 
int senderSignalIndex () const
 
int receivers (const char *signal) const
 Returns the number of receivers connected to the signal.
 
bool isSignalConnected (const QMetaMethod &signal) const
 
virtual void timerEvent (QTimerEvent *event)
 This event handler can be reimplemented in a subclass to receive timer events for the object.
 
virtual void childEvent (QChildEvent *event)
 This event handler can be reimplemented in a subclass to receive child events.
 
virtual void customEvent (QEvent *event)
 This event handler can be reimplemented in a subclass to receive custom events.
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
 QObject (QObjectPrivate &dd, QObject *parent=nullptr)
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr
 

Detailed Description

Definition at line 154 of file qdeclarativegeoroutemodel_p.h.

Member Enumeration Documentation

◆ FeatureType

Enumerator
NoFeature 
TollFeature 
HighwayFeature 
PublicTransitFeature 
FerryFeature 
TunnelFeature 
DirtRoadFeature 
ParksFeature 
MotorPoolLaneFeature 
TrafficFeature 

Definition at line 202 of file qdeclarativegeoroutemodel_p.h.

◆ FeatureWeight

Enumerator
NeutralFeatureWeight 
PreferFeatureWeight 
RequireFeatureWeight 
AvoidFeatureWeight 
DisallowFeatureWeight 

Definition at line 216 of file qdeclarativegeoroutemodel_p.h.

◆ ManeuverDetail

Enumerator
NoManeuvers 
BasicManeuvers 

Definition at line 239 of file qdeclarativegeoroutemodel_p.h.

◆ RouteOptimization

Enumerator
ShortestRoute 
FastestRoute 
MostEconomicRoute 
MostScenicRoute 

Definition at line 225 of file qdeclarativegeoroutemodel_p.h.

◆ SegmentDetail

Enumerator
NoSegmentData 
BasicSegmentData 

Definition at line 233 of file qdeclarativegeoroutemodel_p.h.

◆ TravelMode

Enumerator
CarTravel 
PedestrianTravel 
BicycleTravel 
PublicTransitTravel 
TruckTravel 

Definition at line 193 of file qdeclarativegeoroutemodel_p.h.

Constructor & Destructor Documentation

◆ QDeclarativeGeoRouteQuery() [1/2]

QDeclarativeGeoRouteQuery::QDeclarativeGeoRouteQuery ( QObject * parent = nullptr)
explicit

\qmltype RouteQuery \instantiates QDeclarativeGeoRouteQuery \inqmlmodule QtLocation

Since
QtLocation 5.5

The RouteQuery type is used to provide query parameters to a RouteModel.

A RouteQuery is used to pack all the parameters necessary to make a request to a routing service, which can then populate the contents of a RouteModel.

These parameters describe key details of the route, such as \l waypoints to pass through, \l excludedAreas to avoid, the \l travelModes in use, as well as detailed preferences on how to optimize the route and what features to prefer or avoid along the path (such as toll roads, highways, etc).

RouteQuery objects are used exclusively to fill out the value of a RouteModel's \l{RouteModel::query}{query} property, which can then begin the retrieval process to populate the model.

Some plugins might allow or require specific parameters to operate. In order to specify these plugin-specific parameters, MapParameter elements can be nested inside a RouteQuery.

Definition at line 642 of file qdeclarativegeoroutemodel.cpp.

◆ QDeclarativeGeoRouteQuery() [2/2]

QDeclarativeGeoRouteQuery::QDeclarativeGeoRouteQuery ( const QGeoRouteRequest & request,
QObject * parent = nullptr )

Definition at line 647 of file qdeclarativegeoroutemodel.cpp.

References QGeoRouteRequest::waypoints().

+ Here is the call graph for this function:

◆ ~QDeclarativeGeoRouteQuery()

QDeclarativeGeoRouteQuery::~QDeclarativeGeoRouteQuery ( )

Definition at line 655 of file qdeclarativegeoroutemodel.cpp.

Member Function Documentation

◆ addExcludedArea()

void QDeclarativeGeoRouteQuery::addExcludedArea ( const QGeoRectangle & area)

\qmlmethod void QtLocation::RouteQuery::addExcludedArea(georectangle area)

Adds the specified georectangle area to the excluded areas (areas that the route must not cross). The same area can only be added once.

See also
removeExcludedArea, clearExcludedAreas

Definition at line 791 of file qdeclarativegeoroutemodel.cpp.

References QList< T >::append(), area(), QListSpecialMethodsBase< T >::contains(), emit, QGeoRouteRequest::excludeAreas(), excludedAreas, excludedAreasChanged(), queryDetailsChanged(), and QGeoRouteRequest::setExcludeAreas().

+ Here is the call graph for this function:

◆ addWaypoint()

void QDeclarativeGeoRouteQuery::addWaypoint ( const QGeoCoordinate & waypoint)

\qmlmethod void QtLocation::RouteQuery::addWaypoint(coordinate)

Appends the given coordinate to the list of waypoints. The same coordinate can be set multiple times.

See also
removeWaypoint, clearWaypoints

Definition at line 869 of file qdeclarativegeoroutemodel.cpp.

References QGeoCoordinate::isValid, qmlWarning(), and QStringLiteral.

+ Here is the call graph for this function:

◆ classBegin()

void QDeclarativeGeoRouteQuery::classBegin ( )
inlineoverridevirtual

Invoked after class creation, but before any properties have been set.

Implements QQmlParserStatus.

Definition at line 188 of file qdeclarativegeoroutemodel_p.h.

◆ clearExcludedAreas()

void QDeclarativeGeoRouteQuery::clearExcludedAreas ( )

\qmlmethod void QtLocation::RouteQuery::clearExcludedAreas()

Clears all excluded areas (areas that the route must not cross).

See also
addExcludedArea, removeExcludedArea

Definition at line 848 of file qdeclarativegeoroutemodel.cpp.

References emit, QGeoRouteRequest::excludeAreas(), excludedAreasChanged(), QList< T >::isEmpty(), queryDetailsChanged(), and QGeoRouteRequest::setExcludeAreas().

+ Here is the call graph for this function:

◆ clearWaypoints()

void QDeclarativeGeoRouteQuery::clearWaypoints ( )

\qmlmethod void QtLocation::RouteQuery::clearWaypoints()

Clears all waypoints.

See also
removeWaypoint, addWaypoint

Definition at line 911 of file qdeclarativegeoroutemodel.cpp.

References QList< T >::clear(), and QList< T >::isEmpty().

+ Here is the call graph for this function:

◆ componentComplete()

void QDeclarativeGeoRouteQuery::componentComplete ( )
overridevirtual

Implements QQmlParserStatus.

Definition at line 662 of file qdeclarativegeoroutemodel.cpp.

◆ departureTime()

QDateTime QDeclarativeGeoRouteQuery::departureTime ( ) const

Definition at line 1197 of file qdeclarativegeoroutemodel.cpp.

References QGeoRouteRequest::departureTime().

+ Here is the call graph for this function:

◆ departureTimeChanged

void QDeclarativeGeoRouteQuery::departureTimeChanged ( )
signal

Referenced by setDepartureTime().

+ Here is the caller graph for this function:

◆ excludedAreas()

QList< QGeoRectangle > QDeclarativeGeoRouteQuery::excludedAreas ( ) const

\qmlproperty list<georectangle> RouteQuery::excludedAreas

Areas that the route must not cross.

Excluded areas can be set as part of the \l RouteQuery type declaration or dynamically with the functions provided.

See also
addExcludedArea, removeExcludedArea, clearExcludedAreas

Definition at line 762 of file qdeclarativegeoroutemodel.cpp.

References QGeoRouteRequest::excludeAreas().

+ Here is the call graph for this function:

◆ excludedAreasChanged

void QDeclarativeGeoRouteQuery::excludedAreasChanged ( )
signal

Referenced by addExcludedArea(), clearExcludedAreas(), removeExcludedArea(), and setExcludedAreas().

+ Here is the caller graph for this function:

◆ featureTypes()

QList< int > QDeclarativeGeoRouteQuery::featureTypes ( ) const

\qmlproperty QList<FeatureType> RouteQuery::featureTypes

List of features that will be considered when planning the route. Features with a weight of NeutralFeatureWeight will not be returned.

\list

  • RouteQuery.NoFeature - No features will be taken into account when planning the route
  • RouteQuery.TollFeature - Consider tollways when planning the route
  • RouteQuery.HighwayFeature - Consider highways when planning the route
  • RouteQuery.PublicTransitFeature - Consider public transit when planning the route
  • RouteQuery.FerryFeature - Consider ferries when planning the route
  • RouteQuery.TunnelFeature - Consider tunnels when planning the route
  • RouteQuery.DirtRoadFeature - Consider dirt roads when planning the route
  • RouteQuery.ParksFeature - Consider parks when planning the route
  • RouteQuery.MotorPoolLaneFeature - Consider motor pool lanes when planning the route
  • RouteQuery.TrafficFeature - Consider traffic when planning the route \endlist
See also
setFeatureWeight, featureWeight

Definition at line 689 of file qdeclarativegeoroutemodel.cpp.

References QList< T >::append(), featureTypes, QGeoRouteRequest::featureTypes(), and list.

+ Here is the call graph for this function:

◆ featureTypesChanged

void QDeclarativeGeoRouteQuery::featureTypesChanged ( )
signal

Referenced by resetFeatureWeights(), and setFeatureWeight().

+ Here is the caller graph for this function:

◆ featureWeight()

int QDeclarativeGeoRouteQuery::featureWeight ( FeatureType featureType)

\qmlmethod FeatureWeight QtLocation::RouteQuery::featureWeight(FeatureType featureType)

Gets the weight for the featureType.

See also
featureTypes, setFeatureWeight, resetFeatureWeights

Definition at line 1000 of file qdeclarativegeoroutemodel.cpp.

References QGeoRouteRequest::featureWeight().

Referenced by setFeatureWeight().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ maneuverDetail()

QDeclarativeGeoRouteQuery::ManeuverDetail QDeclarativeGeoRouteQuery::maneuverDetail ( ) const

Definition at line 1090 of file qdeclarativegeoroutemodel.cpp.

References QGeoRouteRequest::maneuverDetail().

+ Here is the call graph for this function:

◆ maneuverDetailChanged

void QDeclarativeGeoRouteQuery::maneuverDetailChanged ( )
signal

Referenced by setManeuverDetail().

+ Here is the caller graph for this function:

◆ numberAlternativeRoutes()

int QDeclarativeGeoRouteQuery::numberAlternativeRoutes ( ) const

\qmlproperty int RouteQuery::numberAlternativeRoutes

The number of alternative routes requested when requesting routes. The default value is 0.

Definition at line 707 of file qdeclarativegeoroutemodel.cpp.

References QGeoRouteRequest::numberAlternativeRoutes().

+ Here is the call graph for this function:

◆ numberAlternativeRoutesChanged

void QDeclarativeGeoRouteQuery::numberAlternativeRoutesChanged ( )
signal

Referenced by setNumberAlternativeRoutes().

+ Here is the caller graph for this function:

◆ queryDetailsChanged

void QDeclarativeGeoRouteQuery::queryDetailsChanged ( )
signal

Referenced by addExcludedArea(), clearExcludedAreas(), removeExcludedArea(), resetFeatureWeights(), setDepartureTime(), setExcludedAreas(), setFeatureWeight(), setManeuverDetail(), setNumberAlternativeRoutes(), QDeclarativeGeoRouteModel::setQuery(), setRouteOptimizations(), setSegmentDetail(), and setTravelModes().

+ Here is the caller graph for this function:

◆ removeExcludedArea()

void QDeclarativeGeoRouteQuery::removeExcludedArea ( const QGeoRectangle & area)

\qmlmethod void QtLocation::RouteQuery::removeExcludedArea(georectangle area)

Removes the given area from excluded areas (areas that the route must not cross).

See also
addExcludedArea, clearExcludedAreas

Definition at line 819 of file qdeclarativegeoroutemodel.cpp.

References area(), emit, QGeoRouteRequest::excludeAreas(), excludedAreas, excludedAreasChanged(), QListSpecialMethodsBase< T >::lastIndexOf(), qmlWarning(), QStringLiteral, queryDetailsChanged(), QList< T >::removeAt(), and QGeoRouteRequest::setExcludeAreas().

+ Here is the call graph for this function:

◆ removeWaypoint()

void QDeclarativeGeoRouteQuery::removeWaypoint ( const QGeoCoordinate & waypoint)

\qmlmethod void QtLocation::RouteQuery::removeWaypoint(coordinate)

Removes the given coordinate from the list of waypoints. If the same coordinate appears multiple times, the most recently added coordinate instance is removed.

See also
addWaypoint, clearWaypoints

Definition at line 889 of file qdeclarativegeoroutemodel.cpp.

References QGeoCoordinate::isValid, QListSpecialMethodsBase< T >::lastIndexOf(), qmlWarning(), QStringLiteral, and QList< T >::remove().

+ Here is the call graph for this function:

◆ resetFeatureWeights()

void QDeclarativeGeoRouteQuery::resetFeatureWeights ( )

\qmlmethod void QtLocation::RouteQuery::resetFeatureWeights()

Resets all feature weights to their default state (NeutralFeatureWeight).

See also
featureTypes, setFeatureWeight, featureWeight

Definition at line 980 of file qdeclarativegeoroutemodel.cpp.

References emit, featureTypes, QGeoRouteRequest::featureTypes(), featureTypesChanged(), QGeoRouteRequest::NeutralFeatureWeight, queryDetailsChanged(), and QGeoRouteRequest::setFeatureWeight().

Referenced by setFeatureWeight().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ routeOptimizations()

QDeclarativeGeoRouteQuery::RouteOptimizations QDeclarativeGeoRouteQuery::routeOptimizations ( ) const

\qmlproperty enumeration RouteQuery::routeOptimizations

The route optimizations which should be considered during the planning of the route. Values can be combined with OR ('|') -operator.

\value RouteQuery.ShortestRoute Minimize the length of the journey

\value RouteQuery.FastestRoute Minimize the traveling time for the journey

\value RouteQuery.MostEconomicRoute Minimize the cost of the journey

\value RouteQuery.MostScenicRoute Maximize the scenic potential of the journey

The default value is {RouteQuery.FastestRoute}.

Definition at line 1160 of file qdeclarativegeoroutemodel.cpp.

References FastestRoute, QGeoRouteRequest::FastestRoute, MostEconomicRoute, QGeoRouteRequest::MostEconomicRoute, MostScenicRoute, QGeoRouteRequest::MostScenicRoute, QGeoRouteRequest::routeOptimization(), ShortestRoute, and QGeoRouteRequest::ShortestRoute.

+ Here is the call graph for this function:

◆ routeOptimizationsChanged

void QDeclarativeGeoRouteQuery::routeOptimizationsChanged ( )
signal

Referenced by setRouteOptimizations().

+ Here is the caller graph for this function:

◆ routeRequest()

QGeoRouteRequest QDeclarativeGeoRouteQuery::routeRequest ( ) const

Definition at line 1229 of file qdeclarativegeoroutemodel.cpp.

References QGeoRouteRequest::setWaypoints().

Referenced by QDeclarativeGeoRouteModel::update().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ segmentDetail()

QDeclarativeGeoRouteQuery::SegmentDetail QDeclarativeGeoRouteQuery::segmentDetail ( ) const

Definition at line 1060 of file qdeclarativegeoroutemodel.cpp.

References QGeoRouteRequest::segmentDetail().

+ Here is the call graph for this function:

◆ segmentDetailChanged

void QDeclarativeGeoRouteQuery::segmentDetailChanged ( )
signal

Referenced by setSegmentDetail().

+ Here is the caller graph for this function:

◆ setDepartureTime()

void QDeclarativeGeoRouteQuery::setDepartureTime ( const QDateTime & departureTime)

\qmlproperty date RouteQuery::departureTime

The departure time to be used when querying for the route. The default value is an invalid date, meaning no departure time will be used in the query.

Since
5.13

Definition at line 1185 of file qdeclarativegeoroutemodel.cpp.

References departureTime, QGeoRouteRequest::departureTime(), departureTimeChanged(), emit, queryDetailsChanged(), and QGeoRouteRequest::setDepartureTime().

+ Here is the call graph for this function:

◆ setExcludedAreas()

void QDeclarativeGeoRouteQuery::setExcludedAreas ( const QList< QGeoRectangle > & value)

Definition at line 767 of file qdeclarativegeoroutemodel.cpp.

References emit, QGeoRouteRequest::excludeAreas(), excludedAreasChanged(), queryDetailsChanged(), and QGeoRouteRequest::setExcludeAreas().

+ Here is the call graph for this function:

◆ setFeatureWeight()

void QDeclarativeGeoRouteQuery::setFeatureWeight ( FeatureType featureType,
FeatureWeight featureWeight )

\qmlmethod void QtLocation::RouteQuery::setFeatureWeight(FeatureType feature, FeatureWeight weight)

Defines the weight to associate with a feature during the planning of a route.

Following lists the possible feature weights:

\value RouteQuery.NeutralFeatureWeight The presence or absence of the feature does not affect the planning of the route

\value RouteQuery.PreferFeatureWeight Routes which contain the feature are preferred over those that do not

\value RouteQuery.RequireFeatureWeight Only routes which contain the feature are considered, otherwise no route will be returned

\value RouteQuery.AvoidFeatureWeight Routes which do not contain the feature are preferred over those that do

\value RouteQuery.DisallowFeatureWeight Only routes which do not contain the feature are considered, otherwise no route will be returned

See also
featureTypes, resetFeatureWeights, featureWeight

Definition at line 951 of file qdeclarativegeoroutemodel.cpp.

References emit, QGeoRouteRequest::featureTypes(), featureTypesChanged(), featureWeight(), QGeoRouteRequest::featureWeight(), NeutralFeatureWeight, NoFeature, queryDetailsChanged(), resetFeatureWeights(), and QGeoRouteRequest::setFeatureWeight().

+ Here is the call graph for this function:

◆ setManeuverDetail()

void QDeclarativeGeoRouteQuery::setManeuverDetail ( ManeuverDetail maneuverDetail)

\qmlproperty enumeration RouteQuery::maneuverDetail

The level of detail which will be used in the representation of routing maneuvers.

\value RouteQuery.NoManeuvers No maneuvers should be included with the route

\value RouteQuery.BasicManeuvers Basic maneuvers will be included with the route

The default value is {RouteQuery.BasicManeuvers}.

Definition at line 1079 of file qdeclarativegeoroutemodel.cpp.

References emit, maneuverDetail, QGeoRouteRequest::maneuverDetail(), maneuverDetailChanged(), queryDetailsChanged(), and QGeoRouteRequest::setManeuverDetail().

+ Here is the call graph for this function:

◆ setNumberAlternativeRoutes()

void QDeclarativeGeoRouteQuery::setNumberAlternativeRoutes ( int numberAlternativeRoutes)

Definition at line 712 of file qdeclarativegeoroutemodel.cpp.

References emit, numberAlternativeRoutes, QGeoRouteRequest::numberAlternativeRoutes(), numberAlternativeRoutesChanged(), queryDetailsChanged(), and QGeoRouteRequest::setNumberAlternativeRoutes().

+ Here is the call graph for this function:

◆ setRouteOptimizations()

void QDeclarativeGeoRouteQuery::setRouteOptimizations ( RouteOptimizations optimization)

◆ setSegmentDetail()

void QDeclarativeGeoRouteQuery::setSegmentDetail ( SegmentDetail segmentDetail)

\qmlproperty enumeration RouteQuery::segmentDetail

The level of detail which will be used in the representation of routing segments.

\value RouteQuery.NoSegmentData No segment data should be included with the route

\value RouteQuery.BasicSegmentData Basic segment data will be included with the route

The default value is {RouteQuery.BasicSegmentData}.

Definition at line 1049 of file qdeclarativegeoroutemodel.cpp.

References emit, queryDetailsChanged(), segmentDetail, QGeoRouteRequest::segmentDetail(), segmentDetailChanged(), and QGeoRouteRequest::setSegmentDetail().

+ Here is the call graph for this function:

◆ setTravelModes()

void QDeclarativeGeoRouteQuery::setTravelModes ( TravelModes travelModes)

◆ setWaypoints()

void QDeclarativeGeoRouteQuery::setWaypoints ( const QList< QGeoCoordinate > & value)

Definition at line 743 of file qdeclarativegeoroutemodel.cpp.

◆ travelModes()

QDeclarativeGeoRouteQuery::TravelModes QDeclarativeGeoRouteQuery::travelModes ( ) const

\qmlproperty enumeration RouteQuery::travelModes

The travel modes which should be considered during the planning of the route. Values can be combined with OR ('|') -operator.

\value RouteQuery.CarTravel The route will be optimized for someone who is driving a car

\value RouteQuery.PedestrianTravel The route will be optimized for someone who is walking

\value RouteQuery.BicycleTravel The route will be optimized for someone who is riding a bicycle

\value RouteQuery.PublicTransit Travel The route will be optimized for someone who is making use of public transit

\value RouteQuery.TruckTravel The route will be optimized for someone who is driving a truck

The default value is {RouteQuery.CarTravel}.

Definition at line 1119 of file qdeclarativegeoroutemodel.cpp.

References BicycleTravel, QGeoRouteRequest::BicycleTravel, CarTravel, QGeoRouteRequest::CarTravel, PedestrianTravel, QGeoRouteRequest::PedestrianTravel, PublicTransitTravel, QGeoRouteRequest::PublicTransitTravel, travelModes, QGeoRouteRequest::travelModes(), TruckTravel, and QGeoRouteRequest::TruckTravel.

+ Here is the call graph for this function:

◆ travelModesChanged

void QDeclarativeGeoRouteQuery::travelModesChanged ( )
signal

Referenced by setTravelModes().

+ Here is the caller graph for this function:

◆ waypoints()

QList< QGeoCoordinate > QDeclarativeGeoRouteQuery::waypoints ( ) const

\qmlproperty list<coordinate> RouteQuery::waypoints

The coordinates of the waypoints for the desired route. The waypoints should be given in order from origin to destination. Two or more coordinates are needed.

Waypoints can be set as part of the RouteQuery type declaration or dynamically with the functions provided.

See also
addWaypoint, removeWaypoint, clearWaypoints

Definition at line 738 of file qdeclarativegeoroutemodel.cpp.

◆ waypointsChanged

void QDeclarativeGeoRouteQuery::waypointsChanged ( )
signal

Property Documentation

◆ departureTime

QDateTime QDeclarativeGeoRouteQuery::departureTime
readwrite

Definition at line 178 of file qdeclarativegeoroutemodel_p.h.

Referenced by setDepartureTime().

◆ excludedAreas

QList<QGeoRectangle> QDeclarativeGeoRouteQuery::excludedAreas
readwrite

Definition at line 176 of file qdeclarativegeoroutemodel_p.h.

Referenced by addExcludedArea(), and removeExcludedArea().

◆ featureTypes

QList<int> QDeclarativeGeoRouteQuery::featureTypes
read

Definition at line 177 of file qdeclarativegeoroutemodel_p.h.

Referenced by featureTypes(), and resetFeatureWeights().

◆ maneuverDetail

ManeuverDetail QDeclarativeGeoRouteQuery::maneuverDetail
readwrite

Definition at line 174 of file qdeclarativegeoroutemodel_p.h.

Referenced by setManeuverDetail().

◆ numberAlternativeRoutes

int QDeclarativeGeoRouteQuery::numberAlternativeRoutes
readwrite

Definition at line 170 of file qdeclarativegeoroutemodel_p.h.

Referenced by setNumberAlternativeRoutes().

◆ routeOptimizations

RouteOptimizations QDeclarativeGeoRouteQuery::routeOptimizations
readwrite

Definition at line 172 of file qdeclarativegeoroutemodel_p.h.

◆ segmentDetail

SegmentDetail QDeclarativeGeoRouteQuery::segmentDetail
readwrite

Definition at line 173 of file qdeclarativegeoroutemodel_p.h.

Referenced by setSegmentDetail().

◆ travelModes

TravelModes QDeclarativeGeoRouteQuery::travelModes
readwrite

Definition at line 171 of file qdeclarativegeoroutemodel_p.h.

Referenced by setTravelModes(), and travelModes().

◆ waypoints

QList<QGeoCoordinate> QDeclarativeGeoRouteQuery::waypoints
readwrite

Definition at line 175 of file qdeclarativegeoroutemodel_p.h.


The documentation for this class was generated from the following files: