qSlicerFileDialog.h

Go to the documentation of this file.

/*==============================================================================
 
  Program: 3D Slicer
 
  Copyright (c) Kitware Inc.
 
  See COPYRIGHT.txt
  or http://www.slicer.org/copyright/copyright.txt for details.
 
  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.
 
  This file was originally developed by Julien Finet, Kitware Inc.
  and was partially funded by NIH grant 3P41RR013218-12S1
 
==============================================================================*/
 
#ifndef __qSlicerFileDialog_h
#define __qSlicerFileDialog_h
 
// Qt includes
#include <QObject>
#include <QStringList>
class QMimeData;
class QDropEvent;
 
// CTK includes
#include <ctkPimpl.h>
 
// Slicer includes
#include "qSlicerIO.h"
#include "qSlicerBaseQTGUIExport.h"

class qSlicerIOManager;
// class qSlicerFileDialogPrivate;
class qSlicerIOOptions;
 
//------------------------------------------------------------------------------
class Q_SLICER_BASE_QTGUI_EXPORT qSlicerFileDialog : public QObject
{
  Q_OBJECT
  Q_ENUMS(IOAction)
  Q_PROPERTY(QString description READ description)
  Q_PROPERTY(QStringList loadedNodes READ loadedNodes)
 
public:
  typedef QObject Superclass;
  qSlicerFileDialog(QObject* parent = nullptr);
  ~qSlicerFileDialog() override;
 
  virtual qSlicerIO::IOFileType fileType() const = 0;

  virtual QString description() const = 0;
 
  enum IOAction
  {
    Read,
    Write
  };
  virtual qSlicerFileDialog::IOAction action() const = 0;
  Q_INVOKABLE virtual bool exec(const qSlicerIO::IOProperties& ioProperties = qSlicerIO::IOProperties()) = 0;

  Q_INVOKABLE static QStringList nameFilters(qSlicerIO::IOFileType fileType = QString("NoFile"));

  Q_INVOKABLE virtual bool isMimeDataAccepted(const QMimeData* mimeData) const;

  Q_INVOKABLE virtual void dropEvent(QDropEvent* event);

  virtual QStringList loadedNodes() const;
 
private:
  //  Q_DECLARE_PRIVATE(qSlicerFileDialog);
  Q_DISABLE_COPY(qSlicerFileDialog);
};
 
Q_DECLARE_METATYPE(qSlicerFileDialog::IOAction)
 
class qSlicerStandardFileDialogPrivate;
class ctkFileDialog;
 
//------------------------------------------------------------------------------
class Q_SLICER_BASE_QTGUI_EXPORT qSlicerStandardFileDialog : public qSlicerFileDialog
{
  Q_OBJECT
  Q_PROPERTY(qSlicerIO::IOFileType fileType READ fileType WRITE setFileType)
  Q_PROPERTY(QString description READ description WRITE setDescription)
  Q_PROPERTY(IOAction action READ action WRITE setAction)
 
public:
  qSlicerStandardFileDialog(QObject* parent = nullptr);
  ~qSlicerStandardFileDialog() override;

  qSlicerIO::IOFileType fileType() const override;
  virtual void setFileType(qSlicerIO::IOFileType fileType);

  QString description() const override;
  virtual void setDescription(const QString& description);

  qSlicerFileDialog::IOAction action() const override;
  void setAction(IOAction action);
 
  bool exec(const qSlicerIO::IOProperties& ioProperties = qSlicerIO::IOProperties()) override;

  Q_INVOKABLE static QStringList getOpenFileName(qSlicerIO::IOProperties ioProperties = qSlicerIO::IOProperties());
  Q_INVOKABLE static QString getExistingDirectory(qSlicerIO::IOProperties ioProperties = qSlicerIO::IOProperties());

  QStringList loadedNodes() const override;
 
protected:
  static ctkFileDialog* createFileDialog(const qSlicerIO::IOProperties& ioProperties = qSlicerIO::IOProperties(), QWidget* parent = nullptr);
 
  qSlicerIOOptions* options(const qSlicerIO::IOProperties& ioProperties) const;
 
protected:
  QScopedPointer<qSlicerStandardFileDialogPrivate> d_ptr;
 
private:
  Q_DECLARE_PRIVATE(qSlicerStandardFileDialog);
  Q_DISABLE_COPY(qSlicerStandardFileDialog);
};
 
#endif