xmloff/source/transform/IgnoreTContext.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_SOURCE_TRANSFORM_IGNORETCONTEXT_HXX
  21 #define INCLUDED_XMLOFF_SOURCE_TRANSFORM_IGNORETCONTEXT_HXX
  22
  23 #include "TransformerContext.hxx"
  24
  25
  26 class XMLIgnoreTransformerContext : public XMLTransformerContext
  27 {
  28     bool m_bIgnoreCharacters;
  29     bool m_bIgnoreElements;
  30     bool m_bAllowCharactersRecursive;
  31     bool m_bRecursiveUse;
  32
  33 public:
  34     TYPEINFO_OVERRIDE();
  35
  36     // A contexts constructor does anything that is required if an element
  37     // starts. Namespace processing has been done already.
  38     // Note that virtual methods cannot be used inside constructors. Use
  39     // StartElement instead if this is required.
  40     XMLIgnoreTransformerContext( XMLTransformerBase& rTransformer,
  41                            const OUString& rQName,
  42                               bool bIgnoreCharacters,
  43                               bool bIgnoreElements  );
  44     // A contexts constructor does anything that is required if an element
  45     // starts. Namespace processing has been done already.
  46     // Note that virtual methods cannot be used inside constructors. Use
  47     // StartElement instead if this is required.
  48     XMLIgnoreTransformerContext( XMLTransformerBase& rTransformer,
  49                            const OUString& rQName,
  50                               bool bAllowCharactersRecursive );
  51
  52     // A contexts destructor does anything that is required if an element
  53     // ends. By default, nothing is done.
  54     // Note that virtual methods cannot be used inside destructors. Use
  55     // EndElement instead if this is required.
  56     virtual ~XMLIgnoreTransformerContext();
  57
  58     // Create a children element context. By default, the import's
  59     // CreateContext method is called to create a new default context.
  60     virtual XMLTransformerContext *CreateChildContext( sal_uInt16 nPrefix,
  61                                    const OUString& rLocalName,
  62                                    const OUString& rQName,
  63                                    const ::com::sun::star::uno::Reference< ::com::sun::star::xml::sax::XAttributeList >& xAttrList ) SAL_OVERRIDE;
  64
  65     // StartElement is called after a context has been constructed and
  66     // before a elements context is parsed. It may be used for actions that
  67     // require virtual methods. The default is to do nothing.
  68     virtual void StartElement( const ::com::sun::star::uno::Reference< ::com::sun::star::xml::sax::XAttributeList >& xAttrList ) SAL_OVERRIDE;
  69
  70     // EndElement is called before a context will be destructed, but
  71     // after a elements context has been parsed. It may be used for actions
  72     // that require virtual methods. The default is to do nothing.
  73     virtual void EndElement() SAL_OVERRIDE;
  74
  75     // This method is called for all characters that are contained in the
  76     // current element. The default is to ignore them.
  77     virtual void Characters( const OUString& rChars ) SAL_OVERRIDE;
  78 };
  79
  80 #endif // INCLUDED_XMLOFF_SOURCE_TRANSFORM_IGNORETCONTEXT_HXX
  81
  82 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */