Albert
Loading...
Searching...
No Matches
albert::Query Class Referenceabstract

#include <query.h>

Inheritance diagram for albert::Query:

Detailed Description

Interface class for queries used by frontends.

See also
Frontend

Signals

void finished ()
 Emitted when the query finished processing. More...
 

Public Member Functions

virtual Q_INVOKABLE QString synopsis () const =0
 The synopsis of this query. More...
 
virtual Q_INVOKABLE QString trigger () const =0
 The trigger of this query. More...
 
virtual Q_INVOKABLE QString string () const =0
 Query string excluding the trigger. More...
 
virtual Q_INVOKABLE bool isFinished () const =0
 True if the query thread stopped. More...
 
virtual Q_INVOKABLE const bool & isValid () const =0
 True if query has not been cancelled. More...
 
virtual Q_INVOKABLE bool isTriggered () const =0
 True if this query has a trigger. More...
 
virtual Q_INVOKABLE QAbstractListModel * matches ()=0
 Returns the matches. More...
 
virtual Q_INVOKABLE QAbstractListModel * fallbacks ()=0
 Returns the fallbacks. More...
 
virtual Q_INVOKABLE void activateMatch (uint item, uint action=0)=0
 Executes match a match action. More...
 
virtual Q_INVOKABLE void activateFallback (uint item, uint action=0)=0
 Executes match a fallback action. More...
 

Protected Member Functions

virtual ~Query ()=default
 Private destructor. Lifetime is handled by the session. More...
 

Constructor & Destructor Documentation

◆ ~Query()

virtual albert::Query::~Query ( )
protectedvirtualdefault

Private destructor. Lifetime is handled by the session.

Member Function Documentation

◆ activateFallback()

virtual Q_INVOKABLE void albert::Query::activateFallback ( uint  item,
uint  action = 0 
)
pure virtual

Executes match a fallback action.

◆ activateMatch()

virtual Q_INVOKABLE void albert::Query::activateMatch ( uint  item,
uint  action = 0 
)
pure virtual

Executes match a match action.

◆ fallbacks()

virtual Q_INVOKABLE QAbstractListModel * albert::Query::fallbacks ( )
pure virtual

Returns the fallbacks.

◆ finished

void albert::Query::finished ( )
signal

Emitted when the query finished processing.

◆ isFinished()

virtual Q_INVOKABLE bool albert::Query::isFinished ( ) const
pure virtual

True if the query thread stopped.

◆ isTriggered()

virtual Q_INVOKABLE bool albert::Query::isTriggered ( ) const
pure virtual

True if this query has a trigger.

◆ isValid()

virtual Q_INVOKABLE const bool & albert::Query::isValid ( ) const
pure virtual

True if query has not been cancelled.

◆ matches()

virtual Q_INVOKABLE QAbstractListModel * albert::Query::matches ( )
pure virtual

Returns the matches.

◆ string()

virtual Q_INVOKABLE QString albert::Query::string ( ) const
pure virtual

Query string excluding the trigger.

◆ synopsis()

virtual Q_INVOKABLE QString albert::Query::synopsis ( ) const
pure virtual

The synopsis of this query.

◆ trigger()

virtual Q_INVOKABLE QString albert::Query::trigger ( ) const
pure virtual

The trigger of this query.


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