xref: /aoo41x/main/chart2/source/inc/LegendHelper.hxx (revision de7b3f82)
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
10*de7b3f82SAndrew Rist  *
11*de7b3f82SAndrew Rist  *   http://www.apache.org/licenses/LICENSE-2.0
12*de7b3f82SAndrew Rist  *
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.
19*de7b3f82SAndrew Rist  *
20*de7b3f82SAndrew Rist  *************************************************************/
21*de7b3f82SAndrew Rist 
22*de7b3f82SAndrew Rist 
23cdf0e10cSrcweir #ifndef _CHART2_TOOLS_LEGENDHELPER_HXX
24cdf0e10cSrcweir #define _CHART2_TOOLS_LEGENDHELPER_HXX
25cdf0e10cSrcweir 
26cdf0e10cSrcweir // header for class OUString
27cdf0e10cSrcweir #include <rtl/ustring.hxx>
28cdf0e10cSrcweir #include <com/sun/star/chart2/XLegend.hpp>
29cdf0e10cSrcweir #include <com/sun/star/chart2/XDiagram.hpp>
30cdf0e10cSrcweir #include <com/sun/star/frame/XModel.hpp>
31cdf0e10cSrcweir #include <com/sun/star/uno/XComponentContext.hpp>
32cdf0e10cSrcweir #include "charttoolsdllapi.hxx"
33cdf0e10cSrcweir 
34cdf0e10cSrcweir //.............................................................................
35cdf0e10cSrcweir namespace chart
36cdf0e10cSrcweir {
37cdf0e10cSrcweir //.............................................................................
38cdf0e10cSrcweir 
39cdf0e10cSrcweir //-----------------------------------------------------------------------------
40cdf0e10cSrcweir /**
41cdf0e10cSrcweir */
42cdf0e10cSrcweir 
43cdf0e10cSrcweir class OOO_DLLPUBLIC_CHARTTOOLS LegendHelper
44cdf0e10cSrcweir {
45cdf0e10cSrcweir public:
46cdf0e10cSrcweir     static ::com::sun::star::uno::Reference<
47cdf0e10cSrcweir             ::com::sun::star::chart2::XLegend >
48cdf0e10cSrcweir         showLegend( const ::com::sun::star::uno::Reference<
49cdf0e10cSrcweir                        ::com::sun::star::frame::XModel >& xModel
50cdf0e10cSrcweir                   , const ::com::sun::star::uno::Reference<
51cdf0e10cSrcweir                        ::com::sun::star::uno::XComponentContext >& xContext );
52cdf0e10cSrcweir 
53cdf0e10cSrcweir     static  void hideLegend( const ::com::sun::star::uno::Reference<
54cdf0e10cSrcweir                        ::com::sun::star::frame::XModel >& xModel );
55cdf0e10cSrcweir 
56cdf0e10cSrcweir     static ::com::sun::star::uno::Reference<
57cdf0e10cSrcweir             ::com::sun::star::chart2::XLegend >
58cdf0e10cSrcweir         getLegend( const ::com::sun::star::uno::Reference<
59cdf0e10cSrcweir                        ::com::sun::star::frame::XModel >& xModel
60cdf0e10cSrcweir                  , const ::com::sun::star::uno::Reference<
61cdf0e10cSrcweir                        ::com::sun::star::uno::XComponentContext >& xContext = 0
62cdf0e10cSrcweir                  , bool bCreate = false );
63cdf0e10cSrcweir 
64cdf0e10cSrcweir     /** returns <FALSE/>, if either there is no legend at the diagram, or there
65cdf0e10cSrcweir         is a legend which has a "Show" property of value <FALSE/>. Otherwise,
66cdf0e10cSrcweir         <TRUE/> is returned.
67cdf0e10cSrcweir      */
68cdf0e10cSrcweir     static bool hasLegend( const ::com::sun::star::uno::Reference< ::com::sun::star::chart2::XDiagram > & xDiagram );
69cdf0e10cSrcweir };
70cdf0e10cSrcweir 
71cdf0e10cSrcweir //.............................................................................
72cdf0e10cSrcweir } //namespace chart
73cdf0e10cSrcweir //.............................................................................
74cdf0e10cSrcweir #endif
75