Class HelpLocatorFilter

ClassList > HelpLocatorFilter

More...

• #include <helplocatorfilter.h>

Inherits the following classes: QgsLocatorFilter

Public Types

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

Public Functions

Type	Name
	HelpLocatorFilter (LocatorModelSuperBridge * locatorBridge, QObject * parent=nullptr)
HelpLocatorFilter *	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
void	triggerResult (const QgsLocatorResult & result) override
void	triggerResultFromAction (const QgsLocatorResult & result, const int actionId) override

Detailed Description

HelpLocatorFilter 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 HelpLocatorFilter::ActionOrigin {
    Normal
};

---

Public Functions Documentation

function HelpLocatorFilter

explicit HelpLocatorFilter::HelpLocatorFilter (
    LocatorModelSuperBridge * locatorBridge,
    QObject * parent=nullptr
) 

---

function clone

HelpLocatorFilter * HelpLocatorFilter::clone () override const

---

function description

inline QString HelpLocatorFilter::description () override const

---

function displayName

inline QString HelpLocatorFilter::displayName () override const

---

function fetchResults

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

---

function name

inline QString HelpLocatorFilter::name () override const

---

function prefix

inline QString HelpLocatorFilter::prefix () override const

---

function priority

inline Priority HelpLocatorFilter::priority () override const

---

function triggerResult

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

---

function triggerResultFromAction

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

---

---

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