berryIPerspectiveListener.h

Go to the documentation of this file.

/*============================================================================

The Medical Imaging Interaction Toolkit (MITK)

Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.

Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.

============================================================================*/


#ifndef BERRYIPERSPECTIVELISTENER_H_
#define BERRYIPERSPECTIVELISTENER_H_

#include <org_blueberry_ui_qt_Export.h>
#include "berryIPerspectiveDescriptor.h"
#include "berryIWorkbenchPartReference.h"

#include <berryMacros.h>

namespace berry {

struct IWorkbenchPage;

struct BERRY_UI_QT IPerspectiveListener
{

  struct Events {

    enum Type {
      NONE           = 0x00000000,
      ACTIVATED      = 0x00000001,
      CHANGED        = 0x00000002,
      PART_CHANGED   = 0x00000004,
      OPENED         = 0x00000008,
      CLOSED         = 0x00000010,
      DEACTIVATED    = 0x00000020,
      SAVED_AS       = 0x00000040,
      PRE_DEACTIVATE = 0x00000080,

      ALL            = 0xffffffff
    };

    Q_DECLARE_FLAGS(Types, Type)

    Message2<const SmartPointer<IWorkbenchPage>&, const IPerspectiveDescriptor::Pointer&> perspectiveActivated;
    Message3<const SmartPointer<IWorkbenchPage>&, const IPerspectiveDescriptor::Pointer&, const QString&> perspectiveChanged;
    Message4<const SmartPointer<IWorkbenchPage>&, const IPerspectiveDescriptor::Pointer&, const SmartPointer<IWorkbenchPartReference>&, const QString&> perspectivePartChanged;
    Message2<const SmartPointer<IWorkbenchPage>&, const IPerspectiveDescriptor::Pointer&> perspectiveOpened;
    Message2<const SmartPointer<IWorkbenchPage>&, const IPerspectiveDescriptor::Pointer&> perspectiveClosed;
    Message2<const SmartPointer<IWorkbenchPage>&, const IPerspectiveDescriptor::Pointer&> perspectiveDeactivated;
    Message3<const SmartPointer<IWorkbenchPage>&, const IPerspectiveDescriptor::Pointer&, const IPerspectiveDescriptor::Pointer&> perspectiveSavedAs;
    Message2<const SmartPointer<IWorkbenchPage>&, const IPerspectiveDescriptor::Pointer&> perspectivePreDeactivate;

    void AddListener(IPerspectiveListener* l);
    void RemoveListener(IPerspectiveListener* l);

  private:

    typedef MessageDelegate2<IPerspectiveListener, const SmartPointer<IWorkbenchPage>&, const IPerspectiveDescriptor::Pointer& > Delegate2;
    typedef MessageDelegate3<IPerspectiveListener, const SmartPointer<IWorkbenchPage>&, const IPerspectiveDescriptor::Pointer&, const QString&> PerspChangedDelegate;
    typedef MessageDelegate3<IPerspectiveListener, const SmartPointer<IWorkbenchPage>&, const IPerspectiveDescriptor::Pointer&, const IPerspectiveDescriptor::Pointer&> PerspSavedAsDelegate;
    typedef MessageDelegate4<IPerspectiveListener, const SmartPointer<IWorkbenchPage>&, const IPerspectiveDescriptor::Pointer&, const SmartPointer<IWorkbenchPartReference>&, const QString&> PerspPartChangedDelegate;

  };

  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);
};

}

Q_DECLARE_OPERATORS_FOR_FLAGS(berry::IPerspectiveListener::Events::Types)

#endif /* BERRYIPERSPECTIVELISTENER_H_ */