1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef _XMLOFF_XMLEVENTEXPORT_HXX
#define _XMLOFF_XMLEVENTEXPORT_HXX
#include "sal/config.h"
#include "xmloff/dllapi.h"
#include "sal/types.h"
#include <com/sun/star/uno/Sequence.hxx>
#include <com/sun/star/uno/Reference.hxx>
#include <rtl/ustring.hxx>
#include <xmloff/xmlevent.hxx>
#include <map>
class SvXMLExport;
namespace com { namespace sun { namespace star {
namespace document { class XEventsSupplier; }
namespace container { class XNameReplace; }
namespace container { class XNameAccess; }
namespace beans { struct PropertyValue; }
} } }
typedef ::std::map< ::rtl::OUString, XMLEventExportHandler* > HandlerMap;
typedef ::std::map< ::rtl::OUString, XMLEventName > NameMap;
/**
* Export instances of EventsSupplier services. To use this class you
* must fulfill two conditions:
*
* 1) provide a translation from the API event names to XML event
* names
* 2) Register XMLEventExportHandler instances for all script types
* that you would like to export.
*
* The Export()-Methods all have a bUseWhitespace parameter that
* causes the exported elements to be surrounded by whitespace, which
* in turn causes the elements to be indented properly. By default,
* whitespace is used, but it may not be called for in all cases (e.g
* events attached to hyperlink within a paragraph.)
*/
class XMLOFF_DLLPUBLIC XMLEventExport
{
const ::rtl::OUString sEventType;
SvXMLExport& rExport;
HandlerMap aHandlerMap;
NameMap aNameTranslationMap;
bool bExtNamespace;
public:
XMLEventExport(SvXMLExport& rExport,
const XMLEventNameTranslation* pTranslationTable = NULL);
~XMLEventExport();
/// register an EventExportHandler for a particular script type
///
/// The handlers will be deleted when the object is destroyed, hence
/// no pointers to a handler registered with AddHandler() should be
/// held by anyone.
void AddHandler( const ::rtl::OUString& rName,
XMLEventExportHandler* rHandler );
/// register additional event names
void AddTranslationTable( const XMLEventNameTranslation* pTransTable );
/// export the events (calls EventExport::Export(Reference<XNameAcess>) )
void Export( ::com::sun::star::uno::Reference<
::com::sun::star::document::XEventsSupplier> & xAccess,
sal_Bool bUseWhitespace = sal_True);
/// export the events (calls EventExport::Export(Reference<XNameAcess>) )
void Export( ::com::sun::star::uno::Reference<
::com::sun::star::container::XNameReplace> & xAccess,
sal_Bool bUseWhitespace = sal_True);
/// export the events (writes <office:events> element)
void Export( ::com::sun::star::uno::Reference<
::com::sun::star::container::XNameAccess> & xAccess,
sal_Bool bUseWhitespace = sal_True);
/// export the events, but write <officeooo:events> element
/// (for new file format additions)
void ExportExt( ::com::sun::star::uno::Reference<
::com::sun::star::container::XNameAccess> & xAccess,
sal_Bool bUseWhitespace = sal_True);
/// export a single event (writes <office:events> element)
void ExportSingleEvent(
::com::sun::star::uno::Sequence<
::com::sun::star::beans::PropertyValue>& rEventValues,
const ::rtl::OUString& rApiEventName,
sal_Bool bUseWhitespace = sal_True );
private:
/// export one event (start container-element if necessary)
SAL_DLLPRIVATE void ExportEvent(
::com::sun::star::uno::Sequence<
::com::sun::star::beans::PropertyValue>& rEventValues,
const XMLEventName& rXmlEventName,
sal_Bool bUseWhitespace,
sal_Bool& rExported);
/// export the start element
SAL_DLLPRIVATE void StartElement(sal_Bool bUseWhitespace);
/// export the end element
SAL_DLLPRIVATE void EndElement(sal_Bool bUseWhitespace);
};
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
