xmloff/source/xforms/TokenContext.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 #pragma once
  21
  22 #include <xmloff/xmlictxt.hxx>
  23 #include <xmloff/xmltkmap.hxx>
  24
  25 namespace com::sun::star {
  26     namespace xml::sax { class XFastAttributeList; }
  27     namespace uno { template<typename T> class Reference; }
  28 }
  29
  30 class SvXMLImport;
  31
  32 /** handle attributes through an SvXMLTokenMap */
  33 class TokenContext : public SvXMLImportContext
  34 {
  35 public:
  36     TokenContext( SvXMLImport& rImport );
  37
  38     // implement SvXMLImportContext methods:
  39
  40     /** call HandleAttribute for each attribute in the token map;
  41      * create a warning for all others. Classes that wish to override
  42      * StartElement need to call the parent method. */
  43     virtual void SAL_CALL startFastElement(
  44         sal_Int32 nElement,
  45         const css::uno::Reference< css::xml::sax::XFastAttributeList >& xAttrList ) override;
  46
  47     /** call HandleChild for each child element in the token map;
  48      * create a warning for all others. Classes that wish to override
  49      * CreateChildContext may want to call the parent method for
  50      * handling of defaults. */
  51     virtual css::uno::Reference< css::xml::sax::XFastContextHandler > SAL_CALL createFastChildContext(
  52         sal_Int32 nElement, const css::uno::Reference< css::xml::sax::XFastAttributeList >& AttrList ) override;
  53
  54     virtual css::uno::Reference< css::xml::sax::XFastContextHandler > SAL_CALL createUnknownChildContext(
  55         const OUString& Namespace, const OUString& Name,
  56         const css::uno::Reference< css::xml::sax::XFastAttributeList >& Attribs ) override;
  57
  58     /** Create a warning for all non-namespace character
  59      * content. Classes that wish to deal with character content have
  60      * to override this method anyway, and will thus get rid of the
  61      * warnings. */
  62     virtual void SAL_CALL characters( const OUString& rChars ) override;
  63
  64 protected:
  65     /** will be called for each attribute */
  66     virtual void HandleAttribute(const sax_fastparser::FastAttributeList::FastAttributeIter & aIter ) = 0;
  67
  68     /** will be called for each child element */
  69     virtual SvXMLImportContext* HandleChild(
  70         sal_Int32 nElementToken,
  71         const css::uno::Reference<css::xml::sax::XFastAttributeList>& xAttrList ) = 0;
  72 };
  73
  74 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */