chart2/source/inc/AxisHelper.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 #pragma once
  20
  21 #include "charttoolsdllapi.hxx"
  22 #include <com/sun/star/chart2/ScaleData.hpp>
  23
  24 #include <vector>
  25
  26 namespace chart { class ChartModel; }
  27 namespace chart { class ExplicitCategoriesProvider; }
  28 namespace chart { class ReferenceSizeProvider; }
  29 namespace com::sun::star::beans { class XPropertySet; }
  30 namespace com::sun::star::chart2 { class XAxis; }
  31 namespace com::sun::star::chart2 { class XChartDocument; }
  32 namespace com::sun::star::chart2 { class XChartType; }
  33 namespace com::sun::star::chart2 { class XCoordinateSystem; }
  34 namespace com::sun::star::chart2 { class XDiagram; }
  35 namespace com::sun::star::chart2 { class XScaling; }
  36 namespace com::sun::star::uno { class XComponentContext; }
  37
  38 namespace chart
  39 {
  40
  41 class OOO_DLLPUBLIC_CHARTTOOLS AxisHelper
  42 {
  43 public:
  44     static css::uno::Reference< css::chart2::XScaling > createLinearScaling();
  45     static css::uno::Reference< css::chart2::XScaling > createLogarithmicScaling( double fBase = 10.0 );
  46
  47     static css::chart2::ScaleData createDefaultScale();
  48
  49     static void removeExplicitScaling( css::chart2::ScaleData& rScaleData );
  50
  51     static bool isLogarithmic( const css::uno::Reference< css::chart2::XScaling >& xScaling );
  52
  53     static void checkDateAxis( css::chart2::ScaleData& rScale, ExplicitCategoriesProvider* pExplicitCategoriesProvider, bool bChartTypeAllowsDateAxis );
  54     static css::chart2::ScaleData getDateCheckedScale( const css::uno::Reference< css::chart2::XAxis >& xAxis, ChartModel& rModel );
  55
  56     static sal_Int32 getExplicitNumberFormatKeyForAxis(
  57                   const css::uno::Reference< css::chart2::XAxis >& xAxis
  58                 , const css::uno::Reference< css::chart2::XCoordinateSystem >& xCorrespondingCoordinateSystem
  59                 , const css::uno::Reference< css::chart2::XChartDocument>& xChartDoc
  60                 , bool bSearchForParallelAxisIfNothingIsFound );
  61
  62     static css::uno::Reference<
  63            css::chart2::XAxis >
  64         createAxis( sal_Int32 nDimensionIndex, bool bMainAxis
  65                 , const css::uno::Reference< css::chart2::XDiagram >& xDiagram
  66                 , const css::uno::Reference< css::uno::XComponentContext >& xContext
  67                 , ReferenceSizeProvider * pRefSizeProvider = nullptr );
  68
  69     static css::uno::Reference< css::chart2::XAxis >
  70         createAxis(
  71             sal_Int32 nDimensionIndex
  72             , sal_Int32 nAxisIndex // 0==main or 1==secondary axis
  73             , const css::uno::Reference< css::chart2::XCoordinateSystem >& xCooSys
  74             , const css::uno::Reference< css::uno::XComponentContext > & xContext
  75             , ReferenceSizeProvider * pRefSizeProvider = nullptr );
  76
  77     static void showAxis( sal_Int32 nDimensionIndex, bool bMainAxis
  78                 , const css::uno::Reference< css::chart2::XDiagram >& xDiagram
  79                 , const css::uno::Reference< css::uno::XComponentContext >& xContext
  80                 , ReferenceSizeProvider * pRefSizeProvider = nullptr );
  81
  82     static void showGrid( sal_Int32 nDimensionIndex, sal_Int32 nCooSysIndex, bool bMainGrid
  83                 , const css::uno::Reference< css::chart2::XDiagram >& xDiagram );
  84
  85     static void hideAxis( sal_Int32 nDimensionIndex, bool bMainAxis
  86                 , const css::uno::Reference< css::chart2::XDiagram >& xDiagram );
  87     static void hideGrid( sal_Int32 nDimensionIndex, sal_Int32 nCooSysIndex, bool bMainGrid
  88                 , const css::uno::Reference< css::chart2::XDiagram >& xDiagram );
  89
  90     static bool isAxisShown( sal_Int32 nDimensionIndex, bool bMainAxis
  91                 , const css::uno::Reference< css::chart2::XDiagram >& xDiagram );
  92     static bool isGridShown( sal_Int32 nDimensionIndex, sal_Int32 nCooSysIndex, bool bMainGrid
  93                 , const css::uno::Reference< css::chart2::XDiagram >& xDiagram );
  94
  95     static void makeAxisVisible( const css::uno::Reference< css::chart2::XAxis >& xAxis );
  96     static void makeGridVisible( const css::uno::Reference< css::beans::XPropertySet >& xGridProperties );
  97
  98     static void makeAxisInvisible( const css::uno::Reference< css::chart2::XAxis >& xAxis );
  99     static void makeGridInvisible( const css::uno::Reference< css::beans::XPropertySet >& xGridProperties );
 100
 101     static void hideAxisIfNoDataIsAttached( const css::uno::Reference< css::chart2::XAxis >& xAxis
 102                                           , const css::uno::Reference< css::chart2::XDiagram >& xDiagram);
 103
 104     SAL_DLLPRIVATE static bool areAxisLabelsVisible( const css::uno::Reference< css::beans::XPropertySet >& xAxisProperties );
 105     static bool isAxisVisible( const css::uno::Reference< css::chart2::XAxis >& xAxis );
 106     static bool isGridVisible( const css::uno::Reference< css::beans::XPropertySet >& xGridProperties );
 107
 108     static css::uno::Reference< css::chart2::XCoordinateSystem >
 109         getCoordinateSystemByIndex(
 110             const css::uno::Reference< css::chart2::XDiagram >& xDiagram
 111             , sal_Int32 nIndex );
 112
 113     static css::uno::Reference< css::chart2::XCoordinateSystem >
 114         getCoordinateSystemOfAxis(
 115               const css::uno::Reference< css::chart2::XAxis >& xAxis
 116             , const css::uno::Reference< css::chart2::XDiagram >& xDiagram );
 117
 118     static css::uno::Reference< css::chart2::XAxis >
 119         getAxis( sal_Int32 nDimensionIndex, bool bMainAxis
 120                 , const css::uno::Reference< css::chart2::XDiagram >& xDiagram );
 121     static css::uno::Reference< css::chart2::XAxis >
 122         getAxis( sal_Int32 nDimensionIndex, sal_Int32 nAxisIndex
 123             , const css::uno::Reference< css::chart2::XCoordinateSystem >& xCooSys );
 124
 125     static css::uno::Reference< css::chart2::XAxis >
 126         getCrossingMainAxis( const css::uno::Reference< css::chart2::XAxis >& xAxis
 127             , const css::uno::Reference< css::chart2::XCoordinateSystem >& xCooSys );
 128
 129     static css::uno::Reference< css::chart2::XAxis >
 130         getParallelAxis( const css::uno::Reference< css::chart2::XAxis >& xAxis
 131             , const css::uno::Reference< css::chart2::XDiagram >& xDiagram );
 132
 133     static css::uno::Reference< css::beans::XPropertySet >
 134         getGridProperties( const css::uno::Reference< css::chart2::XCoordinateSystem >& xCooSys
 135                 , sal_Int32 nDimensionIndex
 136                 , sal_Int32 nAxisIndex //0: Primary axis, 1: secondary axis
 137                 , sal_Int32 nSubGridIndex //-1: Main Grid; 0: First SubGrid etc
 138                 );
 139
 140     static sal_Int32 getDimensionIndexOfAxis(
 141               const css::uno::Reference< css::chart2::XAxis >& xAxis
 142             , const css::uno::Reference< css::chart2::XDiagram >& xDiagram );
 143
 144     static bool getIndicesForAxis(
 145               const css::uno::Reference< css::chart2::XAxis >& xAxis
 146             , const css::uno::Reference< css::chart2::XCoordinateSystem >& xCooSys
 147             , sal_Int32& rOutDimensionIndex, sal_Int32& rOutAxisIndex );
 148
 149     static bool getIndicesForAxis(
 150               const css::uno::Reference< css::chart2::XAxis >& xAxis
 151             , const css::uno::Reference< css::chart2::XDiagram >& xDiagram
 152             , sal_Int32& rOutCooSysIndex, sal_Int32& rOutDimensionIndex, sal_Int32& rOutAxisIndex );
 153
 154     /** @param bOnlyVisible if </TRUE>, only axes with property "Show" set to
 155                </sal_True> are returned
 156      */
 157     static css::uno::Sequence< css::uno::Reference< css::chart2::XAxis > >
 158             getAllAxesOfDiagram( const css::uno::Reference< css::chart2::XDiagram >& xDiagram
 159             , bool bOnlyVisible = false );
 160
 161     /** @param bOnlyVisible if </TRUE>, only axes with property "Show" set to
 162                </sal_True> are returned
 163      */
 164     SAL_DLLPRIVATE static std::vector< css::uno::Reference< css::chart2::XAxis > >
 165             getAllAxesOfCoordinateSystem( const css::uno::Reference< css::chart2::XCoordinateSystem >& xCooSys
 166             , bool bOnlyVisible = false );
 167
 168     static css::uno::Sequence< css::uno::Reference< css::beans::XPropertySet > >
 169             getAllGrids( const css::uno::Reference< css::chart2::XDiagram >& xDiagram );
 170
 171     static void getAxisOrGridPossibilities( css::uno::Sequence< sal_Bool >& rPossibilityList
 172         , const css::uno::Reference< css::chart2::XDiagram>& xDiagram, bool bAxis=true );
 173
 174     static void getAxisOrGridExistence( css::uno::Sequence< sal_Bool >& rExistenceList
 175         , const css::uno::Reference< css::chart2::XDiagram>& xDiagram, bool bAxis=true );
 176
 177     static bool changeVisibilityOfGrids( const css::uno::Reference< css::chart2::XDiagram>& xDiagram
 178                         , const css::uno::Sequence< sal_Bool >& rOldExistenceList
 179                         , const css::uno::Sequence< sal_Bool >& rNewExistenceList );
 180
 181     static bool changeVisibilityOfAxes( const css::uno::Reference< css::chart2::XDiagram>& xDiagram
 182                         , const css::uno::Sequence< sal_Bool >& rOldExistenceList
 183                         , const css::uno::Sequence< sal_Bool >& rNewExistenceList
 184                         , const css::uno::Reference< css::uno::XComponentContext >& xContext
 185                         , ReferenceSizeProvider * pRefSizeProvider );
 186
 187     static bool shouldAxisBeDisplayed( const css::uno::Reference< css::chart2::XAxis >& xAxis
 188                                        , const css::uno::Reference< css::chart2::XCoordinateSystem >& xCooSys );
 189     static bool isSecondaryYAxisNeeded( const css::uno::Reference<
 190                     css::chart2::XCoordinateSystem >& xCooSys );
 191
 192     static css::uno::Reference< css::chart2::XChartType >
 193         getChartTypeByIndex( const css::uno::Reference< css::chart2::XCoordinateSystem >& xCooSys,
 194                              sal_Int32 nIndex );
 195
 196     static void setRTLAxisLayout( const css::uno::Reference< css::chart2::XCoordinateSystem >& xCooSys );
 197
 198     static css::uno::Reference< css::chart2::XChartType >
 199         getFirstChartTypeWithSeriesAttachedToAxisIndex( const css::uno::Reference< css::chart2::XDiagram >& xDiagram, const sal_Int32 nAttachedAxisIndex );
 200
 201     static bool isAxisPositioningEnabled();
 202 };
 203
 204 } //namespace chart
 205
 206 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */