qSlicerTerminologyNavigatorWidget.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 __qSlicerTerminologyNavigatorWidget_h
#define __qSlicerTerminologyNavigatorWidget_h

// MRMLWidgets includes
#include "qMRMLWidget.h"

// Terminologies includes
#include "qSlicerTerminologiesModuleWidgetsExport.h"

#include "vtkSlicerTerminologyEntry.h"

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

class qSlicerTerminologyNavigatorWidgetPrivate;

class QColor;
class QTableWidgetItem;
class QItemSelection;
class vtkSlicerTerminologyCategory;
class vtkSlicerTerminologyType;

class Q_SLICER_MODULE_TERMINOLOGIES_WIDGETS_EXPORT qSlicerTerminologyNavigatorWidget : public qMRMLWidget
{
  Q_OBJECT
  QVTK_OBJECT

  Q_PROPERTY(bool anatomicRegionSectionVisible READ anatomicRegionSectionVisible WRITE setAnatomicRegionSectionVisible)
  Q_PROPERTY(bool overrideSectionVisible READ overrideSectionVisible WRITE setOverrideSectionVisible)

  enum TerminologyItemDataRole
    {
    CodingSchemeDesignatorRole = Qt::UserRole + 100,
    CodeValueRole,
    // Roles for type items referencing category
    CategoryCodingSchemeDesignatorRole,
    CategoryCodeValueRole,
    CategoryCodeMeaningRole,
    // Last role (always keep last)
    LastTerminologyRole
    };

public:
  explicit qSlicerTerminologyNavigatorWidget(QWidget* parent = nullptr);
  ~qSlicerTerminologyNavigatorWidget() override;

#ifndef __VTK_WRAP__
  class Q_SLICER_MODULE_TERMINOLOGIES_WIDGETS_EXPORT TerminologyInfoBundle
  {
  public:
    TerminologyInfoBundle();
    TerminologyInfoBundle(vtkSlicerTerminologyEntry* entry, QString name, bool nameAutoGenerated, QColor color, bool colorAutoGenerated, QColor generatedColor);
    ~TerminologyInfoBundle();
    const TerminologyInfoBundle& operator=(const TerminologyInfoBundle& other);
    vtkSlicerTerminologyEntry* GetTerminologyEntry();

    QString Name;
    bool NameAutoGenerated;
    QColor Color;
    bool ColorAutoGenerated;
    QColor GeneratedColor;
  private:
    vtkSlicerTerminologyEntry* TerminologyEntry;
  };

  void terminologyInfo(TerminologyInfoBundle &terminologyInfo);
  void setTerminologyInfo(TerminologyInfoBundle &terminologyInfo);
#endif // __VTK_WRAP__

  Q_INVOKABLE bool terminologyEntry(vtkSlicerTerminologyEntry* entry);
  Q_INVOKABLE bool setTerminologyEntry(vtkSlicerTerminologyEntry* entry);

  bool anatomicRegionSectionVisible() const;

  bool overrideSectionVisible() const;

  Q_INVOKABLE static QString nameFromTerminology(vtkSlicerTerminologyEntry* entry);
  QString nameFromCurrentTerminology();
  Q_INVOKABLE static QColor recommendedColorFromTerminology(vtkSlicerTerminologyEntry* entry);
  QColor recommendedColorFromCurrentTerminology();

public slots:
  void setAnatomicRegionSectionVisible(bool);

  void setOverrideSectionVisible(bool);

protected:
  void setCurrentTerminology(QString terminologyName);
  bool setCurrentCategory(vtkSlicerTerminologyCategory* category);
  void updateWidgetFromCurrentCategory();
  bool setCurrentType(vtkSlicerTerminologyType* type);
  bool setCurrentTypeModifier(vtkSlicerTerminologyType* modifier);
  void setCurrentAnatomicContext(QString contextName);
  bool setCurrentRegion(vtkSlicerTerminologyType* region);
  bool setCurrentRegionModifier(vtkSlicerTerminologyType* modifier);

protected:
  void populateTerminologyComboBox();
  void populateCategoryTable();
  void populateTypeTable();
  void populateTypeModifierComboBox();

  void populateAnatomicContextComboBox();
  void populateRegionTable();
  void populateRegionModifierComboBox();

  void copyContextToUserDirectory(QString filePath);

protected slots:
  void onTerminologySelectionChanged(int);
  void onCategorySelectionChanged();
  void onTypeSelected(QTableWidgetItem*, QTableWidgetItem*);
  void onTypeCellDoubleClicked(int, int);
  void onTypeModifierSelectionChanged(int);
  void onCategorySearchTextChanged(QString);
  void onTypeSearchTextChanged(QString);

  void onAnatomicContextSelectionChanged(int);
  void onRegionSelected(QTableWidgetItem*,QTableWidgetItem*);
  void onRegionModifierSelectionChanged(int);
  void onRegionSearchTextChanged(QString);

  void onNameChanged(QString);
  void onResetNameClicked();
  void onColorChanged(QColor);
  void onResetColorClicked();

  void onLoadTerminologyClicked();
  void onLoadAnatomicContextClicked();

  void anatomicalRegionExpandButtonUp();
  void anatomicalRegionExpandButtonDown();

  void onLogicModified();

signals:
  void selectionValidityChanged(bool);
  void typeDoubleClicked();

protected:
  QScopedPointer<qSlicerTerminologyNavigatorWidgetPrivate> d_ptr;

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

#endif