chart2/source/inc/LegendHelper.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef INCLUDED_CHART2_SOURCE_INC_LEGENDHELPER_HXX
  20 #define INCLUDED_CHART2_SOURCE_INC_LEGENDHELPER_HXX
  21
  22 #include <rtl/ustring.hxx>
  23 #include <com/sun/star/chart2/XLegend.hpp>
  24 #include <com/sun/star/chart2/XDiagram.hpp>
  25 #include <com/sun/star/uno/XComponentContext.hpp>
  26 #include "charttoolsdllapi.hxx"
  27
  28 #include "ChartModel.hxx"
  29
  30 namespace chart
  31 {
  32
  33 /**
  34 */
  35
  36 class OOO_DLLPUBLIC_CHARTTOOLS LegendHelper
  37 {
  38 public:
  39     static ::com::sun::star::uno::Reference<
  40             ::com::sun::star::chart2::XLegend >
  41         showLegend( ChartModel& rModel
  42                   , const ::com::sun::star::uno::Reference<
  43                        ::com::sun::star::uno::XComponentContext >& xContext );
  44
  45     static  void hideLegend( ChartModel& rModel );
  46
  47     static ::com::sun::star::uno::Reference<
  48             ::com::sun::star::chart2::XLegend >
  49         getLegend( ChartModel& rModel
  50                  , const ::com::sun::star::uno::Reference<
  51                        ::com::sun::star::uno::XComponentContext >& xContext = 0
  52                  , bool bCreate = false );
  53
  54     /** returns <FALSE/>, if either there is no legend at the diagram, or there
  55         is a legend which has a "Show" property of value <FALSE/>. Otherwise,
  56         <TRUE/> is returned.
  57      */
  58     static bool hasLegend( const ::com::sun::star::uno::Reference< ::com::sun::star::chart2::XDiagram > & xDiagram );
  59 };
  60
  61 } //namespace chart
  62 #endif
  63
  64 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */