QGIS API Documentation 3.39.0-Master (bca3cdb6021)
|
The QgsLocatorModelBridge class provides the core functionality to be used in a locator widget. More...
#include <qgslocatormodelbridge.h>
Public Slots | |
void | invalidateResults () |
This will invalidate current search results. | |
void | selectionChanged (const QItemSelection &selected, const QItemSelection &deselected) |
This will call filters implementation of selection/deselection of results. | |
void | updateCanvasCrs (const QgsCoordinateReferenceSystem &crs) |
Update the canvas CRS used to create search context. | |
void | updateCanvasExtent (const QgsRectangle &extent) |
Update the canvas extent used to create search context. | |
Signals | |
void | isRunningChanged () |
Emitted when the running status changes. | |
void | resultAdded () |
Emitted when a result is added. | |
void | resultsCleared () |
Emitted when the results are cleared. | |
Public Member Functions | |
QgsLocatorModelBridge (QObject *parent=nullptr) | |
Constructor of QgsLocatorModelBridge. | |
virtual | ~QgsLocatorModelBridge ()=default |
bool | hasQueueRequested () const |
Returns true if some text to be search is pending in the queue. | |
bool | isRunning () const |
Returns true if the a search is currently running. | |
QgsLocator * | locator () const |
Returns the locator. | |
Q_INVOKABLE void | performSearch (const QString &text) |
Perform a search. | |
Q_INVOKABLE QgsLocatorProxyModel * | proxyModel () const |
Returns the proxy model. | |
void | setTransformContext (const QgsCoordinateTransformContext &context) |
Sets the coordinate transform context, which should be used whenever the locator constructs a coordinate transform. | |
QgsCoordinateTransformContext | transformContext () const |
Returns the coordinate transform context, which should be used whenever the locator constructs a coordinate transform. | |
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. | |
Properties | |
bool | isRunning |
The QgsLocatorModelBridge class provides the core functionality to be used in a locator widget.
Definition at line 43 of file qgslocatormodelbridge.h.
|
explicit |
Constructor of QgsLocatorModelBridge.
Definition at line 26 of file qgslocatormodelbridge.cpp.
|
virtualdefault |
bool QgsLocatorModelBridge::hasQueueRequested | ( | ) | const |
Returns true
if some text to be search is pending in the queue.
Definition at line 160 of file qgslocatormodelbridge.cpp.
|
slot |
This will invalidate current search results.
Definition at line 88 of file qgslocatormodelbridge.cpp.
bool QgsLocatorModelBridge::isRunning | ( | ) | const |
Returns true
if the a search is currently running.
Definition at line 38 of file qgslocatormodelbridge.cpp.
|
signal |
Emitted when the running status changes.
QgsLocator * QgsLocatorModelBridge::locator | ( | ) | const |
Returns the locator.
Definition at line 150 of file qgslocatormodelbridge.cpp.
void QgsLocatorModelBridge::performSearch | ( | const QString & | text | ) |
Perform a search.
Definition at line 128 of file qgslocatormodelbridge.cpp.
QgsLocatorProxyModel * QgsLocatorModelBridge::proxyModel | ( | ) | const |
Returns the proxy model.
Definition at line 155 of file qgslocatormodelbridge.cpp.
|
signal |
Emitted when a result is added.
|
signal |
Emitted when the results are cleared.
|
slot |
This will call filters implementation of selection/deselection of results.
Definition at line 56 of file qgslocatormodelbridge.cpp.
|
inline |
Sets the coordinate transform context, which should be used whenever the locator constructs a coordinate transform.
Definition at line 86 of file qgslocatormodelbridge.h.
|
inline |
Returns the coordinate transform context, which should be used whenever the locator constructs a coordinate transform.
Definition at line 77 of file qgslocatormodelbridge.h.
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 43 of file qgslocatormodelbridge.cpp.
|
slot |
Update the canvas CRS used to create search context.
Definition at line 99 of file qgslocatormodelbridge.cpp.
|
slot |
Update the canvas extent used to create search context.
Definition at line 94 of file qgslocatormodelbridge.cpp.
|
read |
Definition at line 46 of file qgslocatormodelbridge.h.