qSlicerCLIModuleWidget.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 __qSlicerCLIModuleWidget_h
#define __qSlicerCLIModuleWidget_h

// CTK includes
#include <ctkPimpl.h>
#include <ctkVTKObject.h>

// Slicer includes
#include "qSlicerAbstractModuleWidget.h"

#include "qSlicerBaseQTCLIExport.h"

class ModuleDescription;
class vtkMRMLNode;
class vtkMRMLCommandLineModuleNode;
class qSlicerCLIModuleWidgetPrivate;

class Q_SLICER_BASE_QTCLI_EXPORT qSlicerCLIModuleWidget : public qSlicerAbstractModuleWidget
{
  Q_OBJECT
  QVTK_OBJECT
public:

  typedef qSlicerAbstractModuleWidget Superclass;
  qSlicerCLIModuleWidget(QWidget *parent=nullptr);
  ~qSlicerCLIModuleWidget() override;

  Q_INVOKABLE vtkMRMLCommandLineModuleNode * currentCommandLineModuleNode()const;

  // Node editing
  bool setEditedNode(vtkMRMLNode* node, QString role = QString(), QString context = QString()) override;
  double nodeEditable(vtkMRMLNode* node) override;

public slots:
  void setCurrentCommandLineModuleNode(vtkMRMLNode* commandLineModuleNode);

  void apply(bool wait = false);
  void cancel();
  void reset();

  void setAutoRun(bool enable);
  void setAutoRunWhenParameterChanged(bool enable);
  void setAutoRunWhenInputModified(bool enable);
  void setAutoRunOnOtherInputEvents(bool enable);
  void setAutoRunCancelsRunningProcess(bool enable);
protected:
  void setup() override;

  void enter() override;

  void run(vtkMRMLCommandLineModuleNode* parameterNode, bool waitForCompletion = false);

  void cancel(vtkMRMLCommandLineModuleNode* node);
protected:
  QScopedPointer<qSlicerCLIModuleWidgetPrivate> d_ptr;

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

#endif