19 #ifndef UNITY_SCOPES_SEARCHREPLY_H
20 #define UNITY_SCOPES_SEARCHREPLY_H
22 #include <unity/scopes/Category.h>
23 #include <unity/scopes/CategoryRenderer.h>
24 #include <unity/scopes/Department.h>
25 #include <unity/scopes/FilterBase.h>
26 #include <unity/scopes/FilterState.h>
27 #include <unity/scopes/Reply.h>
35 class CategorisedResult;
62 std::string
const& title,
63 std::string
const &icon,
virtual void register_departments(DepartmentList const &departments, std::string current_department_id="")=0
Register departments for the current search reply and provide the current department.
Query link(s) that result in a new search query when clicked by the user.
Definition: Annotation.h:45
std::list< FilterBase::SCPtr > Filters
List of filters.
Definition: FilterBase.h:83
A category renderer template in JSON format.
Definition: CategoryRenderer.h:84
virtual bool register_annotation(Annotation const &annotation)=0
Register an annotation.
std::list< Department > DepartmentList
List of departments (see unity::scopes::Department)
Definition: Department.h:40
Allows query termination to be sent to the source of a query.
Definition: Reply.h:37
virtual Category::SCPtr lookup_category(std::string const &id)=0
Returns a previously registered category.
virtual ~SearchReply()
Destroys a Reply.
Allows the results of a search query to be sent to the query source.
Definition: SearchReply.h:42
virtual bool push(CategorisedResult const &result)=0
Sends a single result to the source of a query.
Captures state of multiple filters.
Definition: FilterState.h:47
virtual Category::SCPtr register_category(std::string const &id, std::string const &title, std::string const &icon, CategoryRenderer const &renderer_template=CategoryRenderer())=0
Register an existing category instance and send it to the source of the query.
A result, including the category it belongs to.
Definition: CategorisedResult.h:41
virtual std::string category()=0
Returns the category of the target object of this proxy.