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

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

#include <xilink.hxx>

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

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 XclImpExtNameGetExternName (sal_uInt16 nXtiIndex, sal_uInt16 nExtName) const
 Returns the specified external name or 0 on error. More...
 
const OUString * GetSupbookUrl (sal_uInt16 nXtiIndex) const
 
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...
 
const 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< XclImpLinkManagerImplXclImpLinkMgrImplPtr
 

Private Attributes

XclImpLinkMgrImplPtr mxImpl
 

Additional Inherited Members

- Protected Member Functions inherited from XclImpRoot
 XclImpRoot (XclImpRootData &rImpRootData)
 
const XclImpRootGetRoot () const
 Returns this root instance - for code readability in derived classes. More...
 
XclImpRootGetRoot ()
 
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...
 
XclImpAddressConverterGetAddressConverter () const
 Returns the address converter. More...
 
XclImpFormulaCompilerGetFormulaCompiler () const
 Returns the formula converter. More...
 
ExcelToScGetOldFmlaConverter () const
 Returns the old formula converter. More...
 
XclImpSstGetSst () const
 Returns the shared string table. More...
 
XclImpPaletteGetPalette () const
 Returns the color buffer. More...
 
XclImpFontBufferGetFontBuffer () const
 Returns the font buffer. More...
 
XclImpNumFmtBufferGetNumFmtBuffer () const
 Returns the number format buffer. More...
 
XclImpXFBufferGetXFBuffer () const
 Returns the cell formatting attributes buffer. More...
 
XclImpXFRangeBufferGetXFRangeBuffer () const
 Returns the buffer of XF index ranges for a sheet. More...
 
ScRangeListTabsGetPrintAreaBuffer () const
 Returns the buffer that contains all print areas in the document. More...
 
ScRangeListTabsGetTitleAreaBuffer () const
 Returns the buffer that contains all print titles in the document. More...
 
XclImpTabInfoGetTabInfo () const
 Returns the buffer that contains the sheet creation order. More...
 
XclImpNameManagerGetNameManager () const
 Returns the buffer that contains internal defined names. More...
 
XclImpLinkManagerGetLinkManager () const
 Returns the link manager. More...
 
XclImpObjectManagerGetObjectManager () const
 Returns the drawing object manager. More...
 
XclImpSheetDrawingGetCurrSheetDrawing () const
 Returns the drawing container of the current sheet. More...
 
XclImpCondFormatManagerGetCondFormatManager () const
 Returns the conditional formatting manager. More...
 
XclImpValidationManagerGetValidationManager () const
 
XclImpAutoFilterBufferGetFilterManager () const
 Returns the filter manager. More...
 
XclImpWebQueryBufferGetWebQueryBuffer () const
 Returns the web query buffer. More...
 
XclImpPivotTableManagerGetPivotTableManager () const
 Returns the pivot table manager. More...
 
XclImpSheetProtectBufferGetSheetProtectBuffer () const
 Returns the sheet protection options of the current sheet. More...
 
XclImpDocProtectBufferGetDocProtectBuffer () const
 Returns the document protection options. More...
 
XclImpPageSettingsGetPageSettings () const
 Returns the page settings of the current sheet. More...
 
XclImpDocViewSettingsGetDocViewSettings () const
 Returns the view settings of the entire document. More...
 
XclImpTabViewSettingsGetTabViewSettings () 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...
 
ScDocumentImportGetDocImport ()
 
- 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...
 
long GetCharWidth () const
 Returns the width of the '0' character (default font) for the current printer (twips). More...
 
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' character (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.

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:

Definition at line 184 of file xilink.hxx.

Member Typedef Documentation

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

Definition at line 224 of file xilink.hxx.

Constructor & Destructor Documentation

XclImpLinkManager::XclImpLinkManager ( const XclImpRoot rRoot)
explicit

Definition at line 891 of file xilink.cxx.

XclImpLinkManager::~XclImpLinkManager ( )
overridevirtual

Definition at line 897 of file xilink.cxx.

Member Function Documentation

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

Returns the specified external name or 0 on error.

Definition at line 937 of file xilink.cxx.

References mxImpl.

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

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.

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 952 of file xilink.cxx.

References mxImpl.

Referenced by ExcelToSc8::Convert().

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

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

Definition at line 957 of file xilink.cxx.

References mxImpl.

Referenced by XclImpDrawObjBase::ReadMacro8().

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 931 of file xilink.cxx.

References mxImpl.

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

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

Definition at line 947 of file xilink.cxx.

References mxImpl.

Referenced by ExcelToSc8::Read3DTabReference().

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

Definition at line 942 of file xilink.cxx.

References mxImpl.

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

bool XclImpLinkManager::IsSelfRef ( sal_uInt16  nXtiIndex) const

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

Definition at line 926 of file xilink.cxx.

References mxImpl.

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

void XclImpLinkManager::ReadCrn ( XclImpStream rStrm)

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

Definition at line 916 of file xilink.cxx.

References mxImpl.

Referenced by ImportExcel8::Read().

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

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

Definition at line 921 of file xilink.cxx.

References mxImpl.

Referenced by ImportExcel8::Read().

void XclImpLinkManager::ReadExternsheet ( XclImpStream rStrm)

Reads the EXTERNSHEET record.

Definition at line 901 of file xilink.cxx.

References mxImpl.

Referenced by ImportExcel8::Read().

void XclImpLinkManager::ReadSupbook ( XclImpStream rStrm)

Reads a SUPBOOK record.

Definition at line 906 of file xilink.cxx.

References mxImpl.

Referenced by ImportExcel8::Read().

void XclImpLinkManager::ReadXct ( XclImpStream rStrm)

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

Definition at line 911 of file xilink.cxx.

References mxImpl.

Referenced by ImportExcel8::Read().

Member Data Documentation

XclImpLinkMgrImplPtr XclImpLinkManager::mxImpl
private

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