src/TDataStd/TDataStd_ExtStringList.hxx

   1 // Created on: 2007-05-29
   2 // Created by: Vlad Romashko
   3 // Copyright (c) 2007-2014 OPEN CASCADE SAS
   4 //
   5 // This file is part of Open CASCADE Technology software library.
   6 //
   7 // This library is free software; you can redistribute it and/or modify it under
   8 // the terms of the GNU Lesser General Public License version 2.1 as published
   9 // by the Free Software Foundation, with special exception defined in the file
  10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  11 // distribution for complete text of the license and disclaimer of any warranty.
  12 //
  13 // Alternatively, this file may be used under the terms of Open CASCADE
  14 // commercial license or contractual agreement.
  15
  16 #ifndef _TDataStd_ExtStringList_HeaderFile
  17 #define _TDataStd_ExtStringList_HeaderFile
  18
  19 #include <Standard.hxx>
  20 #include <Standard_Type.hxx>
  21
  22 #include <TDataStd_ListOfExtendedString.hxx>
  23 #include <TDF_Attribute.hxx>
  24 #include <Standard_Boolean.hxx>
  25 #include <Standard_Integer.hxx>
  26 #include <Standard_OStream.hxx>
  27 class Standard_GUID;
  28 class TDF_Label;
  29 class TCollection_ExtendedString;
  30 class TDF_Attribute;
  31 class TDF_RelocationTable;
  32
  33
  34 class TDataStd_ExtStringList;
  35 DEFINE_STANDARD_HANDLE(TDataStd_ExtStringList, TDF_Attribute)
  36
  37 //! Contains a list of ExtendedString.
  38 class TDataStd_ExtStringList : public TDF_Attribute
  39 {
  40
  41 public:
  42
  43
  44   //! Static methods
  45   //! ==============
  46   //! Returns the ID of the list of strings attribute.
  47   Standard_EXPORT static const Standard_GUID& GetID();
  48
  49   //! Finds or creates a list of string values attribute.
  50   Standard_EXPORT static Handle(TDataStd_ExtStringList) Set (const TDF_Label& label);
  51
  52   Standard_EXPORT TDataStd_ExtStringList();
  53
  54   Standard_EXPORT Standard_Boolean IsEmpty() const;
  55
  56   Standard_EXPORT Standard_Integer Extent() const;
  57
  58   Standard_EXPORT void Prepend (const TCollection_ExtendedString& value);
  59
  60   Standard_EXPORT void Append (const TCollection_ExtendedString& value);
  61
  62   //! Inserts the <value> before the first meet of <before_value>.
  63   Standard_EXPORT Standard_Boolean InsertBefore (const TCollection_ExtendedString& value, const TCollection_ExtendedString& before_value);
  64
  65   //! Inserts the <value> before the <index> position.
  66   //! The indices start with 1 .. Extent().
  67   Standard_EXPORT Standard_Boolean InsertBefore (const Standard_Integer index, const TCollection_ExtendedString& before_value);
  68
  69   //! Inserts the <value> after the first meet of <after_value>.
  70   Standard_EXPORT Standard_Boolean InsertAfter (const TCollection_ExtendedString& value, const TCollection_ExtendedString& after_value);
  71
  72   //! Inserts the <value> after the <index> position.
  73   //! The indices start with 1 .. Extent().
  74   Standard_EXPORT Standard_Boolean InsertAfter (const Standard_Integer index, const TCollection_ExtendedString& after_value);
  75
  76   //! Removes the first meet of the <value>.
  77   Standard_EXPORT Standard_Boolean Remove (const TCollection_ExtendedString& value);
  78
  79   //! Removes a value at <index> position.
  80   Standard_EXPORT Standard_Boolean Remove (const Standard_Integer index);
  81
  82   Standard_EXPORT void Clear();
  83
  84   Standard_EXPORT const TCollection_ExtendedString& First() const;
  85
  86   Standard_EXPORT const TCollection_ExtendedString& Last() const;
  87
  88   Standard_EXPORT const TDataStd_ListOfExtendedString& List() const;
  89
  90   Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
  91
  92   Standard_EXPORT void Restore (const Handle(TDF_Attribute)& With) Standard_OVERRIDE;
  93
  94   Standard_EXPORT Handle(TDF_Attribute) NewEmpty() const Standard_OVERRIDE;
  95
  96   Standard_EXPORT void Paste (const Handle(TDF_Attribute)& Into, const Handle(TDF_RelocationTable)& RT) const Standard_OVERRIDE;
  97
  98   Standard_EXPORT virtual Standard_OStream& Dump (Standard_OStream& anOS) const Standard_OVERRIDE;
  99
 100
 101
 102
 103   DEFINE_STANDARD_RTTIEXT(TDataStd_ExtStringList,TDF_Attribute)
 104
 105 protected:
 106
 107
 108
 109
 110 private:
 111
 112
 113   TDataStd_ListOfExtendedString myList;
 114
 115
 116 };
 117
 118
 119
 120
 121
 122
 123
 124 #endif // _TDataStd_ExtStringList_HeaderFile