LibreOffice Module xmloff (master)  1
XMLAutoTextEventExport.cxx
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 
21 #include <com/sun/star/xml/sax/XDocumentHandler.hpp>
22 #include <com/sun/star/util/MeasureUnit.hpp>
23 #include <com/sun/star/document/XEventsSupplier.hpp>
24 #include <com/sun/star/container/XNameReplace.hpp>
25 #include <com/sun/star/container/XNameAccess.hpp>
26 #include <com/sun/star/uno/Reference.hxx>
27 #include <com/sun/star/uno/Sequence.hxx>
28 #include <com/sun/star/uno/Exception.hpp>
29 #include <com/sun/star/uno/XComponentContext.hpp>
30 #include <osl/diagnose.h>
31 #include <xmloff/xmlnamespace.hxx>
32 #include <xmloff/namespacemap.hxx>
33 #include <xmloff/xmltoken.hxx>
35 #include <tools/debug.hxx>
37 
38 
39 using namespace ::com::sun::star;
40 using namespace ::xmloff::token;
41 
42 using ::com::sun::star::container::XNameReplace;
43 using ::com::sun::star::document::XEventsSupplier;
44 using ::com::sun::star::lang::XMultiServiceFactory;
45 using ::com::sun::star::uno::Any;
46 using ::com::sun::star::uno::Exception;
47 using ::com::sun::star::uno::Reference;
48 using ::com::sun::star::uno::Sequence;
49 using ::com::sun::star::uno::XInterface;
50 using ::com::sun::star::uno::UNO_QUERY;
51 using ::com::sun::star::xml::sax::XDocumentHandler;
52 
53 
55  const css::uno::Reference< css::uno::XComponentContext >& xContext,
56  OUString const & implementationName, SvXMLExportFlags nFlags
57  )
58 : SvXMLExport(xContext, implementationName, util::MeasureUnit::INCH, XML_AUTO_TEXT, nFlags)
59 {
60 }
61 
63 {
64 }
65 
67  const Sequence<Any> & rArguments )
68 {
69  if (rArguments.getLength() > 1)
70  {
71  Reference<XEventsSupplier> xSupplier;
72  rArguments[1] >>= xSupplier;
73  if (xSupplier.is())
74  {
75  xEvents = xSupplier->getEvents();
76  }
77  else
78  {
79  Reference<XNameReplace> xReplace;
80  rArguments[1] >>= xReplace;
81  if (xReplace.is())
82  {
83  xEvents = xReplace;
84  }
85  else
86  {
87  rArguments[1] >>= xEvents;
88  }
89  }
90  }
91 
92  // call super class (for XHandler)
93  SvXMLExport::initialize(rArguments);
94 }
95 
96 
98 {
100  {
102  try
103  {
104 
105  Sequence<Any> aArgs{ Any(GetDocHandler()) };
106 
107  // get filter component
109  xContext->getServiceManager()->createInstanceWithArgumentsAndContext(
110  "com.sun.star.comp.Oasis2OOoTransformer",
111  aArgs,
112  xContext),
113  UNO_QUERY);
114  OSL_ENSURE( xTmpDocHandler.is(),
115  "can't instantiate OASIS transformer component" );
116  if( xTmpDocHandler.is() )
117  {
118  SetDocHandler( xTmpDocHandler );
119  }
120  }
121  catch( css::uno::Exception& )
122  {
123  }
124  }
125  if (hasEvents())
126  {
127  GetDocHandler()->startDocument();
128 
130 
131  addNamespaces();
132 
133  {
134  // container element
135  SvXMLElementExport aContainerElement(
137  true, true);
138 
139  exportEvents();
140  }
141 
142  // and close document again
143  GetDocHandler()->endDocument();
144  }
145 
146  return ERRCODE_NONE;
147 }
148 
150 {
151  // TODO: provide full implementation that check for presence of events
152  return xEvents.is();
153 }
154 
156 {
157  // namespaces for office:, text: and script:
159  GetNamespaceMap().GetAttrNameByIndex( XML_NAMESPACE_OFFICE ),
160  GetNamespaceMap().GetNameByIndex( XML_NAMESPACE_OFFICE ) );
162  GetNamespaceMap().GetAttrNameByIndex( XML_NAMESPACE_TEXT ),
163  GetNamespaceMap().GetNameByIndex( XML_NAMESPACE_TEXT ) );
165  GetNamespaceMap().GetAttrNameByIndex( XML_NAMESPACE_SCRIPT ),
166  GetNamespaceMap().GetNameByIndex( XML_NAMESPACE_SCRIPT ) );
168  GetNamespaceMap().GetAttrNameByIndex( XML_NAMESPACE_DOM ),
169  GetNamespaceMap().GetNameByIndex( XML_NAMESPACE_DOM ) );
171  GetNamespaceMap().GetAttrNameByIndex( XML_NAMESPACE_OOO ),
172  GetNamespaceMap().GetNameByIndex( XML_NAMESPACE_OOO ) );
174  GetNamespaceMap().GetAttrNameByIndex( XML_NAMESPACE_XLINK ),
175  GetNamespaceMap().GetNameByIndex( XML_NAMESPACE_XLINK ) );
176 }
177 
179 {
180  DBG_ASSERT(hasEvents(), "no events to export!");
181 
183 }
184 
185 
186 // methods without content:
187 
195 
196 
197 // methods to support the component registration
198 
199 extern "C" SAL_DLLPUBLIC_EXPORT css::uno::XInterface*
201  css::uno::XComponentContext* context, css::uno::Sequence<css::uno::Any> const&)
202 {
203  return cppu::acquire(new XMLAutoTextEventExport(
204  context, "com.sun.star.comp.Writer.XMLOasisAutotextEventsExporter",
206 }
207 
208 extern "C" SAL_DLLPUBLIC_EXPORT css::uno::XInterface*
210  css::uno::XComponentContext* context, css::uno::Sequence<css::uno::Any> const&)
211 {
212  return cppu::acquire(new XMLAutoTextEventExport(
213  context, "com.sun.star.comp.Writer.XMLAutotextEventsExporter",
215 }
216 
217 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
exports com.sun.star.lib. util
constexpr sal_uInt16 XML_NAMESPACE_OFFICE
virtual void ExportContent_() override
Override this method to export the content of .
constexpr sal_uInt16 XML_NAMESPACE_SCRIPT
virtual void ExportMeta_() override
Override this method to export the content of .
void addChaffWhenEncryptedStorage()
Definition: xmlexp.cxx:1189
SvXMLExportFlags
Definition: xmlexp.hxx:91
constexpr sal_uInt16 XML_NAMESPACE_XLINK
constexpr sal_uInt16 XML_NAMESPACE_OOO
XMLAutoTextEventExport(const css::uno::Reference< css::uno::XComponentContext > &xContext, OUString const &implementationName, SvXMLExportFlags nFlags)
Component for the export of events attached to autotext blocks.
const css::uno::Reference< css::xml::sax::XDocumentHandler > & GetDocHandler() const
Definition: xmlexp.hxx:384
virtual ErrCode exportDoc(enum::xmloff::token::XMLTokenEnum eClass=xmloff::token::XML_TOKEN_INVALID) override
export the events off all autotexts
constexpr sal_uInt16 XML_NAMESPACE_DOM
SvXMLAttributeList & GetAttrList()
Definition: xmlexp.hxx:379
SAL_DLLPUBLIC_EXPORT css::uno::XInterface * com_sun_star_comp_Writer_XMLOasisAutotextEventsExporter_get_implementation(css::uno::XComponentContext *context, css::uno::Sequence< css::uno::Any > const &)
virtual void SAL_CALL initialize(const css::uno::Sequence< css::uno::Any > &aArguments) override
Definition: xmlexp.cxx:653
virtual void ExportMasterStyles_() override
Override this method to export the contents of .
#define DBG_ASSERT(sCon, aError)
XMLEventExport & GetEventExport()
get Event export, with handlers for script types "None" and "StarBasic" already registered; other han...
Definition: xmlexp.cxx:1994
constexpr sal_uInt16 XML_NAMESPACE_TEXT
const css::uno::Reference< css::uno::XComponentContext > & getComponentContext() const
Definition: xmlexp.hxx:522
void exportEvents()
export the events element
virtual ~XMLAutoTextEventExport() override
void SetDocHandler(const css::uno::Reference< css::xml::sax::XDocumentHandler > &rHandler)
Definition: xmlexp.cxx:286
const SvXMLNamespaceMap & GetNamespaceMap() const
Definition: xmlexp.hxx:390
SAL_DLLPUBLIC_EXPORT css::uno::XInterface * com_sun_star_comp_Writer_XMLAutotextEventsExporter_get_implementation(css::uno::XComponentContext *context, css::uno::Sequence< css::uno::Any > const &)
virtual void ExportFontDecls_() override
Override this method to export the font declarations The default implementation will export the conte...
#define ERRCODE_NONE
Handling of tokens in XML:
XMLTokenEnum
The enumeration of all XML tokens.
Definition: xmltoken.hxx:49
virtual void SAL_CALL initialize(const css::uno::Sequence< css::uno::Any > &rArguments) override
bool hasEvents() const
does the document have any events ?
css::uno::Reference< css::container::XNameAccess > xEvents
virtual void ExportAutoStyles_() override
Override this method to export the contents of .
void AddAttribute(const OUString &sName, const OUString &sValue)
Definition: attrlist.cxx:110
virtual void ExportStyles_(bool bUsed) override
Override this method to export the content of .
virtual void ExportScripts_() override
Override this method to export the content of .
SvXMLExportFlags getExportFlags() const
Definition: xmlexp.hxx:478
void addNamespaces()
add the namespaces used by events (to be called for the document element)
void Export(css::uno::Reference< css::document::XEventsSupplier > const &xAccess, bool bUseWhitespace=true)
export the events (calls EventExport::Export(Reference) )