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

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)=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::NavigationInterface *	getNavigation (QString const &navigationId)=0
	Get a NavigationInterface instance for the passed navigationId.

virtual Q_INVOKABLE unity::shell::scopes::NavigationInterface *	getAltNavigation (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.

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 )

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.

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