qMRMLSortFilterSegmentsProxyModel.h

Go to the documentation of this file.

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

  Copyright (c) Laboratory for Percutaneous Surgery (PerkLab)
  Queen's University, Kingston, ON, Canada. All Rights Reserved.

  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 Kyle Sunderland, PerkLab, Queen's University
  and was supported through CANARIE's Research Software Program, and Cancer
  Care Ontario.

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

#ifndef __qMRMLSortFilterSegmentsProxyModel_h
#define __qMRMLSortFilterSegmentsProxyModel_h

// Segmentation includes
#include "qSlicerSegmentationsModuleWidgetsExport.h"

// Qt includes
#include <QSortFilterProxyModel>

// CTK includes
#include <ctkVTKObject.h>
#include <ctkPimpl.h>

class qMRMLSortFilterSegmentsProxyModelPrivate;
class QStandardItem;
class vtkMRMLSegmentationNode;
class vtkMRMLScene;

class Q_SLICER_MODULE_SEGMENTATIONS_WIDGETS_EXPORT qMRMLSortFilterSegmentsProxyModel : public QSortFilterProxyModel
{
  Q_OBJECT
  QVTK_OBJECT

  Q_PROPERTY(bool filterEnabled READ filterEnabled WRITE setFilterEnabled)
  Q_PROPERTY(QString nameFilter READ nameFilter WRITE setNameFilter)
  Q_PROPERTY(QString textFilter READ textFilter WRITE setTextFilter)

public:
  typedef QSortFilterProxyModel Superclass;
  qMRMLSortFilterSegmentsProxyModel(QObject *parent=nullptr);
  ~qMRMLSortFilterSegmentsProxyModel() override;

  Q_INVOKABLE vtkMRMLSegmentationNode* segmentationNode()const;

  Q_INVOKABLE void setHideSegments(const QStringList& segmentIDs);
  Q_INVOKABLE QStringList hideSegments()const;

  bool filterEnabled()const;
  QString nameFilter()const;
  QString textFilter()const;

  Q_INVOKABLE bool showStatus(int status) const;

  Q_INVOKABLE QString segmentIDFromIndex(const QModelIndex& index)const;

  Q_INVOKABLE QModelIndex indexFromSegmentID(QString segmentID, int column=0)const;

  bool filterAcceptsRow(int sourceRow, const QModelIndex &sourceParent)const override;

  virtual bool filterAcceptsItem(QString segmentID)const;

  Qt::ItemFlags flags(const QModelIndex & index)const override;

  Q_INVOKABLE void setShowStatus(int status, bool shown);

public slots:
  void setFilterEnabled(bool filterEnabled);
  void setNameFilter(QString filter);
  void setTextFilter(QString filter);

signals:
  void filterModified();

protected:
  QStandardItem* sourceItem(const QModelIndex& index)const;

protected:
  QScopedPointer<qMRMLSortFilterSegmentsProxyModelPrivate> d_ptr;

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

#endif