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