1 | // |
---|
2 | // Notation.h |
---|
3 | // |
---|
4 | // $Id: //poco/1.3/XML/include/Poco/DOM/Notation.h#1 $ |
---|
5 | // |
---|
6 | // Library: XML |
---|
7 | // Package: DOM |
---|
8 | // Module: DOM |
---|
9 | // |
---|
10 | // Definition of the DOM Notation class. |
---|
11 | // |
---|
12 | // Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH. |
---|
13 | // and Contributors. |
---|
14 | // |
---|
15 | // Permission is hereby granted, free of charge, to any person or organization |
---|
16 | // obtaining a copy of the software and accompanying documentation covered by |
---|
17 | // this license (the "Software") to use, reproduce, display, distribute, |
---|
18 | // execute, and transmit the Software, and to prepare derivative works of the |
---|
19 | // Software, and to permit third-parties to whom the Software is furnished to |
---|
20 | // do so, all subject to the following: |
---|
21 | // |
---|
22 | // The copyright notices in the Software and this entire statement, including |
---|
23 | // the above license grant, this restriction and the following disclaimer, |
---|
24 | // must be included in all copies of the Software, in whole or in part, and |
---|
25 | // all derivative works of the Software, unless such copies or derivative |
---|
26 | // works are solely in the form of machine-executable object code generated by |
---|
27 | // a source language processor. |
---|
28 | // |
---|
29 | // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
---|
30 | // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
---|
31 | // FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT |
---|
32 | // SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE |
---|
33 | // FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, |
---|
34 | // ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
---|
35 | // DEALINGS IN THE SOFTWARE. |
---|
36 | // |
---|
37 | |
---|
38 | |
---|
39 | #ifndef DOM_Notation_INCLUDED |
---|
40 | #define DOM_Notation_INCLUDED |
---|
41 | |
---|
42 | |
---|
43 | #include "Poco/XML/XML.h" |
---|
44 | #include "Poco/DOM/AbstractNode.h" |
---|
45 | #include "Poco/XML/XMLString.h" |
---|
46 | |
---|
47 | |
---|
48 | namespace Poco { |
---|
49 | namespace XML { |
---|
50 | |
---|
51 | |
---|
52 | class XML_API Notation: public AbstractNode |
---|
53 | /// This interface represents a notation declared in the DTD. A notation either |
---|
54 | /// declares, by name, the format of an unparsed entity (see section 4.7 of |
---|
55 | /// the XML 1.0 specification <http://www.w3.org/TR/2004/REC-xml-20040204/>), |
---|
56 | /// or is used for formal declaration of processing |
---|
57 | /// instruction targets (see section 2.6 of the XML 1.0 specification). |
---|
58 | /// The nodeName attribute inherited from Node is set to the declared name of |
---|
59 | /// the notation. |
---|
60 | /// |
---|
61 | /// The DOM Level 1 does not support editing Notation nodes; they are therefore |
---|
62 | /// readonly. |
---|
63 | /// |
---|
64 | /// A Notation node does not have any parent. |
---|
65 | { |
---|
66 | public: |
---|
67 | const XMLString& publicId() const; |
---|
68 | /// Returns the public identifier of this notation. |
---|
69 | /// If not specified, this is an empty string (and not null, |
---|
70 | /// as in the DOM specification). |
---|
71 | |
---|
72 | const XMLString& systemId() const; |
---|
73 | /// Returns the system identifier of this notation. |
---|
74 | /// If not specified, this is an empty string (and not null, |
---|
75 | /// as in the DOM specification). |
---|
76 | |
---|
77 | // Node |
---|
78 | const XMLString& nodeName() const; |
---|
79 | unsigned short nodeType() const; |
---|
80 | |
---|
81 | protected: |
---|
82 | Notation(Document* pOwnerDocument, const XMLString& name, const XMLString& publicId, const XMLString& systemId); |
---|
83 | Notation(Document* pOwnerDocument, const Notation& notation); |
---|
84 | ~Notation(); |
---|
85 | |
---|
86 | Node* copyNode(bool deep, Document* pOwnerDocument) const; |
---|
87 | |
---|
88 | private: |
---|
89 | XMLString _name; |
---|
90 | XMLString _publicId; |
---|
91 | XMLString _systemId; |
---|
92 | |
---|
93 | friend class Document; |
---|
94 | }; |
---|
95 | |
---|
96 | |
---|
97 | // |
---|
98 | // inlines |
---|
99 | // |
---|
100 | inline const XMLString& Notation::publicId() const |
---|
101 | { |
---|
102 | return _publicId; |
---|
103 | } |
---|
104 | |
---|
105 | |
---|
106 | inline const XMLString& Notation::systemId() const |
---|
107 | { |
---|
108 | return _systemId; |
---|
109 | } |
---|
110 | |
---|
111 | |
---|
112 | } } // namespace Poco::XML |
---|
113 | |
---|
114 | |
---|
115 | #endif // DOM_Notation_INCLUDED |
---|