My Project
 All Classes Namespaces Files Functions Typedefs Enumerations Enumerator Properties Macros
unity::shell::application::ApplicationInfoInterface Class Reference

A class that holds information about applications. More...

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

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

Public Types

enum  Stage { MainStage, SideStage }
 A enum that defines a stage. More...
 
enum  State { Starting, Running, Suspended, Stopped }
 An application's state. More...
 

Properties

QString appId
 The appId of the application. More...
 
QString name
 The name of the application. More...
 
QString comment
 The comment for the application. More...
 
QUrl icon
 The application's icon. More...
 
Stage stage
 The application's stage. More...
 
State state
 The application's state. More...
 
bool focused
 The application's focus state. More...
 

Detailed Description

A class that holds information about applications.

The items hold all the information required for the visual representation in the launcher.

Member Enumeration Documentation

A enum that defines a stage.

MainStage: The main stage, which is the normal place for applications in traditional desktop environments. SideStage: The side stage, a panel on the right to place phone form factor applications.

An application's state.

Starting: The application was launched and is currently starting up. Running: The application is running and ready to be used. Suspended: The application is in the background and has been suspended by the system in order to save resources. Stopped: The application is in the background and has been stopped by the system in order to save resources. From a programmers point of view, the application is closed, but it's state has been stored to disk and can be restored upon next launch.

Property Documentation

QString unity::shell::application::ApplicationInfoInterface::appId
read

The appId of the application.

Holds the appId for the application. For example (com.ubuntu.camera-app). The appId is derived from the filename of the .desktop file.

QString unity::shell::application::ApplicationInfoInterface::comment
read

The comment for the application.

Holds the comment of the application as obtained from the .desktop file. Localized to current language.

bool unity::shell::application::ApplicationInfoInterface::focused
read

The application's focus state.

Holds the current application focus state. True if focused, false otherwise.

QUrl unity::shell::application::ApplicationInfoInterface::icon
read

The application's icon.

Holds a path to the icon for the application. Can be a file or a gicon url.

QString unity::shell::application::ApplicationInfoInterface::name
read

The name of the application.

Holds the name of the application. Localized to current language.

Stage unity::shell::application::ApplicationInfoInterface::stage
read

The application's stage.

Holds the stage where this application is currently located.

State unity::shell::application::ApplicationInfoInterface::state
read

The application's state.

Holds the current application state.


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