chart2/source/inc/ChartTypeHelper.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 #pragma once
  21
  22 #include <config_options.h>
  23 #include <com/sun/star/drawing/Direction3D.hpp>
  24 #include "charttoolsdllapi.hxx"
  25 #include "ChartType.hxx"
  26 #include <rtl/ref.hxx>
  27
  28 namespace com::sun::star::chart2 { class XChartType; }
  29 namespace com::sun::star::chart2 { class XDataSeries; }
  30
  31 namespace chart
  32 {
  33 class ChartType;
  34 class DataSeries;
  35
  36 class UNLESS_MERGELIBS(OOO_DLLPUBLIC_CHARTTOOLS) ChartTypeHelper
  37 {
  38 public:
  39     static bool isSupportingGeometryProperties(  const rtl::Reference< ::chart::ChartType >& xChartType, sal_Int32 nDimensionCount );
  40     static bool isSupportingStatisticProperties( const rtl::Reference< ::chart::ChartType >& xChartType, sal_Int32 nDimensionCount );
  41     static bool isSupportingRegressionProperties(const rtl::Reference< ::chart::ChartType >& xChartType, sal_Int32 nDimensionCount );
  42     static bool isSupportingMainAxis(            const rtl::Reference< ::chart::ChartType >& xChartType, sal_Int32 nDimensionCount, sal_Int32 nDimensionIndex );
  43     static bool isSupportingSecondaryAxis(       const rtl::Reference< ::chart::ChartType >& xChartType, sal_Int32 nDimensionCount );
  44     static bool isSupportingAreaProperties(      const rtl::Reference< ::chart::ChartType >& xChartType, sal_Int32 nDimensionCount );
  45     static bool isSupportingSymbolProperties(    const rtl::Reference< ::chart::ChartType >& xChartType, sal_Int32 nDimensionCount );
  46     static bool isSupportingOverlapAndGapWidthProperties( const rtl::Reference< ::chart::ChartType >& xChartType, sal_Int32 nDimensionCount );
  47     static bool isSupportingBarConnectors(       const rtl::Reference< ::chart::ChartType >& xChartType, sal_Int32 nDimensionCount );
  48     static bool isSupportingRightAngledAxes(     const rtl::Reference< ::chart::ChartType >& xChartType );
  49     static bool isSupportingAxisSideBySide(      const rtl::Reference< ::chart::ChartType >& xChartType, sal_Int32 nDimensionCount );
  50     static bool isSupportingStartingAngle(       const rtl::Reference< ::chart::ChartType >& xChartType );
  51     //starting value for bars or baseline for areas for example
  52     static bool isSupportingBaseValue(           const rtl::Reference< ::chart::ChartType >& xChartType );
  53     static bool isSupportingAxisPositioning(     const rtl::Reference< ::chart::ChartType >& xChartType, sal_Int32 nDimensionCount, sal_Int32 nDimensionIndex );
  54     static bool isSupportingDateAxis( const rtl::Reference< ::chart::ChartType >& xChartType, sal_Int32 nDimensionIndex );
  55     static bool isSupportingComplexCategory( const rtl::Reference< ::chart::ChartType >& xChartType );
  56     static bool isSupportingCategoryPositioning( const rtl::Reference< ::chart::ChartType >& xChartType, sal_Int32 nDimensionCount );
  57     static bool shiftCategoryPosAtXAxisPerDefault(     const rtl::Reference< ::chart::ChartType >& xChartType );
  58
  59     //returns sequence of css::chart::DataLabelPlacement
  60     static css::uno::Sequence < sal_Int32 > getSupportedLabelPlacements(
  61         const rtl::Reference< ::chart::ChartType >& xChartType, bool bSwapXAndY
  62         , const rtl::Reference< ::chart::DataSeries >& xSeries );
  63
  64     //returns sequence of css::chart::MissingValueTreatment
  65     static css::uno::Sequence < sal_Int32 > getSupportedMissingValueTreatments(
  66         const rtl::Reference< ::chart::ChartType >& xChartType );
  67
  68     SAL_DLLPRIVATE static css::drawing::Direction3D getDefaultSimpleLightDirection( const rtl::Reference< ::chart::ChartType >& xChartType );
  69     SAL_DLLPRIVATE static css::drawing::Direction3D getDefaultRealisticLightDirection( const rtl::Reference< ::chart::ChartType >& xChartType );
  70     SAL_DLLPRIVATE static sal_Int32 getDefaultDirectLightColor( bool bSimple, const rtl::Reference< ::chart::ChartType >& xChartType );
  71     SAL_DLLPRIVATE static sal_Int32 getDefaultAmbientLightColor( bool bSimple, const rtl::Reference< ::chart::ChartType >& xChartType );
  72     static sal_Int32 getNumberOfDisplayedSeries( const rtl::Reference< ::chart::ChartType >& xChartType, sal_Int32 nNumberOfSeries );
  73     SAL_DLLPRIVATE static bool noBordersForSimpleScheme( const rtl::Reference< ::chart::ChartType >& xChartType );
  74
  75     static bool isSeriesInFrontOfAxisLine( const rtl::Reference< ::chart::ChartType >& xChartType );
  76
  77     static sal_Int32 //one of css::chart2::AxisType
  78                     getAxisType( const rtl::Reference< ::chart::ChartType >& xChartType
  79                                 , sal_Int32 nDimensionIndex );
  80
  81     static OUString getRoleOfSequenceForYAxisNumberFormatDetection( const rtl::Reference<
  82         ::chart::ChartType >& xChartType );
  83
  84     static OUString getRoleOfSequenceForDataLabelNumberFormatDetection( const rtl::Reference<
  85         ::chart::ChartType >& xChartType );
  86
  87     static bool isSupportingOnlyDeepStackingFor3D( const rtl::Reference< ::chart::ChartType >& xChartType );
  88 };
  89
  90 } //namespace chart
  91
  92 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */