qSlicerFileReader.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 __qSlicerFileReader_h
#define __qSlicerFileReader_h

// Qt includes
#include <QFileInfo>

// QtCore includes
#include "qSlicerIO.h"
#include "qSlicerBaseQTCoreExport.h"

class qSlicerFileReaderOptions;
class qSlicerFileReaderPrivate;

class Q_SLICER_BASE_QTCORE_EXPORT qSlicerFileReader
  : public qSlicerIO
{
  Q_OBJECT
public:
  typedef qSlicerIO Superclass;
  explicit qSlicerFileReader(QObject* parent = nullptr);
  ~qSlicerFileReader() override;

  virtual QStringList extensions()const;

  virtual bool canLoadFile(const QString& file)const;

  QStringList supportedNameFilters(const QString& fileName, int* longestExtensionMatchPtr = nullptr)const;

  virtual bool load(const IOProperties& properties);

  virtual QStringList loadedNodes()const;

  virtual bool examineFileInfoList(QFileInfoList &fileInfoList, QFileInfo &archetypeFileInfo, qSlicerIO::IOProperties &ioProperties)const;

protected:
  virtual void setLoadedNodes(const QStringList& nodes);

protected:
  QScopedPointer<qSlicerFileReaderPrivate> d_ptr;

private:
  Q_DECLARE_PRIVATE(qSlicerFileReader);
  Q_DISABLE_COPY(qSlicerFileReader);
};

#endif