albert::TriggerQueryHandler Class Reference

#include <triggerqueryhandler.h>

Inheritance diagram for albert::TriggerQueryHandler:

Detailed Description

Triggered query handler class.

If the trigger matches this handler is the only query handler chosen to process the user query. Inherit this class if you dont want your results to be reordered or if you want to display your items of a long running query as soon as they are available.

Classes
class	TriggerQuery
	The query interface used by TriggerQueryHandler. More...

Public Member Functions
	TriggerQueryHandler ()
	~TriggerQueryHandler ()
QString	trigger () const
	The user configured trigger of this handler. More...
virtual QString	synopsis () const
	The synopsis, displayed on empty query. More...
virtual QString	defaultTrigger () const
	The default (not user defined) trigger. Default Extension::id(). More...
virtual bool	allowTriggerRemap () const
	Enable user remapping of the trigger. Default false. More...
virtual bool	supportsFuzzyMatching () const
	Fuzzy matching capability. Default false. More...
virtual bool	fuzzyMatching () const
	Fuzzy matching. Default false. More...
virtual void	setFuzzyMatching (bool enabled)
	Fuzzy matching behavior. Default does nothing. More...
virtual void	handleTriggerQuery (TriggerQuery *) const =0
	The trigger query processing function. More...
Public Member Functions inherited from albert::Extension
	Extension ()=default
virtual QString	id () const =0
	The identifier of this extension. More...
virtual QString	name () const =0
	Pretty, human readable name. More...
virtual QString	description () const =0
	Brief description of this extension. More...

Friends
class	::QueryEngine

Additional Inherited Members
Protected Member Functions inherited from albert::Extension
virtual	~Extension ()=default

Constructor & Destructor Documentation

TriggerQueryHandler()

albert::TriggerQueryHandler::TriggerQueryHandler

(

)

~TriggerQueryHandler()

albert::TriggerQueryHandler::~TriggerQueryHandler

(

)

Member Function Documentation

allowTriggerRemap()

virtual bool albert::TriggerQueryHandler::allowTriggerRemap ( ) const

virtual

Enable user remapping of the trigger. Default false.

defaultTrigger()

virtual QString albert::TriggerQueryHandler::defaultTrigger ( ) const

virtual

The default (not user defined) trigger. Default Extension::id().

fuzzyMatching()

virtual bool albert::TriggerQueryHandler::fuzzyMatching ( ) const

virtual

Fuzzy matching. Default false.

Reimplemented in albert::IndexQueryHandler.

handleTriggerQuery()

virtual void albert::TriggerQueryHandler::handleTriggerQuery ( TriggerQuery *  ) const

pure virtual

The trigger query processing function.

Note

Executed in a worker thread.

Implemented in albert::GlobalQueryHandler.

setFuzzyMatching()

virtual void albert::TriggerQueryHandler::setFuzzyMatching ( bool  enabled )

virtual

Fuzzy matching behavior. Default does nothing.

Reimplemented in albert::IndexQueryHandler.

supportsFuzzyMatching()

virtual bool albert::TriggerQueryHandler::supportsFuzzyMatching ( ) const

virtual

Fuzzy matching capability. Default false.

Reimplemented in albert::IndexQueryHandler.

synopsis()

virtual QString albert::TriggerQueryHandler::synopsis ( ) const

virtual

The synopsis, displayed on empty query.

Use this to give the user hints about accepted query strings. Default empty.

Reimplemented in albert::IndexQueryHandler.

trigger()

QString albert::TriggerQueryHandler::trigger

(

)

const

The user configured trigger of this handler.

Friends And Related Function Documentation

::QueryEngine

friend class ::QueryEngine

friend

---

The documentation for this class was generated from the following file:

• albert/include/albert/extension/queryhandler/triggerqueryhandler.h