qMRMLMarkupsAbstractOptionsWidget.h

Go to the documentation of this file.

/*==============================================================================

  Copyright (c) The Intervention Centre
  Oslo University Hospital, Oslo, Norway. All Rights Reserved.

  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 Rafael Palomar (The Intervention Centre,
  Oslo University Hospital) and was supported by The Research Council of Norway
  through the ALive project (grant nr. 311393).

==============================================================================*/

#ifndef __qMRMLMarkupsAbstractOptionsWidget_h_
#define __qMRMLMarkupsAbstractOptionsWidget_h_

// Markups Widgets includes
#include "qSlicerMarkupsModuleWidgetsExport.h"

//MRML includes
#include <vtkMRMLScene.h>
#include <vtkMRMLMarkupsNode.h>

// Qt includes
#include <QWidget>

//-------------------------------------------------------------------------------
class vtkMRMLMarkupsNode;
class vtkMRMLNode;

//-------------------------------------------------------------------------------
class Q_SLICER_MODULE_MARKUPS_WIDGETS_EXPORT qMRMLMarkupsAbstractOptionsWidget
  : public QWidget
{
  Q_OBJECT

  Q_PROPERTY(QString className READ className CONSTANT);

public:
  typedef QWidget Superclass;
  qMRMLMarkupsAbstractOptionsWidget(QWidget* parent=nullptr);
  ~qMRMLMarkupsAbstractOptionsWidget()=default;

  virtual void updateWidgetFromMRML() = 0;

  virtual const QString className() const = 0;

  // Returns the associated markups node
  vtkMRMLMarkupsNode* mrmlMarkupsNode() const
    {return this->MarkupsNode.GetPointer();}

  // Returns the associated markups node
  vtkMRMLScene* mrmlScene() const
    {return this->MRMLScene.GetPointer();}

  virtual bool canManageMRMLMarkupsNode(vtkMRMLMarkupsNode *markupsNode) const = 0;

  virtual qMRMLMarkupsAbstractOptionsWidget* createInstance() const = 0;

public slots:
  void setMRMLMarkupsNode(vtkMRMLNode* markupsNode);
  virtual void setMRMLMarkupsNode(vtkMRMLMarkupsNode* markupsNode) = 0;
  virtual void setMRMLScene(vtkMRMLScene* mrmlScene)
  {this->MRMLScene = mrmlScene;}

protected:
  vtkWeakPointer<vtkMRMLMarkupsNode> MarkupsNode;
  vtkWeakPointer<vtkMRMLScene> MRMLScene;

private:
  Q_DISABLE_COPY(qMRMLMarkupsAbstractOptionsWidget);
};

#endif // __qMRMLMarkupsAbstractOptionsWidget_h_