qSlicerAbstractModule.h

Go to the documentation of this file.

/*=auto=========================================================================

 Portions (c) Copyright 2005 Brigham and Women's Hospital (BWH) 
 All Rights Reserved.

 See Doc/copyright/copyright.txt
 or http://www.slicer.org/copyright/copyright.txt for details.

 Program:   3D Slicer

=========================================================================auto=*/
#ifndef __qSlicerAbstractModule_h
#define __qSlicerAbstractModule_h

#include <QObject>

#include <qCTKPimpl.h>

#include "qSlicerBaseQTBaseExport.h"

class qSlicerAbstractModuleWidget;
class vtkSlicerLogic; 
class vtkSlicerApplicationLogic;
class vtkMRMLScene;
class QAction; 
class qSlicerAbstractModulePrivate;


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

class Q_SLICER_BASE_QTBASE_EXPORT qSlicerAbstractModule : public QObject
{
  Q_OBJECT

  Q_PROPERTY(QString Name READ name)
  Q_PROPERTY(QString Title READ title)
  Q_PROPERTY(QString Category READ category)
  Q_PROPERTY(QString Contributor READ contributor)

public:

  typedef QObject Superclass;
  qSlicerAbstractModule(QObject *parent=0);

  virtual void printAdditionalInfo();

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

  void initialize(vtkSlicerApplicationLogic* appLogic);
  inline bool initialized() { return this->Initialized; }

  virtual QString name()const;
  virtual void setName(const QString& name); 
  
  virtual QString title()const = 0;
  virtual QString category()const;
  virtual QString contributor()const;

  virtual QString helpText()const;
  virtual QString acknowledgementText()const;

  qSlicerAbstractModuleWidget* widgetRepresentation();

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

  vtkSlicerLogic* logic();

  vtkMRMLScene* mrmlScene() const;

  bool isEnabled()const;
  
public slots:

  virtual void setEnabled(bool enabled);

  virtual void setMRMLScene(vtkMRMLScene*);

protected:
  virtual void setup() = 0;

  virtual qSlicerAbstractModuleWidget* createWidgetRepresentation() = 0;

  virtual vtkSlicerLogic* createLogic() = 0;
  

private:
  QCTK_DECLARE_PRIVATE(qSlicerAbstractModule);

  bool Initialized;
};

#endif