pqFileDialogModel.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 pqFileDialogModel_h
#define pqFileDialogModel_h
 
#include "pqCoreModule.h"
 
#include "vtkPVFileInformation.h"
#include "vtkParaViewDeprecation.h" // for deprecation
 
#include <QAbstractItemModel>
#include <QFileIconProvider>
#include <QObject>
 
class vtkProcessModule;
class pqServer;
class QModelIndex;
 
class PQCORE_EXPORT pqFileDialogModel : public QAbstractItemModel
{
  typedef QAbstractItemModel base;
 
  Q_OBJECT
 
public:
  pqFileDialogModel(pqServer* server, QObject* Parent = nullptr);
  ~pqFileDialogModel() override;
 
  void setFileItemFlags(const Qt::ItemFlags& flags);
 
  void setDirectoryItemFlags(const Qt::ItemFlags& flags);
 
 
  void setShowDetailedInfo(bool show);
  bool isShowingDetailedInfo();
 
 
  void setGroupFiles(bool group);
  bool isGroupingFiles();
 
  PARAVIEW_DEPRECATED_IN_5_12_0("Use setGroupFiles(bool) and setCurrentPath(path) instead.")
  void setCurrentPath(const QString& path, bool groupFiles);
 
  void setCurrentPath(const QString& path);
 
  QString getCurrentPath();
 
  bool isHidden(const QModelIndex&);
 
  bool isDir(const QModelIndex&) const;
 
  // Creates a directory. "dirName" can be relative or absolute path
  bool mkdir(const QString& dirname);
 
  // Removes a directory. "dirName" can be relative or absolute path
  bool rmdir(const QString& dirname);
 
  // Renames a directory or file.
  bool rename(const QString& oldname, const QString& newname);
 
  bool fileExists(const QString& file, QString& fullpath);
 
  bool dirExists(const QString& dir, QString& fullpath);
 
  bool dirIsEmpty(const QString& dir, QString& fullpath);
 
  QChar separator() const;
 
  QString absoluteFilePath(const QString&);
 
  int fileType(const QString&);
 
  QStringList getFilePaths(const QModelIndex&);
 
  pqServer* server() const;
 
  bool setData(const QModelIndex& idx, const QVariant& value, int role) override;
 
  // overloads for QAbstractItemModel
 
  int columnCount(const QModelIndex&) const override;
  QVariant data(const QModelIndex& idx, int role) const override;
  QModelIndex index(int row, int column, const QModelIndex&) const override;
  QModelIndex parent(const QModelIndex&) const override;
  int rowCount(const QModelIndex&) const override;
  bool hasChildren(const QModelIndex& p) const override;
  QVariant headerData(int section, Qt::Orientation, int role) const override;
  Qt::ItemFlags flags(const QModelIndex& idx) const override;
 
private:
  class pqImplementation;
  pqImplementation* const Implementation;
};
 
class pqFileDialogModelIconProvider : protected QFileIconProvider
{
public:
  enum IconType
  {
    Invalid,
    Computer,
    Drive,
    Folder,
    File,
    FolderLink,
    FileLink,
    NetworkRoot,
    NetworkDomain,
    NetworkFolder
  };
  pqFileDialogModelIconProvider();
  QIcon icon(IconType t) const;
  QIcon icon(vtkPVFileInformation::FileTypes f) const;
 
protected:
  QIcon icon(const QFileInfo& info) const override;
  QIcon icon(QFileIconProvider::IconType ico) const override;
 
  QIcon InvalidIcon;
  QIcon FolderLinkIcon;
  QIcon FileLinkIcon;
  QIcon DomainIcon;
  QIcon NetworkIcon;
};
 
#endif // !pqFileDialogModel_h