chart2/source/inc/LegendHelper.hxx

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