QmitkAbstractNodeSelectionWidget.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 QmitkAbstractNodeSelectionWidget_h
#define QmitkAbstractNodeSelectionWidget_h
 
#include <MitkQtWidgetsExports.h>
 
#include <mitkDataStorage.h>
#include <mitkINodeSelectionListener.h>
#include <mitkWeakPointer.h>
#include <mitkNodePredicateBase.h>
 
#include <QWidget>
 
class QmitkAbstractDataStorageModel;
 
class MITKQTWIDGETS_EXPORT QmitkAbstractNodeSelectionWidget : public QWidget, public mitk::INodeSelectionListener
{
  Q_OBJECT
 
public:
  explicit QmitkAbstractNodeSelectionWidget(QWidget* parent = nullptr);
  virtual ~QmitkAbstractNodeSelectionWidget() override;
 
  void SetDataStorage(mitk::DataStorage* dataStorage);
 
  void SetNodePredicate(const mitk::NodePredicateBase* nodePredicate);
 
  const mitk::NodePredicateBase* GetNodePredicate() const;
 
  QString GetInvalidInfo() const;
  QString GetEmptyInfo() const;
  QString GetPopUpTitel() const;
  QString GetPopUpHint() const;
 
  bool GetSelectionIsOptional() const;
 
  bool GetSelectOnlyVisibleNodes() const;
 
  using NodeList = QList<mitk::DataNode::Pointer>;
  using ConstNodeStdVector = std::vector<mitk::DataNode::ConstPointer>;
 
  NodeList GetSelectedNodes() const;
  ConstNodeStdVector GetSelectedNodesStdVector() const;
 
  void OnSelectionReceived(const std::string& context, const std::vector<mitk::DataNode::Pointer>& selection) override;
 
Q_SIGNALS:
  void CurrentSelectionChanged(NodeList nodes);
 
public Q_SLOTS:
  void SetSelectOnlyVisibleNodes(bool selectOnlyVisibleNodes);
 
  void SetCurrentSelection(NodeList selectedNodes);
 
  void SetInvalidInfo(QString info);
 
  void SetEmptyInfo(QString info);
 
  void SetPopUpTitel(QString info);
 
  void SetPopUpHint(QString info);
 
  void SetSelectionIsOptional(bool isOptional);
 
protected Q_SLOTS:
  void RemoveNodeFromSelection(const mitk::DataNode* node);
 
protected:
  virtual void UpdateInfo() = 0;
 
  virtual void OnNodePredicateChanged();
 
  virtual void OnDataStorageChanged();
 
  virtual void OnInternalSelectionChanged();
 
  virtual void OnNodeAddedToStorage(const mitk::DataNode* node);
 
  virtual void OnNodeRemovedFromStorage(const mitk::DataNode* node);
 
  virtual void OnNodeModified(const itk::Object* caller, const itk::EventObject& event);
 
  void HandleChangeOfInternalSelection(NodeList newInternalSelection);
 
  NodeList CompileEmitSelection() const;
 
  virtual void ReviseSelectionChanged(const NodeList& oldInternalSelection, NodeList& newInternalSelection);
 
  virtual bool AllowEmissionOfSelection(const NodeList& emissionCandidates) const;
 
  void EmitSelection(const NodeList& emissionCandidates);
 
  void SetCurrentInternalSelection(NodeList selectedNodes);
  const NodeList& GetCurrentInternalSelection() const;
  const NodeList& GetCurrentExternalSelection() const;
 
  mitk::WeakPointer<mitk::DataStorage> m_DataStorage;
  mitk::NodePredicateBase::ConstPointer m_NodePredicate;
 
  QString m_InvalidInfo;
  QString m_EmptyInfo;
  QString m_PopUpTitel;
  QString m_PopUpHint;
 
  bool m_IsOptional;
  bool m_SelectOnlyVisibleNodes;
 
private:
  void SetDataStorageDeleted();
 
  void NodeAddedToStorage(const mitk::DataNode* node);
 
  void NodeRemovedFromStorage(const mitk::DataNode* node);
 
  void AddNodeObserver(mitk::DataNode* node);
  void RemoveNodeObserver(mitk::DataNode* node);
 
  unsigned long m_DataStorageDeletedTag;
 
  NodeList m_CurrentInternalSelection;
  NodeList m_CurrentExternalSelection;
 
  NodeList m_LastEmission;
  bool m_LastEmissionAllowance;
 
  using NodeObserverTagMapType = std::map<const mitk::DataNode*, unsigned long>;
  NodeObserverTagMapType m_NodeObserverTags;
 
  bool m_RecursionGuard;
};
 
#endif