berry::IApplication Struct Reference

#include <berryIApplication.h>

Inheritance diagram for berry::IApplication:

Public Member Functions
virtual	~IApplication ()
virtual QVariant	Start (IApplicationContext *context)=0
virtual void	Stop ()=0

Static Public Attributes
static const int	EXIT_OK
static const int	EXIT_RESTART
static const int	EXIT_RELAUNCH

Detailed Description

Bootstrap type for an application. An IApplication represent executable entry points into an application. An IApplication can be configured into the Platform's org.blueberry.osgi.applications extension-point.

Clients may implement this interface.

Definition at line 37 of file berryIApplication.h.

Constructor & Destructor Documentation

berry::IApplication::~IApplication ( )

virtual

Definition at line 26 of file berryIApplication.cpp.

Member Function Documentation

virtual QVariant berry::IApplication::Start ( IApplicationContext *  context )

pure virtual

Starts this application with the given context and returns a result. This method must not exit until the application is finished and is ready to exit. The content of the context is unchecked and should conform to the expectations of the application being invoked.

Applications can return any object they like. If an Integer is returned it is treated as the program exit code if BlueBerry is exiting.

Note: This method is called by the platform; it is not intended to be called directly by clients.

Returns

the return value of the application

See also

EXIT_OK

EXIT_RESTART

EXIT_RELAUNCH

Parameters

context

the application context to pass to the application

Exceptions

std::exception

if there is a problem running this application.

Implemented in QmitkDiffusionImagingAppApplication.

virtual void berry::IApplication::Stop ( )

pure virtual

Forces this running application to exit. This method should wait until the running application is ready to exit. The start() should already have exited or should exit very soon after this method exits

This method is only called to force an application to exit. This method will not be called if an application exits normally from the start() method.

Note: This method is called by the platform; it is not intended to be called directly by clients.

Implemented in berry::UITestApplication, berry::CoreTestApplication, and QmitkDiffusionImagingAppApplication.

Member Data Documentation

const int berry::IApplication::EXIT_OK

static

Exit object indicating normal termination

Definition at line 43 of file berryIApplication.h.

Referenced by QmitkDiffusionImagingAppApplication::Start(), and berry::UITestApplication::Start().

const int berry::IApplication::EXIT_RELAUNCH

static

Exit object requesting that the command passed back be executed. Typically this is used to relaunch BlueBerry with different command line arguments. When the executable is relaunched the command line will be retrieved from the BlueBerry.exitdata system property.

Definition at line 55 of file berryIApplication.h.

const int berry::IApplication::EXIT_RESTART

static

Exit object requesting platform restart

Definition at line 48 of file berryIApplication.h.

Referenced by QmitkDiffusionImagingAppApplication::Start().

---

The documentation for this struct was generated from the following files:

• berryIApplication.h
• berryIApplication.cpp