include/oox/drawingml/chart/chartconverter.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 #ifndef INCLUDED_OOX_DRAWINGML_CHART_CHARTCONVERTER_HXX
  21 #define INCLUDED_OOX_DRAWINGML_CHART_CHARTCONVERTER_HXX
  22
  23 #include <com/sun/star/uno/Reference.hxx>
  24 #include <oox/dllapi.h>
  25 #include <rtl/ustring.hxx>
  26
  27 namespace com::sun::star {
  28     namespace awt { struct Point; }
  29     namespace awt { struct Size; }
  30     namespace drawing { class XShapes; }
  31     namespace chart2 { class XChartDocument; }
  32     namespace chart2::data { class XDataProvider; }
  33     namespace chart2::data { class XDataSequence; }
  34 }
  35
  36 namespace oox::core { class XmlFilterBase; }
  37
  38 namespace oox::drawingml::chart {
  39
  40 struct ChartSpaceModel;
  41 struct DataSequenceModel;
  42
  43
  44 class OOX_DLLPUBLIC ChartConverter
  45 {
  46 public:
  47     explicit            ChartConverter();
  48     virtual             ~ChartConverter();
  49
  50     /** Converts the passed OOXML chart model to the passed chart2 document.
  51
  52         @param rChartModel  The filled MSOOXML chart model structure.
  53
  54         @param rxChartDoc  The UNO chart document model to be initialized.
  55
  56         @param rxExternalPage  If null, all embedded shapes will be inserted
  57             into the internal drawing page of the chart document. If not null,
  58             all embedded shapes will be inserted into this shapes collection.
  59
  60         @param rChartPos  The position of the chart shape in its drawing page,
  61             in 1/100 mm. Will be used only, if parameter rxExternalPage is not
  62             null, for correct positioning of the embedded shapes in the
  63             external drawing page.
  64
  65         @param rChartSize  The size of the chart shape in 1/100 mm. Needed for
  66             calculation of position and size of the chart elements (diagram,
  67             titles, legend, etc.) and embedded shapes.
  68      */
  69     void                convertFromModel(
  70                             ::oox::core::XmlFilterBase& rFilter,
  71                             ChartSpaceModel& rChartModel,
  72                             const css::uno::Reference< css::chart2::XChartDocument >& rxChartDoc,
  73                             const css::uno::Reference< css::drawing::XShapes >& rxExternalPage,
  74                             const css::awt::Point& rChartPos,
  75                             const css::awt::Size& rChartSize );
  76
  77     /** Creates an internal data provider. Derived classes may override this
  78         function to create an external data provider. */
  79     virtual void        createDataProvider(
  80                             const css::uno::Reference< css::chart2::XChartDocument >& rxChartDoc );
  81
  82     /** Creates a data sequence from a formula. Dummy implementation. Derived
  83         classes have to override this function to actually parse the formula. */
  84     virtual css::uno::Reference<css::chart2::data::XDataSequence>
  85         createDataSequence(
  86             const css::uno::Reference<css::chart2::data::XDataProvider>& rxDataProvider,
  87             const DataSequenceModel& rDataSeq, const OUString& rRole,
  88             const OUString& aRoleQualifier );
  89
  90 private:
  91                         ChartConverter( const ChartConverter& ) = delete;
  92     ChartConverter&     operator=( const ChartConverter& ) = delete;
  93 };
  94
  95
  96 } // namespace oox::drawingml::chart
  97
  98 #endif
  99
 100 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */