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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: xmlfilterbase.hxx,v $
* $Revision: 1.7 $
*
* 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 OOX_CORE_XMLFILTERBASE_HXX
#define OOX_CORE_XMLFILTERBASE_HXX
#include <rtl/ref.hxx>
#include <rtl/string.hxx>
#include <rtl/ustring.hxx>
#include "oox/vml/drawing.hxx"
#include "oox/drawingml/table/tablestylelist.hxx"
#include "oox/core/filterbase.hxx"
#include "oox/core/relations.hxx"
#include <oox/dllapi.h>
namespace com { namespace sun { namespace star {
namespace container { class XNameContainer; }
namespace xml { namespace sax { class XLocator; } }
namespace xml { namespace sax { class XFastDocumentHandler; } }
} } }
namespace oox { namespace drawingml { class Theme; } }
namespace oox { namespace drawingml { namespace chart { class ChartConverter; } } }
namespace sax_fastparser {
class FastSerializerHelper;
typedef boost::shared_ptr< FastSerializerHelper > FSHelperPtr;
}
namespace oox {
namespace core {
class FragmentHandler;
class ModelObjectContainer;
// ============================================================================
struct XmlFilterBaseImpl;
class OOX_DLLPUBLIC XmlFilterBase : public FilterBase
{
public:
explicit XmlFilterBase(
const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& rxFactory );
virtual ~XmlFilterBase();
/** Has to be implemented by each filter, returns the current theme. */
virtual const ::oox::drawingml::Theme*
getCurrentTheme() const = 0;
/** Has to be implemented by each filter to resolve scheme colors. */
virtual sal_Int32 getSchemeClr( sal_Int32 nColorSchemeToken ) const = 0;
/** Has to be implemented by each filter to return drawings collection. */
virtual const ::oox::vml::DrawingPtr
getDrawings() = 0;
/** Has to be implemented by each filter, returns a filter-specific chart
converter object, that should be global per imported document. */
virtual ::oox::drawingml::chart::ChartConverter&
getChartConverter() = 0;
/** Has to be implemented by each filter to return the table style list. */
virtual const ::oox::drawingml::table::TableStyleListPtr getTableStyles() = 0;
// ------------------------------------------------------------------------
/** Returns the fragment path for the passed type, used for fragments
referred by the root relations. */
::rtl::OUString getFragmentPathFromType( const ::rtl::OUString& rType );
/** Imports a fragment using the passed fragment handler, which contains
the full path to the fragment stream.
@return True, if the fragment could be imported.
*/
bool importFragment( const ::rtl::Reference< FragmentHandler >& rxHandler );
/** Imports the relations fragment associated with the specified fragment.
@return The relations collection of the specified fragment.
*/
RelationsRef importRelations( const ::rtl::OUString& rFragmentPath );
/** Adds new relation.
@param rType
Relation type.
@param rTarget
Relation target.
@return Added relation Id.
*/
::rtl::OUString addRelation( const ::rtl::OUString& rType, const ::rtl::OUString& rTarget, const ::rtl::OUString& rTargetMode = ::rtl::OUString() );
/** Adds new relation to part's relations.
@param rPartName
Part name the relations are related to. The relations will be stored in <rPartName::path>/_rels/<rPartName::name>.rels.
@param rType
Relation type.
@param rTarget
Relation target.
@return Added relation Id.
*/
::rtl::OUString addRelation( const ::com::sun::star::uno::Reference< ::com::sun::star::io::XOutputStream > xOutputStream, const ::rtl::OUString& rType, const ::rtl::OUString& rTarget, const ::rtl::OUString& rTargetMode = ::rtl::OUString() );
/** Copies the picture element specified with rPicturePath from the source
document to the target models picture substorage.
@return The URL of the picture in the target models storage.
*/
::rtl::OUString copyPictureStream( const ::rtl::OUString& rPicturePath );
/** Returns object containers for various named drawing objects for the imported document. */
ModelObjectContainer& getModelObjectContainer() const;
/** Opens and returns the specified output stream from the base storage with specified media type.
@param rStreamName
The name of the embedded storage stream. The name may contain
slashes to open streams from embedded substorages. If base stream
access has been enabled in the storage, the base stream can be
accessed by passing an empty string as stream name.
@param rMediaType
The media type string, used in [Content_Types].xml stream in base storage.
@return The opened output stream.
*/
::com::sun::star::uno::Reference< ::com::sun::star::io::XOutputStream >
openOutputStream( const ::rtl::OUString& rStreamName,
const ::rtl::OUString& rMediaType );
/** Opens specified output stream from the base storage with specified media type and returns new fast serializer for that stream.
@param rStreamName
The name of the embedded storage stream. The name may contain
slashes to open streams from embedded substorages. If base stream
access has been enabled in the storage, the base stream can be
accessed by passing an empty string as stream name.
@param rMediaType
The media type string, used in [Content_Types].xml stream in base storage.
@return newly created serializer helper.
*/
::sax_fastparser::FSHelperPtr
openOutputStreamWithSerializer( const ::rtl::OUString& rStreamName,
const ::rtl::OUString& rMediaType );
/** Returns new unique ID for exported document.
@return newly created ID.
*/
inline sal_Int32 GetUniqueId() { return mnMaxDocId++; }
inline ::rtl::OString GetUniqueIdOString() { return ::rtl::OString::valueOf( mnMaxDocId++ ); }
inline ::rtl::OUString GetUniqueIdOUString() { return ::rtl::OUString::valueOf( mnMaxDocId++ ); }
private:
virtual StorageRef implCreateStorage(
::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream >& rxInStream,
::com::sun::star::uno::Reference< ::com::sun::star::io::XStream >& rxStream ) const;
private:
::std::auto_ptr< XmlFilterBaseImpl > mxImpl;
sal_Int32 mnRelId;
sal_Int32 mnMaxDocId;
};
typedef ::rtl::Reference< XmlFilterBase > XmlFilterRef;
// ============================================================================
} // namespace core
} // namespace oox
#endif
|
