1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski#if ! defined INCLUDED__com_sun_star_xml_input_XElement_idl__ 24*b1cdbd2cSJim Jagielski#define INCLUDED__com_sun_star_xml_input_XElement_idl__ 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski#include <com/sun/star/xml/input/XAttributes.idl> 27*b1cdbd2cSJim Jagielski#include <com/sun/star/xml/sax/SAXException.idl> 28*b1cdbd2cSJim Jagielski 29*b1cdbd2cSJim Jagielski 30*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module xml { module input { 31*b1cdbd2cSJim Jagielski 32*b1cdbd2cSJim Jagielski/** Capsule around an XML element. 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski @internal 35*b1cdbd2cSJim Jagielski*/ 36*b1cdbd2cSJim Jagielskiinterface XElement : com::sun::star::uno::XInterface 37*b1cdbd2cSJim Jagielski{ 38*b1cdbd2cSJim Jagielski /** Gets the parent context. 39*b1cdbd2cSJim Jagielski 40*b1cdbd2cSJim Jagielski @return 41*b1cdbd2cSJim Jagielski parent context 42*b1cdbd2cSJim Jagielski */ 43*b1cdbd2cSJim Jagielski XElement getParent(); 44*b1cdbd2cSJim Jagielski 45*b1cdbd2cSJim Jagielski /** Gets the localname of this element. 46*b1cdbd2cSJim Jagielski 47*b1cdbd2cSJim Jagielski @return 48*b1cdbd2cSJim Jagielski localname of this element 49*b1cdbd2cSJim Jagielski */ 50*b1cdbd2cSJim Jagielski string getLocalName(); 51*b1cdbd2cSJim Jagielski 52*b1cdbd2cSJim Jagielski /** Gets the namespace uid of this element. 53*b1cdbd2cSJim Jagielski 54*b1cdbd2cSJim Jagielski @return 55*b1cdbd2cSJim Jagielski namespace uid of this element 56*b1cdbd2cSJim Jagielski */ 57*b1cdbd2cSJim Jagielski long getUid(); 58*b1cdbd2cSJim Jagielski 59*b1cdbd2cSJim Jagielski /** Gets the attributes of this element. 60*b1cdbd2cSJim Jagielski 61*b1cdbd2cSJim Jagielski @return 62*b1cdbd2cSJim Jagielski attributes of this element 63*b1cdbd2cSJim Jagielski */ 64*b1cdbd2cSJim Jagielski XAttributes getAttributes(); 65*b1cdbd2cSJim Jagielski 66*b1cdbd2cSJim Jagielski /** Called upon each occuring child element. 67*b1cdbd2cSJim Jagielski 68*b1cdbd2cSJim Jagielski @param uid 69*b1cdbd2cSJim Jagielski namespace uid of element 70*b1cdbd2cSJim Jagielski @param localName 71*b1cdbd2cSJim Jagielski localname of element 72*b1cdbd2cSJim Jagielski @param xAttributes 73*b1cdbd2cSJim Jagielski attributes of element 74*b1cdbd2cSJim Jagielski @return 75*b1cdbd2cSJim Jagielski child import context 76*b1cdbd2cSJim Jagielski */ 77*b1cdbd2cSJim Jagielski XElement startChildElement( 78*b1cdbd2cSJim Jagielski [in] long uid, [in] string localName, [in] XAttributes xAttributes ) 79*b1cdbd2cSJim Jagielski raises (com::sun::star::xml::sax::SAXException); 80*b1cdbd2cSJim Jagielski 81*b1cdbd2cSJim Jagielski /** Called upon retrieval of characters. 82*b1cdbd2cSJim Jagielski 83*b1cdbd2cSJim Jagielski @param chars 84*b1cdbd2cSJim Jagielski characters 85*b1cdbd2cSJim Jagielski */ 86*b1cdbd2cSJim Jagielski void characters( [in] string chars ) 87*b1cdbd2cSJim Jagielski raises (com::sun::star::xml::sax::SAXException); 88*b1cdbd2cSJim Jagielski 89*b1cdbd2cSJim Jagielski /** Receives notification of white space that can be ignored. 90*b1cdbd2cSJim Jagielski 91*b1cdbd2cSJim Jagielski @param whitespace 92*b1cdbd2cSJim Jagielski white space characters 93*b1cdbd2cSJim Jagielski */ 94*b1cdbd2cSJim Jagielski void ignorableWhitespace( [in] string whitespace ) 95*b1cdbd2cSJim Jagielski raises (com::sun::star::xml::sax::SAXException); 96*b1cdbd2cSJim Jagielski 97*b1cdbd2cSJim Jagielski /** Receives notification of a processing instruction. 98*b1cdbd2cSJim Jagielski 99*b1cdbd2cSJim Jagielski @param target 100*b1cdbd2cSJim Jagielski target 101*b1cdbd2cSJim Jagielski @param data 102*b1cdbd2cSJim Jagielski data 103*b1cdbd2cSJim Jagielski */ 104*b1cdbd2cSJim Jagielski void processingInstruction( 105*b1cdbd2cSJim Jagielski [in] string target, [in] string data ) 106*b1cdbd2cSJim Jagielski raises (com::sun::star::xml::sax::SAXException); 107*b1cdbd2cSJim Jagielski 108*b1cdbd2cSJim Jagielski /** Receives notification of element closing. 109*b1cdbd2cSJim Jagielski */ 110*b1cdbd2cSJim Jagielski void endElement() 111*b1cdbd2cSJim Jagielski raises (com::sun::star::xml::sax::SAXException); 112*b1cdbd2cSJim Jagielski}; 113*b1cdbd2cSJim Jagielski 114*b1cdbd2cSJim Jagielski}; }; }; }; }; 115*b1cdbd2cSJim Jagielski 116*b1cdbd2cSJim Jagielski#endif 117