pqTimelineModel.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 pqTimelineModel_h
#define pqTimelineModel_h

#include "pqApplicationComponentsModule.h"

#include <QStandardItemModel>

#include <memory> // for std::unique_ptr

namespace pqTimelineItemRole
{
enum Role
{
  TYPE = Qt::UserRole + 1,
  PROXY,
  TIMES,
  SOURCE_TIME,
  REGISTRATION_NAME,
  LABELS
};
};

namespace pqTimelineColumn
{
enum Column
{
  NAME = 0,
  TIMELINE,
  WIDGET,
  COUNT
};
};

namespace pqTimelineTrack
{
enum TrackType
{
  NONE = 0,
  TIME,
  SOURCE,
  ANIMATION_HEADER,
  ANIMATION
};
};

class PQAPPLICATIONCOMPONENTS_EXPORT pqTimelineModel : public QStandardItemModel
{
  Q_OBJECT
  typedef QStandardItemModel Superclass;

public:
  pqTimelineModel(QObject* parent = nullptr);
  ~pqTimelineModel() override;

  QList<QStandardItem*> createRow(
    pqTimelineTrack::TrackType type, const QString& name, QMap<int, QVariant> additionalData = {});

  void clearRows(pqTimelineTrack::TrackType type);

  void deleteRow(pqTimelineTrack::TrackType type, const QString& registrationName);

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

  void setRowEnabled(
    pqTimelineTrack::TrackType type, bool enabled, const QString& name = QString());
  bool isRowEnabled(pqTimelineTrack::TrackType type, const QString& name = QString());
  void toggleRow(pqTimelineTrack::TrackType type, const QString& name);
  void setRowsEnabled(pqTimelineTrack::TrackType type, bool enabled);

  QList<QList<QStandardItem*>> rows(pqTimelineTrack::TrackType type);

  QList<QList<QStandardItem*>> uncheckedRows(pqTimelineTrack::TrackType type);

Q_SIGNALS:
  void sourceStateChanged();
  void animationStateChanged();

private:
  Q_DISABLE_COPY(pqTimelineModel)
  struct pqInternals;
  std::unique_ptr<pqInternals> Internals;
};

#endif