cd671d6812450f1d51d7a66eb9c6dab617e35c3f
[occt.git] / src / LDOM / LDOM_Document.hxx
1 // Created on: 2001-06-25
2 // Created by: Alexander GRIGORIEV
3 // Copyright (c) 2001-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 LDOM_Document_HeaderFile
17 #define LDOM_Document_HeaderFile
18
19 #include <LDOM_Element.hxx>
20 #include <LDOM_Text.hxx>
21 #include <LDOM_CDATASection.hxx>
22 #include <LDOM_Comment.hxx>
23
24 //  Class LDOM_Document
25
26 class LDOM_Document 
27 {
28  public:
29   // ---------- PUBLIC METHODS ----------
30   Standard_EXPORT LDOM_Document ();
31   // Empty constructor
32
33   Standard_EXPORT LDOM_Document (const LDOM_MemManager& aMemManager);
34   // Called by LDOM_MemManager::Doc()
35
36 //  Standard_EXPORT LDOM_Document (const LDOM_Document& theOther);
37   // Copy constructor
38
39   Standard_EXPORT ~LDOM_Document ();
40   // Destructor
41
42   // ---- CREATE ----
43
44   static Standard_EXPORT LDOM_Document
45                 createDocument          (const LDOMString& theQualifiedName);
46   // Create an empty document
47
48   Standard_EXPORT LDOM_Element
49                 createElement           (const LDOMString& theTagName);
50
51 //  Standard_EXPORT LDOM_Element
52 //                createElementNS         (const LDOMString& theNSuri,
53 //                                         const LDOMString& theQualName);
54
55   Standard_EXPORT LDOM_CDATASection
56                 createCDATASection      (const LDOMString& theData);
57
58   Standard_EXPORT LDOM_Comment
59                 createComment           (const LDOMString& theData);
60
61   Standard_EXPORT LDOM_Text
62                 createTextNode          (const LDOMString& theData);
63
64   // ---- GET ----
65
66   Standard_EXPORT LDOM_Element
67                 getDocumentElement      () const;
68
69   Standard_EXPORT LDOM_NodeList
70                 getElementsByTagName    (const LDOMString& theTagName) const;
71
72   // ---- COMPARE ----
73
74   Standard_Boolean
75                 operator ==             (const LDOM_Document& anOther) const
76                                 { return myMemManager == anOther.myMemManager; }
77
78   Standard_Boolean
79                 operator !=             (const LDOM_Document& anOther) const
80                                 { return myMemManager != anOther.myMemManager; }
81
82   Standard_Boolean
83                 operator ==             (const LDOM_NullPtr *) const;
84   Standard_Boolean
85                 operator !=             (const LDOM_NullPtr *) const;
86
87   Standard_EXPORT Standard_Boolean
88                 isNull                  () const;
89
90   // ---- UTIL ----
91
92   Standard_EXPORT LDOM_Document&
93                 operator =              (const LDOM_NullPtr *);
94
95  private:
96   friend class LDOM_LDOMImplementation;
97   friend class LDOMString;
98   friend class LDOM_Node;
99   // ---------- PRIVATE FIELDS ----------
100
101   Handle(LDOM_MemManager)       myMemManager;
102 };
103
104 #endif