qMRMLSortFilterProxyModel.h

Go to the documentation of this file.

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

  Program: 3D Slicer

  Copyright (c) Kitware Inc.

  See COPYRIGHT.txt
  or http://www.slicer.org/copyright/copyright.txt for details.

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.

  This file was originally developed by Julien Finet, Kitware Inc.
  and was partially funded by NIH grant 3P41RR013218-12S1

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

#ifndef __qMRMLSortFilterProxyModel_h
#define __qMRMLSortFilterProxyModel_h

// Qt includes
#include <QSortFilterProxyModel>
#include <QStringList>
class QStandardItem;

// CTK includes
#include <ctkVTKObject.h>

// qMRML includes
#include "qMRMLWidgetsExport.h"

class vtkMRMLNode;
class vtkMRMLScene;
class qMRMLAbstractItemHelper;
class qMRMLSceneModel;
class qMRMLSortFilterProxyModelPrivate;

class QMRML_WIDGETS_EXPORT qMRMLSortFilterProxyModel : public QSortFilterProxyModel
{
  Q_OBJECT
  QVTK_OBJECT

  Q_PROPERTY(QStringList nodeTypes READ nodeTypes WRITE setNodeTypes)

  
  Q_PROPERTY(bool showHidden READ showHidden WRITE setShowHidden)

  
  Q_PROPERTY(QStringList showHiddenForTypes READ showHiddenForTypes WRITE setShowHiddenForTypes)

  
  Q_PROPERTY(bool showChildNodeTypes READ showChildNodeTypes WRITE setShowChildNodeTypes)

  
  Q_PROPERTY(QStringList hideChildNodeTypes READ hideChildNodeTypes WRITE setHideChildNodeTypes)

  
  Q_PROPERTY(FilterType filterType READ filterType WRITE setFilterType)
  Q_ENUMS(FilterType)
  Q_PROPERTY(bool showAll READ showAll WRITE setShowAll STORED false)
  Q_PROPERTY(bool hideAll READ hideAll WRITE setHideAll STORED false)

  Q_PROPERTY(QStringList hiddenNodeIDs READ hiddenNodeIDs WRITE setHiddenNodeIDs)

  Q_PROPERTY(QStringList visibleNodeIDs READ visibleNodeIDs WRITE setVisibleNodeIDs)

  Q_PROPERTY(QString hideNodesUnaffiliatedWithNodeID READ hideNodesUnaffiliatedWithNodeID WRITE setHideNodesUnaffiliatedWithNodeID)

public:
  enum FilterType
    {
    HideAll = 0,
    ShowAll,
    UseFilters
    };

  typedef QSortFilterProxyModel Superclass;
  qMRMLSortFilterProxyModel(QObject *parent=nullptr);
  ~qMRMLSortFilterProxyModel() override;

  vtkMRMLScene* mrmlScene()const;

  Q_INVOKABLE QModelIndex mrmlSceneIndex()const;

  Q_INVOKABLE vtkMRMLNode* mrmlNodeFromIndex(const QModelIndex& index)const;

  Q_INVOKABLE QModelIndex indexFromMRMLNode(vtkMRMLNode* node, int column = 0)const;

  QStringList nodeTypes()const;
  void setNodeTypes(const QStringList& nodeTypes);

  bool showHidden()const;

  QStringList showHiddenForTypes()const;
  void setShowHiddenForTypes(const QStringList& nodeTypes);

  Q_INVOKABLE void addAttribute(const QString& nodeType,
                    const QString& attributeName,
                    const QVariant& attributeValue = QVariant());
  Q_INVOKABLE void removeAttribute(const QString& nodeType, const QString& attributeName);

  Q_INVOKABLE QVariant attributeFilter(
    const QString& nodeType, const QString& attributeName) const;

  void setShowChildNodeTypes(bool show);
  bool showChildNodeTypes()const;

  void setHideChildNodeTypes(const QStringList& nodeTypes);
  QStringList hideChildNodeTypes()const;

  void setHiddenNodeIDs(const QStringList& nodeIDsToHide);
  QStringList hiddenNodeIDs()const;

  void setVisibleNodeIDs(const QStringList& nodeIDsToShow);
  QStringList visibleNodeIDs()const;

  void setHideNodesUnaffiliatedWithNodeID(const QString& nodeID);
  QString hideNodesUnaffiliatedWithNodeID()const;

  FilterType filterType()const;
  bool showAll()const;
  bool hideAll()const;

  Q_INVOKABLE qMRMLSceneModel* sceneModel()const;

public slots:
  void setShowHidden(bool);

  void setFilterType(FilterType filterType);
  void setShowAll(bool show);
  void setHideAll(bool hide);

  // TODO Add setMRMLScene() to propagate to the scene model
protected:
  enum AcceptType
  {
    Reject = 0,
    Accept,
    RejectButPotentiallyAcceptable,
    AcceptButPotentiallyRejectable,
  };
  bool filterAcceptsRow(int source_row,
                                const QModelIndex &source_parent)const override;
  virtual AcceptType filterAcceptsNode(vtkMRMLNode* node)const;

  QStandardItem* sourceItem(const QModelIndex& index)const;

protected:
  QScopedPointer<qMRMLSortFilterProxyModelPrivate> d_ptr;

private:
  Q_DECLARE_PRIVATE(qMRMLSortFilterProxyModel);
  Q_DISABLE_COPY(qMRMLSortFilterProxyModel);
};

#endif