Skip to content

Class QfLocatorModelSuperBridge

ClassList > QfLocatorModelSuperBridge

More...

  • #include <qflocatormodelsuperbridge.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 QfBookmarkModel * bookmarks
The bookmark manager containing user and current project bookmarks.
property QfFeatureListExtentController * 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 QfNavigation * 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
QfLocatorModelSuperBridge (QObject * parent=nullptr)
QgsMapLayer * activeLayer () const
The current project's active layer.
QfBookmarkModel * bookmarks () const
The bookmark manager containing user and current project bookmarks.
Q_INVOKABLE QfLocatorActionsModel * contextMenuActionsModel (const int row)
Q_INVOKABLE void deregisterQFieldLocatorFilter (QfLocatorFilter * filter)
void emitMessage (const QString & text)
QfFeatureListExtentController * 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.
QfNavigation * navigation () const
The navigation object from which destination can be set or modified.
Q_INVOKABLE void registerQFieldLocatorFilter (QfLocatorFilter * 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 (QfBookmarkModel * bookmarks)
The bookmark manager containing user and current project bookmarks.
void setFeatureListController (QfFeatureListExtentController * 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 (QfNavigation * navigation)
The navigation object from which destination can be set or modified.
~QfLocatorModelSuperBridge () = default

Detailed Description

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

Public Properties Documentation

property activeLayer [1/2]

The current project's active layer. 

QgsMapLayer * QfLocatorModelSuperBridge::activeLayer;

property bookmarks [1/2]

The bookmark manager containing user and current project bookmarks. 

QfBookmarkModel * QfLocatorModelSuperBridge::bookmarks;

property featureListController [1/2]

The feature list extent controller. 

QfFeatureListExtentController * QfLocatorModelSuperBridge::featureListController;

property geometryHighlighter [1/2]

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

QObject * QfLocatorModelSuperBridge::geometryHighlighter;

property keepScale [1/2]

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

bool QfLocatorModelSuperBridge::keepScale;

property mapSettings [1/2]

The current project's map settings. 

QgsQuickMapSettings * QfLocatorModelSuperBridge::mapSettings;

property navigation [1/2]

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

QfNavigation * QfLocatorModelSuperBridge::navigation;

Public Slots Documentation

slot triggerResultAtRow

void QfLocatorModelSuperBridge::triggerResultAtRow;

Public Signals Documentation

signal activeLayerChanged

void QfLocatorModelSuperBridge::activeLayerChanged;

signal bookmarksChanged

void QfLocatorModelSuperBridge::bookmarksChanged;

signal featureListControllerChanged

void QfLocatorModelSuperBridge::featureListControllerChanged;

signal geometryHighlighterChanged

void QfLocatorModelSuperBridge::geometryHighlighterChanged;

signal keepScaleChanged

void QfLocatorModelSuperBridge::keepScaleChanged;

signal locatorFiltersChanged

void QfLocatorModelSuperBridge::locatorFiltersChanged;

signal mapSettingsChanged

void QfLocatorModelSuperBridge::mapSettingsChanged;

signal messageEmitted

void QfLocatorModelSuperBridge::messageEmitted;

signal navigationChanged

void QfLocatorModelSuperBridge::navigationChanged;

signal requestJumpToPoint

void QfLocatorModelSuperBridge::requestJumpToPoint;

signal searchRequested

void QfLocatorModelSuperBridge::searchRequested;

signal searchTextChangeRequested

void QfLocatorModelSuperBridge::searchTextChangeRequested;

Public Functions Documentation

function QfLocatorModelSuperBridge

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

function activeLayer [2/2]

The current project's active layer. 

QgsMapLayer * QfLocatorModelSuperBridge::activeLayer () const

function bookmarks [2/2]

The bookmark manager containing user and current project bookmarks. 

QfBookmarkModel * QfLocatorModelSuperBridge::bookmarks () const

function contextMenuActionsModel

Q_INVOKABLE QfLocatorActionsModel * QfLocatorModelSuperBridge::contextMenuActionsModel (
    const int row
)

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

function deregisterQFieldLocatorFilter

Q_INVOKABLE void QfLocatorModelSuperBridge::deregisterQFieldLocatorFilter (
    QfLocatorFilter * filter
)

Deregisters a given filter with the locator.

function emitMessage

void QfLocatorModelSuperBridge::emitMessage (
    const QString & text
)

function featureListController [2/2]

The feature list extent controller. 

QfFeatureListExtentController * QfLocatorModelSuperBridge::featureListController () const

function geometryHighlighter [2/2]

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

QObject * QfLocatorModelSuperBridge::geometryHighlighter () const

function getLocatorModelDescription

Q_INVOKABLE QString QfLocatorModelSuperBridge::getLocatorModelDescription (
    const int row
)

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

function getPrefixFromSearchString

Q_INVOKABLE QString QfLocatorModelSuperBridge::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 QfLocatorModelSuperBridge::keepScale () const

function mapSettings [2/2]

The current project's map settings. 

QgsQuickMapSettings * QfLocatorModelSuperBridge::mapSettings () const

function navigation [2/2]

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

QfNavigation * QfLocatorModelSuperBridge::navigation () const

function registerQFieldLocatorFilter

Q_INVOKABLE void QfLocatorModelSuperBridge::registerQFieldLocatorFilter (
    QfLocatorFilter * filter
)

Registers a given filter with the locator.

function requestSearch

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

Requests a text query against the search bar.

function requestSearchTextChange

void QfLocatorModelSuperBridge::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 QfLocatorModelSuperBridge::setActiveLayer (
    QgsMapLayer * layer
)

function setBookmarks

The bookmark manager containing user and current project bookmarks. 

void QfLocatorModelSuperBridge::setBookmarks (
    QfBookmarkModel * bookmarks
)

function setFeatureListController

The feature list extent controller. 

void QfLocatorModelSuperBridge::setFeatureListController (
    QfFeatureListExtentController * featureListController
)

function setGeometryHighlighter

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

void QfLocatorModelSuperBridge::setGeometryHighlighter (
    QObject * geometryHighlighter
)

function setKeepScale

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

void QfLocatorModelSuperBridge::setKeepScale (
    bool keepScale
)

function setMapSettings

The current project's map settings. 

void QfLocatorModelSuperBridge::setMapSettings (
    QgsQuickMapSettings * mapSettings
)

function setNavigation

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

void QfLocatorModelSuperBridge::setNavigation (
    QfNavigation * navigation
)

function ~QfLocatorModelSuperBridge

QfLocatorModelSuperBridge::~QfLocatorModelSuperBridge () = default

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