Medical Imaging Interaction Toolkit  2021.10.99-9c07a326
Medical Imaging Interaction Toolkit
berry::IPageService Struct Referenceabstract

#include <berryIPageService.h>

Inheritance diagram for berry::IPageService:

Public Member Functions

virtual ~IPageService ()
 
virtual void AddPerspectiveListener (IPerspectiveListener *listener)=0
 
virtual SmartPointer< IWorkbenchPageGetActivePage () const =0
 
virtual void RemovePerspectiveListener (IPerspectiveListener *listener)=0
 
virtual IPerspectiveListener::EventsGetPerspectiveEvents ()=0
 

Detailed Description

A page service tracks the page and perspective lifecycle events within a workbench window.

This service can be acquired from your service locator:

 IPageService service = (IPageService) getSite().getService(IPageService.class);
  • This service is not available globally, only from the workbench window level down.
See also
IWorkbenchWindow
IPageListener
IPerspectiveListener
IServiceLocator::GetService
Note
This interface is not intended to be implemented by clients.

Definition at line 44 of file berryIPageService.h.

Constructor & Destructor Documentation

◆ ~IPageService()

virtual berry::IPageService::~IPageService ( )
virtual

Member Function Documentation

◆ AddPerspectiveListener()

virtual void berry::IPageService::AddPerspectiveListener ( IPerspectiveListener listener)
pure virtual

Adds the given listener for a page's perspective lifecycle events. Has no effect if an identical listener is already registered.

Note: listeners should be removed when no longer necessary. If not, they will be removed when the IServiceLocator used to acquire this service is disposed.

Parameters
listenera perspective listener
See also
RemovePerspectiveListener

◆ GetActivePage()

virtual SmartPointer<IWorkbenchPage> berry::IPageService::GetActivePage ( ) const
pure virtual

Returns the active page.

Returns
the active page, or null if no page is currently active

Implemented in berry::IWorkbenchWindow.

◆ GetPerspectiveEvents()

virtual IPerspectiveListener::Events& berry::IPageService::GetPerspectiveEvents ( )
pure virtual

◆ RemovePerspectiveListener()

virtual void berry::IPageService::RemovePerspectiveListener ( IPerspectiveListener listener)
pure virtual

Removes the given page's perspective listener. Has no affect if an identical listener is not registered.

Parameters
listenera perspective listener

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