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 QMITK_ABSTRACT_NODE_SELECTION_WIDGET_H
#define QMITK_ABSTRACT_NODE_SELECTION_WIDGET_H

#include <mitkDataStorage.h>
#include <mitkWeakPointer.h>
#include <mitkNodePredicateBase.h>

#include <MitkQtWidgetsExports.h>

#include <QWidget>

class QmitkAbstractDataStorageModel;
class QAbstractItemVew;

class MITKQTWIDGETS_EXPORT QmitkAbstractNodeSelectionWidget : public QWidget
{
  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>;

  NodeList GetSelectedNodes() const;

Q_SIGNALS:
  /*
  * @brief A signal that will be emitted if the selected node has changed.
  *
  * @par        nodes           A list of data nodes that are newly selected.
  */
  void CurrentSelectionChanged(NodeList nodes);

public Q_SLOTS:
  /*
  * @brief Change the selection modus of the item view's selection model.
  *
  *   If true, an incoming selection will be filtered (reduced) to only those nodes that are visible by the current view.
  *   An outgoing selection can then at most contain the filtered nodes.
  *   If false, the incoming non-visible selection will be stored and later added to the outgoing selection,
  *   to include the original selection that could not be modified.
  *   The part of the original selection, that is non-visible are the nodes, that do not fullfill the predicate.
  *
  * @par selectOnlyVisibleNodes   The bool value to define the selection modus.
  */
  void SetSelectOnlyVisibleNodes(bool selectOnlyVisibleNodes);

  /*
  * @brief Transform a list of data nodes into a model selection and set this as a new selection of the
  *        selection model of the private member item view.
  *
  *   The function filters the given list of nodes according to the 'm_SelectOnlyVisibleNodes' member variable. If
  *   necessary, the non-visible nodes are stored. This is done if 'm_SelectOnlyVisibleNodes' is false: In this case
  *   the selection may be filtered and only a subset of the selected nodes may be visible and therefore (de-)selectable
  *   in the data storage viewer. By storing the non-visible nodes it is possible to send the new, modified selection
  *   but also include the selected nodes from the original selection that could not be modified (see 'SetSelectOnlyVisibleNodes').
  *
  * @par        nodes           A list of data nodes that should be newly selected.
  */
  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);

  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 OnNodeModified(const itk::Object * /*caller*/, const itk::EventObject &);

  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 // QmitkAbstractNodeSelectionWidget_H