QmitkPropertiesTableModel.h

Go to the documentation of this file.

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

The Medical Imaging Interaction Toolkit (MITK)

Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.

Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.

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

#ifndef QmitkPropertiesTableModel_h
#define QmitkPropertiesTableModel_h

#include <MitkQtWidgetsExports.h>

//# Own includes
#include "mitkDataNode.h"
#include "mitkWeakPointer.h"

//# Toolkit includes
#include <QAbstractTableModel>
#include <string>
#include <vector>

//# Forward declarations

class MITKQTWIDGETS_EXPORT QmitkPropertiesTableModel : public QAbstractTableModel
{
  //# PUBLIC CTORS,DTOR,TYPEDEFS,CONSTANTS
public:
  static const int PROPERTY_NAME_COLUMN = 0;
  static const int PROPERTY_VALUE_COLUMN = 1;
  typedef std::pair<std::string, mitk::BaseProperty::Pointer> PropertyDataSet;

  QmitkPropertiesTableModel(QObject *parent = nullptr, mitk::PropertyList::Pointer _PropertyList = nullptr);

  ~QmitkPropertiesTableModel() override;

  //# PUBLIC GETTER
public:
  mitk::PropertyList::Pointer GetPropertyList() const;

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

  QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const override;

  QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const override;

  int rowCount(const QModelIndex &parent = QModelIndex()) const override;

  int columnCount(const QModelIndex &parent) const override;

  //# PUBLIC SETTER
public:
  void SetPropertyList(mitk::PropertyList *_PropertyList);

  virtual void PropertyListDelete();

  virtual void PropertyModified(const itk::Object *caller, const itk::EventObject &event);

  virtual void PropertyDelete(const itk::Object *caller, const itk::EventObject &event);

  virtual void SetFilterPropertiesKeyWord(std::string _FilterKeyWord);

  bool setData(const QModelIndex &index, const QVariant &value, int role) override;

  void sort(int column, Qt::SortOrder order = Qt::AscendingOrder) override;

  //#PROTECTED INNER CLASSES
protected:
  struct PropertyDataSetCompareFunction : public std::binary_function<PropertyDataSet, PropertyDataSet, bool>
  {
    enum CompareCriteria
    {
      CompareByName = 0,
      CompareByValue
    };

    enum CompareOperator
    {
      Less = 0,
      Greater
    };

    PropertyDataSetCompareFunction(CompareCriteria _CompareCriteria = CompareByName,
                                   CompareOperator _CompareOperator = Less);
    bool operator()(const PropertyDataSet &_Left, const PropertyDataSet &_Right) const;

  protected:
    CompareCriteria m_CompareCriteria;
    CompareOperator m_CompareOperator;
  };

  struct PropertyListElementFilterFunction : public std::unary_function<PropertyDataSet, bool>
  {
    PropertyListElementFilterFunction(const std::string &m_FilterKeyWord);
    bool operator()(const PropertyDataSet &_Elem) const;

  protected:
    std::string m_FilterKeyWord;
  };

  //# PROTECTED GETTER
protected:
  int FindProperty(const mitk::BaseProperty *_Property) const;

  //# PROTECTED SETTER
protected:
  void AddSelectedProperty(PropertyDataSet &_PropertyDataSet);
  void RemoveSelectedProperty(unsigned int _Index);
  void Reset();

  //# PROTECTED MEMBERS
protected:
  mitk::WeakPointer<mitk::PropertyList> m_PropertyList;

  std::vector<PropertyDataSet> m_SelectedProperties;

  std::vector<unsigned long> m_PropertyModifiedObserverTags;

  std::vector<unsigned long> m_PropertyDeleteObserverTags;

  unsigned long m_PropertyListDeleteObserverTag;

  bool m_BlockEvents;

  bool m_SortDescending;

  std::string m_FilterKeyWord;
};

#endif /* QMITKPROPERTIESTABLEMODEL_H_ */