office-gobmx/sc/inc/dpshttab.hxx
Noel Grandin 0eeb12b424 reduce symbol visibility in sc
Change-Id: I7a1c7dbe61e302584b977fdf202d041d987d0833
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/166777
Reviewed-by: Noel Grandin <noel.grandin@collabora.co.uk>
Tested-by: Jenkins
2024-04-27 20:12:31 +02:00

123 lines
4.7 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* 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 .
*/
#pragma once
#include "dptabdat.hxx"
#include "address.hxx"
#include "scdllapi.h"
#include "queryparam.hxx"
#include <unotools/resmgr.hxx>
#include <unordered_set>
#include <vector>
class ScDPDimensionSaveData;
/**
* This class contains authoritative information on the internal reference
* used as the data source for datapilot table. <i>The range name takes
* precedence over the source range when it's non-empty.</i> When the range
* name is empty, the source range gets used.
*/
class ScSheetSourceDesc
{
public:
ScSheetSourceDesc() = delete;
SC_DLLPUBLIC ScSheetSourceDesc(ScDocument* pDoc);
SC_DLLPUBLIC void SetSourceRange(const ScRange& rRange);
/**
* Get the range that contains the source data. In case the source data
* is referred to via a range name, it returns the range that the range
* name points to.
*
* <i>Note that currently only a single range is supported; if the
* range name contains multiple ranges, only the first range is used.</i>
*
* @return source range.
*/
SC_DLLPUBLIC const ScRange& GetSourceRange() const;
SC_DLLPUBLIC void SetRangeName(const OUString& rName);
const OUString& GetRangeName() const { return maRangeName;}
bool HasRangeName() const;
void SetQueryParam(const ScQueryParam& rParam);
const ScQueryParam& GetQueryParam() const { return maQueryParam;}
bool operator== ( const ScSheetSourceDesc& rOther ) const;
SC_DLLPUBLIC const ScDPCache* CreateCache(const ScDPDimensionSaveData* pDimData) const;
/**
* Check the sanity of the data source range.
*
* @return nullptr if the source range is sane, otherwise an error message ID is
* returned.
*/
TranslateId CheckSourceRange() const;
private:
mutable ScRange maSourceRange;
OUString maRangeName;
ScQueryParam maQueryParam;
ScDocument* mpDoc;
};
/**
* Implementation of ScDPTableData with sheet data.
*/
class SAL_DLLPUBLIC_RTTI ScSheetDPData final : public ScDPTableData
{
private:
ScQueryParam aQuery;
bool bIgnoreEmptyRows;
bool bRepeatIfEmpty;
ScDPFilteredCache aCacheTable;
public:
SC_DLLPUBLIC ScSheetDPData(const ScDocument* pD, const ScSheetSourceDesc& rDesc, const ScDPCache& rCache);
SC_DLLPUBLIC virtual ~ScSheetDPData() override;
virtual sal_Int32 GetColumnCount() override;
virtual OUString getDimensionName(sal_Int32 nColumn) override;
virtual bool getIsDataLayoutDimension(sal_Int32 nColumn) override;
virtual bool IsDateDimension(sal_Int32 nDim) override;
virtual sal_uInt32 GetNumberFormat(sal_Int32 nDim) override;
virtual void DisposeData() override;
virtual void SetEmptyFlags( bool bIgnoreEmptyRows, bool bRepeatIfEmpty ) override;
virtual bool IsRepeatIfEmpty() override;
virtual void CreateCacheTable() override;
virtual void FilterCacheTable(std::vector<ScDPFilteredCache::Criterion>&& rCriteria, std::unordered_set<sal_Int32>&& rCatDims) override;
virtual void GetDrillDownData(std::vector<ScDPFilteredCache::Criterion>&& rCriteria,
std::unordered_set<sal_Int32>&& rCatDims,
css::uno::Sequence< css::uno::Sequence< css::uno::Any > >& rData) override;
virtual void CalcResults(CalcInfo& rInfo, bool bAutoShow) override;
virtual const ScDPFilteredCache& GetCacheTable() const override;
virtual void ReloadCacheTable() override;
#if DUMP_PIVOT_TABLE
virtual void Dump() const override;
#endif
};
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */