CategorisedResult

A result, including the category it belongs to. More...

#include <unity/scopes/CategorisedResult.h>

Inheritance diagram for unity::scopes::CategorisedResult:
Inheritance graph
[legend]

Public Member Functions

 CategorisedResult (Category::SCPtr category)
 Creates a CategorisedResult with given category, with all base attributes initially empty. More...
 
void set_category (Category::SCPtr category)
 Updates the category of this result. More...
 
Category::SCPtr category () const
 Return category of this result. Get the category instance this result belongs to. More...
 
Copy and assignment

Copy and assignment operators (move and non-move versions) have the usual value semantics.

 CategorisedResult (CategorisedResult const &other)
 
CategorisedResultoperator= (CategorisedResult const &other)
 
 CategorisedResult (CategorisedResult &&)
 
CategorisedResultoperator= (CategorisedResult &&)
 
- Public Member Functions inherited from unity::scopes::Result
virtual ~Result ()
 
void store (Result const &other, bool intercept_activation=false)
 Stores a Result inside this Result instance. More...
 
bool has_stored_result () const
 Check if this Result instance has a stored result. More...
 
Result retrieve () const
 Get a stored result. More...
 
void set_uri (std::string const &uri)
 Set the "uri" attribute of this result.
 
void set_title (std::string const &title)
 Set the "title" attribute of this result. More...
 
void set_art (std::string const &image)
 Set the "art" attribute of this result. More...
 
void set_dnd_uri (std::string const &dnd_uri)
 Set the "dnd_uri" attribute of this result. More...
 
void set_intercept_activation ()
 Indicates to the receiver that this scope should intercept activation requests for this result. More...
 
bool direct_activation () const
 Check if this result should be activated directly by the shell because the scope doesn't handle activation of this result. More...
 
ScopeProxy target_scope_proxy () const
 Get the proxy of a scope that handles activation and preview of this result. More...
 
Variantoperator[] (std::string const &key)
 Returns reference of a Result attribute. More...
 
Variant const & operator[] (std::string const &key) const
 Returns a const reference to a Result attribute. More...
 
std::string uri () const noexcept
 Get the "uri" property of this Result. More...
 
std::string title () const noexcept
 Get the "title" property of this Result. More...
 
std::string art () const noexcept
 Get the "art" property of this Result. More...
 
std::string dnd_uri () const noexcept
 Get the "dnd_uri" property of this Result. More...
 
bool contains (std::string const &key) const
 Check if this Result has an attribute. More...
 
Variant const & value (std::string const &key) const
 Get the value of an attribute. More...
 
VariantMap serialize () const
 Returns a dictionary of all attributes of this Result instance. More...
 
bool is_account_login_result () const
 Check if this result is an online account login result. More...
 
bool operator== (Result const &other) const
 Compare result. More...
 
 Result (Result const &other)
 
 Result (Result &&)
 
Resultoperator= (Result const &other)
 
Resultoperator= (Result &&)
 

Detailed Description

A result, including the category it belongs to.

Constructor & Destructor Documentation

unity::scopes::CategorisedResult::CategorisedResult ( Category::SCPtr  category)
explicit

Creates a CategorisedResult with given category, with all base attributes initially empty.

Parameters
categoryThe category for the result.

Member Function Documentation

Category::SCPtr unity::scopes::CategorisedResult::category ( ) const

Return category of this result. Get the category instance this result belongs to.

Returns
The category instance.
void unity::scopes::CategorisedResult::set_category ( Category::SCPtr  category)

Updates the category of this result.

Parameters
categoryThe category for the result.