xref: /AOO41X/main/chart2/source/view/inc/LegendEntryProvider.hxx (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
1*cdf0e10cSrcweir /*************************************************************************
2*cdf0e10cSrcweir  *
3*cdf0e10cSrcweir  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir  *
5*cdf0e10cSrcweir  * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir  *
7*cdf0e10cSrcweir  * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir  *
9*cdf0e10cSrcweir  * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir  *
11*cdf0e10cSrcweir  * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir  * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir  * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir  *
15*cdf0e10cSrcweir  * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir  * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir  * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir  *
21*cdf0e10cSrcweir  * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir  * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir  * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir  * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir  *
26*cdf0e10cSrcweir  ************************************************************************/
27*cdf0e10cSrcweir #ifndef CHART2_VIEW_LEGENDENTRYPROVIDER_HXX
28*cdf0e10cSrcweir #define CHART2_VIEW_LEGENDENTRYPROVIDER_HXX
29*cdf0e10cSrcweir 
30*cdf0e10cSrcweir #include <com/sun/star/beans/XPropertySet.hpp>
31*cdf0e10cSrcweir #include <com/sun/star/chart/ChartLegendExpansion.hpp>
32*cdf0e10cSrcweir #include <com/sun/star/chart2/XFormattedString.hpp>
33*cdf0e10cSrcweir #include <com/sun/star/drawing/XShape.hpp>
34*cdf0e10cSrcweir #include <com/sun/star/drawing/XShapes.hpp>
35*cdf0e10cSrcweir #include <com/sun/star/lang/XMultiServiceFactory.hpp>
36*cdf0e10cSrcweir #include <com/sun/star/uno/XComponentContext.hpp>
37*cdf0e10cSrcweir 
38*cdf0e10cSrcweir #include <vector>
39*cdf0e10cSrcweir 
40*cdf0e10cSrcweir namespace chart
41*cdf0e10cSrcweir {
42*cdf0e10cSrcweir 
43*cdf0e10cSrcweir enum LegendSymbolStyle
44*cdf0e10cSrcweir {
45*cdf0e10cSrcweir     /** A square box with border.
46*cdf0e10cSrcweir      */
47*cdf0e10cSrcweir     LegendSymbolStyle_BOX,
48*cdf0e10cSrcweir 
49*cdf0e10cSrcweir     /** A line like with a symbol.
50*cdf0e10cSrcweir      */
51*cdf0e10cSrcweir     LegendSymbolStyle_LINE,
52*cdf0e10cSrcweir 
53*cdf0e10cSrcweir     /** A bordered circle which has the same bounding-box as the
54*cdf0e10cSrcweir         <member>BOX</member>.
55*cdf0e10cSrcweir      */
56*cdf0e10cSrcweir     LegendSymbolStyle_CIRCLE
57*cdf0e10cSrcweir };
58*cdf0e10cSrcweir 
59*cdf0e10cSrcweir struct ViewLegendEntry
60*cdf0e10cSrcweir {
61*cdf0e10cSrcweir     /** The legend symbol that represents a data series or other
62*cdf0e10cSrcweir         information contained in the legend
63*cdf0e10cSrcweir      */
64*cdf0e10cSrcweir     ::com::sun::star::uno::Reference<
65*cdf0e10cSrcweir         ::com::sun::star::drawing::XShape > aSymbol;
66*cdf0e10cSrcweir 
67*cdf0e10cSrcweir     /** The descriptive text for a legend entry.
68*cdf0e10cSrcweir      */
69*cdf0e10cSrcweir     ::com::sun::star::uno::Sequence<
70*cdf0e10cSrcweir         ::com::sun::star::uno::Reference<
71*cdf0e10cSrcweir             ::com::sun::star::chart2::XFormattedString > >  aLabel;
72*cdf0e10cSrcweir };
73*cdf0e10cSrcweir 
74*cdf0e10cSrcweir class LegendEntryProvider
75*cdf0e10cSrcweir {
76*cdf0e10cSrcweir public:
77*cdf0e10cSrcweir     virtual ::com::sun::star::awt::Size getPreferredLegendKeyAspectRatio()=0;
78*cdf0e10cSrcweir 
79*cdf0e10cSrcweir     virtual std::vector< ViewLegendEntry > createLegendEntries(
80*cdf0e10cSrcweir             const ::com::sun::star::awt::Size& rEntryKeyAspectRatio,
81*cdf0e10cSrcweir             ::com::sun::star::chart::ChartLegendExpansion eLegendExpansion,
82*cdf0e10cSrcweir             const ::com::sun::star::uno::Reference<
83*cdf0e10cSrcweir                 ::com::sun::star::beans::XPropertySet >& xTextProperties,
84*cdf0e10cSrcweir             const ::com::sun::star::uno::Reference<
85*cdf0e10cSrcweir                 ::com::sun::star::drawing::XShapes >& xTarget,
86*cdf0e10cSrcweir             const ::com::sun::star::uno::Reference<
87*cdf0e10cSrcweir                 ::com::sun::star::lang::XMultiServiceFactory >& xShapeFactory,
88*cdf0e10cSrcweir             const ::com::sun::star::uno::Reference<
89*cdf0e10cSrcweir                 ::com::sun::star::uno::XComponentContext >& xContext
90*cdf0e10cSrcweir                 ) = 0;
91*cdf0e10cSrcweir };
92*cdf0e10cSrcweir 
93*cdf0e10cSrcweir } //  namespace chart
94*cdf0e10cSrcweir 
95*cdf0e10cSrcweir // CHART2_VIEW_LEGENDENTRYPROVIDER_HXX
96*cdf0e10cSrcweir #endif
97