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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
|
// 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 _TDocStd_Application_HeaderFile
#define _TDocStd_Application_HeaderFile
#ifndef _Standard_HeaderFile
#include <Standard.hxx>
#endif
#ifndef _Standard_DefineHandle_HeaderFile
#include <Standard_DefineHandle.hxx>
#endif
#ifndef _Handle_TDocStd_Application_HeaderFile
#include <Handle_TDocStd_Application.hxx>
#endif
#ifndef _Handle_Resource_Manager_HeaderFile
#include <Handle_Resource_Manager.hxx>
#endif
#ifndef _Standard_Boolean_HeaderFile
#include <Standard_Boolean.hxx>
#endif
#ifndef _CDF_Application_HeaderFile
#include <CDF_Application.hxx>
#endif
#ifndef _Standard_CString_HeaderFile
#include <Standard_CString.hxx>
#endif
#ifndef _Standard_Integer_HeaderFile
#include <Standard_Integer.hxx>
#endif
#ifndef _Handle_TDocStd_Document_HeaderFile
#include <Handle_TDocStd_Document.hxx>
#endif
#ifndef _PCDM_ReaderStatus_HeaderFile
#include <PCDM_ReaderStatus.hxx>
#endif
#ifndef _PCDM_StoreStatus_HeaderFile
#include <PCDM_StoreStatus.hxx>
#endif
class Resource_Manager;
class Standard_NoSuchObject;
class TDocStd_Document;
class TColStd_SequenceOfExtendedString;
class TCollection_ExtendedString;
//! The abstract root class for all application classes. <br>
//! They are in charge of: <br>
//! - Creating documents <br>
//! - Storing documents and retrieving them <br>
//! - Initializing document views. <br>
//! To create a useful OCAF-based application, you <br>
//! derive a class from Application and implement <br>
//! the methods below. You will have to redefine the <br>
//! deferred (virtual) methods Formats, <br>
//! InitDocument, and Resources, and override others. <br>
//! The application is a container for a document, <br>
//! which in its turn is the container of the data <br>
//! framework made up of labels and attributes. <br>
//! Besides furnishing a container for documents, <br>
//! TDocStd_Application provides the following <br>
//! services for them: <br>
//! - Creation of new documents <br>
//! - Activation of documents in sessions of an application <br>
//! - Storage and retrieval of documents <br>
//! - Initialization of document views. <br>
//! Note: <br>
//! If a client needs detailed information concerning <br>
//! the events during the Open/Store operation, MessageDriver <br>
//! inherited from CDM_MessageDriver of the <br>
//! corresponding application has to be implemented. <br>
//! If the MessageDriver is not defined all messages <br>
//! will be (by default) directed to <br>
//! CDM_NullMessageDriver and will be lost. <br>
class TDocStd_Application : public CDF_Application {
public:
//! Check if meta data driver was successfully loaded <br>
//! by the application constructor <br>
Standard_EXPORT Standard_Boolean IsDriverLoaded() const;
//! create (if not done) a Manager using ResourcesName <br>
//! method. <br>
Standard_EXPORT virtual Handle_Resource_Manager Resources() ;
//! Returns the name of the file containing the <br>
//! resources of this application. <br>
//! In a resource file, the application associates the schema name <br>
//! of the document with the storage and <br>
//! retrieval plug-ins that are to be loaded for each <br>
//! document. On retrieval, the application reads the <br>
//! schema name in the heading of the CSF file and <br>
//! loads the plug-in indicated in the resource file. <br>
//! This plug-in instantiates the actual driver for <br>
//! transient-persistent conversion. <br>
//! Your application can bring this process into play <br>
//! by defining a class which inherits <br>
//! CDF_Application and redefines the function <br>
//! which returns the appropriate resources file. At <br>
//! this point, the function Retrieve and the class <br>
//! CDF_Store can be called. This allows you to <br>
//! deal with storage and retrieval of - as well as <br>
//! copying and pasting - documents. <br>
//! To implement a class like this, several virtual <br>
//! functions should be redefined. In particular, you <br>
//! must redefine the abstract function Resources <br>
//! inherited from the superclass CDM_Application. <br>
Standard_EXPORT virtual Standard_CString ResourcesName() = 0;
//! returns the number of documents handled by the current applicative session. <br>
Standard_EXPORT Standard_Integer NbDocuments() const;
//! Constructs the new document aDoc. <br>
//! aDoc is identified by the index index which is <br>
//! any integer between 1 and n where n is the <br>
//! number of documents returned by NbDocument. <br>
//! Example <br>
//! Handle(TDocStd_Application) <br>
//! anApp; <br>
//! if (!CafTest::Find(A)) return 1; <br>
//! Handle(TDocStd) aDoc; <br>
//! Standard_Integer nbdoc = anApp->NbDocuments(); <br>
//! for (Standard_Integer i = 1; i <= nbdoc; i++) { <br>
//! aApp->GetDocument(i,aDoc); <br>
Standard_EXPORT void GetDocument(const Standard_Integer index,Handle(TDocStd_Document)& aDoc) const;
//! Returns the format name Formats <br>
//! representing the format supported for <br>
//! application documents. <br>
//! This virtual function is to be redefined for each <br>
//! specific application. <br>
Standard_EXPORT virtual void Formats(TColStd_SequenceOfExtendedString& Formats) = 0;
//! Constructs the empty new document aDoc. <br>
//! This document will have the format format. <br>
//! If InitDocument is redefined for a specific <br>
//! application, the new document is handled by the <br>
//! applicative session. <br>
Standard_EXPORT virtual void NewDocument(const TCollection_ExtendedString& format,Handle(TDocStd_Document)& aDoc) ;
//! Initialize the document aDoc for the applicative session. <br>
//! This virtual function is called by NewDocument <br>
//! and is to be redefined for each specific application. <br>//! Modified flag (different of disk version) <br>
//! ============= <br>//! to open/save a document <br>
//! ======================= <br>
Standard_EXPORT virtual void InitDocument(const Handle(TDocStd_Document)& aDoc) const;
//! Close the given document. the document is not any more <br>
//! handled by the applicative session. <br>
Standard_EXPORT void Close(const Handle(TDocStd_Document)& aDoc) ;
//! Returns an index for the document found in the <br>
//! path path in this applicative session. <br>
//! If the returned value is 0, the document is not <br>
//! present in the applicative session. <br>
//! This method can be used for the interactive part <br>
//! of an application. For instance, on a call to <br>
//! Open, the document to be opened may already <br>
//! be in memory. IsInSession checks to see if this <br>
//! is the case. Open can be made to depend on <br>
//! the value of the index returned: if IsInSession <br>
//! returns 0, the document is opened; if it returns <br>
//! another value, a message is displayed asking the <br>
//! user if he wants to override the version of the <br>
//! document in memory. <br>
//! Example: <br>
//! Standard_Integer insession = A->IsInSession(aDoc); <br>
//! if (insession > 0) { <br>
//! cout << "document " << insession << " is already in session" << endl; <br>
//! return 0; <br>
//! } <br>
Standard_EXPORT Standard_Integer IsInSession(const TCollection_ExtendedString& path) const;
//! Retrieves the document aDoc stored under the <br>
//! name aName in the directory directory. <br>
//! In order not to override a version of aDoc which <br>
//! is already in memory, this method can be made <br>
//! to depend on the value returned by IsInSession. <br>
Standard_EXPORT PCDM_ReaderStatus Open(const TCollection_ExtendedString& path,Handle(TDocStd_Document)& aDoc) ;
//! Save the active document in the file <name> in the <br>
//! path <path> ; o verwrites the file if it already exists. <br>
Standard_EXPORT PCDM_StoreStatus SaveAs(const Handle(TDocStd_Document)& aDoc,const TCollection_ExtendedString& path) ;
//! Save aDoc active document. <br>
//! Exceptions: <br>
//! Standard_NotImplemented if the document <br>
//! was not retrieved in the applicative session by using Open. <br>
Standard_EXPORT PCDM_StoreStatus Save(const Handle(TDocStd_Document)& aDoc) ;
//! Save the active document in the file <name> in the <br>
//! path <path> . overwrite the file if it <br>
//! already exist. <br>
Standard_EXPORT PCDM_StoreStatus SaveAs(const Handle(TDocStd_Document)& aDoc,const TCollection_ExtendedString& path,TCollection_ExtendedString& theStatusMessage) ;
//! Save the document overwriting the previous file <br>
Standard_EXPORT PCDM_StoreStatus Save(const Handle(TDocStd_Document)& aDoc,TCollection_ExtendedString& theStatusMessage) ;
friend class TDocStd_Document;
DEFINE_STANDARD_RTTI(TDocStd_Application)
protected:
Standard_EXPORT TDocStd_Application();
//! Notification that is fired at each OpenTransaction event. <br>
Standard_EXPORT virtual void OnOpenTransaction(const Handle(TDocStd_Document)& theDoc) ;
//! Notification that is fired at each CommitTransaction event. <br>
Standard_EXPORT virtual void OnCommitTransaction(const Handle(TDocStd_Document)& theDoc) ;
//! Notification that is fired at each AbortTransaction event. <br>
Standard_EXPORT virtual void OnAbortTransaction(const Handle(TDocStd_Document)& theDoc) ;
private:
Handle_Resource_Manager myResources;
Standard_Boolean myIsDriverLoaded;
};
// other Inline functions and methods (like "C++: function call" methods)
#endif
|
