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

Access to global data from other classes. More...

#include <xeroot.hxx>

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

Public Member Functions

 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
 
- Public 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 Public Member Functions

static css::uno::Sequence< css::beans::NamedValue > GenerateEncryptionData (std::u16string_view aPass)
 
static css::uno::Sequence< css::beans::NamedValue > GenerateDefaultEncryptionData ()
 
- Static Public Member Functions inherited from XclRoot
static OUString GetDefaultPassword ()
 Returns the default password used for stream encryption. More...
 

Private Member Functions

XclExpRootData::XclExpLinkMgrRef const & GetLocalLinkMgrRef () const
 Returns the local or global link manager, depending on current context. More...
 

Private Attributes

XclExpRootDatamrExpData
 

Detailed Description

Access to global data from other classes.

Definition at line 112 of file xeroot.hxx.

Constructor & Destructor Documentation

◆ XclExpRoot()

XclExpRoot::XclExpRoot ( XclExpRootData rExpRootData)
explicit

Definition at line 70 of file xeroot.cxx.

Member Function Documentation

◆ CreateRecord()

XclExpRecordRef XclExpRoot::CreateRecord ( sal_uInt16  nRecId) const

◆ GenerateDefaultEncryptionData()

uno::Sequence< beans::NamedValue > XclExpRoot::GenerateDefaultEncryptionData ( )
static

◆ GenerateEncryptionData()

uno::Sequence< beans::NamedValue > XclExpRoot::GenerateEncryptionData ( std::u16string_view  aPass)
static

◆ GetAddressConverter()

XclExpAddressConverter & XclExpRoot::GetAddressConverter ( ) const

◆ GetCompileFormulaContext()

sc::CompileFormulaContext & XclExpRoot::GetCompileFormulaContext ( ) const
inline

◆ GetDxfs()

XclExpDxfs & XclExpRoot::GetDxfs ( ) const

Returns the differential formatting list.

Definition at line 160 of file xeroot.cxx.

References mrExpData, and XclExpRootData::mxDxfs.

Referenced by XclExpAutofilter::AddColorEntry(), InitializeSave(), XclExpCFImpl::SaveXml(), XclExpAutofilter::SaveXml(), and XclExpDateFormat::SaveXml().

◆ GetEncryptionData()

uno::Sequence< beans::NamedValue > XclExpRoot::GetEncryptionData ( ) const

◆ GetFilterManager()

XclExpFilterManager & XclExpRoot::GetFilterManager ( ) const

Returns the filter manager.

Definition at line 154 of file xeroot.cxx.

References mrExpData, and XclExpRootData::mxFilterMgr.

Referenced by XclExpNameManagerImpl::CreateBuiltInNames(), ExcTable::FillAsTableXml(), and lcl_AddScenariosAndFilters().

◆ GetFontBuffer()

XclExpFontBuffer & XclExpRoot::GetFontBuffer ( ) const

◆ GetFormulaCompiler()

XclExpFormulaCompiler & XclExpRoot::GetFormulaCompiler ( ) const

◆ GetGlobalLinkManager()

XclExpLinkManager & XclExpRoot::GetGlobalLinkManager ( ) const

Returns the global link manager for defined names.

Definition at line 130 of file xeroot.cxx.

References mrExpData, and XclExpRootData::mxGlobLinkMgr.

Referenced by XclExpFmlaCompImpl::Init().

◆ GetLocalLinkManager()

XclExpLinkManager & XclExpRoot::GetLocalLinkManager ( ) const

Returns the local link manager for the current sheet.

Definition at line 136 of file xeroot.cxx.

References GetLocalLinkMgrRef().

Referenced by XclExpFmlaCompImpl::Init(), and XclMacroHelper::SetMacroLink().

◆ GetLocalLinkMgrRef()

XclExpRootData::XclExpLinkMgrRef const & XclExpRoot::GetLocalLinkMgrRef ( ) const
private

Returns the local or global link manager, depending on current context.

Definition at line 357 of file xeroot.cxx.

References XclRoot::IsInGlobals(), mrExpData, XclExpRootData::mxGlobLinkMgr, and XclExpRootData::mxLocLinkMgr.

Referenced by CreateRecord(), and GetLocalLinkManager().

◆ GetNameManager()

XclExpNameManager & XclExpRoot::GetNameManager ( ) const

◆ GetNumFmtBuffer()

XclExpNumFmtBuffer & XclExpRoot::GetNumFmtBuffer ( ) const

◆ GetObjectManager()

XclExpObjectManager & XclExpRoot::GetObjectManager ( ) const

◆ GetPalette()

XclExpPalette & XclExpRoot::GetPalette ( ) const

◆ GetPivotTableManager()

XclExpPivotTableManager & XclExpRoot::GetPivotTableManager ( ) const

Returns the pivot table manager.

Definition at line 166 of file xeroot.cxx.

References mrExpData, and XclExpRootData::mxPTableMgr.

Referenced by ExcTable::FillAsHeaderBinary(), and ExcTable::FillAsTableBinary().

◆ GetProgressBar()

XclExpProgressBar & XclExpRoot::GetProgressBar ( ) const

◆ GetRoot()

const XclExpRoot & XclExpRoot::GetRoot ( ) const
inline

Returns this root instance - for code readability in derived classes.

Definition at line 118 of file xeroot.hxx.

Referenced by XclExpDxfs::addColor(), XclExpPivotCache::AddGroupFields(), XclExpPivotCache::AddStdFields(), XclExpFmlaCompImpl::Append(), XclExpFmlaCompImpl::AppendExt(), XclExpChSourceLink::AppendString(), XclExpChLabelRange::Convert(), XclExpChLabelRange::ConvertAxisPosition(), XclExpChSourceLink::ConvertDataSequence(), XclExpFmlaCompImpl::ConvertRefData(), XclExpChSourceLink::ConvertString(), XclExpChSourceLink::ConvertStringSequence(), XclExpColinfo::ConvertXFIndexes(), XclExpObjectManager::CreateDffAnchor(), XclExpEmbeddedObjectManager::CreateDffAnchor(), XclExpFormulaCompiler::CreateFormula(), XclExpNameManagerImpl::CreateName(), XclExpPivotTableManager::CreatePivotCache(), XclExpPivotTableManager::CreatePivotTables(), ExcAutoFilterRecs::ExcAutoFilterRecs(), ExcTable::FillAsEmptyTable(), ExcTable::FillAsHeaderBinary(), ExcTable::FillAsTableBinary(), ExcTable::FillAsTableXml(), XclExpRow::Finalize(), XclExpArrayBuffer::FindArray(), ExcAutoFilterRecs::GetByCol(), XclExpRowBuffer::GetOrCreateRow(), XclExpFmlaCompImpl::GetScTab(), XclExpDffSheetAnchor::ImplCalcAnchorRect(), XclExpXF::Init(), XclExpChRoot::InitConversion(), XclExpFontBuffer::InitDefaultFonts(), XclExpTablesManager::Initialize(), XclExpXmlPivotTableManager::Initialize(), XclExpColinfoBuffer::Initialize(), InitializeConvert(), InitializeGlobals(), InitializeTable(), XclExpFilterManager::InitTabFilter(), XclExpFontBuffer::Insert(), XclExpNameManagerImpl::InsertBuiltInName(), XclExpXFBuffer::InsertCellXF(), XclExpXFBuffer::InsertDefaultRecords(), XclExpNameManagerImpl::InsertMacroCall(), XclExpNameManagerImpl::InsertRawName(), XclExpXFBuffer::InsertStyleXF(), XclExpNameManagerImpl::InsertUniqueName(), lcl_AddBookviews(), ShapeInteractionHelper::PopulateShapeInteractionInfo(), XclExpFmlaCompImpl::ProcessExternalCellRef(), XclExpFmlaCompImpl::ProcessExternalName(), XclExpFmlaCompImpl::ProcessExternalRangeRef(), XclExpHyperlinkHelper::ProcessUrlField(), XclExpChangeTrack::PushActionRecord(), ExcDocument::ReadDoc(), XclExpDefcolwidth::Save(), XclExpXmlPivotTables::SavePivotTableXml(), XclExpExtCF::SaveXml(), XclExpDefcolwidth::SetDefWidth(), xcl::exp::SparklineBuffer::SparklineBuffer(), XclEscherEx::StartShape(), XclExpObjectManager::StartSheet(), XclExpChangeTrack::Write(), ExcDocument::Write(), XclExpXF::WriteBody(), XclExpPivotCache::WriteCacheStream(), XclEscherClientTextbox::WriteData(), XclExpPivotCache::WriteDconref(), XclExpChangeTrack::WriteUserNamesStream(), XclExpTabViewSettings::WriteWindow2(), ExcDocument::WriteXml(), XclExpCellTable::XclExpCellTable(), XclExpChartObj::XclExpChartObj(), XclExpColorScale::XclExpColorScale(), XclExpCondfmt::XclExpCondfmt(), XclExpCondFormatBuffer::XclExpCondFormatBuffer(), XclExpDataBar::XclExpDataBar(), XclExpDxfs::XclExpDxfs(), XclExpIconSet::XclExpIconSet(), XclExpObjectManager::XclExpObjectManager(), XclExpPageSettings::XclExpPageSettings(), XclObjComment::XclObjComment(), and XclObjDropDown::XclObjDropDown().

◆ GetSst()

XclExpSst & XclExpRoot::GetSst ( ) const

Returns the shared string table.

Definition at line 100 of file xeroot.cxx.

References mrExpData, and XclExpRootData::mxSst.

Referenced by XclExpLabelCell::Init().

◆ GetStringBuf()

OStringBuffer & XclExpRoot::GetStringBuf ( ) const
inline

Clean and return the OStringBuffer.

Definition at line 158 of file xeroot.hxx.

References XclExpRootData::maStringBuf, and mrExpData.

◆ GetTabInfo()

XclExpTabInfo & XclExpRoot::GetTabInfo ( ) const

◆ GetTablesManager()

XclExpTablesManager & XclExpRoot::GetTablesManager ( )

Definition at line 178 of file xeroot.cxx.

References mrExpData, and XclExpRootData::mxTablesMgr.

Referenced by ExcTable::FillAsTableXml(), and ExcDocument::ReadDoc().

◆ GetXFBuffer()

XclExpXFBuffer & XclExpRoot::GetXFBuffer ( ) const

◆ GetXmlPivotTableManager()

XclExpXmlPivotTableManager & XclExpRoot::GetXmlPivotTableManager ( )

Definition at line 172 of file xeroot.cxx.

Referenced by ExcDocument::ReadDoc(), ExcTable::WriteXml(), and ExcDocument::WriteXml().

◆ InitializeConvert()

void XclExpRoot::InitializeConvert ( )

Is called when export filter starts to create the Excel document (all BIFF versions).

Definition at line 184 of file xeroot.cxx.

References GetProgressBar(), GetRoot(), XclExpProgressBar::Initialize(), mrExpData, XclExpRootData::mxAddrConv, XclExpRootData::mxFmlaComp, XclExpRootData::mxProgress, and XclExpRootData::mxTabInfo.

Referenced by ExcDocument::ReadDoc().

◆ InitializeGlobals()

void XclExpRoot::InitializeGlobals ( )

◆ InitializeSave()

void XclExpRoot::InitializeSave ( )

Is called before export filter starts to write the records to the stream.

Definition at line 275 of file xeroot.cxx.

References XclExpPalette::Finalize(), XclExpXFBuffer::Finalize(), XclExpDxfs::Finalize(), GetDxfs(), GetPalette(), and GetXFBuffer().

Referenced by ExcDocument::Write(), and ExcDocument::WriteXml().

◆ InitializeTable()

void XclExpRoot::InitializeTable ( SCTAB  nScTab)

Is called when export filter starts to create data for a single sheet (all BIFF versions).

Definition at line 265 of file xeroot.cxx.

References EXC_BIFF5, XclRoot::GetBiff(), GetRoot(), mrExpData, XclExpRootData::mxLocLinkMgr, and XclRoot::SetCurrScTab().

Referenced by ExcTable::FillAsEmptyTable(), ExcTable::FillAsTableBinary(), and ExcTable::FillAsTableXml().

◆ IsDocumentEncrypted()

bool XclExpRoot::IsDocumentEncrypted ( ) const

◆ IsRelUrl()

bool XclExpRoot::IsRelUrl ( ) const
inline

Returns true, if URLs should be stored relative to the document location.

Definition at line 120 of file xeroot.hxx.

References XclExpRootData::mbRelUrl, and mrExpData.

Referenced by XclExpHyperlink::BuildFileName(), and XclExpUrlHelper::EncodeUrl().

Member Data Documentation

◆ mrExpData

XclExpRootData& XclExpRoot::mrExpData
private

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