LibreOffice Module sc (master) 1
Public Member Functions | Public Attributes | List of all members
XclPTDataFieldInfo Struct Reference

Contains data for a pivot table data field (SXDI record). More...

#include <xlpivot.hxx>

Inheritance diagram for XclPTDataFieldInfo:
[legend]
Collaboration diagram for XclPTDataFieldInfo:
[legend]

Public Member Functions

 XclPTDataFieldInfo ()
 Number format of the results. More...
 
ScGeneralFunction GetApiAggFunc () const
 Returns the API enum representing the aggregation function. More...
 
void SetApiAggFunc (ScGeneralFunction eAggFunc)
 Sets the aggregation function represented by the passed API enum. More...
 
sal_Int32 GetApiRefType () const
 Returns the API constant representing the result reference type. More...
 
void SetApiRefType (sal_Int32 nRefType)
 Sets the result reference type represented by the passed API constant. More...
 
sal_Int32 GetApiRefItemType () const
 Returns the API constant representing the result reference item type. More...
 
void SetApiRefItemType (sal_Int32 nRefItemType)
 Sets the result reference item type represented by the passed API constant. More...
 
- Public Member Functions inherited from XclPTVisNameInfo
bool HasVisName () const
 The displayed name of the item. More...
 
const OUString * GetVisName () const
 Returns the name, if set explicitly (maVisName.mbUseCache is false). More...
 
void SetVisName (const OUString &rName)
 Sets the visible name and enables usage of cache if name is empty. More...
 

Public Attributes

sal_uInt16 mnField
 
sal_uInt16 mnAggFunc
 Base field for this data info. More...
 
sal_uInt16 mnRefType
 Data aggregation function. More...
 
sal_uInt16 mnRefField
 Result reference type. More...
 
sal_uInt16 mnRefItem
 Index to SXVD of referred field used for the results. More...
 
sal_uInt16 mnNumFmt
 Index to SXVI of referred item of the used field. More...
 
- Public Attributes inherited from XclPTVisNameInfo
XclPTCachedName maVisName
 

Detailed Description

Contains data for a pivot table data field (SXDI record).

Definition at line 672 of file xlpivot.hxx.

Constructor & Destructor Documentation

◆ XclPTDataFieldInfo()

XclPTDataFieldInfo::XclPTDataFieldInfo ( )
explicit

Number format of the results.

Definition at line 700 of file xlpivot.cxx.

Member Function Documentation

◆ GetApiAggFunc()

ScGeneralFunction XclPTDataFieldInfo::GetApiAggFunc ( ) const

◆ GetApiRefItemType()

sal_Int32 XclPTDataFieldInfo::GetApiRefItemType ( ) const

Returns the API constant representing the result reference item type.

Definition at line 786 of file xlpivot.cxx.

References EXC_SXDI_NEXTITEM, EXC_SXDI_PREVITEM, and mnRefItem.

Referenced by XclImpPTField::ConvertDataFieldInfo().

◆ GetApiRefType()

sal_Int32 XclPTDataFieldInfo::GetApiRefType ( ) const

◆ SetApiAggFunc()

void XclPTDataFieldInfo::SetApiAggFunc ( ScGeneralFunction  eAggFunc)

◆ SetApiRefItemType()

void XclPTDataFieldInfo::SetApiRefItemType ( sal_Int32  nRefItemType)

Sets the result reference item type represented by the passed API constant.

Definition at line 798 of file xlpivot.cxx.

References EXC_SXDI_NEXTITEM, EXC_SXDI_PREVITEM, and mnRefItem.

Referenced by XclExpPTField::SetDataPropertiesFromDim().

◆ SetApiRefType()

void XclPTDataFieldInfo::SetApiRefType ( sal_Int32  nRefType)

Member Data Documentation

◆ mnAggFunc

sal_uInt16 XclPTDataFieldInfo::mnAggFunc

Base field for this data info.

Definition at line 675 of file xlpivot.hxx.

Referenced by GetApiAggFunc(), operator<<(), operator>>(), and SetApiAggFunc().

◆ mnField

sal_uInt16 XclPTDataFieldInfo::mnField

◆ mnNumFmt

sal_uInt16 XclPTDataFieldInfo::mnNumFmt

Index to SXVI of referred item of the used field.

Definition at line 679 of file xlpivot.hxx.

Referenced by operator<<(), and operator>>().

◆ mnRefField

sal_uInt16 XclPTDataFieldInfo::mnRefField

Result reference type.

Definition at line 677 of file xlpivot.hxx.

Referenced by XclImpPTField::ConvertDataFieldInfo(), operator<<(), operator>>(), and XclExpPTField::SetDataPropertiesFromDim().

◆ mnRefItem

sal_uInt16 XclPTDataFieldInfo::mnRefItem

Index to SXVD of referred field used for the results.

Definition at line 678 of file xlpivot.hxx.

Referenced by XclImpPTField::ConvertDataFieldInfo(), GetApiRefItemType(), operator<<(), operator>>(), SetApiRefItemType(), and XclExpPTField::SetDataPropertiesFromDim().

◆ mnRefType

sal_uInt16 XclPTDataFieldInfo::mnRefType

Data aggregation function.

Definition at line 676 of file xlpivot.hxx.

Referenced by GetApiRefType(), operator<<(), operator>>(), and SetApiRefType().


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