qMRMLSegmentsTableView.h

Go to the documentation of this file.

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

  Program: 3D Slicer

  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 Csaba Pinter, PerkLab, Queen's University
  and was supported through the Applied Cancer Research Unit program of Cancer Care
  Ontario with funds provided by the Ontario Ministry of Health and Long-Term Care

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

#ifndef __qMRMLSegmentsTableView_h
#define __qMRMLSegmentsTableView_h

// Segmentations includes
#include "qSlicerSegmentationsModuleWidgetsExport.h"

// MRMLWidgets includes
#include "qMRMLWidget.h"

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

class vtkMRMLNode;
class vtkSegment;
class qMRMLSegmentsTableViewPrivate;
class QStringList;
class QTableWidget;
class QTableWidgetItem;
class QItemSelection;
class QContextMenuEvent;

class Q_SLICER_MODULE_SEGMENTATIONS_WIDGETS_EXPORT qMRMLSegmentsTableView : public qMRMLWidget
{
  Q_OBJECT
  QVTK_OBJECT

  enum SegmentTableItemDataRole
    {
    IDRole = Qt::UserRole + 1,
    VisibilityRole
    };

public:
  Q_PROPERTY(int selectionMode READ selectionMode WRITE setSelectionMode)
  Q_PROPERTY(bool headerVisible READ headerVisible WRITE setHeaderVisible)
  Q_PROPERTY(bool visibilityColumnVisible READ visibilityColumnVisible WRITE setVisibilityColumnVisible)
  Q_PROPERTY(bool colorColumnVisible READ colorColumnVisible WRITE setColorColumnVisible)
  Q_PROPERTY(bool opacityColumnVisible READ opacityColumnVisible WRITE setOpacityColumnVisible)
  Q_PROPERTY(bool readOnly READ readOnly WRITE setReadOnly)

  typedef qMRMLWidget Superclass;
  explicit qMRMLSegmentsTableView(QWidget* parent = 0);
  virtual ~qMRMLSegmentsTableView();

  Q_INVOKABLE vtkMRMLNode* segmentationNode();

  Q_INVOKABLE QTableWidget* tableWidget();

  int segmentCount() const;

  Q_INVOKABLE QStringList selectedSegmentIDs();
  Q_INVOKABLE void setSelectedSegmentIDs(QStringList segmentIDs);
  Q_INVOKABLE void clearSelection();

  Q_INVOKABLE static QString terminologyTooltipForSegment(vtkSegment* segment);

  int selectionMode();
  bool headerVisible();
  bool visibilityColumnVisible();
  bool colorColumnVisible();
  bool opacityColumnVisible();
  bool readOnly();

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

  Q_INVOKABLE QStringList displayedSegmentIDs()const;

public slots:
  void setSegmentationNode(vtkMRMLNode* node);

  virtual void setMRMLScene(vtkMRMLScene* newScene);

  void setSelectionMode(int mode);

  void setHeaderVisible(bool visible);
  void setVisibilityColumnVisible(bool visible);
  void setColorColumnVisible(bool visible);
  void setOpacityColumnVisible(bool visible);
  void setReadOnly(bool aReadOnly);

  void showOnlySelectedSegments();

  void jumpSlices();

  void moveSelectedSegmentsUp();
  void moveSelectedSegmentsDown();

signals:
  void selectionChanged(const QItemSelection &selected, const QItemSelection &deselected);

  void segmentAboutToBeModified(const QString &segmentID);

protected slots:
  void onSegmentTableItemChanged(QTableWidgetItem* changedItem);

  void onSegmentSelectionChanged(const QItemSelection &selected, const QItemSelection &deselected);

  void onVisibilityButtonClicked();
  void onVisibility3DActionToggled(bool visible);
  void onVisibility2DFillActionToggled(bool visible);
  void onVisibility2DOutlineActionToggled(bool visible);

  void populateSegmentTable();

  void updateWidgetFromMRML();

  void endProcessing();

protected:
  void setSegmentVisibility(QObject* senderObject, int visible, int visible3D, int visible2DFill, int visible2DOutline);

  virtual bool eventFilter(QObject* target, QEvent* event);

  virtual void contextMenuEvent(QContextMenuEvent* event);

protected:
  QScopedPointer<qMRMLSegmentsTableViewPrivate> d_ptr;

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

#endif