xref: /AOO41X/main/chart2/source/view/inc/LegendEntryProvider.hxx (revision de7b3f825c374d9f7270d1282e9d92876f197200)
1*de7b3f82SAndrew Rist /**************************************************************
2cdf0e10cSrcweir  *
3*de7b3f82SAndrew Rist  * Licensed to the Apache Software Foundation (ASF) under one
4*de7b3f82SAndrew Rist  * or more contributor license agreements.  See the NOTICE file
5*de7b3f82SAndrew Rist  * distributed with this work for additional information
6*de7b3f82SAndrew Rist  * regarding copyright ownership.  The ASF licenses this file
7*de7b3f82SAndrew Rist  * to you under the Apache License, Version 2.0 (the
8*de7b3f82SAndrew Rist  * "License"); you may not use this file except in compliance
9*de7b3f82SAndrew Rist  * with the License.  You may obtain a copy of the License at
10cdf0e10cSrcweir  *
11*de7b3f82SAndrew Rist  *   http://www.apache.org/licenses/LICENSE-2.0
12cdf0e10cSrcweir  *
13*de7b3f82SAndrew Rist  * Unless required by applicable law or agreed to in writing,
14*de7b3f82SAndrew Rist  * software distributed under the License is distributed on an
15*de7b3f82SAndrew Rist  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*de7b3f82SAndrew Rist  * KIND, either express or implied.  See the License for the
17*de7b3f82SAndrew Rist  * specific language governing permissions and limitations
18*de7b3f82SAndrew Rist  * under the License.
19cdf0e10cSrcweir  *
20*de7b3f82SAndrew Rist  *************************************************************/
21*de7b3f82SAndrew Rist 
22*de7b3f82SAndrew Rist 
23cdf0e10cSrcweir #ifndef CHART2_VIEW_LEGENDENTRYPROVIDER_HXX
24cdf0e10cSrcweir #define CHART2_VIEW_LEGENDENTRYPROVIDER_HXX
25cdf0e10cSrcweir 
26cdf0e10cSrcweir #include <com/sun/star/beans/XPropertySet.hpp>
27cdf0e10cSrcweir #include <com/sun/star/chart/ChartLegendExpansion.hpp>
28cdf0e10cSrcweir #include <com/sun/star/chart2/XFormattedString.hpp>
29cdf0e10cSrcweir #include <com/sun/star/drawing/XShape.hpp>
30cdf0e10cSrcweir #include <com/sun/star/drawing/XShapes.hpp>
31cdf0e10cSrcweir #include <com/sun/star/lang/XMultiServiceFactory.hpp>
32cdf0e10cSrcweir #include <com/sun/star/uno/XComponentContext.hpp>
33cdf0e10cSrcweir 
34cdf0e10cSrcweir #include <vector>
35cdf0e10cSrcweir 
36cdf0e10cSrcweir namespace chart
37cdf0e10cSrcweir {
38cdf0e10cSrcweir 
39cdf0e10cSrcweir enum LegendSymbolStyle
40cdf0e10cSrcweir {
41cdf0e10cSrcweir     /** A square box with border.
42cdf0e10cSrcweir      */
43cdf0e10cSrcweir     LegendSymbolStyle_BOX,
44cdf0e10cSrcweir 
45cdf0e10cSrcweir     /** A line like with a symbol.
46cdf0e10cSrcweir      */
47cdf0e10cSrcweir     LegendSymbolStyle_LINE,
48cdf0e10cSrcweir 
49cdf0e10cSrcweir     /** A bordered circle which has the same bounding-box as the
50cdf0e10cSrcweir         <member>BOX</member>.
51cdf0e10cSrcweir      */
52cdf0e10cSrcweir     LegendSymbolStyle_CIRCLE
53cdf0e10cSrcweir };
54cdf0e10cSrcweir 
55cdf0e10cSrcweir struct ViewLegendEntry
56cdf0e10cSrcweir {
57cdf0e10cSrcweir     /** The legend symbol that represents a data series or other
58cdf0e10cSrcweir         information contained in the legend
59cdf0e10cSrcweir      */
60cdf0e10cSrcweir     ::com::sun::star::uno::Reference<
61cdf0e10cSrcweir         ::com::sun::star::drawing::XShape > aSymbol;
62cdf0e10cSrcweir 
63cdf0e10cSrcweir     /** The descriptive text for a legend entry.
64cdf0e10cSrcweir      */
65cdf0e10cSrcweir     ::com::sun::star::uno::Sequence<
66cdf0e10cSrcweir         ::com::sun::star::uno::Reference<
67cdf0e10cSrcweir             ::com::sun::star::chart2::XFormattedString > >  aLabel;
68cdf0e10cSrcweir };
69cdf0e10cSrcweir 
70cdf0e10cSrcweir class LegendEntryProvider
71cdf0e10cSrcweir {
72cdf0e10cSrcweir public:
73cdf0e10cSrcweir     virtual ::com::sun::star::awt::Size getPreferredLegendKeyAspectRatio()=0;
74cdf0e10cSrcweir 
75cdf0e10cSrcweir     virtual std::vector< ViewLegendEntry > createLegendEntries(
76cdf0e10cSrcweir             const ::com::sun::star::awt::Size& rEntryKeyAspectRatio,
77cdf0e10cSrcweir             ::com::sun::star::chart::ChartLegendExpansion eLegendExpansion,
78cdf0e10cSrcweir             const ::com::sun::star::uno::Reference<
79cdf0e10cSrcweir                 ::com::sun::star::beans::XPropertySet >& xTextProperties,
80cdf0e10cSrcweir             const ::com::sun::star::uno::Reference<
81cdf0e10cSrcweir                 ::com::sun::star::drawing::XShapes >& xTarget,
82cdf0e10cSrcweir             const ::com::sun::star::uno::Reference<
83cdf0e10cSrcweir                 ::com::sun::star::lang::XMultiServiceFactory >& xShapeFactory,
84cdf0e10cSrcweir             const ::com::sun::star::uno::Reference<
85cdf0e10cSrcweir                 ::com::sun::star::uno::XComponentContext >& xContext
86cdf0e10cSrcweir                 ) = 0;
87cdf0e10cSrcweir };
88cdf0e10cSrcweir 
89cdf0e10cSrcweir } //  namespace chart
90cdf0e10cSrcweir 
91cdf0e10cSrcweir // CHART2_VIEW_LEGENDENTRYPROVIDER_HXX
92cdf0e10cSrcweir #endif
93