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 #pragma once
  20
  21 #include <com/sun/star/uno/Reference.hxx>
  22 #include "charttoolsdllapi.hxx"
  23
  24 namespace chart { class ChartModel; }
  25 namespace com::sun::star::chart2 { class XDiagram; }
  26 namespace com::sun::star::chart2 { class XLegend; }
  27 namespace com::sun::star::uno { class XComponentContext; }
  28
  29 namespace chart
  30 {
  31
  32 class OOO_DLLPUBLIC_CHARTTOOLS LegendHelper
  33 {
  34 public:
  35     static css::uno::Reference< css::chart2::XLegend >
  36         showLegend( ChartModel& rModel
  37                   , const css::uno::Reference< css::uno::XComponentContext >& xContext );
  38
  39     static  void hideLegend( ChartModel& rModel );
  40
  41     static css::uno::Reference< css::chart2::XLegend >
  42         getLegend( ChartModel& rModel
  43                  , const css::uno::Reference< css::uno::XComponentContext >& xContext = nullptr
  44                  , bool bCreate = false );
  45
  46     /** returns <FALSE/>, if either there is no legend at the diagram, or there
  47         is a legend which has a "Show" property of value <FALSE/>. Otherwise,
  48         <TRUE/> is returned.
  49      */
  50     static bool hasLegend( const css::uno::Reference< css::chart2::XDiagram > & xDiagram );
  51 };
  52
  53 } //namespace chart
  54
  55 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */