QgsLocatorModelBridge Class Reference

The QgsLocatorModelBridge class provides the core functionality to be used in a locator widget. More...

#include <qgslocatormodelbridge.h>

Inheritance diagram for QgsLocatorModelBridge:

Public Slots
void	invalidateResults ()
	This will invalidate current search results. More...
void	updateCanvasCrs (const QgsCoordinateReferenceSystem &crs)
	Update the canvas CRS used to create search context. More...
void	updateCanvasExtent (const QgsRectangle &extent)
	Update the canvas extent used to create search context. More...

Signals
void	isRunningChanged ()
	Emitted when the running status changes. More...
void	resultAdded ()
	Emitted when a result is added. More...
void	resultsCleared ()
	Emitted when the results are cleared. More...

Public Member Functions
	QgsLocatorModelBridge (QObject *parent=nullptr)
	Constructor of QgsLocatorModelBridge. More...
virtual	~QgsLocatorModelBridge ()=default
bool	hasQueueRequested () const
	Returns true if some text to be search is pending in the queue. More...
bool	isRunning () const
	Returns true if the a search is currently running. More...
QgsLocator *	locator () const
	Returns the locator. More...
Q_INVOKABLE void	performSearch (const QString &text)
	Perform a search. More...
Q_INVOKABLE QgsLocatorProxyModel *	proxyModel () const
	Returns the proxy model. More...
void	triggerResult (const QModelIndex &index, const int actionId=-1)
	Triggers the result at given index and with optional actionId if an additional action was triggered. More...

Properties
bool	isRunning

Detailed Description

The QgsLocatorModelBridge class provides the core functionality to be used in a locator widget.

Since

QGIS 3.6

Definition at line 42 of file qgslocatormodelbridge.h.

Constructor & Destructor Documentation

QgsLocatorModelBridge()

QgsLocatorModelBridge::QgsLocatorModelBridge ( QObject *  parent = nullptr )

explicit

Constructor of QgsLocatorModelBridge.

Definition at line 23 of file qgslocatormodelbridge.cpp.

~QgsLocatorModelBridge()

virtual QgsLocatorModelBridge::~QgsLocatorModelBridge ( )

virtualdefault

Member Function Documentation

hasQueueRequested()

bool QgsLocatorModelBridge::hasQueueRequested

(

)

const

Returns true if some text to be search is pending in the queue.

Definition at line 134 of file qgslocatormodelbridge.cpp.

invalidateResults

void QgsLocatorModelBridge::invalidateResults ( )

slot

This will invalidate current search results.

Definition at line 62 of file qgslocatormodelbridge.cpp.

isRunning()

bool QgsLocatorModelBridge::isRunning

(

)

const

Returns true if the a search is currently running.

Definition at line 35 of file qgslocatormodelbridge.cpp.

isRunningChanged

void QgsLocatorModelBridge::isRunningChanged ( )

signal

Emitted when the running status changes.

locator()

QgsLocator * QgsLocatorModelBridge::locator

(

)

const

Returns the locator.

Definition at line 124 of file qgslocatormodelbridge.cpp.

performSearch()

void QgsLocatorModelBridge::performSearch

(

const QString &

text

)

Perform a search.

Definition at line 102 of file qgslocatormodelbridge.cpp.

proxyModel()

QgsLocatorProxyModel * QgsLocatorModelBridge::proxyModel

(

)

const

Returns the proxy model.

Definition at line 129 of file qgslocatormodelbridge.cpp.

resultAdded

void QgsLocatorModelBridge::resultAdded ( )

signal

Emitted when a result is added.

resultsCleared

void QgsLocatorModelBridge::resultsCleared ( )

signal

Emitted when the results are cleared.

triggerResult()

void QgsLocatorModelBridge::triggerResult	(	const QModelIndex &	index,
		const int	actionId = -1
	)

Triggers the result at given index and with optional actionId if an additional action was triggered.

Definition at line 40 of file qgslocatormodelbridge.cpp.

updateCanvasCrs

void QgsLocatorModelBridge::updateCanvasCrs ( const QgsCoordinateReferenceSystem &  crs )

slot

Update the canvas CRS used to create search context.

Definition at line 73 of file qgslocatormodelbridge.cpp.

updateCanvasExtent

void QgsLocatorModelBridge::updateCanvasExtent ( const QgsRectangle &  extent )

slot

Update the canvas extent used to create search context.

Definition at line 68 of file qgslocatormodelbridge.cpp.

Property Documentation

isRunning

bool QgsLocatorModelBridge::isRunning

read

Definition at line 1 of file qgslocatormodelbridge.h.

---

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

• /build/qgis-3.16.0+99unstable/src/core/locator/qgslocatormodelbridge.h
• /build/qgis-3.16.0+99unstable/src/core/locator/qgslocatormodelbridge.cpp