berry::IPartListener Struct Reference

#include <berryIPartListener.h>

Inheritance diagram for berry::IPartListener:

Classes
struct	Events

Public Member Functions
virtual	~IPartListener ()
virtual Events::Types	GetPartEventTypes () const =0
virtual void	PartActivated (const IWorkbenchPartReference::Pointer &)
virtual void	PartBroughtToTop (const IWorkbenchPartReference::Pointer &)
virtual void	PartClosed (const IWorkbenchPartReference::Pointer &)
virtual void	PartDeactivated (const IWorkbenchPartReference::Pointer &)
virtual void	PartOpened (const IWorkbenchPartReference::Pointer &)
virtual void	PartHidden (const IWorkbenchPartReference::Pointer &)
virtual void	PartVisible (const IWorkbenchPartReference::Pointer &)
virtual void	PartInputChanged (const IWorkbenchPartReference::Pointer &)

Detailed Description

Interface for listening to part lifecycle events.

This interface may be implemented by clients.

See also

IPartService::AddPartListener(IPartListener)

Definition at line 34 of file berryIPartListener.h.

Constructor & Destructor Documentation

~IPartListener()

berry::IPartListener::~IPartListener ( )

virtual

Definition at line 59 of file berryIPartListener.cpp.

Member Function Documentation

GetPartEventTypes()

virtual Events::Types berry::IPartListener::GetPartEventTypes ( ) const

pure virtual

Implemented in QmitkAbstractMultiWidgetEditor, QmitkStdMultiWidgetEditor, and QmitkFunctionalityCoordinator.

Referenced by berry::IPartListener::Events::AddListener().

PartActivated()

virtual void berry::IPartListener::PartActivated ( const IWorkbenchPartReference::Pointer &  )

inlinevirtual

Notifies this listener that the given part has been activated.

Parameters

partRef

the part that was activated

See also

IWorkbenchPage::activate

Reimplemented in QmitkFunctionalityCoordinator.

Definition at line 83 of file berryIPartListener.h.

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

PartBroughtToTop()

virtual void berry::IPartListener::PartBroughtToTop ( const IWorkbenchPartReference::Pointer &  )

inlinevirtual

Notifies this listener that the given part has been brought to the top.

These events occur when an editor is brought to the top in the editor area, or when a view is brought to the top in a page book with multiple views. They are normally only sent when a part is brought to the top programmatically (via IPerspective.bringToTop). When a part is activated by the user clicking on it, only partActivated is sent.

Parameters

partRef

the part that was surfaced

See also

IWorkbenchPage::bringToTop

Definition at line 98 of file berryIPartListener.h.

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

PartClosed()

virtual void berry::IPartListener::PartClosed ( const IWorkbenchPartReference::Pointer &  )

inlinevirtual

Notifies this listener that the given part has been closed.

Note that if other perspectives in the same page share the view, this notification is not sent. It is only sent when the view is being removed from the page entirely (it is being disposed).

Parameters

partRef

the part that was closed

See also

IWorkbenchPage::hideView

Reimplemented in QmitkAbstractMultiWidgetEditor, QmitkFunctionalityCoordinator, and QmitkStdMultiWidgetEditor.

Definition at line 111 of file berryIPartListener.h.

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

PartDeactivated()

virtual void berry::IPartListener::PartDeactivated ( const IWorkbenchPartReference::Pointer &  )

inlinevirtual

Notifies this listener that the given part has been deactivated.

Parameters

partRef

the part that was deactivated

See also

IWorkbenchPage::activate

Reimplemented in QmitkFunctionalityCoordinator.

Definition at line 119 of file berryIPartListener.h.

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

PartHidden()

virtual void berry::IPartListener::PartHidden ( const IWorkbenchPartReference::Pointer &  )

inlinevirtual

Notifies this listener that the given part is hidden or obscured by another part.

Parameters

partRef

the part that is hidden or obscured by another part

Reimplemented in QmitkFunctionalityCoordinator, and QmitkStdMultiWidgetEditor.

Definition at line 139 of file berryIPartListener.h.

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

PartInputChanged()

virtual void berry::IPartListener::PartInputChanged ( const IWorkbenchPartReference::Pointer &  )

inlinevirtual

Notifies this listener that the given part's input was changed.

Parameters

partRef

the part whose input was changed

Definition at line 153 of file berryIPartListener.h.

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

PartOpened()

virtual void berry::IPartListener::PartOpened ( const IWorkbenchPartReference::Pointer &  )

inlinevirtual

Notifies this listener that the given part has been opened.

Note that if other perspectives in the same page share the view, this notification is not sent. It is only sent when the view is being newly opened in the page (it is being created).

Parameters

partRef

the part that was opened

See also

IWorkbenchPage::showView

Reimplemented in QmitkAbstractMultiWidgetEditor, QmitkFunctionalityCoordinator, and QmitkStdMultiWidgetEditor.

Definition at line 132 of file berryIPartListener.h.

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

PartVisible()

virtual void berry::IPartListener::PartVisible ( const IWorkbenchPartReference::Pointer &  )

inlinevirtual

Notifies this listener that the given part is visible.

Parameters

partRef

the part that is visible

Reimplemented in QmitkFunctionalityCoordinator, and QmitkStdMultiWidgetEditor.

Definition at line 146 of file berryIPartListener.h.

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

---

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

• berryIPartListener.h
• berryIPartListener.cpp