My Project
|
Object representing scope instance, which exposes model(s) with results. More...
#include <unity/shell/scopes/ScopeInterface.h>
Signals | |
void | showDash () |
Signal requesting to show the dash. More... | |
void | hideDash () |
Signal requesting to hide the dash. More... | |
void | gotoUri (QString const &uri) |
Signal requesting to open a uri. More... | |
void | previewRequested (QVariant const &result) |
Signal requesting to preview a result. More... | |
void | gotoScope (QString const &scopeId) |
Signal requesting to change the currently focused scope. | |
void | openScope (unity::shell::scopes::ScopeInterface *scope) |
Signal requesting to show a temporary scope. | |
void | activateApplication (QString const &desktop) |
Signal requesting activation of an application. | |
Public Member Functions | |
virtual Q_INVOKABLE void | activate (QVariant const &result)=0 |
Method used to activate a result. | |
virtual Q_INVOKABLE unity::shell::scopes::PreviewStackInterface * | preview (QVariant const &result)=0 |
Method used to preview a result. More... | |
virtual Q_INVOKABLE void | cancelActivation ()=0 |
Cancels the current activation. | |
virtual Q_INVOKABLE void | closeScope (unity::shell::scopes::ScopeInterface *scope)=0 |
Closes the temporary scope which got opened when openScope was emitted. | |
virtual Q_INVOKABLE unity::shell::scopes::DepartmentInterface * | getDepartment (QString const &departmentId)=0 |
Get a DepartmentInterface instance for the passed departmentId. | |
virtual Q_INVOKABLE void | loadDepartment (QString const &departmentId)=0 |
Activate department by its id. More... | |
virtual Q_INVOKABLE void | performQuery (QString const &cannedQuery)=0 |
Execute canned query. | |
Properties | |
QString | id |
Id of the scope. | |
QString | name |
Display name of the scope. | |
QString | iconHint |
URI to scope's icon. | |
QString | description |
Description of the scope. | |
QString | searchHint |
Hint to display in the search field. | |
bool | searchInProgress |
Boolean specifying whether a search is currently running. | |
bool | visible |
Boolean specifying whether the scope should be visible. | |
QString | shortcut |
Keyboard shortcut used to summon the scope. | |
unity::shell::scopes::CategoriesInterface | categories |
Categories model for scope's results. | |
unity::shell::scopes::SettingsModelInterface | settings |
Settings model for the scope. | |
QString | searchQuery |
Current search query. More... | |
QString | noResultsHint |
Message to display when there are no results after a search. | |
QString | formFactor |
Form factor which is sent with search queries. More... | |
bool | isActive |
Boolean specifying whether the scope is currently visible. | |
QString | currentDepartmentId |
String specifying currently selected department. | |
bool | hasDepartments |
Boolean specifying whether current query has departments. | |
QVariantMap | customizations |
VariantMap with customization properties. | |
Object representing scope instance, which exposes model(s) with results.
|
signal |
Signal requesting to open a uri.
This signal is usually emitted after activating a result.
|
signal |
Signal requesting to hide the dash.
This signal is usually emitted after activating a result.
|
pure virtual |
Activate department by its id.
This effectively runs a new query.
|
pure virtual |
Method used to preview a result.
Returns a new PreviewStackInterface instance. It's caller's responsibility to free it.
|
signal |
Signal requesting to preview a result.
This signal is usually emitted after activating a result.
|
signal |
Signal requesting to show the dash.
This signal is usually emitted after activating a result.
|
readwrite |
Form factor which is sent with search queries.
Form factor is one of scope inputs and be used by it to fine-tune the results.
TODO Document the supported for factors
|
readwrite |
Current search query.
Writing to this property issues a new search to the scope.