Unity Scopes API
|
Holds scope attributes such as name, description, icon etc. More...
#include <unity/scopes/ScopeMetadata.h>
Public Member Functions | |
std::string | scope_id () const |
Get the scope identifier. More... | |
ScopeProxy | proxy () const |
Get the proxy object for this scope. More... | |
std::string | display_name () const |
Get the display name for this scope. More... | |
std::string | description () const |
Get the description for this scope. More... | |
std::string | author () const |
Get the author for this scope. More... | |
std::string | art () const |
Get the art for this scope. More... | |
std::string | icon () const |
Get the icon for this scope. More... | |
std::string | search_hint () const |
Get the search hint for this scope. More... | |
std::string | hot_key () const |
Get the hot key for this scope. More... | |
bool | invisible () const |
Check if this scope should be hidden in the Dash. More... | |
VariantMap | appearance_attributes () const |
Get optional display attributes. More... | |
std::string | scope_directory () const |
Get directory where scope config files and .so file lives. More... | |
VariantMap | serialize () const |
Return a dictionary of all metadata attributes. More... | |
Copy and assignment | |
Copy and assignment operators (move and non-move versions) have the usual value semantics. | |
ScopeMetadata (ScopeMetadata const &other) | |
ScopeMetadata (ScopeMetadata &&) | |
ScopeMetadata & | operator= (ScopeMetadata const &other) |
ScopeMetadata & | operator= (ScopeMetadata &&) |
Holds scope attributes such as name, description, icon etc.
The information stored by ScopeMetadata comes from the .ini file for the given scope (for local scopes) or is fetched from the remote server (for scopes running on Smart Scopes Server). Use unity::scopes::Registry to get the metadata for a specific scope or all scopes.
VariantMap unity::scopes::ScopeMetadata::appearance_attributes | ( | ) | const |
Get optional display attributes.
Appearance attributes define customized look of the scope in Scopes Scope.
std::string unity::scopes::ScopeMetadata::art | ( | ) | const |
Get the art for this scope.
std::string unity::scopes::ScopeMetadata::author | ( | ) | const |
Get the author for this scope.
std::string unity::scopes::ScopeMetadata::description | ( | ) | const |
Get the description for this scope.
std::string unity::scopes::ScopeMetadata::display_name | ( | ) | const |
Get the display name for this scope.
std::string unity::scopes::ScopeMetadata::hot_key | ( | ) | const |
Get the hot key for this scope.
std::string unity::scopes::ScopeMetadata::icon | ( | ) | const |
Get the icon for this scope.
bool unity::scopes::ScopeMetadata::invisible | ( | ) | const |
Check if this scope should be hidden in the Dash.
ScopeProxy unity::scopes::ScopeMetadata::proxy | ( | ) | const |
Get the proxy object for this scope.
std::string unity::scopes::ScopeMetadata::scope_directory | ( | ) | const |
Get directory where scope config files and .so file lives.
Note that the directory is not set for remote scopes; in such case this method throws unity::scopes::NotFoundException.
unity::scopes::NotFoundException | if directory is not set |
std::string unity::scopes::ScopeMetadata::scope_id | ( | ) | const |
Get the scope identifier.
std::string unity::scopes::ScopeMetadata::search_hint | ( | ) | const |
Get the search hint for this scope.
VariantMap unity::scopes::ScopeMetadata::serialize | ( | ) | const |
Return a dictionary of all metadata attributes.