include/xmloff/XMLEventsImportContext.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_XMLEVENTSIMPORTCONTEXT_HXX
  21 #define INCLUDED_XMLOFF_XMLEVENTSIMPORTCONTEXT_HXX
  22
  23 #include <sal/config.h>
  24 #include <xmloff/dllapi.h>
  25 #include <com/sun/star/uno/Reference.hxx>
  26 #include <com/sun/star/uno/Sequence.hxx>
  27 #include <xmloff/xmlictxt.hxx>
  28 #include <xmloff/xmlevent.hxx>
  29
  30 #include <map>
  31 #include <vector>
  32
  33 namespace com { namespace sun { namespace star {
  34     namespace xml { namespace sax { class XAttributeList; } }
  35     namespace beans { struct PropertyValue; }
  36     namespace container { class XNameReplace; }
  37     namespace document { class XEventsSupplier; }
  38 } } }
  39
  40 typedef ::std::pair<
  41             OUString,
  42             css::uno::Sequence<css::beans::PropertyValue> > EventNameValuesPair;
  43
  44 typedef ::std::vector< EventNameValuesPair > EventsVector;
  45
  46 /**
  47  * Import <script:events> element.
  48  *
  49  * The import context usually sets the events immediately at the event
  50  * XNameReplace. If none was given on construction, it operates in
  51  * delayed mode: All events are collected and may then be set
  52  * with the setEvents() method.
  53  */
  54 class XMLOFF_DLLPUBLIC XMLEventsImportContext : public SvXMLImportContext
  55 {
  56     // the event XNameReplace; may be empty
  57     css::uno::Reference<css::container::XNameReplace> xEvents;
  58
  59 protected:
  60     // if no XNameReplace is given, use this vector to collect events
  61     EventsVector aCollectEvents;
  62
  63 public:
  64
  65
  66     XMLEventsImportContext(
  67         SvXMLImport& rImport,
  68         sal_uInt16 nPrfx,
  69         const OUString& rLocalName);
  70
  71     XMLEventsImportContext(
  72         SvXMLImport& rImport,
  73         sal_uInt16 nPrfx,
  74         const OUString& rLocalName,
  75         const css::uno::Reference<css::document::XEventsSupplier> & xEventsSupplier);
  76
  77     XMLEventsImportContext(
  78         SvXMLImport& rImport,
  79         sal_uInt16 nPrfx,
  80         const OUString& rLocalName,
  81         const css::uno::Reference<css::container::XNameReplace> & xNameRepl);
  82
  83     virtual ~XMLEventsImportContext() override;
  84
  85     void AddEventValues(
  86         const OUString& rEventName,
  87         const css::uno::Sequence<css::beans::PropertyValue> & rValues);
  88
  89     /// if the import operates in delayed mode, you can use this method
  90     /// to set all events that have been read on the XEventsSupplier
  91     void SetEvents(
  92         const css::uno::Reference<css::document::XEventsSupplier> & xEventsSupplier);
  93
  94     /// if the import operates in delayed mode, you can use this method
  95     /// to set all events that have been read on the XNameReplace
  96     void SetEvents(
  97         const css::uno::Reference<css::container::XNameReplace> & xNameRepl);
  98
  99     /// if the import operates in delayed mode, you can use this method
 100     /// to obtain the value sequence for a specific event
 101     void GetEventSequence(
 102         const OUString& rName,
 103         css::uno::Sequence<css::beans::PropertyValue> & rSequence );
 104
 105 protected:
 106
 107     virtual void StartElement(
 108         const css::uno::Reference<css::xml::sax::XAttributeList> & xAttrList) override;
 109
 110     virtual void EndElement() override;
 111
 112     virtual SvXMLImportContext *CreateChildContext(
 113         sal_uInt16 nPrefix,
 114         const OUString& rLocalName,
 115         const css::uno::Reference<css::xml::sax::XAttributeList> & xAttrList ) override;
 116 };
 117
 118 #endif
 119
 120 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */