qSlicerSubjectHierarchyTablesPlugin.h

Go to the documentation of this file.

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

  Program: 3D Slicer

  Portions (c) Copyright 2015 Brigham and Women's Hospital (BWH) 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 Andras Lasso (PerkLab, Queen's
  University) and Kevin Wang (Princess Margaret Hospital, Toronto) and was
  supported through OCAIRO and the Applied Cancer Research Unit program of
  Cancer Care Ontario.

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

#ifndef __qSlicerSubjectHierarchyTablesPlugin_h
#define __qSlicerSubjectHierarchyTablesPlugin_h

// SubjectHierarchy includes
#include "qSlicerSubjectHierarchyAbstractPlugin.h"

#include "qSlicerTablesSubjectHierarchyPluginsExport.h"

class qSlicerSubjectHierarchyTablesPluginPrivate;
class vtkMRMLNode;
class vtkMRMLSubjectHierarchyNode;
class vtkMRMLTableViewNode;

// Due to some reason the Python wrapping of this class fails, therefore
// put everything between BTX/ETX to exclude from wrapping.
// TODO investigate why the wrapping fails:
//   https://www.assembla.com/spaces/slicerrt/tickets/210-python-wrapping-error-when-starting-up-slicer-with-slicerrt
//BTX

class Q_SLICER_TABLES_SUBJECT_HIERARCHY_PLUGINS_EXPORT qSlicerSubjectHierarchyTablesPlugin : public qSlicerSubjectHierarchyAbstractPlugin
{
public:
  Q_OBJECT

public:
  typedef qSlicerSubjectHierarchyAbstractPlugin Superclass;
  qSlicerSubjectHierarchyTablesPlugin(QObject* parent = NULL);
  virtual ~qSlicerSubjectHierarchyTablesPlugin();

public:
  virtual double canAddNodeToSubjectHierarchy(
    vtkMRMLNode* node,
    vtkIdType parentItemID=vtkMRMLSubjectHierarchyNode::INVALID_ITEM_ID )const;

  virtual double canOwnSubjectHierarchyItem(vtkIdType itemID)const;

  Q_INVOKABLE virtual const QString roleForPlugin()const;

  virtual QIcon icon(vtkIdType itemID);

  virtual QIcon visibilityIcon(int visible);

  virtual void setDisplayVisibility(vtkIdType itemID, int visible);

  virtual int getDisplayVisibility(vtkIdType itemID)const;

protected:
  vtkMRMLTableViewNode* getTableViewNode()const;

protected:
  QScopedPointer<qSlicerSubjectHierarchyTablesPluginPrivate> d_ptr;

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

//ETX

#endif