QDeclarativeGeoRouteModel Class Reference

#include <qdeclarativegeoroutemodel_p.h>

Inheritance diagram for QDeclarativeGeoRouteModel:

Collaboration diagram for QDeclarativeGeoRouteModel:

Public Types
enum	Roles { RouteRole = Qt::UserRole + 500 }
enum	Status { Null , Ready , Loading , Error }
enum	RouteError {   NoError = QGeoRouteReply::NoError , EngineNotSetError = QGeoRouteReply::EngineNotSetError , CommunicationError = QGeoRouteReply::CommunicationError , ParseError = QGeoRouteReply::ParseError ,   UnsupportedOptionError = QGeoRouteReply::UnsupportedOptionError , UnknownError = QGeoRouteReply::UnknownError , UnknownParameterError = 100 , MissingRequiredParameterError }
Public Types inherited from QAbstractItemModel
enum	LayoutChangeHint { NoLayoutChangeHint , VerticalSortHint , HorizontalSortHint }
	This enum describes the way the model changes layout. More...
enum class	CheckIndexOption { NoOption = 0x0000 , IndexIsValid = 0x0001 , DoNotUseParent = 0x0002 , ParentIsInvalid = 0x0004 }

Public Slots
void	update ()
	\qmlmethod void QtLocation::RouteModel::update()
Public Slots inherited from QAbstractItemModel
virtual bool	submit ()
	Lets the model know that it should submit cached information to permanent storage.
virtual void	revert ()
	Lets the model know that it should discard cached information.
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Signals
void	countChanged ()
void	pluginChanged ()
void	queryChanged ()
void	autoUpdateChanged ()
void	statusChanged ()
void	errorChanged ()
void	routesChanged ()
void	measurementSystemChanged ()
void	abortRequested ()
Signals inherited from QAbstractItemModel
void	dataChanged (const QModelIndex &topLeft, const QModelIndex &bottomRight, const QList< int > &roles=QList< int >())
	This signal is emitted whenever the data in an existing item changes.
void	headerDataChanged (Qt::Orientation orientation, int first, int last)
	This signal is emitted whenever a header is changed.
void	layoutChanged (const QList< QPersistentModelIndex > &parents=QList< QPersistentModelIndex >(), QAbstractItemModel::LayoutChangeHint hint=QAbstractItemModel::NoLayoutChangeHint)
void	layoutAboutToBeChanged (const QList< QPersistentModelIndex > &parents=QList< QPersistentModelIndex >(), QAbstractItemModel::LayoutChangeHint hint=QAbstractItemModel::NoLayoutChangeHint)
void	rowsAboutToBeInserted (const QModelIndex &parent, int first, int last, QPrivateSignal)
	This signal is emitted just before rows are inserted into the model.
void	rowsInserted (const QModelIndex &parent, int first, int last, QPrivateSignal)
	This signal is emitted after rows have been inserted into the model.
void	rowsAboutToBeRemoved (const QModelIndex &parent, int first, int last, QPrivateSignal)
	This signal is emitted just before rows are removed from the model.
void	rowsRemoved (const QModelIndex &parent, int first, int last, QPrivateSignal)
	This signal is emitted after rows have been removed from the model.
void	columnsAboutToBeInserted (const QModelIndex &parent, int first, int last, QPrivateSignal)
	This signal is emitted just before columns are inserted into the model.
void	columnsInserted (const QModelIndex &parent, int first, int last, QPrivateSignal)
	This signal is emitted after columns have been inserted into the model.
void	columnsAboutToBeRemoved (const QModelIndex &parent, int first, int last, QPrivateSignal)
	This signal is emitted just before columns are removed from the model.
void	columnsRemoved (const QModelIndex &parent, int first, int last, QPrivateSignal)
	This signal is emitted after columns have been removed from the model.
void	modelAboutToBeReset (QPrivateSignal)
void	modelReset (QPrivateSignal)
void	rowsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow, QPrivateSignal)
void	rowsMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow, QPrivateSignal)
void	columnsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn, QPrivateSignal)
void	columnsMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn, QPrivateSignal)
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
	QDeclarativeGeoRouteModel (QObject *parent=nullptr)
	\qmltype RouteModel \nativetype QDeclarativeGeoRouteModel \inqmlmodule QtLocation
void	classBegin () override
	Invoked after class creation, but before any properties have been set.
void	componentComplete () override
int	rowCount (const QModelIndex &parent) const override
QVariant	data (const QModelIndex &index, int role) const override
QHash< int, QByteArray >	roleNames () const override
void	setPlugin (QDeclarativeGeoServiceProvider *plugin)
QDeclarativeGeoServiceProvider *	plugin () const
	\qmlproperty Plugin QtLocation::RouteModel::plugin
void	setQuery (QDeclarativeGeoRouteQuery *query)
QDeclarativeGeoRouteQuery *	query () const
	\qmlproperty RouteQuery QtLocation::RouteModel::query
void	setAutoUpdate (bool autoUpdate)
bool	autoUpdate () const
	\qmlproperty bool QtLocation::RouteModel::autoUpdate
void	setMeasurementSystem (QLocale::MeasurementSystem ms)
	\qmlproperty Locale::MeasurementSystem QtLocation::RouteModel::measurementSystem
QLocale::MeasurementSystem	measurementSystem () const
Status	status () const
	\qmlproperty enumeration QtLocation::RouteModel::status
QString	errorString () const
	\qmlproperty string QtLocation::RouteModel::errorString
RouteError	error () const
	\qmlproperty enumeration QtLocation::RouteModel::error
int	count () const
	\qmlproperty int QtLocation::RouteModel::count
Q_INVOKABLE QGeoRoute	get (int index)
	\qmlmethod route QtLocation::RouteModel::get(int index)
Q_INVOKABLE void	reset ()
	\qmlmethod void QtLocation::RouteModel::reset()
Q_INVOKABLE void	cancel ()
	\qmlmethod void QtLocation::RouteModel::cancel()
Public Member Functions inherited from QAbstractListModel
	QAbstractListModel (QObject *parent=nullptr)
	Constructs an abstract list model with the given parent.
	~QAbstractListModel ()
	Destroys the abstract list model.
QModelIndex	index (int row, int column=0, const QModelIndex &parent=QModelIndex()) const override
	Returns the index of the data in row and column with parent.
QModelIndex	sibling (int row, int column, const QModelIndex &idx) const override
	\reimp
bool	dropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) override
	\reimp
Qt::ItemFlags	flags (const QModelIndex &index) const override
	\reimp
QObject *	parent () const
	Returns a pointer to the parent object.
Public Member Functions inherited from QAbstractItemModel
	QAbstractItemModel (QObject *parent=nullptr)
	Constructs an abstract item model with the given parent.
virtual	~QAbstractItemModel ()
	Destroys the abstract item model.
Q_INVOKABLE bool	hasIndex (int row, int column, const QModelIndex &parent=QModelIndex()) const
	Returns {true} if the model returns a valid QModelIndex for row and column with parent, otherwise returns {false}.
virtual Q_INVOKABLE bool	setData (const QModelIndex &index, const QVariant &value, int role=Qt::EditRole)
	Sets the role data for the item at index to value.
virtual Q_INVOKABLE QVariant	headerData (int section, Qt::Orientation orientation, int role=Qt::DisplayRole) const
	Returns the data for the given role and section in the header with the specified orientation.
virtual bool	setHeaderData (int section, Qt::Orientation orientation, const QVariant &value, int role=Qt::EditRole)
	Sets the data for the given role and section in the header with the specified orientation to the value supplied.
virtual QMap< int, QVariant >	itemData (const QModelIndex &index) const
	Returns a map with values for all predefined roles in the model for the item at the given index.
virtual bool	setItemData (const QModelIndex &index, const QMap< int, QVariant > &roles)
	Sets the role data for the item at index to the associated value in roles, for every Qt::ItemDataRole.
virtual bool	clearItemData (const QModelIndex &index)
virtual QStringList	mimeTypes () const
	Returns the list of allowed MIME types.
virtual QMimeData *	mimeData (const QModelIndexList &indexes) const
	Returns an object that contains serialized items of data corresponding to the list of indexes specified.
virtual bool	canDropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) const
	Returns {true} if a model can accept a drop of the data.
virtual Qt::DropActions	supportedDropActions () const
virtual Qt::DropActions	supportedDragActions () const
	Returns the actions supported by the data in this model.
Q_INVOKABLE	Q_REVISION (6, 4) virtual bool insertRows(int row
Q_INVOKABLE	Q_REVISION (6, 4) virtual bool insertColumns(int column
Q_INVOKABLE	Q_REVISION (6, 4) virtual bool removeRows(int row
Q_INVOKABLE	Q_REVISION (6, 4) virtual bool removeColumns(int column
Q_INVOKABLE	Q_REVISION (6, 4) virtual bool moveRows(const QModelIndex &sourceParent
Q_INVOKABLE	Q_REVISION (6, 4) virtual bool moveColumns(const QModelIndex &sourceParent
Q_INVOKABLE	Q_REVISION (6, 4) inline bool insertRow(int row
Q_INVOKABLE	Q_REVISION (6, 4) inline bool insertColumn(int column
Q_INVOKABLE	Q_REVISION (6, 4) inline bool removeRow(int row
Q_INVOKABLE	Q_REVISION (6, 4) inline bool removeColumn(int column
Q_INVOKABLE	Q_REVISION (6, 4) inline bool moveRow(const QModelIndex &sourceParent
Q_INVOKABLE	Q_REVISION (6, 4) inline bool moveColumn(const QModelIndex &sourceParent
virtual Q_INVOKABLE void	fetchMore (const QModelIndex &parent)
	Fetches any available data for the items with the parent specified by the parent index.
virtual Q_INVOKABLE bool	canFetchMore (const QModelIndex &parent) const
	Returns {true} if there is more data available for parent; otherwise returns {false}.
Q_INVOKABLE	Q_REVISION (6, 4) virtual void sort(int column
virtual QModelIndex	buddy (const QModelIndex &index) const
	Returns a model index for the buddy of the item represented by index.
virtual Q_INVOKABLE QModelIndexList	match (const QModelIndex &start, int role, const QVariant &value, int hits=1, Qt::MatchFlags flags=Qt::MatchFlags(Qt::MatchStartsWith|Qt::MatchWrap)) const
	Returns a list of indexes for the items in the column of the start index where data stored under the given role matches the specified value.
virtual QSize	span (const QModelIndex &index) const
	Returns the row and column span of the item represented by index.
bool	checkIndex (const QModelIndex &index, CheckIndexOptions options=CheckIndexOption::NoOption) const
virtual void	multiData (const QModelIndex &index, QModelRoleDataSpan roleDataSpan) const
QObject *	parent () const
	Returns a pointer to the parent object.
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< QString >	bindableObjectName ()
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).
QThread *	thread () 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 >
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 >
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 QObjectList &	children () 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< QByteArray >	dynamicPropertyNames () const
QBindingStorage *	bindingStorage ()
const QBindingStorage *	bindingStorage () const
QObject *	parent () 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
QDeclarativeGeoServiceProvider *	plugin
QDeclarativeGeoRouteQuery *	query
int	count
bool	autoUpdate
Status	status
QString	errorString
RouteError	error
QLocale::MeasurementSystem	measurementSystem
Properties inherited from QObject
QString	objectName
	the name of this object

Additional Inherited Members
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)
Public Attributes inherited from QAbstractItemModel
Q_INVOKABLE int	count
Q_INVOKABLE int const QModelIndex &	parent = QModelIndex())
	Returns the parent of the model item with the given index.
Q_INVOKABLE int	sourceRow
Q_INVOKABLE int int	count
Q_INVOKABLE int int const QModelIndex &	destinationParent
Q_INVOKABLE int int const QModelIndex int	destinationChild
Q_INVOKABLE int	sourceColumn
Q_INVOKABLE const QModelIndex &	parent = QModelIndex())
Q_INVOKABLE int const QModelIndex &	destinationParent
Q_INVOKABLE int const QModelIndex int	destinationChild
Q_INVOKABLE Qt::SortOrder	order = Qt::AscendingOrder)
Protected Slots inherited from QAbstractItemModel
virtual void	resetInternalData ()
Protected Member Functions inherited from QAbstractListModel
	QAbstractListModel (QAbstractItemModelPrivate &dd, QObject *parent)
Protected Member Functions inherited from QAbstractItemModel
	QAbstractItemModel (QAbstractItemModelPrivate &dd, QObject *parent=nullptr)
QModelIndex	createIndex (int row, int column, const void *data=nullptr) const
	Creates a model index for the given row and column with the internal pointer ptr.
QModelIndex	createIndex (int row, int column, quintptr id) const
	Creates a model index for the given row and column with the internal identifier, id.
void	encodeData (const QModelIndexList &indexes, QDataStream &stream) const
bool	decodeData (int row, int column, const QModelIndex &parent, QDataStream &stream)
void	beginInsertRows (const QModelIndex &parent, int first, int last)
	Begins a row insertion operation.
void	endInsertRows ()
	Ends a row insertion operation.
void	beginRemoveRows (const QModelIndex &parent, int first, int last)
	Begins a row removal operation.
void	endRemoveRows ()
	Ends a row removal operation.
bool	beginMoveRows (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationRow)
void	endMoveRows ()
	Ends a row move operation.
void	beginInsertColumns (const QModelIndex &parent, int first, int last)
	Begins a column insertion operation.
void	endInsertColumns ()
	Ends a column insertion operation.
void	beginRemoveColumns (const QModelIndex &parent, int first, int last)
	Begins a column removal operation.
void	endRemoveColumns ()
	Ends a column removal operation.
bool	beginMoveColumns (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationColumn)
	Begins a column move operation.
void	endMoveColumns ()
	Ends a column move operation.
void	beginResetModel ()
	Begins a model reset operation.
void	endResetModel ()
	Completes a model reset operation.
void	changePersistentIndex (const QModelIndex &from, const QModelIndex &to)
	Changes the QPersistentModelIndex that is equal to the given from model index to the given to model index.
void	changePersistentIndexList (const QModelIndexList &from, const QModelIndexList &to)
QModelIndexList	persistentIndexList () const
Protected Member Functions inherited from QObject
QObject *	sender () 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< QObjectData >	d_ptr
Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()
template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()
	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

Definition at line 39 of file qdeclarativegeoroutemodel_p.h.

Member Enumeration Documentation

Roles

enum QDeclarativeGeoRouteModel::Roles

Enumerator
RouteRole

Definition at line 59 of file qdeclarativegeoroutemodel_p.h.

RouteError

enum QDeclarativeGeoRouteModel::RouteError

Enumerator
NoError
EngineNotSetError
CommunicationError
ParseError
UnsupportedOptionError
UnknownError
UnknownParameterError
MissingRequiredParameterError

Definition at line 70 of file qdeclarativegeoroutemodel_p.h.

Status

enum QDeclarativeGeoRouteModel::Status

Enumerator
Null
Ready
Loading
Error

Definition at line 63 of file qdeclarativegeoroutemodel_p.h.

Constructor & Destructor Documentation

QDeclarativeGeoRouteModel()

QT_BEGIN_NAMESPACE QDeclarativeGeoRouteModel::QDeclarativeGeoRouteModel ( QObject * parent = nullptr )

explicit

\qmltype RouteModel \nativetype QDeclarativeGeoRouteModel \inqmlmodule QtLocation

Since

QtLocation 5.5

The RouteModel type provides access to routes.

The RouteModel type is used as part of a model/view grouping to retrieve geographic routes from a backend provider. Routes include data about driving directions between two points, walking directions with multiple waypoints, and various other similar concepts. It functions much like other Model types in QML (see for example \l {Models and Views in Qt Quick#Models}{ListModel}), and interacts with views such as \l MapItemView, and \l{ListView}.

Like \l Map and \l GeocodeModel, all the data for a RouteModel to work comes from a services plugin. This is contained in the \l{plugin} property, and this must be set before the RouteModel can do any useful work.

Once the plugin is set, create a \l RouteQuery with the appropriate waypoints and other settings, and set the RouteModel's \l{query} property. If \l autoUpdate is enabled, the update will being automatically. Otherwise, the \l{update} method may be used. By default, autoUpdate is disabled.

The data stored and returned in the RouteModel consists of \l route objects, as a list with the role name "routeData". See the documentation for \l route for further details on its structure and contents.

Definition at line 82 of file qdeclarativegeoroutemodel.cpp.

Member Function Documentation

abortRequested

void QDeclarativeGeoRouteModel::abortRequested ( )

signal

autoUpdate()

bool QDeclarativeGeoRouteModel::autoUpdate

(

)

const

\qmlproperty bool QtLocation::RouteModel::autoUpdate

This property controls whether the Model automatically updates in response to changes in its attached RouteQuery. The default value of this property is false.

If setting this value to 'true', note that any change at all in the RouteQuery object set in the \l{query} property will trigger a new request to be sent. If you are adjusting many properties of the RouteQuery with autoUpdate enabled, this can generate large numbers of useless (and later discarded) requests.

Definition at line 361 of file qdeclarativegeoroutemodel.cpp.

autoUpdateChanged

void QDeclarativeGeoRouteModel::autoUpdateChanged ( )

signal

cancel()

void QDeclarativeGeoRouteModel::cancel

(

)

\qmlmethod void QtLocation::RouteModel::cancel()

Cancels any outstanding requests and clears errors. Model status will be set to either RouteModel.Null or RouteModel.Ready.

Definition at line 129 of file qdeclarativegeoroutemodel.cpp.

classBegin()

void QDeclarativeGeoRouteModel::classBegin ( )

inlineoverridevirtual

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

Implements QQmlParserStatus.

Definition at line 87 of file qdeclarativegeoroutemodel_p.h.

componentComplete()

void QDeclarativeGeoRouteModel::componentComplete ( )

overridevirtual

Implements QQmlParserStatus.

Definition at line 159 of file qdeclarativegeoroutemodel.cpp.

count()

int QDeclarativeGeoRouteModel::count

(

)

const

\qmlproperty int QtLocation::RouteModel::count

This property holds how many routes the model currently has. Amongst other uses, you can use this value when accessing routes via the QtLocation::RouteModel::get -method.

Definition at line 95 of file qdeclarativegeoroutemodel.cpp.

countChanged

void QDeclarativeGeoRouteModel::countChanged ( )

signal

data()

QVariant QDeclarativeGeoRouteModel::data ( const QModelIndex & index, int role ) const

overridevirtual

Implements QAbstractItemModel.

Definition at line 179 of file qdeclarativegeoroutemodel.cpp.

error()

QDeclarativeGeoRouteModel::RouteError QDeclarativeGeoRouteModel::error

(

)

const

\qmlproperty enumeration QtLocation::RouteModel::error

This read-only property holds the latest error value of the routing request.

\list

• RouteModel.NoError - No error has occurred.
• RouteModel.CommunicationError - An error occurred while communicating with the service provider.
• RouteModel.EngineNotSetError - The model's plugin property was not set or there is no routing manager associated with the plugin.
• RouteModel.MissingRequiredParameterError - A required parameter was not specified.
• RouteModel.ParseError - The response from the service provider was in an unrecognizable format.
• RouteModel.UnknownError - An error occurred which does not fit into any of the other categories.
• RouteModel.UnknownParameterError - The plugin did not recognize one of the parameters it was given.
• RouteModel.UnsupportedOptionError - The requested operation is not supported by the routing provider. This may happen when the loaded engine does not support a particular type of routing request. \endlist

Definition at line 486 of file qdeclarativegeoroutemodel.cpp.

errorChanged

void QDeclarativeGeoRouteModel::errorChanged ( )

signal

errorString()

QString QDeclarativeGeoRouteModel::errorString

(

)

const

\qmlproperty string QtLocation::RouteModel::errorString

This read-only property holds the textual presentation of the latest routing error. If no error has occurred or the model has been reset, an empty string is returned.

An empty string may also be returned if an error occurred which has no associated textual representation.

Definition at line 462 of file qdeclarativegeoroutemodel.cpp.

get()

QGeoRoute QDeclarativeGeoRouteModel::get

(

int

index

)

\qmlmethod route QtLocation::RouteModel::get(int index)

Returns the route at the specified index. Use the \l count property to check the amount of routes available. The routes are indexed from zero, so the accessible range is 0...(count - 1).

If you access out of bounds, an empty route is returned and a warning is issued.

Definition at line 147 of file qdeclarativegeoroutemodel.cpp.

measurementSystem()

QLocale::MeasurementSystem QDeclarativeGeoRouteModel::measurementSystem

(

)

const

Definition at line 396 of file qdeclarativegeoroutemodel.cpp.

measurementSystemChanged

void QDeclarativeGeoRouteModel::measurementSystemChanged ( )

signal

plugin()

QDeclarativeGeoServiceProvider * QDeclarativeGeoRouteModel::plugin

(

)

const

\qmlproperty Plugin QtLocation::RouteModel::plugin

This property holds the plugin that providers the actual routing service. Note that all plugins do not necessarily provide routing (could for example provide only geocoding or maps).

A valid plugin must be set before the RouteModel can perform any useful operations.

See also

Plugin

Definition at line 298 of file qdeclarativegeoroutemodel.cpp.

pluginChanged

void QDeclarativeGeoRouteModel::pluginChanged ( )

signal

query()

QDeclarativeGeoRouteQuery * QDeclarativeGeoRouteModel::query

(

)

const

\qmlproperty RouteQuery QtLocation::RouteModel::query

This property holds the data of the route request. The primary data are the waypoint coordinates and possible further preferences (means of traveling, things to avoid on route etc).

Definition at line 330 of file qdeclarativegeoroutemodel.cpp.

queryChanged

void QDeclarativeGeoRouteModel::queryChanged ( )

signal

reset()

void QDeclarativeGeoRouteModel::reset

(

)

\qmlmethod void QtLocation::RouteModel::reset()

Resets the model. All route data is cleared, any outstanding requests are aborted and possible errors are cleared. Model status will be set to RouteModel.Null

Definition at line 108 of file qdeclarativegeoroutemodel.cpp.

roleNames()

QHash< int, QByteArray > QDeclarativeGeoRouteModel::roleNames ( ) const

overridevirtual

Since

4.6

Returns the model's role names.

The default role names set by Qt are:

\table \header

• Qt Role
• QML Role Name \row
• Qt::DisplayRole
• display \row
• Qt::DecorationRole
• decoration \row
• Qt::EditRole
• edit \row
• Qt::ToolTipRole
• toolTip \row
• Qt::StatusTipRole
• statusTip \row
• Qt::WhatsThisRole
• whatsThis \endtable

Reimplemented from QAbstractItemModel.

Definition at line 196 of file qdeclarativegeoroutemodel.cpp.

routesChanged

void QDeclarativeGeoRouteModel::routesChanged ( )

signal

rowCount()

int QDeclarativeGeoRouteModel::rowCount ( const QModelIndex & parent ) const

overridevirtual

Implements QAbstractItemModel.

Definition at line 170 of file qdeclarativegeoroutemodel.cpp.

setAutoUpdate()

void QDeclarativeGeoRouteModel::setAutoUpdate

(

bool

autoUpdate

)

Definition at line 338 of file qdeclarativegeoroutemodel.cpp.

setMeasurementSystem()

void QDeclarativeGeoRouteModel::setMeasurementSystem

(

QLocale::MeasurementSystem

ms

)

\qmlproperty Locale::MeasurementSystem QtLocation::RouteModel::measurementSystem

This property holds the measurement system which will be used when calculating the route. This property is changed when the \l {QtLocation::Plugin::locales}{Plugin::locales} property of \l {QtLocation::RouteModel::plugin}{plugin} changes.

If setting this property it must be set after the \l {QtLocation::RouteModel::plugin}{plugin} property is set.

Definition at line 376 of file qdeclarativegeoroutemodel.cpp.

setPlugin()

void QDeclarativeGeoRouteModel::setPlugin

(

QDeclarativeGeoServiceProvider *

plugin

)

Definition at line 206 of file qdeclarativegeoroutemodel.cpp.

setQuery()

void QDeclarativeGeoRouteModel::setQuery

(

QDeclarativeGeoRouteQuery *

query

)

Definition at line 306 of file qdeclarativegeoroutemodel.cpp.

status()

QDeclarativeGeoRouteModel::Status QDeclarativeGeoRouteModel::status

(

)

const

\qmlproperty enumeration QtLocation::RouteModel::status

This read-only property holds the current status of the model.

\list

• RouteModel.Null - No route requests have been issued or \l reset has been called.
• RouteModel.Ready - Route request(s) have finished successfully.
• RouteModel.Loading - Route request has been issued but not yet finished
• RouteModel.Error - Routing error has occurred, details are in \l error and \l errorString \endlist

Definition at line 447 of file qdeclarativegeoroutemodel.cpp.

statusChanged

void QDeclarativeGeoRouteModel::statusChanged ( )

signal

update

void QDeclarativeGeoRouteModel::update ( )

slot

\qmlmethod void QtLocation::RouteModel::update()

Instructs the RouteModel to update its data. This is most useful when \l autoUpdate is disabled, to force a refresh when the query has been changed.

Definition at line 507 of file qdeclarativegeoroutemodel.cpp.

Property Documentation

autoUpdate

bool QDeclarativeGeoRouteModel::autoUpdate

readwrite

Definition at line 50 of file qdeclarativegeoroutemodel_p.h.

count

int QDeclarativeGeoRouteModel::count

read

Definition at line 49 of file qdeclarativegeoroutemodel_p.h.

error

RouteError QDeclarativeGeoRouteModel::error

read

Definition at line 53 of file qdeclarativegeoroutemodel_p.h.

errorString

QString QDeclarativeGeoRouteModel::errorString

read

Definition at line 52 of file qdeclarativegeoroutemodel_p.h.

measurementSystem

QLocale::MeasurementSystem QDeclarativeGeoRouteModel::measurementSystem

readwrite

Definition at line 54 of file qdeclarativegeoroutemodel_p.h.

plugin

QDeclarativeGeoServiceProvider * QDeclarativeGeoRouteModel::plugin

readwrite

Definition at line 47 of file qdeclarativegeoroutemodel_p.h.

query

QDeclarativeGeoRouteQuery * QDeclarativeGeoRouteModel::query

readwrite

Definition at line 48 of file qdeclarativegeoroutemodel_p.h.

status

Status QDeclarativeGeoRouteModel::status

read

Definition at line 51 of file qdeclarativegeoroutemodel_p.h.

---

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

• qtlocation/src/location/declarativemaps/qdeclarativegeoroutemodel_p.h (60828037eb143eaefab1780f1f831a3f0e6dcaf2)
• qtlocation/src/location/declarativemaps/qdeclarativegeoroutemodel.cpp (28cf195bb48e935517dbe46cf7f71a4af9179e37)