summaryrefslogtreecommitdiff
path: root/inc/TDataStd_Comment.hxx
blob: 620b5926cf3a1c62a269f561001fff7772ddbaff (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
// This file is generated by WOK (CPPExt).
// Please do not edit this file; modify original file instead.
// The copyright and license terms as defined for the original file apply to 
// this header file considered to be the "object code" form of the original source.

#ifndef _TDataStd_Comment_HeaderFile
#define _TDataStd_Comment_HeaderFile

#ifndef _Standard_HeaderFile
#include <Standard.hxx>
#endif
#ifndef _Standard_DefineHandle_HeaderFile
#include <Standard_DefineHandle.hxx>
#endif
#ifndef _Handle_TDataStd_Comment_HeaderFile
#include <Handle_TDataStd_Comment.hxx>
#endif

#ifndef _TCollection_ExtendedString_HeaderFile
#include <TCollection_ExtendedString.hxx>
#endif
#ifndef _TDF_Attribute_HeaderFile
#include <TDF_Attribute.hxx>
#endif
#ifndef _Handle_TDF_Attribute_HeaderFile
#include <Handle_TDF_Attribute.hxx>
#endif
#ifndef _Handle_TDF_RelocationTable_HeaderFile
#include <Handle_TDF_RelocationTable.hxx>
#endif
#ifndef _Standard_OStream_HeaderFile
#include <Standard_OStream.hxx>
#endif
#ifndef _Standard_Boolean_HeaderFile
#include <Standard_Boolean.hxx>
#endif
class Standard_GUID;
class TDF_Label;
class TCollection_ExtendedString;
class TDF_Attribute;
class TDF_RelocationTable;


//! Comment attribute. may be  associated to any label <br>
//!          to store user comment. <br>
class TDataStd_Comment : public TDF_Attribute {

public:

  //! class methods <br>
//!          ============= <br>//! Returns the GUID for comments. <br>
  Standard_EXPORT   static const Standard_GUID& GetID() ;
  //!  Find, or create  a   Comment attribute.  the  Comment <br>
//!          attribute is returned. <br>
  Standard_EXPORT   static  Handle_TDataStd_Comment Set(const TDF_Label& label) ;
  //! Finds, or creates a Comment attribute and sets the string. <br>
//!          the Comment attribute is returned. <br>//! Comment methods <br>
//!          ============ <br>
  Standard_EXPORT   static  Handle_TDataStd_Comment Set(const TDF_Label& label,const TCollection_ExtendedString& string) ;
  
  Standard_EXPORT   TDataStd_Comment();
  
  Standard_EXPORT     void Set(const TCollection_ExtendedString& S) ;
  
//!    Returns the comment attribute. <br>
  Standard_EXPORT    const TCollection_ExtendedString& Get() const;
  
  Standard_EXPORT    const Standard_GUID& ID() const;
  
  Standard_EXPORT     void Restore(const Handle(TDF_Attribute)& with) ;
  
  Standard_EXPORT     Handle_TDF_Attribute NewEmpty() const;
  
  Standard_EXPORT     void Paste(const Handle(TDF_Attribute)& into,const Handle(TDF_RelocationTable)& RT) const;
  
  Standard_EXPORT   virtual  Standard_OStream& Dump(Standard_OStream& anOS) const;
  
  Standard_EXPORT     Standard_Boolean AfterRetrieval(const Standard_Boolean forceIt = Standard_False) ;




  DEFINE_STANDARD_RTTI(TDataStd_Comment)

protected:




private: 


TCollection_ExtendedString myString;


};





// other Inline functions and methods (like "C++: function call" methods)


#endif