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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
|
/*************************************************************************
*
* 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 SC_XLROOT_HXX
#define SC_XLROOT_HXX
#include <i18npool/lang.h>
#include <sot/storage.hxx>
#include "xlconst.hxx"
#include "xltools.hxx"
namespace comphelper { class IDocPasswordVerifier; }
// Forward declarations of objects in public use ==============================
class DateTime;
struct XclAddress;
struct XclRange;
class XclRangeList;
class XclTokenArray;
// Global data ================================================================
#ifdef DBG_UTIL
/** Counts the number of created root objects. */
struct XclDebugObjCounter
{
sal_Int32 mnObjCnt;
inline explicit XclDebugObjCounter() : mnObjCnt( 0 ) {}
~XclDebugObjCounter();
};
#endif
// ----------------------------------------------------------------------------
class SfxMedium;
class ScEditEngineDefaulter;
class ScHeaderEditEngine;
class EditEngine;
class ScExtDocOptions;
class XclFontPropSetHelper;
class XclChPropSetHelper;
class XclTracer;
struct RootData;//!
/** Stores global buffers and data needed elsewhere in the Excel filters. */
struct XclRootData
#ifdef DBG_UTIL
: public XclDebugObjCounter
#endif
{
typedef ScfRef< ScEditEngineDefaulter > ScEEDefaulterRef;
typedef ScfRef< ScHeaderEditEngine > ScHeaderEERef;
typedef ScfRef< EditEngine > EditEngineRef;
typedef ScfRef< XclFontPropSetHelper > XclFontPropSetHlpRef;
typedef ScfRef< XclChPropSetHelper > XclChPropSetHlpRef;
typedef ScfRef< ScExtDocOptions > ScExtDocOptRef;
typedef ScfRef< XclTracer > XclTracerRef;
typedef ScfRef< RootData > RootDataRef;
XclBiff meBiff; /// Current BIFF version.
XclOutput meOutput; /// Current Output format.
SfxMedium& mrMedium; /// The medium to import from.
SotStorageRef mxRootStrg; /// The root OLE storage of imported/exported file.
ScDocument& mrDoc; /// The source or destination document.
String maDocUrl; /// Document URL of imported/exported file.
String maBasePath; /// Base path of imported/exported file (path of maDocUrl).
String maUserName; /// Current user name.
const String maDefPassword; /// The default password used for stream encryption.
rtl_TextEncoding meTextEnc; /// Text encoding to import/export byte strings.
LanguageType meSysLang; /// System language.
LanguageType meDocLang; /// Document language (import: from file, export: from system).
LanguageType meUILang; /// UI language (import: from file, export: from system).
sal_Int16 mnDefApiScript; /// Default script type for blank cells (API constant).
ScAddress maScMaxPos; /// Highest Calc cell position.
ScAddress maXclMaxPos; /// Highest Excel cell position.
ScAddress maMaxPos; /// Highest position valid in Calc and Excel.
ScEEDefaulterRef mxEditEngine; /// Edit engine for rich strings etc.
ScHeaderEERef mxHFEditEngine; /// Edit engine for header/footer.
EditEngineRef mxDrawEditEng; /// Edit engine for text boxes.
XclFontPropSetHlpRef mxFontPropSetHlp; /// Property set helper for fonts.
XclChPropSetHlpRef mxChPropSetHlp; /// Property set helper for chart filter.
ScExtDocOptRef mxExtDocOpt; /// Extended document options.
XclTracerRef mxTracer; /// Filter tracer.
RootDataRef mxRD; /// Old RootData struct. Will be removed.
double mfScreenPixelX; /// Width of a screen pixel (1/100 mm).
double mfScreenPixelY; /// Height of a screen pixel (1/100 mm).
long mnCharWidth; /// Width of '0' in default font (twips).
SCTAB mnScTab; /// Current Calc sheet index.
const bool mbExport; /// false = Import, true = Export.
explicit XclRootData( XclBiff eBiff, SfxMedium& rMedium,
SotStorageRef xRootStrg, ScDocument& rDoc,
rtl_TextEncoding eTextEnc, bool bExport );
virtual ~XclRootData();
};
// ----------------------------------------------------------------------------
class SfxObjectShell;
class ScModelObj;
class OutputDevice;
class SvNumberFormatter;
class SdrPage;
class ScDocumentPool;
class ScStyleSheetPool;
class ScRangeName;
class ScDBCollection;
struct XclFontData;
/** Access to global data for a filter object (imported or exported document) from other classes. */
class XclRoot
{
public:
explicit XclRoot( XclRootData& rRootData );
XclRoot( const XclRoot& rRoot );
virtual ~XclRoot();
XclRoot& operator=( const XclRoot& rRoot );
/** Returns this root instance - for code readability in derived classes. */
inline const XclRoot& GetRoot() const { return *this; }
/** Returns old RootData struct. Deprecated. */
inline RootData& GetOldRoot() const { return *mrData.mxRD; }
/** Returns the current BIFF version of the importer/exporter. */
inline XclBiff GetBiff() const { return mrData.meBiff; }
/** Returns the current output format of the importer/exporter. */
inline XclOutput GetOutput() const { return mrData.meOutput; }
/** Returns true, if currently a document is imported. */
inline bool IsImport() const { return !mrData.mbExport; }
/** Returns true, if currently a document is exported. */
inline bool IsExport() const { return mrData.mbExport; }
/** Returns the text encoding to import/export byte strings. */
inline rtl_TextEncoding GetTextEncoding() const { return mrData.meTextEnc; }
/** Returns the system language, i.e. for number formats. */
inline LanguageType GetSysLanguage() const { return mrData.meSysLang; }
/** Returns the document language. */
inline LanguageType GetDocLanguage() const { return mrData.meDocLang; }
/** Returns the UI language. */
inline LanguageType GetUILanguage() const { return mrData.meUILang; }
/** Returns the default script type, e.g. for blank cells. */
inline sal_Int16 GetDefApiScript() const { return mrData.mnDefApiScript; }
/** Returns the width of the '0' character (default font) for the current printer (twips). */
inline long GetCharWidth() const { return mrData.mnCharWidth; }
/** Returns the current Calc sheet index. */
inline bool IsInGlobals() const { return mrData.mnScTab == SCTAB_GLOBAL; }
/** Returns the current Calc sheet index. */
inline SCTAB GetCurrScTab() const { return mrData.mnScTab; }
/** Calculates the width of the passed number of pixels in 1/100 mm. */
sal_Int32 GetHmmFromPixelX( double fPixelX ) const;
/** Calculates the height of the passed number of pixels in 1/100 mm. */
sal_Int32 GetHmmFromPixelY( double fPixelY ) const;
/** Returns the medium to import from. */
inline SfxMedium& GetMedium() const { return mrData.mrMedium; }
/** Returns the document URL of the imported/exported file. */
inline const String& GetDocUrl() const { return mrData.maDocUrl; }
/** Returns the base path of the imported/exported file. */
inline const String& GetBasePath() const { return mrData.maBasePath; }
/** Returns the current user name. */
inline const String& GetUserName() const { return mrData.maUserName; }
/** Returns the default password used for stream encryption. */
inline const String& GetDefaultPassword() const { return mrData.maDefPassword; }
/** Requests and verifies a password from the medium or the user. */
String RequestPassword( ::comphelper::IDocPasswordVerifier& rVerifier ) const;
/** Returns the OLE2 root storage of the imported/exported file.
@return Pointer to root storage or 0, if the file is a simple stream. */
inline SotStorageRef GetRootStorage() const { return mrData.mxRootStrg; }
/** Returns true, if the document contains a VBA storage. */
bool HasVbaStorage() const;
/** Tries to open a storage as child of the specified storage for reading or writing. */
SotStorageRef OpenStorage( SotStorageRef xStrg, const String& rStrgName ) const;
/** Tries to open a storage as child of the root storage for reading or writing. */
SotStorageRef OpenStorage( const String& rStrgName ) const;
/** Tries to open a new stream in the specified storage for reading or writing. */
SotStorageStreamRef OpenStream( SotStorageRef xStrg, const String& rStrmName ) const;
/** Tries to open a new stream in the root storage for reading or writing. */
SotStorageStreamRef OpenStream( const String& rStrmName ) const;
/** Returns the destination document (import) or source document (export). */
inline ScDocument& GetDoc() const { return mrData.mrDoc; }
/** Returns pointer to the destination document (import) or source document (export). */
inline ScDocument* GetDocPtr() const { return &mrData.mrDoc; }
/** Returns the object shell of the Calc document. May be 0 (i.e. import from clipboard). */
SfxObjectShell* GetDocShell() const;
/** Returns the object model of the Calc document. */
ScModelObj* GetDocModelObj() const;
/** Returns pointer to the printer of the Calc document. */
OutputDevice* GetPrinter() const;
/** Returns the style sheet pool of the Calc document. */
ScStyleSheetPool& GetStyleSheetPool() const;
/** Returns the defined names container of the Calc document. */
ScRangeName& GetNamedRanges() const;
/** Returns the database ranges container of the Calc document. */
ScDBCollection& GetDatabaseRanges() const;
/** Returns the drawing layer page of the passed sheet, if present. */
SdrPage* GetSdrPage( SCTAB nScTab ) const;
/** Returns the number formatter of the Calc document. */
SvNumberFormatter& GetFormatter() const;
/** Returns the null date of the current number formatter. */
DateTime GetNullDate() const;
/** Converts a date/time value to a floating-point value. */
double GetDoubleFromDateTime( const DateTime& rDateTime ) const;
/** Converts a floating-point value to a date/time value. */
DateTime GetDateTimeFromDouble( double fValue ) const;
/** Returns the edit engine for import/export of rich strings etc. */
ScEditEngineDefaulter& GetEditEngine() const;
/** Returns the edit engine for import/export of headers/footers. */
ScHeaderEditEngine& GetHFEditEngine() const;
/** Returns the edit engine for import/export of drawing text boxes. */
EditEngine& GetDrawEditEngine() const;
/** Returns the property set helper for fonts. */
XclFontPropSetHelper& GetFontPropSetHelper() const;
/** Returns the property set helper for the chart filters. */
XclChPropSetHelper& GetChartPropSetHelper() const;
/** Returns the extended document options. */
ScExtDocOptions& GetExtDocOptions() const;
/** Returns the filter tracer. */
XclTracer& GetTracer() const;
/** Returns the highest possible cell address in a Calc document. */
inline const ScAddress& GetScMaxPos() const { return mrData.maScMaxPos; }
/** Returns the highest possible cell address in an Excel document (using current BIFF version). */
inline const ScAddress& GetXclMaxPos() const { return mrData.maXclMaxPos; }
/** Returns the highest possible cell address valid in Calc and Excel (using current BIFF version). */
inline const ScAddress& GetMaxPos() const { return mrData.maMaxPos; }
/** Sets the document language. */
inline void SetDocLanguage( LanguageType eLang ) { mrData.meDocLang = eLang; }
/** Sets the UI language, i.e. if it has been read from a file. */
inline void SetUILanguage( LanguageType eLang ) { mrData.meUILang = eLang; }
/** Sets the text encoding to import/export byte strings. */
void SetTextEncoding( rtl_TextEncoding eTextEnc );
/** Sets the width of the '0' character (default font) for the current printer (twips).
@param rFontData The font used for the '0' character. */
void SetCharWidth( const XclFontData& rFontData );
/** Sets the current Calc sheet index. */
inline void SetCurrScTab( SCTAB nScTab ) { mrData.mnScTab = nScTab; }
/** Increases the current Calc sheet index by 1. */
inline void IncCurrScTab() { ++mrData.mnScTab; }
private:
mutable XclRootData& mrData; /// Reference to the global data struct.
};
// ============================================================================
#endif
|
