Skip to content

Class LocatorModelSuperBridge

ClassList > LocatorModelSuperBridge

More...

  • #include <locatormodelsuperbridge.h>

Inherits the following classes: QgsLocatorModelBridge

Public Slots

Type Name
slot Q_INVOKABLE void triggerResultAtRow (const int row, const int id=-1)

Public Properties

Type Name
property QgsMapLayer * activeLayer
The current project's active layer.
property BookmarkModel * bookmarks
The bookmark manager containing user and current project bookmarks.
property FeatureListExtentController * featureListController
The feature list extent controller.
property QObject * geometryHighlighter
The locator highlight geometry object through which locator actions can highhlight features.
property bool keepScale
The keep scale flag. When turned on, locator actions should not result in changed scale.
property QgsQuickMapSettings * mapSettings
The current project's map settings.
property Navigation * navigation
The navigation object from which destination can be set or modified.

Public Signals

Type Name
signal void activeLayerChanged
signal void bookmarksChanged
signal void featureListControllerChanged
signal void geometryHighlighterChanged
signal void keepScaleChanged
signal void locatorFiltersChanged
signal void mapSettingsChanged
signal void messageEmitted (const QString & text)
signal void navigationChanged
signal void requestJumpToPoint (const QgsPoint & center, const double & scale=-1.0, bool handleMargins=false)
signal void searchRequested (const QString & text)
signal void searchTextChangeRequested (const QString & text)

Public Functions

Type Name
LocatorModelSuperBridge (QObject * parent=nullptr)
QgsMapLayer * activeLayer () const
The current project's active layer.
BookmarkModel * bookmarks () const
The bookmark manager containing user and current project bookmarks.
Q_INVOKABLE LocatorActionsModel * contextMenuActionsModel (const int row)
Q_INVOKABLE void deregisterQFieldLocatorFilter (QFieldLocatorFilter * filter)
void emitMessage (const QString & text)
FeatureListExtentController * featureListController () const
The feature list extent controller.
QObject * geometryHighlighter () const
The locator highlight geometry object through which locator actions can highhlight features.
Q_INVOKABLE QString getLocatorModelDescription (const int row)
Q_INVOKABLE QString getPrefixFromSearchString (const QString & string)
bool keepScale () const
The keep scale flag. When turned on, locator actions should not result in changed scale.
QgsQuickMapSettings * mapSettings () const
The current project's map settings.
Navigation * navigation () const
The navigation object from which destination can be set or modified.
Q_INVOKABLE void registerQFieldLocatorFilter (QFieldLocatorFilter * filter)
Q_INVOKABLE void requestSearch (const QString & text)
void requestSearchTextChange (const QString & text)
void setActiveLayer (QgsMapLayer * layer)
The current project's active layer.
void setBookmarks (BookmarkModel * bookmarks)
The bookmark manager containing user and current project bookmarks.
void setFeatureListController (FeatureListExtentController * featureListController)
The feature list extent controller.
void setGeometryHighlighter (QObject * geometryHighlighter)
The locator highlight geometry object through which locator actions can highhlight features.
void setKeepScale (bool keepScale)
The keep scale flag. When turned on, locator actions should not result in changed scale.
void setMapSettings (QgsQuickMapSettings * mapSettings)
The current project's map settings.
void setNavigation (Navigation * navigation)
The navigation object from which destination can be set or modified.
~LocatorModelSuperBridge () = default

Detailed Description

LocatorModelSuperBridge reimplements QgsLocatorModelBridge for specific needs of QField / QML implementation.

Public Properties Documentation

property activeLayer [1/2]

The current project's active layer. 

QgsMapLayer * LocatorModelSuperBridge::activeLayer;

property bookmarks [1/2]

The bookmark manager containing user and current project bookmarks. 

BookmarkModel * LocatorModelSuperBridge::bookmarks;

property featureListController [1/2]

The feature list extent controller. 

FeatureListExtentController * LocatorModelSuperBridge::featureListController;

property geometryHighlighter [1/2]

The locator highlight geometry object through which locator actions can highhlight features. 

QObject * LocatorModelSuperBridge::geometryHighlighter;

property keepScale [1/2]

The keep scale flag. When turned on, locator actions should not result in changed scale. 

bool LocatorModelSuperBridge::keepScale;

property mapSettings [1/2]

The current project's map settings. 

QgsQuickMapSettings * LocatorModelSuperBridge::mapSettings;

property navigation [1/2]

The navigation object from which destination can be set or modified. 

Navigation * LocatorModelSuperBridge::navigation;

Public Slots Documentation

slot triggerResultAtRow

void LocatorModelSuperBridge::triggerResultAtRow;

Public Signals Documentation

signal activeLayerChanged

void LocatorModelSuperBridge::activeLayerChanged;

signal bookmarksChanged

void LocatorModelSuperBridge::bookmarksChanged;

signal featureListControllerChanged

void LocatorModelSuperBridge::featureListControllerChanged;

signal geometryHighlighterChanged

void LocatorModelSuperBridge::geometryHighlighterChanged;

signal keepScaleChanged

void LocatorModelSuperBridge::keepScaleChanged;

signal locatorFiltersChanged

void LocatorModelSuperBridge::locatorFiltersChanged;

signal mapSettingsChanged

void LocatorModelSuperBridge::mapSettingsChanged;

signal messageEmitted

void LocatorModelSuperBridge::messageEmitted;

signal navigationChanged

void LocatorModelSuperBridge::navigationChanged;

signal requestJumpToPoint

void LocatorModelSuperBridge::requestJumpToPoint;

signal searchRequested

void LocatorModelSuperBridge::searchRequested;

signal searchTextChangeRequested

void LocatorModelSuperBridge::searchTextChangeRequested;

Public Functions Documentation

function LocatorModelSuperBridge

explicit LocatorModelSuperBridge::LocatorModelSuperBridge (
    QObject * parent=nullptr
)

function activeLayer [2/2]

The current project's active layer. 

QgsMapLayer * LocatorModelSuperBridge::activeLayer () const

function bookmarks [2/2]

The bookmark manager containing user and current project bookmarks. 

BookmarkModel * LocatorModelSuperBridge::bookmarks () const

function contextMenuActionsModel

Q_INVOKABLE LocatorActionsModel * LocatorModelSuperBridge::contextMenuActionsModel (
    const int row
)

Returns the actions model for a given locator search result list item.

function deregisterQFieldLocatorFilter

Q_INVOKABLE void LocatorModelSuperBridge::deregisterQFieldLocatorFilter (
    QFieldLocatorFilter * filter
)

Deregisters a given filter with the locator.

function emitMessage

void LocatorModelSuperBridge::emitMessage (
    const QString & text
)

function featureListController [2/2]

The feature list extent controller. 

FeatureListExtentController * LocatorModelSuperBridge::featureListController () const

function geometryHighlighter [2/2]

The locator highlight geometry object through which locator actions can highhlight features. 

QObject * LocatorModelSuperBridge::geometryHighlighter () const

function getLocatorModelDescription

Q_INVOKABLE QString LocatorModelSuperBridge::getLocatorModelDescription (
    const int row
)

Returns the description for a given locator search result list item.

function getPrefixFromSearchString

Q_INVOKABLE QString LocatorModelSuperBridge::getPrefixFromSearchString (
    const QString & string
)

Looks for and if present returns the locator filter prefix from a given search string. If not prefix is detected, an empty string will be returned.

function keepScale [2/2]

The keep scale flag. When turned on, locator actions should not result in changed scale. 

bool LocatorModelSuperBridge::keepScale () const

function mapSettings [2/2]

The current project's map settings. 

QgsQuickMapSettings * LocatorModelSuperBridge::mapSettings () const

function navigation [2/2]

The navigation object from which destination can be set or modified. 

Navigation * LocatorModelSuperBridge::navigation () const

function registerQFieldLocatorFilter

Q_INVOKABLE void LocatorModelSuperBridge::registerQFieldLocatorFilter (
    QFieldLocatorFilter * filter
)

Registers a given filter with the locator.

function requestSearch

Q_INVOKABLE void LocatorModelSuperBridge::requestSearch (
    const QString & text
)

Requests a text query against the search bar.

function requestSearchTextChange

void LocatorModelSuperBridge::requestSearchTextChange (
    const QString & text
)

Requests for the current text in the search bar to be changed to the provided text string.

function setActiveLayer

The current project's active layer. 

void LocatorModelSuperBridge::setActiveLayer (
    QgsMapLayer * layer
)

function setBookmarks

The bookmark manager containing user and current project bookmarks. 

void LocatorModelSuperBridge::setBookmarks (
    BookmarkModel * bookmarks
)

function setFeatureListController

The feature list extent controller. 

void LocatorModelSuperBridge::setFeatureListController (
    FeatureListExtentController * featureListController
)

function setGeometryHighlighter

The locator highlight geometry object through which locator actions can highhlight features. 

void LocatorModelSuperBridge::setGeometryHighlighter (
    QObject * geometryHighlighter
)

function setKeepScale

The keep scale flag. When turned on, locator actions should not result in changed scale. 

void LocatorModelSuperBridge::setKeepScale (
    bool keepScale
)

function setMapSettings

The current project's map settings. 

void LocatorModelSuperBridge::setMapSettings (
    QgsQuickMapSettings * mapSettings
)

function setNavigation

The navigation object from which destination can be set or modified. 

void LocatorModelSuperBridge::setNavigation (
    Navigation * navigation
)

function ~LocatorModelSuperBridge

LocatorModelSuperBridge::~LocatorModelSuperBridge () = default

The documentation for this class was generated from the following file src/core/locator/locatormodelsuperbridge.h