- Main Page
- Related Pages
- Modules
- Classes
- Files

# SkipElementHandler.h

Go to the documentation of this file.

    00001 #ifndef FDO_XML_SKIPELEMENTHANDLER_H
    00002 #define FDO_XML_SKIPELEMENTHANDLER_H
    00003 //
    00004
    00005 //
    00006 // Copyright (C) 2004-2006  Autodesk, Inc.
    00007 //
    00008 // This library is free software; you can redistribute it and/or
    00009 // modify it under the terms of version 2.1 of the GNU Lesser
    00010 // General Public License as published by the Free Software Foundation.
    00011 //
    00012 // This library is distributed in the hope that it will be useful,
    00013 // but WITHOUT ANY WARRANTY; without even the implied warranty of
    00014 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    00015 // Lesser General Public License for more details.
    00016 //
    00017 // You should have received a copy of the GNU Lesser General Public
    00018 // License along with this library; if not, write to the Free Software
    00019 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
    00020 //
    00021
    00022 #ifdef _WIN32
    00023 #pragma once
    00024 #endif
    00025
    00026 /// \brief
    00027 /// FdoXmlSkipHandler can be used to skip an XML element, when reading an
    00028 /// XML document via FdoXmlReader. It is a FdoXmlSaxHandler with no callback
    00029 /// implementations. Therefore, if another FdoXmlSaxHandler's XmlStartElement
    00030 /// callback returns a FdoXmlSkipElementHandler then there are no more SAX events
    00031 /// until the end of the current element is reached.
    00032 class FdoXmlSkipElementHandler :
    00033     public FdoDisposable,
    00034     public FdoXmlSaxHandler
    00035 {
    00036 public:
    00037     /// \brief
    00038     /// Constructs a SAX Handler for skipping an element.
    00039     ///
    00040     /// \return
    00041     /// Returns FdoXmlSkipElementHandler
    00042     ///
    00043     FDO_API_COMMON static FdoXmlSkipElementHandler* Create()
    00044     {
    00045         return new FdoXmlSkipElementHandler();
    00046     }
    00047
    00048 /// \cond DOXYGEN-IGNORE
    00049 protected:
    00050     FdoXmlSkipElementHandler() {}
    00051     ~FdoXmlSkipElementHandler() {}
    00052 /// \endcond
    00053 };
    00054
    00055 /// \ingroup (typedefs)
    00056 /// \brief
    00057 /// FdoXmlSkipElementHandlerP is a FdoPtr on FdoXmlSkipElementHandler, provided for convenience.
    00058 typedef FdoPtr<FdoXmlSkipElementHandler> FdoXmlSkipElementHandlerP;
    00059
    00060 #endif
    00061
    00062

Please send us your comment about this page