chart2/source/inc/DiagramHelper.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef CHART2_DIAGRAMHELPER_HXX
  29 #define CHART2_DIAGRAMHELPER_HXX
  30
  31 #include "StackMode.hxx"
  32 #include "charttoolsdllapi.hxx"
  33 #include <com/sun/star/chart2/XAxis.hpp>
  34 #include <com/sun/star/chart2/XDiagram.hpp>
  35 #include <com/sun/star/chart2/XChartTypeTemplate.hpp>
  36 #include <com/sun/star/chart2/XCoordinateSystem.hpp>
  37 #include <com/sun/star/chart2/InterpretedData.hpp>
  38 #include <com/sun/star/chart2/StackingDirection.hpp>
  39 #include <com/sun/star/chart2/XChartDocument.hpp>
  40 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  41 #include <com/sun/star/uno/XComponentContext.hpp>
  42 #include <com/sun/star/util/XNumberFormats.hpp>
  43 #include <com/sun/star/util/XNumberFormatsSupplier.hpp>
  44
  45 #include <utility>
  46 #include <vector>
  47
  48
  49 namespace chart
  50 {
  51
  52 enum DiagramPositioningMode
  53 {
  54     DiagramPositioningMode_AUTO,
  55     DiagramPositioningMode_EXCLUDING,
  56     DiagramPositioningMode_INCLUDING
  57 };
  58
  59 class OOO_DLLPUBLIC_CHARTTOOLS DiagramHelper
  60 {
  61 public:
  62     typedef ::std::pair<
  63             ::com::sun::star::uno::Reference<
  64                 ::com::sun::star::chart2::XChartTypeTemplate >,
  65             ::rtl::OUString >
  66         tTemplateWithServiceName;
  67
  68     /** tries to find a template in the chart-type manager that matches the
  69         given diagram.
  70
  71         @param rPreferredTemplateName
  72             Check this template first.  This may speed up searching, if the
  73             caller assumes a certain template as most likely to be the one that
  74             matches.
  75
  76         @return
  77             A pair containing a template with the correct properties set as
  78             first entry and the service name of the templateas second entry.  If
  79             no template was found both elements are empty.
  80      */
  81     static tTemplateWithServiceName
  82         getTemplateForDiagram(
  83             const ::com::sun::star::uno::Reference<
  84                 ::com::sun::star::chart2::XDiagram > & xDiagram,
  85             const ::com::sun::star::uno::Reference<
  86                 ::com::sun::star::lang::XMultiServiceFactory > & xChartTypeManager,
  87             const ::rtl::OUString & rPreferredTemplateName = ::rtl::OUString());
  88
  89     /** Sets the "SwapXAndYAxis" property at all coordinate systems found in the
  90         given diagram.
  91
  92         "vertical==true" for bar charts, "vertical==false" for column charts
  93      */
  94     static void setVertical( const ::com::sun::star::uno::Reference<
  95                                  ::com::sun::star::chart2::XDiagram > & xDiagram,
  96                              bool bVertical = true );
  97
  98     /** Gets the "SwapXAndYAxis" property at all coordinate systems found in the
  99         given diagram.
 100
 101         "vertical==true" for bar charts, "vertical==false" for column charts
 102     */
 103     static bool getVertical( const ::com::sun::star::uno::Reference<
 104                                  ::com::sun::star::chart2::XDiagram > & xDiagram,
 105                              bool& rbOutFoundResult, bool& rbOutAmbiguousResult );
 106
 107     static StackMode getStackMode(
 108         const ::com::sun::star::uno::Reference<
 109             ::com::sun::star::chart2::XDiagram > & xDiagram,
 110         bool& rbFound, bool& rbAmbiguous
 111         );
 112
 113     /** @param bOnlyAtFirstChartType
 114             If </sal_True>, the stacking mode is only set at the series found inside
 115             the first chart type.  This is the standard for all current
 116             templates (the only template that has more than one chart-type and
 117             allows stacking is bar/line combi, and for this the stacking only
 118             applies to the first chart type/the bars)
 119      */
 120     static void setStackMode(
 121         const ::com::sun::star::uno::Reference<
 122             ::com::sun::star::chart2::XDiagram > & xDiagram,
 123         StackMode eStackMode,
 124         bool bOnlyAtFirstChartType = true
 125         );
 126
 127     /** Retrieves the stackmode of the first DataSeries or none. If the series have differing stack
 128         modes, rbAmbiguous is set to true. If no series is there rbFound is set to false.
 129
 130         @param xCorrespondingCoordinateSystem
 131             The coordinate system in which the given chart type xChartType is
 132             located.  (This is needed for determining percent stacking.  If
 133             omitted, the result will just indicate "not stacked", "stacked" or
 134             "ambiguous")
 135      */
 136     static StackMode getStackModeFromChartType(
 137         const ::com::sun::star::uno::Reference<
 138             ::com::sun::star::chart2::XChartType > & xChartType,
 139         bool& rbFound, bool& rbAmbiguous,
 140         const ::com::sun::star::uno::Reference<
 141             ::com::sun::star::chart2::XCoordinateSystem > & xCorrespondingCoordinateSystem =
 142                 ::com::sun::star::uno::Reference< ::com::sun::star::chart2::XCoordinateSystem >()
 143         );
 144
 145     /** Returns the dimension found for all chart types in the tree.  If the
 146         dimension is not unique, 0 is returned.
 147      */
 148     static sal_Int32 getDimension(
 149         const ::com::sun::star::uno::Reference<
 150             ::com::sun::star::chart2::XDiagram > & xDiagram );
 151
 152     /** Sets the dimension of the diagram given.
 153
 154         1. Sets the dimension of all used ChartTypes
 155         2. Adapts the DataSeriesTree to reflect the new dimension
 156         3. If new coordinate-systems have to be created, adapts the
 157            XCoordinateSystemContainer of the diagram.
 158      */
 159     static void setDimension(
 160         const ::com::sun::star::uno::Reference<
 161             ::com::sun::star::chart2::XDiagram > & xDiagram,
 162         sal_Int32 nNewDimensionCount );
 163
 164     /** Replaces all occurrences of xCooSysToReplace in the tree with
 165         xReplacement in the diagram's tree
 166      */
 167     SAL_DLLPRIVATE static void replaceCoordinateSystem(
 168         const ::com::sun::star::uno::Reference<
 169             ::com::sun::star::chart2::XDiagram > & xDiagram,
 170         const ::com::sun::star::uno::Reference<
 171             ::com::sun::star::chart2::XCoordinateSystem > & xCooSysToReplace,
 172         const ::com::sun::star::uno::Reference<
 173             ::com::sun::star::chart2::XCoordinateSystem > & xReplacement );
 174
 175     static bool isSeriesAttachedToMainAxis(
 176         const ::com::sun::star::uno::Reference<
 177             ::com::sun::star::chart2::XDataSeries >& xDataSeries );
 178
 179     static bool attachSeriesToAxis( bool bMainAxis,
 180         const ::com::sun::star::uno::Reference<
 181             ::com::sun::star::chart2::XDataSeries >& xSeries,
 182         const ::com::sun::star::uno::Reference<
 183             ::com::sun::star::chart2::XDiagram >& xDiagram,
 184         const ::com::sun::star::uno::Reference<
 185             ::com::sun::star::uno::XComponentContext > & xContext,
 186         bool bAdaptAxes=true );
 187
 188     static ::com::sun::star::uno::Reference<
 189             ::com::sun::star::chart2::XAxis > getAttachedAxis(
 190         const ::com::sun::star::uno::Reference<
 191             ::com::sun::star::chart2::XDataSeries >& xSeries,
 192         const ::com::sun::star::uno::Reference<
 193             ::com::sun::star::chart2::XDiagram >& xDiagram );
 194
 195     static ::com::sun::star::uno::Reference<
 196             ::com::sun::star::chart2::XChartType >
 197         getChartTypeOfSeries(
 198             const ::com::sun::star::uno::Reference<
 199                 ::com::sun::star::chart2::XDiagram >& xDiagram,
 200             const ::com::sun::star::uno::Reference<
 201                 ::com::sun::star::chart2::XDataSeries >& xSeries );
 202
 203     static ::std::vector<
 204             ::com::sun::star::uno::Reference<
 205             ::com::sun::star::chart2::XDataSeries > >
 206         getDataSeriesFromDiagram(
 207             const ::com::sun::star::uno::Reference<
 208             ::com::sun::star::chart2::XDiagram > & xDiagram );
 209
 210     /** return all data series in this diagram grouped by chart-types
 211      */
 212     static ::com::sun::star::uno::Sequence<
 213                ::com::sun::star::uno::Sequence<
 214                    ::com::sun::star::uno::Reference< ::com::sun::star::chart2::XDataSeries > > >
 215         getDataSeriesGroups(
 216             const ::com::sun::star::uno::Reference<
 217             ::com::sun::star::chart2::XDiagram > & xDiagram );
 218
 219     static bool isCategoryDiagram(
 220             const ::com::sun::star::uno::Reference<
 221                 ::com::sun::star::chart2::XDiagram >& xDiagram );
 222
 223     static void setCategoriesToDiagram(
 224             const ::com::sun::star::uno::Reference<
 225                 ::com::sun::star::chart2::data::XLabeledDataSequence >& xCategories,
 226             const ::com::sun::star::uno::Reference<
 227                 ::com::sun::star::chart2::XDiagram >& xDiagram,
 228             bool bSetAxisType = false, // when this flag is true ...
 229             bool bCategoryAxis = true);// set the AxisType to CATEGORY or back to REALNUMBER
 230
 231     static ::com::sun::star::uno::Reference< ::com::sun::star::chart2::data::XLabeledDataSequence >
 232         getCategoriesFromDiagram(
 233             const ::com::sun::star::uno::Reference<
 234                 ::com::sun::star::chart2::XDiagram > & xDiagram );
 235
 236     static ::com::sun::star::uno::Sequence< rtl::OUString >
 237         getExplicitSimpleCategories(
 238             const ::com::sun::star::uno::Reference<
 239                 ::com::sun::star::chart2::XChartDocument > & xChartDoc );
 240
 241     SAL_DLLPRIVATE static ::com::sun::star::uno::Sequence< rtl::OUString >
 242         generateAutomaticCategoriesFromCooSys(
 243             const ::com::sun::star::uno::Reference<
 244                 ::com::sun::star::chart2::XCoordinateSystem > & xCooSys );
 245
 246     static void switchToDateCategories(
 247         const ::com::sun::star::uno::Reference<
 248                 ::com::sun::star::chart2::XChartDocument > & xChartDoc );
 249
 250     static void switchToTextCategories(
 251         const ::com::sun::star::uno::Reference<
 252                 ::com::sun::star::chart2::XChartDocument > & xChartDoc );
 253
 254     static bool isSupportingDateAxis( const ::com::sun::star::uno::Reference< ::com::sun::star::chart2::XDiagram >& xDiagram );
 255     static bool isDateNumberFormat( sal_Int32 nNumberFormat, const ::com::sun::star::uno::Reference< ::com::sun::star::util::XNumberFormats >& xNumberFormats );
 256     static sal_Int32 getDateNumberFormat( const ::com::sun::star::uno::Reference< ::com::sun::star::util::XNumberFormatsSupplier >& xNumberFormatsSupplier );
 257
 258     static sal_Int32 getPercentNumberFormat( const ::com::sun::star::uno::Reference<
 259                 ::com::sun::star::util::XNumberFormatsSupplier >& xNumberFormatsSupplier );
 260
 261     static ::com::sun::star::uno::Reference<
 262             ::com::sun::star::chart2::XChartType >
 263         getChartTypeByIndex( const ::com::sun::star::uno::Reference<
 264             ::com::sun::star::chart2::XDiagram >& xDiagram, sal_Int32 nIndex );
 265
 266     static ::com::sun::star::uno::Sequence<
 267             ::com::sun::star::uno::Reference<
 268                 ::com::sun::star::chart2::XChartType > >
 269         getChartTypesFromDiagram(
 270             const ::com::sun::star::uno::Reference<
 271                 ::com::sun::star::chart2::XDiagram > & xDiagram );
 272
 273     SAL_DLLPRIVATE static bool areChartTypesCompatible( const ::com::sun::star::uno::Reference<
 274                 ::com::sun::star::chart2::XChartType >& xFirstType,
 275                 const ::com::sun::star::uno::Reference<
 276                 ::com::sun::star::chart2::XChartType >& xSecondType );
 277
 278
 279     /**
 280         * Test if a series can be moved.
 281         *
 282         * @param xDiagram
 283         *  Reference to the diagram that contains the series.
 284         *
 285         * @param xGivenDataSeries
 286         *  Reference to the series that should be tested for moving.
 287         *
 288         * @param bForward
 289         *  Direction of the move to be checked.
 290         *
 291         * @returns </sal_True> if the series can be moved.
 292         *
 293         */
 294     static bool isSeriesMoveable(
 295             const ::com::sun::star::uno::Reference<
 296                 ::com::sun::star::chart2::XDiagram >& xDiagram,
 297             const ::com::sun::star::uno::Reference<
 298         ::com::sun::star::chart2::XDataSeries >& xGivenDataSeries,
 299             bool bForward );
 300
 301     /**
 302         * Move a series forward or backward.
 303         *
 304         * @param xDiagram
 305         *  Reference to the diagram that contains the series.
 306         *
 307         * @param xGivenDataSeries
 308         *  Reference to the series that should be moved.
 309         *
 310         * @param bForward
 311         *  Direction in which the series should be moved.
 312         *
 313         * @returns </sal_True> if the series was moved successfully.
 314         *
 315         */
 316     static bool moveSeries(
 317                 const ::com::sun::star::uno::Reference<
 318                   ::com::sun::star::chart2::XDiagram >& xDiagram,
 319                 const ::com::sun::star::uno::Reference<
 320           ::com::sun::star::chart2::XDataSeries >& xGivenDataSeries,
 321                 bool bForward );
 322
 323     static bool isSupportingFloorAndWall( const ::com::sun::star::uno::Reference<
 324                 ::com::sun::star::chart2::XDiagram > & xDiagram );
 325
 326     static bool isPieOrDonutChart( const ::com::sun::star::uno::Reference<
 327                 ::com::sun::star::chart2::XDiagram >& xDiagram );
 328
 329     static sal_Int32 getGeometry3D(
 330         const ::com::sun::star::uno::Reference<
 331             ::com::sun::star::chart2::XDiagram > & xDiagram,
 332         bool& rbFound, bool& rbAmbiguous );
 333
 334     static void setGeometry3D(
 335         const ::com::sun::star::uno::Reference<
 336             ::com::sun::star::chart2::XDiagram > & xDiagram,
 337         sal_Int32 nNewGeometry );
 338
 339     //returns integer from constant group ::com::sun::star::chart::MissingValueTreatment
 340     static sal_Int32 getCorrectedMissingValueTreatment(
 341             const ::com::sun::star::uno::Reference<
 342                 ::com::sun::star::chart2::XDiagram > & xDiagram,
 343             const ::com::sun::star::uno::Reference<
 344                 ::com::sun::star::chart2::XChartType >& xChartType );
 345
 346     static DiagramPositioningMode getDiagramPositioningMode( const ::com::sun::star::uno::Reference<
 347                 ::com::sun::star::chart2::XDiagram > & xDiagram );
 348
 349     static bool setDiagramPositioning( const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModel >& xChartModel,
 350         const ::com::sun::star::awt::Rectangle& rPosRect /*100th mm*/ );
 351
 352     static ::com::sun::star::awt::Rectangle getDiagramRectangleFromModel( const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModel >& xChartModel );
 353
 354     static bool switchDiagramPositioningToExcludingPositioning( const ::com::sun::star::uno::Reference<
 355         ::com::sun::star::frame::XModel >& xChartModel
 356         , bool bResetModifiedState //set model back to unchanged if it was unchanged before
 357         , bool bConvertAlsoFromAutoPositioning );
 358
 359 private:
 360     // not implemented
 361     DiagramHelper();
 362
 363 };
 364
 365 } //  namespace chart
 366
 367 // CHART2_DIAGRAMHELPER_HXX
 368 #endif
 369
 370 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */