chart2/source/inc/LegendHelper.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef _CHART2_TOOLS_LEGENDHELPER_HXX
  28 #define _CHART2_TOOLS_LEGENDHELPER_HXX
  29
  30 // header for class OUString
  31 #include <rtl/ustring.hxx>
  32 #include <com/sun/star/chart2/XLegend.hpp>
  33 #include <com/sun/star/chart2/XDiagram.hpp>
  34 #include <com/sun/star/frame/XModel.hpp>
  35 #include <com/sun/star/uno/XComponentContext.hpp>
  36 #include "charttoolsdllapi.hxx"
  37
  38 //.............................................................................
  39 namespace chart
  40 {
  41 //.............................................................................
  42
  43 //-----------------------------------------------------------------------------
  44 /**
  45 */
  46
  47 class OOO_DLLPUBLIC_CHARTTOOLS LegendHelper
  48 {
  49 public:
  50     static ::com::sun::star::uno::Reference<
  51             ::com::sun::star::chart2::XLegend >
  52         showLegend( const ::com::sun::star::uno::Reference<
  53                        ::com::sun::star::frame::XModel >& xModel
  54                   , const ::com::sun::star::uno::Reference<
  55                        ::com::sun::star::uno::XComponentContext >& xContext );
  56
  57     static  void hideLegend( const ::com::sun::star::uno::Reference<
  58                        ::com::sun::star::frame::XModel >& xModel );
  59
  60     static ::com::sun::star::uno::Reference<
  61             ::com::sun::star::chart2::XLegend >
  62         getLegend( const ::com::sun::star::uno::Reference<
  63                        ::com::sun::star::frame::XModel >& xModel
  64                  , const ::com::sun::star::uno::Reference<
  65                        ::com::sun::star::uno::XComponentContext >& xContext = 0
  66                  , bool bCreate = false );
  67
  68     /** returns <FALSE/>, if either there is no legend at the diagram, or there
  69         is a legend which has a "Show" property of value <FALSE/>. Otherwise,
  70         <TRUE/> is returned.
  71      */
  72     static bool hasLegend( const ::com::sun::star::uno::Reference< ::com::sun::star::chart2::XDiagram > & xDiagram );
  73 };
  74
  75 //.............................................................................
  76 } //namespace chart
  77 //.............................................................................
  78 #endif