qSlicerAbstractCoreModule.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 __qSlicerAbstractCoreModule_h
#define __qSlicerAbstractCoreModule_h

// Qt includes
#include <QObject>
#include <QStringList>

// CTK includes
#include <ctkPimpl.h>

// QTBase includes
#include "qSlicerBaseQTCoreExport.h"

class qSlicerAbstractModuleRepresentation;
class vtkMRMLAbstractLogic;
class vtkSlicerApplicationLogic;
class vtkMRMLScene;
class qSlicerAbstractCoreModulePrivate;


#define qSlicerGetTitleMacro(_TITLE)               \
  static QString staticTitle() { return _TITLE; }  \
  QString title() const override { return _TITLE; }

//
class Q_SLICER_BASE_QTCORE_EXPORT qSlicerAbstractCoreModule : public QObject
{
  Q_OBJECT


  Q_PROPERTY(QString name READ name)

  
  Q_PROPERTY(QString title READ title)

  
  Q_PROPERTY(QStringList categories READ categories)

  
  Q_PROPERTY(int index READ index)

  
  Q_PROPERTY(bool hidden READ isHidden)

  
  Q_PROPERTY(bool widgetRepresentationCreationEnabled
             READ isWidgetRepresentationCreationEnabled
             WRITE setWidgetRepresentationCreationEnabled)

  
  Q_PROPERTY(QString helpText READ helpText)

  
  Q_PROPERTY(QString acknowledgementText READ acknowledgementText)

  
  Q_PROPERTY(QStringList contributors READ contributors)

  
  Q_PROPERTY(QString slicerWikiUrl READ slicerWikiUrl)

  
  Q_PROPERTY(QString defaultDocumentationLink READ defaultDocumentationLink);

  Q_PROPERTY(QStringList dependencies READ dependencies)

  
  Q_PROPERTY(QString path READ path)

  
  Q_PROPERTY(bool isInstalled READ isInstalled)

  
  Q_PROPERTY(bool isBuiltIn READ isBuiltIn)

  
  Q_PROPERTY(QStringList associatedNodeTypes READ associatedNodeTypes)

public:

  typedef QObject Superclass;
  qSlicerAbstractCoreModule(QObject *parent=nullptr);
  ~qSlicerAbstractCoreModule() override;

  virtual void printAdditionalInfo();

  QString slicerWikiUrl()const{ return "https://www.slicer.org/w/index.php"; }

  QString defaultDocumentationLink()const;

  void initialize(vtkSlicerApplicationLogic* appLogic);

  virtual QString name()const;
  virtual void setName(const QString& name);

  virtual QString title()const = 0;

  virtual QStringList categories()const;

  virtual int index()const;

  virtual bool isHidden()const;

  virtual QStringList contributors()const;

  virtual QString helpText()const;

  virtual QString acknowledgementText()const;

  bool isWidgetRepresentationCreationEnabled()const;
  void setWidgetRepresentationCreationEnabled(bool value);

  qSlicerAbstractModuleRepresentation* widgetRepresentation();

  qSlicerAbstractModuleRepresentation* createNewWidgetRepresentation();

  void setAppLogic(vtkSlicerApplicationLogic* appLogic);
  vtkSlicerApplicationLogic* appLogic() const;

  vtkMRMLAbstractLogic* moduleLogic(const QString& moduleName) const;

  Q_INVOKABLE vtkMRMLAbstractLogic* logic();

  Q_INVOKABLE vtkMRMLScene* mrmlScene() const;

  virtual QStringList dependencies()const;

  QString path()const;
  void setPath(const QString& newPath);

  bool isInstalled()const;
  void setInstalled(bool value);

  bool isBuiltIn()const;
  void setBuiltIn(bool value);

  virtual QStringList associatedNodeTypes()const;

public slots:

  virtual void setMRMLScene(vtkMRMLScene*);

protected:
  virtual void setup() = 0;

  virtual qSlicerAbstractModuleRepresentation* createWidgetRepresentation() = 0;

  virtual vtkMRMLAbstractLogic* createLogic() = 0;

protected:
  QScopedPointer<qSlicerAbstractCoreModulePrivate> d_ptr;

private:
  Q_DECLARE_PRIVATE(qSlicerAbstractCoreModule);
  Q_DISABLE_COPY(qSlicerAbstractCoreModule);
  friend class qSlicerAbstractModuleRepresentation;

  void representationDeleted(qSlicerAbstractModuleRepresentation *representation);
};

#endif