LibreOffice Module sc (master) 1
Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
XclExpPivotTableManager Class Reference

The main class for pivot table export. More...

#include <xepivot.hxx>

Inheritance diagram for XclExpPivotTableManager:
[legend]
Collaboration diagram for XclExpPivotTableManager:
[legend]

Public Member Functions

 XclExpPivotTableManager (const XclExpRoot &rRoot)
 
void CreatePivotTables ()
 Creates all pivot tables and caches from the Calc DataPilot objects. More...
 
XclExpRecordRef CreatePivotCachesRecord ()
 Creates a record wrapper for exporting all pivot caches. More...
 
XclExpRecordRef CreatePivotTablesRecord (SCTAB nScTab)
 Creates a record wrapper for exporting all pivot tables of the specified sheet. More...
 
void WritePivotCaches (XclExpStream &rStrm)
 Writes all pivot caches (all Workbook records and cache streams). More...
 
void WritePivotTables (XclExpStream &rStrm, SCTAB nScTab)
 Writes all pivot tables of the specified Calc sheet. More...
 

Private Types

typedef XclExpRecordList< XclExpPivotTableXclExpPivotTableList
 
typedef XclExpPivotTableList::RecordRefType XclExpPivotTableRef
 

Private Member Functions

const XclExpPivotCacheCreatePivotCache (const ScDPObject &rDPObj)
 Finds an existing (if enabled in mbShareCaches) or creates a new pivot cache. More...
 

Private Attributes

XclExpRecordList< XclExpPivotCachemaPCacheList
 
XclExpPivotTableList maPTableList
 List of all pivot caches. More...
 

Additional Inherited Members

- Protected Member Functions inherited from XclExpRoot
 XclExpRoot (XclExpRootData &rExpRootData)
 
const XclExpRootGetRoot () const
 Returns this root instance - for code readability in derived classes. More...
 
bool IsRelUrl () const
 Returns true, if URLs should be stored relative to the document location. More...
 
sc::CompileFormulaContextGetCompileFormulaContext () const
 
XclExpTabInfoGetTabInfo () const
 Returns the buffer for Calc->Excel sheet index conversion. More...
 
XclExpAddressConverterGetAddressConverter () const
 Returns the address converter. More...
 
XclExpFormulaCompilerGetFormulaCompiler () const
 Returns the formula compiler to produce formula token arrays. More...
 
XclExpProgressBarGetProgressBar () const
 Returns the export progress bar. More...
 
XclExpSstGetSst () const
 Returns the shared string table. More...
 
XclExpPaletteGetPalette () const
 Returns the color buffer. More...
 
XclExpFontBufferGetFontBuffer () const
 Returns the font buffer. More...
 
XclExpNumFmtBufferGetNumFmtBuffer () const
 Returns the number format buffer. More...
 
XclExpXFBufferGetXFBuffer () const
 Returns the cell formatting attributes buffer. More...
 
XclExpLinkManagerGetGlobalLinkManager () const
 Returns the global link manager for defined names. More...
 
XclExpLinkManagerGetLocalLinkManager () const
 Returns the local link manager for the current sheet. More...
 
XclExpNameManagerGetNameManager () const
 Returns the buffer that contains internal defined names. More...
 
XclExpObjectManagerGetObjectManager () const
 Returns the drawing object manager. More...
 
XclExpFilterManagerGetFilterManager () const
 Returns the filter manager. More...
 
XclExpPivotTableManagerGetPivotTableManager () const
 Returns the pivot table manager. More...
 
XclExpDxfsGetDxfs () const
 Returns the differential formatting list. More...
 
OStringBuffer & GetStringBuf () const
 Clean and return the OStringBuffer. More...
 
XclExpXmlPivotTableManagerGetXmlPivotTableManager ()
 
XclExpTablesManagerGetTablesManager ()
 
void InitializeConvert ()
 Is called when export filter starts to create the Excel document (all BIFF versions). More...
 
void InitializeGlobals ()
 Is called when export filter starts to create the workbook global data (>=BIFF5). More...
 
void InitializeTable (SCTAB nScTab)
 Is called when export filter starts to create data for a single sheet (all BIFF versions). More...
 
void InitializeSave ()
 Is called before export filter starts to write the records to the stream. More...
 
XclExpRecordRef CreateRecord (sal_uInt16 nRecId) const
 Returns the reference to a record (or record list) representing a root object. More...
 
bool IsDocumentEncrypted () const
 
css::uno::Sequence< css::beans::NamedValue > GetEncryptionData () const
 
- Protected Member Functions inherited from XclRoot
 XclRoot (XclRootData &rRootData)
 
 XclRoot (const XclRoot &rRoot)
 
virtual ~XclRoot ()
 
XclRootoperator= (const XclRoot &rRoot)
 
RootDataGetOldRoot () const
 Returns old RootData struct. More...
 
XclBiff GetBiff () const
 Returns the current BIFF version of the importer/exporter. More...
 
XclOutput GetOutput () const
 Returns the current output format of the importer/exporter. More...
 
bool IsImport () const
 Returns true, if currently a document is imported. More...
 
rtl_TextEncoding GetTextEncoding () const
 Returns the text encoding to import/export byte strings. More...
 
LanguageType GetSysLanguage () const
 Returns the system language, i.e. More...
 
LanguageType GetDocLanguage () const
 Returns the document language. More...
 
LanguageType GetUILanguage () const
 Returns the UI language. More...
 
sal_Int16 GetDefApiScript () const
 Returns the default script type, e.g. More...
 
tools::Long GetCharWidth () const
 Returns the width of the '0' character (default font) for the current printer (twips). More...
 
tools::Long GetSpaceWidth () const
 
bool IsInGlobals () const
 Returns the current Calc sheet index. More...
 
SCTAB GetCurrScTab () const
 Returns the current Calc sheet index. More...
 
sal_Int32 GetHmmFromPixelX (double fPixelX) const
 Calculates the width of the passed number of pixels in 1/100 mm. More...
 
sal_Int32 GetHmmFromPixelY (double fPixelY) const
 Calculates the height of the passed number of pixels in 1/100 mm. More...
 
SfxMediumGetMedium () const
 Returns the medium to import from. More...
 
const OUString & GetDocUrl () const
 Returns the document URL of the imported/exported file. More...
 
const OUString & GetBasePath () const
 Returns the base path of the imported/exported file. More...
 
const OUString & GetUserName () const
 Returns the current user name. More...
 
css::uno::Sequence< css::beans::NamedValue > RequestEncryptionData (::comphelper::IDocPasswordVerifier &rVerifier) const
 Requests and verifies a password from the medium or the user. More...
 
const tools::SvRef< SotStorage > & GetRootStorage () const
 Returns the OLE2 root storage of the imported/exported file. More...
 
bool HasVbaStorage () const
 Returns true, if the document contains a VBA storage. More...
 
tools::SvRef< SotStorageOpenStorage (tools::SvRef< SotStorage > const &xStrg, const OUString &rStrgName) const
 Tries to open a storage as child of the specified storage for reading or writing. More...
 
tools::SvRef< SotStorageOpenStorage (const OUString &rStrgName) const
 Tries to open a storage as child of the root storage for reading or writing. More...
 
tools::SvRef< SotStorageStreamOpenStream (tools::SvRef< SotStorage > const &xStrg, const OUString &rStrmName) const
 Tries to open a new stream in the specified storage for reading or writing. More...
 
tools::SvRef< SotStorageStreamOpenStream (const OUString &rStrmName) const
 Tries to open a new stream in the root storage for reading or writing. More...
 
ScDocumentGetDoc () const
 Returns reference to the destination document (import) or source document (export). More...
 
SfxObjectShellGetDocShell () const
 Returns the object shell of the Calc document. More...
 
ScModelObjGetDocModelObj () const
 Returns the object model of the Calc document. More...
 
OutputDeviceGetPrinter () const
 Returns pointer to the printer of the Calc document. More...
 
ScStyleSheetPoolGetStyleSheetPool () const
 Returns the style sheet pool of the Calc document. More...
 
ScRangeNameGetNamedRanges () const
 Returns the defined names container of the Calc document. More...
 
SdrPageGetSdrPage (SCTAB nScTab) const
 Returns the drawing layer page of the passed sheet, if present. More...
 
SvNumberFormatterGetFormatter () const
 Returns the number formatter of the Calc document. More...
 
DateTime GetNullDate () const
 Returns the null date of the current number formatter. More...
 
sal_uInt16 GetBaseYear () const
 Returns the base year depending on the current null date (1900 or 1904). More...
 
double GetDoubleFromDateTime (const DateTime &rDateTime) const
 Converts a date/time value to a floating-point value. More...
 
DateTime GetDateTimeFromDouble (double fValue) const
 Converts a floating-point value to a date/time value. More...
 
ScEditEngineDefaulterGetEditEngine () const
 Returns the edit engine for import/export of rich strings etc. More...
 
ScHeaderEditEngineGetHFEditEngine () const
 Returns the edit engine for import/export of headers/footers. More...
 
EditEngineGetDrawEditEngine () const
 Returns the edit engine for import/export of drawing text boxes. More...
 
XclFontPropSetHelperGetFontPropSetHelper () const
 Returns the property set helper for fonts. More...
 
XclChPropSetHelperGetChartPropSetHelper () const
 Returns the property set helper for the chart filters. More...
 
ScExtDocOptionsGetExtDocOptions () const
 Returns the extended document options. More...
 
XclTracerGetTracer () const
 Returns the filter tracer. More...
 
const ScAddressGetScMaxPos () const
 Returns the highest possible cell address in a Calc document. More...
 
const ScAddressGetXclMaxPos () const
 Returns the highest possible cell address in an Excel document (using current BIFF version). More...
 
const ScAddressGetMaxPos () const
 Returns the highest possible cell address valid in Calc and Excel (using current BIFF version). More...
 
void SetDocLanguage (LanguageType eLang)
 Sets the document language. More...
 
void SetUILanguage (LanguageType eLang)
 Sets the UI language, i.e. More...
 
void SetTextEncoding (rtl_TextEncoding eTextEnc)
 Sets the text encoding to import/export byte strings. More...
 
void SetCharWidth (const XclFontData &rFontData)
 Sets the width of the '0' - '9' digit character as well as the ' ' space char (using the default font) for the current printer (twips). More...
 
void SetCurrScTab (SCTAB nScTab)
 Sets the current Calc sheet index. More...
 
void IncCurrScTab ()
 Increases the current Calc sheet index by 1. More...
 
- Static Protected Member Functions inherited from XclExpRoot
static css::uno::Sequence< css::beans::NamedValue > GenerateEncryptionData (std::u16string_view aPass)
 
static css::uno::Sequence< css::beans::NamedValue > GenerateDefaultEncryptionData ()
 
- Static Protected Member Functions inherited from XclRoot
static OUString GetDefaultPassword ()
 Returns the default password used for stream encryption. More...
 

Detailed Description

The main class for pivot table export.

This class contains all pivot caches and pivot tables in a Calc document. It creates the pivot cache streams and pivot table records in the main workbook stream. It supports sharing of pivot caches between multiple pivot tables to decrease file size.

Definition at line 405 of file xepivot.hxx.

Member Typedef Documentation

◆ XclExpPivotTableList

Definition at line 429 of file xepivot.hxx.

◆ XclExpPivotTableRef

Definition at line 430 of file xepivot.hxx.

Constructor & Destructor Documentation

◆ XclExpPivotTableManager()

XclExpPivotTableManager::XclExpPivotTableManager ( const XclExpRoot rRoot)
explicit

Definition at line 1625 of file xepivot.cxx.

Member Function Documentation

◆ CreatePivotCache()

const XclExpPivotCache * XclExpPivotTableManager::CreatePivotCache ( const ScDPObject rDPObj)
private

Finds an existing (if enabled in mbShareCaches) or creates a new pivot cache.

Returns
Pointer to the pivot cache or 0, if the passed source range was invalid.

Definition at line 1666 of file xepivot.cxx.

References XclExpRecordList< RecType >::AppendRecord(), XclExpRecordList< RecType >::GetRecord(), XclExpRoot::GetRoot(), ScDPObject::GetSaveData(), XclExpRecordList< RecType >::GetSize(), XclExpPivotCache::HasAddFields(), XclExpPivotCache::HasEqualDataSource(), ScDPDimensionSaveData::HasGroupDimensions(), maPCacheList, and nPos.

Referenced by CreatePivotTables().

◆ CreatePivotCachesRecord()

XclExpRecordRef XclExpPivotTableManager::CreatePivotCachesRecord ( )

Creates a record wrapper for exporting all pivot caches.

Definition at line 1641 of file xepivot.cxx.

◆ CreatePivotTables()

void XclExpPivotTableManager::CreatePivotTables ( )

Creates all pivot tables and caches from the Calc DataPilot objects.

Definition at line 1630 of file xepivot.cxx.

References XclExpRecordList< RecType >::AppendNewRecord(), CreatePivotCache(), XclRoot::GetDoc(), XclExpRoot::GetRoot(), maPTableList, and nCount.

Referenced by ExcTable::FillAsHeaderBinary().

◆ CreatePivotTablesRecord()

XclExpRecordRef XclExpPivotTableManager::CreatePivotTablesRecord ( SCTAB  nScTab)

Creates a record wrapper for exporting all pivot tables of the specified sheet.

Definition at line 1646 of file xepivot.cxx.

◆ WritePivotCaches()

void XclExpPivotTableManager::WritePivotCaches ( XclExpStream rStrm)

Writes all pivot caches (all Workbook records and cache streams).

Definition at line 1651 of file xepivot.cxx.

References maPCacheList, rStrm, and XclExpRecordList< RecType >::Save().

◆ WritePivotTables()

void XclExpPivotTableManager::WritePivotTables ( XclExpStream rStrm,
SCTAB  nScTab 
)

Writes all pivot tables of the specified Calc sheet.

Definition at line 1656 of file xepivot.cxx.

References XclExpRecordList< RecType >::GetRecord(), XclExpRecordList< RecType >::GetSize(), maPTableList, nPos, and rStrm.

Member Data Documentation

◆ maPCacheList

XclExpRecordList< XclExpPivotCache > XclExpPivotTableManager::maPCacheList
private

Definition at line 432 of file xepivot.hxx.

Referenced by CreatePivotCache(), and WritePivotCaches().

◆ maPTableList

XclExpPivotTableList XclExpPivotTableManager::maPTableList
private

List of all pivot caches.

Definition at line 433 of file xepivot.hxx.

Referenced by CreatePivotTables(), and WritePivotTables().


The documentation for this class was generated from the following files: