Class QfHelpLocatorFilter

ClassList > QfHelpLocatorFilter

More...

• #include <qfhelplocatorfilter.h>

Inherits the following classes: QgsLocatorFilter

Public Types

Type	Name
enum	ActionOrigin Origin of the action which triggers the result.

Public Functions

Type	Name
	QfHelpLocatorFilter (QfLocatorModelSuperBridge * locatorBridge, QObject * parent=nullptr)
QfHelpLocatorFilter *	clone () override const
QString	description () override const
QString	displayName () override const
void	fetchResults (const QString & string, const QgsLocatorContext & context, QgsFeedback * feedback) override
QString	name () override const
QString	prefix () override const
Priority	priority () override const
QString	searchUrl () const
void	setSearchUrl (const QString & url)
void	triggerResult (const QgsLocatorResult & result) override
void	triggerResultFromAction (const QgsLocatorResult & result, const int actionId) override

Detailed Description

QfHelpLocatorFilter is a locator filter to search for and display QField documentation pages.

Public Types Documentation

enum ActionOrigin

Origin of the action which triggers the result.

enum QfHelpLocatorFilter::ActionOrigin {
    Normal
};

---

Public Functions Documentation

function QfHelpLocatorFilter

explicit QfHelpLocatorFilter::QfHelpLocatorFilter (
    QfLocatorModelSuperBridge * locatorBridge,
    QObject * parent=nullptr
) 

---

function clone

QfHelpLocatorFilter * QfHelpLocatorFilter::clone () override const

---

function description

inline QString QfHelpLocatorFilter::description () override const

---

function displayName

inline QString QfHelpLocatorFilter::displayName () override const

---

function fetchResults

void QfHelpLocatorFilter::fetchResults (
    const QString & string,
    const QgsLocatorContext & context,
    QgsFeedback * feedback
) override

---

function name

inline QString QfHelpLocatorFilter::name () override const

---

function prefix

inline QString QfHelpLocatorFilter::prefix () override const

---

function priority

inline Priority QfHelpLocatorFilter::priority () override const

---

function searchUrl

inline QString QfHelpLocatorFilter::searchUrl () const

---

function setSearchUrl

inline void QfHelpLocatorFilter::setSearchUrl (
    const QString & url
) 

---

function triggerResult

void QfHelpLocatorFilter::triggerResult (
    const QgsLocatorResult & result
) override

---

function triggerResultFromAction

void QfHelpLocatorFilter::triggerResultFromAction (
    const QgsLocatorResult & result,
    const int actionId
) override

---

---

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