Ubuntu Phone documentation
unity.scopes.Category
A set of related results returned by a scope and displayed within a single pane in the Unity dash. More...
#include <unity/scopes/Category.h>
Inheritance diagram for unity::scopes::Category:
src="https://assets.ubuntu.com/v1/8105c7b1-classunity_1_1scopes_1_1_category__inherit__graph.png" border="0" alt="Inheritance graph"/>
Public Member Functions | |
| std::string | id () const |
| Get identifier of this Category. More... | |
| std::string | title () const |
| Get title of this Category. More... | |
| std::string | 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 Category, use SearchReplyProxy::register_category.
- See also
- ResultItem
Member Function Documentation
| std::string unity::scopes::Category::icon | ( | ) | const |
Get icon of this Category.
- Returns
- The category icon.
| std::string unity::scopes::Category::id | ( | ) | const |
Get identifier of this Category.
- Returns
- The category identifier.
| CannedQuery::SCPtr unity::scopes::Category::query | ( | ) | const |
Query to perform when this category is expanded.
- Returns
- The expansion query or nullptr.
| CategoryRenderer const& unity::scopes::Category::renderer_template | ( | ) | const |
Get renderer template of this Category.
- Returns
- The category renderer template.
| std::string unity::scopes::Category::title | ( | ) | const |
Get title of this Category.
- Returns
- The category title.