qSlicerScriptedFileWriter.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 Jean-Christophe Fillion-Robin, Kitware Inc.
  and was partially funded by NIH grant 3P41RR013218-12S1

==============================================================================*/

#ifndef __qSlicerScriptedFileWriter_h
#define __qSlicerScriptedFileWriter_h

// Slicer includes
#include "qSlicerFileWriter.h"
#include "qSlicerBaseQTCoreExport.h"

// Forward Declare PyObject*
#ifndef PyObject_HEAD
struct _object;
typedef _object PyObject;
#endif
class qSlicerScriptedFileWriterPrivate;

class Q_SLICER_BASE_QTCORE_EXPORT qSlicerScriptedFileWriter
  : public qSlicerFileWriter
{
  Q_OBJECT

  Q_PROPERTY(QStringList writtenNodes READ writtenNodes WRITE setWrittenNodes)

public:
  typedef qSlicerFileWriter Superclass;
  qSlicerScriptedFileWriter(QObject* parent = nullptr);
  ~qSlicerScriptedFileWriter() override;

  QString pythonSource()const;

  bool setPythonSource(const QString& newPythonSource, const QString& className = QLatin1String(""), bool missingClassIsExpected = true);

  Q_INVOKABLE PyObject* self() const;

  QString description()const override;

  IOFileType fileType()const override;

  bool canWriteObject(vtkObject* object)const override;

  QStringList extensions(vtkObject* object)const override;

  bool write(const qSlicerIO::IOProperties& properties) override;

  void addWrittenNode(const QString& writtenNode);

  QStringList writtenNodes()const override {
    return Superclass::writtenNodes();
  };
  void setWrittenNodes(const QStringList& nodes) override {
    Superclass::setWrittenNodes(nodes);
  };

protected:
  QScopedPointer<qSlicerScriptedFileWriterPrivate> d_ptr;

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

#endif