ScSheetSourceDesc Class Reference

This class contains authoritative information on the internal reference used as the data source for datapilot table. More...

#include <dpshttab.hxx>

Collaboration diagram for ScSheetSourceDesc:

Public Member Functions
	ScSheetSourceDesc ()=delete
SC_DLLPUBLIC	ScSheetSourceDesc (ScDocument *pDoc)
SC_DLLPUBLIC void	SetSourceRange (const ScRange &rRange)
SC_DLLPUBLIC const ScRange &	GetSourceRange () const
	Get the range that contains the source data. More...
SC_DLLPUBLIC void	SetRangeName (const OUString &rName)
const OUString &	GetRangeName () const
bool	HasRangeName () const
void	SetQueryParam (const ScQueryParam &rParam)
const ScQueryParam &	GetQueryParam () const
bool	operator== (const ScSheetSourceDesc &rOther) const
SC_DLLPUBLIC const ScDPCache *	CreateCache (const ScDPDimensionSaveData *pDimData) const
TranslateId	CheckSourceRange () const
	Check the sanity of the data source range. More...

Private Attributes
ScRange	maSourceRange
OUString	maRangeName
ScQueryParam	maQueryParam
ScDocument *	mpDoc

Detailed Description

This class contains authoritative information on the internal reference used as the data source for datapilot table.

The range name takes precedence over the source range when it's non-empty. When the range name is empty, the source range gets used.

Definition at line 39 of file dpshttab.hxx.

Constructor & Destructor Documentation

ScSheetSourceDesc() [1/2]

ScSheetSourceDesc::ScSheetSourceDesc ( )

delete

ScSheetSourceDesc() [2/2]

ScSheetSourceDesc::ScSheetSourceDesc

(

ScDocument *

pDoc

)

Definition at line 221 of file dpshttab.cxx.

Member Function Documentation

CheckSourceRange()

TranslateId ScSheetSourceDesc::CheckSourceRange

(

)

const

Check the sanity of the data source range.

Returns

nullptr if the source range is sane, otherwise an error message ID is returned.

Definition at line 307 of file dpshttab.cxx.

References ScRange::aEnd, ScRange::aStart, ScAddress::Col(), GetSourceRange(), ScRange::IsValid(), mpDoc, and ScAddress::Row().

Referenced by CreateCache(), ScCellShell::ExecuteDataPilotDialog(), ScDPCollection::ReloadCache(), and ScPivotLayoutDialog::UpdateSourceRange().

CreateCache()

const ScDPCache * ScSheetSourceDesc::CreateCache

(

const ScDPDimensionSaveData *

pDimData

)

const

Definition at line 282 of file dpshttab.cxx.

References CheckSourceRange(), ScDPCollection::NameCaches::getCache(), ScDPCollection::SheetCaches::getCache(), ScDocument::GetDPCollection(), ScDPCollection::GetNameCaches(), GetRangeName(), ScDPCollection::GetSheetCaches(), GetSourceRange(), HasRangeName(), and mpDoc.

Referenced by XclExpPCField::InsertNumDateGroupItems().

GetQueryParam()

const ScQueryParam & ScSheetSourceDesc::GetQueryParam ( ) const

inline

Definition at line 63 of file dpshttab.hxx.

References maQueryParam.

Referenced by ScGridWindow::DoPushPivotButton(), ScPivotShell::Execute(), ScDataPilotFilterDescriptor::GetData(), and ScXMLExportDataPilot::WriteDataPilots().

GetRangeName()

const OUString & ScSheetSourceDesc::GetRangeName ( ) const

inline

Definition at line 60 of file dpshttab.hxx.

References maRangeName.

Referenced by CreateCache(), ScDPCollection::GetAllTables(), ScDPCollection::GetReferenceGroups(), ScDPCollection::ReloadCache(), ScDPCollection::ReloadGroupsInCache(), ScXMLExportDataPilot::WriteDataPilots(), and XclExpPivotCache::XclExpPivotCache().

GetSourceRange()

const ScRange & ScSheetSourceDesc::GetSourceRange

(

)

const

Get the range that contains the source data.

In case the source data is referred to via a range name, it returns the range that the range name points to.

Note that currently only a single range is supported; if the range name contains multiple ranges, only the first range is used.

Returns

source range.

Definition at line 230 of file dpshttab.cxx.

References ScRangeName::findByUpperName(), ScGlobal::getCharClass(), ScDocument::GetRangeName(), maRangeName, maSourceRange, mpDoc, pData, and CharClass::uppercase().

Referenced by CheckSourceRange(), CreateCache(), ScGridWindow::DoPushPivotButton(), ScPivotShell::Execute(), ScTabViewShell::ExecuteTable(), ScDPCollection::GetAllTables(), ScDPCollection::GetReferenceGroups(), ScDataPilotDescriptorBase::getSourceRange(), ScDocShell::RefreshPivotTables(), ScDPCollection::ReloadCache(), ScDPCollection::ReloadGroupsInCache(), ScPivotLayoutDialog::SetupSource(), ScPivotLayoutDialog::UpdateSourceRange(), ScXMLExportDataPilot::WriteDataPilots(), and XclExpPivotCache::XclExpPivotCache().

HasRangeName()

bool ScSheetSourceDesc::HasRangeName

(

)

const

Definition at line 265 of file dpshttab.cxx.

References maRangeName.

Referenced by CreateCache(), ScDPCollection::GetAllTables(), ScDPCollection::GetReferenceGroups(), ScDPCollection::ReloadCache(), ScDPCollection::ReloadGroupsInCache(), and ScXMLExportDataPilot::WriteDataPilots().

operator==()

bool ScSheetSourceDesc::operator==

(

const ScSheetSourceDesc &

rOther

)

const

Definition at line 275 of file dpshttab.cxx.

References maQueryParam, maRangeName, and maSourceRange.

SetQueryParam()

void ScSheetSourceDesc::SetQueryParam

(

const ScQueryParam &

rParam

)

Definition at line 270 of file dpshttab.cxx.

References maQueryParam.

Referenced by ScGridWindow::DoPushPivotButton(), ScXMLDataPilotTableContext::endFastElement(), ScPivotShell::Execute(), and ScDataPilotFilterDescriptor::PutData().

SetRangeName()

void ScSheetSourceDesc::SetRangeName

(

const OUString &

rName

)

Definition at line 260 of file dpshttab.cxx.

References maRangeName.

Referenced by XclImpPivotTable::Convert(), ScXMLDataPilotTableContext::endFastElement(), ScCellShell::ExecuteDataPilotDialog(), and ScPivotLayoutDialog::UpdateSourceRange().

SetSourceRange()

void ScSheetSourceDesc::SetSourceRange

(

const ScRange &

rRange

)

Definition at line 224 of file dpshttab.cxx.

References maRangeName, and maSourceRange.

Referenced by XclImpPivotTable::Convert(), ScXMLDataPilotTableContext::endFastElement(), ScDataPilotDescriptorBase::setSourceRange(), and ScPivotLayoutDialog::UpdateSourceRange().

Member Data Documentation

maQueryParam

ScQueryParam ScSheetSourceDesc::maQueryParam

private

Definition at line 79 of file dpshttab.hxx.

Referenced by GetQueryParam(), operator==(), and SetQueryParam().

maRangeName

OUString ScSheetSourceDesc::maRangeName

private

Definition at line 78 of file dpshttab.hxx.

Referenced by GetRangeName(), GetSourceRange(), HasRangeName(), operator==(), SetRangeName(), and SetSourceRange().

maSourceRange

ScRange ScSheetSourceDesc::maSourceRange

mutableprivate

Definition at line 77 of file dpshttab.hxx.

Referenced by GetSourceRange(), operator==(), and SetSourceRange().

mpDoc

ScDocument* ScSheetSourceDesc::mpDoc

private

Definition at line 80 of file dpshttab.hxx.

Referenced by CheckSourceRange(), CreateCache(), and GetSourceRange().

---

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

• dpshttab.hxx
• dpshttab.cxx