LibreOffice Module xmloff (master) 1
XMLEventExport.hxx
Go to the documentation of this file.
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 <rtl/ustring.hxx>
27#include <xmloff/xmlevent.hxx>
28
29#include <map>
30#include <memory>
31
32class SvXMLExport;
33namespace com::sun::star {
34 namespace document { class XEventsSupplier; }
35 namespace container { class XNameReplace; }
36 namespace container { class XNameAccess; }
37 namespace beans { struct PropertyValue; }
38}
39
40namespace com::sun::star::uno { template <class interface_type> class Reference; }
41namespace com::sun::star::uno { template <typename > class Sequence; }
42
43typedef ::std::map< OUString, std::unique_ptr<XMLEventExportHandler> > HandlerMap;
44typedef ::std::map< OUString, XMLEventName > NameMap;
45
62{
64
67
69
70public:
73
74 XMLEventExport& operator=( XMLEventExport const & ) = delete; // MSVC2017 workaround
75 XMLEventExport( XMLEventExport const & ) = delete; // MSVC2017 workaround
76
82 void AddHandler( const OUString& rName,
83 std::unique_ptr<XMLEventExportHandler> pHandler );
84
86 void AddTranslationTable( const XMLEventNameTranslation* pTransTable );
87
89 void Export( css::uno::Reference<css::document::XEventsSupplier> const & xAccess,
90 bool bUseWhitespace = true);
91
93 void Export( css::uno::Reference<css::container::XNameReplace> const & xAccess,
94 bool bUseWhitespace = true);
95
97 void Export( css::uno::Reference<css::container::XNameAccess> const & xAccess,
98 bool bUseWhitespace = true);
99
102 void ExportExt( css::uno::Reference<css::container::XNameAccess> const & xAccess);
103
105 void ExportSingleEvent(
106 const css::uno::Sequence<css::beans::PropertyValue>& rEventValues,
107 const OUString& rApiEventName,
108 bool bUseWhitespace = true );
109
110private:
111
113 SAL_DLLPRIVATE void ExportEvent(
114 const css::uno::Sequence<css::beans::PropertyValue>& rEventValues,
115 const XMLEventName& rXmlEventName,
116 bool bUseWhitespace,
117 bool& rExported);
118
120 SAL_DLLPRIVATE void StartElement(bool bUseWhitespace);
121
123 SAL_DLLPRIVATE void EndElement(bool bUseWhitespace);
124};
125
126#endif
127
128/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
::std::map< OUString, std::unique_ptr< XMLEventExportHandler > > HandlerMap
::std::map< OUString, XMLEventName > NameMap
::std::map< XMLEventName, OUString > NameMap
Export instances of EventsSupplier services.
void Export(css::uno::Reference< css::container::XNameAccess > const &xAccess, bool bUseWhitespace=true)
export the events (writes <office:events> element)
HandlerMap aHandlerMap
XMLEventExport & operator=(XMLEventExport const &)=delete
void Export(css::uno::Reference< css::container::XNameReplace > const &xAccess, bool bUseWhitespace=true)
export the events (calls EventExport::Export(Reference<XNameAccess>) )
void Export(css::uno::Reference< css::document::XEventsSupplier > const &xAccess, bool bUseWhitespace=true)
export the events (calls EventExport::Export(Reference<XNameAccess>) )
XMLEventExport(XMLEventExport const &)=delete
SvXMLExport & rExport
NameMap aNameTranslationMap
#define XMLOFF_DLLPUBLIC
Definition: dllapi.h:29
Reference
XMLEventNameTranslation: define tables that translate between event names as used in the XML file for...
Definition: xmlevent.hxx:76