pqSpreadSheetViewModel.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-FileCopyrightText: Copyright (c) Sandia Corporation
// SPDX-License-Identifier: BSD-3-Clause
#ifndef pqSpreadSheetViewModel_h
#define pqSpreadSheetViewModel_h

#include "pqCoreModule.h"
#include "vtkTuple.h" // needed for vtkTuple.
#include "vtkType.h"  // needed for vtkIdType.
#include <QAbstractTableModel>
#include <QPair>
#include <QSet>

class pqDataRepresentation;
class QItemSelection;
class QItemSelectionModel;
class vtkObject;
class vtkSelection;
class vtkSelectionNode;
class vtkSMProxy;
class vtkSpreadSheetView;

class PQCORE_EXPORT pqSpreadSheetViewModel : public QAbstractTableModel
{
  Q_OBJECT
  typedef QAbstractTableModel Superclass;

public:
  pqSpreadSheetViewModel(vtkSMProxy* viewProxy, QObject* parent = nullptr);
  ~pqSpreadSheetViewModel() override;

  class vtkIndex : public vtkTuple<vtkIdType, 3>
  {
  };

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

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

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

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

  bool setHeaderData(
    int section, Qt::Orientation orientation, const QVariant& value, int role) override;

  void sortSection(int section, Qt::SortOrder order);

  bool isSortable(int section);

  int getFieldType() const;

  // Returns the vtk indices for the view indices.
  QSet<vtkIndex> getVTKIndices(const QModelIndexList& indexes);

  void setDecimalPrecision(int);
  int getDecimalPrecision();

  void setFixedRepresentation(bool);
  bool getFixedRepresentation();

  void setActiveRegion(int row_top, int row_bottom);

  pqDataRepresentation* activeRepresentation() const;
  vtkSMProxy* activeRepresentationProxy() const;

  Qt::ItemFlags flags(const QModelIndex& index) const override;
  bool setData(const QModelIndex& index, const QVariant& value, int role = Qt::EditRole) override;

  enum
  {
    SectionInternal = Qt::UserRole + 1,
    SectionVisible,
    // This value can be temporarily set by a caller, and if it is set, the header display
    // string will be returned as being the number of 'a' characters that is returned as
    // an int value.
    // The default value is -1, which will return the real header string
    // note: The purpose of this is the proper calculation of display width of columns for
    // a multi-component column
    SectionHeaderTemp
  };

  QString GetRowsAsString() const;

public Q_SLOTS: // NOLINT(readability-redundant-access-specifiers)
  void forceUpdate();

  void setActiveRepresentation(pqDataRepresentation*);

  void setActiveRepresentationProxy(vtkSMProxy*);

Q_SIGNALS:
  void selectionChanged(const QItemSelection& selection);

private Q_SLOTS:
  void delayedUpdate();

  void triggerSelectionChanged();

  void onDataFetched(vtkObject*, unsigned long, void*, void* call_data);

  void hiddenColumnsChanged();

protected:
  bool isDataValid(const QModelIndex& idx) const;

  vtkSpreadSheetView* GetView() const;

private:
  Q_DISABLE_COPY(pqSpreadSheetViewModel)

  class pqInternal;
  pqInternal* Internal;

  vtkSMProxy* ViewProxy;
};

#endif