qMRMLTextWidget.h

Go to the documentation of this file.

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

  Copyright (c) Laboratory for Percutaneous Surgery (PerkLab)
  Queen's University, Kingston, ON, Canada. 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 Kyle Sunderland, PerkLab, Queen's University
  and was supported through CANARIE's Research Software Program, and Cancer
  Care Ontario.

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

#ifndef __qMRMLTextWidget_h
#define __qMRMLTextWidget_h

// Slicer includes
#include "qSlicerWidget.h"

// Text widgets includes
#include "qSlicerTextsModuleWidgetsExport.h"
#include "ui_qMRMLTextWidget.h"

class vtkMRMLNode;
class vtkMRMLTextNode;
class qMRMLTextWidgetPrivate;
class QTextEdit;

class Q_SLICER_MODULE_TEXTS_WIDGETS_EXPORT qMRMLTextWidget : public qSlicerWidget
{
  Q_OBJECT

public:
  typedef qSlicerWidget Superclass;
  qMRMLTextWidget(QWidget *parent=nullptr);
  ~qMRMLTextWidget() override;

  Q_PROPERTY(bool autoSave READ isAutoSave WRITE setAutoSave);
  Q_PROPERTY(bool editing READ isEditing);
  Q_PROPERTY(bool readOnly READ isReadOnly WRITE setReadOnly);
  Q_PROPERTY(bool wordWrap READ wordWrap WRITE setWordWrap);

  Q_INVOKABLE vtkMRMLTextNode* mrmlTextNode() const;
  Q_INVOKABLE vtkMRMLNode* mrmlNode() const;

  bool isReadOnly();

  bool isAutoSave();

  bool isEditing();

  bool wordWrap();

  Q_INVOKABLE QTextEdit* textEditWidget();

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

  void setReadOnly(bool readOnly);

  void setAutoSave(bool autoSave);

  void setWordWrap(bool wordWrap);

  void setMRMLTextNode(vtkMRMLTextNode* textNode);

  void setMRMLNode(vtkMRMLNode* textNode);

public slots:
  void startEdits();

  void cancelEdits();

  void saveEdits();

signals:
  void updateWidgetFromMRMLRequested();

  void updateMRMLFromWidgetRequested();

  void updateWidgetFromMRMLFinished();

  void updateMRMLFromWidgetFinished();

  void mrmlNodeChanged(vtkMRMLNode*);

  void readOnlyChanged(bool);

  bool autoSaveChanged(bool);

  void editingChanged(bool);

protected slots:
  void updateWidgetFromMRML();

  void updateMRMLFromWidget();

  void onTextNodeContentsModified();

  void onTextEditChanged();

protected:
  QScopedPointer<qMRMLTextWidgetPrivate> d_ptr;

  // Setup the UI and establish connections
  virtual void setup();

private:
  Q_DECLARE_PRIVATE(qMRMLTextWidget);
  Q_DISABLE_COPY(qMRMLTextWidget);

protected:
  bool AutoSave{false};
  bool ReadOnly{false};

};

#endif