Stores the correct Excel sheet index for each Calc sheet. More...

#include <xelink.hxx>

Inheritance diagram for XclExpTabInfo:

Collaboration diagram for XclExpTabInfo:

Classes
struct	XclExpTabInfoEntry
	Data structure with information about one Calc sheet. More...

Public Member Functions
	XclExpTabInfo (const XclExpRoot &rRoot)
	Initializes the complete buffer from the current exported document. More...

bool	IsExportTab (SCTAB nScTab) const
	Returns true, if the specified Calc sheet will be exported. More...

bool	IsExternalTab (SCTAB nScTab) const
	Returns true, if the specified Calc sheet is used to store external cell contents. More...

bool	IsVisibleTab (SCTAB nScTab) const
	Returns true, if the specified Calc sheet is visible and will be exported. More...

bool	IsSelectedTab (SCTAB nScTab) const
	Returns true, if the specified Calc sheet is selected and will be exported. More...

bool	IsDisplayedTab (SCTAB nScTab) const
	Returns true, if the specified Calc sheet is the displayed (active) sheet. More...

bool	IsMirroredTab (SCTAB nScTab) const
	Returns true, if the specified Calc sheet is displayed in right-to-left mode. More...

OUString	GetScTabName (SCTAB nScTab) const
	Returns the Calc name of the specified sheet. More...

sal_uInt16	GetXclTab (SCTAB nScTab) const
	Returns the Excel sheet index for a given Calc sheet. More...

SCTAB	GetRealScTab (SCTAB nSortedScTab) const
	Returns the Calc sheet index of the nSortedTab-th entry in the sorted sheet names list. More...

SCTAB	GetScTabCount () const
	Returns the number of Calc sheets. More...

sal_uInt16	GetXclTabCount () const
	Returns the number of Excel sheets to be exported. More...

sal_uInt16	GetXclExtTabCount () const
	Returns the number of external linked sheets. More...

sal_uInt16	GetXclSelectedCount () const
	Returns the number of exported selected sheets. More...

sal_uInt16	GetDisplayedXclTab () const
	Returns the Excel index of the active, displayed sheet. More...

sal_uInt16	GetFirstVisXclTab () const
	Returns the Excel index of the first visible sheet. More...

Private Types
typedef ::std::vector< SCTAB >	ScTabVec

Private Member Functions
bool	GetFlag (SCTAB nScTab, ExcTabBufFlags nFlags) const
	Returns true, if any of the passed flags is set for the specified Calc sheet. More...

void	SetFlag (SCTAB nScTab, ExcTabBufFlags nFlags, bool bSet=true)
	Sets or clears (depending on bSet) all passed flags for the specified Calc sheet. More...

void	CalcXclIndexes ()
	Searches for sheets not to be exported. More...

void	CalcSortedIndexes ()
	Sorts the names of all tables and stores the indexes of the sorted indexes. More...

Private Attributes
std::vector< XclExpTabInfoEntry >	maTabInfoVec

SCTAB	mnScCnt
	Array of Calc sheet index information. More...

sal_uInt16	mnXclCnt
	Count of Calc sheets. More...

sal_uInt16	mnXclExtCnt
	Count of Excel sheets to be exported. More...

sal_uInt16	mnXclSelCnt
	Count of external link sheets. More...

sal_uInt16	mnDisplXclTab
	Count of selected and exported sheets. More...

sal_uInt16	mnFirstVisXclTab
	Displayed (active) sheet. More...

ScTabVec	maFromSortedVec
	First visible sheet. More...

ScTabVec	maToSortedVec
	Sorted Calc sheet index -> real Calc sheet index. More...

Additional Inherited Members
Protected Member Functions inherited from XclExpRoot
	XclExpRoot (XclExpRootData &rExpRootData)

const XclExpRoot &	GetRoot () 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::CompileFormulaContext &	GetCompileFormulaContext () const

XclExpTabInfo &	GetTabInfo () const
	Returns the buffer for Calc->Excel sheet index conversion. More...

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

XclExpFormulaCompiler &	GetFormulaCompiler () const
	Returns the formula compiler to produce formula token arrays. More...

XclExpProgressBar &	GetProgressBar () const
	Returns the export progress bar. More...

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

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

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

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

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

XclExpLinkManager &	GetGlobalLinkManager () const
	Returns the global link manager for defined names. More...

XclExpLinkManager &	GetLocalLinkManager () const
	Returns the local link manager for the current sheet. More...

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

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

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

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

XclExpDxfs &	GetDxfs () const
	Returns the differential formatting list. More...

OStringBuffer &	GetStringBuf () const
	Clean and return the OStringBuffer. More...

XclExpXmlPivotTableManager &	GetXmlPivotTableManager ()

XclExpTablesManager &	GetTablesManager ()

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 ()

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 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

Stores the correct Excel sheet index for each Calc sheet.

@descr The class knows all sheets which will not exported (i.e. external link sheets, scenario sheets).

Definition at line 61 of file xelink.hxx.

Member Typedef Documentation

◆ ScTabVec

typedef ::std::vector< SCTAB > XclExpTabInfo::ScTabVec

private

Definition at line 124 of file xelink.hxx.

Constructor & Destructor Documentation

◆ XclExpTabInfo()

XclExpTabInfo::XclExpTabInfo ( const XclExpRoot & rRoot )

explicit

Initializes the complete buffer from the current exported document.

Definition at line 671 of file xelink.cxx.

References CalcSortedIndexes(), CalcXclIndexes(), Extern, XclRoot::GetDoc(), ScExtDocOptions::GetDocSettings(), XclRoot::GetExtDocOptions(), ScDocument::GetLinkMode(), ScDocument::GetName(), ScDocument::GetTableCount(), ScExtDocOptions::GetTabSettings(), ScDocument::GetVisibleTab(), GetXclTab(), Ignore, IsExportTab(), ScDocument::IsLayoutRTL(), ScDocument::IsScenario(), IsSelectedTab(), ScDocument::IsVisible(), maTabInfoVec, Mirrored, ScExtDocSettings::mnDisplTab, mnDisplXclTab, mnFirstVisXclTab, mnScCnt, mnXclSelCnt, SCTAB_INVALID, Selected, SetFlag(), SkipMask, VALUE, and Visible.

Member Function Documentation

◆ CalcSortedIndexes()

void XclExpTabInfo::CalcSortedIndexes ( )

private

Sorts the names of all tables and stores the indexes of the sorted indexes.

Definition at line 889 of file xelink.cxx.

References first, XclRoot::GetDoc(), ScDocument::GetName(), maFromSortedVec, maToSortedVec, and mnScCnt.

Referenced by XclExpTabInfo().

◆ CalcXclIndexes()

void XclExpTabInfo::CalcXclIndexes ( )

private

Searches for sheets not to be exported.

Definition at line 843 of file xelink.cxx.

References EXC_TAB_DELETED, IsExportTab(), IsExternalTab(), maTabInfoVec, mnScCnt, mnXclCnt, and mnXclExtCnt.

Referenced by XclExpTabInfo().

◆ GetDisplayedXclTab()

sal_uInt16 XclExpTabInfo::GetDisplayedXclTab ( ) const

inline

Returns the Excel index of the active, displayed sheet.

Definition at line 99 of file xelink.hxx.

References mnDisplXclTab.

Referenced by XclExpWindow1::SaveXml(), and XclExpWindow1::WriteBody().

◆ GetFirstVisXclTab()

sal_uInt16 XclExpTabInfo::GetFirstVisXclTab ( ) const

inline

Returns the Excel index of the first visible sheet.

Definition at line 101 of file xelink.hxx.

References mnFirstVisXclTab.

Referenced by XclExpWindow1::SaveXml(), and XclExpWindow1::WriteBody().

◆ GetFlag()

bool XclExpTabInfo::GetFlag	(	SCTAB	nScTab,
		ExcTabBufFlags	nFlags
	)		const

private

Returns true, if any of the passed flags is set for the specified Calc sheet.

Definition at line 825 of file xelink.cxx.

References maTabInfoVec.

Referenced by IsExportTab(), IsExternalTab(), IsMirroredTab(), IsSelectedTab(), and IsVisibleTab().

◆ GetRealScTab()

SCTAB XclExpTabInfo::GetRealScTab ( SCTAB nSortedScTab ) const

Returns the Calc sheet index of the nSortedTab-th entry in the sorted sheet names list.

Definition at line 819 of file xelink.cxx.

References maFromSortedVec, and SCTAB_INVALID.

Referenced by XclExpNameManagerImpl::CreateBuiltInNames().

◆ GetScTabCount()

SCTAB XclExpTabInfo::GetScTabCount ( ) const

inline

Returns the number of Calc sheets.

Definition at line 89 of file xelink.hxx.

References mnScCnt.

Referenced by XclExpNameManagerImpl::CreateBuiltInNames(), ExcTable::FillAsHeaderBinary(), ExcTable::FillAsHeaderXml(), XclExpProgressBar::Initialize(), and ExcDocument::ReadDoc().

◆ GetScTabName()

OUString XclExpTabInfo::GetScTabName ( SCTAB nScTab ) const

Returns the Calc name of the specified sheet.

Definition at line 808 of file xelink.cxx.

References maTabInfoVec.

Referenced by ExcBundlesheet::ExcBundlesheet().

◆ GetXclExtTabCount()

sal_uInt16 XclExpTabInfo::GetXclExtTabCount ( ) const

inline

Returns the number of external linked sheets.

Definition at line 94 of file xelink.hxx.

References mnXclExtCnt.

◆ GetXclSelectedCount()

sal_uInt16 XclExpTabInfo::GetXclSelectedCount ( ) const

inline

Returns the number of exported selected sheets.

Definition at line 96 of file xelink.hxx.

References mnXclSelCnt.

Referenced by XclExpWindow1::WriteBody().

◆ GetXclTab()

sal_uInt16 XclExpTabInfo::GetXclTab ( SCTAB nScTab ) const

Returns the Excel sheet index for a given Calc sheet.

Definition at line 814 of file xelink.cxx.

References EXC_TAB_DELETED, and maTabInfoVec.

Referenced by XclExpChTrAction::GetTabId(), XclExpChTrAction::IsDeletedTab(), IsDisplayedTab(), XclExpChangeTrack::XclExpChangeTrack(), and XclExpTabInfo().

◆ GetXclTabCount()

sal_uInt16 XclExpTabInfo::GetXclTabCount ( ) const

inline

Returns the number of Excel sheets to be exported.

Definition at line 92 of file xelink.hxx.

References mnXclCnt.

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

◆ IsDisplayedTab()

bool XclExpTabInfo::IsDisplayedTab ( SCTAB nScTab ) const

Returns true, if the specified Calc sheet is the displayed (active) sheet.

Definition at line 797 of file xelink.cxx.

References GetXclTab(), and mnDisplXclTab.

Referenced by XclExpTabViewSettings::XclExpTabViewSettings().

◆ IsExportTab()

bool XclExpTabInfo::IsExportTab ( SCTAB nScTab ) const

Returns true, if the specified Calc sheet will be exported.

Definition at line 774 of file xelink.cxx.

References GetFlag(), and SkipMask.

Referenced by CalcXclIndexes(), XclExpNameManagerImpl::CreateBuiltInNames(), ExcTable::FillAsHeaderBinary(), ExcTable::FillAsHeaderXml(), XclExpProgressBar::Initialize(), and XclExpTabInfo().

◆ IsExternalTab()

bool XclExpTabInfo::IsExternalTab ( SCTAB nScTab ) const

Returns true, if the specified Calc sheet is used to store external cell contents.

Definition at line 780 of file xelink.cxx.

References Extern, and GetFlag().

Referenced by CalcXclIndexes().

◆ IsMirroredTab()

bool XclExpTabInfo::IsMirroredTab ( SCTAB nScTab ) const

Returns true, if the specified Calc sheet is displayed in right-to-left mode.

Definition at line 803 of file xelink.cxx.

References GetFlag(), and Mirrored.

Referenced by XclExpTabViewSettings::XclExpTabViewSettings().

◆ IsSelectedTab()

bool XclExpTabInfo::IsSelectedTab ( SCTAB nScTab ) const

Returns true, if the specified Calc sheet is selected and will be exported.

Definition at line 792 of file xelink.cxx.

References GetFlag(), and Selected.

Referenced by XclExpTabInfo(), and XclExpTabViewSettings::XclExpTabViewSettings().

◆ IsVisibleTab()

bool XclExpTabInfo::IsVisibleTab ( SCTAB nScTab ) const

Returns true, if the specified Calc sheet is visible and will be exported.

Definition at line 787 of file xelink.cxx.

References GetFlag(), and Visible.

◆ SetFlag()

void XclExpTabInfo::SetFlag	(	SCTAB	nScTab,
		ExcTabBufFlags	nFlags,
		bool	bSet = `true`
	)

private

Sets or clears (depending on bSet) all passed flags for the specified Calc sheet.

Definition at line 831 of file xelink.cxx.

References maTabInfoVec.

Referenced by XclExpTabInfo().

Member Data Documentation

◆ maFromSortedVec

ScTabVec XclExpTabInfo::maFromSortedVec

private

First visible sheet.

Definition at line 136 of file xelink.hxx.

Referenced by CalcSortedIndexes(), and GetRealScTab().

◆ maTabInfoVec

std::vector< XclExpTabInfoEntry > XclExpTabInfo::maTabInfoVec

private

Definition at line 127 of file xelink.hxx.

Referenced by CalcXclIndexes(), GetFlag(), GetScTabName(), GetXclTab(), SetFlag(), and XclExpTabInfo().

◆ maToSortedVec

ScTabVec XclExpTabInfo::maToSortedVec

private

Sorted Calc sheet index -> real Calc sheet index.

Definition at line 137 of file xelink.hxx.

Referenced by CalcSortedIndexes().

◆ mnDisplXclTab

sal_uInt16 XclExpTabInfo::mnDisplXclTab

private

Count of selected and exported sheets.

Definition at line 133 of file xelink.hxx.

Referenced by GetDisplayedXclTab(), IsDisplayedTab(), and XclExpTabInfo().

◆ mnFirstVisXclTab

sal_uInt16 XclExpTabInfo::mnFirstVisXclTab

private

Displayed (active) sheet.

Definition at line 134 of file xelink.hxx.

Referenced by GetFirstVisXclTab(), and XclExpTabInfo().

◆ mnScCnt

SCTAB XclExpTabInfo::mnScCnt

private

Array of Calc sheet index information.

Definition at line 129 of file xelink.hxx.

Referenced by CalcSortedIndexes(), CalcXclIndexes(), GetScTabCount(), and XclExpTabInfo().

◆ mnXclCnt

sal_uInt16 XclExpTabInfo::mnXclCnt

private

Count of Calc sheets.

Definition at line 130 of file xelink.hxx.

Referenced by CalcXclIndexes(), and GetXclTabCount().

◆ mnXclExtCnt

sal_uInt16 XclExpTabInfo::mnXclExtCnt

private

Count of Excel sheets to be exported.

Definition at line 131 of file xelink.hxx.

Referenced by CalcXclIndexes(), and GetXclExtTabCount().

◆ mnXclSelCnt

sal_uInt16 XclExpTabInfo::mnXclSelCnt

private

Count of external link sheets.

Definition at line 132 of file xelink.hxx.

Referenced by GetXclSelectedCount(), and XclExpTabInfo().

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

Classes

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ScTabVec

Constructor & Destructor Documentation

◆ XclExpTabInfo()

Member Function Documentation

◆ CalcSortedIndexes()

◆ CalcXclIndexes()

◆ GetDisplayedXclTab()

◆ GetFirstVisXclTab()

◆ GetFlag()

◆ GetRealScTab()

◆ GetScTabCount()

◆ GetScTabName()

◆ GetXclExtTabCount()

◆ GetXclSelectedCount()

◆ GetXclTab()

◆ GetXclTabCount()

◆ IsDisplayedTab()

◆ IsExportTab()

◆ IsExternalTab()

◆ IsMirroredTab()

◆ IsSelectedTab()

◆ IsVisibleTab()

◆ SetFlag()

Member Data Documentation

◆ maFromSortedVec

◆ maTabInfoVec

◆ maToSortedVec

◆ mnDisplXclTab

◆ mnFirstVisXclTab

◆ mnScCnt

◆ mnXclCnt

◆ mnXclExtCnt

◆ mnXclSelCnt