QmitkFunctionality.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 QMITKFUNCTIONALITY_H_
#define QMITKFUNCTIONALITY_H_

//# blueberry stuff
#include <berryQtViewPart.h>
#include <berryIPreferencesService.h>
#include <berryISelectionListener.h>

#include <berryIPreferences.h>

//# mitk stuff
#include <org_mitk_gui_qt_common_legacy_Export.h>
#include "mitkDataNodeSelection.h"
#include <mitkDataStorage.h>
#include <mitkIDataStorageService.h>
#include <mitkIDataStorageReference.h>
#include <QmitkAbstractMultiWidget.h>

// CTK Includes
#include <ctkServiceTracker.h>


//# forward declarations

namespace mitk {
  class DataNode;
  struct IDataStorageService;
}

namespace berry {
  struct IBerryPreferences;
}

class QmitkFunctionalitySelectionProvider;

class MITK_QT_COMMON_LEGACY QmitkFunctionality : public berry::QtViewPart
{

//# public virtual methods which can be overwritten
public:
  berryObjectMacro(QmitkFunctionality);
  QmitkFunctionality();
  ~QmitkFunctionality() override;
  virtual void ClosePart();
  virtual void OnSelectionChanged(std::vector<mitk::DataNode*> /*nodes*/);
  virtual void OnPreferencesChanged(const berry::IBerryPreferences*);
  void SetHandleMultipleDataStorages(bool multiple);
  bool HandlesMultipleDataStorages() const;
  virtual void MultiWidgetAvailable(QmitkAbstractMultiWidget& multiWidget);
  virtual void MultiWidgetClosed(QmitkAbstractMultiWidget& multiWidget);
  virtual void MultiWidgetNotAvailable();
  virtual void Activated();
  bool IsActivated() const;
  virtual void Deactivated();
  virtual bool IsExclusiveFunctionality() const;
  void FireNodeSelected(mitk::DataNode* node);
  void FireNodesSelected(std::vector<mitk::DataNode*> nodes);
  virtual void Visible();
  bool IsVisible() const;
  virtual void Hidden();
//# protected virtual methods which can be overwritten
protected:
  virtual void NodeAdded(const mitk::DataNode* node);
  virtual void NodeChanged(const mitk::DataNode* /*node*/);
  virtual void NodeRemoved(const mitk::DataNode* node);
  virtual void DataStorageChanged();
  std::vector<mitk::DataNode*> GetCurrentSelection() const;
  std::vector<mitk::DataNode*> GetDataManagerSelection() const;
  berry::IPreferences::Pointer GetPreferences() const;
  mitk::DataStorage::Pointer GetDataStorage() const;
  mitk::DataStorage::Pointer GetDefaultDataStorage() const;

  mitk::IDataStorageReference::Pointer GetDataStorageReference() const;

  QmitkAbstractMultiWidget* GetActiveMultiWidget( bool reCreateWidget = true);
  void HandleException( std::exception& e, QWidget* parent = nullptr, bool showDialog = true ) const;
  void HandleException( const char* str, QWidget* parent = nullptr, bool showDialog = true ) const;
  void WaitCursorOn();
  void WaitCursorOff();
  void BusyCursorOn();
  void BusyCursorOff();
  void RestoreOverrideCursor();

//# other public methods which should not be overwritten
public:
  void CreatePartControl(QWidget* parent) override;
  void SetFocus() override;
  void NodeAddedProxy(const mitk::DataNode* node);
  void NodeRemovedProxy(const mitk::DataNode* node);
  void NodeChangedProxy(const mitk::DataNode* node);
  void SetVisible(bool visible);
  void SetActivated(bool activated);
  void ClosePartProxy();

//# other protected methods which should not be overwritten (or which are deprecated)
protected:
  void AfterCreateQtPartControl();
  void ActivateLastVisibleFunctionality();
  void BlueBerrySelectionChanged(const berry::IWorkbenchPart::Pointer& sourcepart, const berry::ISelection::ConstPointer& selection);
  std::vector<mitk::DataNode*> DataNodeSelectionToVector(mitk::DataNodeSelection::ConstPointer currentSelection) const;
  //# protected fields
protected:
  friend struct berry::SelectionChangedAdapter<QmitkFunctionality>;
  QWidget* m_Parent;
  bool m_Active;
  bool m_Visible;

  //# private fields:

private:
  QmitkFunctionalitySelectionProvider* m_SelectionProvider;
  QScopedPointer<berry::ISelectionListener> m_BlueBerrySelectionListener;

  ctkServiceTracker<mitk::IDataStorageService*> m_DataStorageServiceTracker;


  bool m_HandlesMultipleDataStorages;
  bool m_InDataStorageChanged;
  std::set<std::string> m_VisibleFunctionalities;
};

#endif /*QMITKFUNCTIONALITY_H_*/