vtkMRMLTextNode.h

Go to the documentation of this file.

/*=auto=========================================================================

  Portions (c) Copyright 2009 Brigham and Women's Hospital (BWH) All Rights Reserved.

  See Doc/copyright/copyright.txt
  or http://www.slicer.org/copyright/copyright.txt for details.

  Program:   3D Slicer
  Module:    $RCSfile: vtkMRMLTextNode.h,v $
  Date:      $Date: 2006/03/19 17:12:29 $
  Version:   $Revision: 1.3 $

=========================================================================auto=*/

#ifndef __vtkMRMLTextNode_h
#define __vtkMRMLTextNode_h

// MRML includes
#include <vtkMRMLStorableNode.h>

class  VTK_MRML_EXPORT vtkMRMLTextNode : public vtkMRMLStorableNode
{
public:

  static vtkMRMLTextNode* New();
  vtkTypeMacro(vtkMRMLTextNode, vtkMRMLStorableNode);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  enum
  {
    CreateStorageNodeAuto,
    CreateStorageNodeAlways,
    CreateStorageNodeNever
  };

  vtkMRMLNode* CreateNodeInstance() override;

  void ReadXMLAttributes(const char** atts) override;

  void WriteXML(ostream& of, int indent) override;

  vtkMRMLCopyContentMacro(vtkMRMLTextNode);

  const char* GetNodeTagName() override { return "Text"; };

  void SetText(const std::string &text, int encoding=-1);
  vtkGetMacro(Text, std::string);

  void SetEncoding(int encoding);
  vtkGetMacro(Encoding, int);
  std::string GetEncodingAsString();

  vtkSetClampMacro(ForceCreateStorageNode, int, CreateStorageNodeAuto, CreateStorageNodeNever);
  vtkGetMacro(ForceCreateStorageNode, int);

  vtkMRMLStorageNode* CreateDefaultStorageNode() override;

  std::string GetDefaultStorageNodeClassName(const char* filename=nullptr) override;

  enum
  {
    TextModifiedEvent = 51000, // Invoked if the text OR encoding is changed with SetText() and SetEncoding() methods and is not invoked
                               // if the text and encoding specified in the set methods are the same as the current text and encoding
  };

protected:
  vtkMRMLTextNode();
  ~vtkMRMLTextNode() override;
  vtkMRMLTextNode(const vtkMRMLTextNode&);
  void operator=(const vtkMRMLTextNode&);

  std::string Text;
  int Encoding{VTK_ENCODING_US_ASCII};
  int ForceCreateStorageNode{CreateStorageNodeAuto};

};

#endif