QDeclarativeSearchResultModel Class Reference

#include <qdeclarativesearchresultmodel_p.h>

Inheritance diagram for QDeclarativeSearchResultModel:

Collaboration diagram for QDeclarativeSearchResultModel:

Public Types
enum	SearchResultType { UnknownSearchResult = QPlaceSearchResult::UnknownSearchResult , PlaceResult = QPlaceSearchResult::PlaceResult , ProposedSearchResult = QPlaceSearchResult::ProposedSearchResult }
enum	RelevanceHint { UnspecifiedHint = QPlaceSearchRequest::UnspecifiedHint , DistanceHint = QPlaceSearchRequest::DistanceHint , LexicalPlaceNameHint = QPlaceSearchRequest::LexicalPlaceNameHint }
Public Types inherited from QDeclarativeSearchModelBase
enum	Status { Null , Ready , Loading , Error }
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 }

Signals
void	searchTermChanged ()
void	categoriesChanged ()
void	recommendationIdChanged ()
void	relevanceHintChanged ()
void	visibilityScopeChanged ()
void	rowCountChanged ()
void	favoritesPluginChanged ()
void	favoritesMatchParametersChanged ()
void	dataChanged ()
void	incrementalChanged ()
Signals inherited from QDeclarativeSearchModelBase
void	pluginChanged ()
void	searchAreaChanged ()
void	limitChanged ()
void	previousPagesAvailableChanged ()
void	nextPagesAvailableChanged ()
void	statusChanged ()
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
	QDeclarativeSearchResultModel (QObject *parent=nullptr)
	\qmltype PlaceSearchModel \nativetype QDeclarativeSearchResultModel \inqmlmodule QtLocation
	~QDeclarativeSearchResultModel ()
QString	searchTerm () const
	\qmlproperty string PlaceSearchModel::searchTerm
void	setSearchTerm (const QString &searchTerm)
QQmlListProperty< QDeclarativeCategory >	categories ()
QString	recommendationId () const
	\qmlproperty string PlaceSearchModel::recommendationId
void	setRecommendationId (const QString &recommendationId)
QDeclarativeSearchResultModel::RelevanceHint	relevanceHint () const
	\qmlproperty enumeration PlaceSearchModel::relevanceHint
void	setRelevanceHint (QDeclarativeSearchResultModel::RelevanceHint hint)
QDeclarativePlace::Visibility	visibilityScope () const
	\qmlproperty enum PlaceSearchModel::visibilityScope
void	setVisibilityScope (QDeclarativePlace::Visibility visibilityScope)
QDeclarativeGeoServiceProvider *	favoritesPlugin () const
void	setFavoritesPlugin (QDeclarativeGeoServiceProvider *plugin)
QVariantMap	favoritesMatchParameters () const
void	setFavoritesMatchParameters (const QVariantMap &parameters)
int	rowCount (const QModelIndex &parent=QModelIndex()) const override
void	clearData (bool suppressSignal=false) override
QVariant	data (const QModelIndex &index, int role=Qt::DisplayRole) const override
	Returns the data stored under the given role for the item referred to by the index.
Q_INVOKABLE QVariant	data (int index, const QString &roleName) const
QHash< int, QByteArray >	roleNames () const override
Q_INVOKABLE void	updateWith (int proposedSearchIndex)
	\qmlmethod void PlaceSearchModel::updateWith(int proposedSearchIndex)
void	updateSearchRequest ()
Public Member Functions inherited from QDeclarativeSearchModelBase
	QDeclarativeSearchModelBase (QObject *parent=nullptr)
	~QDeclarativeSearchModelBase ()
QDeclarativeGeoServiceProvider *	plugin () const
void	setPlugin (QDeclarativeGeoServiceProvider *plugin)
QVariant	searchArea () const
void	setSearchArea (const QVariant &searchArea)
int	limit () const
void	setLimit (int limit)
bool	previousPagesAvailable () const
bool	nextPagesAvailable () const
Status	status () const
void	setStatus (Status status, const QString &errorString=QString())
Q_INVOKABLE void	update ()
Q_INVOKABLE void	cancel ()
Q_INVOKABLE void	reset ()
Q_INVOKABLE QString	errorString () const
Q_INVOKABLE void	previousPage ()
Q_INVOKABLE void	nextPage ()
void	classBegin () override
void	componentComplete () override
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 ()

Static Public Member Functions
static void	categories_append (QQmlListProperty< QDeclarativeCategory > *list, QDeclarativeCategory *category)
static qsizetype	categories_count (QQmlListProperty< QDeclarativeCategory > *list)
static QDeclarativeCategory *	category_at (QQmlListProperty< QDeclarativeCategory > *list, qsizetype index)
static void	categories_clear (QQmlListProperty< QDeclarativeCategory > *list)
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 Slots
void	queryFinished () override
void	onContentUpdated () override
Protected Slots inherited from QDeclarativeSearchModelBase
virtual void	queryFinished ()=0
virtual void	onContentUpdated ()
Protected Slots inherited from QAbstractItemModel
virtual void	resetInternalData ()

Protected Member Functions
QPlaceReply *	sendQuery (QPlaceManager *manager, const QPlaceSearchRequest &request) override
void	initializePlugin (QDeclarativeGeoServiceProvider *plugin) override
Protected Member Functions inherited from QDeclarativeSearchModelBase
void	setPreviousPageRequest (const QPlaceSearchRequest &previous)
void	setNextPageRequest (const QPlaceSearchRequest &next)
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)

Properties
QString	searchTerm
QQmlListProperty< QDeclarativeCategory >	categories
	\qmlproperty list<Category> PlaceSearchModel::categories
QString	recommendationId
RelevanceHint	relevanceHint
QDeclarativePlace::Visibility	visibilityScope
int	count
QDeclarativeGeoServiceProvider *	favoritesPlugin
QVariantMap	favoritesMatchParameters
bool	incremental
Properties inherited from QDeclarativeSearchModelBase
QDeclarativeGeoServiceProvider *	plugin
QVariant	searchArea
int	limit
bool	previousPagesAvailable
bool	nextPagesAvailable
Status	status
Properties inherited from QObject
QString	objectName
	the name of this object

Additional Inherited Members
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
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 Attributes inherited from QDeclarativeSearchModelBase
QPlaceSearchRequest	m_request
QDeclarativeGeoServiceProvider *	m_plugin = nullptr
QPlaceReply *	m_reply = 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 28 of file qdeclarativesearchresultmodel_p.h.

Member Enumeration Documentation

RelevanceHint

enum QDeclarativeSearchResultModel::RelevanceHint

Enumerator
UnspecifiedHint
DistanceHint
LexicalPlaceNameHint

Definition at line 55 of file qdeclarativesearchresultmodel_p.h.

SearchResultType

enum QDeclarativeSearchResultModel::SearchResultType

Enumerator
UnknownSearchResult
PlaceResult
ProposedSearchResult

Definition at line 49 of file qdeclarativesearchresultmodel_p.h.

Constructor & Destructor Documentation

QDeclarativeSearchResultModel()

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

explicit

\qmltype PlaceSearchModel \nativetype QDeclarativeSearchResultModel \inqmlmodule QtLocation

Since

QtLocation 5.5

Provides access to place search results.

PlaceSearchModel provides a model of place search results within the \l searchArea. The \l searchTerm and \l categories properties can be set to restrict the search results to places matching those criteria.

The PlaceSearchModel returns both sponsored and \l {http://en.wikipedia.org/wiki/Organic_search}{organic search results}. Sponsored search results will have the sponsored role set to true.

\target PlaceSearchModel Roles The model returns data for the following roles:

\table \header

• Role
• Type
• Description \row
• type
• enum
• The type of search result. \row
• title
• string
• A string describing the search result. \row
• icon
• PlaceIcon
• Icon representing the search result. \row
• distance
• real
• Valid only when the type role is PlaceResult, the distance to the place from the center of the \l searchArea. If no \l searchArea has been specified, the distance is NaN. \row
• place
• \l Place
• Valid only when the type role is PlaceResult, an object representing the place. \row
• sponsored
• bool
• Valid only when the type role is PlaceResult, true if the search result is a sponsored result. \endtable

Definition at line 321 of file qdeclarativesearchresultmodel.cpp.

~QDeclarativeSearchResultModel()

QDeclarativeSearchResultModel::~QDeclarativeSearchResultModel

(

)

Definition at line 326 of file qdeclarativesearchresultmodel.cpp.

Member Function Documentation

categories()

QQmlListProperty< QDeclarativeCategory > QDeclarativeSearchResultModel::categories

(

)

categories_append()

void QDeclarativeSearchResultModel::categories_append ( QQmlListProperty< QDeclarativeCategory > * list, QDeclarativeCategory * category )

static

Definition at line 367 of file qdeclarativesearchresultmodel.cpp.

categories_clear()

void QDeclarativeSearchResultModel::categories_clear ( QQmlListProperty< QDeclarativeCategory > * list )

static

Definition at line 399 of file qdeclarativesearchresultmodel.cpp.

categories_count()

qsizetype QDeclarativeSearchResultModel::categories_count ( QQmlListProperty< QDeclarativeCategory > * list )

static

Definition at line 381 of file qdeclarativesearchresultmodel.cpp.

categoriesChanged

void QDeclarativeSearchResultModel::categoriesChanged ( )

signal

category_at()

QDeclarativeCategory * QDeclarativeSearchResultModel::category_at ( QQmlListProperty< QDeclarativeCategory > * list, qsizetype index )

static

Definition at line 390 of file qdeclarativesearchresultmodel.cpp.

clearData()

void QDeclarativeSearchResultModel::clearData ( bool suppressSignal = false )

overridevirtual

Reimplemented from QDeclarativeSearchModelBase.

Definition at line 572 of file qdeclarativesearchresultmodel.cpp.

data() [1/2]

QVariant QDeclarativeSearchResultModel::data ( const QModelIndex & index, int role = Qt::DisplayRole ) const

overridevirtual

Returns the data stored under the given role for the item referred to by the index.

Note

If you do not have a value to return, return an invalid (default-constructed) QVariant.

See also

Qt::ItemDataRole, setData(), headerData()

Implements QAbstractItemModel.

Definition at line 587 of file qdeclarativesearchresultmodel.cpp.

data() [2/2]

QVariant QDeclarativeSearchResultModel::data	(	int	index,
		const QString &	role ) const

Definition at line 625 of file qdeclarativesearchresultmodel.cpp.

dataChanged

void QDeclarativeSearchResultModel::dataChanged ( )

signal

favoritesMatchParameters()

QVariantMap QDeclarativeSearchResultModel::favoritesMatchParameters

(

)

const

Definition at line 545 of file qdeclarativesearchresultmodel.cpp.

favoritesMatchParametersChanged

void QDeclarativeSearchResultModel::favoritesMatchParametersChanged ( )

signal

favoritesPlugin()

QDeclarativeGeoServiceProvider * QDeclarativeSearchResultModel::favoritesPlugin

(

)

const

Definition at line 510 of file qdeclarativesearchresultmodel.cpp.

favoritesPluginChanged

void QDeclarativeSearchResultModel::favoritesPluginChanged ( )

signal

incrementalChanged

void QDeclarativeSearchResultModel::incrementalChanged ( )

signal

initializePlugin()

void QDeclarativeSearchResultModel::initializePlugin ( QDeclarativeGeoServiceProvider * plugin )

overrideprotectedvirtual

Reimplemented from QDeclarativeSearchModelBase.

Definition at line 674 of file qdeclarativesearchresultmodel.cpp.

onContentUpdated

void QDeclarativeSearchResultModel::onContentUpdated ( )

overrideprotectedslot

Definition at line 798 of file qdeclarativesearchresultmodel.cpp.

queryFinished

void QDeclarativeSearchResultModel::queryFinished ( )

overrideprotectedslot

Definition at line 713 of file qdeclarativesearchresultmodel.cpp.

recommendationId()

QString QDeclarativeSearchResultModel::recommendationId

(

)

const

\qmlproperty string PlaceSearchModel::recommendationId

This property holds the placeId to be used in order to find recommendations for similar places.

Definition at line 418 of file qdeclarativesearchresultmodel.cpp.

recommendationIdChanged

void QDeclarativeSearchResultModel::recommendationIdChanged ( )

signal

relevanceHint()

QDeclarativeSearchResultModel::RelevanceHint QDeclarativeSearchResultModel::relevanceHint

(

)

const

\qmlproperty enumeration PlaceSearchModel::relevanceHint

This property holds a relevance hint used in the search query. The hint is given to the provider to help but not dictate the ranking of results. For example, the distance hint may give closer places a higher ranking but it does not necessarily mean the results will be strictly ordered according to distance. A provider may ignore the hint altogether.

\table \row

• SearchResultModel.UnspecifiedHint
• No relevance hint is given to the provider. \row
• SearchResultModel.DistanceHint
• The distance of the place from the user's current location is important to the user. This hint is only meaningful when a circular search area is used. \row
• SearchResultModel.LexicalPlaceNameHint
• The lexical ordering of place names (in ascending alphabetical order) is relevant to the user. This hint is useful for providers based on a local data store. \endtable

Definition at line 454 of file qdeclarativesearchresultmodel.cpp.

relevanceHintChanged

void QDeclarativeSearchResultModel::relevanceHintChanged ( )

signal

roleNames()

QHash< int, QByteArray > QDeclarativeSearchResultModel::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 631 of file qdeclarativesearchresultmodel.cpp.

rowCount()

int QDeclarativeSearchResultModel::rowCount ( const QModelIndex & parent = QModelIndex() ) const

overridevirtual

Implements QAbstractItemModel.

Definition at line 565 of file qdeclarativesearchresultmodel.cpp.

rowCountChanged

void QDeclarativeSearchResultModel::rowCountChanged ( )

signal

searchTerm()

QString QDeclarativeSearchResultModel::searchTerm

(

)

const

\qmlproperty string PlaceSearchModel::searchTerm

This property holds search term used in query. The search term is a free-form text string.

Definition at line 335 of file qdeclarativesearchresultmodel.cpp.

searchTermChanged

void QDeclarativeSearchResultModel::searchTermChanged ( )

signal

sendQuery()

QPlaceReply * QDeclarativeSearchResultModel::sendQuery ( QPlaceManager * manager, const QPlaceSearchRequest & request )

overrideprotectedvirtual

Implements QDeclarativeSearchModelBase.

Definition at line 664 of file qdeclarativesearchresultmodel.cpp.

setFavoritesMatchParameters()

void QDeclarativeSearchResultModel::setFavoritesMatchParameters

(

const QVariantMap &

parameters

)

Definition at line 553 of file qdeclarativesearchresultmodel.cpp.

setFavoritesPlugin()

void QDeclarativeSearchResultModel::setFavoritesPlugin

(

QDeclarativeGeoServiceProvider *

plugin

)

Definition at line 518 of file qdeclarativesearchresultmodel.cpp.

setRecommendationId()

void QDeclarativeSearchResultModel::setRecommendationId

(

const QString &

recommendationId

)

Definition at line 423 of file qdeclarativesearchresultmodel.cpp.

setRelevanceHint()

void QDeclarativeSearchResultModel::setRelevanceHint

(

QDeclarativeSearchResultModel::RelevanceHint

hint

)

Definition at line 459 of file qdeclarativesearchresultmodel.cpp.

setSearchTerm()

void QDeclarativeSearchResultModel::setSearchTerm

(

const QString &

searchTerm

)

Definition at line 340 of file qdeclarativesearchresultmodel.cpp.

setVisibilityScope()

void QDeclarativeSearchResultModel::setVisibilityScope

(

QDeclarativePlace::Visibility

visibilityScope

)

Definition at line 496 of file qdeclarativesearchresultmodel.cpp.

updateSearchRequest()

void QDeclarativeSearchResultModel::updateSearchRequest

(

)

updateWith()

void QDeclarativeSearchResultModel::updateWith

(

int

proposedSearchIndex

)

\qmlmethod void PlaceSearchModel::updateWith(int proposedSearchIndex)

Updates the model based on the ProposedSearchResult at index proposedSearchIndex. The model will be populated with a list of places matching the proposed search. Model status will be set to PlaceSearchModel.Loading. If the model is updated successfully status will be set to PlaceSearchModel.Ready. If an error occurs status will be set to PlaceSearchModel.Error and the model cleared.

If proposedSearchIndex does not reference a ProposedSearchResult this method does nothing.

Definition at line 655 of file qdeclarativesearchresultmodel.cpp.

visibilityScope()

QDeclarativePlace::Visibility QDeclarativeSearchResultModel::visibilityScope

(

)

const

\qmlproperty enum PlaceSearchModel::visibilityScope

This property holds the visibility scope of the places to search. Only places with the specified visibility will be returned in the search results.

The visibility scope can be one of:

\table \row

• Place.UnspecifiedVisibility
• No explicit visibility scope specified, places with any visibility may be part of search results. \row
• Place.DeviceVisibility
• Only places stored on the local device will be part of the search results. \row
• Place.PrivateVisibility
• Only places that are private to the current user will be part of the search results. \row
• Place.PublicVisibility
• Only places that are public will be part of the search results. \endtable

Definition at line 491 of file qdeclarativesearchresultmodel.cpp.

visibilityScopeChanged

void QDeclarativeSearchResultModel::visibilityScopeChanged ( )

signal

Property Documentation

categories

QQmlListProperty< QDeclarativeCategory > QDeclarativeSearchResultModel::categories

read

\qmlproperty list<Category> PlaceSearchModel::categories

This property holds a list of categories to be used when searching. Returned search results will be for places that match at least one of the categories.

Definition at line 35 of file qdeclarativesearchresultmodel_p.h.

count

int QDeclarativeSearchResultModel::count

read

Definition at line 40 of file qdeclarativesearchresultmodel_p.h.

favoritesMatchParameters

QVariantMap QDeclarativeSearchResultModel::favoritesMatchParameters

readwrite

Definition at line 42 of file qdeclarativesearchresultmodel_p.h.

favoritesPlugin

QDeclarativeGeoServiceProvider * QDeclarativeSearchResultModel::favoritesPlugin

readwrite

Definition at line 41 of file qdeclarativesearchresultmodel_p.h.

incremental

bool QDeclarativeSearchResultModel::incremental

Definition at line 44 of file qdeclarativesearchresultmodel_p.h.

recommendationId

QString QDeclarativeSearchResultModel::recommendationId

readwrite

Definition at line 36 of file qdeclarativesearchresultmodel_p.h.

relevanceHint

RelevanceHint QDeclarativeSearchResultModel::relevanceHint

readwrite

Definition at line 37 of file qdeclarativesearchresultmodel_p.h.

searchTerm

QString QDeclarativeSearchResultModel::searchTerm

readwrite

Definition at line 34 of file qdeclarativesearchresultmodel_p.h.

visibilityScope

QDeclarativePlace::Visibility QDeclarativeSearchResultModel::visibilityScope

readwrite

Definition at line 38 of file qdeclarativesearchresultmodel_p.h.

---

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

• qtlocation/src/location/declarativeplaces/qdeclarativesearchresultmodel_p.h (60828037eb143eaefab1780f1f831a3f0e6dcaf2)
• qtlocation/src/location/declarativeplaces/qdeclarativesearchresultmodel.cpp (28cf195bb48e935517dbe46cf7f71a4af9179e37)