include/opencascade/TDocStd.hxx

0001 // Created on: 1999-04-07
0002 // Created by: Denis PASCAL
0003 // Copyright (c) 1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _TDocStd_HeaderFile
0018 #define _TDocStd_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <TDF_IDList.hxx>
0025
0026 //! This package define  CAF main classes.
0027 //!
0028 //! * The standard application root class
0029 //!
0030 //! * The standard document which contains data
0031 //!
0032 //! * The external reference mechanism between documents
0033 //!
0034 //! * Attributes for Document management
0035 //! Standard documents offer you a ready-to-use
0036 //! document containing a TDF-based data
0037 //! structure. The documents themselves are
0038 //! contained in a class inheriting from
0039 //! TDocStd_Application which manages creation,
0040 //! storage and retrieval of documents.
0041 //! You can implement undo and redo in your
0042 //! document, and refer from the data framework of
0043 //! one document to that of another one. This is
0044 //! done by means of external link attributes, which
0045 //! store the path and the entry of external links. To
0046 //! sum up, standard documents alone provide
0047 //! access to the data framework. They also allow
0048 //! you to:
0049 //! -   Update external links
0050 //! -   Manage the saving and opening of data
0051 //! -   Manage undo/redo functionality.
0052 //! Note
0053 //! For information on the relations between this
0054 //! component of OCAF and the others, refer to the
0055 //! OCAF User's Guide.
0056 class TDocStd
0057 {
0058 public:
0059   DEFINE_STANDARD_ALLOC
0060
0061   //! specific GUID of this package
0062   //! =============================
0063   //! Appends to <anIDList> the list of the attributes
0064   //! IDs of this package. CAUTION: <anIDList> is NOT
0065   //! cleared before use.
0066   Standard_EXPORT static void IDList(TDF_IDList& anIDList);
0067 };
0068
0069 #endif // _TDocStd_HeaderFile