qSlicerCLIModule.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 __qSlicerCLIModule_h
#define __qSlicerCLIModule_h

// CTK includes
#include <ctkPimpl.h>

// Slicer includes
#include "qSlicerAbstractModule.h"

// SlicerExecutionModel includes
#include <ModuleDescription.h>

#include "qSlicerBaseQTCLIExport.h"

class ModuleLogo;
class vtkMRMLCommandLineModuleNode;
class vtkSlicerCLIModuleLogic;

class qSlicerCLIModulePrivate;
class Q_SLICER_BASE_QTCLI_EXPORT qSlicerCLIModule : public qSlicerAbstractModule
{
  Q_OBJECT
public:

  typedef qSlicerAbstractModule Superclass;
  qSlicerCLIModule(QWidget *parent=nullptr);
  ~qSlicerCLIModule() override;

  void setXmlModuleDescription(const QString& xmlModuleDescription);

  int index() const override;

  QString helpText() const override;
  QString acknowledgementText() const override;

  void setTempDirectory(const QString& tempDirectory);
  QString tempDirectory() const;

  void setEntryPoint(const QString& entryPoint);
  QString entryPoint() const;

  void setModuleType(const QString& type);
  QString moduleType() const;

  Q_INVOKABLE vtkSlicerCLIModuleLogic* cliModuleLogic();

  QString title() const override;

  QStringList categories() const override;

  QStringList contributors() const override;

  QStringList associatedNodeTypes()const override;

  QImage logo() const override;
  void setLogo(const ModuleLogo& logo);

  static QImage moduleLogoToImage(const ModuleLogo& logo);

  ModuleDescription& moduleDescription();

  QString translate(const std::string& sourceText)const;

protected:
  void setup() override;

  qSlicerAbstractModuleRepresentation * createWidgetRepresentation() override;

  vtkMRMLAbstractLogic* createLogic() override;

protected:
  QScopedPointer<qSlicerCLIModulePrivate> d_ptr;

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

#endif