My Project
unity::shell::application::ApplicationManagerInterface Class Referenceabstract

The Application manager. More...

#include <unity/shell/application/ApplicationManagerInterface.h>

Inheritance diagram for unity::shell::application::ApplicationManagerInterface:
Collaboration diagram for unity::shell::application::ApplicationManagerInterface:

Public Types

enum  Roles {
  RoleAppId = Qt::UserRole, RoleName, RoleComment, RoleIcon,
  RoleStage, RoleState, RoleFocused
}
 The Roles supported by the model. More...
 

Signals

void focusRequested (const QString &appId)
 Will be emitted right before the focused application changes. More...
 
void focusedApplicationIdChanged ()
 Will be emitted whenever the focused application changes.
 
void applicationAdded (const QString &appId)
 Will be emitted when an application was added to the model. More...
 
void applicationRemoved (const QString &appId)
 Will be emitted when an application was removed from the model. More...
 

Public Member Functions

virtual Q_INVOKABLE unity::shell::application::ApplicationInfoInterfaceget (int index) const =0
 Get an ApplicationInfo item (using stack index). More...
 
virtual Q_INVOKABLE unity::shell::application::ApplicationInfoInterfacefindApplication (const QString &appId) const =0
 Get an ApplicationInfo item (using the appId). More...
 
virtual Q_INVOKABLE bool requestFocusApplication (const QString &appId)=0
 Request to focus a given application. More...
 
virtual Q_INVOKABLE bool focusApplication (const QString &appId)=0
 Focus the given application. More...
 
virtual Q_INVOKABLE void unfocusCurrentApplication ()=0
 Unfocus the currently focused application.
 
virtual Q_INVOKABLE unity::shell::application::ApplicationInfoInterfacestartApplication (const QString &appId, const QStringList &arguments)=0
 Start an application. More...
 
virtual Q_INVOKABLE bool stopApplication (const QString &appId)=0
 Stops an application. More...
 

Properties

int count
 The count of the applications known to the manager. More...
 
QString focusedApplicationId
 The currently focused application. More...
 

Detailed Description

The Application manager.

This is the main class to interact with Applications

Member Enumeration Documentation

The Roles supported by the model.

See ApplicationInfoInterface properties for details.

Member Function Documentation

void unity::shell::application::ApplicationManagerInterface::applicationAdded ( const QString &  appId)
signal

Will be emitted when an application was added to the model.

Parameters
appIdThe appId of the application that was added.
void unity::shell::application::ApplicationManagerInterface::applicationRemoved ( const QString &  appId)
signal

Will be emitted when an application was removed from the model.

Parameters
appIdThe appId of the application that was removed.
virtual Q_INVOKABLE unity::shell::application::ApplicationInfoInterface* unity::shell::application::ApplicationManagerInterface::findApplication ( const QString &  appId) const
pure virtual

Get an ApplicationInfo item (using the appId).

Note: QML requires the full namespace in the return value.

Parameters
appIdthe appId of the item to get
Returns
The item, or null if not found.
virtual Q_INVOKABLE bool unity::shell::application::ApplicationManagerInterface::focusApplication ( const QString &  appId)
pure virtual

Focus the given application.

This will immediately focus the given application. Usually you should not use this but instead call requestFocusApplication() in order to allow the shell to prepare for the upcoming animation or even block the focus request (e.g. focus stealing prevention)

Parameters
appIdThe application to be focused.
Returns
True if appId found and application focused, else false.
void unity::shell::application::ApplicationManagerInterface::focusRequested ( const QString &  appId)
signal

Will be emitted right before the focused application changes.

This can be used to prepare for an upcoming focus change. For example starting an animation.

virtual Q_INVOKABLE unity::shell::application::ApplicationInfoInterface* unity::shell::application::ApplicationManagerInterface::get ( int  index) const
pure virtual

Get an ApplicationInfo item (using stack index).

Note: QML requires the full namespace in the return value.

Parameters
indexthe index of the item to get
Returns
The item, or null if not found.
virtual Q_INVOKABLE bool unity::shell::application::ApplicationManagerInterface::requestFocusApplication ( const QString &  appId)
pure virtual

Request to focus a given application.

This will request the shell to focus the given application.

Parameters
appIdThe appId of the app to be focused.
Returns
True if the request will processed, false if it was discarded (i.e. the given appid could not be found)
virtual Q_INVOKABLE unity::shell::application::ApplicationInfoInterface* unity::shell::application::ApplicationManagerInterface::startApplication ( const QString &  appId,
const QStringList &  arguments 
)
pure virtual

Start an application.

Parameters
appIdThe appId for the application to be spawned.
argumentsAny arguments to be passed to the process.
Returns
The created application item if start successful, else null.
virtual Q_INVOKABLE bool unity::shell::application::ApplicationManagerInterface::stopApplication ( const QString &  appId)
pure virtual

Stops an application.

Parameters
appIdThe application to be stopped.
Returns
True if application stop successful, else false (i.e. false if application was not running).

Property Documentation

int unity::shell::application::ApplicationManagerInterface::count
read

The count of the applications known to the manager.

This is the same as rowCount, added in order to keep compatibility with QML ListModels.

QString unity::shell::application::ApplicationManagerInterface::focusedApplicationId
read

The currently focused application.

Use focusApplication() and unfocusCurrentApplication() to modify this.


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