qSlicerIOManager.h

Go to the documentation of this file.

#ifndef __qSlicerIOManager_h
#define __qSlicerIOManager_h
 
// Qt includes
#include <QList>
#include <QString>
#include <QUrl>
 
// CTK includes
#include <ctkVTKObject.h>
 
// SlicerQ includes
#include "qSlicerApplication.h"
#include "qSlicerCoreIOManager.h"
#include "qSlicerFileDialog.h"
 
#include "qSlicerBaseQTGUIExport.h"

class QDragEnterEvent;
class QDropEvent;
class QWidget;
 
class qSlicerIOManagerPrivate;
class qSlicerIOOptionsWidget;
 
class Q_SLICER_BASE_QTGUI_EXPORT qSlicerIOManager : public qSlicerCoreIOManager
{
  Q_OBJECT;
  QVTK_OBJECT;
 
public:
  typedef qSlicerCoreIOManager Superclass;
  qSlicerIOManager(QObject* parent = nullptr);
  ~qSlicerIOManager() override;

  Q_INVOKABLE bool openDialog(qSlicerIO::IOFileType fileType,
                              qSlicerFileDialog::IOAction action,
                              qSlicerIO::IOProperties ioProperties = qSlicerIO::IOProperties(),
                              vtkCollection* loadedNodes = nullptr);
 
  Q_INVOKABLE void addHistory(const QString& path);
  Q_INVOKABLE QStringList history() const;
 
  Q_INVOKABLE void setFavorites(const QList<QUrl>& urls);
  Q_INVOKABLE QList<QUrl> favorites() const;

  Q_INVOKABLE void registerDialog(qSlicerFileDialog* dialog);

  qSlicerIOOptionsWidget* fileOptionsWidget(const QString& fileDescription, QWidget* parent = nullptr) const;

  qSlicerIOOptionsWidget* fileWriterOptionsWidget(vtkObject* object, const QString& extension = QString(), QWidget* parent = nullptr) const;

  Q_INVOKABLE bool isDialogRegistered(qSlicerIO::IOFileType fileType, qSlicerFileDialog::IOAction action) const;

  Q_INVOKABLE bool loadNodes(const qSlicerIO::IOFileType& fileType,
                             const qSlicerIO::IOProperties& parameters,
                             vtkCollection* loadedNodes = nullptr,
                             vtkMRMLMessageCollection* userMessages = nullptr) override;
  Q_INVOKABLE bool loadNodes(const QList<qSlicerIO::IOProperties>& files, vtkCollection* loadedNodes = nullptr, vtkMRMLMessageCollection* userMessages = nullptr) override;

  Q_INVOKABLE static void showLoadNodesResultDialog(bool success, vtkMRMLMessageCollection* userMessages);

  void dragEnterEvent(QDragEnterEvent* event);

  void dropEvent(QDropEvent* event);
 
public slots:
 
  void openScreenshotDialog();
  void openSceneViewsDialog();
  bool openLoadSceneDialog();
  bool openAddSceneDialog();
  inline bool openAddDataDialog();
  inline bool openAddDataDialog(QString fileName);
  inline bool openAddVolumeDialog();
  inline bool openAddVolumesDialog();
  inline bool openAddModelDialog();
  inline bool openAddScalarOverlayDialog();
  inline bool openAddTransformDialog();
  inline bool openAddColorTableDialog();
  inline bool openAddFiducialDialog();
  inline bool openAddMarkupsDialog();
  inline bool openAddFiberBundleDialog();
  inline bool openSaveDataDialog();
 
protected slots:
  void execDelayedFileDialog();
 
protected:
  qSlicerIOOptions* createGenericOptions(vtkMRMLFileIOHandler* ioHandler) const override;

  void startProgress(vtkMRMLOperationProgress* progress) override;
  void updateProgress(vtkMRMLOperationProgress* progress) override;
  void endProgress(vtkMRMLOperationProgress* progress) override;
 
  friend class qSlicerFileDialog;
 
protected:
  QScopedPointer<qSlicerIOManagerPrivate> d_ptr;
 
private:
  Q_DECLARE_PRIVATE(qSlicerIOManager);
  Q_DISABLE_COPY(qSlicerIOManager);
};
 
//------------------------------------------------------------------------------
bool qSlicerIOManager::openAddDataDialog(QString fileName)
{
  qSlicerIO::IOProperties ioProperties;
  ioProperties["fileName"] = fileName;
  return this->openDialog(QString("NoFile"), qSlicerFileDialog::Read, ioProperties);
}
 
//------------------------------------------------------------------------------
bool qSlicerIOManager::openAddDataDialog()
{
  return this->openDialog(QString("NoFile"), qSlicerFileDialog::Read);
}
 
//-----------------------------------------------------------------------------
bool qSlicerIOManager::openAddVolumeDialog()
{
  return this->openDialog(QString("VolumeFile"), qSlicerFileDialog::Read);
}
 
//-----------------------------------------------------------------------------
bool qSlicerIOManager::openAddVolumesDialog()
{
  qSlicerIO::IOProperties ioProperties;
  ioProperties["multipleFiles"] = true;
  return this->openDialog(QString("VolumeFile"), qSlicerFileDialog::Read, ioProperties);
}
 
//-----------------------------------------------------------------------------
bool qSlicerIOManager::openAddModelDialog()
{
  return this->openDialog(QString("ModelFile"), qSlicerFileDialog::Read);
}
 
//-----------------------------------------------------------------------------
bool qSlicerIOManager::openAddScalarOverlayDialog()
{
  return this->openDialog(QString("ScalarOverlayFile"), qSlicerFileDialog::Read);
}
 
//-----------------------------------------------------------------------------
bool qSlicerIOManager::openAddTransformDialog()
{
  return this->openDialog(QString("TransformFile"), qSlicerFileDialog::Read);
}
 
//-----------------------------------------------------------------------------
bool qSlicerIOManager::openAddColorTableDialog()
{
  return this->openDialog(QString("ColorTableFile"), qSlicerFileDialog::Read);
}
 
//-----------------------------------------------------------------------------
bool qSlicerIOManager::openAddFiducialDialog()
{
  return this->openDialog(QString("FiducialListFile"), qSlicerFileDialog::Read);
}
 
//-----------------------------------------------------------------------------
bool qSlicerIOManager::openAddMarkupsDialog()
{
  return this->openDialog(QString("MarkupsFiducials"), qSlicerFileDialog::Read);
}
 
//-----------------------------------------------------------------------------
bool qSlicerIOManager::openAddFiberBundleDialog()
{
  return this->openDialog(QString("FiberBundleFile"), qSlicerFileDialog::Read);
}
 
//------------------------------------------------------------------------------
bool qSlicerIOManager::openSaveDataDialog()
{
  return this->openDialog(QString("NoFile"), qSlicerFileDialog::Write);
}
 
#endif