Unity Scopes Qt library
unity::scopes::qt::QSearchQueryBaseAPI Class Reference

Abstract base class to represent a particular query. More...

#include <unity/scopes/qt/QSearchQueryBaseAPI.h>

Inheritance diagram for unity::scopes::qt::QSearchQueryBaseAPI:

Public Member Functions

virtual void run (SearchReplyProxy const &reply) final
 Called by scopes run time to start the query. More...
 
virtual void cancelled () final
 Called by the scopes run time when the query originator cancels a query. More...
 

Detailed Description

Abstract base class to represent a particular query.

A scope must return an instance of this class from its implementation of ScopeBase::search().

This is the class that links scope API calls with the main QThread. The instance of this class is moved to the main QThread and pushes events to the Qt event loop.

Note
The constructor of the instance must complete in a timely manner. Do not perform anything in the constructor that might block.

Member Function Documentation

§ cancelled()

virtual void unity::scopes::qt::QSearchQueryBaseAPI::cancelled ( )
finalvirtual

Called by the scopes run time when the query originator cancels a query.

Your implementation of this method should ensure that the scope stops processing the current query as soon as possible. Any calls to a push() method once a query is cancelled are ignored, so continuing to push after cancellation only wastes CPU cycles. (push() returns false once a query is cancelled or exceeds its cardinality limit.)

§ run()

virtual void unity::scopes::qt::QSearchQueryBaseAPI::run ( SearchReplyProxy const &  reply)
finalvirtual

Called by scopes run time to start the query.

Your implementation of run() can use the reply proxy to push results for the query. You can push results from within run(), in which case the query implicitly completes when run() returns. Alternatively, run() can store the reply proxy and return immediately. In this case, you can use the stored proxy to push results from another thread. It is safe to call push() from multiple threads without synchronization.

The query completes either when run() returns, or when the last stored reply proxy goes out of scope (whichever happens last).

Parameters
replyThe proxy on which to push results for the query.

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