include/xmloff/XMLEventExport.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_XMLEVENTEXPORT_HXX
  21 #define INCLUDED_XMLOFF_XMLEVENTEXPORT_HXX
  22
  23 #include <sal/config.h>
  24 #include <xmloff/dllapi.h>
  25 #include <sal/types.h>
  26 #include <com/sun/star/uno/Sequence.hxx>
  27 #include <com/sun/star/uno/Reference.hxx>
  28 #include <rtl/ustring.hxx>
  29 #include <xmloff/xmlevent.hxx>
  30
  31 #include <map>
  32
  33 class SvXMLExport;
  34 namespace com { namespace sun { namespace star {
  35     namespace document { class XEventsSupplier; }
  36     namespace container { class XNameReplace; }
  37     namespace container { class XNameAccess; }
  38     namespace beans { struct PropertyValue; }
  39 } } }
  40
  41 typedef ::std::map< OUString, XMLEventExportHandler* > HandlerMap;
  42 typedef ::std::map< OUString, XMLEventName > NameMap;
  43
  44 /**
  45  * Export instances of EventsSupplier services. To use this class you
  46  * must fulfill two conditions:
  47  *
  48  * 1) provide a translation from the API event names to XML event
  49  * names
  50  * 2) Register XMLEventExportHandler instances for all script types
  51  * that you would like to export.
  52  *
  53  * The Export()-Methods all have a bUseWhitespace parameter that
  54  * causes the exported elements to be surrounded by whitespace, which
  55  * in turn causes the elements to be indented properly. By default,
  56  * whitespace is used, but it may not be called for in all cases (e.g
  57  * events attached to hyperlink within a paragraph.)
  58  */
  59 class XMLOFF_DLLPUBLIC XMLEventExport
  60 {
  61     const OUString sEventType;
  62
  63     SvXMLExport& rExport;
  64
  65     HandlerMap aHandlerMap;
  66     NameMap aNameTranslationMap;
  67
  68     bool bExtNamespace;
  69
  70 public:
  71     XMLEventExport(SvXMLExport& rExport);
  72     ~XMLEventExport();
  73
  74     /// register an EventExportHandler for a particular script type
  75     ///
  76     /// The handlers will be deleted when the object is destroyed, hence
  77     /// no pointers to a handler registered with AddHandler() should be
  78     /// held by anyone.
  79     void AddHandler( const OUString& rName,
  80                      XMLEventExportHandler* rHandler );
  81
  82     /// register additional event names
  83     void AddTranslationTable( const XMLEventNameTranslation* pTransTable );
  84
  85     /// export the events (calls EventExport::Export(Reference<XNameAccess>) )
  86     void Export( css::uno::Reference<css::document::XEventsSupplier> & xAccess,
  87                 bool bUseWhitespace = true);
  88
  89     /// export the events (calls EventExport::Export(Reference<XNameAccess>) )
  90     void Export( css::uno::Reference<css::container::XNameReplace> & xAccess,
  91                 bool bUseWhitespace = true);
  92
  93     /// export the events (writes <office:events> element)
  94     void Export( css::uno::Reference<css::container::XNameAccess> & xAccess,
  95                 bool bUseWhitespace = true);
  96
  97     /// export the events, but write <officeooo:events> element
  98     /// (for new file format additions)
  99     void ExportExt( css::uno::Reference<css::container::XNameAccess> & xAccess);
 100
 101     /// export a single event (writes <office:events> element)
 102     void ExportSingleEvent(
 103         css::uno::Sequence<css::beans::PropertyValue>& rEventValues,
 104         const OUString& rApiEventName,
 105         bool bUseWhitespace = true );
 106
 107 private:
 108
 109     /// export one event (start container-element if necessary)
 110     SAL_DLLPRIVATE void ExportEvent(
 111         css::uno::Sequence<css::beans::PropertyValue>& rEventValues,
 112         const XMLEventName& rXmlEventName,
 113         bool bUseWhitespace,
 114         bool& rExported);
 115
 116     /// export the start element
 117     SAL_DLLPRIVATE void StartElement(bool bUseWhitespace);
 118
 119     /// export the end element
 120     SAL_DLLPRIVATE void EndElement(bool bUseWhitespace);
 121 };
 122
 123 #endif
 124
 125 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */