ScExtDocOptions Class Reference

Extended options held by an ScDocument containing additional settings for filters. More...

#include <scextopt.hxx>

Public Member Functions
	ScExtDocOptions ()
	ScExtDocOptions (const ScExtDocOptions &rSrc)
	~ScExtDocOptions ()
ScExtDocOptions &	operator= (const ScExtDocOptions &rSrc)
bool	IsChanged () const
void	SetChanged (bool bChanged)
	If set to true, the data will be copied to the view data after import. More...
const ScExtDocSettings &	GetDocSettings () const
ScExtDocSettings &	GetDocSettings ()
const ScExtTabSettings *	GetTabSettings (SCTAB nTab) const
SCTAB	GetLastTab () const
ScExtTabSettings &	GetOrCreateTabSettings (SCTAB nTab)
SCTAB	GetCodeNameCount () const
OUString	GetCodeName (SCTAB nTab) const
void	SetCodeName (SCTAB nTab, const OUString &rCodeName)
	Appends a codename for a sheet. More...

Private Attributes
::std::unique_ptr< ScExtDocOptionsImpl >	mxImpl

Detailed Description

Extended options held by an ScDocument containing additional settings for filters.

This object is owned by a Calc document. It contains global document settings (struct ScExtDocSettings), settings for all sheets in the document (struct ScExtTabSettings), and a list of codenames used for VBA import/export.

Definition at line 76 of file scextopt.hxx.

Constructor & Destructor Documentation

ScExtDocOptions() [1/2]

ScExtDocOptions::ScExtDocOptions ( )

explicit

Definition at line 140 of file scextopt.cxx.

ScExtDocOptions() [2/2]

ScExtDocOptions::ScExtDocOptions

(

const ScExtDocOptions &

rSrc

)

Definition at line 145 of file scextopt.cxx.

~ScExtDocOptions()

ScExtDocOptions::~ScExtDocOptions

(

)

Definition at line 150 of file scextopt.cxx.

Member Function Documentation

GetCodeName()

OUString ScExtDocOptions::GetCodeName

(

SCTAB

nTab

)

const

Returns

the specified codename (empty string = no codename).

Definition at line 200 of file scextopt.cxx.

References GetCodeNameCount(), and mxImpl.

Referenced by XclImpObjectManager::GetOleNameOverride().

GetCodeNameCount()

SCTAB ScExtDocOptions::GetCodeNameCount

(

)

const

Returns

the number of sheet codenames.

Definition at line 195 of file scextopt.cxx.

References mxImpl.

Referenced by ExcTable::FillAsHeaderBinary(), ExcTable::FillAsHeaderXml(), GetCodeName(), and ExcDocument::ReadDoc().

GetDocSettings() [1/2]

ScExtDocSettings & ScExtDocOptions::GetDocSettings

(

)

Returns

read/write access to the global document settings.

Definition at line 175 of file scextopt.cxx.

References mxImpl.

GetDocSettings() [2/2]

const ScExtDocSettings & ScExtDocOptions::GetDocSettings

(

)

const

Returns

read access to the global document settings.

Definition at line 170 of file scextopt.cxx.

References mxImpl.

Referenced by ExcScenario::Apply(), ExcTable::FillAsHeaderBinary(), XclImpDocViewSettings::Finalize(), ExtSheetBuffer::GetScTabIndex(), ScExternalRefManager::loadSrcDocument(), ImportExcel::PostDocLoad(), XclImpRoot::ReadCodeName(), ScViewData::ReadExtOptions(), ScDocumentLoader::ScDocumentLoader(), ScViewData::WriteExtOptions(), XclExpTabInfo::XclExpTabInfo(), and XclExpWindow1::XclExpWindow1().

GetLastTab()

SCTAB ScExtDocOptions::GetLastTab

(

)

const

Returns

index of the last sheet that has settings, or -1 if no tab settings are present.

Definition at line 185 of file scextopt.cxx.

References mxImpl.

Referenced by ScViewData::ReadExtOptions().

GetOrCreateTabSettings()

ScExtTabSettings & ScExtDocOptions::GetOrCreateTabSettings

(

SCTAB

nTab

)

Returns

read/write access to the settings of a sheet, may create a new struct.

Definition at line 190 of file scextopt.cxx.

References mxImpl.

Referenced by XclImpTabViewSettings::Finalize(), XclImpName::InsertName(), ImportExcel::ReadDimensions(), and ScViewData::WriteExtOptions().

GetTabSettings()

const ScExtTabSettings * ScExtDocOptions::GetTabSettings

(

SCTAB

nTab

)

const

Returns

read access to the settings of a sheet, if extant; otherwise 0.

Definition at line 180 of file scextopt.cxx.

References mxImpl.

Referenced by ScViewFunc::PasteDataFormat(), ScViewData::ReadExtOptions(), and XclExpTabInfo::XclExpTabInfo().

IsChanged()

bool ScExtDocOptions::IsChanged

(

)

const

Returns

true, if the data needs to be copied to the view data after import.

Definition at line 160 of file scextopt.cxx.

References mxImpl.

Referenced by ScTabViewShell::Activate(), ScTabViewObj::getSelectedSheets(), and ScViewData::ReadExtOptions().

operator=()

ScExtDocOptions & ScExtDocOptions::operator=

(

const ScExtDocOptions &

rSrc

)

Definition at line 154 of file scextopt.cxx.

References mxImpl.

SetChanged()

void ScExtDocOptions::SetChanged

(

bool

bChanged

)

If set to true, the data will be copied to the view data after import.

Definition at line 165 of file scextopt.cxx.

References mxImpl.

Referenced by ScTabViewShell::Activate(), ScTabViewObj::getSelectedSheets(), and ImportExcel::PostDocLoad().

SetCodeName()

void ScExtDocOptions::SetCodeName	(	SCTAB	nTab,
		const OUString &	rCodeName
	)

Appends a codename for a sheet.

Definition at line 206 of file scextopt.cxx.

References mxImpl, and nIndex.

Referenced by XclImpRoot::ReadCodeName().

Member Data Documentation

mxImpl

::std::unique_ptr< ScExtDocOptionsImpl > ScExtDocOptions::mxImpl

private

Definition at line 115 of file scextopt.hxx.

Referenced by GetCodeName(), GetCodeNameCount(), GetDocSettings(), GetLastTab(), GetOrCreateTabSettings(), GetTabSettings(), IsChanged(), operator=(), SetChanged(), and SetCodeName().

---

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

• scextopt.hxx
• scextopt.cxx