Ubuntu Phone documentation
unity.scopes.SearchListenerBase
Abstract base interface for a client to receive the results of a query. More...
#include <unity/scopes/SearchListenerBase.h>
Inheritance diagram for unity::scopes::SearchListenerBase:
src="https://assets.ubuntu.com/v1/545b96ac-classunity_1_1scopes_1_1_search_listener_base__inherit__graph.png" border="0" alt="Inheritance graph"/>
Public Member Functions | |
| virtual void | push (Department::SCPtr const &parent) |
| Called at most once by the scopes runtime for a tree of departments returned by a query. More... | |
| virtual void | push (CategorisedResult result)=0 |
| Called once by the scopes runtime for each result that is returned by a query(). | |
| virtual void | push (experimental::Annotation annotation) |
| Called once by the scopes runtime for each annotation that is returned by a query(). More... | |
| virtual void | push (Category::SCPtr const &category) |
| Called once by the scopes runtime for each category that is returned by a query(). More... | |
| virtual void | push (Filters const &filters, FilterState const &filter_state) |
| Called once by the scopes to send all the filters and their state. More... | |
| virtual void | push (Filters const &filters) |
| Called once by the scope to send all filters and their states. More... | |
| virtual void | finished (CompletionDetails const &details)=0 |
| Called once by the scopes runtime after the final result for a request was sent. More... | |
| virtual void | info (OperationInfo const &op_info) |
| Called by the scopes runtime each time a scope reports additional information about the reply to a query. More... | |
Detailed Description
Abstract base interface for a client to receive the results of a query.
An instance of this interface must be passed to Scope::search(). Results for the query are delivered to the client by the scopes run time by invoking the appropriate push method.
If the implementation of a push method throws an exception, the scopes runtime calls ListenerBase::finished() with an 'Error' status.
- See also
- ListenerBase
Member Function Documentation
|
virtual |
Called at most once by the scopes runtime for a tree of departments returned by a query.
The default implementation does nothing.
|
virtual |
Called once by the scopes runtime for each annotation that is returned by a query().
The default implementation does nothing.
|
virtual |
Called once by the scopes runtime for each category that is returned by a query().
Receipt of categories may be interleaved with the receipt of results, that is, there is no guarantee that the complete set of categories will be provided before the first query result.
The default implementation does nothing.
|
virtual |
Called once by the scopes to send all the filters and their state.
- Deprecated:
- Please override the push(Filters& const) method instead. This method will be removed from future releases.
The default implementation does nothing.
|
virtual |
Called once by the scope to send all filters and their states.
The default implementation does nothing.