LibreOffice Module sc (master)  1
Public Member Functions | Protected Attributes | List of all members
XclPCField Class Reference

Represents a field in a pivot cache. More...

#include <xlpivot.hxx>

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

Public Member Functions

 XclPCField (XclPCFieldType eFieldType, sal_uInt16 nFieldIdx)
 
virtual ~XclPCField ()
 
sal_uInt16 GetFieldIndex () const
 Returns the index of this field in the containing pivot cache. More...
 
bool IsSupportedField () const
 Returns true, if the type of the field is supported by Calc. More...
 
bool IsStandardField () const
 Returns true, if this is a standard field build directly from source data. More...
 
bool IsStdGroupField () const
 Returns true, if this field is a grouping field. More...
 
bool IsNumGroupField () const
 Returns true, if this field is a numeric grouping field. More...
 
bool IsDateGroupField () const
 Returns true, if this field is a date/time grouping field. More...
 
bool IsGroupField () const
 Returns true, if this field is a grouping field of any type. More...
 
bool IsGroupBaseField () const
 Returns true, if this field has a child field in a grouping. More...
 
bool IsGroupChildField () const
 Returns true, if this field is a child field in a grouping (it has a base field). More...
 
bool HasOrigItems () const
 Returns true, if the field is based on a column in the source data area. More...
 
bool HasInlineItems () const
 Returns true, if any items are stored after the SXFIELD record. More...
 
bool HasPostponedItems () const
 Returns true, if the items are stored separately after the last field. More...
 
bool Has16BitIndexes () const
 Returns true, if the item indexes in the SXINDEXLIST record are stored as 16-bit values. More...
 

Protected Attributes

XclPCFieldInfo maFieldInfo
 
XclPCFieldType meFieldType
 Pivot cache field info (SXFIELD record). More...
 
sal_uInt16 mnFieldIdx
 Type of this pivot cache field. More...
 
ScfUInt16Vec maGroupOrder
 Own field index in pivot cache. More...
 
XclPCNumGroupInfo maNumGroupInfo
 Order of items in a grouping field (SXGROUPINFO record). More...
 

Detailed Description

Represents a field in a pivot cache.

Supposed as base class for import and export.

Definition at line 477 of file xlpivot.hxx.

Constructor & Destructor Documentation

XclPCField::XclPCField ( XclPCFieldType  eFieldType,
sal_uInt16  nFieldIdx 
)
explicit

Definition at line 283 of file xlpivot.cxx.

XclPCField::~XclPCField ( )
virtual

Definition at line 289 of file xlpivot.cxx.

Member Function Documentation

sal_uInt16 XclPCField::GetFieldIndex ( ) const
inline

Returns the index of this field in the containing pivot cache.

Definition at line 484 of file xlpivot.hxx.

References mnFieldIdx.

Referenced by XclExpPCField::InsertNumDateGroupItems(), XclExpPCField::SetGroupChildField(), and XclExpPCField::XclExpPCField().

bool XclPCField::Has16BitIndexes ( ) const

Returns true, if the item indexes in the SXINDEXLIST record are stored as 16-bit values.

Definition at line 348 of file xlpivot.cxx.

References EXC_SXFIELD_16BIT, get_flag(), IsStandardField(), maFieldInfo, and XclPCFieldInfo::mnFlags.

Referenced by XclExpPCField::GetIndexSize(), and XclExpPCField::WriteIndex().

bool XclPCField::HasInlineItems ( ) const

Returns true, if any items are stored after the SXFIELD record.

Definition at line 338 of file xlpivot.cxx.

References IsGroupField(), IsStandardField(), maFieldInfo, XclPCFieldInfo::mnGroupItems, and XclPCFieldInfo::mnOrigItems.

Referenced by XclImpPCField::ReadItem().

bool XclPCField::HasOrigItems ( ) const

Returns true, if the field is based on a column in the source data area.

Definition at line 333 of file xlpivot.cxx.

References HasPostponedItems(), IsSupportedField(), maFieldInfo, and XclPCFieldInfo::mnOrigItems.

Referenced by XclImpPCField::WriteFieldNameToSource().

bool XclPCField::HasPostponedItems ( ) const

Returns true, if the items are stored separately after the last field.

Definition at line 343 of file xlpivot.cxx.

References EXC_SXFIELD_POSTPONE, get_flag(), IsStandardField(), maFieldInfo, and XclPCFieldInfo::mnFlags.

Referenced by HasOrigItems(), and XclImpPCField::ReadItem().

bool XclPCField::IsDateGroupField ( ) const
bool XclPCField::IsGroupBaseField ( ) const

Returns true, if this field has a child field in a grouping.

Definition at line 323 of file xlpivot.cxx.

References EXC_SXFIELD_HASCHILD, get_flag(), maFieldInfo, and XclPCFieldInfo::mnFlags.

Referenced by XclImpPCField::GetDateGroupStep().

bool XclPCField::IsGroupChildField ( ) const

Returns true, if this field is a child field in a grouping (it has a base field).

Definition at line 328 of file xlpivot.cxx.

References EXC_PCFIELD_DATECHILD, EXC_PCFIELD_STDGROUP, and meFieldType.

Referenced by XclImpPCField::GetDateGroupStep(), XclImpPCField::GetFieldName(), and XclImpPCField::GetGroupBaseField().

bool XclPCField::IsGroupField ( ) const

Returns true, if this field is a grouping field of any type.

Definition at line 318 of file xlpivot.cxx.

References IsDateGroupField(), IsNumGroupField(), and IsStdGroupField().

Referenced by HasInlineItems(), and XclExpPCField::InitStdGroupField().

bool XclPCField::IsNumGroupField ( ) const
bool XclPCField::IsStandardField ( ) const
bool XclPCField::IsStdGroupField ( ) const
bool XclPCField::IsSupportedField ( ) const

Returns true, if the type of the field is supported by Calc.

Definition at line 293 of file xlpivot.cxx.

References EXC_PCFIELD_CALCED, EXC_PCFIELD_UNKNOWN, and meFieldType.

Referenced by XclImpPTField::ConvertFieldInfo(), XclImpPTField::ConvertRCPField(), HasOrigItems(), and XclExpPCField::Save().

Member Data Documentation

XclPCFieldInfo XclPCField::maFieldInfo
protected
ScfUInt16Vec XclPCField::maGroupOrder
protected
XclPCNumGroupInfo XclPCField::maNumGroupInfo
protected
XclPCFieldType XclPCField::meFieldType
protected
sal_uInt16 XclPCField::mnFieldIdx
protected

Type of this pivot cache field.

Definition at line 518 of file xlpivot.hxx.

Referenced by GetFieldIndex(), and XclImpPCField::GetFieldName().


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