This is the central class for the import of all internal/external links. More...

#include <xilink.hxx>

Inheritance diagram for XclImpLinkManager:

Collaboration diagram for XclImpLinkManager:

Public Member Functions
	XclImpLinkManager (const XclImpRoot &rRoot)

virtual	~XclImpLinkManager () override

void	ReadExternsheet (XclImpStream &rStrm)
	Reads the EXTERNSHEET record. More...

void	ReadSupbook (XclImpStream &rStrm)
	Reads a SUPBOOK record. More...

void	ReadXct (XclImpStream &rStrm)
	Reads an XCT record and appends it to the current SUPBOOK. More...

void	ReadCrn (XclImpStream &rStrm)
	Reads a CRN record and appends it to the current SUPBOOK. More...

void	ReadExternname (XclImpStream &rStrm, ExcelToSc *pFormulaConv)
	Reads an EXTERNNAME record and appends it to the current SUPBOOK. More...

bool	IsSelfRef (sal_uInt16 nXtiIndex) const
	Returns true, if the specified XTI entry contains an internal reference. More...

bool	GetScTabRange (SCTAB &rnFirstScTab, SCTAB &rnLastScTab, sal_uInt16 nXtiIndex) const
	Returns the Calc sheet index range of the specified XTI entry. More...

const XclImpExtName *	GetExternName (sal_uInt16 nXtiIndex, sal_uInt16 nExtName) const
	Returns the specified external name or 0 on error. More...

const OUString *	GetSupbookUrl (sal_uInt16 nXtiIndex) const

OUString	GetSupbookTabName (sal_uInt16 nXti, sal_uInt16 nXtiTab) const

bool	GetLinkData (OUString &rApplic, OUString &rTopic, sal_uInt16 nXtiIndex) const
	Tries to decode the URL of the specified XTI entry to OLE or DDE link components. More...

OUString	GetMacroName (sal_uInt16 nExtSheet, sal_uInt16 nExtName) const
	Returns the specified macro name or an empty string on error. More...

Private Types
typedef ::std::unique_ptr< XclImpLinkManagerImpl >	XclImpLinkMgrImplPtr

Private Attributes
XclImpLinkMgrImplPtr	mxImpl

Additional Inherited Members
Protected Member Functions inherited from XclImpRoot
	XclImpRoot (XclImpRootData &rImpRootData)

const XclImpRoot &	GetRoot () const
	Returns this root instance - for code readability in derived classes. More...

XclImpRoot &	GetRoot ()

void	SetCodePage (sal_uInt16 nCodePage)
	Sets a code page read from a CODEPAGE record for byte string import. More...

void	InitializeTable (SCTAB nScTab)
	Is called when import filter starts importing a single sheet (all BIFF versions). More...

void	FinalizeTable ()
	Is called when import filter stops importing a single sheet (all BIFF versions). More...

XclImpAddressConverter &	GetAddressConverter () const
	Returns the address converter. More...

XclImpFormulaCompiler &	GetFormulaCompiler () const
	Returns the formula converter. More...

ExcelToSc &	GetOldFmlaConverter () const
	Returns the old formula converter. More...

XclImpSst &	GetSst () const
	Returns the shared string table. More...

XclImpPalette &	GetPalette () const
	Returns the color buffer. More...

XclImpFontBuffer &	GetFontBuffer () const
	Returns the font buffer. More...

XclImpNumFmtBuffer &	GetNumFmtBuffer () const
	Returns the number format buffer. More...

XclImpXFBuffer &	GetXFBuffer () const
	Returns the cell formatting attributes buffer. More...

XclImpXFRangeBuffer &	GetXFRangeBuffer () const
	Returns the buffer of XF index ranges for a sheet. More...

ScRangeListTabs &	GetPrintAreaBuffer () const
	Returns the buffer that contains all print areas in the document. More...

ScRangeListTabs &	GetTitleAreaBuffer () const
	Returns the buffer that contains all print titles in the document. More...

XclImpTabInfo &	GetTabInfo () const
	Returns the buffer that contains the sheet creation order. More...

XclImpNameManager &	GetNameManager () const
	Returns the buffer that contains internal defined names. More...

XclImpLinkManager &	GetLinkManager () const
	Returns the link manager. More...

XclImpObjectManager &	GetObjectManager () const
	Returns the drawing object manager. More...

XclImpSheetDrawing &	GetCurrSheetDrawing () const
	Returns the drawing container of the current sheet. More...

XclImpCondFormatManager &	GetCondFormatManager () const
	Returns the conditional formatting manager. More...

XclImpValidationManager &	GetValidationManager () const

XclImpAutoFilterBuffer &	GetFilterManager () const
	Returns the filter manager. More...

XclImpWebQueryBuffer &	GetWebQueryBuffer () const
	Returns the web query buffer. More...

XclImpPivotTableManager &	GetPivotTableManager () const
	Returns the pivot table manager. More...

XclImpSheetProtectBuffer &	GetSheetProtectBuffer () const
	Returns the sheet protection options of the current sheet. More...

XclImpDocProtectBuffer &	GetDocProtectBuffer () const
	Returns the document protection options. More...

XclImpPageSettings &	GetPageSettings () const
	Returns the page settings of the current sheet. More...

XclImpDocViewSettings &	GetDocViewSettings () const
	Returns the view settings of the entire document. More...

XclImpTabViewSettings &	GetTabViewSettings () const
	Returns the view settings of the current sheet. More...

bool	HasBasic () const
	Returns true, if the document contains a VB project. More...

void	SetHasBasic ()
	Called to indicate that the document contains a VB project. More...

void	ReadCodeName (XclImpStream &rStrm, bool bGlobals)
	Reads the CODENAME record and inserts the codename into the document. More...

ScDocumentImport &	GetDocImport ()

Protected Member Functions inherited from XclRoot
	XclRoot (XclRootData &rRootData)

	XclRoot (const XclRoot &rRoot)

virtual	~XclRoot ()

XclRoot &	operator= (const XclRoot &rRoot)

RootData &	GetOldRoot () 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...

SfxMedium &	GetMedium () 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< SotStorage >	OpenStorage (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< SotStorage >	OpenStorage (const OUString &rStrgName) const
	Tries to open a storage as child of the root storage for reading or writing. More...

tools::SvRef< SotStorageStream >	OpenStream (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< SotStorageStream >	OpenStream (const OUString &rStrmName) const
	Tries to open a new stream in the root storage for reading or writing. More...

ScDocument &	GetDoc () const
	Returns reference to the destination document (import) or source document (export). More...

SfxObjectShell *	GetDocShell () const
	Returns the object shell of the Calc document. More...

ScModelObj *	GetDocModelObj () const
	Returns the object model of the Calc document. More...

OutputDevice *	GetPrinter () const
	Returns pointer to the printer of the Calc document. More...

ScStyleSheetPool &	GetStyleSheetPool () const
	Returns the style sheet pool of the Calc document. More...

ScRangeName &	GetNamedRanges () const
	Returns the defined names container of the Calc document. More...

SdrPage *	GetSdrPage (SCTAB nScTab) const
	Returns the drawing layer page of the passed sheet, if present. More...

SvNumberFormatter &	GetFormatter () 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...

ScEditEngineDefaulter &	GetEditEngine () const
	Returns the edit engine for import/export of rich strings etc. More...

ScHeaderEditEngine &	GetHFEditEngine () const
	Returns the edit engine for import/export of headers/footers. More...

EditEngine &	GetDrawEditEngine () const
	Returns the edit engine for import/export of drawing text boxes. More...

XclFontPropSetHelper &	GetFontPropSetHelper () const
	Returns the property set helper for fonts. More...

XclChPropSetHelper &	GetChartPropSetHelper () const
	Returns the property set helper for the chart filters. More...

ScExtDocOptions &	GetExtDocOptions () const
	Returns the extended document options. More...

XclTracer &	GetTracer () const
	Returns the filter tracer. More...

const ScAddress &	GetScMaxPos () const
	Returns the highest possible cell address in a Calc document. More...

const ScAddress &	GetXclMaxPos () const
	Returns the highest possible cell address in an Excel document (using current BIFF version). More...

const ScAddress &	GetMaxPos () 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 XclImpRoot
static OUString	GetScAddInName (const OUString &rXclName)
	Returns the Calc add-in function name for an Excel function name. More...

Static Protected Member Functions inherited from XclRoot
static OUString	GetDefaultPassword ()
	Returns the default password used for stream encryption. More...

Detailed Description

This is the central class for the import of all internal/external links.

@descr This manager stores all data about external documents with their sheets and cached cell contents. Additionally it handles external names, such as add-in function names, DDE links, and OLE object links. File contents in BIFF8:

Record SUPBOOK: Contains the name of an external document and the names of its sheets. This record is optionally followed by NAME, EXTERNNAME, XCT and CRN records.
Record XCT: Contains the number and sheet index of the following CRN records.
Record CRN: Contains addresses (row and column) and values of external referenced cells.
Record NAME: Contains defined names of the own workbook.
Record EXTERNNAME: Contains external defined names, DDE links, or OLE object links.
Record EXTERNSHEET: Contains indexes to URLs of external documents (SUPBOOKs) and sheet indexes for each external reference used anywhere in the workbook. This record follows a list of SUPBOOK records (with their attached records).

Definition at line 184 of file xilink.hxx.

Member Typedef Documentation

◆ XclImpLinkMgrImplPtr

typedef ::std::unique_ptr< XclImpLinkManagerImpl > XclImpLinkManager::XclImpLinkMgrImplPtr

private

Definition at line 224 of file xilink.hxx.

Constructor & Destructor Documentation

◆ XclImpLinkManager()

XclImpLinkManager::XclImpLinkManager ( const XclImpRoot & rRoot )

explicit

Definition at line 892 of file xilink.cxx.

◆ ~XclImpLinkManager()

XclImpLinkManager::~XclImpLinkManager ( )

overridevirtual

Definition at line 898 of file xilink.cxx.

Member Function Documentation

◆ GetExternName()

const XclImpExtName * XclImpLinkManager::GetExternName	(	sal_uInt16	nXtiIndex,
		sal_uInt16	nExtName
	)		const

Returns the specified external name or 0 on error.

Definition at line 938 of file xilink.cxx.

References mxImpl.

Referenced by ExcelToSc8::Convert(), and XclImpPictureObj::ReadPictFmla().

◆ GetLinkData()

bool XclImpLinkManager::GetLinkData	(	OUString &	rApplic,
		OUString &	rTopic,
		sal_uInt16	nXtiIndex
	)		const

Tries to decode the URL of the specified XTI entry to OLE or DDE link components.

@descr For DDE links: Decodes to application name and topic. For OLE object links: Decodes to class name and document URL.

Returns: true = decoding was successful, returned strings are valid (not empty).

Definition at line 953 of file xilink.cxx.

References mxImpl.

Referenced by ExcelToSc8::Convert().

◆ GetMacroName()

OUString XclImpLinkManager::GetMacroName	(	sal_uInt16	nExtSheet,
		sal_uInt16	nExtName
	)		const

Returns the specified macro name or an empty string on error.

Definition at line 958 of file xilink.cxx.

References mxImpl.

Referenced by XclImpDrawObjBase::ReadMacro8().

◆ GetScTabRange()

bool XclImpLinkManager::GetScTabRange	(	SCTAB &	rnFirstScTab,
		SCTAB &	rnLastScTab,
		sal_uInt16	nXtiIndex
	)		const

Returns the Calc sheet index range of the specified XTI entry.

Returns: true = XTI data found, returned sheet index range is valid.

Definition at line 932 of file xilink.cxx.

References mxImpl.

Referenced by ExcelToSc8::Convert(), ExcelToSc8::GetAbsRefs(), and ExcelToSc8::Read3DTabReference().

◆ GetSupbookTabName()

OUString XclImpLinkManager::GetSupbookTabName	(	sal_uInt16	nXti,
		sal_uInt16	nXtiTab
	)		const

Definition at line 948 of file xilink.cxx.

References mxImpl.

Referenced by ExcelToSc8::Read3DTabReference().

◆ GetSupbookUrl()

const OUString * XclImpLinkManager::GetSupbookUrl ( sal_uInt16 nXtiIndex ) const

Definition at line 943 of file xilink.cxx.

References mxImpl.

Referenced by ExcelToSc8::GetExternalFileIdFromXti(), and ExcelToSc8::HandleOleLink().

◆ IsSelfRef()

bool XclImpLinkManager::IsSelfRef ( sal_uInt16 nXtiIndex ) const

Returns true, if the specified XTI entry contains an internal reference.

Definition at line 927 of file xilink.cxx.

References mxImpl.

Referenced by ExcelToSc8::Convert(), and ExcelToSc8::Read3DTabReference().

◆ ReadCrn()

void XclImpLinkManager::ReadCrn ( XclImpStream & rStrm )

Reads a CRN record and appends it to the current SUPBOOK.

Definition at line 917 of file xilink.cxx.

References mxImpl, and rStrm.

Referenced by ImportExcel8::Read().

◆ ReadExternname()

void XclImpLinkManager::ReadExternname	(	XclImpStream &	rStrm,
		ExcelToSc *	pFormulaConv
	)

Reads an EXTERNNAME record and appends it to the current SUPBOOK.

Definition at line 922 of file xilink.cxx.

References mxImpl, and rStrm.

Referenced by ImportExcel8::Read().

◆ ReadExternsheet()

void XclImpLinkManager::ReadExternsheet ( XclImpStream & rStrm )

Reads the EXTERNSHEET record.

Definition at line 902 of file xilink.cxx.

References mxImpl, and rStrm.

Referenced by ImportExcel8::Read().

◆ ReadSupbook()

void XclImpLinkManager::ReadSupbook ( XclImpStream & rStrm )

Reads a SUPBOOK record.

Definition at line 907 of file xilink.cxx.

References mxImpl, and rStrm.

Referenced by ImportExcel8::Read().

◆ ReadXct()

void XclImpLinkManager::ReadXct ( XclImpStream & rStrm )

Reads an XCT record and appends it to the current SUPBOOK.

Definition at line 912 of file xilink.cxx.

References mxImpl, and rStrm.

Referenced by ImportExcel8::Read().

Member Data Documentation

◆ mxImpl

XclImpLinkMgrImplPtr XclImpLinkManager::mxImpl

private

Definition at line 225 of file xilink.hxx.

Referenced by GetExternName(), GetLinkData(), GetMacroName(), GetScTabRange(), GetSupbookTabName(), GetSupbookUrl(), IsSelfRef(), ReadCrn(), ReadExternname(), ReadExternsheet(), ReadSupbook(), and ReadXct().

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

Public Member Functions

Private Types

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ XclImpLinkMgrImplPtr

Constructor & Destructor Documentation

◆ XclImpLinkManager()

◆ ~XclImpLinkManager()

Member Function Documentation

◆ GetExternName()

◆ GetLinkData()

◆ GetMacroName()

◆ GetScTabRange()

◆ GetSupbookTabName()

◆ GetSupbookUrl()

◆ IsSelfRef()

◆ ReadCrn()

◆ ReadExternname()

◆ ReadExternsheet()

◆ ReadSupbook()

◆ ReadXct()

Member Data Documentation

◆ mxImpl