/* -*- 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_EDITENG_TSTPITEM_HXX

#define INCLUDED_EDITENG_TSTPITEM_HXX

#include <svl/poolitem.hxx>

#include <editeng/svxenum.hxx>

#include <editeng/editengdllapi.h>

#include <o3tl/sorted_vector.hxx>

// class SvxTabStop ------------------------------------------------------

#define SVX_TAB_DEFCOUNT    10

#define SVX_TAB_DEFDIST     1134            // 2cm in twips

#define SVX_TAB_NOTFOUND    USHRT_MAX

#define cDfltDecimalChar    u'\0' // Get from IntlWrapper

#define cDfltFillChar       u' '

class EDITENG_DLLPUBLIC SvxTabStop

{

private:

    sal_Int32       nTabPos;

    SvxTabAdjust    eAdjustment;

    sal_Unicode     m_cDecimal;

    sal_Unicode     cFill;

    void fillDecimal();

public:

    SvxTabStop();

    explicit SvxTabStop( const sal_Int32 nPos,

                const SvxTabAdjust eAdjst = SvxTabAdjust::Left,

                const sal_Unicode cDec = cDfltDecimalChar,

                const sal_Unicode cFil = cDfltFillChar );

    sal_Int32&    GetTabPos() { return nTabPos; }

    sal_Int32     GetTabPos() const { return nTabPos; }

    SvxTabAdjust& GetAdjustment() { return eAdjustment; }

    SvxTabAdjust  GetAdjustment() const { return eAdjustment; }

    sal_Unicode&  GetDecimal() { return m_cDecimal; }

    sal_Unicode   GetDecimal() const { return m_cDecimal; }

    sal_Unicode&  GetFill() { return cFill; }

    sal_Unicode   GetFill() const { return cFill; }

    bool          operator==( const SvxTabStop& rTS ) const

                        {

                            return ( nTabPos     == rTS.nTabPos     &&

                                     eAdjustment == rTS.eAdjustment &&

                                     m_cDecimal    == rTS.m_cDecimal    &&

                                     cFill       == rTS.cFill );

                        }

    bool          operator!=( const SvxTabStop& rTS ) const

                        {

                            return !operator==(rTS);

                        }

    // For the SortedArray:

    bool            operator <( const SvxTabStop& rTS ) const

                        { return nTabPos < rTS.nTabPos; }

    void dumpAsXml(xmlTextWriterPtr pWriter) const;

};

// class SvxTabStopItem --------------------------------------------------

typedef o3tl::sorted_vector<SvxTabStop> SvxTabStopArr;

/*  [Description]

    This item describes a list of TabStops.

*/

class EDITENG_DLLPUBLIC SvxTabStopItem final : public SfxPoolItem

{

    SvxTabStopArr maTabStops;

    /// Defines default tab width for tabs without dedicated tab stop in the paragraph.

    sal_Int32 mnDefaultDistance = 0;

public:

    static SfxPoolItem* CreateDefault();

    DECLARE_ITEM_TYPE_FUNCTION(SvxTabStopItem)

    explicit SvxTabStopItem( sal_uInt16 nWhich  );

    SvxTabStopItem( const sal_uInt16 nTabs,

                    const sal_uInt16 nDist,

                    const SvxTabAdjust eAdjst /*= SvxTabAdjust::Default*/,

                    sal_uInt16 nWhich  );

    // Returns index of the tab or TAB_NOTFOUND

    sal_uInt16          GetPos( const SvxTabStop& rTab ) const;

    // Returns index of the tab at nPos, or TAB_NOTFOUND

    sal_uInt16          GetPos( const sal_Int32 nPos ) const;

    void SetDefaultDistance(sal_Int32 nDefaultDistancenDefTabSize);

    sal_Int32 GetDefaultDistance() const;

    // unprivatized:

    sal_uInt16          Count() const { return maTabStops.size(); }

    bool                Insert( const SvxTabStop& rTab );

    void                Insert( const SvxTabStopItem* pTabs );

    void                Remove( const sal_uInt16 nPos, const sal_uInt16 nLen = 1 )

                        { ASSERT_CHANGE_REFCOUNTED_ITEM; maTabStops.erase( maTabStops.begin() + nPos, maTabStops.begin() + nPos + nLen ); }

    // Assignment operator, equality operator (caution: expensive!)

    // this is already included in SfxPoolItem declaration

    //int             operator!=( const SvxTabStopItem& rTSI ) const

    //                  { return !( operator==( rTSI ) ); }

    const SvxTabStop& operator[]( const sal_uInt16 nPos ) const

                        { return maTabStops[nPos]; }

    const SvxTabStop& At( const sal_uInt16 nPos ) const

    {

        return maTabStops[nPos];

    }

    // "pure virtual Methods" from SfxPoolItem

    virtual bool             operator==( const SfxPoolItem& ) const override;

    virtual bool             supportsHashCode() const override { return true; }

    virtual size_t           hashCode() const override final;

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

    virtual bool             PutValue( const css::uno::Any& rVal, sal_uInt8 nMemberId ) override;

    virtual bool GetPresentation( SfxItemPresentation ePres,

                                  MapUnit eCoreMetric,

                                  MapUnit ePresMetric,

                                  OUString &rText, const IntlWrapper& ) const override;

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

    void dumpAsXml(xmlTextWriterPtr pWriter) const override;

};

#endif

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