berryIPartListener.h

Go to the documentation of this file.

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

BlueBerry Platform

Copyright (c) German Cancer Research Center,
Division of Medical and Biological Informatics.
All rights reserved.

This software is distributed WITHOUT ANY WARRANTY; without
even the implied warranty of MERCHANTABILITY or FITNESS FOR
A PARTICULAR PURPOSE.

See LICENSE.txt or http://www.mitk.org for details.

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

#ifndef BERRYIPARTLISTENER_H_
#define BERRYIPARTLISTENER_H_

#include <berryMacros.h>
#include <berryMessage.h>

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

namespace berry {

struct BERRY_UI_QT IPartListener
{

  struct Events {

    enum Type {
      NONE           = 0x00000000,
      ACTIVATED      = 0x00000001,
      BROUGHT_TO_TOP = 0x00000002,
      CLOSED         = 0x00000004,
      DEACTIVATED    = 0x00000008,
      OPENED         = 0x00000010,
      HIDDEN         = 0x00000020,
      VISIBLE        = 0x00000040,
      INPUT_CHANGED  = 0x00000080,

      ALL            = 0xffffffff
    };

    Q_DECLARE_FLAGS(Types, Type)

    typedef Message1<const IWorkbenchPartReference::Pointer&> PartEvent;

    PartEvent partActivated;
    PartEvent partBroughtToTop;
    PartEvent partClosed;
    PartEvent partDeactivated;
    PartEvent partOpened;
    PartEvent partHidden;
    PartEvent partVisible;
    PartEvent partInputChanged;

    void AddListener(IPartListener* listener);
    void RemoveListener(IPartListener* listener);

  private:
    typedef MessageDelegate1<IPartListener, const IWorkbenchPartReference::Pointer&> Delegate;
  };

  virtual ~IPartListener();

  virtual Events::Types GetPartEventTypes() const = 0;

  virtual void PartActivated(const IWorkbenchPartReference::Pointer& /*partRef*/) {}

  virtual void PartBroughtToTop(const IWorkbenchPartReference::Pointer& /*partRef*/) {}

  virtual void PartClosed(const IWorkbenchPartReference::Pointer& /*partRef*/) {}

  virtual void PartDeactivated(const IWorkbenchPartReference::Pointer& /*partRef*/) {}

  virtual void PartOpened(const IWorkbenchPartReference::Pointer& /*partRef*/) {}

  virtual void PartHidden(const IWorkbenchPartReference::Pointer& /*partRef*/) {}

  virtual void PartVisible(const IWorkbenchPartReference::Pointer& /*partRef*/) {}

  virtual void PartInputChanged(const IWorkbenchPartReference::Pointer& /*partRef*/) {}
};

}  // namespace berry

Q_DECLARE_OPERATORS_FOR_FLAGS(berry::IPartListener::Events::Types)

#endif /*BERRYIPARTLISTENER_H_*/