FDO .NET API Reference Feature Data Objects

mgIXmlSaxHandler.h

Go to the documentation of this file.
00001 /*
00002 * Copyright (C) 2004-2006  Autodesk, Inc.
00003 * 
00004 * This library is free software; you can redistribute it and/or
00005 * modify it under the terms of version 2.1 of the GNU Lesser
00006 * General Public License as published by the Free Software Foundation.
00007 * 
00008 * This library is distributed in the hope that it will be useful,
00009 * but WITHOUT ANY WARRANTY; without even the implied warranty of
00010 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00011 * Lesser General Public License for more details.
00012 * 
00013 * You should have received a copy of the GNU Lesser General Public
00014 * License along with this library; if not, write to the Free Software
00015 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
00016 *
00017 */
00018 
00019 #pragma once
00020 
00021 BEGIN_NAMESPACE_OSGEO_COMMON_XML
00022 public __gc class XmlAttributeCollection;
00023 public __gc class XmlSaxContext;
00024 
00025 /// \ingroup (OSGeoFDOCommonXml)
00026 /// \interface OSGeo::FDO::Common::Xml::IXmlSaxHandler
00027 /// \brief
00028 /// IXmlSaxHandler defines the SAX Handler callback interface.
00029 /// It is not an interface in the strict sense, since each function has a 
00030 /// default implementation that does nothing. Implementors can override these
00031 /// callbacks to customize the handling of XML fragments parsed by XmlReader.
00032 public __gc __interface IXmlSaxHandler : public System::IDisposable
00033 {
00034 public:
00035     /// \brief
00036     /// Default Sax callback that is called when the XmlReader 
00037     /// starts reading an XML document. Does nothing.
00038     /// 
00039     /// \param context 
00040     /// Input caller specified contextual information
00041     /// 
00042     /// \return
00043     /// Returns the SAX Handler for the document's root element. If NULL then 
00044     /// this SAX handler will handle the root element
00045     /// 
00046     NAMESPACE_OSGEO_COMMON_XML::IXmlSaxHandler* XmlStartDocument(NAMESPACE_OSGEO_COMMON_XML::XmlSaxContext* context);
00047 
00048     /// \brief
00049     /// Default Sax callback that is called when the XmlReader 
00050     /// finishes reading an XML document. Does nothing
00051     /// 
00052     /// \param context 
00053     /// Input caller specified contextual information
00054     /// 
00055     System::Void XmlEndDocument(NAMESPACE_OSGEO_COMMON_XML::XmlSaxContext* context);
00056 
00057     /// \brief
00058     /// Default Sax callback that is called when the XmlReader 
00059     /// reads the start tag for an XML element in the document. Does nothing.
00060     /// 
00061     /// \param context 
00062     /// Input caller specified contextual information
00063     /// \param resourceLocation 
00064     /// Input the element's Universal Resource Indicator
00065     /// \param name 
00066     /// Input the unqualified element name (doesn't include namespace)
00067     /// \param qualifiedName 
00068     /// Input the qualified element name (includes namespace)
00069     /// \param attributes 
00070     /// Input the attributes for the element.
00071     /// 
00072     /// \return
00073     /// Returns the SAX Handler for the element's sub-elements. If NULL then 
00074     /// this SAX handler will handle the sub-elements
00075     /// 
00076     NAMESPACE_OSGEO_COMMON_XML::IXmlSaxHandler* XmlStartElement(NAMESPACE_OSGEO_COMMON_XML::XmlSaxContext* context, System::String* resourceLocation, System::String* name, System::String* qualifiedName, NAMESPACE_OSGEO_COMMON_XML::XmlAttributeCollection* attributes);
00077 
00078     /// \brief
00079     /// Default Sax callback that is called when the XmlReader 
00080     /// reads the end tag for an XML element in the document. Does nothing.
00081     /// 
00082     /// \param context 
00083     /// Input caller specified contextual information
00084     /// \param resourceLocation 
00085     /// Input the element's Universal Resource Indicator
00086     /// \param name 
00087     /// Input the unqualified element name (doesn't include namespace)
00088     /// \param qualifiedName 
00089     /// Input the qualified element name (includes namespace)
00090     /// 
00091     /// \return
00092     /// Returning true causes the current parse to stop. Returning false
00093     /// cause the parse to continue. Return value is ignored if the current parse
00094     /// is not an incremental parse ( see XmlReader::Parse())
00095     /// 
00096     System::Boolean XmlEndElement(NAMESPACE_OSGEO_COMMON_XML::XmlSaxContext* context, System::String* resourceLocation, System::String* name, System::String* qualifiedName);
00097 
00098     /// \brief
00099     /// Default Sax callback that is called when the XmlReader 
00100     /// reads a chunk of simple content for the current element. Does nothing by default.
00101     /// This function may be called multiple times for the same element, if the 
00102     /// the content is long. Applications must not make any assumptions about the
00103     /// chunk size or number of chunks for each element
00104     /// 
00105     /// \param context 
00106     /// Input caller specified contextual information
00107     /// \param characters 
00108     /// Input the next chunk of simple content
00109     /// 
00110     System::Void XmlCharacters(NAMESPACE_OSGEO_COMMON_XML::XmlSaxContext* context, System::String* characters);
00111 };
00112 END_NAMESPACE_OSGEO_COMMON_XML
00113 
00114 

Comments or suggestions? Send us feedback.