QmitkModelViewSelectionConnector.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 QMITKMODELVIEWSELECTIONCONNECTOR_H
#define QMITKMODELVIEWSELECTIONCONNECTOR_H

#include <MitkQtWidgetsExports.h>

// qt widgets module
#include <QmitkAbstractDataStorageModel.h>

 // qt
#include <QAbstractItemView>

class MITKQTWIDGETS_EXPORT QmitkModelViewSelectionConnector : public QObject
{
  Q_OBJECT

public:

  QmitkModelViewSelectionConnector();
  void SetView(QAbstractItemView* view);

  QList<mitk::DataNode::Pointer> GetSelectedNodes() const;

  bool GetSelectOnlyVisibleNodes() const;

Q_SIGNALS:
  void CurrentSelectionChanged(QList<mitk::DataNode::Pointer> nodes);

public Q_SLOTS:
  void SetSelectOnlyVisibleNodes(bool selectOnlyVisibleNodes);

  void SetCurrentSelection(QList<mitk::DataNode::Pointer> selectedNodes);

private Q_SLOTS:
  void ChangeModelSelection(const QItemSelection& selected, const QItemSelection& deselected);

private:

  QmitkAbstractDataStorageModel* m_Model;
  QAbstractItemView* m_View;

  bool m_SelectOnlyVisibleNodes;
  QList<mitk::DataNode::Pointer> m_NonVisibleSelection;

  /*
  * @brief      Retrieve the currently selected nodes from the selection model of the private member item view by
  *         transforming the selection indexes into a data node list.
  *
  *   In order to transform the indices into data nodes, the private data storage model must return
  *   'mitk::DataNode::Pointer' objects for model indexes if the role is QmitkDataNodeRole.
  */
  QList<mitk::DataNode::Pointer> GetInternalSelectedNodes() const;
  /*
  * @brief Filter the list of given nodes such that only those nodes are used that are valid
  *        when using the data storage model's node predicate.
  *        If no node predicate was set or the data storage model is invalid, the input list
  *        of given nodes is returned.
  */
  QList<mitk::DataNode::Pointer> FilterNodeList(const QList<mitk::DataNode::Pointer>& nodes) const;
};

/*
* @brief Return true, if the nodes in the list of two given selections are equal (Sorting is ignored. Any permutation is valid.)*/
bool MITKQTWIDGETS_EXPORT EqualNodeSelections(const QList<mitk::DataNode::Pointer>& selection1, const QList<mitk::DataNode::Pointer>& selection2);

#endif // QMITKMODELVIEWSELECTIONCONNECTOR_H