xref: /aoo42x/main/unoxml/source/dom/attr.hxx (revision cdf0e10c)
1*cdf0e10cSrcweir /*************************************************************************
2*cdf0e10cSrcweir  *
3*cdf0e10cSrcweir  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir  *
5*cdf0e10cSrcweir  * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir  *
7*cdf0e10cSrcweir  * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir  *
9*cdf0e10cSrcweir  * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir  *
11*cdf0e10cSrcweir  * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir  * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir  * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir  *
15*cdf0e10cSrcweir  * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir  * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir  * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir  *
21*cdf0e10cSrcweir  * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir  * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir  * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir  * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir  *
26*cdf0e10cSrcweir  ************************************************************************/
27*cdf0e10cSrcweir 
28*cdf0e10cSrcweir #ifndef DOM_ATTR_HXX
29*cdf0e10cSrcweir #define DOM_ATTR_HXX
30*cdf0e10cSrcweir 
31*cdf0e10cSrcweir #include <memory>
32*cdf0e10cSrcweir 
33*cdf0e10cSrcweir #include <libxml/tree.h>
34*cdf0e10cSrcweir 
35*cdf0e10cSrcweir #include <cppuhelper/implbase1.hxx>
36*cdf0e10cSrcweir 
37*cdf0e10cSrcweir #include <com/sun/star/uno/Reference.h>
38*cdf0e10cSrcweir #include <com/sun/star/xml/dom/XNode.hpp>
39*cdf0e10cSrcweir #include <com/sun/star/xml/dom/XAttr.hpp>
40*cdf0e10cSrcweir 
41*cdf0e10cSrcweir #include <node.hxx>
42*cdf0e10cSrcweir 
43*cdf0e10cSrcweir using ::rtl::OUString;
44*cdf0e10cSrcweir using namespace com::sun::star::uno;
45*cdf0e10cSrcweir using namespace com::sun::star::xml::dom;
46*cdf0e10cSrcweir 
47*cdf0e10cSrcweir namespace DOM
48*cdf0e10cSrcweir {
49*cdf0e10cSrcweir     typedef ::std::pair< ::rtl::OString, ::rtl::OString > stringpair_t;
50*cdf0e10cSrcweir 
51*cdf0e10cSrcweir     typedef ::cppu::ImplInheritanceHelper1< CNode, XAttr > CAttr_Base;
52*cdf0e10cSrcweir 
53*cdf0e10cSrcweir     class CAttr
54*cdf0e10cSrcweir         : public CAttr_Base
55*cdf0e10cSrcweir     {
56*cdf0e10cSrcweir     private:
57*cdf0e10cSrcweir         friend class CDocument;
58*cdf0e10cSrcweir 
59*cdf0e10cSrcweir     private:
60*cdf0e10cSrcweir         xmlAttrPtr m_aAttrPtr;
61*cdf0e10cSrcweir         ::std::auto_ptr< stringpair_t > m_pNamespace;
62*cdf0e10cSrcweir 
63*cdf0e10cSrcweir     protected:
64*cdf0e10cSrcweir         CAttr(CDocument const& rDocument, ::osl::Mutex const& rMutex,
65*cdf0e10cSrcweir                 xmlAttrPtr const pAttr);
66*cdf0e10cSrcweir 
67*cdf0e10cSrcweir     public:
68*cdf0e10cSrcweir         /// return the libxml namespace corresponding to m_pNamespace on pNode
69*cdf0e10cSrcweir         xmlNsPtr GetNamespace(xmlNodePtr const pNode);
70*cdf0e10cSrcweir 
71*cdf0e10cSrcweir         virtual bool IsChildTypeAllowed(NodeType const nodeType);
72*cdf0e10cSrcweir 
73*cdf0e10cSrcweir         /**
74*cdf0e10cSrcweir         Returns the name of this attribute.
75*cdf0e10cSrcweir         */
76*cdf0e10cSrcweir         virtual OUString SAL_CALL getName() throw (RuntimeException);
77*cdf0e10cSrcweir 
78*cdf0e10cSrcweir         /**
79*cdf0e10cSrcweir         The Element node this attribute is attached to or null if this
80*cdf0e10cSrcweir         attribute is not in use.
81*cdf0e10cSrcweir         */
82*cdf0e10cSrcweir         virtual Reference< XElement > SAL_CALL getOwnerElement() throw (RuntimeException);
83*cdf0e10cSrcweir 
84*cdf0e10cSrcweir         /**
85*cdf0e10cSrcweir         If this attribute was explicitly given a value in the original
86*cdf0e10cSrcweir         document, this is true; otherwise, it is false.
87*cdf0e10cSrcweir         */
88*cdf0e10cSrcweir         virtual sal_Bool SAL_CALL getSpecified()throw (RuntimeException);
89*cdf0e10cSrcweir 
90*cdf0e10cSrcweir         /**
91*cdf0e10cSrcweir         On retrieval, the value of the attribute is returned as a string.
92*cdf0e10cSrcweir         */
93*cdf0e10cSrcweir         virtual OUString SAL_CALL getValue() throw (RuntimeException);
94*cdf0e10cSrcweir 
95*cdf0e10cSrcweir         /**
96*cdf0e10cSrcweir         Sets the value of the attribute from a string.
97*cdf0e10cSrcweir         */
98*cdf0e10cSrcweir 
99*cdf0e10cSrcweir         virtual void SAL_CALL setValue(const OUString& value) throw (RuntimeException, DOMException);
100*cdf0e10cSrcweir 
101*cdf0e10cSrcweir         // resolve uno inheritance problems...
102*cdf0e10cSrcweir         // overrides for XNode base
103*cdf0e10cSrcweir         virtual OUString SAL_CALL getNodeName()
104*cdf0e10cSrcweir             throw (RuntimeException);
105*cdf0e10cSrcweir         virtual OUString SAL_CALL getNodeValue()
106*cdf0e10cSrcweir             throw (RuntimeException);
107*cdf0e10cSrcweir         virtual OUString SAL_CALL getLocalName()
108*cdf0e10cSrcweir             throw (RuntimeException);
109*cdf0e10cSrcweir 
110*cdf0e10cSrcweir     // --- delegation for XNde base.
111*cdf0e10cSrcweir     virtual Reference< XNode > SAL_CALL appendChild(const Reference< XNode >& newChild)
112*cdf0e10cSrcweir         throw (RuntimeException, DOMException)
113*cdf0e10cSrcweir     {
114*cdf0e10cSrcweir         return CNode::appendChild(newChild);
115*cdf0e10cSrcweir     }
116*cdf0e10cSrcweir     virtual Reference< XNode > SAL_CALL cloneNode(sal_Bool deep)
117*cdf0e10cSrcweir         throw (RuntimeException)
118*cdf0e10cSrcweir     {
119*cdf0e10cSrcweir         return CNode::cloneNode(deep);
120*cdf0e10cSrcweir     }
121*cdf0e10cSrcweir     virtual Reference< XNamedNodeMap > SAL_CALL getAttributes()
122*cdf0e10cSrcweir         throw (RuntimeException)
123*cdf0e10cSrcweir     {
124*cdf0e10cSrcweir         return CNode::getAttributes();
125*cdf0e10cSrcweir     }
126*cdf0e10cSrcweir     virtual Reference< XNodeList > SAL_CALL getChildNodes()
127*cdf0e10cSrcweir         throw (RuntimeException)
128*cdf0e10cSrcweir     {
129*cdf0e10cSrcweir         return CNode::getChildNodes();
130*cdf0e10cSrcweir     }
131*cdf0e10cSrcweir     virtual Reference< XNode > SAL_CALL getFirstChild()
132*cdf0e10cSrcweir         throw (RuntimeException)
133*cdf0e10cSrcweir     {
134*cdf0e10cSrcweir         return CNode::getFirstChild();
135*cdf0e10cSrcweir     }
136*cdf0e10cSrcweir     virtual Reference< XNode > SAL_CALL getLastChild()
137*cdf0e10cSrcweir         throw (RuntimeException)
138*cdf0e10cSrcweir     {
139*cdf0e10cSrcweir         return CNode::getLastChild();
140*cdf0e10cSrcweir     }
141*cdf0e10cSrcweir     virtual OUString SAL_CALL getNamespaceURI()
142*cdf0e10cSrcweir         throw (RuntimeException);
143*cdf0e10cSrcweir     virtual Reference< XNode > SAL_CALL getNextSibling()
144*cdf0e10cSrcweir         throw (RuntimeException)
145*cdf0e10cSrcweir     {
146*cdf0e10cSrcweir         return CNode::getNextSibling();
147*cdf0e10cSrcweir     }
148*cdf0e10cSrcweir     virtual NodeType SAL_CALL getNodeType()
149*cdf0e10cSrcweir         throw (RuntimeException)
150*cdf0e10cSrcweir     {
151*cdf0e10cSrcweir         return CNode::getNodeType();
152*cdf0e10cSrcweir     }
153*cdf0e10cSrcweir     virtual Reference< XDocument > SAL_CALL getOwnerDocument()
154*cdf0e10cSrcweir         throw (RuntimeException)
155*cdf0e10cSrcweir     {
156*cdf0e10cSrcweir         return CNode::getOwnerDocument();
157*cdf0e10cSrcweir     }
158*cdf0e10cSrcweir     virtual Reference< XNode > SAL_CALL getParentNode()
159*cdf0e10cSrcweir         throw (RuntimeException)
160*cdf0e10cSrcweir     {
161*cdf0e10cSrcweir         return CNode::getParentNode();
162*cdf0e10cSrcweir     }
163*cdf0e10cSrcweir     virtual OUString SAL_CALL getPrefix()
164*cdf0e10cSrcweir         throw (RuntimeException);
165*cdf0e10cSrcweir     virtual Reference< XNode > SAL_CALL getPreviousSibling()
166*cdf0e10cSrcweir         throw (RuntimeException)
167*cdf0e10cSrcweir     {
168*cdf0e10cSrcweir         return CNode::getPreviousSibling();
169*cdf0e10cSrcweir     }
170*cdf0e10cSrcweir     virtual sal_Bool SAL_CALL hasAttributes()
171*cdf0e10cSrcweir         throw (RuntimeException)
172*cdf0e10cSrcweir     {
173*cdf0e10cSrcweir         return CNode::hasAttributes();
174*cdf0e10cSrcweir     }
175*cdf0e10cSrcweir     virtual sal_Bool SAL_CALL hasChildNodes()
176*cdf0e10cSrcweir         throw (RuntimeException)
177*cdf0e10cSrcweir     {
178*cdf0e10cSrcweir         return CNode::hasChildNodes();
179*cdf0e10cSrcweir     }
180*cdf0e10cSrcweir     virtual Reference< XNode > SAL_CALL insertBefore(
181*cdf0e10cSrcweir             const Reference< XNode >& newChild, const Reference< XNode >& refChild)
182*cdf0e10cSrcweir         throw (RuntimeException, DOMException)
183*cdf0e10cSrcweir     {
184*cdf0e10cSrcweir         return CNode::insertBefore(newChild, refChild);
185*cdf0e10cSrcweir     }
186*cdf0e10cSrcweir     virtual sal_Bool SAL_CALL isSupported(const OUString& feature, const OUString& ver)
187*cdf0e10cSrcweir         throw (RuntimeException)
188*cdf0e10cSrcweir     {
189*cdf0e10cSrcweir         return CNode::isSupported(feature, ver);
190*cdf0e10cSrcweir     }
191*cdf0e10cSrcweir     virtual void SAL_CALL normalize()
192*cdf0e10cSrcweir         throw (RuntimeException)
193*cdf0e10cSrcweir     {
194*cdf0e10cSrcweir         CNode::normalize();
195*cdf0e10cSrcweir     }
196*cdf0e10cSrcweir     virtual Reference< XNode > SAL_CALL removeChild(const Reference< XNode >& oldChild)
197*cdf0e10cSrcweir         throw (RuntimeException, DOMException)
198*cdf0e10cSrcweir     {
199*cdf0e10cSrcweir         return CNode::removeChild(oldChild);
200*cdf0e10cSrcweir     }
201*cdf0e10cSrcweir     virtual Reference< XNode > SAL_CALL replaceChild(
202*cdf0e10cSrcweir             const Reference< XNode >& newChild, const Reference< XNode >& oldChild)
203*cdf0e10cSrcweir         throw (RuntimeException, DOMException)
204*cdf0e10cSrcweir     {
205*cdf0e10cSrcweir         return CNode::replaceChild(newChild, oldChild);
206*cdf0e10cSrcweir     }
207*cdf0e10cSrcweir     virtual void SAL_CALL setNodeValue(const OUString& nodeValue)
208*cdf0e10cSrcweir         throw (RuntimeException, DOMException)
209*cdf0e10cSrcweir     {
210*cdf0e10cSrcweir         return setValue(nodeValue);
211*cdf0e10cSrcweir     }
212*cdf0e10cSrcweir     virtual void SAL_CALL setPrefix(const OUString& prefix)
213*cdf0e10cSrcweir         throw (RuntimeException, DOMException);
214*cdf0e10cSrcweir 
215*cdf0e10cSrcweir     };
216*cdf0e10cSrcweir }
217*cdf0e10cSrcweir 
218*cdf0e10cSrcweir #endif
219