| /************************************************************** |
| * |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| *************************************************************/ |
| |
| |
| |
| #ifndef SC_DPSAVE_HXX |
| #define SC_DPSAVE_HXX |
| |
| #include <tools/string.hxx> |
| #include <tools/list.hxx> |
| #include <com/sun/star/sheet/XDimensionsSupplier.hpp> |
| #include <com/sun/star/sheet/DataPilotFieldOrientation.hpp> |
| #include "scdllapi.h" |
| #include <hash_map> |
| #include <list> |
| #include <memory> |
| |
| namespace com { namespace sun { namespace star { namespace sheet { |
| struct DataPilotFieldReference; |
| struct DataPilotFieldSortInfo; |
| struct DataPilotFieldAutoShowInfo; |
| struct DataPilotFieldLayoutInfo; |
| } } } } |
| |
| class ScDPDimensionSaveData; |
| class ScDPTableData; |
| class ScDPObject; |
| |
| // -------------------------------------------------------------------- |
| // |
| // classes to save Data Pilot settings |
| // |
| |
| |
| class ScDPSaveMember |
| { |
| private: |
| String aName; |
| ::std::auto_ptr<rtl::OUString> mpLayoutName; // custom name to be displayed in the table. |
| sal_uInt16 nVisibleMode; |
| sal_uInt16 nShowDetailsMode; |
| |
| public: |
| ScDPSaveMember(const String& rName); |
| ScDPSaveMember(const ScDPSaveMember& r); |
| ~ScDPSaveMember(); |
| |
| sal_Bool operator== ( const ScDPSaveMember& r ) const; |
| |
| const String& GetName() const { return aName; } |
| SC_DLLPUBLIC sal_Bool HasIsVisible() const; |
| SC_DLLPUBLIC void SetIsVisible(sal_Bool bSet); |
| sal_Bool GetIsVisible() const { return sal_Bool(nVisibleMode); } |
| SC_DLLPUBLIC sal_Bool HasShowDetails() const; |
| SC_DLLPUBLIC void SetShowDetails(sal_Bool bSet); |
| sal_Bool GetShowDetails() const { return sal_Bool(nShowDetailsMode); } |
| |
| void SetName( const String& rNew ); // used if the source member was renamed (groups) |
| |
| SC_DLLPUBLIC void SetLayoutName( const ::rtl::OUString& rName ); |
| SC_DLLPUBLIC const ::rtl::OUString* GetLayoutName() const; |
| void RemoveLayoutName(); |
| |
| void WriteToSource( const com::sun::star::uno::Reference< |
| com::sun::star::uno::XInterface>& xMember, |
| sal_Int32 nPosition ); |
| }; |
| |
| |
| bool operator == (const ::com::sun::star::sheet::DataPilotFieldSortInfo &l, const ::com::sun::star::sheet::DataPilotFieldSortInfo &r ); |
| bool operator == (const ::com::sun::star::sheet::DataPilotFieldAutoShowInfo &l, const ::com::sun::star::sheet::DataPilotFieldAutoShowInfo &r ); |
| bool operator == (const ::com::sun::star::sheet::DataPilotFieldReference &l, const ::com::sun::star::sheet::DataPilotFieldReference &r ); |
| class SC_DLLPUBLIC ScDPSaveDimension |
| { |
| private: |
| String aName; |
| String* pSelectedPage; |
| ::std::auto_ptr<rtl::OUString> mpLayoutName; |
| ::std::auto_ptr<rtl::OUString> mpSubtotalName; |
| sal_Bool bIsDataLayout; |
| sal_Bool bDupFlag; |
| sal_uInt16 nOrientation; |
| sal_uInt16 nFunction; // enum GeneralFunction, for data dimensions |
| long nUsedHierarchy; |
| sal_uInt16 nShowEmptyMode; //! at level |
| sal_Bool bSubTotalDefault; //! at level |
| long nSubTotalCount; |
| sal_uInt16* pSubTotalFuncs; // enum GeneralFunction |
| ::com::sun::star::sheet::DataPilotFieldReference* pReferenceValue; |
| ::com::sun::star::sheet::DataPilotFieldSortInfo* pSortInfo; // (level) |
| ::com::sun::star::sheet::DataPilotFieldAutoShowInfo* pAutoShowInfo; // (level) |
| ::com::sun::star::sheet::DataPilotFieldLayoutInfo* pLayoutInfo; // (level) |
| |
| public: |
| typedef std::hash_map <String, ScDPSaveMember*, rtl::OUStringHash> MemberHash; |
| typedef std::list <ScDPSaveMember*> MemberList; |
| private: |
| MemberHash maMemberHash; |
| MemberList maMemberList; |
| public: |
| ScDPSaveDimension(const String& rName, sal_Bool bDataLayout); |
| ScDPSaveDimension(const ScDPSaveDimension& r); |
| ~ScDPSaveDimension(); |
| |
| sal_Bool operator== ( const ScDPSaveDimension& r ) const; |
| |
| const MemberList& GetMembers() const { return maMemberList; } |
| void AddMember(ScDPSaveMember* pMember); |
| |
| void SetDupFlag(sal_Bool bSet) { bDupFlag = bSet; } |
| sal_Bool GetDupFlag() const { return bDupFlag; } |
| |
| const String& GetName() const { return aName; } |
| sal_Bool IsDataLayout() const { return bIsDataLayout; } |
| |
| void SetName( const String& rNew ); // used if the source dim was renamed (groups) |
| |
| void SetOrientation(sal_uInt16 nNew); |
| void SetSubTotals(long nCount, const sal_uInt16* pFuncs); |
| long GetSubTotalsCount() const { return nSubTotalCount; } |
| sal_uInt16 GetSubTotalFunc(long nIndex) const { return pSubTotalFuncs[nIndex]; } |
| bool HasShowEmpty() const; |
| void SetShowEmpty(sal_Bool bSet); |
| sal_Bool GetShowEmpty() const { return sal_Bool(nShowEmptyMode); } |
| void SetFunction(sal_uInt16 nNew); // enum GeneralFunction |
| sal_uInt16 GetFunction() const { return nFunction; } |
| void SetUsedHierarchy(long nNew); |
| long GetUsedHierarchy() const { return nUsedHierarchy; } |
| |
| void SetLayoutName(const ::rtl::OUString& rName); |
| const ::rtl::OUString* GetLayoutName() const; |
| void RemoveLayoutName(); |
| void SetSubtotalName(const ::rtl::OUString& rName); |
| const ::rtl::OUString* GetSubtotalName() const; |
| |
| bool IsMemberNameInUse(const ::rtl::OUString& rName) const; |
| |
| const ::com::sun::star::sheet::DataPilotFieldReference* GetReferenceValue() const { return pReferenceValue; } |
| void SetReferenceValue(const ::com::sun::star::sheet::DataPilotFieldReference* pNew); |
| |
| const ::com::sun::star::sheet::DataPilotFieldSortInfo* GetSortInfo() const { return pSortInfo; } |
| void SetSortInfo(const ::com::sun::star::sheet::DataPilotFieldSortInfo* pNew); |
| const ::com::sun::star::sheet::DataPilotFieldAutoShowInfo* GetAutoShowInfo() const { return pAutoShowInfo; } |
| void SetAutoShowInfo(const ::com::sun::star::sheet::DataPilotFieldAutoShowInfo* pNew); |
| const ::com::sun::star::sheet::DataPilotFieldLayoutInfo* GetLayoutInfo() const { return pLayoutInfo; } |
| void SetLayoutInfo(const ::com::sun::star::sheet::DataPilotFieldLayoutInfo* pNew); |
| |
| void SetCurrentPage( const String* pPage ); // NULL = no selection (all) |
| sal_Bool HasCurrentPage() const; |
| const String& GetCurrentPage() const; |
| |
| sal_uInt16 GetOrientation() const { return nOrientation; } |
| |
| ScDPSaveMember* GetExistingMemberByName(const String& rName); |
| ScDPSaveMember* GetMemberByName(const String& rName); |
| |
| void SetMemberPosition( const String& rName, sal_Int32 nNewPos ); |
| |
| void WriteToSource( const com::sun::star::uno::Reference< |
| com::sun::star::uno::XInterface>& xDim ); |
| void Refresh( const com::sun::star::uno::Reference< |
| com::sun::star::sheet::XDimensionsSupplier>& xSource , |
| const std::list<String> & deletedDims); |
| |
| void UpdateMemberVisibility(const ::std::hash_map< ::rtl::OUString, bool, ::rtl::OUStringHash>& rData); |
| |
| bool HasInvisibleMember() const; |
| }; |
| |
| |
| class ScDPSaveData |
| { |
| private: |
| List aDimList; |
| ScDPDimensionSaveData* pDimensionData; // settings that create new dimensions |
| sal_uInt16 nColumnGrandMode; |
| sal_uInt16 nRowGrandMode; |
| sal_uInt16 nIgnoreEmptyMode; |
| sal_uInt16 nRepeatEmptyMode; |
| sal_Bool bFilterButton; // not passed to DataPilotSource |
| sal_Bool bDrillDown; // not passed to DataPilotSource |
| // Wang Xu Ming -- 2009-8-17 |
| // DataPilot Migration - Cache&&Performance |
| long mnCacheId; |
| // End Comments |
| |
| /** if true, all dimensions already have all of their member instances |
| * created. */ |
| bool mbDimensionMembersBuilt; |
| |
| ::std::auto_ptr<rtl::OUString> mpGrandTotalName; |
| |
| public: |
| SC_DLLPUBLIC ScDPSaveData(); |
| ScDPSaveData(const ScDPSaveData& r); |
| SC_DLLPUBLIC ~ScDPSaveData(); |
| |
| ScDPSaveData& operator= ( const ScDPSaveData& r ); |
| |
| sal_Bool operator== ( const ScDPSaveData& r ) const; |
| |
| SC_DLLPUBLIC void SetGrandTotalName(const ::rtl::OUString& rName); |
| SC_DLLPUBLIC const ::rtl::OUString* GetGrandTotalName() const; |
| |
| const List& GetDimensions() const { return aDimList; } |
| void AddDimension(ScDPSaveDimension* pDim) { aDimList.Insert(pDim, LIST_APPEND); } |
| |
| ScDPSaveDimension* GetDimensionByName(const String& rName); |
| SC_DLLPUBLIC ScDPSaveDimension* GetDataLayoutDimension(); |
| SC_DLLPUBLIC ScDPSaveDimension* GetExistingDataLayoutDimension() const; |
| |
| ScDPSaveDimension* DuplicateDimension(const String& rName); |
| SC_DLLPUBLIC ScDPSaveDimension& DuplicateDimension(const ScDPSaveDimension& rDim); |
| |
| SC_DLLPUBLIC ScDPSaveDimension* GetExistingDimensionByName(const String& rName) const; |
| SC_DLLPUBLIC ScDPSaveDimension* GetNewDimensionByName(const String& rName); |
| |
| void RemoveDimensionByName(const String& rName); |
| |
| ScDPSaveDimension* GetInnermostDimension(sal_uInt16 nOrientation); |
| ScDPSaveDimension* GetFirstDimension(::com::sun::star::sheet::DataPilotFieldOrientation eOrientation); |
| long GetDataDimensionCount() const; |
| |
| |
| void SetPosition( ScDPSaveDimension* pDim, long nNew ); |
| SC_DLLPUBLIC void SetColumnGrand( sal_Bool bSet ); |
| sal_Bool GetColumnGrand() const { return sal_Bool(nColumnGrandMode); } |
| SC_DLLPUBLIC void SetRowGrand( sal_Bool bSet ); |
| sal_Bool GetRowGrand() const { return sal_Bool(nRowGrandMode); } |
| void SetIgnoreEmptyRows( sal_Bool bSet ); |
| sal_Bool GetIgnoreEmptyRows() const { return sal_Bool(nIgnoreEmptyMode); } |
| void SetRepeatIfEmpty( sal_Bool bSet ); |
| sal_Bool GetRepeatIfEmpty() const { return sal_Bool(nRepeatEmptyMode); } |
| |
| SC_DLLPUBLIC void SetFilterButton( sal_Bool bSet ); |
| sal_Bool GetFilterButton() const { return bFilterButton; } |
| SC_DLLPUBLIC void SetDrillDown( sal_Bool bSet ); |
| sal_Bool GetDrillDown() const { return bDrillDown; } |
| |
| void WriteToSource( const com::sun::star::uno::Reference< |
| com::sun::star::sheet::XDimensionsSupplier>& xSource ); |
| // Wang Xu Ming -- 2009-8-17 |
| // DataPilot Migration - Cache&&Performance |
| void Refresh( const com::sun::star::uno::Reference< |
| com::sun::star::sheet::XDimensionsSupplier>& xSource ); |
| sal_Bool IsEmpty() const; |
| inline long GetCacheId() const{ return mnCacheId; } |
| inline void SetCacheId( long nCacheId ){ mnCacheId = nCacheId; } |
| // End Comments |
| const ScDPDimensionSaveData* GetExistingDimensionData() const { return pDimensionData; } |
| SC_DLLPUBLIC ScDPDimensionSaveData* GetDimensionData(); // create if not there |
| void SetDimensionData( const ScDPDimensionSaveData* pNew ); // copied |
| void BuildAllDimensionMembers(ScDPTableData* pData); |
| void BuildAllDimensionMembersFromSource(ScDPObject* pDPObj); |
| |
| /** |
| * Check whether a dimension has one or more invisible members. |
| * |
| * @param rDimName dimension name |
| */ |
| SC_DLLPUBLIC bool HasInvisibleMember(const ::rtl::OUString& rDimName) const; |
| }; |
| |
| |
| #endif |
| |
