Medical Imaging Interaction Toolkit  2024.06.00
Medical Imaging Interaction Toolkit
berry::IPartService Struct Referenceabstract

#include <berryIPartService.h>

Inheritance diagram for berry::IPartService:

Public Member Functions

virtual ~IPartService ()
 
virtual void AddPartListener (IPartListener *listener)=0
 
virtual IWorkbenchPart::Pointer GetActivePart ()=0
 
virtual IWorkbenchPartReference::Pointer GetActivePartReference ()=0
 
virtual void RemovePartListener (IPartListener *listener)=0
 

Detailed Description

A part service tracks the creation and activation of parts within a workbench page.

This interface is not intended to be implemented by clients.

See also
IWorkbenchPage

Definition at line 35 of file berryIPartService.h.

Constructor & Destructor Documentation

◆ ~IPartService()

virtual berry::IPartService::~IPartService ( )
virtual

Member Function Documentation

◆ AddPartListener()

virtual void berry::IPartService::AddPartListener ( IPartListener listener)
pure virtual

Adds the given observer for part 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 part listener
See also
RemovePartListener

◆ GetActivePart()

virtual IWorkbenchPart::Pointer berry::IPartService::GetActivePart ( )
pure virtual

Returns the active part.

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

◆ GetActivePartReference()

virtual IWorkbenchPartReference::Pointer berry::IPartService::GetActivePartReference ( )
pure virtual

Returns the active part reference.

Returns
the active part reference, or null if no part is currently active

◆ RemovePartListener()

virtual void berry::IPartService::RemovePartListener ( IPartListener listener)
pure virtual

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

Parameters
listenera part listener

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