Medical Imaging Interaction Toolkit  2018.4.99-a3d2e8fb
Medical Imaging Interaction Toolkit
berry::IPerspectiveListener Struct Referenceabstract

#include <berryIPerspectiveListener.h>

Inheritance diagram for berry::IPerspectiveListener:

Classes

struct  Events
 

Public Member Functions

virtual ~IPerspectiveListener ()
 
virtual Events::Types GetPerspectiveEventTypes () const =0
 
virtual void PerspectiveActivated (const SmartPointer< IWorkbenchPage > &page, const IPerspectiveDescriptor::Pointer &perspective)
 
virtual void PerspectiveChanged (const SmartPointer< IWorkbenchPage > &page, const IPerspectiveDescriptor::Pointer &perspective, const QString &changeId)
 
virtual void PerspectiveChanged (const SmartPointer< IWorkbenchPage > &page, const IPerspectiveDescriptor::Pointer &perspective, const SmartPointer< IWorkbenchPartReference > &partRef, const QString &changeId)
 
virtual void PerspectiveOpened (const SmartPointer< IWorkbenchPage > &page, const IPerspectiveDescriptor::Pointer &perspective)
 
virtual void PerspectiveClosed (const SmartPointer< IWorkbenchPage > &page, const IPerspectiveDescriptor::Pointer &perspective)
 
virtual void PerspectiveDeactivated (const SmartPointer< IWorkbenchPage > &page, const IPerspectiveDescriptor::Pointer &perspective)
 
virtual void PerspectiveSavedAs (const SmartPointer< IWorkbenchPage > &page, const IPerspectiveDescriptor::Pointer &oldPerspective, const IPerspectiveDescriptor::Pointer &newPerspective)
 
virtual void PerspectivePreDeactivate (const SmartPointer< IWorkbenchPage > &page, const IPerspectiveDescriptor::Pointer &perspective)
 

Detailed Description

Interface for listening to perspective lifecycle events.

This interface may be implemented by clients.

See also
IPageService::addPerspectiveListener(IPerspectiveListener)
PerspectiveAdapter

Definition at line 36 of file berryIPerspectiveListener.h.

Constructor & Destructor Documentation

◆ ~IPerspectiveListener()

berry::IPerspectiveListener::~IPerspectiveListener ( )
virtual

Definition at line 61 of file berryIPerspectiveListener.cpp.

Member Function Documentation

◆ GetPerspectiveEventTypes()

virtual Events::Types berry::IPerspectiveListener::GetPerspectiveEventTypes ( ) const
pure virtual

◆ PerspectiveActivated()

void berry::IPerspectiveListener::PerspectiveActivated ( const SmartPointer< IWorkbenchPage > &  page,
const IPerspectiveDescriptor::Pointer perspective 
)
virtual

Notifies this listener that a perspective in the given page has been activated.

Parameters
pagethe page containing the activated perspective
perspectivethe perspective descriptor that was activated
See also
IWorkbenchPage::setPerspective

Definition at line 65 of file berryIPerspectiveListener.cpp.

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

◆ PerspectiveChanged() [1/2]

void berry::IPerspectiveListener::PerspectiveChanged ( const SmartPointer< IWorkbenchPage > &  page,
const IPerspectiveDescriptor::Pointer perspective,
const QString &  changeId 
)
virtual

Notifies this listener that a perspective has changed in some way (for example, editor area hidden, perspective reset, view show/hide, editor open/close, etc).

Parameters
pagethe page containing the affected perspective
perspectivethe perspective descriptor
changeIdone of the CHANGE_* constants on IWorkbenchPage

Definition at line 69 of file berryIPerspectiveListener.cpp.

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

◆ PerspectiveChanged() [2/2]

virtual void berry::IPerspectiveListener::PerspectiveChanged ( const SmartPointer< IWorkbenchPage > &  page,
const IPerspectiveDescriptor::Pointer perspective,
const SmartPointer< IWorkbenchPartReference > &  partRef,
const QString &  changeId 
)
virtual

Notifies this listener that a part in the given page's perspective has changed in some way (for example, view show/hide, editor open/close, etc).

Parameters
pagethe workbench page containing the perspective
perspectivethe descriptor for the changed perspective
partRefthe reference to the affected part
changeIdone of the CHANGE_* constants on IWorkbenchPage

◆ PerspectiveClosed()

void berry::IPerspectiveListener::PerspectiveClosed ( const SmartPointer< IWorkbenchPage > &  page,
const IPerspectiveDescriptor::Pointer perspective 
)
virtual

Notifies this listener that a perspective in the given page has been closed.

Parameters
pagethe page containing the closed perspective
perspectivethe perspective descriptor that was closed
See also
IWorkbenchPage::closePerspective(IPerspectiveDescriptor, boolean, boolean)
IWorkbenchPage::closeAllPerspectives(boolean, boolean)

Definition at line 82 of file berryIPerspectiveListener.cpp.

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

◆ PerspectiveDeactivated()

void berry::IPerspectiveListener::PerspectiveDeactivated ( const SmartPointer< IWorkbenchPage > &  page,
const IPerspectiveDescriptor::Pointer perspective 
)
virtual

Notifies this listener that a perspective in the given page has been deactivated.

Parameters
pagethe page containing the deactivated perspective
perspectivethe perspective descriptor that was deactivated
See also
IWorkbenchPage::setPerspective(IPerspectiveDescriptor)

Definition at line 86 of file berryIPerspectiveListener.cpp.

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

◆ PerspectiveOpened()

void berry::IPerspectiveListener::PerspectiveOpened ( const SmartPointer< IWorkbenchPage > &  page,
const IPerspectiveDescriptor::Pointer perspective 
)
virtual

Notifies this listener that a perspective in the given page has been opened.

Parameters
pagethe page containing the opened perspective
perspectivethe perspective descriptor that was opened
See also
IWorkbenchPage::setPerspective(IPerspectiveDescriptor)

Definition at line 78 of file berryIPerspectiveListener.cpp.

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

◆ PerspectivePreDeactivate()

void berry::IPerspectiveListener::PerspectivePreDeactivate ( const SmartPointer< IWorkbenchPage > &  page,
const IPerspectiveDescriptor::Pointer perspective 
)
virtual

Notifies this listener that a perspective in the given page is about to be deactivated.

Note: This does not have the ability to veto a perspective deactivation.

Parameters
pagethe page containing the deactivated perspective
perspectivethe perspective descriptor that was deactivated
See also
IWorkbenchPage::setPerspective(IPerspectiveDescriptor)

Definition at line 95 of file berryIPerspectiveListener.cpp.

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

◆ PerspectiveSavedAs()

void berry::IPerspectiveListener::PerspectiveSavedAs ( const SmartPointer< IWorkbenchPage > &  page,
const IPerspectiveDescriptor::Pointer oldPerspective,
const IPerspectiveDescriptor::Pointer newPerspective 
)
virtual

Notifies this listener that a perspective in the given page has been saved as a new perspective with a different perspective descriptor.

Parameters
pagethe page containing the saved perspective
oldPerspectivethe old perspective descriptor
newPerspectivethe new perspective descriptor
See also
IWorkbenchPage::savePerspectiveAs(IPerspectiveDescriptor)

Definition at line 90 of file berryIPerspectiveListener.cpp.

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


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