My Project
unity::shell::scopes::ScopeInterface Class Referenceabstract

Object representing scope instance, which exposes model(s) with results. More...

#include <unity/shell/scopes/ScopeInterface.h>

Inheritance diagram for unity::shell::scopes::ScopeInterface:
Collaboration diagram for unity::shell::scopes::ScopeInterface:

Public Types

enum  Status { Okay, NoInternet, NoLocationData, Unknown }
 Status info code following the last operation.
 

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.
 

Public Member Functions

virtual Q_INVOKABLE void activate (QVariant const &result, QString const &categoryId)=0
 Method used to activate a result.
 
virtual Q_INVOKABLE unity::shell::scopes::PreviewStackInterfacepreview (QVariant const &result, QString const &categoryId)=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::NavigationInterfacegetNavigation (QString const &navigationId)=0
 Get a NavigationInterface instance for the passed navigationId.
 
virtual Q_INVOKABLE unity::shell::scopes::NavigationInterfacegetAltNavigation (QString const &altNavigationId)=0
 Get a NavigationInterface instance for the passed altNavigationId.
 
virtual Q_INVOKABLE void setNavigationState (QString const &navId, bool altNavigation)=0
 Request change to the current navigation or altNavigation id.
 
virtual Q_INVOKABLE void performQuery (QString const &cannedQuery)=0
 Execute canned query.
 
virtual Q_INVOKABLE void refresh ()=0
 Force refresh of the scope contents.
 

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 favorite
 Boolean specifying whether the scope is favourited.
 
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 active.
 
QString currentNavigationId
 String specifying currently selected department.
 
bool hasNavigation
 Boolean specifying whether current query has departments.
 
QString currentAltNavigationId
 String specifying currently selected sort order.
 
bool hasAltNavigation
 Boolean specifying whether current query has sort order.
 
QVariantMap customizations
 VariantMap with customization properties.
 
unity::shell::scopes::ScopeInterface::Status status
 Enum representing the status of the scope.
 

Detailed Description

Object representing scope instance, which exposes model(s) with results.

Member Function Documentation

void unity::shell::scopes::ScopeInterface::gotoUri ( QString const &  uri)
signal

Signal requesting to open a uri.

This signal is usually emitted after activating a result.

void unity::shell::scopes::ScopeInterface::hideDash ( )
signal

Signal requesting to hide the dash.

This signal is usually emitted after activating a result.

virtual Q_INVOKABLE unity::shell::scopes::PreviewStackInterface* unity::shell::scopes::ScopeInterface::preview ( QVariant const &  result,
QString const &  categoryId 
)
pure virtual

Method used to preview a result.

Returns a new PreviewStackInterface instance. It's caller's responsibility to free it.

void unity::shell::scopes::ScopeInterface::previewRequested ( QVariant const &  result)
signal

Signal requesting to preview a result.

This signal is usually emitted after activating a result.

void unity::shell::scopes::ScopeInterface::showDash ( )
signal

Signal requesting to show the dash.

This signal is usually emitted after activating a result.

Property Documentation

QString unity::shell::scopes::ScopeInterface::formFactor
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

QString unity::shell::scopes::ScopeInterface::searchQuery
readwrite

Current search query.

Writing to this property issues a new search to the scope.


The documentation for this class was generated from the following file: