qMRMLNodeComboBox.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 Julien Finet, Kitware Inc.
  and was partially funded by NIH grant 3P41RR013218-12S1

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

#ifndef __qMRMLNodeComboBox_h
#define __qMRMLNodeComboBox_h

// Qt includes
#include <QComboBox>

// qMRML includes
#include "qMRMLSortFilterProxyModel.h"
#include "qMRMLWidgetsExport.h"
class qMRMLNodeFactory;
class qMRMLNodeComboBoxPrivate;
class qMRMLSceneModel;

// VTK includes
class vtkMRMLNode;
class vtkMRMLScene;

class QMRML_WIDGETS_EXPORT qMRMLNodeComboBox
  : public QWidget
{
  Q_OBJECT
  Q_PROPERTY(QString currentNodeID READ currentNodeID WRITE setCurrentNodeID NOTIFY currentNodeIDChanged DESIGNABLE false)
  Q_PROPERTY(QString currentNodeId READ currentNodeId WRITE setCurrentNode DESIGNABLE false) // \deprecated
  Q_PROPERTY(QStringList nodeTypes READ nodeTypes WRITE setNodeTypes)
  Q_PROPERTY(bool showHidden READ showHidden WRITE setShowHidden)
  Q_PROPERTY(bool showChildNodeTypes READ showChildNodeTypes WRITE setShowChildNodeTypes)
  Q_PROPERTY(QStringList hideChildNodeTypes READ hideChildNodeTypes WRITE setHideChildNodeTypes)

  Q_PROPERTY(QString baseName READ baseName WRITE setBaseName)
  Q_PROPERTY(bool noneEnabled READ noneEnabled WRITE setNoneEnabled)
  Q_PROPERTY(bool addEnabled READ addEnabled WRITE setAddEnabled)
  Q_PROPERTY(bool removeEnabled READ removeEnabled WRITE setRemoveEnabled)
  Q_PROPERTY(bool editEnabled READ editEnabled WRITE setEditEnabled)
  Q_PROPERTY(bool renameEnabled READ renameEnabled WRITE setRenameEnabled)

  Q_PROPERTY(QString interactionNodeSingletonTag READ interactionNodeSingletonTag WRITE setInteractionNodeSingletonTag)

  Q_PROPERTY(bool selectNodeUponCreation READ selectNodeUponCreation WRITE setSelectNodeUponCreation)
  Q_PROPERTY(QString noneDisplay READ noneDisplay WRITE setNoneDisplay)

  Q_PROPERTY(QComboBox::SizeAdjustPolicy sizeAdjustPolicy READ sizeAdjustPolicy WRITE setSizeAdjustPolicy)

public:
  typedef QWidget Superclass;

  explicit qMRMLNodeComboBox(QWidget* parent = nullptr);
  ~qMRMLNodeComboBox() override;

  Q_INVOKABLE vtkMRMLScene* mrmlScene()const;

  QStringList nodeTypes()const;
  void setNodeTypes(const QStringList& nodeTypes);

  inline void setShowHidden(bool);
  inline bool showHidden()const;

  inline void setShowChildNodeTypes(bool show);
  inline bool showChildNodeTypes()const;

  inline void setHideChildNodeTypes(const QStringList& nodeTypes);
  inline QStringList hideChildNodeTypes()const;

  Q_INVOKABLE void addAttribute(const QString& nodeType,
                                const QString& attributeName,
                                const QVariant& attributeValue = QVariant());
  Q_INVOKABLE void removeAttribute(const QString& nodeType,
                                const QString& attributeName);

  void setBaseName(const QString& baseName, const QString& nodeType = "");
  QString baseName(const QString& nodeType = "")const;

  Q_INVOKABLE void setNodeTypeLabel(const QString& label, const QString& nodeType);
  Q_INVOKABLE QString nodeTypeLabel(const QString& nodeType)const;

  Q_INVOKABLE int nodeCount()const;

  Q_INVOKABLE vtkMRMLNode* nodeFromIndex(int index)const;

  Q_INVOKABLE vtkMRMLNode* currentNode()const;

  QString currentNodeID()const;

  Q_INVOKABLE QString currentNodeId()const;

  bool selectNodeUponCreation()const;
  void setSelectNodeUponCreation(bool value);

  bool noneEnabled()const;
  void setNoneEnabled(bool enable);

  bool addEnabled()const;
  void setAddEnabled(bool enable);

  bool removeEnabled()const;
  void setRemoveEnabled(bool enable);

  bool editEnabled()const;
  void setEditEnabled(bool enable);

  bool renameEnabled()const;
  void setRenameEnabled(bool enable);

  QString noneDisplay()const;

  void setNoneDisplay(const QString& displayName);

  QList<vtkMRMLNode*> nodes()const;

  QAbstractItemModel* model()const;

  Q_INVOKABLE qMRMLSortFilterProxyModel* sortFilterProxyModel()const;

  qMRMLSceneModel* sceneModel()const;

  qMRMLNodeFactory* nodeFactory()const;

  QComboBox::SizeAdjustPolicy sizeAdjustPolicy()const;
  void setSizeAdjustPolicy(QComboBox::SizeAdjustPolicy policy);

  Q_INVOKABLE virtual void addMenuAction(QAction *newAction);

  virtual QString interactionNodeSingletonTag()const;
  virtual void setInteractionNodeSingletonTag(const QString& tag);

public slots:
  virtual void setMRMLScene(vtkMRMLScene* scene);

  void setCurrentNode(vtkMRMLNode* node);

  void setCurrentNode(const QString& nodeID);

  void setCurrentNodeID(const QString& nodeID);

  void setCurrentNodeIndex(int index);

  virtual vtkMRMLNode* addNode(QString nodeType);

  virtual vtkMRMLNode* addNode();

  virtual void removeCurrentNode();

  virtual void editCurrentNode();

  virtual void renameCurrentNode();

signals:
  void currentNodeChanged(vtkMRMLNode* node);

  void currentNodeIDChanged(const QString& id);

  void nodeActivated(vtkMRMLNode* node);

  void currentNodeChanged(bool validNode);


  void nodeAdded(vtkMRMLNode* node);

  void nodeAddedByUser(vtkMRMLNode* node);

  void nodeAboutToBeRemoved(vtkMRMLNode* node);


  void currentNodeRenamed(const QString& newName);

  void nodeAboutToBeEdited(vtkMRMLNode* node);

protected:
  qMRMLNodeComboBox(QAbstractItemModel* model, QWidget* parent = nullptr);
  qMRMLNodeComboBox(qMRMLNodeComboBoxPrivate* pimpl, QWidget* parent = nullptr);
  QAbstractItemModel* rootModel()const;

  void setComboBox(QComboBox* comboBox);

  QComboBox* comboBox()const;

  void changeEvent(QEvent* event) override;

protected slots:
  void activateExtraItem(const QModelIndex& index);
  void emitCurrentNodeChanged();
  void emitNodeActivated(int currentIndex);
  void emitNodesAdded(const QModelIndex & parent, int start, int end);
  void emitNodesAboutToBeRemoved(const QModelIndex & parent, int start, int end);
  void refreshIfCurrentNodeHidden();

protected:
  QScopedPointer<qMRMLNodeComboBoxPrivate> d_ptr;

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

// --------------------------------------------------------------------------
void qMRMLNodeComboBox::setShowHidden(bool enable)
{
  this->sortFilterProxyModel()->setShowHidden(enable);
}

// --------------------------------------------------------------------------
bool qMRMLNodeComboBox::showHidden()const
{
  return this->sortFilterProxyModel()->showHidden();
}

// --------------------------------------------------------------------------
void qMRMLNodeComboBox::setShowChildNodeTypes(bool show)
{
  this->sortFilterProxyModel()->setShowChildNodeTypes(show);
}

// --------------------------------------------------------------------------
bool qMRMLNodeComboBox::showChildNodeTypes()const
{
  return this->sortFilterProxyModel()->showChildNodeTypes();
}

// --------------------------------------------------------------------------
void qMRMLNodeComboBox::setHideChildNodeTypes(const QStringList& _nodeTypes)
{
  this->sortFilterProxyModel()->setHideChildNodeTypes(_nodeTypes);
}

// --------------------------------------------------------------------------
QStringList qMRMLNodeComboBox::hideChildNodeTypes()const
{
  return this->sortFilterProxyModel()->hideChildNodeTypes();
}

#endif