0031353: TDocStd_Application does not have api to set progress indicator
[occt.git] / src / CDF / CDF_Store.hxx
1 // Created on: 1995-11-13
2 // Created by: Jean-Louis Frenkel
3 // Copyright (c) 1995-1999 Matra Datavision
4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
5 //
6 // This file is part of Open CASCADE Technology software library.
7 //
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.
13 //
14 // Alternatively, this file may be used under the terms of Open CASCADE
15 // commercial license or contractual agreement.
16
17 #ifndef _CDF_Store_HeaderFile
18 #define _CDF_Store_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_DefineAlloc.hxx>
22 #include <Standard_Handle.hxx>
23
24 #include <Standard_Boolean.hxx>
25 #include <TCollection_ExtendedString.hxx>
26 #include <PCDM_StoreStatus.hxx>
27 #include <CDF_TryStoreStatus.hxx>
28 #include <Standard_ExtString.hxx>
29 #include <CDF_StoreSetNameStatus.hxx>
30 #include <CDF_SubComponentStatus.hxx>
31
32 #include <Message_ProgressIndicator.hxx>
33
34 class CDF_StoreList;
35 class CDM_Document;
36 class TCollection_ExtendedString;
37
38
39
40 class CDF_Store 
41 {
42 public:
43
44   DEFINE_STANDARD_ALLOC
45
46   
47   //! creates a store list  from the document of the current selection.
48   Standard_EXPORT CDF_Store(const Handle(CDM_Document)& aDocument);
49   
50   //! returns the folder in which the current document will be stored.
51   Standard_EXPORT Standard_ExtString Folder() const;
52   
53   //! returns the name under which the current document will be stored
54   Standard_EXPORT Standard_ExtString Name() const;
55   
56   //! returns true if the current document is already stored
57   Standard_EXPORT Standard_Boolean IsStored() const;
58   
59   Standard_EXPORT Standard_Boolean IsModified() const;
60   
61   Standard_EXPORT Standard_Boolean CurrentIsConsistent() const;
62   
63   Standard_EXPORT Standard_Boolean IsConsistent() const;
64   
65   Standard_EXPORT Standard_Boolean HasAPreviousVersion() const;
66   
67   Standard_EXPORT Standard_ExtString PreviousVersion() const;
68   
69   //! returns true if the currentdocument is the main one, ie the document
70   //! of the current selection.
71   Standard_EXPORT Standard_Boolean IsMainDocument() const;
72   
73   //! defines the   folder in which  the document  should be
74   //! stored.  returns  Standard_True if  the Folder exists,
75   //! Standard_False otherwise.
76   Standard_EXPORT Standard_Boolean SetFolder (const TCollection_ExtendedString& aFolder);
77   
78   //! defines the name under which the document should be stored.
79   Standard_EXPORT CDF_StoreSetNameStatus SetName (const Standard_ExtString aName);
80   
81   Standard_EXPORT void SetComment (const Standard_ExtString aComment);
82   
83   Standard_EXPORT Standard_ExtString Comment() const;
84   
85   //! defines the name under which the document should be stored.
86   //! uses for example after modification of the folder.
87   Standard_EXPORT CDF_StoreSetNameStatus RecheckName();
88   
89   Standard_EXPORT Standard_Boolean SetPreviousVersion (const Standard_ExtString aPreviousVersion);
90   
91   Standard_EXPORT void Realize (const Handle(Message_ProgressIndicator)& theProgress = NULL);
92   
93   //! returns the complete path of the created meta-data.
94   Standard_EXPORT Standard_ExtString Path() const;
95   
96   //! returns the path of  the previous store is the object
97   //! is already stored, otherwise an empty string;
98   Standard_EXPORT Standard_ExtString MetaDataPath() const;
99   
100   //! returns the description of the format of the main object.
101   Standard_EXPORT Standard_ExtString Description() const;
102   
103   //! Allows to Start a new Iteration from beginning
104   Standard_EXPORT void InitComponent();
105   
106   //! Returns True if there are more entries to return
107   Standard_EXPORT Standard_Boolean MoreComponent() const;
108   
109   //! Go to the next entry
110   //! (if there is not, Value will raise an exception)
111   Standard_EXPORT void NextComponent();
112   
113   Standard_EXPORT void SetCurrent();
114   
115   //! Returns item value of current entry
116   Standard_EXPORT Standard_ExtString Component() const;
117   
118   Standard_EXPORT Standard_Boolean HasSubComponents() const;
119   
120   Standard_EXPORT CDF_SubComponentStatus SubComponentStatus (const Standard_ExtString aPresentation) const;
121   
122   Standard_EXPORT void SetCurrent (const Standard_ExtString aPresentation);
123   
124   //! the two following methods can
125   //! be used just after Realize  or Import --  method to know if
126   //! thes methods worked correctly, and if not why.
127   Standard_EXPORT void SetMain();
128   
129   Standard_EXPORT PCDM_StoreStatus StoreStatus() const;
130   
131   Standard_EXPORT Standard_ExtString AssociatedStatusText() const;
132   
133   //! defines the name under which the document should be stored.
134   Standard_EXPORT CDF_StoreSetNameStatus SetName (const TCollection_ExtendedString& aName);
135   
136   //! defines the   folder in which  the document  should be
137   //! stored.  returns  Standard_True if  the Folder exists,
138   //! Standard_False otherwise.
139   Standard_EXPORT Standard_Boolean SetFolder (const Standard_ExtString aFolder);
140
141
142
143
144 protected:
145
146
147
148
149
150 private:
151
152   
153   Standard_EXPORT CDF_Store();
154   
155   Standard_EXPORT void FindDefault();
156   
157   Standard_EXPORT void Init();
158
159
160   Handle(CDF_StoreList) myList;
161   Handle(CDM_Document) myMainDocument;
162   Handle(CDM_Document) myCurrentDocument;
163   Standard_Boolean myHasSubComponents;
164   Standard_Boolean myIsMainDocument;
165   TCollection_ExtendedString myPath;
166   TCollection_ExtendedString myText;
167   PCDM_StoreStatus myStatus;
168
169
170 };
171
172
173
174
175
176
177
178 #endif // _CDF_Store_HeaderFile