#include <qdeclarativegeocodemodel_p.h>

Inheritance diagram for QDeclarativeGeocodeModel:

Collaboration diagram for QDeclarativeGeocodeModel:

Public Types
enum	Status { Null , Ready , Loading , Error }

enum	GeocodeError { NoError = QGeoCodeReply::NoError , EngineNotSetError = QGeoCodeReply::EngineNotSetError , CommunicationError = QGeoCodeReply::CommunicationError , ParseError = QGeoCodeReply::ParseError , UnsupportedOptionError = QGeoCodeReply::UnsupportedOptionError , CombinationError = QGeoCodeReply::CombinationError , UnknownError = QGeoCodeReply::UnknownError , UnknownParameterError = 100 , MissingRequiredParameterError }

enum	Roles { LocationRole = Qt::UserRole + 1 }

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::GeocodeModel::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	statusChanged ()

void	errorChanged ()

void	locationsChanged ()

void	autoUpdateChanged ()

void	boundsChanged ()

void	queryChanged ()

void	limitChanged ()

void	offsetChanged ()

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
	QDeclarativeGeocodeModel (QObject *parent=nullptr)
	\qmltype GeocodeModel \nativetype QDeclarativeGeocodeModel \inqmlmodule QtLocation

virtual	~QDeclarativeGeocodeModel ()

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::GeocodeModel::plugin

void	setBounds (const QVariant &boundingArea)

QVariant	bounds () const
	\qmlproperty geoshape QtLocation::GeocodeModel::bounds

Status	status () const
	\qmlproperty enumeration QtLocation::GeocodeModel::status

QString	errorString () const
	\qmlproperty string QtLocation::GeocodeModel::errorString

GeocodeError	error () const
	\qmlproperty enumeration QtLocation::GeocodeModel::error

bool	autoUpdate () const
	\qmlproperty bool QtLocation::GeocodeModel::autoUpdate

void	setAutoUpdate (bool update)

int	count () const
	\qmlproperty int QtLocation::GeocodeModel::count

Q_INVOKABLE QDeclarativeGeoLocation *	get (int index)
	\qmlmethod Location QtLocation::GeocodeModel::get(int index)

int	limit () const
	\qmlproperty int QtLocation::GeocodeModel::limit

void	setLimit (int limit)

int	offset () const
	\qmlproperty int QtLocation::GeocodeModel::offset

void	setOffset (int offset)

QVariant	query () const
	\qmlproperty QVariant QtLocation::GeocodeModel::query

void	setQuery (const QVariant &query)

Q_INVOKABLE void	reset ()
	\qmlmethod void QtLocation::GeocodeModel::reset()

Q_INVOKABLE void	cancel ()
	\qmlmethod void QtLocation::GeocodeModel::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 ()

Protected Slots
void	queryContentChanged ()

void	geocodeFinished (QGeoCodeReply *reply)

void	geocodeError (QGeoCodeReply *reply, QGeoCodeReply::Error error, const QString &errorString)

void	pluginReady ()

Protected Slots inherited from QAbstractItemModel
virtual void	resetInternalData ()

Protected Member Functions
QGeoCodingManager *	searchManager ()

void	setStatus (Status status)

void	setError (GeocodeError error, const QString &errorString)

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
bool	autoUpdate_ = false

bool	complete_ = false

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Properties
QDeclarativeGeoServiceProvider *	plugin

bool	autoUpdate

Status	status

QString	errorString

int	count

int	limit

int	offset

QVariant	query

QVariant	bounds

GeocodeError	error

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)

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 37 of file qdeclarativegeocodemodel_p.h.

Member Enumeration Documentation

◆ GeocodeError

enum QDeclarativeGeocodeModel::GeocodeError

Enumerator
NoError
EngineNotSetError
CommunicationError
ParseError
UnsupportedOptionError
CombinationError
UnknownError
UnknownParameterError
MissingRequiredParameterError

Definition at line 64 of file qdeclarativegeocodemodel_p.h.

◆ Roles

enum QDeclarativeGeocodeModel::Roles

Enumerator
LocationRole

Definition at line 79 of file qdeclarativegeocodemodel_p.h.

◆ Status

enum QDeclarativeGeocodeModel::Status

Enumerator
Null
Ready
Loading
Error

Definition at line 57 of file qdeclarativegeocodemodel_p.h.

Constructor & Destructor Documentation

◆ QDeclarativeGeocodeModel()

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

explicit

\qmltype GeocodeModel \nativetype QDeclarativeGeocodeModel \inqmlmodule QtLocation

Since: QtLocation 5.5

The GeocodeModel type provides support for searching operations related to geographic information.

The GeocodeModel type is used as part of a model/view grouping to match addresses or search strings with geographic locations. How the geographic locations generated are used or displayed is decided by any Views attached to the GeocodeModel (for example a \l MapItemView or \l{ListView}).

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

Once the plugin is set, the \l{query} property can be used to specify the address or search string to match. If \l{autoUpdate} is enabled, the Model will update its output automatically. Otherwise, the \l{update} method may be used. By default, autoUpdate is disabled.

The data stored and returned in the GeocodeModel consists of \l [QML] {Location} objects, as a list with the role name "locationData". See the documentation for \l [QML] {Location} for further details on its structure and contents.

Definition at line 84 of file qdeclarativegeocodemodel.cpp.

◆ ~QDeclarativeGeocodeModel()

QDeclarativeGeocodeModel::~QDeclarativeGeocodeModel ( )

virtual

Definition at line 89 of file qdeclarativegeocodemodel.cpp.

Member Function Documentation

◆ autoUpdate()

bool QDeclarativeGeocodeModel::autoUpdate ( ) const

\qmlproperty bool QtLocation::GeocodeModel::autoUpdate

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

If setting this value to 'true' and using an Address or \l {coordinate} as the query, note that any change at all in the object's properties will trigger a new request to be sent. If you are adjusting many properties of the object whilst autoUpdate is enabled, this can generate large numbers of useless (and later discarded) requests.

Definition at line 691 of file qdeclarativegeocodemodel.cpp.

◆ autoUpdateChanged

void QDeclarativeGeocodeModel::autoUpdateChanged ( )

signal

◆ bounds()

QVariant QDeclarativeGeocodeModel::bounds ( ) const

\qmlproperty geoshape QtLocation::GeocodeModel::bounds

This property holds the bounding area used to limit the results to those within the area. This is particularly useful if query is only partially filled out, as the service will attempt to (reverse) geocode all matches for the specified data.

Accepted types are \l {georectangle} and \l {geocircle}.

Definition at line 338 of file qdeclarativegeocodemodel.cpp.

◆ boundsChanged

void QDeclarativeGeocodeModel::boundsChanged ( )

signal

◆ cancel()

void QDeclarativeGeocodeModel::cancel ( )

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

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

Definition at line 590 of file qdeclarativegeocodemodel.cpp.

◆ classBegin()

void QDeclarativeGeocodeModel::classBegin ( )

inlineoverridevirtual

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

Implements QQmlParserStatus.

Definition at line 87 of file qdeclarativegeocodemodel_p.h.

◆ componentComplete()

void QDeclarativeGeocodeModel::componentComplete ( )

overridevirtual

From QQmlParserStatus

Implements QQmlParserStatus.

Definition at line 100 of file qdeclarativegeocodemodel.cpp.

◆ count()

int QDeclarativeGeocodeModel::count ( ) const

\qmlproperty int QtLocation::GeocodeModel::count

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

Definition at line 485 of file qdeclarativegeocodemodel.cpp.

◆ countChanged

void QDeclarativeGeocodeModel::countChanged ( )

signal

◆ data()

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

overridevirtual

Implements QAbstractItemModel.

Definition at line 208 of file qdeclarativegeocodemodel.cpp.

◆ error()

QDeclarativeGeocodeModel::GeocodeError QDeclarativeGeocodeModel::error ( ) const

\qmlproperty enumeration QtLocation::GeocodeModel::error

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

\list

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

Definition at line 435 of file qdeclarativegeocodemodel.cpp.

◆ errorChanged

void QDeclarativeGeocodeModel::errorChanged ( )

signal

◆ errorString()

QString QDeclarativeGeocodeModel::errorString ( ) const

\qmlproperty string QtLocation::GeocodeModel::errorString

This read-only property holds the textual presentation of the latest geocoding 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 459 of file qdeclarativegeocodemodel.cpp.

◆ geocodeError

void QDeclarativeGeocodeModel::geocodeError	(	QGeoCodeReply *	reply,
		QGeoCodeReply::Error	error,
		const QString &	errorString )

protectedslot

Definition at line 369 of file qdeclarativegeocodemodel.cpp.

◆ geocodeFinished

void QDeclarativeGeocodeModel::geocodeFinished ( QGeoCodeReply * reply )

protectedslot

Definition at line 350 of file qdeclarativegeocodemodel.cpp.

◆ get()

QDeclarativeGeoLocation * QDeclarativeGeocodeModel::get ( int index )

\qmlmethod Location QtLocation::GeocodeModel::get(int index)

Returns the \l [QML] {Location} at given index. Use \l count property to check the amount of locations available. The locations are indexed from zero, so the accessible range is 0...(count - 1).

If you access out of bounds, a zero (null object) is returned and a warning is issued.

Definition at line 500 of file qdeclarativegeocodemodel.cpp.

◆ limit()

int QDeclarativeGeocodeModel::limit ( ) const

\qmlproperty int QtLocation::GeocodeModel::limit

This property holds the maximum number of results. The limit and \l offset values are only applicable with free string geocoding (that is they are not considered when using addresses or coordinates in the search query).

If limit is -1 the entire result set will be returned, otherwise at most limit results will be returned. The limit and \l offset results can be used together to implement paging.

Definition at line 520 of file qdeclarativegeocodemodel.cpp.

◆ limitChanged

void QDeclarativeGeocodeModel::limitChanged ( )

signal

◆ locationsChanged

void QDeclarativeGeocodeModel::locationsChanged ( )

signal

◆ offset()

int QDeclarativeGeocodeModel::offset ( ) const

\qmlproperty int QtLocation::GeocodeModel::offset

This property tells not to return the first 'offset' number of the results. The \l limit and offset values are only applicable with free string geocoding (that is they are not considered when using addresses or coordinates in the search query).

The \l limit and offset results can be used together to implement paging.

Definition at line 546 of file qdeclarativegeocodemodel.cpp.

Referenced by testing.tools.fixup_pdf_template.TemplateProcessor::insert_xref_entry(), and testing.tools.fixup_pdf_template.TemplateProcessor::process_line().

Here is the caller graph for this function:

◆ offsetChanged

void QDeclarativeGeocodeModel::offsetChanged ( )

signal

◆ plugin()

QDeclarativeGeoServiceProvider * QDeclarativeGeocodeModel::plugin ( ) const

\qmlproperty Plugin QtLocation::GeocodeModel::plugin

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

See also: Plugin

Definition at line 304 of file qdeclarativegeocodemodel.cpp.

◆ pluginChanged

void QDeclarativeGeocodeModel::pluginChanged ( )

signal

◆ pluginReady

void QDeclarativeGeocodeModel::pluginReady ( )

protectedslot

Definition at line 256 of file qdeclarativegeocodemodel.cpp.

◆ query()

QVariant QDeclarativeGeocodeModel::query ( ) const

\qmlproperty QVariant QtLocation::GeocodeModel::query

This property holds the data of the geocoding request. The property accepts three types of queries which determine both the data and the type of action to be performed:

\list

Address - Geocoding (address to coordinate)
\l {coordinate} - Reverse geocoding (coordinate to address)
string - Geocoding (address to coordinate) \endlist

Definition at line 611 of file qdeclarativegeocodemodel.cpp.

◆ queryChanged

void QDeclarativeGeocodeModel::queryChanged ( )

signal

◆ queryContentChanged

void QDeclarativeGeocodeModel::queryContentChanged ( )

protectedslot

Definition at line 189 of file qdeclarativegeocodemodel.cpp.

◆ reset()

void QDeclarativeGeocodeModel::reset ( )

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

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

Definition at line 570 of file qdeclarativegeocodemodel.cpp.

◆ roleNames()

QHash< int, QByteArray > QDeclarativeGeocodeModel::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 222 of file qdeclarativegeocodemodel.cpp.

◆ rowCount()

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

overridevirtual

From QAbstractListModel

Implements QAbstractItemModel.

Definition at line 199 of file qdeclarativegeocodemodel.cpp.

◆ searchManager()

QGeoCodingManager * QDeclarativeGeocodeModel::searchManager ( )

protected

◆ setAutoUpdate()

void QDeclarativeGeocodeModel::setAutoUpdate ( bool update )

Definition at line 696 of file qdeclarativegeocodemodel.cpp.

◆ setBounds()

void QDeclarativeGeocodeModel::setBounds ( const QVariant & boundingArea )

Definition at line 309 of file qdeclarativegeocodemodel.cpp.

◆ setError()

void QDeclarativeGeocodeModel::setError	(	GeocodeError	error,
		const QString &	errorString )

protected

Definition at line 440 of file qdeclarativegeocodemodel.cpp.

◆ setLimit()

void QDeclarativeGeocodeModel::setLimit ( int limit )

Definition at line 525 of file qdeclarativegeocodemodel.cpp.

◆ setOffset()

void QDeclarativeGeocodeModel::setOffset ( int offset )

Definition at line 551 of file qdeclarativegeocodemodel.cpp.

◆ setPlugin()

void QDeclarativeGeocodeModel::setPlugin ( QDeclarativeGeoServiceProvider * plugin )

Definition at line 232 of file qdeclarativegeocodemodel.cpp.

◆ setQuery()

void QDeclarativeGeocodeModel::setQuery ( const QVariant & query )

Definition at line 616 of file qdeclarativegeocodemodel.cpp.

◆ setStatus()

void QDeclarativeGeocodeModel::setStatus ( QDeclarativeGeocodeModel::Status status )

protected

Definition at line 407 of file qdeclarativegeocodemodel.cpp.

◆ status()

QDeclarativeGeocodeModel::Status QDeclarativeGeocodeModel::status ( ) const

\qmlproperty enumeration QtLocation::GeocodeModel::status

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

\list

GeocodeModel.Null - No geocode requests have been issued or \l reset has been called.
GeocodeModel.Ready - Geocode request(s) have finished successfully.
GeocodeModel.Loading - Geocode request has been issued but not yet finished
GeocodeModel.Error - Geocoding error has occurred, details are in \l error and \l errorString \endlist

Definition at line 402 of file qdeclarativegeocodemodel.cpp.

◆ statusChanged

void QDeclarativeGeocodeModel::statusChanged ( )

signal

◆ update

void QDeclarativeGeocodeModel::update ( )

slot

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

Instructs the GeocodeModel 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 114 of file qdeclarativegeocodemodel.cpp.

Member Data Documentation

◆ autoUpdate_

bool QDeclarativeGeocodeModel::autoUpdate_ = false

protected

Definition at line 148 of file qdeclarativegeocodemodel_p.h.

◆ complete_

bool QDeclarativeGeocodeModel::complete_ = false

protected

Definition at line 149 of file qdeclarativegeocodemodel_p.h.

Property Documentation

◆ autoUpdate

bool QDeclarativeGeocodeModel::autoUpdate

readwrite

Definition at line 45 of file qdeclarativegeocodemodel_p.h.

◆ bounds

QVariant QDeclarativeGeocodeModel::bounds

readwrite

Definition at line 52 of file qdeclarativegeocodemodel_p.h.

◆ count

int QDeclarativeGeocodeModel::count

read

Definition at line 48 of file qdeclarativegeocodemodel_p.h.

◆ error

GeocodeError QDeclarativeGeocodeModel::error

read

Definition at line 53 of file qdeclarativegeocodemodel_p.h.

◆ errorString

QString QDeclarativeGeocodeModel::errorString

read

Definition at line 47 of file qdeclarativegeocodemodel_p.h.

◆ limit

int QDeclarativeGeocodeModel::limit

readwrite

Definition at line 49 of file qdeclarativegeocodemodel_p.h.

◆ offset

int QDeclarativeGeocodeModel::offset

readwrite

Definition at line 50 of file qdeclarativegeocodemodel_p.h.

Referenced by testing.tools.fixup_pdf_template.TemplateProcessor::insert_xref_entry(), and testing.tools.fixup_pdf_template.TemplateProcessor::process_line().

◆ plugin

QDeclarativeGeoServiceProvider * QDeclarativeGeocodeModel::plugin

readwrite

Definition at line 44 of file qdeclarativegeocodemodel_p.h.

◆ query

QVariant QDeclarativeGeocodeModel::query

readwrite

Definition at line 51 of file qdeclarativegeocodemodel_p.h.

◆ status

Status QDeclarativeGeocodeModel::status

read

Definition at line 46 of file qdeclarativegeocodemodel_p.h.

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

qtlocation/src/location/declarativemaps/qdeclarativegeocodemodel_p.h (60828037eb143eaefab1780f1f831a3f0e6dcaf2)
qtlocation/src/location/declarativemaps/qdeclarativegeocodemodel.cpp (28cf195bb48e935517dbe46cf7f71a4af9179e37)

Public Types

Public Slots

Signals

Public Member Functions

Protected Slots

Protected Member Functions

Protected Attributes

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ GeocodeError

◆ Roles

◆ Status

Constructor & Destructor Documentation

◆ QDeclarativeGeocodeModel()

◆ ~QDeclarativeGeocodeModel()

Member Function Documentation

◆ autoUpdate()

◆ autoUpdateChanged

◆ bounds()

◆ boundsChanged

◆ cancel()

◆ classBegin()

◆ componentComplete()

◆ count()

◆ countChanged

◆ data()

◆ error()

◆ errorChanged

◆ errorString()

◆ geocodeError

◆ geocodeFinished

◆ get()

◆ limit()

◆ limitChanged

◆ locationsChanged

◆ offset()

◆ offsetChanged

◆ plugin()

◆ pluginChanged

◆ pluginReady

◆ query()

◆ queryChanged

◆ queryContentChanged

◆ reset()

◆ roleNames()

◆ rowCount()

◆ searchManager()

◆ setAutoUpdate()

◆ setBounds()

◆ setError()

◆ setLimit()

◆ setOffset()

◆ setPlugin()

◆ setQuery()

◆ setStatus()

◆ status()

◆ statusChanged

◆ update

Member Data Documentation

◆ autoUpdate_

◆ complete_

Property Documentation

◆ autoUpdate

◆ bounds

◆ count

◆ error

◆ errorString

◆ limit

◆ offset

◆ plugin

◆ query

◆ status