chart2/source/inc/LegendHelper.hxx

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