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