/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef INCLUDED_CHART2_SOURCE_INC_LEGENDHELPER_HXX
#define INCLUDED_CHART2_SOURCE_INC_LEGENDHELPER_HXX

#include <com/sun/star/uno/Reference.hxx>
#include "charttoolsdllapi.hxx"

namespace chart { class ChartModel; }
namespace com::sun::star::chart2 { class XDiagram; }
namespace com::sun::star::chart2 { class XLegend; }
namespace com::sun::star::uno { class XComponentContext; }

namespace chart
{

class OOO_DLLPUBLIC_CHARTTOOLS LegendHelper
{
public:
    static css::uno::Reference< css::chart2::XLegend >
        showLegend( ChartModel& rModel
                  , const css::uno::Reference< css::uno::XComponentContext >& xContext );

    static  void hideLegend( ChartModel& rModel );

    static css::uno::Reference< css::chart2::XLegend >
        getLegend( ChartModel& rModel
                 , const css::uno::Reference< css::uno::XComponentContext >& xContext = nullptr
                 , bool bCreate = false );

    /** returns <FALSE/>, if either there is no legend at the diagram, or there
        is a legend which has a "Show" property of value <FALSE/>. Otherwise,
        <TRUE/> is returned.
     */
    static bool hasLegend( const css::uno::Reference< css::chart2::XDiagram > & xDiagram );
};

} //namespace chart
#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */