1 // Created on: 1998-01-15
2 // Created by: Denis PASCAL
3 // Copyright (c) 1998-1999 Matra Datavision
4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
6 // This file is part of Open CASCADE Technology software library.
8 // This library is free software; you can redistribute it and/or modify it under
9 // the terms of the GNU Lesser General Public License version 2.1 as published
10 // by the Free Software Foundation, with special exception defined in the file
11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12 // distribution for complete text of the license and disclaimer of any warranty.
14 // Alternatively, this file may be used under the terms of Open CASCADE
15 // commercial license or contractual agreement.
17 #ifndef _TDataStd_Comment_HeaderFile
18 #define _TDataStd_Comment_HeaderFile
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
23 #include <TCollection_ExtendedString.hxx>
24 #include <TDF_Attribute.hxx>
25 #include <Standard_OStream.hxx>
26 #include <Standard_Boolean.hxx>
29 class TCollection_ExtendedString;
31 class TDF_RelocationTable;
34 class TDataStd_Comment;
35 DEFINE_STANDARD_HANDLE(TDataStd_Comment, TDF_Attribute)
37 //! Comment attribute. may be associated to any label
38 //! to store user comment.
39 class TDataStd_Comment : public TDF_Attribute
47 //! Returns the GUID for comments.
48 Standard_EXPORT static const Standard_GUID& GetID();
50 //! Find, or create a Comment attribute. the Comment
51 //! attribute is returned.
52 Standard_EXPORT static Handle(TDataStd_Comment) Set (const TDF_Label& label);
54 //! Finds, or creates a Comment attribute and sets the string.
55 //! the Comment attribute is returned.
58 Standard_EXPORT static Handle(TDataStd_Comment) Set (const TDF_Label& label, const TCollection_ExtendedString& string);
60 Standard_EXPORT TDataStd_Comment();
62 Standard_EXPORT void Set (const TCollection_ExtendedString& S);
65 //! Returns the comment attribute.
66 Standard_EXPORT const TCollection_ExtendedString& Get() const;
68 Standard_EXPORT const Standard_GUID& ID() const;
70 Standard_EXPORT void Restore (const Handle(TDF_Attribute)& with);
72 Standard_EXPORT Handle(TDF_Attribute) NewEmpty() const;
74 Standard_EXPORT void Paste (const Handle(TDF_Attribute)& into, const Handle(TDF_RelocationTable)& RT) const;
76 Standard_EXPORT virtual Standard_OStream& Dump (Standard_OStream& anOS) const Standard_OVERRIDE;
78 Standard_EXPORT Standard_Boolean AfterRetrieval (const Standard_Boolean forceIt = Standard_False) Standard_OVERRIDE;
83 DEFINE_STANDARD_RTTI(TDataStd_Comment,TDF_Attribute)
93 TCollection_ExtendedString myString;
104 #endif // _TDataStd_Comment_HeaderFile