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