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

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

#include <xlpivot.hxx>

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

Public Member Functions

 XclPTFieldInfo ()
 Index into cache for field name (not part of record). More...
 
css::sheet::DataPilotFieldOrientation GetApiOrient (sal_uInt16 nMask) const
 Returns the API enum representing the orientation (first of row/col/page/data). More...
 
void AddApiOrient (css::sheet::DataPilotFieldOrientation eOrient)
 Adds the axis orientation represented by the passed API enum. More...
 
void GetSubtotals (XclPTSubtotalVec &rSubtotals) const
 Returns a vector of all set subtotal functions. More...
 
void SetSubtotals (const XclPTSubtotalVec &rSubtotals)
 Sets the subtotal functions contained in the passed sequence. 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 mnAxes
 
sal_uInt16 mnSubtCount
 Flags for axes this field is part of. More...
 
sal_uInt16 mnSubtotals
 Number of subtotal functions. More...
 
sal_uInt16 mnItemCount
 Bitfield for subtotal functions. More...
 
sal_uInt16 mnCacheIdx
 Number of items of this field. More...
 
- Public Attributes inherited from XclPTVisNameInfo
XclPTCachedName maVisName
 

Detailed Description

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

Definition at line 592 of file xlpivot.hxx.

Constructor & Destructor Documentation

XclPTFieldInfo::XclPTFieldInfo ( )
explicit

Index into cache for field name (not part of record).

Definition at line 460 of file xlpivot.cxx.

Member Function Documentation

void XclPTFieldInfo::AddApiOrient ( css::sheet::DataPilotFieldOrientation  eOrient)

Adds the axis orientation represented by the passed API enum.

Definition at line 485 of file xlpivot.cxx.

References EXC_SXVD_AXIS_COL, EXC_SXVD_AXIS_DATA, EXC_SXVD_AXIS_PAGE, EXC_SXVD_AXIS_ROW, and mnAxes.

Referenced by XclExpPTField::SetDataPropertiesFromDim(), and XclExpPTField::SetPropertiesFromDim().

DataPilotFieldOrientation XclPTFieldInfo::GetApiOrient ( sal_uInt16  nMask) const

Returns the API enum representing the orientation (first of row/col/page/data).

Parameters
nMaskRestricts the axes taken into account.
Returns
The first found axis orientation, that is allowed in nMask parameter.

Definition at line 469 of file xlpivot.cxx.

References EXC_SXVD_AXIS_COL, EXC_SXVD_AXIS_DATA, EXC_SXVD_AXIS_PAGE, EXC_SXVD_AXIS_ROW, and mnAxes.

Referenced by XclImpPTField::ConvertRCPField(), and XclImpPTField::ConvertRowColField().

void XclPTFieldInfo::GetSubtotals ( XclPTSubtotalVec rSubtotals) const
void XclPTFieldInfo::SetSubtotals ( const XclPTSubtotalVec rSubtotals)

Member Data Documentation

sal_uInt16 XclPTFieldInfo::mnAxes
sal_uInt16 XclPTFieldInfo::mnCacheIdx
sal_uInt16 XclPTFieldInfo::mnItemCount

Bitfield for subtotal functions.

Definition at line 597 of file xlpivot.hxx.

Referenced by XclExpPTField::AppendSubtotalItem(), operator<<(), operator>>(), and XclExpPTField::XclExpPTField().

sal_uInt16 XclPTFieldInfo::mnSubtCount

Flags for axes this field is part of.

Definition at line 595 of file xlpivot.hxx.

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

sal_uInt16 XclPTFieldInfo::mnSubtotals

Number of subtotal functions.

Definition at line 596 of file xlpivot.hxx.

Referenced by XclExpPTField::AppendSubtotalItems(), GetSubtotals(), operator<<(), operator>>(), and SetSubtotals().


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