Ubuntu Phone documentation
unity.scopes.SearchQueryBase
Abstract base class to represent a particular query. More...
#include <unity/scopes/SearchQueryBase.h>
Inheritance diagram for unity::scopes::SearchQueryBase:
src="https://assets.ubuntu.com/v1/83df383a-classunity_1_1scopes_1_1_search_query_base__inherit__graph.png" border="0" alt="Inheritance graph"/>
Public Member Functions | |
| virtual void | run (SearchReplyProxy const &reply)=0 |
| Called by scopes runtime to start the query. More... | |
| CannedQuery | query () const |
| Get a canned query for this search request. More... | |
| SearchMetadata | search_metadata () const |
| Get metadata for this search request. More... | |
| Subquery methods | |
The subsearch() methods are for use by aggregating scopes. When an aggregator passes a query to its child scopes, it should use subsearch() instead of the normal Scope::search() that would be called by a client. subsearch() takes care of automatically forwarding query cancellation to child scopes. This means that there is no need for an aggregating scope to explicitly forward cancellation to child scopes when its QueryBase::cancelled() method is called by the scopes runtime. | |
| QueryCtrlProxy | subsearch (ScopeProxy const &scope, std::string const &query_string, SearchListenerBase::SPtr const &reply) |
| QueryCtrlProxy | subsearch (ChildScope const &scope, std::string const &query_string, SearchListenerBase::SPtr const &reply) |
| QueryCtrlProxy | subsearch (ScopeProxy const &scope, std::string const &query_string, FilterState const &filter_state, SearchListenerBase::SPtr const &reply) |
| QueryCtrlProxy | subsearch (ScopeProxy const &scope, std::string const &query_string, std::string const &department_id, FilterState const &filter_state, SearchListenerBase::SPtr const &reply) |
| QueryCtrlProxy | subsearch (ChildScope const &scope, std::string const &query_string, std::string const &department_id, FilterState const &filter_state, SearchListenerBase::SPtr const &reply) |
| QueryCtrlProxy | subsearch (ScopeProxy const &scope, std::string const &query_string, std::string const &department_id, FilterState const &filter_state, SearchMetadata const &hints, SearchListenerBase::SPtr const &reply) |
| QueryCtrlProxy | subsearch (ChildScope const &scope, std::string const &query_string, std::string const &department_id, FilterState const &filter_state, SearchMetadata const &hints, SearchListenerBase::SPtr const &reply) |
| QueryCtrlProxy | subsearch (ChildScope const &scope, std::string const &query_string, std::string const &department_id, FilterState const &filter_state, Variant const &user_data, SearchMetadata const &hints, SearchListenerBase::SPtr const &reply) |
| QueryCtrlProxy | subsearch (ScopeProxy const &scope, std::string const &query_string, std::string const &department_id, FilterState const &filter_state, Variant const &user_data, SearchMetadata const &hints, SearchListenerBase::SPtr const &reply) |
| virtual void | cancelled ()=0 |
| Called by the scopes runtime when the query originator cancels a query. More... | |
| bool | valid () const |
| Check whether this query is still valid. More... | |
| unity::scopes::VariantMap | settings () const |
| Returns a dictionary with the scope's current settings. 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().
- 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
| CannedQuery unity::scopes::SearchQueryBase::query | ( | ) | const |
Get a canned query for this search request.
- Returns
- The canned query.
- Exceptions
-
unity::LogicException if the canned query was not initialized (was default-constructed).
|
pure virtual |
Called by scopes runtime 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
-
reply The proxy on which to push results for the query.
Implemented in unity::scopes::qt::QSearchQueryBaseAPI.
| SearchMetadata unity::scopes::SearchQueryBase::search_metadata | ( | ) | const |
Get metadata for this search request.
- Returns
- The search metadata.
- Exceptions
-
unity::LogicException if search metadata was not initialized (was default-constructed).