pqFileDialog.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 pqFileDialog_h
#define pqFileDialog_h

#include "pqCoreModule.h"
#include "pqFileDialogModel.h"

#include "vtkType.h" // needed for vtkTypeUInt32

#include <optional>

#include <QDialog>
#include <QMap>
#include <QPointer>
#include <QStringList>

class QModelIndex;
class QPoint;
class QShowEvent;
class pqServer;

class PQCORE_EXPORT pqFileDialog : public QDialog
{
  typedef QDialog Superclass;
  Q_OBJECT
public:
  enum FileMode
  {
    AnyFile,
    ExistingFile,
    ExistingFiles,
    Directory,
    ExistingFilesAndDirectories
  };

  using pqFileValidityCallback = std::function<bool( //
    QStringList group,                               //
    vtkTypeUInt32 location,                          //
    QString& reason                                  //
    )>;

  pqFileDialog(pqServer* server, QWidget* parent, const QString& title = QString(),
    const QString& directory = QString(), const QString& filter = QString(),
    bool supportGroupFiles = true, bool onlyBrowseRemotely = true);
  ~pqFileDialog() override;


  void setFileMode(FileMode, vtkTypeUInt32);
  void setFileMode(FileMode);


  void setRecentlyUsedExtension(const QString& fileExtension, vtkTypeUInt32 location);
  void setRecentlyUsedExtension(const QString& fileExtension);

  void setFileValidityCallback(
    const std::optional<pqFileValidityCallback>& callback = std::nullopt);

  std::optional<pqFileValidityCallback> getFileValidityCallback();

  QStringList getSelectedFiles(int index = 0);

  QList<QStringList> getAllSelectedFiles();

  int getSelectedFilterIndex();

  void accept() override;

  bool selectFile(const QString&);

  void setShowHidden(const bool& hidden);

  bool getShowHidden();

  vtkTypeUInt32 getSelectedLocation() const { return this->SelectedLocation; }


  static QString getSaveFileName(pqServer* server, QWidget* parentWdg,
    const QString& title = QString(), const QString& directory = QString(),
    const QString& filter = QString())
  {
    const QPair<QString, vtkTypeUInt32> result =
      pqFileDialog::getSaveFileNameAndLocation(server, parentWdg, title, directory, filter);
    return result.first;
  }
  static QPair<QString, vtkTypeUInt32> getSaveFileNameAndLocation(pqServer* server,
    QWidget* parentWdg, const QString& title = QString(), const QString& directory = QString(),
    const QString& filter = QString(), bool supportGroupFiles = false,
    bool onlyBrowseRemotely = true);
Q_SIGNALS:
  void filesSelected(const QList<QStringList>&);

  void filesSelected(const QStringList&);

  void fileAccepted(const QString&);

protected:
  bool acceptExistingFiles();
  bool acceptDefault(const bool& checkForGrouping);

  QStringList buildFileGroup(const QString& filename);
  bool areFilesValid(const QStringList& filenames, QString& reason);

  void showEvent(QShowEvent* showEvent) override;

private Q_SLOTS:
  void onLocationChanged(int fs);
  void onModelReset();
  void onNavigate(const QString& = QString());
  void onNavigateUp();
  void onNavigateBack();
  void onNavigateForward();
  void onNavigateDown(const QModelIndex&);
  void onFilterChange(const QString&);

  void onClickedRecent(const QModelIndex&);
  void onClickedFavorite(const QModelIndex&);
  void onClickedFile(const QModelIndex&);

  void onActivateFavorite(const QModelIndex&);
  void onActivateLocation(const QModelIndex&);
  void onActivateRecent(const QModelIndex&);
  void onDoubleClickFile(const QModelIndex&);

  void onTextEdited(const QString&);

  void onShowHiddenFiles(const bool& hide);

  void onShowDetailToggled(bool show);

  void onGroupFilesToggled(bool group);

  // Called when the user changes the file selection.
  void fileSelectionChanged();

  // Called when the user right-clicks in the file qtreeview
  void onContextMenuRequested(const QPoint& pos);

  // Called when the user right-clicks in the favorites qlistview
  void onFavoritesContextMenuRequested(const QPoint& pos);

  void AddDirectoryToFavorites(QString const&);
  void RemoveDirectoryFromFavorites(QString const&);
  void FilterDirectoryFromFavorites(const QString& filter);

  void onAddCurrentDirectoryToFavorites();
  void onRemoveSelectedDirectoriesFromFavorites();
  void onResetFavoritesToSystemDefault();

  // Called when the user requests to create a new directory in the cwd
  void onCreateNewFolder();

  void addToFilesSelected(const QStringList&);

  void emitFilesSelectionDone();

  void updateButtonStates(vtkTypeUInt32 fileSystem);

private: // NOLINT(readability-redundant-access-specifiers)
  pqFileDialog(const pqFileDialog&);
  pqFileDialog& operator=(const pqFileDialog&);

  class pqImplementation;
  QMap<vtkTypeUInt32, QPointer<pqImplementation>> Implementations;
  vtkTypeUInt32 SelectedLocation;

  QPointer<pqServer> Server;
  const QString StartDirectory;
  const QString NameFilter;
  bool SupportsGroupFiles;
  vtkTypeUInt32 DefaultLocation;
  QString RecentlyUsedExtension;
  std::optional<pqFileValidityCallback> FileValidityCallback;

  void addImplementation(vtkTypeUInt32 location);

  // returns if true if files are loaded
  bool acceptInternal(const QStringList& selected_files);
  QString fixFileExtension(const QString& filename, const QString& filter);


  void saveState(vtkTypeUInt32 fileSystem);
  void saveState();


  void restoreState(vtkTypeUInt32 fileSystem);
  void restoreState();
};

#endif // pqFileDialog_h