qSlicerAbstractModuleRepresentation.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 __qSlicerAbstractModuleRepresentation_h
#define __qSlicerAbstractModuleRepresentation_h

// Qt includes
#include <QString>

// CTK includes
#include <ctkPimpl.h>

// Slicer includes
#include "qSlicerObject.h"

#include "qSlicerBaseQTCoreExport.h"

class vtkMRMLAbstractLogic;
class vtkMRMLNode;
class qSlicerAbstractCoreModule;
class QAction;
class qSlicerAbstractModuleRepresentationPrivate;

class Q_SLICER_BASE_QTCORE_EXPORT qSlicerAbstractModuleRepresentation : virtual public qSlicerObject
{
public:

  typedef qSlicerObject Superclass;
  qSlicerAbstractModuleRepresentation();
  ~qSlicerAbstractModuleRepresentation() override;

  QString moduleName()const;

  qSlicerAbstractCoreModule* module()const;

  virtual bool setEditedNode(vtkMRMLNode* node, QString role = QString(), QString context = QString());

  virtual double nodeEditable(vtkMRMLNode* node);

protected:
  virtual void setup() = 0;

  vtkMRMLAbstractLogic* logic() const;

protected:
  QScopedPointer<qSlicerAbstractModuleRepresentationPrivate> d_ptr;

private:
  Q_DECLARE_PRIVATE(qSlicerAbstractModuleRepresentation);
  Q_DISABLE_COPY(qSlicerAbstractModuleRepresentation);

  friend class qSlicerAbstractCoreModule;
  void setModule(qSlicerAbstractCoreModule* module);
};

#endif