chart2/source/view/inc/LegendEntryProvider.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 INCLUDED_CHART2_SOURCE_VIEW_INC_LEGENDENTRYPROVIDER_HXX
  20 #define INCLUDED_CHART2_SOURCE_VIEW_INC_LEGENDENTRYPROVIDER_HXX
  21
  22 #include <com/sun/star/beans/XPropertySet.hpp>
  23 #include <com/sun/star/chart/ChartLegendExpansion.hpp>
  24 #include <com/sun/star/chart2/XFormattedString2.hpp>
  25 #include <com/sun/star/drawing/XShape.hpp>
  26 #include <com/sun/star/drawing/XShapes.hpp>
  27 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  28 #include <com/sun/star/uno/XComponentContext.hpp>
  29
  30 #include <vector>
  31
  32 namespace chart
  33 {
  34
  35 enum LegendSymbolStyle
  36 {
  37     /** A square box with border.
  38      */
  39     LegendSymbolStyle_BOX,
  40
  41     /** A line like with a symbol.
  42      */
  43     LegendSymbolStyle_LINE,
  44
  45     /** A bordered circle which has the same bounding-box as the
  46         <member>BOX</member>.
  47      */
  48     LegendSymbolStyle_CIRCLE
  49 };
  50
  51 struct ViewLegendEntry
  52 {
  53     /** The legend symbol that represents a data series or other
  54         information contained in the legend
  55      */
  56     ::com::sun::star::uno::Reference<
  57         ::com::sun::star::drawing::XShape > aSymbol;
  58
  59     /** The descriptive text for a legend entry.
  60      */
  61     ::com::sun::star::uno::Sequence<
  62         ::com::sun::star::uno::Reference<
  63             ::com::sun::star::chart2::XFormattedString2 > >  aLabel;
  64 };
  65
  66 class LegendEntryProvider
  67 {
  68 public:
  69     virtual ::com::sun::star::awt::Size getPreferredLegendKeyAspectRatio()=0;
  70
  71     virtual std::vector< ViewLegendEntry > createLegendEntries(
  72             const ::com::sun::star::awt::Size& rEntryKeyAspectRatio,
  73             ::com::sun::star::chart::ChartLegendExpansion eLegendExpansion,
  74             const ::com::sun::star::uno::Reference<
  75                 ::com::sun::star::beans::XPropertySet >& xTextProperties,
  76             const ::com::sun::star::uno::Reference<
  77                 ::com::sun::star::drawing::XShapes >& xTarget,
  78             const ::com::sun::star::uno::Reference<
  79                 ::com::sun::star::lang::XMultiServiceFactory >& xShapeFactory,
  80             const ::com::sun::star::uno::Reference<
  81                 ::com::sun::star::uno::XComponentContext >& xContext
  82                 ) = 0;
  83
  84 protected:
  85     ~LegendEntryProvider() {}
  86 };
  87
  88 } //  namespace chart
  89
  90 // INCLUDED_CHART2_SOURCE_VIEW_INC_LEGENDENTRYPROVIDER_HXX
  91 #endif
  92
  93 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */