qSlicerAbstractModuleWidget.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 __qSlicerAbstractModuleWidget_h
#define __qSlicerAbstractModuleWidget_h

#if defined(_MSC_VER)
#pragma warning( disable:4250 )
#endif

// CTK includes
#include <ctkPimpl.h>

// Slicer includes
#include "qSlicerAbstractModuleRepresentation.h"
#include "qSlicerWidget.h"
class qSlicerAbstractModuleWidgetPrivate;
class vtkMRMLNode;
class Q_SLICER_BASE_QTGUI_EXPORT qSlicerAbstractModuleWidget
  :public qSlicerWidget, public qSlicerAbstractModuleRepresentation
{
  Q_OBJECT
  Q_PROPERTY(bool isEntered READ isEntered);
public:
  qSlicerAbstractModuleWidget(QWidget *parent=nullptr);
  ~qSlicerAbstractModuleWidget() override;

  Q_INVOKABLE virtual void enter();
  Q_INVOKABLE virtual void exit();
  bool isEntered()const;

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

protected:
  QScopedPointer<qSlicerAbstractModuleWidgetPrivate> d_ptr;

  void setup() override;

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

#endif