/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the Collabora Office 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_SVX_CHRTITEM_HXX
#define INCLUDED_SVX_CHRTITEM_HXX

#include <config_options.h>
#include <rtl/ustring.hxx>
#include <sal/types.h>
#include <svl/eitem.hxx>
#include <svl/poolitem.hxx>
#include <svx/svxdllapi.h>

enum class ChartColorPaletteType;
enum class ChartGradientVariation;
enum class ChartGradientType;

enum class SvxChartTextOrder
{
    SideBySide,
    UpDown,
    DownUp,
    Auto
};

#define CHTXTORDER_COUNT    (sal_uInt16(SvxChartTextOrder::Auto) + 1)

enum class SvxChartKindError
{
    NONE,
    Variant,
    Sigma,
    Percent,
    BigError,
    Const,
    StdError,
    Range
};

#define CHERROR_COUNT   (sal_uInt16(SvxChartKindError::Range) + 1)

enum class SvxChartIndicate
{
    NONE,
    Both,
    Up,
    Down
};

#define CHINDICATE_COUNT    (sal_uInt16(SvxChartIndicate::Down) + 1)

enum class SvxChartRegress
{
    NONE,
    Linear,
    Log,
    Exp,
    Power,
    Polynomial,
    MovingAverage,
    MeanValue,
    Unknown
};

#define CHREGRESS_COUNT (sal_uInt16(SvxChartRegress::Unknown) + 1)

class SAL_WARN_UNUSED UNLESS_MERGELIBS(SVXCORE_DLLPUBLIC) SvxChartRegressItem final : public SfxEnumItem<SvxChartRegress>
{
public:
    DECLARE_ITEM_TYPE_FUNCTION(SvxChartRegressItem)
    SvxChartRegressItem(SvxChartRegress eRegress /*= SvxChartRegress::Linear*/,
                        TypedWhichId<SvxChartRegressItem> nId );

    virtual SvxChartRegressItem* Clone(SfxItemPool* pPool = nullptr) const override;
};

class SAL_WARN_UNUSED UNLESS_MERGELIBS(SVXCORE_DLLPUBLIC) SvxChartTextOrderItem final : public SfxEnumItem<SvxChartTextOrder>
{
public:
    DECLARE_ITEM_TYPE_FUNCTION(SvxChartTextOrderItem)
    SvxChartTextOrderItem(SvxChartTextOrder eOrder /*= SvxChartTextOrder::SideBySide*/,
                          TypedWhichId<SvxChartTextOrderItem> nId );

    virtual SvxChartTextOrderItem* Clone(SfxItemPool* pPool = nullptr) const override;

    virtual bool         QueryValue( cpo::uno::Any& rVal, sal_uInt8 nMemberId = 0 ) const override;
    virtual bool         PutValue( const cpo::uno::Any& rVal, sal_uInt8 nMemberId ) override;
};

class SAL_WARN_UNUSED UNLESS_MERGELIBS(SVXCORE_DLLPUBLIC) SvxChartKindErrorItem final : public SfxEnumItem<SvxChartKindError>
{
public:
    DECLARE_ITEM_TYPE_FUNCTION(SvxChartKindErrorItem)
    SvxChartKindErrorItem(SvxChartKindError /*eOrient = SvxChartKindError::NONE*/,
                           TypedWhichId<SvxChartKindErrorItem> nId );

    virtual SvxChartKindErrorItem* Clone(SfxItemPool* pPool = nullptr) const override;
};

class SAL_WARN_UNUSED UNLESS_MERGELIBS(SVXCORE_DLLPUBLIC) SvxChartIndicateItem final : public SfxEnumItem<SvxChartIndicate>
{
public:
    DECLARE_ITEM_TYPE_FUNCTION(SvxChartIndicateItem)
    SvxChartIndicateItem(SvxChartIndicate eOrient /*= SvxChartIndicate::NONE*/,
                           TypedWhichId<SvxChartIndicateItem> nId );

    virtual SvxChartIndicateItem* Clone(SfxItemPool* pPool = nullptr) const override;
};

class SAL_WARN_UNUSED SVXCORE_DLLPUBLIC SvxDoubleItem final : public SfxPoolItem
{
    double m_fVal;

public:
    static SfxPoolItem* CreateDefault();
    DECLARE_ITEM_TYPE_FUNCTION(SvxDoubleItem)
    SvxDoubleItem(double fValue /*= 0.0*/, TypedWhichId<SvxDoubleItem> nId );
    SvxDoubleItem(const SvxDoubleItem& rItem);

    virtual bool QueryValue( cpo::uno::Any& rVal, sal_uInt8 nMemberId = 0 ) const override;
    virtual bool PutValue( const cpo::uno::Any& rVal, sal_uInt8 nMemberId ) override;

    virtual bool GetPresentation(SfxItemPresentation ePres,
                                 MapUnit eCoreMetric,
                                 MapUnit ePresMetric,
                                 OUString &rText, const IntlWrapper&) const override;

    virtual bool             operator == (const SfxPoolItem&) const override;
    virtual SvxDoubleItem* Clone(SfxItemPool *pPool = nullptr) const override;

    double GetValue() const { return m_fVal; }
};

// This SfxPoolItem is used to represent a chart color palette.
// A chart color palette is uniquely determined by its type and an index.
// Chart color palettes depends on current color theme and are generated by ChartColorPaletteHelper.
class SAL_WARN_UNUSED SVXCORE_DLLPUBLIC SvxChartColorPaletteItem final : public SfxPoolItem
{
    ChartColorPaletteType meType;
    sal_uInt32 mnIndex;

public:
    DECLARE_ITEM_TYPE_FUNCTION(SvxChartColorPaletteItem);
    SvxChartColorPaletteItem(ChartColorPaletteType eType, sal_uInt32 nIndex,
                             TypedWhichId<SvxChartColorPaletteItem> nId);
    SvxChartColorPaletteItem(const SvxChartColorPaletteItem& rItem);

    virtual bool QueryValue(cpo::uno::Any& rVal, sal_uInt8 nMemberId = 0) const override;
    virtual bool PutValue(const cpo::uno::Any& rVal, sal_uInt8 nMemberId) override;

    virtual bool GetPresentation(SfxItemPresentation ePres, MapUnit eCoreMetric,
                                 MapUnit ePresMetric, OUString& rText,
                                 const IntlWrapper&) const override;

    virtual bool operator==(const SfxPoolItem& rItem) const override;
    virtual SvxChartColorPaletteItem* Clone(SfxItemPool* pPool = nullptr) const override;

    ChartColorPaletteType GetType() const { return meType; }
    sal_uInt32 GetIndex() const { return mnIndex; }
};

// This SfxPoolItem is used to represent a chart gradient preset item.
// A gradient preset item is uniquely determined by its variation and its type.
// Chart gradient samples are generated by ChartGradientPaletteHelper.
class SAL_WARN_UNUSED SVXCORE_DLLPUBLIC SvxChartGradientPresetItem final : public SfxPoolItem
{
    ChartGradientVariation meVariation;
    ChartGradientType meType;

public:
    DECLARE_ITEM_TYPE_FUNCTION(SvxChartGradientPresetItem);
    SvxChartGradientPresetItem(ChartGradientVariation eVariation, ChartGradientType eType,
                               TypedWhichId<SvxChartGradientPresetItem> nId);
    SvxChartGradientPresetItem(const SvxChartGradientPresetItem& rItem);

    virtual bool QueryValue(cpo::uno::Any& rVal, sal_uInt8 nMemberId = 0) const override;
    virtual bool PutValue(const cpo::uno::Any& rVal, sal_uInt8 nMemberId) override;

    virtual bool GetPresentation(SfxItemPresentation ePres, MapUnit eCoreMetric,
                                 MapUnit ePresMetric, OUString& rText,
                                 const IntlWrapper&) const override;

    virtual bool operator==(const SfxPoolItem& rItem) const override;
    virtual SvxChartGradientPresetItem* Clone(SfxItemPool* pPool = nullptr) const override;

    ChartGradientVariation GetVariation() const { return meVariation; }
    ChartGradientType GetType() const { return meType; }
};

#endif // INCLUDED_SVX_CHRTITEM_HXX

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