LibreOffice Module sc (master)  1
Public Member Functions | Private Attributes | List of all members
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:
[legend]

Public Member Functions

 ScSheetSourceDesc ()=delete
 
SC_DLLPUBLIC ScSheetSourceDesc (ScDocument *pDoc)
 
SC_DLLPUBLIC void SetSourceRange (const ScRange &rRange)
 
SC_DLLPUBLIC const ScRangeGetSourceRange () 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 ScQueryParamGetQueryParam () const
 
bool operator== (const ScSheetSourceDesc &rOther) const
 
SC_DLLPUBLIC const ScDPCacheCreateCache (const ScDPDimensionSaveData *pDimData) const
 
const char * CheckSourceRange () const
 Check the sanity of the data source range. More...
 

Private Attributes

ScRange maSourceRange
 
OUString maRangeName
 
ScQueryParam maQueryParam
 
ScDocumentmpDoc
 

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::ScSheetSourceDesc ( )
delete
ScSheetSourceDesc::ScSheetSourceDesc ( ScDocument pDoc)

Definition at line 220 of file dpshttab.cxx.

Member Function Documentation

const char * 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 306 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().

const ScDPCache * ScSheetSourceDesc::CreateCache ( const ScDPDimensionSaveData pDimData) const
const ScQueryParam& ScSheetSourceDesc::GetQueryParam ( ) const
inline
const OUString& ScSheetSourceDesc::GetRangeName ( ) const
inline
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 229 of file dpshttab.cxx.

References ScRangeName::findByUpperName(), ScGlobal::getCharClassPtr(), ScDocument::GetRangeName(), ScRangeData::IsReference(), 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(), and ScXMLExportDataPilot::WriteDataPilots().

bool ScSheetSourceDesc::HasRangeName ( ) const
bool ScSheetSourceDesc::operator== ( const ScSheetSourceDesc rOther) const

Definition at line 274 of file dpshttab.cxx.

References maQueryParam, maRangeName, and maSourceRange.

void ScSheetSourceDesc::SetQueryParam ( const ScQueryParam rParam)
void ScSheetSourceDesc::SetRangeName ( const OUString &  rName)
void ScSheetSourceDesc::SetSourceRange ( const ScRange rRange)

Member Data Documentation

ScQueryParam ScSheetSourceDesc::maQueryParam
private

Definition at line 79 of file dpshttab.hxx.

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

OUString ScSheetSourceDesc::maRangeName
private
ScRange ScSheetSourceDesc::maSourceRange
mutableprivate

Definition at line 77 of file dpshttab.hxx.

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

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: