qSlicerTerminologyNavigatorWidget.h

Go to the documentation of this file.

/*==============================================================================
 
  Program: 3D Slicer
 
  Copyright (c) Seattle Children�s Hospital d/b/a Seattle Children�s Research Institute.
 
  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 partially 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
  and by Murat Maga (Seattle Children's Research Institute).
 
==============================================================================*/
 
#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 regionSectionVisible READ regionSectionVisible WRITE setRegionSectionVisible)
  Q_PROPERTY(bool overrideSectionVisible READ overrideSectionVisible WRITE setOverrideSectionVisible)

  enum TerminologyItemDataRole
  {
    TerminologyRole = Qt::UserRole + 9,
    DefaultTerminologyRole,
    NameRole,
    NameAutoGeneratedRole,
    ColorRole,
    ColorAutoGeneratedRole,
    GeneratedColorRole
  };

  enum TableItemDataRole
  {
    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{ true }; // indicates that the name does not contain valuable information
    QColor Color;
    bool ColorAutoGenerated{ true }; // indicates that the color does not contain valuable information
    QColor GeneratedColor;
 
  private:
    vtkSlicerTerminologyEntry* TerminologyEntry{ nullptr };
  };

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

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

  bool regionSectionVisible() 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 setRegionSectionVisible(bool);

  void setOverrideSectionVisible(bool);
 
protected slots:
  void onTerminologySelectionChanged(int);
  void onCategorySelectionChanged();
  void onSelectAllCategoriesButtonClicked();
  void onTypeSelected(QTableWidgetItem*, QTableWidgetItem*);
  void onTypeCellDoubleClicked(int, int);
  void onTypeModifierSelectionChanged(int);
  void onCategorySearchTextChanged(QString);
  void onTypeSearchTextChanged(QString);
 
  void onRegionContextSelectionChanged(int);
  void onRegionSelected(QTableWidgetItem*, QTableWidgetItem*);
  void onRegionModifierSelectionChanged(int);
  void onRegionSearchTextChanged(QString);
 
  void onColorSelected(const QItemSelection& selected, const QItemSelection& deselected);
  void onColorRowDoubleClicked(const QModelIndex& index);
 
  void onNameChanged(QString);
  void onResetNameClicked();
  void onColorChanged(QColor);
  void onResetColorClicked();
 
  void onLoadTerminologyClicked();
  void onLoadRegionContextClicked();
 
  void onRegionExpandButtonUp();
  void onRegionExpandButtonDown();
 
  void onLogicModified();
 
  // Set focus on color item in list, name editor or property name search box so that the user can just start typing.
  void setInitialFocus();
 
signals:
  void selectionValidityChanged(bool);
  void typeDoubleClicked();
  void colorDoubleClicked();
 
protected:
  QScopedPointer<qSlicerTerminologyNavigatorWidgetPrivate> d_ptr;
 
private:
  Q_DECLARE_PRIVATE(qSlicerTerminologyNavigatorWidget);
  Q_DISABLE_COPY(qSlicerTerminologyNavigatorWidget);
};
 
#endif