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

#include <pivottablebuffer.hxx>

Inheritance diagram for oox::xls::PivotTableField:
[legend]
Collaboration diagram for oox::xls::PivotTableField:
[legend]

Public Member Functions

 PivotTableField (PivotTable &rPivotTable, sal_Int32 nFieldIndex)
 
void importPivotField (const AttributeList &rAttribs)
 Imports pivot field settings from the pivotField element. More...
 
void importItem (const AttributeList &rAttribs)
 Imports settings of an item in this pivot field from the item element. More...
 
void importReference (const AttributeList &rAttribs)
 Imports pivot field reference settings from the reference element. More...
 
void importReferenceItem (const AttributeList &rAttribs)
 Imports pivot field item reference settings from the x element. More...
 
void importPTField (SequenceInputStream &rStrm)
 Imports pivot field settings from the PTFIELD record. More...
 
void importPTFItem (SequenceInputStream &rStrm)
 Imports settings of an item in this pivot field from the PTFITEM record. More...
 
void importPTReference (SequenceInputStream &rStrm)
 Imports pivot field reference settings from the PTREFERENCE record. More...
 
void importPTReferenceItem (SequenceInputStream &rStrm)
 Imports pivot field item reference settings from the PTREFERENCEITEM record. More...
 
void finalizeImport (const css::uno::Reference< css::sheet::XDataPilotDescriptor > &rxDPDesc)
 Finalizes the field after import, creates grouping and other settings. More...
 
void finalizeDateGroupingImport (const css::uno::Reference< css::sheet::XDataPilotField > &rxBaseDPField, sal_Int32 nBaseFieldIdx)
 Finalizes the grouped date field after import. More...
 
void finalizeParentGroupingImport (const css::uno::Reference< css::sheet::XDataPilotField > &rxBaseDPField, const PivotCacheField &rBaseCacheField, PivotCacheGroupItemVector &orItemNames)
 Finalizes the grouped field after import. More...
 
void finalizeImportBasedOnCache (const css::uno::Reference< css::sheet::XDataPilotDescriptor > &rxDPDesc)
 
const OUString & getDPFieldName () const
 Returns the name of the DataPilot field in the fields collection. More...
 
void convertRowField ()
 Converts dimension and other settings for a row field. More...
 
void convertColField ()
 Converts dimension and other settings for a column field. More...
 
void convertHiddenField ()
 Converts dimension and other settings for a hidden field. More...
 
void convertPageField (const PTPageFieldModel &rPageField)
 Converts dimension and other settings for a page field. More...
 
void convertDataField (const PTDataFieldModel &rDataField)
 Converts dimension and other settings for a data field. More...
 
- Public Member Functions inherited from oox::xls::WorkbookHelper
 WorkbookHelper (WorkbookGlobals &rBookGlob)
 
virtual ~WorkbookHelper ()
 
 WorkbookHelper (WorkbookHelper const &)=default
 
 WorkbookHelper (WorkbookHelper &&)=default
 
WorkbookHelperoperator= (WorkbookHelper const &)=delete
 
WorkbookHelperoperator= (WorkbookHelper &&)=delete
 
::oox::core::FilterBasegetBaseFilter () const
 Returns the base filter object (base class of all filters). More...
 
SegmentProgressBargetProgressBar () const
 Returns the filter progress bar. More...
 
sal_Int16 getCurrentSheetIndex () const
 Returns the index of the current Calc sheet, if filter currently processes a sheet. More...
 
bool isGeneratorKnownGood () const
 Returns true when reading a file generated by a known good generator. More...
 
bool hasCalculatedFormulaCells () const
 Returns true if any formula cell is calculated. More...
 
void setCalculatedFormulaCells ()
 Set if any formula cell is calculated. More...
 
void setVbaProjectStorage (const StorageRef &rxVbaPrjStrg)
 Sets the VBA project storage used to import VBA source code and forms. More...
 
void setCurrentSheetIndex (SCTAB nSheet)
 Sets the index of the current Calc sheet, if filter currently processes a sheet. More...
 
void finalizeWorkbookImport ()
 Final conversion after importing the workbook. More...
 
void useInternalChartDataTable (bool bInternal)
 
ScDocumentgetScDocument ()
 
const ScDocumentgetScDocument () const
 
ScDocumentImportgetDocImport ()
 
const ScDocumentImportgetDocImport () const
 
ScEditEngineDefaultergetEditEngine () const
 
const css::uno::Reference< css::sheet::XSpreadsheetDocument > & getDocument () const
 Returns a reference to the source/target spreadsheet document model. More...
 
css::uno::Reference< css::sheet::XSpreadsheet > getSheetFromDoc (sal_Int32 nSheet) const
 Returns a reference to the specified spreadsheet in the document model. More...
 
css::uno::Reference< css::sheet::XSpreadsheet > getSheetFromDoc (const OUString &rSheet) const
 Returns a reference to the specified spreadsheet in the document model. More...
 
css::uno::Reference< css::table::XCellRange > getCellRangeFromDoc (const ScRange &rRange) const
 Returns the XCellRange interface for the passed cell range address. More...
 
css::uno::Reference< css::container::XNameContainer > getCellStyleFamily () const
 Returns the cell styles container from the Calc document. More...
 
css::uno::Reference< css::style::XStyle > getStyleObject (const OUString &rStyleName, bool bPageStyle) const
 Returns the specified cell or page style from the Calc document. More...
 
RangeDataRet createNamedRangeObject (OUString &orName, sal_Int32 nIndex, sal_Int32 nNameFlags, bool bHidden) const
 Creates and returns a defined name on-the-fly in the Calc document. More...
 
RangeDataRet createLocalNamedRangeObject (OUString &orName, sal_Int32 nIndex, sal_Int32 nNameFlags, sal_Int32 nTab, bool bHidden) const
 Creates and returns a defined name on-the-fly in the sheet. More...
 
css::uno::Reference< css::sheet::XDatabaseRange > createDatabaseRangeObject (OUString &orName, const ScRange &rRangeAddr) const
 Creates and returns a database range on-the-fly in the Calc document. More...
 
css::uno::Reference< css::sheet::XDatabaseRange > createUnnamedDatabaseRangeObject (const ScRange &rRangeAddr) const
 Creates and returns an unnamed database range on-the-fly in the Calc document. More...
 
ScDBDatafindDatabaseRangeByIndex (sal_uInt16 nIndex) const
 Finds the (already existing) database range of the given formula token index. More...
 
css::uno::Reference< css::style::XStyle > createStyleObject (OUString &orStyleName, bool bPageStyle) const
 Creates and returns a com.sun.star.style.Style object for cells or pages. More...
 
FormulaBuffergetFormulaBuffer () const
 
WorkbookSettingsgetWorkbookSettings () const
 Returns the global workbook settings object. More...
 
ViewSettingsgetViewSettings () const
 Returns the workbook and sheet view settings object. More...
 
WorksheetBuffergetWorksheets () const
 Returns the worksheet buffer containing sheet names and properties. More...
 
ThemeBuffergetTheme () const
 Returns the office theme object read from the theme substorage. More...
 
StylesBuffergetStyles () const
 Returns all cell formatting objects read from the styles substream. More...
 
SharedStringsBuffergetSharedStrings () const
 Returns the shared strings read from the shared strings substream. More...
 
ExternalLinkBuffergetExternalLinks () const
 Returns the external links read from the external links substream. More...
 
DefinedNamesBuffergetDefinedNames () const
 Returns the defined names read from the workbook globals. More...
 
TableBuffergetTables () const
 Returns the tables collection (equivalent to Calc's database ranges). More...
 
ScenarioBuffergetScenarios () const
 Returns the scenarios collection. More...
 
ConnectionsBuffergetConnections () const
 Returns the collection of external data connections. More...
 
PivotCacheBuffergetPivotCaches () const
 Returns the collection of pivot caches. More...
 
PivotTableBuffergetPivotTables () const
 Returns the collection of pivot tables. More...
 
FormulaParsergetFormulaParser () const
 Returns a shared import formula parser (import filter only!). More...
 
FormulaParsercreateFormulaParser () const
 Returns an unshared import formula parser (import filter only!). More...
 
UnitConvertergetUnitConverter () const
 Returns the measurement unit converter. More...
 
AddressConvertergetAddressConverter () const
 Returns the converter for string to cell address/range conversion. More...
 
oox::drawingml::chart::ChartConvertergetChartConverter () const
 Returns the chart object converter. More...
 
PageSettingsConvertergetPageSettingsConverter () const
 Returns the page and print settings converter. More...
 
::oox::core::XmlFilterBasegetOoxFilter () const
 Returns the base OOXML/BIFF12 filter object. More...
 
bool importOoxFragment (const rtl::Reference< oox::core::FragmentHandler > &rxHandler)
 Imports a fragment using the passed fragment handler, which contains the full path to the fragment stream. More...
 
bool importOoxFragment (const rtl::Reference< oox::core::FragmentHandler > &rxHandler, oox::core::FastParser &rParser)
 
rtl_TextEncoding getTextEncoding () const
 Returns the text encoding used to import/export byte strings. More...
 

Private Types

typedef ::std::vector< PTFieldItemModelItemModelVector
 

Private Member Functions

css::uno::Reference< css::sheet::XDataPilotField > convertRowColPageField (sal_Int32 nAxis)
 Converts dimension and other settings for row, column, page, or hidden fields. More...
 

Private Attributes

PivotTablemrPivotTable
 
ItemModelVector maItems
 The parent pivot table object. More...
 
PTFieldModel maModel
 All items of this field. More...
 
OUString maDPFieldName
 Pivot field settings. More...
 
sal_Int32 mnFieldIndex
 Name of the field in DataPilot field collection. More...
 

Additional Inherited Members

- Public Types inherited from oox::xls::WorkbookHelper
typedef std::pair< ScRangeData *, bool > RangeDataRet
 
- Static Public Member Functions inherited from oox::xls::WorkbookHelper
static WorkbookGlobalsRef constructGlobals (ExcelFilter &rFilter)
 

Detailed Description

Definition at line 115 of file pivottablebuffer.hxx.

Member Typedef Documentation

◆ ItemModelVector

Definition at line 173 of file pivottablebuffer.hxx.

Constructor & Destructor Documentation

◆ PivotTableField()

oox::xls::PivotTableField::PivotTableField ( PivotTable rPivotTable,
sal_Int32  nFieldIndex 
)
explicit

Definition at line 255 of file pivottablebuffer.cxx.

Member Function Documentation

◆ convertColField()

void oox::xls::PivotTableField::convertColField ( )

Converts dimension and other settings for a column field.

Definition at line 513 of file pivottablebuffer.cxx.

References convertRowColPageField().

◆ convertDataField()

void oox::xls::PivotTableField::convertDataField ( const PTDataFieldModel rDataField)

◆ convertHiddenField()

void oox::xls::PivotTableField::convertHiddenField ( )

Converts dimension and other settings for a hidden field.

Definition at line 518 of file pivottablebuffer.cxx.

References convertRowColPageField(), and XML_TOKEN_INVALID.

◆ convertPageField()

void oox::xls::PivotTableField::convertPageField ( const PTPageFieldModel rPageField)

◆ convertRowColPageField()

Reference< XDataPilotField > oox::xls::PivotTableField::convertRowColPageField ( sal_Int32  nAxis)
private

Converts dimension and other settings for row, column, page, or hidden fields.

Definition at line 656 of file pivottablebuffer.cxx.

References aLayoutInfo, comphelper::containerToSequence(), Exception, oox::xls::PivotTable::getCacheField(), oox::xls::PivotTable::getCacheFieldOfDataField(), oox::xls::PivotTable::getDataLayoutField(), oox::xls::PivotTable::getDataPilotField(), ScDPSaveData::GetDimensionByName(), oox::xls::PivotTable::getDPObject(), oox::xls::PivotCacheItem::getFormattedName(), ScDPSaveDimension::GetMemberByName(), oox::xls::PivotCacheField::getName(), ScDPObject::GetSaveData(), oox::xls::WorkbookHelper::getWorkbookSettings(), maDPFieldName, maItems, maModel, oox::xls::PTFieldModel::mbAutoShow, oox::xls::PTFieldModel::mbAverageSubtotal, oox::xls::PTFieldModel::mbCompact, oox::xls::PTFieldModel::mbCountASubtotal, oox::xls::PTFieldModel::mbCountSubtotal, oox::xls::PTFieldModel::mbDefaultSubtotal, oox::xls::PTFieldModel::mbInsertBlankRow, oox::xls::PTFieldModel::mbMaxSubtotal, oox::xls::PTFieldModel::mbMinSubtotal, oox::xls::PTFieldModel::mbOutline, oox::xls::PTFieldModel::mbProductSubtotal, oox::xls::PTFieldModel::mbShowAll, oox::xls::PTFieldModel::mbStdDevPSubtotal, oox::xls::PTFieldModel::mbStdDevSubtotal, oox::xls::PTFieldModel::mbSubtotalTop, oox::xls::PTFieldModel::mbSumSubtotal, oox::xls::PTFieldModel::mbTopAutoShow, oox::xls::PTFieldModel::mbVarPSubtotal, oox::xls::PTFieldModel::mbVarSubtotal, oox::xls::PTFieldModel::mnAutoShowItems, oox::xls::PTFieldModel::mnAutoShowRankBy, oox::xls::PTFieldModel::mnAxis, mnFieldIndex, oox::xls::PTFieldModel::mnSortRefField, oox::xls::PTFieldModel::mnSortRefItem, oox::xls::PTFieldModel::mnSortType, mrPivotTable, SAL_WARN_IF, ScDPSaveMember::SetIsVisible(), oox::PropertySet::setProperty(), and ScDPSaveMember::SetShowDetails().

Referenced by convertColField(), convertHiddenField(), convertPageField(), and convertRowField().

◆ convertRowField()

void oox::xls::PivotTableField::convertRowField ( )

Converts dimension and other settings for a row field.

Definition at line 508 of file pivottablebuffer.cxx.

References convertRowColPageField().

◆ finalizeDateGroupingImport()

void oox::xls::PivotTableField::finalizeDateGroupingImport ( const css::uno::Reference< css::sheet::XDataPilotField > &  rxBaseDPField,
sal_Int32  nBaseFieldIdx 
)

Finalizes the grouped date field after import.

Definition at line 437 of file pivottablebuffer.cxx.

References oox::xls::PivotTable::getCacheField(), maDPFieldName, mnFieldIndex, and mrPivotTable.

Referenced by oox::xls::PivotTable::finalizeDateGroupingImport().

◆ finalizeImport()

void oox::xls::PivotTableField::finalizeImport ( const css::uno::Reference< css::sheet::XDataPilotDescriptor > &  rxDPDesc)

◆ finalizeImportBasedOnCache()

void oox::xls::PivotTableField::finalizeImportBasedOnCache ( const css::uno::Reference< css::sheet::XDataPilotDescriptor > &  rxDPDesc)

◆ finalizeParentGroupingImport()

void oox::xls::PivotTableField::finalizeParentGroupingImport ( const css::uno::Reference< css::sheet::XDataPilotField > &  rxBaseDPField,
const PivotCacheField rBaseCacheField,
PivotCacheGroupItemVector orItemNames 
)

◆ getDPFieldName()

const OUString & oox::xls::PivotTableField::getDPFieldName ( ) const
inline

Returns the name of the DataPilot field in the fields collection.

Definition at line 154 of file pivottablebuffer.hxx.

References maDPFieldName.

◆ importItem()

void oox::xls::PivotTableField::importItem ( const AttributeList rAttribs)

◆ importPivotField()

void oox::xls::PivotTableField::importPivotField ( const AttributeList rAttribs)

◆ importPTField()

void oox::xls::PivotTableField::importPTField ( SequenceInputStream rStrm)

◆ importPTFItem()

void oox::xls::PivotTableField::importPTFItem ( SequenceInputStream rStrm)

◆ importPTReference()

void oox::xls::PivotTableField::importPTReference ( SequenceInputStream rStrm)

Imports pivot field reference settings from the PTREFERENCE record.

Definition at line 374 of file pivottablebuffer.cxx.

References maModel, oox::xls::PTFieldModel::mnSortRefField, and rStrm.

Referenced by oox::xls::PivotTableFieldContext::onCreateRecordContext().

◆ importPTReferenceItem()

void oox::xls::PivotTableField::importPTReferenceItem ( SequenceInputStream rStrm)

Imports pivot field item reference settings from the PTREFERENCEITEM record.

Definition at line 379 of file pivottablebuffer.cxx.

References maModel, oox::xls::PTFieldModel::mnSortRefItem, and rStrm.

Referenced by oox::xls::PivotTableFieldContext::onCreateRecordContext().

◆ importReference()

void oox::xls::PivotTableField::importReference ( const AttributeList rAttribs)

Imports pivot field reference settings from the reference element.

Definition at line 309 of file pivottablebuffer.cxx.

References oox::AttributeList::getUnsigned(), maModel, oox::xls::PTFieldModel::mnSortRefField, and SAL_MAX_UINT32.

Referenced by oox::xls::PivotTableFieldContext::onCreateContext().

◆ importReferenceItem()

void oox::xls::PivotTableField::importReferenceItem ( const AttributeList rAttribs)

Imports pivot field item reference settings from the x element.

Definition at line 315 of file pivottablebuffer.cxx.

References oox::AttributeList::getInteger(), maModel, and oox::xls::PTFieldModel::mnSortRefItem.

Referenced by oox::xls::PivotTableFieldContext::onCreateContext().

Member Data Documentation

◆ maDPFieldName

OUString oox::xls::PivotTableField::maDPFieldName
private

◆ maItems

ItemModelVector oox::xls::PivotTableField::maItems
private

The parent pivot table object.

Definition at line 176 of file pivottablebuffer.hxx.

Referenced by convertPageField(), convertRowColPageField(), finalizeParentGroupingImport(), importItem(), and importPTFItem().

◆ maModel

PTFieldModel oox::xls::PivotTableField::maModel
private

◆ mnFieldIndex

sal_Int32 oox::xls::PivotTableField::mnFieldIndex
private

◆ mrPivotTable

PivotTable& oox::xls::PivotTableField::mrPivotTable
private

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