sc/inc/pivot.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 /*
  21     IMPORTANT:
  22     Strictly adhere to the following sequence when creating a pivot table:
  23
  24     pPivot->SetColFields(aColArr, aColCount)
  25     pPivot->SetRowFields(aRowArr, aRowCount)
  26     pPivot->SetDataFields(aDataArr, aDataCount)
  27     if (pPivot->CreateData())
  28     {
  29         pPivotDrawData();
  30         pPivotReleaseData();
  31     }
  32
  33     Make sure that either ColArr or RowArr contains a PivotDataField entry.
  34 */
  35
  36 #ifndef INCLUDED_SC_INC_PIVOT_HXX
  37 #define INCLUDED_SC_INC_PIVOT_HXX
  38
  39 #include <rtl/ustring.hxx>
  40 #include <tools/long.hxx>
  41 #include "types.hxx"
  42 #include "scdllapi.h"
  43 #include "dpglobal.hxx"
  44 #include "calcmacros.hxx"
  45
  46 #include <vector>
  47 #include <memory>
  48
  49 #include <com/sun/star/uno/Sequence.hxx>
  50 #include <com/sun/star/sheet/DataPilotFieldReference.hpp>
  51 #include <com/sun/star/sheet/DataPilotFieldSortInfo.hpp>
  52 #include <com/sun/star/sheet/DataPilotFieldLayoutInfo.hpp>
  53 #include <com/sun/star/sheet/DataPilotFieldAutoShowInfo.hpp>
  54
  55 #define PIVOT_DATA_FIELD        (MAXCOLCOUNT)
  56
  57 struct SC_DLLPUBLIC ScDPName
  58 {
  59     OUString     maName;         ///< Original name of the dimension.
  60     OUString     maLayoutName;   ///< Layout name (display name)
  61     sal_uInt8    mnDupCount;
  62
  63     ScDPName();
  64     explicit ScDPName(const OUString& rName, const OUString& rLayoutName, sal_uInt8 nDupCount);
  65 };
  66
  67 struct ScDPLabelData
  68 {
  69     OUString   maName;         ///< Original name of the dimension.
  70     OUString   maLayoutName;   ///< Layout name (display name)
  71     OUString   maSubtotalName;
  72     SCCOL      mnCol;          ///< 0-based field index (not the source column index)
  73     tools::Long       mnOriginalDim;  ///< original dimension index (>= 0 for duplicated dimension)
  74     PivotFunc  mnFuncMask;     ///< Page/Column/Row subtotal function.
  75     sal_Int32  mnUsedHier;     ///< Used hierarchy.
  76     sal_Int32  mnFlags;        ///< Flags from the DataPilotSource dimension
  77     sal_uInt8  mnDupCount;
  78     bool       mbShowAll:1;    ///< true = Show all (also empty) results.
  79     bool       mbIsValue:1;    ///< true = Sum or count in data field.
  80     bool       mbDataLayout:1;
  81     bool       mbRepeatItemLabels:1;
  82
  83     struct Member
  84     {
  85         OUString maName;
  86         OUString maLayoutName;
  87         bool mbVisible;
  88         bool mbShowDetails;
  89
  90         Member();
  91
  92         /**
  93          * @return the name that should be displayed in the dp dialogs i.e.
  94          * when the layout name is present, use it, or else use the original
  95          * name.
  96          */
  97         SC_DLLPUBLIC OUString const & getDisplayName() const;
  98     };
  99     std::vector<Member>                    maMembers;
 100     css::uno::Sequence<OUString>           maHiers;        ///< Hierarchies.
 101     css::sheet::DataPilotFieldSortInfo     maSortInfo;     ///< Sorting info.
 102     css::sheet::DataPilotFieldLayoutInfo   maLayoutInfo;   ///< Layout info.
 103     css::sheet::DataPilotFieldAutoShowInfo maShowInfo;     ///< AutoShow info.
 104
 105     ScDPLabelData();
 106
 107     /**
 108      * @return the name that should be displayed in the dp dialogs i.e. when
 109      * the layout name is present, use it, or else use the original name.
 110      */
 111     SC_DLLPUBLIC OUString const & getDisplayName() const;
 112 };
 113
 114 typedef std::vector< std::unique_ptr<ScDPLabelData> > ScDPLabelDataVector;
 115
 116 struct ScPivotField
 117 {
 118     css::sheet::DataPilotFieldReference maFieldRef;
 119
 120     tools::Long        mnOriginalDim; ///< >= 0 for duplicated field.
 121     PivotFunc   nFuncMask;
 122     SCCOL       nCol;          ///< 0-based dimension index (not source column index)
 123     sal_uInt8   mnDupCount;
 124
 125     explicit ScPivotField( SCCOL nNewCol = 0 );
 126
 127     tools::Long getOriginalDim() const;
 128 };
 129
 130 typedef std::vector< ScPivotField > ScPivotFieldVector;
 131
 132 struct ScPivotParam
 133 {
 134     SCCOL nCol;           ///< Cursor Position /
 135     SCROW nRow;           ///< or start of destination area
 136     SCTAB nTab;
 137
 138     ScDPLabelDataVector maLabelArray;
 139     ScPivotFieldVector  maPageFields;
 140     ScPivotFieldVector  maColFields;
 141     ScPivotFieldVector  maRowFields;
 142     ScPivotFieldVector  maDataFields;
 143
 144     bool bIgnoreEmptyRows;
 145     bool bDetectCategories;
 146     bool bMakeTotalCol;
 147     bool bMakeTotalRow;
 148
 149     ScPivotParam();
 150     ScPivotParam( const ScPivotParam& r );
 151     ~ScPivotParam();
 152
 153     ScPivotParam&   operator=  ( const ScPivotParam& r );
 154     void SetLabelData(const ScDPLabelDataVector& r);
 155 };
 156
 157 struct ScPivotFuncData
 158 {
 159     css::sheet::DataPilotFieldReference maFieldRef;
 160
 161     tools::Long       mnOriginalDim;
 162     PivotFunc  mnFuncMask;
 163     SCCOL      mnCol;
 164     sal_uInt8  mnDupCount;
 165
 166     explicit ScPivotFuncData( SCCOL nCol, PivotFunc nFuncMask );
 167
 168 #if DEBUG_PIVOT_TABLE
 169     void Dump() const;
 170 #endif
 171 };
 172
 173 typedef std::vector<ScDPName> ScDPNameVec;
 174
 175 #endif
 176
 177 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */