pqFileDialogFavoriteModel.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 pqFileDialogFavoriteModel_h
#define pqFileDialogFavoriteModel_h
 
#include "pqCoreModule.h"
#include "vtkParaViewDeprecation.h" // for deprecation
 
#include <QAbstractListModel>
#include <QList>
#include <QObject>
#include <QPointer>
 
class vtkProcessModule;
class pqFileDialogModel;
class pqServer;
class QModelIndex;
 
class PQCORE_EXPORT pqFileDialogFavoriteModel : public QAbstractListModel
{
  typedef QAbstractListModel Superclass;
 
  Q_OBJECT
 
public:
  pqFileDialogFavoriteModel(pqFileDialogModel* model, pqServer* server, QObject* Parent);
  ~pqFileDialogFavoriteModel() override;
 
  QString filePath(const QModelIndex&) const;
  bool isDirectory(const QModelIndex&) const;
 
  QVariant data(const QModelIndex& idx, int role) const override;
 
  int rowCount(const QModelIndex& idx) const override;
 
  bool setData(const QModelIndex& index, const QVariant& value, int role = Qt::EditRole) override;
 
  Qt::ItemFlags flags(const QModelIndex& index) const override;
 
  QVariant headerData(int section, Qt::Orientation, int role) const override;
 
  virtual void addToFavorites(QString const& dirPath);
 
  virtual void removeFromFavorites(QString const& dirPath);
 
  virtual void resetFavoritesToDefault();
 
  PARAVIEW_DEPRECATED_IN_5_12_0("Use pqFileDialogLocationModel::AddExamplesInLocations instead")
  static bool AddExamplesInFavorites;
 
protected:
  struct pqFileDialogFavoriteModelFileInfo
  {
    QString Label;
    QString FilePath;
    int Type;
  };
 
  QPointer<pqFileDialogModel> FileDialogModel;
  pqServer* Server = nullptr;
  QList<pqFileDialogFavoriteModelFileInfo> FavoriteList;
  QString SettingsKey;
};
 
#endif // !pqFileDialogFavoriteModel_h