diff options
Diffstat (limited to 'sc/source/filter/inc/xeroot.hxx')
| -rw-r--r-- | sc/source/filter/inc/xeroot.hxx | 175 |
1 files changed, 175 insertions, 0 deletions
diff --git a/sc/source/filter/inc/xeroot.hxx b/sc/source/filter/inc/xeroot.hxx new file mode 100644 index 000000000000..980590f9d4ff --- /dev/null +++ b/sc/source/filter/inc/xeroot.hxx @@ -0,0 +1,175 @@ +/************************************************************************* + * + * 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_XEROOT_HXX +#define SC_XEROOT_HXX + +#include "xlroot.hxx" + +// Forward declarations of objects in public use ============================== + +class XclExpStream; +class XclExpRecordBase; +class XclExpString; + +typedef ScfRef< XclExpRecordBase > XclExpRecordRef; +typedef ScfRef< XclExpString > XclExpStringRef; + +// Global data ================================================================ + +class XclExpTabInfo; +class XclExpAddressConverter; +class XclExpFormulaCompiler; +class XclExpProgressBar; +class XclExpSst; +class XclExpPalette; +class XclExpFontBuffer; +class XclExpNumFmtBuffer; +class XclExpXFBuffer; +class XclExpLinkManager; +class XclExpNameManager; +class XclExpObjectManager; +class XclExpFilterManager; +class XclExpPivotTableManager; + +/** Stores global buffers and data needed for Excel export filter. */ +struct XclExpRootData : public XclRootData +{ + typedef ScfRef< XclExpTabInfo > XclExpTabInfoRef; + typedef ScfRef< XclExpAddressConverter > XclExpAddrConvRef; + typedef ScfRef< XclExpFormulaCompiler > XclExpFmlaCompRef; + typedef ScfRef< XclExpProgressBar > XclExpProgressRef; + + typedef ScfRef< XclExpSst > XclExpSstRef; + typedef ScfRef< XclExpPalette > XclExpPaletteRef; + typedef ScfRef< XclExpFontBuffer > XclExpFontBfrRef; + typedef ScfRef< XclExpNumFmtBuffer > XclExpNumFmtBfrRef; + typedef ScfRef< XclExpXFBuffer > XclExpXFBfrRef; + typedef ScfRef< XclExpNameManager > XclExpNameMgrRef; + typedef ScfRef< XclExpLinkManager > XclExpLinkMgrRef; + typedef ScfRef< XclExpObjectManager > XclExpObjectMgrRef; + typedef ScfRef< XclExpFilterManager > XclExpFilterMgrRef; + typedef ScfRef< XclExpPivotTableManager > XclExpPTableMgrRef; + + XclExpTabInfoRef mxTabInfo; /// Calc->Excel sheet index conversion. + XclExpAddrConvRef mxAddrConv; /// The address converter. + XclExpFmlaCompRef mxFmlaComp; /// The formula compiler. + XclExpProgressRef mxProgress; /// The export progress bar. + + XclExpSstRef mxSst; /// The shared string table. + XclExpPaletteRef mxPalette; /// The color buffer. + XclExpFontBfrRef mxFontBfr; /// All fonts in the file. + XclExpNumFmtBfrRef mxNumFmtBfr; /// All number formats in the file. + XclExpXFBfrRef mxXFBfr; /// All XF records in the file. + XclExpNameMgrRef mxNameMgr; /// Internal defined names. + XclExpLinkMgrRef mxGlobLinkMgr; /// Global link manager for defined names. + XclExpLinkMgrRef mxLocLinkMgr; /// Local link manager for a sheet. + XclExpObjectMgrRef mxObjMgr; /// All drawing objects. + XclExpFilterMgrRef mxFilterMgr; /// Manager for filtered areas in all sheets. + XclExpPTableMgrRef mxPTableMgr; /// All pivot tables and pivot caches. + + bool mbRelUrl; /// true = Store URLs relative. + + explicit XclExpRootData( XclBiff eBiff, SfxMedium& rMedium, + SotStorageRef xRootStrg, ScDocument& rDoc, rtl_TextEncoding eTextEnc ); + virtual ~XclExpRootData(); +}; + +// ---------------------------------------------------------------------------- + +/** Access to global data from other classes. */ +class XclExpRoot : public XclRoot +{ +public: + explicit XclExpRoot( XclExpRootData& rExpRootData ); + + /** Returns this root instance - for code readability in derived classes. */ + inline const XclExpRoot& GetRoot() const { return *this; } + /** Returns true, if URLs should be stored relative to the document location. */ + inline bool IsRelUrl() const { return mrExpData.mbRelUrl; } + + /** Returns the buffer for Calc->Excel sheet index conversion. */ + XclExpTabInfo& GetTabInfo() const; + /** Returns the address converter. */ + XclExpAddressConverter& GetAddressConverter() const; + /** Returns the formula compiler to produce formula token arrays. */ + XclExpFormulaCompiler& GetFormulaCompiler() const; + /** Returns the export progress bar. */ + XclExpProgressBar& GetProgressBar() const; + + /** Returns the shared string table. */ + XclExpSst& GetSst() const; + /** Returns the color buffer. */ + XclExpPalette& GetPalette() const; + /** Returns the font buffer. */ + XclExpFontBuffer& GetFontBuffer() const; + /** Returns the number format buffer. */ + XclExpNumFmtBuffer& GetNumFmtBuffer() const; + /** Returns the cell formatting attributes buffer. */ + XclExpXFBuffer& GetXFBuffer() const; + /** Returns the global link manager for defined names. */ + XclExpLinkManager& GetGlobalLinkManager() const; + /** Returns the local link manager for the current sheet. */ + XclExpLinkManager& GetLocalLinkManager() const; + /** Returns the buffer that contains internal defined names. */ + XclExpNameManager& GetNameManager() const; + /** Returns the drawing object manager. */ + XclExpObjectManager& GetObjectManager() const; + /** Returns the filter manager. */ + XclExpFilterManager& GetFilterManager() const; + /** Returns the pivot table manager. */ + XclExpPivotTableManager& GetPivotTableManager() const; + + /** Is called when export filter starts to create the Excel document (all BIFF versions). */ + void InitializeConvert(); + /** Is called when export filter starts to create the workbook global data (>=BIFF5). */ + void InitializeGlobals(); + /** Is called when export filter starts to create data for a single sheet (all BIFF versions). */ + void InitializeTable( SCTAB nScTab ); + /** Is called before export filter starts to write the records to the stream. */ + void InitializeSave(); + /** Returns the reference to a record (or record list) representing a root object. + @param nRecId Identifier that specifies which record is returned. */ + XclExpRecordRef CreateRecord( sal_uInt16 nRecId ) const; + + bool IsDocumentEncrypted() const; + + String GetPassword() const; + +private: + + /** Returns the local or global link manager, depending on current context. */ + XclExpRootData::XclExpLinkMgrRef GetLocalLinkMgrRef() const; + +private: + mutable XclExpRootData& mrExpData; /// Reference to the global export data struct. +}; + +// ============================================================================ + +#endif + |