Line data    Source code

       1             : /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
       2             : /*
       3             :  * This file is part of the LibreOffice project.
       4             :  *
       5             :  * This Source Code Form is subject to the terms of the Mozilla Public
       6             :  * License, v. 2.0. If a copy of the MPL was not distributed with this
       7             :  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
       8             :  *
       9             :  * This file incorporates work covered by the following license notice:
      10             :  *
      11             :  *   Licensed to the Apache Software Foundation (ASF) under one or more
      12             :  *   contributor license agreements. See the NOTICE file distributed
      13             :  *   with this work for additional information regarding copyright
      14             :  *   ownership. The ASF licenses this file to you under the Apache
      15             :  *   License, Version 2.0 (the "License"); you may not use this file
      16             :  *   except in compliance with the License. You may obtain a copy of
      17             :  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
      18             :  */
      19             : 
      20             : #ifndef _XMLOFF_TRANSFORMERCONTEXT_HXX
      21             : #define _XMLOFF_TRANSFORMERCONTEXT_HXX
      22             : 
      23             : #include <com/sun/star/xml/sax/XAttributeList.hpp>
      24             : #include <tools/solar.h>
      25             : #include <salhelper/simplereferenceobject.hxx>
      26             : #include <rtl/ustring.hxx>
      27             : #include <tools/rtti.hxx>
      28             : #include <xmloff/xmltoken.hxx>
      29             : 
      30             : class SvXMLNamespaceMap;
      31             : class XMLTransformerBase;
      32             : 
      33             : class XMLTransformerContext : public ::salhelper::SimpleReferenceObject
      34             : {
      35             :     friend class XMLTransformerBase;
      36             : 
      37             :     XMLTransformerBase& m_rTransformer;
      38             : 
      39             :     ::rtl::OUString m_aQName;
      40             : 
      41             :     SvXMLNamespaceMap   *m_pRewindMap;
      42             : 
      43          93 :     SvXMLNamespaceMap  *GetRewindMap() const { return m_pRewindMap; }
      44           2 :     void SetRewindMap( SvXMLNamespaceMap *p ) { m_pRewindMap = p; }
      45             : 
      46             : protected:
      47             : 
      48          26 :     XMLTransformerBase& GetTransformer() { return m_rTransformer; }
      49           2 :     const XMLTransformerBase& GetTransformer() const { return m_rTransformer; }
      50             : 
      51           0 :     void SetQName( const ::rtl::OUString& rQName ) { m_aQName = rQName; }
      52             : 
      53             : public:
      54             :     TYPEINFO();
      55             : 
      56           0 :     const ::rtl::OUString& GetQName() const { return m_aQName; }
      57             :     sal_Bool HasQName( sal_uInt16 nPrefix,
      58             :                        ::xmloff::token::XMLTokenEnum eToken ) const;
      59             :     sal_Bool HasNamespace( sal_uInt16 nPrefix ) const;
      60             : 
      61             :     // A contexts constructor does anything that is required if an element
      62             :     // starts. Namespace processing has been done already.
      63             :     // Note that virtual methods cannot be used inside constructors. Use
      64             :     // StartElement instead if this is required.
      65             :     XMLTransformerContext( XMLTransformerBase& rTransformer,
      66             :                         const ::rtl::OUString& rQName );
      67             : 
      68             :     // A contexts destructor does anything that is required if an element
      69             :     // ends. By default, nothing is done.
      70             :     // Note that virtual methods cannot be used inside destructors. Use
      71             :     // EndElement instead if this is required.
      72             :     virtual ~XMLTransformerContext();
      73             : 
      74             :     // Create a children element context. By default, the import's
      75             :     // CreateContext method is called to create a new default context.
      76             :     virtual XMLTransformerContext *CreateChildContext( sal_uInt16 nPrefix,
      77             :                                    const ::rtl::OUString& rLocalName,
      78             :                                    const ::rtl::OUString& rQName,
      79             :                                    const ::com::sun::star::uno::Reference< ::com::sun::star::xml::sax::XAttributeList >& xAttrList );
      80             : 
      81             :     // StartElement is called after a context has been constructed and
      82             :     // before a elements context is parsed. It may be used for actions that
      83             :     // require virtual methods. The default is to do nothing.
      84             :     virtual void StartElement( const ::com::sun::star::uno::Reference< ::com::sun::star::xml::sax::XAttributeList >& xAttrList );
      85             : 
      86             :     // EndElement is called before a context will be destructed, but
      87             :     // after a elements context has been parsed. It may be used for actions
      88             :     // that require virtual methods. The default is to do nothing.
      89             :     virtual void EndElement();
      90             : 
      91             :     // This method is called for all characters that are contained in the
      92             :     // current element. The default is to ignore them.
      93             :     virtual void Characters( const ::rtl::OUString& rChars );
      94             : 
      95             :     // Is the current context a persistent one (i.e. one that saves is content
      96             :     // rather than exporting it directly?
      97             :     virtual sal_Bool IsPersistent() const;
      98             : 
      99             :     // Export the whole element. By default, nothing is done here
     100             :     virtual void Export();
     101             : 
     102             :     // Export the element content. By default, nothing is done here
     103             :     virtual void ExportContent();
     104             : };
     105             : 
     106             : 
     107             : #endif  //  _XMLOFF_TRANSFORMERCONTEXT_HXX
     108             : 
     109             : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */