include/xmloff/xmlictxt.hxx

   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 INCLUDED_XMLOFF_XMLICTXT_HXX
  21 #define INCLUDED_XMLOFF_XMLICTXT_HXX
  22
  23 #include <sal/config.h>
  24 #include <xmloff/dllapi.h>
  25 #include <sal/types.h>
  26 #include <com/sun/star/xml/sax/XAttributeList.hpp>
  27 #include <tools/solar.h>
  28 #include <tools/ref.hxx>
  29 #include <rtl/ustring.hxx>
  30 #include <tools/rtti.hxx>
  31
  32 class SvXMLNamespaceMap;
  33 class SvXMLImport;
  34
  35 class XMLOFF_DLLPUBLIC SvXMLImportContext : public SvRefBase
  36 {
  37     friend class SvXMLImport;
  38
  39     SvXMLImport& mrImport;
  40
  41     sal_uInt16       mnPrefix;
  42     OUString maLocalName;
  43
  44     SvXMLNamespaceMap   *mpRewindMap;
  45
  46     SAL_DLLPRIVATE SvXMLNamespaceMap *GetRewindMap() const
  47     { return mpRewindMap; }
  48     SAL_DLLPRIVATE void SetRewindMap( SvXMLNamespaceMap *p ) { mpRewindMap = p; }
  49
  50 protected:
  51
  52     SvXMLImport& GetImport() { return mrImport; }
  53     const SvXMLImport& GetImport() const { return mrImport; }
  54
  55 public:
  56     TYPEINFO();
  57
  58     sal_uInt16 GetPrefix() const { return mnPrefix; }
  59     const OUString& GetLocalName() const { return maLocalName; }
  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     SvXMLImportContext( SvXMLImport& rImport, sal_uInt16 nPrfx,
  66                         const OUString& rLName );
  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 ~SvXMLImportContext();
  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 SvXMLImportContext *CreateChildContext( sal_uInt16 nPrefix,
  77                                    const OUString& rLocalName,
  78                                    const ::com::sun::star::uno::Reference< ::com::sun::star::xml::sax::XAttributeList >& xAttrList );
  79
  80     /** StartElement is called after a context has been constructed and
  81      * before a elements context is parsed. It may be used for actions that
  82      * require virtual methods. The default is to do nothing. */
  83     virtual void StartElement( const ::com::sun::star::uno::Reference< ::com::sun::star::xml::sax::XAttributeList >& xAttrList );
  84
  85     /** EndElement is called before a context will be destructed, but
  86      * after a elements context has been parsed. It may be used for actions
  87      * that require virtual methods. The default is to do nothing. */
  88     virtual void EndElement();
  89
  90     /** This method is called for all characters that are contained in the
  91      * current element. The default is to ignore them. */
  92     virtual void Characters( const OUString& rChars );
  93 };
  94
  95 SV_DECL_REF( SvXMLImportContext )
  96 SV_IMPL_REF( SvXMLImportContext )
  97
  98
  99 #endif // INCLUDED_XMLOFF_XMLICTXT_HXX
 100
 101 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */