berry::IPageService Struct Reference

#include <berryIPageService.h>

Inheritance diagram for berry::IPageService:

Public Member Functions
virtual	~IPageService ()
virtual void	AddPerspectiveListener (IPerspectiveListener *listener)=0
virtual SmartPointer< IWorkbenchPage >	GetActivePage () const =0
virtual void	RemovePerspectiveListener (IPerspectiveListener *listener)=0
virtual IPerspectiveListener::Events &	GetPerspectiveEvents ()=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

org.blueberry.ui.services.IServiceLocator::getService(Class) This interface is not intended to be implemented by clients.

Definition at line 48 of file berryIPageService.h.

Constructor & Destructor Documentation

berry::IPageService::~IPageService ( )

virtual

Definition at line 21 of file berryIPageService.cpp.

Member Function Documentation

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

pure virtual

Adds the given listener for page 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

listener

a page listener

See also

#removePageListener(IPageListener) 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

listener

a perspective listener

See also

#removePerspectiveListener(IPerspectiveListener)

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.

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

pure virtual

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

pure virtual

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

Parameters

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

---

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

• berryIPageService.h
• berryIPageService.cpp