unity.scopes.qt.QCategorisedResult

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

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

Inheritance diagram for unity::scopes::qt::QCategorisedResult: src="https://assets.ubuntu.com/v1/74a3bcac-classunity_1_1scopes_1_1qt_1_1_q_categorised_result__inherit__graph.png" border="0" alt="Inheritance graph"/>

Public Member Functions

 QCategorisedResult (QCategory::SCPtr category)
 Creates a CategorisedResult with given category, with all base attributes initially empty. More...
 
void set_category (QCategory::SCPtr category)
 Updates the category of this result. More...
 
QCategory::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.

 QCategorisedResult (QCategorisedResult const &other)
 
QCategorisedResultoperator= (QCategorisedResult const &other)
 
 QCategorisedResult (QCategorisedResult &&)
 
QCategorisedResultoperator= (QCategorisedResult &&)
 
src="https://assets.ubuntu.com/v1/c6607712-closed.png" alt="-"/> Public Member Functions inherited from unity::scopes::qt::QResult
virtual ~QResult ()
 
void store (QResult 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...
 
QResult retrieve () const
 Get a stored result. More...
 
void set_uri (QString const &uri)
 Set the "uri" attribute of this result.
 
void set_title (QString const &title)
 Set the "title" attribute of this result. More...
 
void set_art (QString const &image)
 Set the "art" attribute of this result. More...
 
void set_dnd_uri (QString 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...
 
QVariant & operator[] (QString const &key)
 Returns reference of a Result attribute. More...
 
QVariant const & operator[] (QString const &key) const
 Returns a const reference to a Result attribute. More...
 
QString uri () const noexcept
 Get the "uri" property of this Result. More...
 
QString title () const noexcept
 Get the "title" property of this Result. More...
 
QString art () const noexcept
 Get the "art" property of this Result. More...
 
QString dnd_uri () const noexcept
 Get the "dnd_uri" property of this Result. More...
 
bool contains (QString const &key) const
 Check if this Result has an attribute. More...
 
QVariant const & value (QString const &key) const
 Get the value of an attribute. More...
 
QVariantMap serialize () const
 Returns a dictionary of all attributes of this Result instance. More...
 
 QResult (QResult const &other)
 
 QResult (QResult &&)
 
QResultoperator= (QResult const &other)
 
QResultoperator= (QResult &&)
 

Detailed Description

A result, including the category it belongs to.

Constructor & Destructor Documentation

unity::scopes::qt::QCategorisedResult::QCategorisedResult ( QCategory::SCPtr  category)
explicit

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

Parameters
categoryThe category for the result.

Member Function Documentation

QCategory::SCPtr unity::scopes::qt::QCategorisedResult::category ( ) const

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

Returns
The category instance.
void unity::scopes::qt::QCategorisedResult::set_category ( QCategory::SCPtr  category)

Updates the category of this result.

Parameters
categoryThe category for the result.