unity.scopes.qt.QCategory

A set of related results returned by a scope and displayed within a single pane in the Unity dash. More...

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

Public Member Functions

QString id () const
 Get identifier of this Category. More...
 
QString title () const
 Get title of this Category. More...
 
QString icon () const
 Get icon of this Category. More...
 
CannedQuery::SCPtr query () const
 Query to perform when this category is expanded. More...
 
CategoryRenderer const & renderer_template () const
 Get renderer template of this Category. More...
 

Detailed Description

A set of related results returned by a scope and displayed within a single pane in the Unity dash.

To create a QCategory, use QReplyProxy::register_category.

Member Function Documentation

QString unity::scopes::qt::QCategory::icon ( ) const

Get icon of this Category.

Returns
The category icon.
QString unity::scopes::qt::QCategory::id ( ) const

Get identifier of this Category.

Returns
The category identifier.
CannedQuery::SCPtr unity::scopes::qt::QCategory::query ( ) const

Query to perform when this category is expanded.

Returns
The expansion query or nullptr.
CategoryRenderer const& unity::scopes::qt::QCategory::renderer_template ( ) const

Get renderer template of this Category.

Returns
The category renderer template.
QString unity::scopes::qt::QCategory::title ( ) const

Get title of this Category.

Returns
The category title.