Medical Imaging Interaction Toolkit  2016.11.0
Medical Imaging Interaction Toolkit
Classes | Public Member Functions | List of all members
berry::IWorkbenchListener Struct Reference

#include <berryIWorkbenchListener.h>

Classes

struct  Events
 

Public Member Functions

virtual ~IWorkbenchListener ()
 
virtual bool PreShutdown (IWorkbench *, bool)
 
virtual void PostShutdown (IWorkbench *)
 

Detailed Description

Interface for listening to workbench lifecycle events.

This interface may be implemented by clients.

See also
IWorkbench::addWorkbenchListener
IWorkbench::removeWorkbenchListener

Definition at line 39 of file berryIWorkbenchListener.h.

Constructor & Destructor Documentation

berry::IWorkbenchListener::~IWorkbenchListener ( )
virtual

Definition at line 41 of file berryIWorkbenchListener.cpp.

Member Function Documentation

virtual void berry::IWorkbenchListener::PostShutdown ( IWorkbench *  )
inlinevirtual

Performs arbitrary finalization after the workbench stops running.

This method is called during workbench shutdown after all windows have been closed.

Parameters
workbenchthe workbench

Definition at line 93 of file berryIWorkbenchListener.h.

Referenced by berry::IWorkbenchListener::Events::AddListener(), and berry::IWorkbenchListener::Events::RemoveListener().

virtual bool berry::IWorkbenchListener::PreShutdown ( IWorkbench *  ,
bool   
)
inlinevirtual

Notifies that the workbench is about to shut down.

This method is called immediately prior to workbench shutdown before any windows have been closed.

The listener may veto a regular shutdown by returning false, although this will be ignored if the workbench is being forced to shut down.

Since other workbench listeners may veto the shutdown, the listener should not dispose resources or do any other work during this notification that would leave the workbench in an inconsistent state.

Parameters
workbenchthe workbench
forcedtrue if the workbench is being forced to shutdown, false for a regular close
Returns
true to allow the workbench to proceed with shutdown, false to veto a non-forced shutdown

Definition at line 82 of file berryIWorkbenchListener.h.

Referenced by berry::IWorkbenchListener::Events::AddListener(), and berry::IWorkbenchListener::Events::RemoveListener().

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